wilc/driver/source/m2m_hif.c File Reference

This module contains WILC M2M host interface APIs implementation.

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

#include "driver/source/nmbus.h"
#include "bsp/include/nm_bsp.h"
#include "m2m_hif.h"
#include "driver/include/m2m_types.h"
#include "driver/source/nmasic.h"
#include "driver/include/m2m_periph.h"

Macros
#define	NMI_AHB_DATA_MEM_BASE   0x30000
#define	NMI_AHB_SHARE_MEM_BASE   0xd0000
#define	WIFI_HOST_RCV_CTRL_0   (0x1070)
#define	WIFI_HOST_RCV_CTRL_1   (0x1084)
#define	WIFI_HOST_RCV_CTRL_2   (0x1078)
#define	WIFI_HOST_RCV_CTRL_3   (0x106c)
#define	WIFI_HOST_RCV_CTRL_4   (0x150400)
#define	WIFI_HOST_RCV_CTRL_5   (0x1088)

Functions
sint8	hif_chip_sleep (void)
	To make the chip sleep. More...
sint8	hif_chip_sleep_sc (void)
	To clear the chip sleep but keep the chip sleep. More...
sint8	hif_chip_wake (void)
	To Wakeup the chip. More...
sint8	hif_deinit (void *arg)
	To Deinitialize HIF layer. More...
uint8	hif_get_sleep_mode (void)
	Get the sleep mode of the HIF layer. More...
sint8	hif_handle_isr (void)
	Handle interrupt received from NMC1500 firmware. More...
sint8	hif_init (tstrHifinitParam *pstrInitParam)
static sint8	hif_isr (void)
	Host interface interrupt service routine. More...
sint8	hif_receive (uint32 u32Addr, uint8 *pu8Buf, uint16 u16Sz, uint8 isDone)
sint8	hif_register_cb (uint8 u8Grp, tpfHifCallBack fn)
sint8	hif_send (uint8 u8Gid, uint8 u8Opcode, uint8 *pu8CtrlBuf, uint16 u16CtrlBufSize, uint8 *pu8DataBuf, uint16 u16DataSize, uint16 u16DataOffset)
	Send packet using host interface. More...
sint8	hif_send_optimized (uint8 u8Gid, uint8 u8Opcode, uint8 *buffer, uint16 u16DataSize)
sint8	hif_set_receive_buffer (void *pvBuffer, uint16 u16BufferLen)
	Handle interrupt received from NMC1500 firmware. More...
static sint8	hif_set_rx_done (void)
void	hif_set_sleep_mode (uint8 u8Pstype)
	Set the sleep mode of the HIF layer. More...
static void	isr (void)
static void	m2m_hif_cb (uint8 u8OpCode, uint16 u16DataSize, uint8 *pu8Buff)

Variables
static volatile tstrHifHdr gstrHif	__M2M_DMA_BUF_ATT__
static volatile uint8	gu8ChipMode = 0
static volatile uint8	gu8ChipSleep = 0
static volatile uint8	gu8HifSizeDone = 0
static volatile uint8	gu8Interrupt = 0
tpfHifCallBack	pfHifCb = NULL
tpfHifCallBack	pfWifiCb = NULL
tstrHifinitParam	strHifInitParam

#define NMI_AHB_DATA_MEM_BASE   0x30000

#define NMI_AHB_SHARE_MEM_BASE   0xd0000

#define WIFI_HOST_RCV_CTRL_0   (0x1070)

Referenced by hif_isr(), hif_receive(), and hif_set_rx_done().

#define WIFI_HOST_RCV_CTRL_1   (0x1084)

Referenced by hif_isr(), and hif_receive().

#define WIFI_HOST_RCV_CTRL_2   (0x1078)

#define WIFI_HOST_RCV_CTRL_3   (0x106c)

Referenced by hif_send(), and hif_send_optimized().

#define WIFI_HOST_RCV_CTRL_4   (0x150400)

#define WIFI_HOST_RCV_CTRL_5   (0x1088)

NMI_API sint8 hif_chip_sleep

(

void

)

To make the chip sleep.

        To make the chip sleep.

Returns

The function shall return ZERO for successful operation and a negative value otherwise.

