Beacon Vendor Specific IE Filter API

Detailed Description

This API enables access to Vendor Specific information elements (IEs) in beacons.

The application can register a callback to be executed if Vendor Specific IEs containing one of the specified Organizational Unique Identifiers (OUIs). Up to MMWLAN_BEACON_VENDOR_IE_MAX_OUI_FILTERS can be specified.

Data Structures
struct	mmwlan_beacon_vendor_ie_filter
	Structure for storing beacon vendor ie filter parameter. More...

Macros
#define	MMWLAN_BEACON_VENDOR_IE_MAX_OUI_FILTERS   (5)
	Max number of OUIs supported in vendor IE OUI filter, mmwlan_beacon_vendor_ie_filter. More...

Typedefs
typedef void(*	mmwlan_beacon_vendor_ie_filter_cb_t) (const uint8_t *ies, uint32_t ies_len, void *arg)
	Beacon vendor ie filter callback function prototype. More...
typedef uint8_t	mmwlan_oui_t[MMWLAN_OUI_SIZE]
	24-bit OUI type. More...

Functions
enum mmwlan_status	mmwlan_update_beacon_vendor_ie_filter (const struct mmwlan_beacon_vendor_ie_filter *filter)
	Function to update the filter used to pass beacon back. More...

Macro Definition Documentation

MMWLAN_BEACON_VENDOR_IE_MAX_OUI_FILTERS

#define MMWLAN_BEACON_VENDOR_IE_MAX_OUI_FILTERS   (5)

Max number of OUIs supported in vendor IE OUI filter, mmwlan_beacon_vendor_ie_filter.

Definition at line 1590 of file mmwlan.h.

Typedef Documentation

mmwlan_beacon_vendor_ie_filter_cb_t

typedef void(* mmwlan_beacon_vendor_ie_filter_cb_t) (const uint8_t *ies, uint32_t ies_len, void *arg)

Beacon vendor ie filter callback function prototype.

Parameters

ies	Reference to the list of information elements (little endian order) present in the beacon that matched the filter.
ies_len	Length of the IE list in octets.
arg	Reference to the opaque argument provided with the filter.

Definition at line 1600 of file mmwlan.h.

mmwlan_oui_t

typedef uint8_t mmwlan_oui_t[MMWLAN_OUI_SIZE]

24-bit OUI type.

Definition at line 1604 of file mmwlan.h.

Function Documentation

mmwlan_update_beacon_vendor_ie_filter()

enum mmwlan_status mmwlan_update_beacon_vendor_ie_filter

(

const struct mmwlan_beacon_vendor_ie_filter *

filter

)

Function to update the filter used to pass beacon back.

Note

This will block until the filter has been installed or some error has occurred.

Parameters

filter

Reference to the filter to use. This must reside in memory and not be modified until after the filter is successfully cleared. To clear the filter pass NULL here.

Returns

MMWLAN_SUCCESS on success, else an appropriate error code.