Driver API on STM32 for MXCHIP Wi-Fi module, see mx_wifi.h **. More...

Modules
	Driver_I/O
	Driver I/O interface setting API **.

	Driver_init
	**

	Network bypass mode
	**

	Station
	station mode API **

	SoftAP
	**

	Socket
	**

	mDNS
	**

	TLS
	**

	Webserver
	**

	FOTA
	**

	MX_WIFI_STATION_POWERSAVE
	**

Data Structures
struct	mwifi_ip_attr_t
	Wi-Fi ip address info. More...

struct	mwifi_eap_attr_t
	Wi-Fi EAP info. More...

struct	MX_WIFI_IO_t
	Wi-Fi low level I/O interface operation handles. More...

struct	MX_WIFI_SystemInfo_t
	Wi-Fi system info. More...

struct	MX_WIFI_Network_t
	Wi-Fi station info. More...

struct	MX_WIFI_APSettings_t
	Wi-Fi softAP info. More...

struct	MX_WIFI_Runtime_t
	Wi-Fi runtime info. More...

struct	MX_WIFIObject_t
	Wi-Fi Wi-Fi object handle. More...

Macros
#define	MX_WIFI_STATUS_OK (0)
	status code success. More...

#define	MX_WIFI_STATUS_ERROR (-1)
	status code common error. More...

#define	MX_WIFI_STATUS_TIMEOUT (-2)
	status code timeout. More...

#define	MX_WIFI_STATUS_IO_ERROR (-3)
	status code I/O error. More...

#define	MX_WIFI_STATUS_PARAM_ERROR (-4)
	status code bad argument error. More...

#define	MX_WIFI_STATUS_T int32_t
	status code. More...

#define	MX_WIFI_MAC_SIZE (6)
	max length of MAC address. More...

#define	MX_WIFI_SCAN_BUF_SIZE (2000)
	max size of scan buffer. More...

#define	MIN(a, b) ( ((a) < (b)) ? (a) : (b))
	helper function: get minimum. More...

Typedefs
typedef uint8_t	mwifi_if_t
	wifi mode. More...

typedef uint8_t	mc_wifi_scan_mode_t
	wifi scan mode. More...

typedef int8_t(*	IO_Init_Func) (uint16_t mode)
	I/O interface init function. More...

typedef int8_t(*	IO_DeInit_Func) (void)
	I/O interface deinit function. More...

typedef void(*	IO_Delay_Func) (uint32_t ms)
	I/O interface delay function. More...

typedef uint16_t(*	IO_Send_Func) (uint8_t *data, uint16_t len)
	I/O interface send function. More...

typedef uint16_t(*	IO_Receive_Func) (uint8_t *buffer, uint16_t buff_size)
	I/O interface receive function. More...

typedef void(*	mx_wifi_status_callback_t) (uint8_t cate, uint8_t event, void *arg)
	Prototype of Wi-Fi status changed callback function. More...

typedef void(*	mx_wifi_fota_status_cb_t) (mx_wifi_fota_status_e status, uint32_t user_args)
	Prototype of FOTA status callback function. More...

typedef void(*	mx_wifi_netlink_input_cb_t) (mx_buf_t pbuf, void user_args)
	Prototype of netlink input callback function for network bypass mode. More...

Enumerations

Detailed Description

Driver API on STM32 for MXCHIP Wi-Fi module, see mx_wifi.h **.

Macro Definition Documentation

#define MIN	(	a,
		b
	)	( ((a) < (b)) ? (a) : (b))

helper function: get minimum.

Definition at line 129 of file mx_wifi.h.

#define MX_WIFI_MAC_SIZE (6)

max length of MAC address.

Definition at line 126 of file mx_wifi.h.

#define MX_WIFI_SCAN_BUF_SIZE (2000)

max size of scan buffer.

Definition at line 127 of file mx_wifi.h.

#define MX_WIFI_STATUS_ERROR (-1)

status code common error.

Definition at line 119 of file mx_wifi.h.

#define MX_WIFI_STATUS_IO_ERROR (-3)

status code I/O error.

Definition at line 121 of file mx_wifi.h.

#define MX_WIFI_STATUS_OK (0)

status code success.

Definition at line 118 of file mx_wifi.h.

#define MX_WIFI_STATUS_PARAM_ERROR (-4)

status code bad argument error.

Definition at line 122 of file mx_wifi.h.

