iot_flash.h

Go to the documentation of this file.

/*
 * FreeRTOS Common IO V1.0.0
 * Copyright (C) 2019 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 * http://aws.amazon.com/freertos
 * http://www.FreeRTOS.org
 */

#ifndef _IOT_FLASH_H_
#define _IOT_FLASH_H_

#define IOT_FLASH_SUCCESS                   ( 0 )    
#define IOT_FLASH_INVALID_VALUE             ( 1 )    
#define IOT_FLASH_WRITE_FAILED              ( 2 )    
#define IOT_FLASH_READ_FAILED               ( 3 )    
#define IOT_FLASH_ERASE_FAILED              ( 4 )    
#define IOT_FLASH_DEVICE_BUSY               ( 5 )    
#define IOT_FLASH_CTRL_OP_FAILED            ( 6 )    
#define IOT_FLASH_FUNCTION_NOT_SUPPORTED    ( 7 )    
typedef enum
{
    eFlashIdle,                 
    eFlashCmdInProgress,        
    eFlashEraseFailed,          
    eFlashProgramSuspended,     
    eFlashEraseSuspended        /*<! Flash erase operation suspended. */
} IotFlashStatus_t;

typedef enum
{
    eFlashCompleted = IOT_FLASH_SUCCESS,             
    eFlashLastEraseFailed = IOT_FLASH_ERASE_FAILED,  
    eFlashLastReadFailed = IOT_FLASH_READ_FAILED,    
    eFlashLastWriteFailed = IOT_FLASH_WRITE_FAILED,  
} IotFlashOperationStatus_t;

typedef enum
{
    eFlashReadWrite,       
    eFlashReadOnly         
} IotFlashWriteProtect_t;

typedef struct IotFlashInfo
{
    uint32_t ulFlashSize;       
    uint32_t ulBlockSize;       
    uint32_t ulSectorSize;      
    uint32_t ulPageSize;        
    uint32_t ulLockSupportSize; 
    uint8_t ucAsyncSupported;   
} IotFlashInfo_t;

typedef struct IotFlashWriteProtectConfig
{
    uint32_t ulAddress;                      
    uint32_t ulSize;                         
    IotFlashWriteProtect_t xProtectionLevel; 
} IotFlashWriteProtectConfig_t;

typedef enum IotFlashIoctlRequest
{
    eSetFlashBlockProtection,  
    eGetFlashBlockProtection,  
    eSuspendFlashProgramErase, 
    eResumeFlashProgramErase,  
    eGetFlashStatus,           
    eGetFlashTxNoOfbytes,      
    eGetFlashRxNoOfbytes,      
} IotFlashIoctlRequest_t;

struct                        IotFlashDescriptor;

typedef struct IotFlashDescriptor   * IotFlashHandle_t;

typedef void ( * IotFlashCallback_t)( IotFlashOperationStatus_t xStatus, void * pvUserContext );

IotFlashHandle_t iot_flash_open( int32_t lFlashInstance );

IotFlashInfo_t * iot_flash_getinfo( IotFlashHandle_t const pxFlashHandle );

void iot_flash_set_callback( IotFlashHandle_t const pxFlashHandle,
                             IotFlashCallback_t xCallback,
                             void * pvUserContext );

int32_t iot_flash_ioctl( IotFlashHandle_t const pxFlashHandle,
                         IotFlashIoctlRequest_t xRequest,
                         void * const pvBuffer );

int32_t iot_flash_erase_sectors( IotFlashHandle_t const pxFlashHandle,
                                 uint32_t ulStartAddress,
                                 size_t xSize );

int32_t iot_flash_erase_chip( IotFlashHandle_t const pxFlashHandle );

int32_t iot_flash_write_sync( IotFlashHandle_t const pxFlashHandle,
                              uint32_t ulAddress,
                              uint8_t * const pvBuffer,
                              size_t xBytes );

int32_t iot_flash_read_sync( IotFlashHandle_t const pxFlashHandle,
                             uint32_t ulAddress,
                             uint8_t * const pvBuffer,
                             size_t xBytes );

int32_t iot_flash_write_async( IotFlashHandle_t const pxFlashHandle,
                               uint32_t ulAddress,
                               uint8_t * const pvBuffer,
                               size_t xBytes );

int32_t iot_flash_read_async( IotFlashHandle_t const pxFlashHandle,
                              uint32_t ulAddress,
                              uint8_t * const pvBuffer,
                              size_t xBytes );

int32_t iot_flash_close( IotFlashHandle_t const pxFlashHandle );

#endif /* ifndef _IOT_FLASH_H_ */