kopia lustrzana https://github.com/espressif/esp-idf
70 wiersze
2.2 KiB
C
70 wiersze
2.2 KiB
C
// Copyright 2015-2016 Espressif Systems (Shanghai) PTE LTD
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
#ifndef __BOOTLOADER_FLASH_H
|
|
#define __BOOTLOADER_FLASH_H
|
|
|
|
#include <stddef.h>
|
|
#include <stdbool.h>
|
|
#include <stdint.h>
|
|
#include <esp_err.h>
|
|
|
|
/* Provide a Flash API for bootloader_support code,
|
|
that can be used from bootloader or app code.
|
|
|
|
This header is available to source code in the bootloader &
|
|
bootloader_support components only.
|
|
*/
|
|
|
|
/**
|
|
* @brief Map a region of flash to data memory
|
|
*
|
|
* @important In bootloader code, only one region can be bootloader_mmaped at once. The previous region must be bootloader_munmapped before another region is mapped.
|
|
*
|
|
* @important In app code, these functions are not thread safe.
|
|
*
|
|
* Call bootloader_munmap once for each successful call to bootloader_mmap.
|
|
*
|
|
* In esp-idf app, this function maps directly to spi_flash_mmap.
|
|
*
|
|
* @param offset - Starting flash offset to map to memory.
|
|
* @param length - Length of data to map.
|
|
*
|
|
* @return Pointer to mapped data memory (at src_addr), or NULL
|
|
* if an allocation error occured.
|
|
*/
|
|
const void *bootloader_mmap(uint32_t src_addr, uint32_t size);
|
|
|
|
|
|
/**
|
|
* @brief Unmap a previously mapped region of flash
|
|
*
|
|
* Call bootloader_munmap once for each successful call to bootloader_mmap.
|
|
*/
|
|
void bootloader_munmap(const void *mapping);
|
|
|
|
/**
|
|
* @brief Read data from Flash.
|
|
*
|
|
* @note Both src and dest have to be 4-byte aligned.
|
|
*
|
|
* @param src source address of the data in Flash.
|
|
* @param dest pointer to the destination buffer
|
|
* @param size length of data
|
|
*
|
|
* @return esp_err_t
|
|
*/
|
|
esp_err_t bootloader_flash_read(size_t src_addr, void *dest, size_t size);
|
|
|
|
#endif
|