nmdrv.h File Reference

This module contains WINC3400 M2M driver APIs declarations. More...

#include "common/include/nm_common.h"

Include dependency graph for nmdrv.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	tstrM2mRev
	Structure holding firmware version parameters and build date/time. More...

Functions
sint8	nm_cpu_start (void)
	Start CPU from the WINC module. More...
sint8	nm_drv_deinit (void *arg)
sint8	nm_drv_init (void *arg, uint32 req_serial_number)
sint8	nm_drv_init_download_mode (uint32 req_serial_number)
sint8	nm_drv_init_hold (uint32 req_serial_number)
sint8	nm_drv_init_start (void *arg)
sint8	nm_get_firmware_full_info (tstrM2mRev *pstrRev)
	Get Firmware version info. More...
sint8	nm_get_hif_info (uint16 *pu16FwHifInfo, uint16 *pu16OtaHifInfo)
	Get Hif info of images in both partitions (Firmware and Ota). More...
sint8	nm_get_ota_firmware_info (tstrM2mRev *pstrRev)
	Get Firmware version info. More...

Detailed Description

This module contains WINC3400 M2M driver APIs declarations.

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

Definition in file nmdrv.h.

Function Documentation

nm_cpu_start()

sint8 nm_cpu_start

(

void

)

Start CPU from the WINC module.

Returns

ZERO in case of success and Negative error code in case of failure

Definition at line 401 of file nmdrv.c.

nm_drv_deinit()

sint8 nm_drv_deinit

(

void *

arg

)

Definition at line 370 of file nmdrv.c.

nm_drv_init()

sint8 nm_drv_init	(	void *	arg,
		uint32	req_serial_number
	)

Definition at line 351 of file nmdrv.c.

nm_drv_init_download_mode()

sint8 nm_drv_init_download_mode

(

uint32

req_serial_number

)

Definition at line 224 of file nmdrv.c.

nm_drv_init_hold()

sint8 nm_drv_init_hold

(

uint32

req_serial_number

)

Go...

Definition at line 249 of file nmdrv.c.

nm_drv_init_start()

sint8 nm_drv_init_start

(

void *

arg

)

Definition at line 291 of file nmdrv.c.

nm_get_firmware_full_info()

sint8 nm_get_firmware_full_info

(

tstrM2mRev *

pstrRev

)

Get Firmware version info.

Parameters

[out]

M2mRev

pointer holds address of structure "tstrM2mRev" that contains the firmware version parameters

Version

1.0

Parameters

[out]

pstrRev

Pointer holds address of structure tstrM2mRev that contains the version parameters of image in the active partition.

Returns

ZERO in case of success and Negative error code in case of failure

Definition at line 81 of file nmdrv.c.

nm_get_hif_info()

sint8 nm_get_hif_info	(	uint16 *	pu16FwHifInfo,
		uint16 *	pu16OtaHifInfo
	)

Get Hif info of images in both partitions (Firmware and Ota).

Parameters

[out]	pu16FwHifInfo	Pointer holding Hif info of image in the active partition.
[out]	pu16OtaHifInfo	Pointer holding Hif info of image in the inactive partition.

Returns

ZERO in case of success and Negative error code in case of failure

Definition at line 55 of file nmdrv.c.

nm_get_ota_firmware_info()

sint8 nm_get_ota_firmware_info

(

tstrM2mRev *

pstrRev

)

Get Firmware version info.

Parameters

[out]

M2mRev

pointer holds address of structure "tstrM2mRev" that contains the firmware version parameters

Version

1.0

Parameters

[out]

pstrRev

Pointer holds address of structure tstrM2mRev that contains the version parameters of image in the inactive partition.

Returns

ZERO in case of success and Negative error code in case of failure

Definition at line 151 of file nmdrv.c.