This section describes the M2MB APIs for WLAN Scanning. More...

#define	M2MB_PROV_SSID_FILTER_SIZE 32

#define	M2MB_PROV_SECURITY_NONE_STR "none"

#define	M2MB_PROV_WEP_STR "wep"

#define	M2MB_PROV_WPA_PERSONAL_STR "wpa-personal"

#define	M2MB_PROV_WPA_ENTERPRISE_STR "wpa-enterprise"

#define	M2MB_PROV_SCAN_DWELL_TIME 150

#define	M2MB_PROV_SCAN_DELAY_TIME 150

#define	M2MB_PROV_REG_DOMAIN_FCC_MAX_CH 11

#define	M2MB_PROV_REG_DOMAIN_ETSI_MAX_CH 13

#define	M2MB_PROV_REG_DOMAIN_TELEC_MAX_CH 14

#define	M2MB_PROV_REG_DOMAIN_UNKNOWN_MAX_CH 14

#define	M2MB_PROV_REG_DOMAIN_FCC_STR "fcc"

#define	M2MB_PROV_REG_DOMAIN_ETSI_STR "etsi"

#define	M2MB_PROV_REG_DOMAIN_ETSI_MEXS_STR "etsi_mex"

#define	M2MB_PROV_REG_DOMAIN_TELEC_STR "telec"

#define	M2MB_PROV_REG_DOMAIN_UNKNOWN_STR "unknown"

#define	M2MB_PROV_2_4_GHZ_BAND "2.4GHz"

#define	M2MB_PROV_5_GHZ_BAND "5GHz"

typedef UINT64	M2MB_PROV_MAC_ADDR_T

typedef struct M2MB_PROV_SCAN_PARAM	M2MB_PROV_SCAN_PARAM_T
	Definition of structure controlling scan. More...

typedef struct M2MB_PROV_SCAN_RESULT	M2MB_PROV_SCAN_RESULT_T
	Definition of structure describing scan results. More...

VOID	m2mb_prov_scan_channel_fill (UINT8 *chTable, UINT8 domain, UINT8 phyMode)
	To fill valid channel numbers depending on current reg domain and PHY mode This function shall be called during scan or connect. More...

M2MB_OS_RESULT_E	m2mb_prov_scan_channels (M2MB_PROV_SCAN_PARAM_T sParams, M2MB_PROV_SCAN_RESULT_T pScanResult, INT32 *maxScanElements)
	Scan for Networks This function scans the configured channels for networks configuration parameter provided. More...

Detailed Description

This section describes the M2MB APIs for WLAN Scanning.

Macro Definition Documentation

◆ M2MB_PROV_2_4_GHZ_BAND

#define M2MB_PROV_2_4_GHZ_BAND "2.4GHz"

Definition at line 110 of file m2mb_wlan_scan.h.

◆ M2MB_PROV_5_GHZ_BAND

#define M2MB_PROV_5_GHZ_BAND "5GHz"

Definition at line 111 of file m2mb_wlan_scan.h.

◆ M2MB_PROV_REG_DOMAIN_ETSI_MAX_CH

#define M2MB_PROV_REG_DOMAIN_ETSI_MAX_CH 13

Maximum number of channels specified by TELEC

Definition at line 87 of file m2mb_wlan_scan.h.

◆ M2MB_PROV_REG_DOMAIN_ETSI_MEXS_STR

#define M2MB_PROV_REG_DOMAIN_ETSI_MEXS_STR "etsi_mex"

Definition at line 106 of file m2mb_wlan_scan.h.

◆ M2MB_PROV_REG_DOMAIN_ETSI_STR

#define M2MB_PROV_REG_DOMAIN_ETSI_STR "etsi"

Definition at line 105 of file m2mb_wlan_scan.h.

◆ M2MB_PROV_REG_DOMAIN_FCC_MAX_CH

#define M2MB_PROV_REG_DOMAIN_FCC_MAX_CH 11

Maximum number of channels specified by ETSI

Definition at line 84 of file m2mb_wlan_scan.h.

◆ M2MB_PROV_REG_DOMAIN_FCC_STR

#define M2MB_PROV_REG_DOMAIN_FCC_STR "fcc"

Definition at line 104 of file m2mb_wlan_scan.h.

◆ M2MB_PROV_REG_DOMAIN_TELEC_MAX_CH

#define M2MB_PROV_REG_DOMAIN_TELEC_MAX_CH 14

Maximum number of frequency bands supported