Referenced by gpio_ioctl(), hif_init(), hif_send(), hif_send_optimized(), m2m_ota_get_firmware_version(), m2m_wifi_get_firmware_version(), m2m_wifi_get_mac_address(), and m2m_wifi_get_otp_mac_address().

NMI_API sint8 hif_chip_sleep_sc

(

void

)

To clear the chip sleep but keep the chip sleep.

        To clear the chip count only but keep the chip awake

Returns

The function shall return ZERO for successful operation and a negative value otherwise.

Referenced by hif_send().

NMI_API sint8 hif_chip_wake

(

void

)

To Wakeup the chip.

    To Wakeup the chip.

Returns

The function shall return ZERO for successful operation and a negative value otherwise.

Referenced by gpio_ioctl(), hif_deinit(), hif_send(), hif_send_optimized(), m2m_ota_get_firmware_version(), m2m_wifi_get_firmware_version(), m2m_wifi_get_mac_address(), and m2m_wifi_get_otp_mac_address().

NMI_API sint8 hif_deinit

(

void *

arg

)

To Deinitialize HIF layer.

To De-initialize HIF layer.

        To Deinitialize HIF layer.

Parameters

[in]

arg

Pointer to the arguments.

Returns

The function shall return ZERO for successful operation and a negative value otherwise.

Parameters

[in]

arg

Pointer to the arguments.

Returns

The function shall return ZERO for successful operation and a negative value otherwise.

Referenced by m2m_wifi_deinit().

NMI_API uint8 hif_get_sleep_mode

(

void

)

Get the sleep mode of the HIF layer.

Returns

The function SHALL return the sleep mode of the HIF layer.

Referenced by m2m_wifi_get_sleep_mode(), m2m_wifi_request_sleep(), and m2m_wifi_set_sleep_mode().

hif_handle_isr

(

void

)

Handle interrupt received from NMC1500 firmware.

    Handle interrupt received from NMC1500 firmware.

Returns

The function SHALL return 0 for success and a negative value otherwise.

Referenced by m2m_wifi_handle_events().

sint8 hif_init

(

tstrHifinitParam *

pstrInitParam

)

References gu8ChipMode, gu8ChipSleep, gu8Interrupt, hif_register_cb(), isr(), m2m_hif_cb(), m2m_memcpy(), M2M_NO_PS, M2M_REQ_GRP_HIF, M2M_SUCCESS, nm_bsp_register_isr(), NULL, and pfWifiCb.

Referenced by m2m_wifi_init(), and m2m_wifi_init_start().

hif_isr ( void  )

static

Host interface interrupt service routine.

Author

M. Abdelmawla

Date

15 July 2012

Returns

1 in case of interrupt received else 0 will be returned

Version

1.0

start bus transfer

References gu8HifSizeDone, hif_set_rx_done(), IRG_FLAGS_OFFSET, M2M_ERR, M2M_ERR_BUS_FAIL, M2M_ERR_RCV, M2M_HIF_HDR_OFFSET, M2M_REQ_GRP_WIFI, M2M_SUCCESS, M2M_WIFI_RESP_PACKET_SENT, NM_BSP_B_L_16, nm_bsp_interrupt_ctrl(), nm_read_block(), nm_read_reg_with_ret(), nm_write_reg(), pfWifiCb, tstrHifinitParam::pu8RcvBuff, tstrHifHdr::u16Length, tstrHifinitParam::u32RcvBuffSize, tstrHifHdr::u8Gid, tstrHifHdr::u8Opcode, WIFI_HOST_RCV_CTRL_0, and WIFI_HOST_RCV_CTRL_1.

Referenced by hif_handle_isr().

sint8 hif_receive	(	uint32	u32Addr,
		uint8 *	pu8Buf,
		uint16	u16Sz,
		uint8	isDone
	)

Referenced by m2m_ip_cb(), m2m_ota_cb(), m2m_ssl_cb(), m2m_ssl_retrieve_hash(), m2m_ssl_retrieve_next_for_verifying(), m2m_ssl_stop_retrieving(), m2m_wifi_cb(), and Socket_ReadSocketData().

sint8 hif_register_cb	(	uint8	u8Grp,
		tpfHifCallBack	fn
	)

Referenced by hif_init(), m2m_ota_init(), m2m_ssl_init(), m2m_wifi_init(), m2m_wifi_init_start(), socketDeinit(), and socketInit().