#define MX_WIFI_STATUS_T int32_t

status code.

Definition at line 123 of file mx_wifi.h.

#define MX_WIFI_STATUS_TIMEOUT (-2)

status code timeout.

Definition at line 120 of file mx_wifi.h.

Typedef Documentation

typedef int8_t(* IO_DeInit_Func) (void)

I/O interface deinit function.

Definition at line 172 of file mx_wifi.h.

typedef void(* IO_Delay_Func) (uint32_t ms)

I/O interface delay function.

Definition at line 173 of file mx_wifi.h.

typedef int8_t(* IO_Init_Func) (uint16_t mode)

I/O interface init function.

Definition at line 171 of file mx_wifi.h.

typedef uint16_t(* IO_Receive_Func) (uint8_t *buffer, uint16_t buff_size)

I/O interface receive function.

Definition at line 175 of file mx_wifi.h.

typedef uint16_t(* IO_Send_Func) (uint8_t *data, uint16_t len)

I/O interface send function.

Definition at line 174 of file mx_wifi.h.

typedef uint8_t mc_wifi_scan_mode_t

wifi scan mode.

Definition at line 79 of file mx_wifi.h.

typedef uint8_t mwifi_if_t

wifi mode.

Definition at line 68 of file mx_wifi.h.

typedef void(* mx_wifi_fota_status_cb_t) (mx_wifi_fota_status_e status, uint32_t user_args)

Prototype of FOTA status callback function.

Definition at line 262 of file mx_wifi.h.

typedef void(* mx_wifi_netlink_input_cb_t) (mx_buf_t *pbuf, void *user_args)

Prototype of netlink input callback function for network bypass mode.

Definition at line 267 of file mx_wifi.h.

typedef void(* mx_wifi_status_callback_t) (uint8_t cate, uint8_t event, void *arg)

Prototype of Wi-Fi status changed callback function.

Parameters

cate	wifi status: MC_STATION, MC_SOFTAP
event	wifi events: MWIFI_EVENT_STA_DOWN, MWIFI_EVENT_STA_UP, WIFI_EVENT_STA_GOT_IP, MWIFI_EVENT_AP_UP, MWIFI_EVENT_AP_DOWN
arg	user argument passed by

Definition at line 248 of file mx_wifi.h.

Enumeration Type Documentation

anonymous enum

Wi-Fi mode.

Enumerator
MC_SOFTAP	wifi softap mode.
MC_STATION	wifi station mode.

Definition at line 62 of file mx_wifi.h.

anonymous enum

Wi-Fi scan mode.

Enumerator
MC_SCAN_PASSIVE	wifi passive scan mode.
MC_SCAN_ACTIVE	wifi active scan mode.

Definition at line 73 of file mx_wifi.h.

anonymous enum

**

Enumerator
MWIFI_EVENT_STA_DOWN	Wi-Fi station down event.
MWIFI_EVENT_STA_UP	Wi-Fi station up event.
MWIFI_EVENT_STA_GOT_IP	Wi-Fi station got ip event.
MWIFI_EVENT_AP_DOWN	Wi-Fi softap down event.
MWIFI_EVENT_AP_UP	Wi-Fi softap up event.

Definition at line 464 of file mx_wifi.h.

enum EapType

Wi-Fi EAP type.

Definition at line 95 of file mx_wifi.h.

enum mx_wifi_fota_status_e

FOTA status.

Definition at line 253 of file mx_wifi.h.

enum MX_WIFI_SecurityType_t

Security settings for wifi network.

Enumerator
MX_WIFI_SEC_NONE	Open system.
MX_WIFI_SEC_WEP	Wired Equivalent Privacy. WEP security.
MX_WIFI_SEC_WPA_TKIP	WPA /w TKIP.
MX_WIFI_SEC_WPA_AES	WPA /w AES.
MX_WIFI_SEC_WPA2_TKIP	WPA2 /w TKIP.
MX_WIFI_SEC_WPA2_AES	WPA2 /w AES.
MX_WIFI_SEC_WPA2_MIXED	WPA2 /w AES or TKIP.
MX_WIFI_SEC_AUTO	It is used when calling mwifi_connect, MXOS read security type from scan result.

Definition at line 158 of file mx_wifi.h.

Modules

Data Structures

Macros

Typedefs

Enumerations

Detailed Description

Macro Definition Documentation

Typedef Documentation

Enumeration Type Documentation

Important Information for this Arm website