Definition at line 90 of file m2mb_wlan_scan.h.

◆ M2MB_PROV_REG_DOMAIN_TELEC_STR

#define M2MB_PROV_REG_DOMAIN_TELEC_STR "telec"

Definition at line 107 of file m2mb_wlan_scan.h.

◆ M2MB_PROV_REG_DOMAIN_UNKNOWN_MAX_CH

#define M2MB_PROV_REG_DOMAIN_UNKNOWN_MAX_CH 14

<Maximum number of channels when no regulatory domain is specified

Definition at line 102 of file m2mb_wlan_scan.h.

◆ M2MB_PROV_REG_DOMAIN_UNKNOWN_STR

#define M2MB_PROV_REG_DOMAIN_UNKNOWN_STR "unknown"

Definition at line 108 of file m2mb_wlan_scan.h.

◆ M2MB_PROV_SCAN_DELAY_TIME

#define M2MB_PROV_SCAN_DELAY_TIME 150

Maximum number of channels specified by FCCs

Definition at line 64 of file m2mb_wlan_scan.h.

◆ M2MB_PROV_SCAN_DWELL_TIME

#define M2MB_PROV_SCAN_DWELL_TIME 150

Delay between switching channels (quiet time) in milliseconds

Definition at line 61 of file m2mb_wlan_scan.h.

◆ M2MB_PROV_SECURITY_NONE_STR

#define M2MB_PROV_SECURITY_NONE_STR "none"

Definition of WLAN WEP security method string

Definition at line 49 of file m2mb_wlan_scan.h.

◆ M2MB_PROV_SSID_FILTER_SIZE

#define M2MB_PROV_SSID_FILTER_SIZE 32

< Global macros< Max Length of the SSID filter Definition of WLAN "No Security" string

Definition at line 46 of file m2mb_wlan_scan.h.

◆ M2MB_PROV_WEP_STR

#define M2MB_PROV_WEP_STR "wep"

Definition of WLAN WPA Personal security method string

Definition at line 52 of file m2mb_wlan_scan.h.

◆ M2MB_PROV_WPA_ENTERPRISE_STR

#define M2MB_PROV_WPA_ENTERPRISE_STR "wpa-enterprise"

Scan time on channel (dwell time) in milliseconds

Definition at line 58 of file m2mb_wlan_scan.h.

◆ M2MB_PROV_WPA_PERSONAL_STR

#define M2MB_PROV_WPA_PERSONAL_STR "wpa-personal"

Definition of WLAN WPA Enterprise security method string

Definition at line 55 of file m2mb_wlan_scan.h.

Typedef Documentation

◆ M2MB_PROV_MAC_ADDR_T

typedef UINT64 M2MB_PROV_MAC_ADDR_T

Definition at line 113 of file m2mb_wlan_scan.h.

◆ M2MB_PROV_SCAN_PARAM_T

typedef struct M2MB_PROV_SCAN_PARAM M2MB_PROV_SCAN_PARAM_T

Definition of structure controlling scan.

◆ M2MB_PROV_SCAN_RESULT_T

typedef struct M2MB_PROV_SCAN_RESULT M2MB_PROV_SCAN_RESULT_T

Definition of structure describing scan results.

Function Documentation

◆ m2mb_prov_scan_channel_fill()

VOID m2mb_prov_scan_channel_fill	(	UINT8 *	chTable,
		UINT8	domain,
		UINT8	phyMode
	)

To fill valid channel numbers depending on current reg domain and PHY mode This function shall be called during scan or connect.

Parameters

chTable	: Pointer to array to hold the valid channel numbers
domain	: Regulatory domain
phyMode	: PHY mode. If ZERO passed then currently configured phymode used

Return values

none. Important Note: chTable[] array size must be M2MB_PROV_WLAN_MAX_CHNLS+1

◆ m2mb_prov_scan_channels()

M2MB_OS_RESULT_E m2mb_prov_scan_channels	(	M2MB_PROV_SCAN_PARAM_T *	sParams,
		M2MB_PROV_SCAN_RESULT_T *	pScanResult,
		INT32 *	maxScanElements
	)

Scan for Networks This function scans the configured channels for networks configuration parameter provided.

Parameters

sParams	- IN Pointer to Scan Parameters structure
pScanResult	- OUT Pointer to Scan Results structure
maxScanElements	- IN/OUT Pointer to number of elements in scan results

Returns: M2MB_OS_SUCCESS If Operation successful.; Else Operation failed.