NMI_API sint8 hif_send	(	uint8	u8Gid,
		uint8	u8Opcode,
		uint8 *	pu8CtrlBuf,
		uint16	u16CtrlBufSize,
		uint8 *	pu8DataBuf,
		uint16	u16DataSize,
		uint16	u16DataOffset
	)

Send packet using host interface.

Parameters

[in]	u8Gid	Group ID.
[in]	u8Opcode	Operation ID.
[in]	pu8CtrlBuf	Pointer to the Control buffer.
[in]	u16CtrlBufSize	Control buffer size.
[in]	u16DataOffset	Packet Data offset.
[in]	pu8DataBuf	Packet buffer Allocated by the caller.
[in]	u16DataSize	Packet buffer size (including the HIF header).

Returns

The function shall return ZERO for successful operation and a negative value otherwise.

Parameters

[in]	u8Gid	Group ID.
[in]	u8Opcode	Operation ID.
[in]	pu8CtrlBuf	Pointer to the Control buffer.
[in]	u16CtrlBufSize	Control buffer size.
[in]	u16DataOffset	Packet Data offset.
[in]	pu8DataBuf	Packet buffer Allocated by the caller.
[in]	u16DataSize	Packet buffer size (including the HIF header).

Returns

The function shall return M2M_SUCCESS for successful operation and a negative value otherwise.

Referenced by m2m_ota_abort(), m2m_ota_host_file_erase(), m2m_ota_host_file_get(), m2m_ota_host_file_read_hif(), m2m_ota_init(), m2m_ota_notif_check_for_update(), m2m_ota_notif_sched(), m2m_ota_notif_set_url(), m2m_ota_rollback(), m2m_ota_start_update(), m2m_ota_switch_firmware(), m2m_ssl_handshake_rsp(), m2m_ssl_send_certs_to_winc(), m2m_ssl_set_active_ciphersuites(), m2m_wifi_ap_add_black_list(), m2m_wifi_ap_get_assoc_info(), m2m_wifi_ble_api_send(), m2m_wifi_ble_set_gain_table(), m2m_wifi_change_monitoring_channel(), m2m_wifi_conf_auto_rate(), m2m_wifi_configure_sntp(), m2m_wifi_connect(), m2m_wifi_connect_1x_mschap2(), m2m_wifi_connect_1x_tls(), m2m_wifi_connect_open(), m2m_wifi_connect_psk(), m2m_wifi_connect_wep(), m2m_wifi_default_connect(), m2m_wifi_delete_sc(), m2m_wifi_disable_ap(), m2m_wifi_disable_mcast_filter(), m2m_wifi_disable_monitoring_mode(), m2m_wifi_disable_roaming(), m2m_wifi_disconnect(), m2m_wifi_download_cert(), m2m_wifi_enable_ap(), m2m_wifi_enable_ap_ext(), m2m_wifi_enable_dhcp(), m2m_wifi_enable_firmware_logs(), m2m_wifi_enable_mac_mcast(), m2m_wifi_enable_mcast_filter(), m2m_wifi_enable_monitoring_mode(), m2m_wifi_enable_roaming(), m2m_wifi_enable_sntp(), m2m_wifi_enable_XO_during_sleep(), m2m_wifi_get_connection_info(), m2m_wifi_get_system_time(), m2m_wifi_p2p(), m2m_wifi_p2p_disconnect(), m2m_wifi_prng_get_random_bytes(), m2m_wifi_req_client_ctrl(), m2m_wifi_req_curr_rssi(), m2m_wifi_req_restrict_ble(), m2m_wifi_req_scan_result(), m2m_wifi_req_server_init(), m2m_wifi_req_unrestrict_ble(), m2m_wifi_request_scan(), m2m_wifi_request_scan_passive(), m2m_wifi_request_scan_ssid(), m2m_wifi_request_scan_ssid_list(), m2m_wifi_request_sleep(), m2m_wifi_send_crl(), m2m_wifi_send_ethernet_pkt(), m2m_wifi_send_wlan_pkt(), m2m_wifi_set_antenna_mode(), m2m_wifi_set_battery_voltage(), m2m_wifi_set_cust_InfoElement(), m2m_wifi_set_device_name(), m2m_wifi_set_gain_table_idx(), m2m_wifi_set_gains(), m2m_wifi_set_ht_enable(), m2m_wifi_set_lsn_int(), m2m_wifi_set_mac_address(), m2m_wifi_set_max_tx_rate(), m2m_wifi_set_p2p_control_ifc(), m2m_wifi_set_p2p_pin(), m2m_wifi_set_power_profile(), m2m_wifi_set_scan_list(), m2m_wifi_set_scan_options(), m2m_wifi_set_scan_region(), m2m_wifi_set_sleep_mode(), m2m_wifi_set_static_ip(), m2m_wifi_set_stop_scan_on_first(), m2m_wifi_set_system_time(), m2m_wifi_set_tx_power(), m2m_wifi_start_provision_mode_ext(), m2m_wifi_stop_provision_mode(), m2m_wifi_wps(), and m2m_wifi_wps_disable().

