taf_flash_common.h

Go to the documentation of this file.

/*
 * ====================== WARNING ======================
 *
 * THE CONTENTS OF THIS FILE HAVE BEEN AUTO-GENERATED.
 * DO NOT MODIFY IN ANY WAY.
 *
 * ====================== WARNING ======================
 */
#ifndef TAF_FLASH_COMMON_H_INCLUDE_GUARD
#define TAF_FLASH_COMMON_H_INCLUDE_GUARD


#include "legato.h"

#define IFGEN_TAF_FLASH_PROTOCOL_ID "b36da29f4d7707ec3eceaa2f60f31c0a"
#define IFGEN_TAF_FLASH_MSG_SIZE 16404



//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_FLASH_PARTITION_NAME_MAX_BYTES 128

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_FLASH_MTD_PAGE_MAX_WRITE_SIZE 4096

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_FLASH_MTD_PAGE_MAX_READ_SIZE 4096

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_FLASH_MTD_MAX_READ_SIZE 16384

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_FLASH_MTD_MAX_WRITE_SIZE 16384

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_FLASH_VOLUME_NAME_MAX_BYTES 64

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_FLASH_VOLUME_TYPE_MAX_BYTES 128

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_FLASH_UBI_MAX_READ_SIZE 16384

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_FLASH_UBI_MAX_WRITE_SIZE 16384

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_flash_Partition* taf_flash_PartitionRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_flash_Volume* taf_flash_VolumeRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_FLASH_READ_ONLY = 1,
    TAF_FLASH_WRITE_ONLY = 2,
    TAF_FLASH_READ_WRITE = 3
}
taf_flash_OpenMode_t;



//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED bool ifgen_taf_flash_HasLocalBinding
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_flash_InitCommonData
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_flash_CleanupCommonData
(
    le_msg_SessionRef_t _ifgen_sessionRef
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_flash_OpenSession
(
    le_msg_SessionRef_t _ifgen_sessionRef,
    bool isBlocking
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_flash_Init
(
    le_msg_SessionRef_t _ifgen_sessionRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_flash_MtdOpen
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        const char* LE_NONNULL partitionName,
        taf_flash_OpenMode_t mode,
        taf_flash_PartitionRef_t* partitionRefPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_flash_MtdClose
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_flash_PartitionRef_t partitionRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_flash_MtdInformation
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_flash_PartitionRef_t partitionRef,
        uint32_t* blocksNumberPtr,
        uint32_t* badBlocksNumberPtr,
        uint32_t* blockSizePtr,
        uint32_t* pageSizePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_flash_MtdEraseBlock
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_flash_PartitionRef_t partitionRef,
        uint32_t blockIndex
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_flash_MtdReadPage
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_flash_PartitionRef_t partitionRef,
        uint32_t pageIndex,
        uint8_t* readDataPtr,
        size_t* readDataSizePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_flash_MtdWritePage
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_flash_PartitionRef_t partitionRef,
        uint32_t pageIndex,
        const uint8_t* writeDataPtr,
        size_t writeDataSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_flash_MtdRead
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_flash_PartitionRef_t partitionRef,
        uint32_t offset,
        uint8_t* readDataPtr,
        size_t* readDataSizePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_flash_MtdWrite
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_flash_PartitionRef_t partitionRef,
        uint32_t offset,
        const uint8_t* writeDataPtr,
        size_t writeDataSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_flash_MtdErase
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_flash_PartitionRef_t partitionRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED bool ifgen_taf_flash_MtdIsBlockGood
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_flash_PartitionRef_t partitionRef,
        uint32_t blockIndex
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_flash_UbiOpen
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        const char* LE_NONNULL volumeName,
        taf_flash_OpenMode_t mode,
        taf_flash_VolumeRef_t* volumeRefPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_flash_UbiClose
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_flash_VolumeRef_t volumeRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_flash_UbiInformation
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_flash_VolumeRef_t volumeRef,
        uint32_t* lebNumberPtr,
        uint32_t* freeLebNumberPtr,
        uint32_t* volumeSizePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_flash_UbiRead
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_flash_VolumeRef_t volumeRef,
        uint32_t offset,
        uint8_t* readDataPtr,
        size_t* readDataSizePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_flash_UbiInitWrite
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_flash_VolumeRef_t volumeRef,
        int64_t writeBytes
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_flash_UbiWrite
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_flash_VolumeRef_t volumeRef,
        const uint8_t* writeDataPtr,
        size_t writeDataSize
);

#endif // TAF_FLASH_COMMON_H_INCLUDE_GUARD