nmflash.h

Go to the documentation of this file.

#ifndef __NM_FLASH_H__
#define __NM_FLASH_H__

/*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*
INCLUDES
*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*/
#include "common/include/nm_common.h"
#include "driver/include/m2m_types.h"

#define FLASH_RETURN_OK                                         0
#define FLASH_SECTOR_SIZE                                       FLASH_SECTOR_SZ
#define FLASH_SIGNATURE                                         HOST_CONTROL_FLASH_SIG
#define BACKUP_SIGNATURE                                        0x424b5550

#define FLASH_MODE_FLAGS_CS                                     NBIT0
#define FLASH_MODE_FLAGS_CS_SWITCH                      NBIT1
#define FLASH_MODE_FLAGS_CS_SWITCH_TARGET       NBIT2
#define FLASH_MODE_FLAGS_CS_VALIDATE_IMAGE      NBIT3
#define FLASH_MODE_FLAGS_UNCHANGED                      NBIT4
#define FLASH_MODE_FLAGS_DATA_IN_BACKUP         NBIT5

#define FLASH_FN_FLAGS_COMPARE_BEFORE           NBIT0

#define FLASH_FN_FLAGS_READ_SURROUNDING         NBIT1

#define FLASH_FN_FLAGS_BACKUP                           NBIT2

#define FLASH_FN_FLAGS_ERASE                            NBIT3

#define FLASH_FN_FLAGS_WRITE                            NBIT4

#define FLASH_FN_FLAGS_COMPARE_AFTER            NBIT5

#define FLASH_FN_FLAGS_READ                                     NBIT6

#define FLASH_ACCESS_OPTION_ERASE_FIRST                 NBIT0

#define FLASH_ACCESS_OPTION_KEEP_SURROUNDING    NBIT1

#define FLASH_ACCESS_OPTION_USE_BACKUP                  NBIT2

#define FLASH_ACCESS_OPTION_COMPARE_BEFORE              NBIT3

#define FLASH_ACCESS_OPTION_COMPARE_AFTER               NBIT4

#define FLASH_ACCESS_WINC_MASK                                  (FLASH_ACCESS_OPTION_COMPARE_BEFORE | FLASH_ACCESS_OPTION_COMPARE_AFTER)


typedef enum {
        CS_INITIALIZE,
        CS_INVALIDATE_RB,
        CS_VALIDATE_RB,
        CS_SWITCH,
        CS_VALIDATE_SWITCH,
        CS_GET_ACTIVE,
        CS_GET_INACTIVE,
        CS_DEINITIALIZE
}tenuCSOp;

typedef enum {
        /*
         *      Status values arranged so that status can be updated without any erase operation.
         */
        FLASH_STATUS_EMPTY                      = 0xFFFFFFFF,
        FLASH_STATUS_NOT_ACTIVE         = 0xFFFFFF00,
        FLASH_STATUS_ACTIVE                     = 0xFFFF0000,
        FLASH_STATUS_DONE                       = 0xFF000000
}tenuFlashAccessStatus;

typedef enum {
        /*
         *      Status values arranged so that status can be updated without any erase operation.
         */
        BACKUP_STATUS_EMPTY                     = 0xFFFFFFFF,
        BACKUP_STATUS_NOT_ACTIVE        = BACKUP_SIGNATURE | 0xFFFFFF00,
        BACKUP_STATUS_ACTIVE            = BACKUP_SIGNATURE,
        BACKUP_STATUS_DONE                      = 0x00000000
}tenuBackupStatus;

typedef enum {
        /*
         *      Special location ID values. If top bit is not set, the location ID is interpreted as flash address.
         */
        MEM_ID_WINC_FLASH = 0x80000000,
        MEM_ID_WINC_ACTIVE,
        MEM_ID_WINC_INACTIVE,
        MEM_ID_NONE = 0xFFFFFFFF
}tenuMemId;

typedef enum {
        FLASH_ITEM_ADD,
        FLASH_ITEM_REMOVE,
        FLASH_ITEM_READ,
        FLASH_ITEM_READIDX
}tenuFlashAccessItemMode;


typedef struct {
        uint32                                  u32Signature;
        tenuFlashAccessStatus   enuTransferStatus;
        uint16                                  u16AppId;
        uint8                                   u8AccessFlags;          // These correspond bitwise to application access options.
        uint8                                   u8ModeFlags;            // These are set internally, with reference to application mode options.
}tstrFlashAccessPersistent;
#define FLASH_SIG_SZ            (sizeof(uint32))
#define FLASH_STA_SZ            (sizeof(tenuFlashAccessStatus))
#define FLASH_SIG_STA_SZ        (FLASH_SIG_SZ+FLASH_STA_SZ)

typedef struct {
        tstrFlashAccessPersistent       strPersistentInfo;
        tpfDataAccessFn                         pfDestinationFn;
        tpfDataAccessFn                         pfSourceFn;
        uint32                                          u32Size;
}tstrFlashAccess;

typedef struct {
        tenuBackupStatus                enuTransferStatus;
        uint32                                  u32DestinationAddr;
        uint32                                  u32SourceAddr;
        uint32                                  u32Size;
}tstrBackup;
#define FLASH_BACKUP_STA_SZ                     sizeof(tenuBackupStatus)
#define FLASH_BACKUP_STORE_SZ           (2*sizeof(tstrBackup))
#define FLASH_BACKUP_STORE_OFFSET       (HOST_CONTROL_FLASH_OFFSET + HOST_CONTROL_FLASH_SZ - FLASH_BACKUP_STORE_SZ)

typedef struct {
        uint32  u32TotalSize;
        uint8   u8Flags;
        uint32  u32AlignmentSize;
        uint32  u32StartAlignment;
}tstrDataAccessInitParams;

typedef struct {
        uint8   *pu8Buf;
        uint32  u32BufSize;
        /* Offset of data within the buffer. */
        uint32  u32DataOffset;
        /* Size of data to be written or read. */
        uint32  u32DataSize;
}tstrDataAccessParams;

extern uint16   gu16LastAccessId;
extern uint8    gu8Success;
extern uint8    gu8Changed;
extern uint8    gu8Init;
extern uint8    gu8Reset;

/*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*
FUNCTION PROTOTYPES
*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*/

sint8 winc_flash_write_verify(uint8 *pu8Buf, uint32 u32Offset, uint32 u32Size);
void set_internal_info(tpfDataAccessFn *ppfFn, uint32 u32LocationId);
void set_internal_info_ptr(tpfDataAccessFn *ppfFn, uint8 *pu8Ptr);
uint8 is_internal_info(tpfDataAccessFn pfFn);
sint8 recover_backup(void);
sint8 prepare_backup(uint32 u32Target);
sint8 image_get_target(uint8 *pu8Target);
sint8 rootcert_get_size(tstrRootCertEntryHeader *pstrHdr, uint16 *pu16Size);
sint8 rootcert_access(tenuFlashAccessItemMode enuMode, tstrRootCertEntryHeader *pstrReferenceHdr, uint16 *pu16EntrySize, uint8 *pu8Buff, uint32 *pu32Offset);
sint8 transfer_run(tstrFlashAccess *pstrFlashAccess);


#endif /* __NM_FLASH_H__ */