Classes | Macros | Typedefs | Enumerations | Functions
m2m_flash.h File Reference

WINC3400 Flash Interface. More...

#include "common/include/nm_common.h"
#include "driver/include/m2m_types.h"
Include dependency graph for m2m_flash.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  tstrDataAccessInitParamsApp
 This structure contains parameters for initializing a local data access (read or write). More...
 
struct  tstrDataAccessParamsApp
 This structure contains data for local data access (read or write). More...
 
struct  tstrFlashState
 This structure contains information about an attempted transfer. More...
 

Macros

#define FLASH_ERR_INTERNAL   (-7)
 
#define FLASH_ERR_LOCAL_ACCESS   (-2)
 
#define FLASH_ERR_PARAM   (-1)
 
#define FLASH_ERR_SIZE   (-4)
 
#define FLASH_ERR_UNINIT   (-6)
 
#define FLASH_ERR_WINC_ACCESS   (-3)
 
#define FLASH_ERR_WINC_CONFLICT   (-5)
 
#define FLASH_SUCCESS   0
 
#define FLASH_UPDATEIMAGE_OPTION_SWITCH   NBIT2
 
#define FLASH_UPDATEIMAGE_OPTION_UPDATE   NBIT0
 
#define FLASH_UPDATEIMAGE_OPTION_VALIDATE   NBIT1
 

Typedefs

typedef sint8(* tpfDataAccessFn) (tenuFlashDataFnCtl enuCtl, void *pvStr)
 A function of this type is used for local data access. It can be implemented to handle simple RAM access with pointer/length, or it can be implemented to handle access to external memory. Functions of this type are provided to the module via various function APIs. More...
 

Enumerations

enum  tenuDataFnRW { FLASH_DATA_FN_READ, FLASH_DATA_FN_WRITE }
 Indicates whether data is to be read or written. More...
 
enum  tenuFlashDataFnCtl { FLASH_DATA_FN_INITIALIZE, FLASH_DATA_FN_DATA, FLASH_DATA_FN_TERMINATE, FLASH_DATA_FN_COMPLETE }
 Control parameter for tpfDataAccessFn. More...
 
enum  tenuImageId { FLASH_IMAGE_INACTIVE, FLASH_IMAGE_ACTIVE }
 Indicates which image to access in WINC flash. More...
 

Functions

void m2m_flash_get_state (tstrFlashState *pstrState)
 Get information about the module current state and about the most recent access attempt. More...
 
sint8 m2m_flash_init (void)
 Initialize the module. More...
 
sint8 m2m_flash_readimage (tenuImageId enuImageId, uint16 u16Id, tpfDataAccessFn pfDestFn, uint32 u32DestSize)
 Read a WINC firmware image. More...
 
sint8 m2m_flash_rootcert_add (uint16 u16Id, tpfDataAccessFn pfFn, uint32 u32Size)
 Add an entry to the WINC TLS root certificate store. More...
 
sint8 m2m_flash_rootcert_read (uint16 u16Id, tpfDataAccessFn pfDestFn, uint32 u32DestSize, uint8 *pu8Identifier, uint32 u32IdentifierSz)
 Read an entry from the WINC TLS root certificate store, referenced by entry identifier. More...
 
sint8 m2m_flash_rootcert_readidx (uint16 u16Id, tpfDataAccessFn pfDestFn, uint32 u32DestSize, uint8 u8Index)
 Read an entry from the WINC TLS root certificate store, referenced by entry index. More...
 
sint8 m2m_flash_rootcert_remove (uint16 u16Id, uint8 *pu8Identifier, uint32 u32IdentifierSz)
 Remove an entry from the WINC TLS root certificate store. More...
 
sint8 m2m_flash_updateimage (uint8 u8Options, uint16 u16Id, tpfDataAccessFn pfSourceFn, uint32 u32SourceSize)
 Write/validate/switch a WINC firmware image. More...
 

Detailed Description

WINC3400 Flash Interface.

Copyright (c) 2017-2018 Microchip Technology Inc. and its subsidiaries.

Definition in file m2m_flash.h.



inertial_sense_ros
Author(s):
autogenerated on Sat Sep 19 2020 03:19:06