nmdrv.h
Go to the documentation of this file.
1 
35 #ifndef _NMDRV_H_
36 #define _NMDRV_H_
37 
39 
44 typedef struct {
45  uint16 u16FirmwareHifInfo; /* Fw HIF Info */
46  uint8 u8FirmwareMajor; /* Version Major Number */
47  uint8 u8FirmwareRsvd; /* Reserved */
48  uint8 u8FirmwareMinor; /* Version Minor */
49  uint8 u8FirmwarePatch; /* Patch Number */
50  uint8 BuildDate[sizeof(__DATE__)]; // 12 bytes
51  uint8 BuildTime[sizeof(__TIME__)]; // 9 bytes
52 } tstrM2mRev;
53 
54 #ifdef __cplusplus
55  extern "C" {
56  #endif
57 
66 sint8 nm_get_hif_info(uint16 *pu16FwHifInfo, uint16 *pu16OtaHifInfo);
85 /*
86 * @fn nm_drv_init
87 * @brief Initialize NMC1000 driver
88 * @return ZERO in case of success and Negative error code in case of failure
89 */
90 sint8 nm_drv_init_download_mode(uint32 req_serial_number);
91 
92 /*
93 * @fn nm_drv_init
94 * @brief Initialize NMC1000 driver
95 * @return M2M_SUCCESS in case of success and Negative error code in case of failure
96 * @param [in] arg - Generic argument passed on to nm_drv_init_start
97 * @param [in] req_serial_number
98 * @return ZERO in case of success and Negative error code in case of failure
99 */
100 sint8 nm_drv_init(void * arg, uint32 req_serial_number);
101 
102 /*
103 * @fn nm_drv_init_hold
104 * @brief First part of nm_drv_init, up to the point of initializing spi for flash access.
105 * @see nm_drv_init
106 * @return M2M_SUCCESS in case of success and Negative error code in case of failure
107 * @param [in] req_serial_number
108 * Parameter inherited from nm_drv_init
109 * @return ZERO in case of success and Negative error code in case of failure
110 */
111 sint8 nm_drv_init_hold(uint32 req_serial_number);
112 
113 /*
114 * @fn nm_drv_init_start
115 * @brief Second part of nm_drv_init, continuing from where nm_drv_init_hold left off.
116 * @see nm_drv_init
117 * @return M2M_SUCCESS in case of success and Negative error code in case of failure
118 * @param [in] arg
119 * Parameter inherited from nm_drv_init
120 * @return ZERO in case of success and Negative error code in case of failure
121 */
122 sint8 nm_drv_init_start(void * arg);
123 
131 sint8 nm_drv_deinit(void * arg);
132 
139 sint8 nm_cpu_start(void);
140 
141 #ifdef __cplusplus
142  }
143  #endif
144 
145 #endif /*_NMDRV_H_*/
146 
147 
This module contains common APIs declarations.
signed char sint8
Range of values between -128 to 127.
Definition: nm_bsp.h:111
uint8 u8FirmwarePatch
Definition: nmdrv.h:49
sint8 nm_drv_deinit(void *arg)
Definition: nmdrv.c:370
sint8 nm_cpu_start(void)
Start CPU from the WINC module.
Definition: nmdrv.c:401
unsigned short uint16
Range of values between 0 to 65535.
Definition: nm_bsp.h:96
sint8 nm_get_ota_firmware_info(tstrM2mRev *pstrRev)
Get Firmware version info.
Definition: nmdrv.c:151
sint8 nm_drv_init(void *arg, uint32 req_serial_number)
Definition: nmdrv.c:351
uint8 u8FirmwareRsvd
Definition: nmdrv.h:47
sint8 nm_drv_init_start(void *arg)
Definition: nmdrv.c:291
sint8 nm_drv_init_download_mode(uint32 req_serial_number)
Definition: nmdrv.c:224
sint8 nm_drv_init_hold(uint32 req_serial_number)
Definition: nmdrv.c:249
uint16 u16FirmwareHifInfo
Definition: nmdrv.h:45
sint8 nm_get_firmware_full_info(tstrM2mRev *pstrRev)
Get Firmware version info.
Definition: nmdrv.c:81
unsigned long uint32
Range of values between 0 to 4294967295.
Definition: nm_bsp.h:103
uint8 u8FirmwareMinor
Definition: nmdrv.h:48
unsigned char uint8
Range of values between 0 to 255.
Definition: nm_bsp.h:89
sint8 nm_get_hif_info(uint16 *pu16FwHifInfo, uint16 *pu16OtaHifInfo)
Get Hif info of images in both partitions (Firmware and Ota).
Definition: nmdrv.c:55
uint8 u8FirmwareMajor
Definition: nmdrv.h:46
Structure holding firmware version parameters and build date/time.
Definition: nmdrv.h:44


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