nmdrv.h

Go to the documentation of this file.

#ifndef _NMDRV_H_
#define _NMDRV_H_

#include "common/include/nm_common.h"

typedef struct {
        uint16 u16FirmwareHifInfo; /* Fw HIF Info */
        uint8 u8FirmwareMajor; /* Version Major Number */
        uint8 u8FirmwareRsvd; /* Reserved */
        uint8 u8FirmwareMinor; /* Version Minor */
        uint8 u8FirmwarePatch; /* Patch Number */
        uint8 BuildDate[sizeof(__DATE__)]; // 12 bytes
        uint8 BuildTime[sizeof(__TIME__)]; // 9 bytes
} tstrM2mRev;

#ifdef __cplusplus
     extern "C" {
 #endif

sint8 nm_get_hif_info(uint16 *pu16FwHifInfo, uint16 *pu16OtaHifInfo);
sint8 nm_get_firmware_full_info(tstrM2mRev* pstrRev);
sint8 nm_get_ota_firmware_info(tstrM2mRev* pstrRev);
/*
*       @fn             nm_drv_init
*       @brief  Initialize NMC1000 driver
*       @return ZERO in case of success and Negative error code in case of failure
*/
sint8 nm_drv_init_download_mode(uint32 req_serial_number);

/*
*       @fn             nm_drv_init
*       @brief  Initialize NMC1000 driver
*       @return M2M_SUCCESS in case of success and Negative error code in case of failure
*       @param [in]     arg - Generic argument passed on to nm_drv_init_start
*       @param [in]     req_serial_number
*       @return ZERO in case of success and Negative error code in case of failure
*/
sint8 nm_drv_init(void * arg, uint32 req_serial_number);

/*
*       @fn             nm_drv_init_hold
*       @brief  First part of nm_drv_init, up to the point of initializing spi for flash access.
*       @see    nm_drv_init
*       @return M2M_SUCCESS in case of success and Negative error code in case of failure
*       @param [in]     req_serial_number
*                               Parameter inherited from nm_drv_init
*       @return ZERO in case of success and Negative error code in case of failure
*/
sint8 nm_drv_init_hold(uint32 req_serial_number);

/*
*       @fn             nm_drv_init_start
*       @brief  Second part of nm_drv_init, continuing from where nm_drv_init_hold left off.
*       @see    nm_drv_init
*       @return M2M_SUCCESS in case of success and Negative error code in case of failure
*       @param [in]     arg
*                               Parameter inherited from nm_drv_init
*       @return ZERO in case of success and Negative error code in case of failure
*/
sint8 nm_drv_init_start(void * arg);

sint8 nm_drv_deinit(void * arg);

sint8 nm_cpu_start(void);

#ifdef __cplusplus
         }
 #endif

#endif  /*_NMDRV_H_*/