winc1500/host_drv/driver/source/nmdrv.h File Reference

This module contains NMC1500 M2M driver APIs declarations.

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

#include "common/include/nm_common.h"

Data Structures
struct	tstrM2mBinaryHeader
	Structure holding compatibility version info for firmware binaries. More...
struct	tstrM2mRev
	Structure holding firmware version parameters and build date/time. More...

Functions
sint8	nm_drv_deinit (void *arg)
sint8	nm_drv_init (void *arg)
sint8	nm_drv_init_download_mode (void)
	Initialize NMC1000 driver in download mode. More...
sint8	nm_drv_init_hold (void)
	First part of nm_drv_init, up to the point of initializing spi for flash access. More...
sint8	nm_drv_init_start (void *arg)
sint8	nm_get_firmware_full_info (tstrM2mRev *pstrRev)
	Get Firmware version info. More...
sint8	nm_get_firmware_info (tstrM2mRev *M2mRev)
	Get Firmware version info. More...
sint8	nm_get_ota_firmware_info (tstrM2mRev *pstrRev)
	Get Firmware version info. More...

sint8 nm_drv_deinit

(

void *

arg

)

sint8 nm_drv_init

(

void *

arg

)

References chip_apply_conf(), cpu_start(), enable_interrupts(), firmware_download(), M2M_DRIVER_VERSION_MAJOR_NO, M2M_DRIVER_VERSION_MINOR_NO, M2M_DRIVER_VERSION_PATCH_NO, M2M_ERR, M2M_ERR_FW_VER_MISMATCH, M2M_INFO, M2M_SUCCESS, nm_bus_iface_deinit(), nm_bus_iface_init(), nm_drv_init_hold(), nm_drv_init_start(), nm_get_firmware_info(), nm_sdio_deinit(), nm_sdio_init(), nm_spi_init(), nmi_get_chipid(), NULL, tstrM2mRev::u8DriverMajor, tstrM2mRev::u8DriverMinor, tstrM2mRev::u8DriverPatch, tstrM2mRev::u8FirmwareMajor, tstrM2mRev::u8FirmwareMinor, wait_for_bootrom(), and wait_for_firmware_start().

Referenced by m2m_wifi_init().

sint8 nm_drv_init_download_mode

(

void

)

Initialize NMC1000 driver in download mode.

Parameters

[in]

req_serial_number

Chip serial number

Returns

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

TODO:reset the chip and halt the cpu in case of no wait efuse is set (add the no wait effuse check)

References chip_reset_and_cpu_halt(), GET_CHIPID, ISNMC3000, M2M_ERR, M2M_INFO, M2M_SUCCESS, nm_bus_iface_init(), nm_spi_init(), nm_write_reg(), nmi_get_chipid(), and NULL.

Referenced by m2m_wifi_download_mode().

sint8 nm_drv_init_hold

(

void

)

First part of nm_drv_init, up to the point of initializing spi for flash access.

See Also

nm_drv_init

Parameters

[in]

req_serial_number

Parameter inherited from nm_drv_init

Returns

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

References chip_reset(), chip_wake(), M2M_ERR, M2M_INFO, M2M_SUCCESS, nm_bus_iface_deinit(), nm_bus_iface_init(), nm_spi_init(), nmi_get_chipid(), and NULL.

Referenced by m2m_wifi_init_hold(), and nm_drv_init().

sint8 nm_drv_init_start

(

void *

arg

)

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]	M2mRev	Pointer holds address of structure tstrM2mRev that contains the firmware version parameters
[out]	pstrRev	Pointer holds address of structure tstrM2mRev that contains the version parameters of image in the active partition.

Returns

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

sint8 nm_get_firmware_info

(

tstrM2mRev *

M2mRev

)

Get Firmware version info.

Parameters

[out]

M2mRev

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

Version

1.0

References M2M_ATE_FW_IS_UP_VALUE, M2M_ERR_FW_VER_MISMATCH, M2M_GET_DRV_MAJOR, M2M_GET_DRV_MINOR, M2M_GET_DRV_PATCH, M2M_GET_FW_MAJOR, M2M_GET_FW_MINOR, M2M_GET_FW_PATCH, M2M_MAKE_VERSION, M2M_RELEASE_VERSION_MAJOR_NO, M2M_RELEASE_VERSION_MINOR_NO, M2M_RELEASE_VERSION_PATCH_NO, M2M_SUCCESS, nm_read_reg_with_ret(), nmi_get_chipid(), NMI_REV_REG, NMI_REV_REG_ATE, tstrM2mRev::u16FirmwareSvnNum, tstrM2mRev::u32Chipid, tstrM2mRev::u8DriverMajor, tstrM2mRev::u8DriverMinor, tstrM2mRev::u8DriverPatch, tstrM2mRev::u8FirmwareMajor, tstrM2mRev::u8FirmwareMinor, and tstrM2mRev::u8FirmwarePatch.

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]	M2mRev	Pointer holds address of structure tstrM2mRev that contains the firmware version parameters
[out]	pstrRev	Pointer holds address of structure tstrM2mRev that contains the version parameters of image in the inactive partition.

Returns

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