AliOS Things API HAL SOC FLASH Guide - Shaofa/AliOS-Things-Certification-Manual GitHub Wiki
- 1 hal_flash_get_info
- 2 hal_flash_erase
- 3 hal_flash_write
- 4 hal_flash_erase_write
- 5 hal_flash_read
- 6 hal_flash_enable_secure
- 7 hal_flash_dis_secure
hal_logic_partition_t *hal_flash_get_info(hal_partition_t in_partition)-
Description
Get the infomation of the specified flash area
-
Parameters
IN/OUT NAME DESC [in] in_partition The target flash logical partition which should be erased -
Returns
HAL_logi_partition struct
int32_t hal_flash_erase(hal_partition_t in_partition, uint32_t off_set, uint32_t size)-
Description
Erase an area on a Flash logical partition
-
Parameters
IN/OUT NAME DESC [in] in_partition The target flash logical partition which should be erased [in] off_set Start address of the erased flash area [in] size Size of the erased flash are -
Returns
0 : On success, EIO : If an error occurred with any step
int32_t hal_flash_write(hal_partition_t in_partition, uint32_t *off_set,
const void *in_buf, uint32_t in_buf_len)-
Description
Write data to an area on a flash logical partition without erase
-
Parameters
IN/OUT NAME DESC [in] in_partition The target flash logical partition which should be read which should be written [in] off_set Point to the start address that the data is written to, and point to the last unwritten address after this function is returned, so you can call this function serval times without update this start address. [in] inBuffer point to the data buffer that will be written to flash [in] inBufferLength The length of the buffe -
Returns
0 : On success, EIO : If an error occurred with any step
int32_t hal_flash_erase_write(hal_partition_t in_partition, uint32_t *off_set,
const void *in_buf, uint32_t in_buf_len)-
Description
Write data to an area on a flash logical partition with erase first
-
Parameters
IN/OUT NAME DESC [in] in_partition The target flash logical partition which should be read which should be written [in] off_set Point to the start address that the data is written to, and point to the last unwritten address after this function is returned, so you can call this function serval times without update this start address. [in] inBuffer point to the data buffer that will be written to flash [in] inBufferLength The length of the buffe -
Returns
0 : On success, EIO : If an error occurred with any step
int32_t hal_flash_read(hal_partition_t in_partition, uint32_t *off_set,
void *out_buf, uint32_t in_buf_len)-
Description
Read data from an area on a Flash to data buffer in RAM
-
Parameters
IN/OUT NAME DESC [in] in_partition The target flash logical partition which should be read [in] off_set Point to the start address that the data is read, and point to the last unread address after this function is returned, so you can call this function serval times without update this start address. [in] outBuffer Point to the data buffer that stores the data read from flash [in] inBufferLength The length of the buffe -
Returns
0 : On success, EIO : If an error occurred with any step
int32_t hal_flash_enable_secure(hal_partition_t partition, uint32_t off_set, uint32_t size)-
Description
Set security options on a logical partition
-
Parameters
IN/OUT NAME DESC [in] partition The target flash logical partition [in] offset Point to the start address that the data is read, and point to the last unread address after this function is returned, so you can call this function serval times without update this start address. [in] size Size of enabled flash are -
Returns
0 : On success, EIO : If an error occurred with any step
int32_t hal_flash_dis_secure(hal_partition_t partition, uint32_t off_set, uint32_t size)-
Description
Disable security options on a logical partition
-
Parameters
IN/OUT NAME DESC [in] partition The target flash logical partition [in] offset Point to the start address that the data is read, and point to the last unread address after this function is returned, so you can call this function serval times without update this start address. [in] size Size of disabled flash are -
Returns
0 : On success, EIO : If an error occurred with any step