sint8 hif_send_optimized	(	uint8	u8Gid,
		uint8	u8Opcode,
		uint8 *	buffer,
		uint16	u16DataSize
	)

References hif_chip_sleep(), hif_chip_wake(), INTERRUPT_CORTUS_2_3000D0, M2M_DBG, M2M_ERR, M2M_ERR_MEM_ALLOC, M2M_ERR_SEND, M2M_SUCCESS, NBIT7, NM_BSP_B_L_16, nm_read_reg_with_ret(), nm_write_block(), nm_write_reg(), tstrHifHdr::u16Length, tstrHifHdr::u8Gid, tstrHifHdr::u8Opcode, and WIFI_HOST_RCV_CTRL_3.

Referenced by m2m_wifi_send_ethernet_pkt().

hif_set_receive_buffer	(	void *	pvBuffer,
		uint16	u16BufferLen
	)

    Handle interrupt received from NMC1500 firmware.

Parameters

[in]	pvBuffer	Pointer to the buffer.
[in]	u16BufferLen	Size of the buffer.

Returns

The function SHALL return 0 for success and a negative value otherwise.

References M2M_ERR, tstrHifinitParam::pu8RcvBuff, and tstrHifinitParam::u32RcvBuffSize.

Referenced by m2m_wifi_set_receive_buffer().

static sint8 hif_set_rx_done ( void  )

static

References gu8HifSizeDone, INTERRUPT_CORTUS_0_3000D0, M2M_SUCCESS, nm_bsp_interrupt_ctrl(), nm_read_reg_with_ret(), nm_write_reg(), and WIFI_HOST_RCV_CTRL_0.

Referenced by hif_isr(), and hif_receive().

NMI_API void hif_set_sleep_mode

(

uint8

u8Pstype

)

Set the sleep mode of the HIF layer.

Parameters

[in]

u8Pstype

Sleep mode.

Returns

The function SHALL return 0 for success and a negative value otherwise.

Referenced by m2m_wifi_set_sleep_mode().

static void isr ( void  )

static

References gu8Interrupt, and nm_bsp_interrupt_ctrl().

Referenced by hif_init().

static void m2m_hif_cb ( uint8  u8OpCode, uint16  u16DataSize, uint8 *  pu8Buff  )

static

Referenced by hif_init().

volatile tstrHifHdr gstrHif __M2M_DMA_BUF_ATT__

static

volatile uint8 gu8ChipMode = 0

static

Referenced by hif_chip_sleep(), hif_chip_wake(), hif_get_sleep_mode(), hif_init(), and hif_set_sleep_mode().

volatile uint8 gu8ChipSleep = 0

static

Referenced by hif_chip_sleep(), hif_chip_sleep_sc(), hif_chip_wake(), and hif_init().

volatile uint8 gu8HifSizeDone = 0

static

Referenced by hif_chip_wake(), hif_isr(), and hif_set_rx_done().

volatile uint8 gu8Interrupt = 0

static

Referenced by hif_handle_isr(), hif_init(), and isr().

tpfHifCallBack pfHifCb = NULL

Referenced by hif_register_cb().

tpfHifCallBack pfWifiCb = NULL

pointer to Wi-Fi call back function

Referenced by hif_init(), hif_isr(), and hif_register_cb().

tstrHifinitParam strHifInitParam

Referenced by m2m_wifi_init().