kunlun/export/inc/bsp/iot_flash_api.h

/****************************************************************************

Copyright(c) 2019 by Aerospace C.Power (Chongqing) Microelectronics. ALL RIGHTS RESERVED.

This Information is proprietary to Aerospace C.Power (Chongqing) Microelectronics and MAY NOT
be copied by any method or incorporated into another program without
the express written consent of Aerospace C.Power. This Information or any portion
thereof remains the property of Aerospace C.Power. The Information contained herein
is believed to be accurate and Aerospace C.Power assumes no responsibility or
liability for its use in any way and conveys no license or title under
any patent or copyright and makes no representation or warranty that this
Information is free from patent or copyright infringement.

****************************************************************************/

#ifndef IOT_FLASH_API_H
#define IOT_FLASH_API_H

#ifdef __cplusplus
extern "C" {
#endif

#define DEV_SEEK_SET 0
#define DEV_SEEK_CUR 1
#define DEV_SEEK_END 2

/** \defgroup FLASH_APIs CUSTOM APIs
 *  @brief CUSTOM APIs
 *
 *
 */

/** @addtogroup FLASH_APIs
 *  @{
 *
 */

/**
 * @brief custom_dev_resize() - config custom flash part layout
 *
 * @param offset        the offset address
 * @param size          the flash port max size
 * @return              0 means successful, 1 means failed
 */
uint32_t custom_dev_resize(uint32_t offset, uint32_t size);

/**
 * @brief custom_dev_query_offset() - query custom flash part offset address
 *
 * @return              the built-in flash address.
 */
uint32_t custom_dev_query_offset();

/**
 * @brief custom_dev_query_rw_size() - query custom flash part max size
 *
 * @return              the built-in flash size allocated for customer
 *                      application use
 *
 */
int32_t custom_dev_query_rw_size();

/**
 * @brief custom_dev_open() - open custom flash part
 *
 * @return              -1 -- open custom flash part failed
 * @return              other -- open custom flash part successfully
 *
 */
int32_t custom_dev_open();

/**
 * @brief custom_dev_close() - close custom flash part
 * @param fd:           custom flash part file pointer
 *
 * @return              -1 -- close custom flash part failed
 * @return              0 -- close custom flash part successfully
 *
 */
int32_t custom_dev_close(int32_t fd);

/**
 * @brief custom_dev_seek() - set the position indicator for the file pointed
 * @param fd:           custom flash part file pointer
 * @param offset:       the new position specified by fromwhere,
 *                      "offset" is below the built-in flash size
 * @param fromwhere:    it is set to DEV_SEEK_SET, DEV_SEEK, CUR DEV_SEEK_END,
 *                      and it means the start, the current, the end of part
 *
 * @return              -1 -- set custom flash part position failed
 * @return              other -- the new position set
 *
 */
int32_t custom_dev_seek(int32_t fd, uint32_t offset, uint8_t fromwhere);

/**
 * @brief custom_dev_read() - read custom flash part data
 * @param fd:           custom flash part file pointer
 * @param buf:          store the data at the location
 * @param count:        the size of data to read
 *                      "count" is below the built-in flash size
 *
 * @return              -1 -- read custom flash part data failed
 * @return              other -- return the read size
 *
 */
int32_t custom_dev_read(int32_t fd, void* buf, size_t count);

/**
 * @brief custom_dev_write() - write custom flash part data
 * @param fd:           custom flash part file pointer
 * @param buf:          the pointer of data to be written
 * @param count:        the size of data to be written
 *                      "count" is below the built-in flash size
 *
 * @return              -1 -- write custom flash part data failed
 * @return              other -- return the written size
 *
 */
int32_t custom_dev_write(int32_t fd, void*buf, size_t count);

/**
 * @brief custom_dev_erase() - erase custom flash as sector
 * @param fd:           custom flash part file pointer
 * @param offset:       the custom flash offset address of erase
 *                      Must be aligned with flash sector size
 * @param count:        the size of data to be erase,Must be aligned
 *                      with flash sector size
 *                      "count" is below the built-in flash size
 *
 *
 * @return              -1 -- erase custom flash part data failed
 * @return               0 -- erase custom flash part data successfully
 *
 */
int32_t custom_dev_erase(int32_t fd, uint32_t offset, size_t count);

/**
 * @brief custom_dev_get_size_of_erase_once() - get once erase operation size
 * @param fd:           flash device part fd.
 *
 * @return              -1 -- write custom flash part data failed
 * @return              other -- return the erase operation size
 *
 */
int32_t custom_dev_get_size_of_erase_once(int32_t fd);

/**
 * @brief custom_dev_write_without_erase() - write custom flash part data
 *                      without erase.
 * @param fd:           custom flash part file pointer
 * @param buf:          the pointer of data to be written
 * @param count:        the size of data to be written
 *                      "count" is below the built-in flash size
 * @retval:             -1 -- write custom flash part data failed
 * @retval:             other -- return the written size
 *
 */
int32_t custom_dev_write_without_erase(int32_t fd, void * buf,
    size_t count);

#ifdef __cplusplus
}
#endif

#endif

/**
 * @}
 */