amt630hv160-sdk-release/amt630hv160-freertos-beta/lib/sfud/inc/snfud.h

#ifndef _SNFUD_H_
#define _SNFUD_H_

#ifdef __cplusplus
extern "C" {
#endif

/* ../src/sfup.c */
/**
 * SFUD library initialize.
 *
 * @return result
 */
sfud_err snfud_init(void);

/**
 * get flash device by its index which in the flash information table
 *
 * @param index the index which in the flash information table  @see flash_table
 *
 * @return flash device
 */
sfud_flash *snfud_get_device(size_t index);

/**
 * get flash device total number on flash device information table  @see flash_table
 *
 * @return flash device total number
 */
size_t snfud_get_device_num(void);

/**
 * read flash data
 *
 * @param flash flash device
 * @param addr start address
 * @param size read size
 * @param data read data pointer
 *
 * @return result
 */
sfud_err snfud_read(const sfud_flash *flash, uint32_t addr, size_t size, uint8_t *data);

/**
 * erase flash data
 *
 * @note It will erase align by erase granularity.
 *
 * @param flash flash device
 * @param addr start address
 * @param size erase size
 *
 * @return result
 */
sfud_err snfud_erase(const sfud_flash *flash, uint32_t addr, size_t size);

/**
 * write flash data (no erase operate)
 *
 * @param flash flash device
 * @param addr start address
 * @param data write data
 * @param size write size
 *
 * @return result
 */
sfud_err snfud_write(const sfud_flash *flash, uint32_t addr, size_t size, const uint8_t *data);

/**
 * erase and write flash data
 *
 * @param flash flash device
 * @param addr start address
 * @param size write size
 * @param data write data
 *
 * @return result
 */
sfud_err snfud_erase_write(const sfud_flash *flash, uint32_t addr, size_t size, const uint8_t *data);

/**
 * erase all flash data
 *
 * @param flash flash device
 *
 * @return result
 */
sfud_err snfud_chip_erase(const sfud_flash *flash);

/**
 * read flash register status
 *
 * @param flash flash device
 * @param status register status
 *
 * @return result
 */
sfud_err snfud_read_status(const sfud_flash *flash, uint8_t *status, uint8_t cmd);

/**
 * write status register
 *
 * @param flash flash device
 * @param is_volatile true: volatile mode, false: non-volatile mode
 * @param status register status
 *
 * @return result
 */
sfud_err snfud_write_status(const sfud_flash *flash, bool is_volatile, uint8_t status, uint8_t cmd);

/**
 * write ef log data to a single block
 *
 * @param flash flash device
 * @param addr write flash address
 * @param size write size
 * @param data write data
 *
 * @return result
 */
sfud_err snfud_erase_write_ef_log(const sfud_flash *flash, uint32_t addr, size_t size, const uint8_t *data);

/**
 * write serial bytes to a single block
 *
 * @param flash flash device
 * @param addr write flash address
 * @param size write size
 * @param data write data
 *
 * @return result
 */
sfud_err snfud_write_one(const sfud_flash *flash, uint32_t addr, size_t size, const uint8_t *data);

/**
 * read serial bytes from a single block
 *
 * @param flash flash device
 * @param addr read flash address
 * @param size read size
 * @param data read data
 *
 * @return result
 */
sfud_err snfud_read_one(const sfud_flash *flash, uint32_t addr, size_t size, uint8_t *data);

/**
 * erase one block
 *
 * @param flash flash device
 * @param addr start address (align with block size)
 * @param size write size (block size)
 * @param data write data
 *
 * @return result
 */
sfud_err snfud_erase_one(const sfud_flash *flash, uint32_t addr, size_t size);

/**
 * flush cache data to flash (Only for filesystem partition)
 *
 * @param flash flash device
 *
 * @return result
 */
sfud_err snfud_flush(const sfud_flash *flash);

/**
 * format the filesystem partition
 *
 * @param flash flash device
 *
 * @return result
 */
sfud_err snfud_fs_format(const sfud_flash *flash);

#ifdef __cplusplus
}
#endif

#endif /* _SNFUD_H_ */