RDK-B
WIFI HAL APIs

Description

Data Structures

struct  _wifi_eap_config_t
 Set the Fast Transition capability to disabled, full FT. More...
 

Typedefs

typedef int(* wifi_newApAssociatedDevice_callback) (int apIndex, wifi_associated_dev_t *associated_dev)
 This call back will be invoked when new wifi client come to associate to Access Point. More...
 
typedef int(* wifi_apDisassociatedDevice_callback) (int apIndex, char *MAC, int event_type)
 This call back will be invoked when new wifi client disassociates from Access Point. More...
 
typedef int(* wifi_apDeAuthEvent_callback) (int ap_index, char *mac, int reason)
 This call back will be invoked when DeAuth Event (reason 2 wrong password) comes from client. More...
 
typedef void(* wifi_steering_eventCB_t) (unsigned int steeringgroupIndex, wifi_steering_event_t *event)
 Wifi Steering Event Callback Definition. More...
 
typedef int(* wifi_apAuthEvent_callback) (int apIndex, char *MAC, int event_type)
 
typedef int(* wifi_apAuthenticatedEvent_callback) (int apIndex, char *MAC)
 
typedef int(* wifi_apAssociatedDevice_callback) (int apIndex, char *MAC, int event_type)
 
typedef struct _wifi_eap_config_t wifi_eap_config_t
 Set the Fast Transition capability to disabled, full FT. More...
 
typedef int(* wifi_BTMQueryRequest_callback) (unsigned int apIndex, char *peerMac, wifi_BTMQuery_t *query, unsigned int inMemSize, wifi_BTMRequest_t *request)
 This call back is invoked when a STA sends a BTM query message to a vAP in the gateway. The driver will use the frame returned from this function to process the response to the query. A BTM transaction is started by a STA sending a query or by the AP sending an autonomous request. This callback is used for the former. More...
 
typedef int(* wifi_BTMResponse_callback) (unsigned int apIndex, char *peerMac, wifi_BTMResponse_t *response)
 This call back is invoked when a STA responds to a BTM Request from the gateway. More...
 
typedef int(* wifi_RMBeaconReport_callback) (unsigned int apIndex, wifi_BeaconReport_t *out_struct, unsigned int *out_array_size, unsigned char *out_DialogToken)
 
typedef void(* wifi_dppAuthResponse_callback_t) (unsigned int apIndex, mac_address_t sta, unsigned char *frame, unsigned int len)
 
typedef void(* wifi_dppConfigRequest_callback_t) (unsigned int apIndex, mac_address_t sta, unsigned char token, unsigned char *attribs, unsigned int length)
 
typedef int(* wifi_receivedMgmtFrame_callback) (int apIndex, unsigned char *sta_mac, unsigned char *frame, unsigned int len, wifi_mgmtFrameType_t type)
 
typedef int(* wifi_newApAssociatedDevice_callback) (int apIndex, wifi_associated_dev_t *associated_dev)
 
typedef int(* wifi_apAuthEvent_callback) (int apIndex, char *MAC, int event_type)
 

Functions

int wifi_getRadioChannelStats (int radioIndex, wifi_channelStats_t *input_output_channelStats_array, int array_size)
 Get the all (currently used by configured regualtory domain) Radio channel utilization status. More...
 
int wifi_getRadioChannelStats2 (int radioIndex, wifi_channelStats2_t *outputChannelStats2)
 
int wifi_getApAssociatedDeviceRxStatsResult (int radioIndex, mac_address_t *clientMacAddress, wifi_associated_dev_rate_info_rx_stats_t **stats_array, unsigned int *output_array_size, unsigned long long *handle)
 Get the associated client per rate receive status. More...
 
int wifi_getApAssociatedDeviceTxStatsResult (int radioIndex, mac_address_t *clientMacAddress, wifi_associated_dev_rate_info_tx_stats_t **stats_array, unsigned int *output_array_size, unsigned long long *handle)
 Get the associated client per rate transmission status. More...
 
int wifi_getApAssociatedDeviceTidStatsResult (int radioIndex, mac_address_t *clientMacAddress, wifi_associated_dev_tid_stats_t *tid_stats, unsigned long long *handle)
 Get the associated client per rate transmission status. More...
 
int wifi_getApAssociatedDeviceStats (int apIndex, mac_address_t *clientMacAddress, wifi_associated_dev_stats_t *associated_dev_stats, unsigned long long *handle)
 Get the associated device status. More...
 
int wifi_getHalVersion (char *output_string)
 Get the wifi hal version in string. More...
 
int wifi_factoryReset ()
 Clears internal variables to implement a factory reset of the Wi-Fi subsystem. More...
 
int wifi_factoryResetRadios ()
 Restore all radio parameters without touching access point parameters. More...
 
int wifi_factoryResetRadio (int radioIndex)
 Restore selected radio parameters without touching access point parameters. More...
 
int wifi_setLED (int radioIndex, unsigned char enable)
 Set the system LED status. More...
 
int wifi_init ()
 This function call initializes all Wi-Fi radios. More...
 
int wifi_reset ()
 Resets the Wifi subsystem. This includes reset of all Access Point variables. More...
 
int wifi_down ()
 Turns off transmit power for the entire Wifi subsystem, for all radios. More...
 
int wifi_createInitialConfigFiles ()
 This function creates wifi configuration files. More...
 
int wifi_getRadioCountryCode (int radioIndex, char *output_string)
 Outputs the country code to a max 64 character string. More...
 
int wifi_setRadioCountryCode (int radioIndex, char *CountryCode)
 Set the country code for selected Wi-Fi radio channel. More...
 
int wifi_pushCountryCode (char *CountryCode)
 Set the country code for both wifi radios and apply them. wifi reset automatically if necessary. The function need to return immediately. More...
 
int wifi_getATMCapable (unsigned char *output_bool)
 Get the ATM(Air Time Management) Capable. More...
 
int wifi_setATMEnable (unsigned char enable)
 Set ATM Enable. More...
 
int wifi_getATMEnable (unsigned char *output_enable)
 Get ATM Enable status. More...
 
int wifi_setApATMAirTimePercent (int apIndex, unsigned int ap_AirTimePercent)
 Set Access Point Air Time Percent. More...
 
int wifi_getApATMAirTimePercent (int apIndex, unsigned int *output_ap_AirTimePercent)
 Get Ap Air Time Percent. More...
 
int wifi_getApATMSta (int apIndex, unsigned char *output_sta_MAC_ATM_array, unsigned int buf_size)
 Get the list for Air Time Percent for each Station. More...
 
int wifi_setApATMSta (int apIndex, unsigned char *sta_MAC, unsigned int sta_AirTimePercent)
 Set Air Time Percent for each Station. More...
 
int wifi_getRadioNumberOfEntries (unsigned long *output)
 Get the total number of radios in this wifi subsystem. More...
 
int wifi_getSSIDNumberOfEntries (unsigned long *output)
 Get the total number of SSID entries in this wifi subsystem. More...
 
int wifi_getRadioEnable (int radioIndex, unsigned char *output_bool)
 Get the Radio enable config parameter. More...
 
int wifi_setRadioEnable (int radioIndex, unsigned char enable)
 Set the Radio enable config parameter. More...
 
int wifi_getRadioStatus (int radioIndex, unsigned char *output_bool)
 Get the Radio enable status. More...
 
int wifi_getRadioIfName (int radioIndex, char *output_string)
 Get the Radio Interface name from platform, eg "wifi0". More...
 
int wifi_getRadioMaxBitRate (int radioIndex, char *output_string)
 Get the maximum PHY bit rate supported by this interface. eg: "216.7 Mb/s", "1.3 Gb/s". More...
 
int wifi_getRadioSupportedFrequencyBands (int radioIndex, char *output_string)
 Get Supported frequency bands at which the radio can operate. eg: "2.4GHz,5GHz". More...
 
int wifi_getRadioOperatingFrequencyBand (int radioIndex, char *output_string)
 Get the frequency band at which the radio is operating, eg: "2.4GHz". More...
 
int wifi_getRadioSupportedStandards (int radioIndex, char *output_string)
 Get the Supported Radio Mode. eg: "b,g,n"; "n,ac"; "ax"; "a,n,ac,ax". More...
 
int wifi_getRadioStandard (int radioIndex, char *output_string, unsigned char *gOnly, unsigned char *nOnly, unsigned char *acOnly)
 Get the radio operating mode, and pure mode flag. eg: "ac". More...
 
int wifi_getRadioMode (int radioIndex, char *output_string, unsigned int *pureMode)
 Get the radio operating mode, and pure mode flag. eg: "ac". More...
 
int wifi_setRadioChannelMode (int radioIndex, char *channelMode, unsigned char gOnlyFlag, unsigned char nOnlyFlag, unsigned char acOnlyFlag)
 Set the radio operating mode, and pure mode flag. More...
 
int wifi_setRadioMode (int radioIndex, char *channelMode, unsigned int pureMode)
 Set the radio operating mode, and pure mode flag. More...
 
int wifi_getRadioPossibleChannels (int radioIndex, char *output_string)
 Get the list of supported channel. eg: "1-11". More...
 
int wifi_getRadioChannelsInUse (int radioIndex, char *output_string)
 Get the list of supported channel. eg: "1-11". More...
 
int wifi_getRadioChannel (int radioIndex, unsigned long *output_ulong)
 Get the running channel number. More...
 
int wifi_setRadioChannel (int radioIndex, unsigned long channel)
 Set the running channel number. More...
 
int wifi_setRadioAutoChannelEnable (int radioIndex, unsigned char enable)
 Enables or disables a driver level variable to indicate if auto channel selection is enabled on this radio. More...
 
int wifi_getRadioAutoChannelSupported (int radioIndex, unsigned char *output_bool)
 Check if the driver support the AutoChannel. More...
 
int wifi_getRadioAutoChannelEnable (int radioIndex, unsigned char *output_bool)
 Get the AutoChannel enable status. More...
 
int wifi_getRadioDCSSupported (int radioIndex, unsigned char *output_bool)
 Check if the driver support the DCS. More...
 
int wifi_getRadioDCSEnable (int radioIndex, unsigned char *output_bool)
 Get DCS of the selected wifi radio channel's enable/disable status. More...
 
int wifi_setRadioDCSEnable (int radioIndex, unsigned char enable)
 Enable/Disable selected wifi radio channel's DCS. More...
 
int wifi_getRadioDCSChannelPool (int radioIndex, char *output_pool)
 Get radio DCS channel pool. More...
 
int wifi_setRadioDCSChannelPool (int radioIndex, char *pool)
 Set radio DCS channel pool. More...
 
int wifi_getRadioDCSScanTime (int radioIndex, int *output_interval_seconds, int *output_dwell_milliseconds)
 Get radio DCS scan time. More...
 
int wifi_setRadioDCSScanTime (int radioIndex, int interval_seconds, int dwell_milliseconds)
 Set radio DCS scan time. More...
 
int wifi_setRadioDcsDwelltime (int radioIndex, int millisecond)
 Set radio Dcs Dwell time. More...
 
int wifi_getRadioDcsDwelltime (int radioIndex, int *output_millisecond)
 Get radio Dcs Dwell time. More...
 
int wifi_setRadioDcsScanning (int radioIndex, unsigned char enable)
 Enable/Disable selected wifi radio channel's DCS. More...
 
int wifi_getRadioDcsScanning (int radioIndex, unsigned char *output_bool)
 Get DCS of the selected wifi radio channel's enable/disable status. More...
 
int wifi_getRadioDcsChannelMetrics (int radioIndex, wifi_channelMetrics_t *input_output_channelMetrics_array, int array_size)
 Get radio Channel Metrics. More...
 
int wifi_pushRadioChannel (int radioIndex, unsigned int channel)
 Instantlly change the radio Channel. More...
 
int wifi_pushRadioChannel2 (int radioIndex, unsigned int channel, unsigned int channel_width_MHz, unsigned int csa_beacon_count)
 This HAL API is used to change the channel to destination channel, with destination bandwidth. More...
 
int wifi_getRadioDfsSupport (int radioIndex, unsigned char *output_bool)
 Get radio DFS support. More...
 
int wifi_getRadioDfsEnable (int radioIndex, unsigned char *output_bool)
 Get the Dfs enable status. More...
 
int wifi_setRadioDfsEnable (int radioIndex, unsigned char enabled)
 Set the Dfs enable status. More...
 
int wifi_getRadioAutoChannelRefreshPeriodSupported (int radioIndex, unsigned char *output_bool)
 Check if the driver support the AutoChannelRefreshPeriod. More...
 
int wifi_getRadioAutoChannelRefreshPeriod (int radioIndex, unsigned long *output_ulong)
 Get the DCS refresh period in seconds. More...
 
int wifi_setRadioAutoChannelRefreshPeriod (int radioIndex, unsigned long seconds)
 Set the DCS refresh period in seconds. More...
 
int wifi_getRadioOperatingChannelBandwidth (int radioIndex, char *output_string)
 Get the Operating Channel Bandwidth. eg "20MHz", "40MHz", "80MHz", "80+80", "160". More...
 
int wifi_setRadioOperatingChannelBandwidth (int radioIndex, char *bandwidth)
 Set the Operating Channel Bandwidth. eg "20MHz", "40MHz", "80MHz", "80+80", "160". More...
 
int wifi_getRadioExtChannel (int radioIndex, char *output_string)
 Get the secondary extension channel position. More...
 
int wifi_setRadioExtChannel (int radioIndex, char *string)
 Set the secondary extension channel position. More...
 
int wifi_getRadioGuardInterval (int radioIndex, char *output_string)
 Get the guard interval value. eg "400nsec" or "800nsec". More...
 
int wifi_setRadioGuardInterval (int radioIndex, char *string)
 Set the guard interval value. eg "400nsec" or "800nsec". More...
 
int wifi_getRadioMCS (int radioIndex, int *output_INT)
 Get the Modulation Coding Scheme index, eg: "-1", "1", "15". More...
 
int wifi_setRadioMCS (int radioIndex, int MCS)
 Set the Modulation Coding Scheme index, eg: "-1", "1", "15". More...
 
int wifi_getRadioTransmitPowerSupported (int radioIndex, char *output_list)
 Get supported Transmit Power list, eg : "0,25,50,75,100". More...
 
int wifi_getRadioTransmitPower (int radioIndex, unsigned long *output_ulong)
 Get current Transmit Power in dBm units. More...
 
int wifi_getRadioPercentageTransmitPower (int radioIndex, unsigned long *output_ulong)
 Get current Transmit Power level in units of full power. More...
 
int wifi_setRadioTransmitPower (int radioIndex, unsigned long TransmitPower)
 Set current Transmit Power, eg "75", "100". More...
 
int wifi_getRadioIEEE80211hSupported (int radioIndex, unsigned char *Supported)
 Get 80211h Supported. More...
 
int wifi_getRadioIEEE80211hEnabled (int radioIndex, unsigned char *enable)
 Get 80211h feature enable. More...
 
int wifi_setRadioIEEE80211hEnabled (int radioIndex, unsigned char enable)
 Set 80211h feature enable. More...
 
int wifi_getRadioCarrierSenseThresholdRange (int radioIndex, int *output)
 Indicates the Carrier Sense ranges supported by the radio. More...
 
int wifi_getRadioCarrierSenseThresholdInUse (int radioIndex, int *output)
 The RSSI signal level at which CS/CCA detects a busy condition. More...
 
int wifi_setRadioCarrierSenseThresholdInUse (int radioIndex, int threshold)
 Set Carrier sense threshold in use for the selected radio index. More...
 
int wifi_getRadioBeaconPeriod (int radioIndex, unsigned int *output)
 Gets the time interval between transmitting beacons (expressed in milliseconds). More...
 
int wifi_setRadioBeaconPeriod (int radioIndex, unsigned int BeaconPeriod)
 Sets the time interval between transmitting beacons (expressed in milliseconds). More...
 
int wifi_getRadioBasicDataTransmitRates (int radioIndex, char *output)
 Get the set of data rates, in Mbps. More...
 
int wifi_setRadioBasicDataTransmitRates (int radioIndex, char *TransmitRates)
 Set the data rates, in Mbps. More...
 
int wifi_getRadioSupportedDataTransmitRates (int radioIndex, char *output_rates)
 Get the supported data transmit rates in Mbps. More...
 
int wifi_getRadioOperationalDataTransmitRates (int radioIndex, char *output_rates)
 Get the set of data rates, in Mbps, that have to be supported by all stations that desire to join this BSS. More...
 
int wifi_setRadioOperationalDataTransmitRates (int radioIndex, char *rates)
 Set the data rates, in Mbps, that have to be supported by all stations that desire to join this BSS. More...
 
int wifi_getRadioTrafficStats2 (int radioIndex, wifi_radioTrafficStats2_t *output_struct)
 Get detail radio traffic static info. More...
 
int wifi_setRadioTrafficStatsMeasure (int radioIndex, wifi_radioTrafficStatsMeasure_t *input_struct)
 Set radio traffic static Measuring rules. More...
 
int wifi_setRadioTrafficStatsRadioStatisticsEnable (int radioIndex, unsigned char enable)
 Set radio traffic statistics enable. More...
 
int wifi_getRadioStatsReceivedSignalLevel (int radioIndex, int signalIndex, int *SignalLevel)
 Clients associated with the AP over a specific interval. More...
 
int wifi_applyRadioSettings (int radioIndex)
 This API is used to apply (push) all previously set radio level variables and make these settings active in the hardware. More...
 
int wifi_getRadioResetCount (int radioIndex, unsigned long *output_int)
 Get the radio reset count. More...
 
int wifi_getSSIDRadioIndex (int ssidIndex, int *radioIndex)
 Get the radio index associated with the SSID entry. More...
 
int wifi_getSSIDEnable (int ssidIndex, unsigned char *output_bool)
 Get SSID enable configuration parameters (not the SSID enable status). More...
 
int wifi_setSSIDEnable (int ssidIndex, unsigned char enable)
 Set SSID enable configuration parameters. More...
 
int wifi_getSSIDStatus (int ssidIndex, char *output_string)
 Get SSID enable status. Device.WiFi.SSID.{i}.Status. More...
 
int wifi_getSSIDName (int apIndex, char *output_string)
 Get SSID Name associated with the Access Point index. More...
 
int wifi_getSSIDNameStatus (int apIndex, char *output_string)
 To read the run time ssid name. More...
 
int wifi_setSSIDName (int apIndex, char *ssid_string)
 Set SSID Name associated with the Access Point index. More...
 
int wifi_getBaseBSSID (int ssidIndex, char *output_string)
 Get the BSSID. More...
 
int wifi_getSSIDMACAddress (int ssidIndex, char *output_string)
 Get the MAC address associated with this Wifi SSID. More...
 
int wifi_getSSIDTrafficStats2 (int ssidIndex, wifi_ssidTrafficStats2_t *output_struct)
 Get the basic SSID traffic static info. More...
 
int wifi_applySSIDSettings (int ssidIndex)
 Apply SSID and AP (in the case of Acess Point devices) to the hardware. More...
 
int wifi_getNeighboringWiFiDiagnosticResult2 (int radioIndex, wifi_neighbor_ap2_t **neighbor_ap_array, unsigned int *output_array_size)
 Start the wifi scan and get the result into output buffer for RDKB to parser. More...
 
int wifi_getNeighboringWiFiStatus (int radioIndex, wifi_neighbor_ap2_t **neighbor_ap_array, unsigned int *output_array_size)
 Returns the Wifi scan status. More...
 
int wifi_startNeighborScan (int apIndex, wifi_neighborScanMode_t scan_mode, int dwell_time, unsigned int chan_num, unsigned int *chan_list)
 This API initates the scanning. More...
 
int wifi_getSSIDTrafficStats (int ssidIndex, wifi_ssidTrafficStats_t *output_struct)
 
int wifi_getBasicTrafficStats (int apIndex, wifi_basicTrafficStats_t *output_struct)
 Outputs basic traffic stats per AP. More...
 
int wifi_getWifiTrafficStats (int apIndex, wifi_trafficStats_t *output_struct)
 Outputs more detailed traffic stats per AP. More...
 
int wifi_getNeighboringWiFiDiagnosticResult (wifi_neighbor_ap_t **neighbor_ap_array, unsigned int *output_array_size)
 
int wifi_getAllAssociatedDeviceDetail (int apIndex, unsigned long *output_ulong, wifi_device_t **output_struct)
 
int wifi_getBandSteeringCapability (unsigned char *support)
 To get Band Steering Capability. More...
 
int wifi_getBandSteeringEnable (unsigned char *enable)
 To get Band Steering enable status. More...
 
int wifi_setBandSteeringEnable (unsigned char enable)
 To turn on/off Band steering. More...
 
int wifi_getBandSteeringApGroup (char *output_ApGroup)
 To get Band Steering Access Point group. More...
 
int wifi_setBandSteeringApGroup (char *ApGroup)
 To set Band Steering Access Point group. More...
 
int wifi_getRadioBandUtilization (int radioIndex, int *output_percentage)
 To read the radio band utilization. More...
 
int wifi_getApAssociatedDevice (int ap_index, char *output_buf, int output_buf_size)
 Gets the ApAssociatedDevice list for client MAC addresses. More...
 
int wifi_getApDeviceRSSI (int ap_index, char *MAC, int *output_RSSI)
 Gets the RSSI value associated with the access point. More...
 
int wifi_getApDeviceRxrate (int ap_index, char *MAC, int *output_RxMb)
 Gets the ApAssociatedDevice Rx Rate. More...
 
int wifi_getApDeviceTxrate (int ap_index, char *MAC, int *output_TxMb)
 Gets the ApAssociatedDevice Tx Rate. More...
 
int wifi_getBandSteeringBandUtilizationThreshold (int radioIndex, int *pBuThreshold)
 To set and read the band steering BandUtilizationThreshold parameters. More...
 
int wifi_setBandSteeringBandUtilizationThreshold (int radioIndex, int buThreshold)
 To set the band steering BandUtilizationThreshold parameters. More...
 
int wifi_getBandSteeringRSSIThreshold (int radioIndex, int *pRssiThreshold)
 To read the band steering RSSIThreshold parameters. More...
 
int wifi_setBandSteeringRSSIThreshold (int radioIndex, int rssiThreshold)
 To set the band steering RSSIThreshold parameters. More...
 
int wifi_getBandSteeringPhyRateThreshold (int radioIndex, int *pPrThreshold)
 To read the band steering physical modulation rate threshold parameters. More...
 
int wifi_setBandSteeringPhyRateThreshold (int radioIndex, int prThreshold)
 To set the band steering physical modulation rate threshold parameters. More...
 
int wifi_getBandSteeringOverloadInactiveTime (int radioIndex, int *overloadInactiveTime)
 To read the inactivity time (in seconds) for steering under overload condition. More...
 
int wifi_setBandSteeringOverloadInactiveTime (int radioIndex, int overloadInactiveTime)
 To set the inactivity time (in seconds) for steering under overload condition. More...
 
int wifi_getBandSteeringIdleInactiveTime (int radioIndex, int *idleInactiveTime)
 To read the inactivity time (in seconds) for steering under Idle condition. More...
 
int wifi_setBandSteeringIdleInactiveTime (int radioIndex, int idleInactiveTime)
 To set the inactivity time (in seconds) for steering under Idle condition. More...
 
int wifi_getBandSteeringLog (int record_index, unsigned long *pSteeringTime, char *pClientMAC, int *pSourceSSIDIndex, int *pDestSSIDIndex, int *pSteeringReason)
 To get the band steering log. More...
 
int wifi_factoryResetAP (int apIndex)
 Restore Access point paramters to default without change other AP nor Radio parameters (No need to reboot wifi) More...
 
int wifi_setRadioCtsProtectionEnable (int apIndex, unsigned char enable)
 Enables CTS protection for the radio used by this Access Point. More...
 
int wifi_setRadioObssCoexistenceEnable (int apIndex, unsigned char enable)
 Enables OBSS Coexistence - fall back to 20MHz if necessary for the radio used by this AP. More...
 
int wifi_setRadioFragmentationThreshold (int apIndex, unsigned int threshold)
 Sets the fragmentation threshold in bytes for the radio used by this Access Point. More...
 
int wifi_setRadioSTBCEnable (int radioIndex, unsigned char STBC_Enable)
 Enable STBC mode in the hardware. 0 == not enabled, 1 == enabled. More...
 
int wifi_getRadioAMSDUEnable (int radioIndex, unsigned char *output_bool)
 Outputs A-MSDU enable status, 0 == not enabled, 1 == enabled. More...
 
int wifi_setRadioAMSDUEnable (int radioIndex, unsigned char amsduEnable)
 Enables A-MSDU in the hardware, 0 == not enabled, 1 == enabled. More...
 
int wifi_getRadioTxChainMask (int radioIndex, int *output_int)
 Outputs the number of Tx streams. More...
 
int wifi_setRadioTxChainMask (int radioIndex, int numStreams)
 Sets the number of Tx streams to an environment variable. More...
 
int wifi_getRadioRxChainMask (int radioIndex, int *output_int)
 Outputs the number of Rx streams. More...
 
int wifi_setRadioRxChainMask (int radioIndex, int numStreams)
 Sets the number of Rx streams to an environment variable. More...
 
int wifi_pushBridgeInfo (int apIndex)
 
int wifi_pushRadioChannelMode (int radioIndex)
 
int wifi_pushRadioTxChainMask (int radioIndex)
 
int wifi_pushRadioRxChainMask (int radioIndex)
 
int wifi_pushSSID (int apIndex, char *ssid)
 Push the environment variable that is set by "wifi_setSsidName" to the hardware. More...
 
int wifi_pushSsidAdvertisementEnable (int apIndex, unsigned char enable)
 Push the environment variable that is set by "wifi_setApSsidAdvertisementEnable" to the hardware. More...
 
int wifi_getRadioUpTime (int radioIndex, unsigned long *uptime)
 Get the number of seconds elapsed since radio is started. More...
 
int wifi_getRadioReverseDirectionGrantSupported (int radioIndex, unsigned char *output_bool)
 Get radio RDG enable Support. More...
 
int wifi_getRadioReverseDirectionGrantEnable (int radioIndex, unsigned char *output_bool)
 Get radio RDG enable setting. More...
 
int wifi_setRadioReverseDirectionGrantEnable (int radioIndex, unsigned char enable)
 Set radio RDG enable setting. More...
 
int wifi_getRadioDeclineBARequestEnable (int radioIndex, unsigned char *output_bool)
 Get radio ADDBA (ADD Block Acknowledgement) enable setting. More...
 
int wifi_setRadioDeclineBARequestEnable (int radioIndex, unsigned char enable)
 Set radio ADDBA (ADD Block Acknowledgement) enable setting. More...
 
int wifi_getRadioAutoBlockAckEnable (int radioIndex, unsigned char *output_bool)
 Get radio auto block ack enable setting. More...
 
int wifi_setRadioAutoBlockAckEnable (int radioIndex, unsigned char enable)
 Set radio auto block ack enable setting. More...
 
int wifi_getRadio11nGreenfieldSupported (int radioIndex, unsigned char *output_bool)
 Get radio 11n pure mode enable support. More...
 
int wifi_getRadio11nGreenfieldEnable (int radioIndex, unsigned char *output_bool)
 Get radio 11n pure mode enable setting. More...
 
int wifi_setRadio11nGreenfieldEnable (int radioIndex, unsigned char enable)
 Set radio 11n pure mode enable setting. More...
 
int wifi_getRadioIGMPSnoopingEnable (int radioIndex, unsigned char *output_bool)
 Get radio IGMP snooping enable setting. More...
 
int wifi_setRadioIGMPSnoopingEnable (int radioIndex, unsigned char enable)
 Set radio IGMP snooping enable setting. More...
 
int wifi_createAp (int apIndex, int radioIndex, char *essid, unsigned char hideSsid)
 Creates a new access point and pushes these parameters to the hardware. More...
 
int wifi_deleteAp (int apIndex)
 Deletes this access point entry on the hardware, clears all internal variables associated with this access point. More...
 
int wifi_getApName (int apIndex, char *output_string)
 Outputs a 16 byte or less name associated with the Access Point. String buffer must be pre-allocated by the caller. More...
 
int wifi_getApIndexFromName (char *inputSsidString, int *ouput_int)
 Outputs the index number in that corresponds to the SSID string. More...
 
int wifi_getApBeaconType (int apIndex, char *output_string)
 Outputs a 32 byte or less string indicating the beacon type as "None", "Basic", "WPA", "11i", "WPAand11i". More...
 
int wifi_setApBeaconType (int apIndex, char *beaconTypeString)
 Sets the beacon type environment variable. Allowed input strings are "None", "Basic", "WPA, "11i", "WPAand11i". More...
 
int wifi_setApBeaconInterval (int apIndex, int beaconInterval)
 Sets the beacon interval on the hardware for this Access Point. More...
 
int wifi_setApDTIMInterval (int apIndex, int dtimInterval)
 Sets the DTIM interval for this Access Point. More...
 
int wifi_getApRtsThresholdSupported (int apIndex, unsigned char *output_bool)
 Get the packet size threshold supported. More...
 
int wifi_setApRtsThreshold (int apIndex, unsigned int threshold)
 Sets the packet size threshold in bytes to apply RTS/CTS backoff rules. More...
 
int wifi_getApWpaEncryptionMode (int apIndex, char *output_string)
 Ouputs up to a 32 byte string as either "TKIPEncryption", "AESEncryption", or "TKIPandAESEncryption". More...
 
int wifi_setApWpaEncryptionMode (int apIndex, char *encMode)
 Sets the encyption mode environment variable. More...
 
int wifi_removeApSecVaribles (int apIndex)
 Deletes internal security variable settings for this access point. More...
 
int wifi_disableApEncryption (int apIndex)
 Changes the hardware settings to disable encryption on this access point. More...
 
int wifi_setApAuthMode (int apIndex, int mode)
 Set the authorization mode on this access point. More...
 
int wifi_setApBasicAuthenticationMode (int apIndex, char *authMode)
 Sets an environment variable for the authMode. More...
 
int wifi_getApNumDevicesAssociated (int apIndex, unsigned long *output_ulong)
 Outputs the number of stations associated per Access Point. More...
 
int wifi_kickApAssociatedDevice (int apIndex, char *client_mac)
 Manually removes any active wi-fi association with the device specified on this access point. More...
 
int wifi_getApRadioIndex (int apIndex, int *output_int)
 Outputs the radio index for the specified access point. More...
 
int wifi_setApRadioIndex (int apIndex, int radioIndex)
 Sets the radio index for the specific access point. More...
 
int wifi_getApAclDevices (int apIndex, char *macArray, unsigned int buf_size)
 Get the ACL MAC list per Access Point. More...
 
int wifi_addApAclDevice (int apIndex, char *DeviceMacAddress)
 Adds the mac address to the filter list. More...
 
int wifi_delApAclDevice (int apIndex, char *DeviceMacAddress)
 Deletes the Device MAC address from the Access control filter list. More...
 
int wifi_delApAclDevices (int apINdex)
 Deletes all Device MAC address from the Access control filter list. More...
 
int wifi_getApAclDeviceNum (int apIndex, unsigned int *output_uint)
 Outputs the number of devices in the filter list. More...
 
int wifi_kickApAclAssociatedDevices (int apIndex, unsigned char enable)
 Enable kick for devices on acl black list. More...
 
int wifi_setApMacAddressControlMode (int apIndex, int filterMode)
 Sets the mac address filter control mode. More...
 
int wifi_getApMacAddressControlMode (int apIndex, int *output_filterMode)
 This function is to read the ACL mode. More...
 
int wifi_setApVlanEnable (int apIndex, unsigned char VlanEnabled)
 Enables internal gateway VLAN mode. More...
 
int wifi_setApVlanID (int apIndex, int vlanId)
 Sets the vlan ID for this access point to an internal environment variable. More...
 
int wifi_getApBridgeInfo (int index, char *bridgeName, char *IP, char *subnet)
 Gets bridgeName, IP address and Subnet. More...
 
int wifi_setApBridgeInfo (int apIndex, char *bridgeName, char *IP, char *subnet)
 Sets bridgeName, IP address and Subnet to internal environment variables. More...
 
int wifi_resetApVlanCfg (int apIndex)
 Reset the vlan configuration for this access point. More...
 
int wifi_createHostApdConfig (int apIndex, unsigned char createWpsCfg)
 Creates configuration variables needed for WPA/WPS. More...
 
int wifi_startHostApd ()
 Starts hostapd. More...
 
int wifi_stopHostApd ()
 Stops hostapd. More...
 
int wifi_setApEnable (int apIndex, unsigned char enable)
 Sets the Access Point enable status variable for the specified access point. More...
 
int wifi_pushApEnable (int apIndex, unsigned char Enable)
 Dynamically enable/disable access point. More...
 
int wifi_getApEnable (int apIndex, unsigned char *output_bool)
 Outputs the setting of the internal variable that is set by wifi_setEnable(). More...
 
int wifi_getApStatus (int apIndex, char *output_string)
 Outputs the AP "Enabled" "Disabled" status from driver. More...
 
int wifi_getApSsidAdvertisementEnable (int apIndex, unsigned char *output_bool)
 Indicates whether or not beacons include the SSID name. More...
 
int wifi_setApSsidAdvertisementEnable (int apIndex, unsigned char enable)
 Sets an internal variable for ssid advertisement. More...
 
int wifi_pushApSsidAdvertisementEnable (int apIndex, unsigned char enable)
 Push the ssid advertisement enable variable to the hardware. More...
 
int wifi_getApRetryLimit (int apIndex, unsigned int *output)
 Get the maximum number of retransmission for a packet. More...
 
int wifi_setApRetryLimit (int apIndex, unsigned int number)
 Set the maximum number of retransmission for a packet. More...
 
int wifi_getApWMMCapability (int apIndex, unsigned char *output)
 Indicates whether this access point supports WiFi Multimedia (WMM) Access Categories (AC). Device.WiFi.AccessPoint.{i}.WMMCapability. More...
 
int wifi_getApUAPSDCapability (int apIndex, unsigned char *output)
 Indicates whether this access point supports WMM Unscheduled Automatic Power Save Delivery (U-APSD). More...
 
int wifi_getApWmmEnable (int apIndex, unsigned char *output)
 Indicates whether WMM support is currently enabled. More...
 
int wifi_setApWmmEnable (int apIndex, unsigned char enable)
 Enables/disables WMM on the hardwawre for this AP. enable==1, disable == 0. More...
 
int wifi_getApWmmUapsdEnable (int apIndex, unsigned char *output)
 Indicates whether U-APSD support is currently enabled. More...
 
int wifi_setApWmmUapsdEnable (int apIndex, unsigned char enable)
 Enables/disables Automatic Power Save Delivery on the hardwarwe for this Access Point. More...
 
int wifi_setApWmmOgAckPolicy (int apIndex, int cla, unsigned char ackPolicy)
 Sets the WMM ACK policy on the hardware. More...
 
int wifi_getApIsolationEnable (int apIndex, unsigned char *output)
 Get Access Point isolation value. More...
 
int wifi_setApIsolationEnable (int apIndex, unsigned char enable)
 Enables or disables device isolation. More...
 
int wifi_setApBeaconRate (int apIndex, char *sBeaconRate)
 Set Access Point Beacon TX rate. More...
 
int wifi_getApBeaconRate (int apIndex, char *output_BeaconRate)
 Get Access Point Beacon TX rate. More...
 
int wifi_getApMaxAssociatedDevices (int apIndex, unsigned int *output)
 Get maximum associated devices with the Access Point index. More...
 
int wifi_setApMaxAssociatedDevices (int apIndex, unsigned int number)
 Set maximum associated devices with the Access Point index. More...
 
int wifi_getApAssociatedDevicesHighWatermarkThreshold (int apIndex, unsigned int *output)
 Get the HighWatermarkThreshold value, that is lesser than or equal to MaxAssociatedDevices. More...
 
int wifi_setApAssociatedDevicesHighWatermarkThreshold (int apIndex, unsigned int Threshold)
 Set the HighWatermarkThreshold value, that is lesser than or equal to MaxAssociatedDevices. More...
 
int wifi_getApAssociatedDevicesHighWatermarkThresholdReached (int apIndex, unsigned int *output)
 Get the number of times the current total number of associated device has reached the HighWatermarkThreshold value. More...
 
int wifi_getApAssociatedDevicesHighWatermark (int apIndex, unsigned int *output)
 Maximum number of associated devices that have ever associated with the access point concurrently since the last reset of the device or WiFi module. Device.WiFi.AccessPoint.{i}.X_COMCAST-COM_AssociatedDevicesHighWatermark. More...
 
int wifi_getApAssociatedDevicesHighWatermarkDate (int apIndex, unsigned long *output_in_seconds)
 Get Date and Time at which the maximum number of associated devices ever associated with the access point concurrently since the last reset of the device or WiFi module. More...
 
int wifi_getApSecurityModesSupported (int apIndex, char *output)
 Indicates which security modes this AccessPoint instance is capable of supporting. More...
 
int wifi_getApSecurityModeEnabled (int apIndex, char *output)
 Get the Security modes supported. More...
 
int wifi_setApSecurityModeEnabled (int apIndex, char *encMode)
 Enable supported security mode. More...
 
int wifi_getApSecurityPreSharedKey (int apIndex, char *output_string)
 Get PreSharedKey associated with a Access Point. More...
 
int wifi_setApSecurityPreSharedKey (int apIndex, char *preSharedKey)
 Set PreSharedKey associated with a Access Point. More...
 
int wifi_getApSecurityKeyPassphrase (int apIndex, char *output_string)
 Get a passphrase from which the PreSharedKey is to be generated for WPA-Personal or WPA2-Personal or. More...
 
int wifi_setApSecurityKeyPassphrase (int apIndex, char *passPhrase)
 Set a passphrase from which the PreSharedKey is to be generated, for WPA-Personal or WPA2-Personal or WPA-WPA2-Personal security modes. More...
 
int wifi_setApSecurityReset (int apIndex)
 When set to true, this AccessPoint instance's WiFi security settings are reset to their factory default values. More...
 
int wifi_getApSecurityMFPConfig (int apIndex, char *output_string)
 To retrive the MFPConfig for each VAP. More...
 
int wifi_setApSecurityMFPConfig (int apIndex, char *MfpConfig)
 the hal is used to set the MFP config for each VAP. More...
 
int wifi_getApSecurityRadiusServer (int apIndex, char *IP_output, unsigned int *Port_output, char *RadiusSecret_output)
 Get the IP Address and port number of the RADIUS server, which are used for WLAN security. More...
 
int wifi_setApSecurityRadiusServer (int apIndex, char *IPAddress, unsigned int port, char *RadiusSecret)
 Set the IP Address and port number of the RADIUS server, which are used for WLAN security. More...
 
int wifi_getApSecuritySecondaryRadiusServer (int apIndex, char *IP_output, unsigned int *Port_output, char *RadiusSecret_output)
 Get secondary IP Address, port number and RADIUS server. More...
 
int wifi_setApSecuritySecondaryRadiusServer (int apIndex, char *IPAddress, unsigned int port, char *RadiusSecret)
 Set secondary IP Address, port number and RADIUS server, which are used for WLAN security. More...
 
int wifi_getApSecurityRadiusSettings (int apIndex, wifi_radius_setting_t *output)
 Get Access Point security radius settings. More...
 
int wifi_setApSecurityRadiusSettings (int apIndex, wifi_radius_setting_t *input)
 Set Access Point security radius settings. More...
 
int wifi_getApWpsEnable (int apIndex, unsigned char *output_bool)
 Outputs the WPS enable state of this access point in output_bool. More...
 
int wifi_setApWpsEnable (int apIndex, unsigned char enableValue)
 Enables or disables WPS functionality for this access point. More...
 
int wifi_getApWpsConfigMethodsSupported (int apIndex, char *output)
 Indicates WPS configuration methods supported by the device. More...
 
int wifi_getApWpsConfigMethodsEnabled (int apIndex, char *output_string)
 Indicates WPS configuration methods enabled on the device. More...
 
int wifi_setApWpsConfigMethodsEnabled (int apIndex, char *methodString)
 Enable WPS configuration methods on the device. More...
 
int wifi_getApWpsDevicePIN (int apIndex, unsigned long *output_ulong)
 Outputs the WPS device pin value, ulong_pin must be allocated by the caller. More...
 
int wifi_setApWpsDevicePIN (int apIndex, unsigned long pin)
 Set an environment variable for the WPS pin for the selected Access Point. More...
 
int wifi_getApWpsConfigurationState (int apIndex, char *output_string)
 Get WPS configuration state. More...
 
int wifi_setApWpsEnrolleePin (int apIndex, char *pin)
 Sets the WPS pin for this Access Point. More...
 
int wifi_setApWpsButtonPush (int apIndex)
 This function is called when the WPS push button has been pressed for this AP. More...
 
int wifi_cancelApWPS (int apIndex)
 Cancels WPS mode for this Access Point. More...
 
int wifi_getApManagementFramePowerControl (int apIndex, int *output_dBm)
 Get the ApManagementFramePowerControl. More...
 
int wifi_setApManagementFramePowerControl (int apIndex, int dBm)
 Sets the ApManagementFramePowerControl. More...
 
int wifi_getApAssociatedDeviceDiagnosticResult (int apIndex, wifi_associated_dev_t **associated_dev_array, unsigned int *output_array_size)
 The function provides a list of the devices currently associated with the access point. More...
 
int wifi_getApAssociatedDeviceDiagnosticResult2 (int apIndex, wifi_associated_dev2_t **associated_dev_array, unsigned int *output_array_size)
 The function provides a list of the devices currently associated with the access point. More...
 
int wifi_getApAssociatedDeviceDiagnosticResult3 (int apIndex, wifi_associated_dev3_t **associated_dev_array, unsigned int *output_array_size)
 
int wifi_getApAssociatedClientDiagnosticResult (int apIndex, char *mac_addr, wifi_associated_dev3_t *dev_conn)
 
int wifi_setClientDetailedStatisticsEnable (int radioIndex, unsigned char enable)
 This function enabled/disabled collection of detailed statistics of associated clients on Access Point. More...
 
void wifi_newApAssociatedDevice_callback_register (wifi_newApAssociatedDevice_callback callback_proc)
 Callback registration function. More...
 
void wifi_apDisassociatedDevice_callback_register (wifi_apDisassociatedDevice_callback callback_proc)
 Callback registration function. More...
 
void wifi_apDeAuthEvent_callback_register (wifi_apDeAuthEvent_callback callback_proc)
 Callback registration function. More...
 
int wifi_getRadioStatsEnable (int radioIndex, unsigned char *output_enable)
 This API returns the radio enabled status. More...
 
int wifi_setRadioStatsEnable (int radioIndex, unsigned char enable)
 This API is to enable/disable radio status. More...
 
int wifi_setApCsaDeauth (int apIndex, int mode)
 This API set the CSA (Channel Switch Announcement) deauthentication to all clients before moving to a new channel, in the event some client doesn't support/react to CSA. More...
 
int wifi_setApScanFilter (int apIndex, int mode, char *essid)
 Enable/Disable scan filter in the driver. More...
 
unsigned char wifi_steering_supported (void)
 Steering API Supported. More...
 
int wifi_steering_setGroup (unsigned int steeringgroupIndex, wifi_steering_apConfig_t *cfg_2, wifi_steering_apConfig_t *cfg_5)
 Add a Steering Group. More...
 
int wifi_steering_eventRegister (wifi_steering_eventCB_t event_cb)
 Register for Steering Event Callbacks. More...
 
int wifi_steering_eventUnregister (void)
 Unregister for Steering Event Callbacks. More...
 
int wifi_steering_clientSet (unsigned int steeringgroupIndex, int apIndex, mac_address_t client_mac, wifi_steering_clientConfig_t *config)
 Add Client Config to apIndex. More...
 
int wifi_steering_clientRemove (unsigned int steeringgroupIndex, int apIndex, mac_address_t client_mac)
 Remove Client Config from apIndex. More...
 
int wifi_steering_clientMeasure (unsigned int steeringgroupIndex, int apIndex, mac_address_t client_mac)
 Initiate Instant Client RSSI Measurement. More...
 
int wifi_steering_clientDisconnect (unsigned int steeringgroupIndex, int apIndex, mac_address_t client_mac, wifi_disconnectType_t type, unsigned int reason)
 Initiate a Client Disconnect. More...
 
void wifi_apAuthEvent_callback_register (wifi_apAuthEvent_callback callback_proc)
 
int wifi_getApAuthenticatedDevices (int apIndex, mac_t **mac_array, unsigned int *output_array_size)
 
void wifi_apAuthenticatedEvent_callback_register (wifi_apAuthEvent_callback callback_proc)
 
int wifi_getRadioClientInactivityTimout (int radioIndex, int *output_timout_sec)
 
void wifi_apAssociatedDevice_callback_register (wifi_apAssociatedDevice_callback callback_proc)
 
int wifi_setInterworkingAccessNetworkType (int apIndex, int accessNetworkType)
 
int wifi_getInterworkingAccessNetworkType (int apIndex, unsigned int *output_uint)
 
int wifi_getApInterworkingServiceCapability (int apIndex, unsigned char *output_bool)
 Get the Interworking Service Capability of the AP. More...
 
int wifi_getApInterworkingServiceEnable (int apIndex, unsigned char *output_bool)
 Get the Interworking Service enable/disable value for the AP. More...
 
int wifi_setApInterworkingServiceEnable (int apIndex, unsigned char input_bool)
 Set the Interworking Service enable/disable value for the AP. More...
 
int wifi_getApInterworkingElement (int apIndex, wifi_InterworkingElement_t *output_struct)
 Get the Interworking Element that will be sent by the AP. More...
 
int wifi_pushApInterworkingElement (int apIndex, wifi_InterworkingElement_t *infoEelement)
 
int wifi_setFastBSSTransitionActivated (int apIndex, unsigned char activate)
 
int wifi_getBSSTransitionActivated (int apIndex, unsigned char *activate)
 Get the Fast Transition capability value. More...
 
unsigned int wifi_setEAP_Param (unsigned int apIndex, unsigned int value, char *param)
 Get the Fast Transition over DS activated value.
Set the EAP authentication and EAPOL Handshake parameters. EAPOL Key Timeout and max retries [M1 and M3] EAP Identity Request and max retries EAP Request Timeout and max retries. More...
 
unsigned int wifi_getEAP_Param (unsigned int apIndex, wifi_eap_config_t *output)
 
int wifi_getFTOverDSActivated (int apIndex, unsigned char *activate)
 
int wifi_setFTOverDSActivated (int apIndex, unsigned char *activate)
 Set the Fast Transition over DS activated value. See 802.11-2016 section 13.3. More...
 
int wifi_getFTMobilityDomainID (int apIndex, unsigned char mobilityDomain[2])
 Get the Fast Transition Mobility Domain value. See 802.11-2016 section 13.3. More...
 
int wifi_setFTMobilityDomainID (int apIndex, unsigned char mobilityDomain[2])
 Set the Fast Transition Mobility Domain value.
See 802.11-2016 section 13.3. More...
 
int wifi_getFTResourceRequestSupported (int apIndex, unsigned char *supported)
 Get the Fast Transition Resource Request Support value. See 802.11-2016 section 13.3. More...
 
int wifi_setFTResourceRequestSupported (int apIndex, unsigned char *supported)
 Set the Fast Transition Resource Request Support value.
See 802.11-2016 section 13.3. More...
 
int wifi_getFTR0KeyLifetime (int apIndex, unsigned int *lifetime)
 Get the Fast Transition R0 Key Lifetime value.
See 802.11-2016 section 13.4.2. More...
 
int wifi_setFTR0KeyLifetime (int apIndex, unsigned int *lifetime)
 Set the Fast Transition R0 Key Lifetime value.
See 802.11-2016 section 13.4.2. More...
 
int wifi_getFTR0KeyHolderID (int apIndex, unsigned char *keyHolderID)
 Get the Fast Transition R0 Key Holder ID value.
See 802.11-2016 section 13.3. More...
 
int wifi_setFTR0KeyHolderID (int apIndex, unsigned char *keyHolderID)
 Set the Fast Transition R0 Key Holder ID value.
See 802.11-2016 section 13.3. More...
 
int wifi_getFTR1KeyHolderID (int apIndex, unsigned char *keyHolderID)
 Get the Fast Transition R1 Key Holder ID value.
See 802.11-2016 section 13.3. More...
 
int wifi_setFTR1KeyHolderID (int apIndex, unsigned char *keyHolderID)
 Set the Fast Transition R1 Key Holder ID value.
See 802.11-2016 section 13.3. More...
 
int wifi_pushApFastTransitionConfig (int apIndex, wifi_FastTransitionConfig_t *ftData)
 
int wifi_BTMQueryRequest_callback_register (unsigned int apIndex, wifi_BTMQueryRequest_callback btmQueryCallback, wifi_BTMResponse_callback btmResponseCallback)
 BTM Query callback registration function. More...
 
int wifi_setBTMRequest (unsigned int apIndex, char *peerMac, wifi_BTMRequest_t *request)
 Set a BTM Request to a non-AP STA. The callback register function should be called first so that the response can be handled by the application. More...
 
int wifi_getBSSTransitionImplemented (unsigned int apIndex, unsigned char *activate)
 Get the BTM implemented value. When not implemented the gateway ignores a BTM query request as defined in 802.11-2016 section 11.11.10.3. More...
 
int wifi_setBSSTransitionActivation (unsigned int apIndex, unsigned char activate)
 Set the BTM capability to activated or deactivated, same as enabled or disabled. The word "activated" is used here because that's what's used in the 802.11 specification. When deactivate the gateway ignores a BTM report request as defined in 802.11-2016 section 11.11.10.3. The AP (apIndex) BSS Transition bit in any Extended Capabilities element sent out is set corresponding to the activate parameter. More...
 
int wifi_getBSSTransitionActivation (unsigned int apIndex, unsigned char *activate)
 
int wifi_getBTMClientCapabilityList (unsigned int apIndex, wifi_BTMCapabilities_t *extBTMCapabilities)
 
int wifi_setNeighborReports (unsigned int apIndex, unsigned int numNeighborReports, wifi_NeighborReport_t *neighborReports)
 
int wifi_setNeighborReportActivation (unsigned int apIndex, unsigned char activate)
 
int wifi_getNeighborReportActivation (unsigned int apIndex, unsigned char *activate)
 
int wifi_RMBeaconRequestCallbackRegister (unsigned int apIndex, wifi_RMBeaconReport_callback beaconReportCallback)
 
int wifi_RMBeaconRequestCallbackUnregister (unsigned int apIndex, wifi_RMBeaconReport_callback beaconReportCallback)
 
int wifi_setRMBeaconRequest (unsigned int apIndex, char *peer, wifi_BeaconRequest_t *in_request, unsigned char *out_DialogToken)
 
int wifi_cancelRMBeaconRequest (unsigned int apIndex, unsigned char dialogToken)
 
int wifi_getRMCapabilities (char *peer, unsigned char out_Capabilities[5])
 
int wifi_getVAPTelemetry (unsigned int apIndex, wifi_VAPTelemetry_t *telemetry)
 
int wifi_dppInitiate (wifi_device_dpp_context_t *ctx)
 
int wifi_dppCancel (wifi_device_dpp_context_t *ctx)
 
int wifi_dpp_frame_received_callbacks_register (wifi_dppAuthResponse_callback_t dppAuthCallback, wifi_dppConfigRequest_callback_t dppCpnfigCallback)
 
int wifi_dppSendAuthCnf (wifi_device_dpp_context_t *ctx)
 
int wifi_dppSendConfigResponse (wifi_device_dpp_context_t *ctx)
 
int wifi_dppSetSTAPassphrase (unsigned int apIndex, char *sta, char *key)
 
int wifi_dppRemoveSTAPassphrase (unsigned int apIndex, char *sta)
 
int wifi_sendActionFrame (int apIndex, mac_address_t sta, unsigned int frequency, unsigned char *frame, unsigned int len)
 
int wifi_getApWpaEncryptoinMode (int apIndex, char *output_string)
 
void KillHostapd ()
 
unsigned char checkWifi ()
 
unsigned char checkLanInterface ()
 
int CcspHal_change_config_value (char *field_name, char *field_value, char *buf, unsigned int *nbytes)
 
int do_MacFilter_Addrule ()
 
int do_MacFilter_Delrule ()
 
int do_MacFilter_Update (char *Operation, int i_macFiltCnt, COSA_DML_WIFI_AP_MAC_FILTER *i_macFiltTabPtr, int count, struct hostDetails *hostPtr)
 
int wifi_getApIndexForWiFiBand (wifi_band band)
 
void wlan_encryption_mode_to_string (char *encryption_mode, char *string)
 
int File_Reading (char *file, char *Value)
 
void wlan_wireless_mode_to_supported_standards_string (char *wireless_mode, char *string, char *freq)
 
void wlan_bitrate_to_operated_standards_string (char *bitrate, char *string, char *freq)
 
void wlan_operated_standards_to_channel_bandwidth_string (char *wireless_mode, char *string)
 
int Hostapd_PublicWifi_status (char status[50])
 
int Hostapd_PrivateWifi_status (char status[50])
 
int GetInterfaceName (char interface_name[50], char conf_file[100])
 
int GetInterfaceName_virtualInterfaceName_2G (char interface_name[50])
 
void RestartHostapd ()
 
void xfinitywifi_2g (int ssidIndex)
 
void privatewifi_2g (int ssidIndex)
 
void KillHostapd_2g (int ssidIndex)
 
void KillHostapd_xfinity_2g (int ssidIndex)
 
void xfinitywifi_5g (int ssidIndex)
 
void privatewifi_5g (int ssidIndex)
 
void KillHostapd_5g (int ssidIndex)
 
void KillHostapd_xfinity_5g (int ssidIndex)
 
int killXfinityWiFi ()
 
void defaultwifi_restarting_process ()
 
int hostapd_restarting_process (int apIndex)
 
void get_mac (unsigned char *mac)
 
int GettingHostapdSsid (int ssidIndex, char *hostapd_conf, char *val)
 
void DisableWifi (int InstanceNumber)
 
int wifi_hostapdRead (int ap, struct params *params, char *output)
 
int wifi_hostapdWrite (int ap, param_list_t *list)
 
int get_wifiMaxbitrate (int radioIndex, char *output_string)
 
void wifi_updateRadiochannel (int radioIndex, unsigned long channel)
 
int wifi_setAutoChannelEnableVal (int radioIndex, unsigned long channel)
 
void wifi_storeprevchanval (int radioIndex)
 
int wifi_halgetRadioChannelBW (char *file, char *Value)
 
int wifi_halsetRadioChannelBW_40 (char *file)
 
int wifi_halsetRadioChannelBW_20 (char *file)
 
int wifi_halgetRadioExtChannel (char *file, char *Value)
 
int wifi_halGetIfStats (char *ifname, wifi_radioTrafficStats2_t *pStats)
 
int GetIfacestatus (char *interface_name, char *status)
 
int wifi_halGetIfStatsNull (wifi_radioTrafficStats2_t *output_struct)
 
int wifihal_getBaseBSSID (char *interface_name, char *mac, int index)
 
int GetScanningValues (char *file, char *value)
 
void converting_lowercase_to_uppercase (char *Value)
 
void wifihal_GettingNeighbouringAPScanningDetails (char *interface_name, wifi_neighbor_ap2_t **neighbor_ap_array, unsigned int *output_array_size)
 
int SetWPSButton (char *interface_name)
 
int wifihal_AssociatedDevicesstats (int apIndex, char *interface_name, wifi_associated_dev_t **associated_dev_array, unsigned int *output_array_size)
 
int wifihal_interfacestatus (char *wifi_status, char *interface_name)
 

Data Structure Documentation

◆ _wifi_eap_config_t

struct _wifi_eap_config_t

Set the Fast Transition capability to disabled, full FT.

EAP/EAPOL Authenticator information.

Structure which holds the the EAP/EAPOL Config param values.

Definition at line 7743 of file wifi_hal.h.

Collaboration diagram for _wifi_eap_config_t:
Collaboration graph

Data Fields

unsigned int uiEAPOLKeyTimeout
 
unsigned int uiEAPOLKeyRetries
 
unsigned int uiEAPIdentityRequestTimeout
 
unsigned int uiEAPIdentityRequestRetries
 
unsigned int uiEAPRequestTimeout
 
unsigned int uiEAPRequestRetries
 

Field Documentation

◆ uiEAPOLKeyTimeout

unsigned int _wifi_eap_config_t::uiEAPOLKeyTimeout

Definition at line 7745 of file wifi_hal.h.

◆ uiEAPOLKeyRetries

unsigned int _wifi_eap_config_t::uiEAPOLKeyRetries

Definition at line 7746 of file wifi_hal.h.

◆ uiEAPIdentityRequestTimeout

unsigned int _wifi_eap_config_t::uiEAPIdentityRequestTimeout

Definition at line 7747 of file wifi_hal.h.

◆ uiEAPIdentityRequestRetries

unsigned int _wifi_eap_config_t::uiEAPIdentityRequestRetries

Definition at line 7748 of file wifi_hal.h.

◆ uiEAPRequestTimeout

unsigned int _wifi_eap_config_t::uiEAPRequestTimeout

Definition at line 7749 of file wifi_hal.h.

◆ uiEAPRequestRetries

unsigned int _wifi_eap_config_t::uiEAPRequestRetries

Definition at line 7750 of file wifi_hal.h.

Typedef Documentation

◆ wifi_newApAssociatedDevice_callback [1/2]

typedef int( * wifi_newApAssociatedDevice_callback) (int apIndex, wifi_associated_dev_t *associated_dev)

This call back will be invoked when new wifi client come to associate to Access Point.

Parameters
[in]apIndexAccess Point Index
[in]associated_devAssociated device info
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Definition at line 6932 of file wifi_hal.h.

◆ wifi_apDisassociatedDevice_callback

typedef int( * wifi_apDisassociatedDevice_callback) (int apIndex, char *MAC, int event_type)

This call back will be invoked when new wifi client disassociates from Access Point.

Parameters
[in]apIndexAccess Point Index
[in]MACMAC address of disassociated device
[in]event_typetype of disassociation, explicit or due to client inactivity
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Definition at line 6972 of file wifi_hal.h.

◆ wifi_apDeAuthEvent_callback

typedef int( * wifi_apDeAuthEvent_callback) (int ap_index, char *mac, int reason)

This call back will be invoked when DeAuth Event (reason 2 wrong password) comes from client.

Parameters
[in]apIndexAccess Point Index
[in]MACMAC address of client device
[in]reasonreason for Auth Event
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Definition at line 7012 of file wifi_hal.h.

◆ wifi_steering_eventCB_t

typedef void(* wifi_steering_eventCB_t) (unsigned int steeringgroupIndex, wifi_steering_event_t *event)

Wifi Steering Event Callback Definition.

This is the definition of the event callback provided when upper layer registers for steering events.

Warning
the event passed to the callback is not dynamically allocated the call back function handler must allocate wifi_steering_event_t and copy the "event" into that

Definition at line 7384 of file wifi_hal.h.

◆ wifi_apAuthEvent_callback [1/2]

typedef int( * wifi_apAuthEvent_callback) (int apIndex, char *MAC, int event_type)

Definition at line 7532 of file wifi_hal.h.

◆ wifi_apAuthenticatedEvent_callback

typedef int( * wifi_apAuthenticatedEvent_callback) (int apIndex, char *MAC)

Definition at line 7556 of file wifi_hal.h.

◆ wifi_apAssociatedDevice_callback

typedef int( * wifi_apAssociatedDevice_callback) (int apIndex, char *MAC, int event_type)

Definition at line 7586 of file wifi_hal.h.

◆ wifi_eap_config_t

Set the Fast Transition capability to disabled, full FT.

EAP/EAPOL Authenticator information.

Structure which holds the the EAP/EAPOL Config param values.

◆ wifi_BTMQueryRequest_callback

typedef int(* wifi_BTMQueryRequest_callback) (unsigned int apIndex, char *peerMac, wifi_BTMQuery_t *query, unsigned int inMemSize, wifi_BTMRequest_t *request)

This call back is invoked when a STA sends a BTM query message to a vAP in the gateway. The driver will use the frame returned from this function to process the response to the query. A BTM transaction is started by a STA sending a query or by the AP sending an autonomous request. This callback is used for the former.

Parameters
apIndex- Access Point Index.
peerMACAddress- MAC address of the peer STA the Query was received from.
inQueryFrame- Query frame received from a non-AP STA.
inMemSize- Size of the memory allocated by the callback. The caller should set to max size for the request. Otherwise the callback may drop elements or return an error.
inRequestFrame- Frame to use for the response. The caller allocates the memory for the response. The caller may free the memory when the callback returns and the response is sent to the STA.
Returns
The status of the operation.
Return values
RETURN_OKif successful.
RETURN_ERRif any error is detected.
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls.

Definition at line 8291 of file wifi_hal.h.

◆ wifi_BTMResponse_callback

typedef int(* wifi_BTMResponse_callback) (unsigned int apIndex, char *peerMac, wifi_BTMResponse_t *response)

This call back is invoked when a STA responds to a BTM Request from the gateway.

Parameters
apIndex- Access Point Index.
peerMACAddress- MAC address of the peer the response was received from.
in_struct- Response frame received from a non-AP STA.
Returns
The status of the operation.
Return values
RETURN_OKif successful.
RETURN_ERRif any error is detected.
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls.

Definition at line 8315 of file wifi_hal.h.

◆ wifi_RMBeaconReport_callback

typedef int(* wifi_RMBeaconReport_callback) (unsigned int apIndex, wifi_BeaconReport_t *out_struct, unsigned int *out_array_size, unsigned char *out_DialogToken)

Definition at line 8594 of file wifi_hal.h.

◆ wifi_dppAuthResponse_callback_t

typedef void(* wifi_dppAuthResponse_callback_t) (unsigned int apIndex, mac_address_t sta, unsigned char *frame, unsigned int len)

Definition at line 8903 of file wifi_hal.h.

◆ wifi_dppConfigRequest_callback_t

typedef void(* wifi_dppConfigRequest_callback_t) (unsigned int apIndex, mac_address_t sta, unsigned char token, unsigned char *attribs, unsigned int length)

Definition at line 8921 of file wifi_hal.h.

◆ wifi_receivedMgmtFrame_callback

typedef int(* wifi_receivedMgmtFrame_callback) (int apIndex, unsigned char *sta_mac, unsigned char *frame, unsigned int len, wifi_mgmtFrameType_t type)

Definition at line 8947 of file wifi_hal.h.

◆ wifi_newApAssociatedDevice_callback [2/2]

typedef int( * wifi_newApAssociatedDevice_callback) (int apIndex, wifi_associated_dev_t *associated_dev)

This call back will be invoked when new wifi client come to associate to AP.

Parameters
apIndex- Access Point Index
associated_dev- wifi_associated_dev_t *associated_dev, associated device info
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Definition at line 4904 of file wifi_hal_emu.h.

◆ wifi_apAuthEvent_callback [2/2]

typedef int( * wifi_apAuthEvent_callback) (int apIndex, char *MAC, int event_type)

Definition at line 5427 of file wifi_hal_emu.h.

Function Documentation

◆ wifi_getRadioChannelStats()

int wifi_getRadioChannelStats ( int  radioIndex,
wifi_channelStats_t input_output_channelStats_array,
int  array_size 
)

Get the all (currently used by configured regualtory domain) Radio channel utilization status.

Parameters
[in]radioIndexThe index of the radio array
[out]input_output_channelStats_arrayChannel status info to be returned
[out]array_sizeThe length of the output array When array_size = 0, the API return ONCHAN stats
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioChannelStats2()

int wifi_getRadioChannelStats2 ( int  radioIndex,
wifi_channelStats2_t outputChannelStats2 
)

◆ wifi_getApAssociatedDeviceRxStatsResult()

int wifi_getApAssociatedDeviceRxStatsResult ( int  radioIndex,
mac_address_t clientMacAddress,
wifi_associated_dev_rate_info_rx_stats_t **  stats_array,
unsigned int *  output_array_size,
unsigned long long *  handle 
)

Get the associated client per rate receive status.

Parameters
[in]radioIndexThe index of radio array.
[in]clientMacAddressClient mac address UCHAR[6]
[out]stats_arrayClient receive status
[out]output_array_sizeThe length of output array
[out]handleStatus validation handle used to determine reconnects; increases for every association.
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApAssociatedDeviceTxStatsResult()

int wifi_getApAssociatedDeviceTxStatsResult ( int  radioIndex,
mac_address_t clientMacAddress,
wifi_associated_dev_rate_info_tx_stats_t **  stats_array,
unsigned int *  output_array_size,
unsigned long long *  handle 
)

Get the associated client per rate transmission status.

Parameters
[in]radioIndexThe index of radio array.
[in]clientMacAddressClient mac address UCHAR[6]
[out]stats_arrayClient transmission status
[out]output_array_sizeThe length of output array
[out]handleStatus validation handle used to determine reconnects; increases for every association.
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApAssociatedDeviceTidStatsResult()

int wifi_getApAssociatedDeviceTidStatsResult ( int  radioIndex,
mac_address_t clientMacAddress,
wifi_associated_dev_tid_stats_t tid_stats,
unsigned long long *  handle 
)

Get the associated client per rate transmission status.

Parameters
[in]radioIndexThe index of radio array
[in]clientMacAddressclient mac address UCHAR[6]
[out]statswifi_associated_dev_tid_stats_t *stats, client status
[in]handleStatus validation handle used to determine reconnects incremented for every association
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApAssociatedDeviceStats()

int wifi_getApAssociatedDeviceStats ( int  apIndex,
mac_address_t clientMacAddress,
wifi_associated_dev_stats_t associated_dev_stats,
unsigned long long *  handle 
)

Get the associated device status.

Parameters
[in]apIndexThe index of access point array
[in]clientMacAddressclient mac address UCHAR[6]
[out]associated_dev_statsAssociated device status
[in]handleStatus validation handle used to determine reconnects; increases for every association
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getHalVersion()

int wifi_getHalVersion ( char *  output_string)

Get the wifi hal version in string.

Eg "2.0.0". WIFI_HAL_MAJOR_VERSION.WIFI_HAL_MINOR_VERSION.WIFI_HAL_MAINTENANCE_VERSION

Parameters
[out]output_stringWiFi Hal version to be returned.
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Side Effects: None

Get the wifi hal version in string, eg "2.0.0". WIFI_HAL_MAJOR_VERSION.WIFI_HAL_MINOR_VERSION.WIFI_HAL_MAINTENANCE_VERSION

Parameters
output_string- WiFi Hal version, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Side Effects: None

◆ wifi_factoryReset()

int wifi_factoryReset ( )

Clears internal variables to implement a factory reset of the Wi-Fi subsystem.

A Specific implementation may dictate some functionalities since different hardware implementations may have different requirements.

Parameters
None
Returns
The status of the operation.
Return values
RETURN_OKif successful.
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Clears internal variables to implement a factory reset of the Wi-Fi subsystem. Resets Implementation specifics may dictate some functionality since different hardware implementations may have different requirements.

Parameters
None
Returns
The status of the operation.
Return values
RETURN_OKif successful.
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_factoryResetRadios()

int wifi_factoryResetRadios ( )

Restore all radio parameters without touching access point parameters.

A Specific implementation may dictate some functionalities since different hardware implementations may have different requirements.

Parameters
None
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Restore all radio parameters without touching access point parameters. Resets Implementation specifics may dictate some functionality since different hardware implementations may have different requirements.

Parameters
None
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_factoryResetRadio()

int wifi_factoryResetRadio ( int  radioIndex)

Restore selected radio parameters without touching access point parameters.

Parameters
radioIndexIndex of Wi-Fi Radio channel
Returns
The status of the operation.
Return values
RETURN_OKif successful.
RETURN_ERRif any error is detected
Execution: Synchronous.
Side Effects: None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Restore selected radio parameters without touching access point parameters

Parameters
radioIndex- Index of Wi-Fi Radio channel
Returns
The status of the operation.
Return values
RETURN_OKif successful.
RETURN_ERRif any error is detected
Execution: Synchronous.
Side Effects: None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setLED()

int wifi_setLED ( int  radioIndex,
unsigned char  enable 
)

Set the system LED status.

Parameters
radioIndexIndex of Wi-Fi Radio channel
enableLED status
Returns
The status of the operation.
Return values
RETURN_OKif successful.
RETURN_ERRif any error is detected
Execution: Synchronous.
Side Effects: None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Set the system LED status

Parameters
radioIndex- Index of Wi-Fi Radio channel
enable- LED status
Returns
The status of the operation.
Return values
RETURN_OKif successful.
RETURN_ERRif any error is detected
Execution: Synchronous.
Side Effects: None.
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_init()

int wifi_init ( )

This function call initializes all Wi-Fi radios.

A specific implementation may dictate some functionality since different hardware implementations may have different initilization requirements.

Parameters
None
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

This function call initializes all Wi-Fi radios. Implementation specifics may dictate the functionality since different hardware implementations may have different initilization requirements.

Parameters
None
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_reset()

int wifi_reset ( )

Resets the Wifi subsystem. This includes reset of all Access Point variables.

Implementation specifics may dictate what is actualy reset since different hardware implementations may have different requirements.

Parameters
None
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Resets the Wifi subsystem. This includes reset of all AP varibles. Implementation specifics may dictate what is actualy reset since different hardware implementations may have different requirements.

Parameters
None
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_down()

int wifi_down ( )

Turns off transmit power for the entire Wifi subsystem, for all radios.

Implementation specifics may dictate some functionality since different hardware implementations may have different requirements.

Parameters
None
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Turns off transmit power for the entire Wifi subsystem, for all radios. Implementation specifics may dictate some functionality since different hardware implementations may have different requirements.

Parameters
None
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_createInitialConfigFiles()

int wifi_createInitialConfigFiles ( )

This function creates wifi configuration files.

The format and content of these files are implementation dependent. This function call is used to trigger this task if necessary. Some implementations may not need this function. If an implementation does not need to create config files the function call can do nothing and return RETURN_OK.

Parameters
None
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

This function creates wifi configuration files. The format and content of these files are implementation dependent. This function call is used to trigger this task if necessary. Some implementations may not need this function. If an implementation does not need to create config files the function call can do nothing and return RETURN_OK.

Parameters
None
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioCountryCode()

int wifi_getRadioCountryCode ( int  radioIndex,
char *  output_string 
)

Outputs the country code to a max 64 character string.

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[out]output_stringCountry code to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Outputs the country code to a max 64 character string

Parameters
radioIndex- Index of Wi-Fi radio channel
output_string- Country code, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setRadioCountryCode()

int wifi_setRadioCountryCode ( int  radioIndex,
char *  CountryCode 
)

Set the country code for selected Wi-Fi radio channel.

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[in]CountryCodeCountry code
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Set the country code for selected Wi-Fi radio channel.

Parameters
radioIndex- Index of Wi-Fi radio channel
CountryCode- Country code
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_pushCountryCode()

int wifi_pushCountryCode ( char *  CountryCode)

Set the country code for both wifi radios and apply them. wifi reset automatically if necessary. The function need to return immediately.

Parameters
[in]CountryCodeCountry code
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getATMCapable()

int wifi_getATMCapable ( unsigned char *  output_bool)

Get the ATM(Air Time Management) Capable.

Device.WiFi.X_RDKCENTRAL-COM_ATM_Capable boolean R

Parameters
[out]output_boolIndication as to whether Air Time Management is supported.
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setATMEnable()

int wifi_setATMEnable ( unsigned char  enable)

Set ATM Enable.

The type of algorithm to apply across the configured Access Points and/or clients; Device.WiFi.X_RDKCENTRAL-COM_ATM_Enable uint W

Parameters
[in]enableBoolean value to set/unset ATM. False indicates Disabled True indicates Dynamic (Sharing of unused Airtime Between AP Groups allowed)
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getATMEnable()

int wifi_getATMEnable ( unsigned char *  output_enable)

Get ATM Enable status.

Device.WiFi.X_RDKCENTRAL-COM_ATM_Enable uint W

Parameters
[out]output_enableReturns the ATM enable status.
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setApATMAirTimePercent()

int wifi_setApATMAirTimePercent ( int  apIndex,
unsigned int  ap_AirTimePercent 
)

Set Access Point Air Time Percent.

Device.WiFi.X_RDKCENTRAL-COM_ATM_APGroup.{i}.AirTimePercent uint W

Parameters
[in]apIndexIndex of Access Point array.
[in]ap_AirTimePercentThe Percentage of Available Airtime assigned to this ATM Access Point Group (5%-100%) The sum of all percentages assigned to all groups must be <= 100%"
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApATMAirTimePercent()

int wifi_getApATMAirTimePercent ( int  apIndex,
unsigned int *  output_ap_AirTimePercent 
)

Get Ap Air Time Percent.

Device.WiFi.X_RDKCENTRAL-COM_ATM_APGroup.{i}.AirTimePercent uint W

Parameters
[in]apIndexThe index of Access Point array.
[out]output_ap_AirTimePercentThe Percentage of Available Airtime assigned to this ATM Access Point Group (5%-100%)
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApATMSta()

int wifi_getApATMSta ( int  apIndex,
unsigned char *  output_sta_MAC_ATM_array,
unsigned int  buf_size 
)

Get the list for Air Time Percent for each Station.

Parameters
[in]apIndexThe index of Access Point array.
[out]output_sta_MAC_ATM_arrayCaller allocated buffer. output_sta_MAC_ATM_array contains the atm array in format of "$MAC $ATM_percent|$MAC $ATM_percent|$MAC $ATM_percent"
[out]buf_sizeThe size for output_sta_MAC_ATM_array
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setApATMSta()

int wifi_setApATMSta ( int  apIndex,
unsigned char *  sta_MAC,
unsigned int  sta_AirTimePercent 
)

Set Air Time Percent for each Station.

Parameters
[in]apIndexThe index of Access Point array
[in]sta_MACIf sta_MAC is new, HAL need to add this new record into ATM table for this AP; if sta_MAC is not new, HAL need to change sta_AirTimePercent for this MAC in ATM table for this AP.
sta_AirTimePercentif sta_AirTimePercent is 0, HAL needd to remove this recordC from the ATM table
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioNumberOfEntries()

int wifi_getRadioNumberOfEntries ( unsigned long *  output)

Get the total number of radios in this wifi subsystem.

Parameters
[out]outputTotal number of radios to be returned.
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get the total number of radios in this wifi subsystem

Parameters
output- Total no. of radios, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getSSIDNumberOfEntries()

int wifi_getSSIDNumberOfEntries ( unsigned long *  output)

Get the total number of SSID entries in this wifi subsystem.

Parameters
[out]outputTotal number of SSID entries to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get the total number of SSID entries in this wifi subsystem

Parameters
output- Total no. of SSID entries, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioEnable()

int wifi_getRadioEnable ( int  radioIndex,
unsigned char *  output_bool 
)

Get the Radio enable config parameter.

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[out]output_boolRadio Enable status, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get the Radio enable config parameter

Parameters
radioIndex- Index of Wi-Fi radio channel
output_bool- Radio Enable status, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setRadioEnable()

int wifi_setRadioEnable ( int  radioIndex,
unsigned char  enable 
)

Set the Radio enable config parameter.

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[in]enableSet the selected radio's status as Enable/Disable
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Set the Radio enable config parameter

Parameters
radioIndex- Index of Wi-Fi radio channel
enable- Set the selected radio's status as Enable/Disable
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioStatus()

int wifi_getRadioStatus ( int  radioIndex,
unsigned char *  output_bool 
)

Get the Radio enable status.

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[out]output_boolSelected radio's enable status, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get the Radio enable status

Parameters
radioIndex- Index of Wi-Fi radio channel
output_bool- Selected radio's enable status, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioIfName()

int wifi_getRadioIfName ( int  radioIndex,
char *  output_string 
)

Get the Radio Interface name from platform, eg "wifi0".

Parameters
radioIndexIndex of Wi-Fi radio channel
output_stringInterface name, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get the Radio Interface name from platform, eg "wifi0"

Parameters
radioIndex- Index of Wi-Fi radio channel
output_string- Interface name, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioMaxBitRate()

int wifi_getRadioMaxBitRate ( int  radioIndex,
char *  output_string 
)

Get the maximum PHY bit rate supported by this interface. eg: "216.7 Mb/s", "1.3 Gb/s".

The output_string is a max length 64 octet string that is allocated by the RDKB code. Implementations must ensure that strings are not longer than this.

Parameters
[in]radioIndexIndex of Wi-Fi radio channel.
[out]output_stringMaximum bit rate supported, to be returned.
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get the maximum PHY bit rate supported by this interface. eg: "216.7 Mb/s", "1.3 Gb/s" The output_string is a max length 64 octet string that is allocated by the RDKB code. Implementations must ensure that strings are not longer than this.

Parameters
radioIndex- Index of Wi-Fi radio channel
output_string- Maximum bit rate supported, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioSupportedFrequencyBands()

int wifi_getRadioSupportedFrequencyBands ( int  radioIndex,
char *  output_string 
)

Get Supported frequency bands at which the radio can operate. eg: "2.4GHz,5GHz".

The output_string is a max length 64 octet string that is allocated by the RDKB code.
Implementations must ensure that strings are not longer than this.

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[out]output_stringSupported frequency bands, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get Supported frequency bands at which the radio can operate. eg: "2.4GHz,5GHz" The output_string is a max length 64 octet string that is allocated by the RDKB code.
Implementations must ensure that strings are not longer than this.

Parameters
radioIndex- Index of Wi-Fi radio channel
output_string- Supported frequency bands, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioOperatingFrequencyBand()

int wifi_getRadioOperatingFrequencyBand ( int  radioIndex,
char *  output_string 
)

Get the frequency band at which the radio is operating, eg: "2.4GHz".

The output_string is a max length 64 octet string that is allocated by the RDKB code. Implementations must ensure that strings are not longer than this.

Parameters
[in]radioIndexIndex of Wi-Fi radio channel.
[out]output_stringOperating frequency band, to be returned.
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get the frequency band at which the radio is operating, eg: "2.4GHz". The output_string is a max length 64 octet string that is allocated by the RDKB code. Implementations must ensure that strings are not longer than this.

Parameters
radioIndex- Index of Wi-Fi radio channel
output_string- Operating frequency band, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioSupportedStandards()

int wifi_getRadioSupportedStandards ( int  radioIndex,
char *  output_string 
)

Get the Supported Radio Mode. eg: "b,g,n"; "n,ac"; "ax"; "a,n,ac,ax".

The output_string is a max length 64 octet string that is allocated by the RDKB code. Implementations must ensure that strings are not longer than this.

Parameters
[in]radioIndexIndex of Wi-Fi radio channel.
[out]output_stringSupported radio mode, to be returned.
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get the Supported Radio Mode. eg: "b,g,n"; "n,ac". The output_string is a max length 64 octet string that is allocated by the RDKB code. Implementations must ensure that strings are not longer than this.

Parameters
radioIndex- Index of Wi-Fi radio channel
output_string- Supported radio mode, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioStandard()

int wifi_getRadioStandard ( int  radioIndex,
char *  output_string,
unsigned char *  gOnly,
unsigned char *  nOnly,
unsigned char *  acOnly 
)

Get the radio operating mode, and pure mode flag. eg: "ac".

Deprecated: used for old RDKB code.
The output_string is a max length 64 octet string that is allocated by the RDKB code. Implementations must ensure that strings are not longer than this.

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[out]output_stringRadio operating mode, to be returned
[out]gOnlyBoolean pointer variable need to be updated based on the "output_string"
[out]nOnlyBoolean pointer variable need to be updated based on the "output_string"
[out]acOnlyBoolean pointer variable need to be updated based on the "output_string"
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get the radio operating mode, and pure mode flag. eg: "ac". The output_string is a max length 64 octet string that is allocated by the RDKB code. Implementations must ensure that strings are not longer than this.

Parameters
radioIndex- Index of Wi-Fi radio channel
output_string- Radio operating mode, to be returned
gOnly- Boolean pointer variable need to be updated based on the "output_string"
nOnly- Boolean pointer variable need to be updated based on the "output_string"
acOnly- Boolean pointer variable need to be updated based on the "output_string"
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioMode()

int wifi_getRadioMode ( int  radioIndex,
char *  output_string,
unsigned int *  pureMode 
)

Get the radio operating mode, and pure mode flag. eg: "ac".

The output_string is a max length 64 octet string that is allocated by the RDKB code. Implementations must ensure that strings are not longer than this.

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[out]output_stringRadio operating mode, to be returned
[out]pureModePointer to pure mode bit map starting from LSB b only, g only, a only, n only, ac only, ax only, e.g. n only will be 8, ax only will be 32
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setRadioChannelMode()

int wifi_setRadioChannelMode ( int  radioIndex,
char *  channelMode,
unsigned char  gOnlyFlag,
unsigned char  nOnlyFlag,
unsigned char  acOnlyFlag 
)

Set the radio operating mode, and pure mode flag.

Deprecated: used for old RDKB code.

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[in]channelModePass the channelMode for specified radio index
[in]gOnlyFlagPass operating mode flag for setting pure mode flag
[in]nOnlyFlagPass operating mode flag for setting pure mode flag
[in]acOnlyFlagPass operating mode flag for setting pure mode flag
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Set the radio operating mode, and pure mode flag.

Parameters
radioIndex- Index of Wi-Fi radio channel
channelMode- Pass the channelMode for specified radio index
gOnlyFlag- Pass operating mode flag for setting pure mode flag
nOnlyFlag- Pass operating mode flag for setting pure mode flag
acOnlyFlag- Pass operating mode flag for setting pure mode flag
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setRadioMode()

int wifi_setRadioMode ( int  radioIndex,
char *  channelMode,
unsigned int  pureMode 
)

Set the radio operating mode, and pure mode flag.

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[in]channelModePass the channelMode for specified radio index
[in]pureModePass flag for setting pure mode bit map starting from LSB b only, g only, a only, n only, ac only, ax only, e.g. n only will be 8, ax only will be 32
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioPossibleChannels()

int wifi_getRadioPossibleChannels ( int  radioIndex,
char *  output_string 
)

Get the list of supported channel. eg: "1-11".

The output_string is a max length 64 octet string that is allocated by the RDKB code. Implementations must ensure that strings are not longer than this.

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[out]output_stringList of supported radio channels, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get the list of supported channel. eg: "1-11". The output_string is a max length 64 octet string that is allocated by the RDKB code. Implementations must ensure that strings are not longer than this.

Parameters
radioIndex- Index of Wi-Fi radio channel
output_string- List of supported radio channels, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioChannelsInUse()

int wifi_getRadioChannelsInUse ( int  radioIndex,
char *  output_string 
)

Get the list of supported channel. eg: "1-11".

The output_string is a max length 64 octet string that is allocated by the RDKB code. Implementations must ensure that strings are not longer than this.

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[out]output_stringList of supported radio channels, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get the list of supported channel. eg: "1-11". The output_string is a max length 64 octet string that is allocated by the RDKB code. Implementations must ensure that strings are not longer than this.

Parameters
radioIndex- Index of Wi-Fi radio channel
output_string- List of supported radio channels, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioChannel()

int wifi_getRadioChannel ( int  radioIndex,
unsigned long *  output_ulong 
)

Get the running channel number.

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[out]output_ulongRunning channel number, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get the running channel number.

Parameters
radioIndex- Index of Wi-Fi radio channel
output_ulong- Running channel number, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setRadioChannel()

int wifi_setRadioChannel ( int  radioIndex,
unsigned long  channel 
)

Set the running channel number.

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[in]channelChannel number to be set as running wifi radio channel
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Set the running channel number.

Parameters
radioIndex- Index of Wi-Fi radio channel
channel- Channel number to be set as running wifi radio channel
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setRadioAutoChannelEnable()

int wifi_setRadioAutoChannelEnable ( int  radioIndex,
unsigned char  enable 
)

Enables or disables a driver level variable to indicate if auto channel selection is enabled on this radio.

This "auto channel" means the auto channel selection when radio is up. (which is different from the dynamic channel/frequency selection (DFC/DCS))

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[in]enableEnable/Disable selected radio channel as auto channel radio
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

This "auto channel" means the auto channel selection when radio is up. (which is different from the dynamic channel/frequency selection (DFC/DCS))

Parameters
[in]radioIndexIndex of Wi-Fi radio channel.
[in]enableEnable/Disable selected radio channel as auto channel radio
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Enables or disables a driver level variable to indicate if auto channel selection is enabled on this radio. This "auto channel" means the auto channel selection when radio is up. (which is different from the dynamic channel/frequency selection (DFC/DCS))

Parameters
radioIndex- Index of Wi-Fi radio channel
enable- Enable/Disable selected radio channel as auto channel radio
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioAutoChannelSupported()

int wifi_getRadioAutoChannelSupported ( int  radioIndex,
unsigned char *  output_bool 
)

Check if the driver support the AutoChannel.

Device.WiFi.Radio.{i}.AutoChannelSupported

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[out]output_boolValue of Auto Channel Supported, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Check if the driver support the AutoChannel.
Device.WiFi.Radio.{i}.AutoChannelSupported

Parameters
radioIndex- Index of Wi-Fi radio channel
BOOL*output_bool - Value of Auto Channel Supported, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioAutoChannelEnable()

int wifi_getRadioAutoChannelEnable ( int  radioIndex,
unsigned char *  output_bool 
)

Get the AutoChannel enable status.

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[out]output_boolAuto Channel Enabled status, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get the AutoChannel enable status.

Parameters
radioIndex- Index of Wi-Fi radio channel
BOOL*output_bool - Auto Channel Enabled status, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioDCSSupported()

int wifi_getRadioDCSSupported ( int  radioIndex,
unsigned char *  output_bool 
)

Check if the driver support the DCS.

Device.WiFi.Radio.{i}.X_COMCAST-COM_DCSSupported.

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[out]output_boolDCS Supported flag for the radio index, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Device.WiFi.Radio.{i}.X_COMCAST-COM_DCSSupported. Check if the driver support the DCS

Parameters
radioIndex- Index of Wi-Fi radio channel
output_bool- DCS Supported flag for the radio index, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioDCSEnable()

int wifi_getRadioDCSEnable ( int  radioIndex,
unsigned char *  output_bool 
)

Get DCS of the selected wifi radio channel's enable/disable status.

Device.WiFi.Radio.{i}.X_COMCAST-COM_DCSEnable

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[out]output_boolDCS Enable flag for the selected radio index, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get DCS of the selected wifi radio channel's enable/disable status.
Device.WiFi.Radio.{i}.X_COMCAST-COM_DCSEnable

Parameters
radioIndex- Index of Wi-Fi radio channel
output_bool- DCS Enable flag for the selected radio index, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setRadioDCSEnable()

int wifi_setRadioDCSEnable ( int  radioIndex,
unsigned char  enable 
)

Enable/Disable selected wifi radio channel's DCS.

Device.WiFi.Radio.{i}.X_COMCAST-COM_DCSEnable

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[out]enableSet the value of DCS Enable flag for the selected radio index
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Enable/Disable selected wifi radio channel's DCS.
Device.WiFi.Radio.{i}.X_COMCAST-COM_DCSEnable

Parameters
radioIndex- Index of Wi-Fi radio channel
enable- Set the value of DCS Enable flag for the selected radio index
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioDCSChannelPool()

int wifi_getRadioDCSChannelPool ( int  radioIndex,
char *  output_pool 
)

Get radio DCS channel pool.

The output_string is a max length 256 octet string that is allocated by the RDKB code. Implementations must ensure that strings are not longer than this. The value of this parameter is a comma seperated list of channel number.

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[out]output_poolDCS channel pool for the selected radio index,to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get radio DCS channel pool. The output_string is a max length 256 octet string that is allocated by the RDKB code. Implementations must ensure that strings are not longer than this. The value of this parameter is a comma seperated list of channel number.

Parameters
radioIndex- Index of Wi-Fi radio channel
output_pool- DCS channel pool for the selected radio index,to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setRadioDCSChannelPool()

int wifi_setRadioDCSChannelPool ( int  radioIndex,
char *  pool 
)

Set radio DCS channel pool.

The output_string is a max length 256 octet string that is allocated by the RDKB code. Implementations must ensure that strings are not longer than this. The value of this parameter is a comma seperated list of channel number.

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[in]poolSet DCS channel pool for the selected radio index
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Set radio DCS channel pool. The output_string is a max length 256 octet string that is allocated by the RDKB code. Implementations must ensure that strings are not longer than this. The value of this parameter is a comma seperated list of channel number.

Parameters
radioIndex- Index of Wi-Fi radio channel
pool- Set DCS channel pool for the selected radio index
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioDCSScanTime()

int wifi_getRadioDCSScanTime ( int  radioIndex,
int *  output_interval_seconds,
int *  output_dwell_milliseconds 
)

Get radio DCS scan time.

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[out]output_interval_secondsGet the interval time in seconds
[out]output_dwell_millisecondsGet the dwell time in milliseconds
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get radio DCS scan time.

Parameters
radioIndex- Index of Wi-Fi radio channel
output_interval_seconds- Get the interval time in seconds
output_dwell_milliseconds- Get the dwell time in milliseconds
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setRadioDCSScanTime()

int wifi_setRadioDCSScanTime ( int  radioIndex,
int  interval_seconds,
int  dwell_milliseconds 
)

Set radio DCS scan time.

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[in]interval_secondsSet the interval time in seconds
[in]dwell_millisecondsSet the dwell time in milliseconds
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Set radio DCS scan time.

Parameters
radioIndex- Index of Wi-Fi radio channel
interval_seconds- Set the interval time in seconds
dwell_milliseconds- Set the dwell time in milliseconds
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setRadioDcsDwelltime()

int wifi_setRadioDcsDwelltime ( int  radioIndex,
int  millisecond 
)

Set radio Dcs Dwell time.

Device.WiFi.Radio.{i}.X_RDKCENTRAL-COM_DCSDwelltime integer W

Parameters
[in]radioIndexIndex of Wi-Fi radio
[in]millisecondDwell time on each channel
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioDcsDwelltime()

int wifi_getRadioDcsDwelltime ( int  radioIndex,
int *  output_millisecond 
)

Get radio Dcs Dwell time.

Device.WiFi.Radio.{i}.X_RDKCENTRAL-COM_DCSDwelltime integer W

Parameters
[in]radioIndexIndex of Wi-Fi radio
[in]output_millisecondDwell time on each channel
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setRadioDcsScanning()

int wifi_setRadioDcsScanning ( int  radioIndex,
unsigned char  enable 
)

Enable/Disable selected wifi radio channel's DCS.

Device.WiFi.Radio.{i}.X_RDKCENTRAL_COM_DCSEnable

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[in]enableSet the value of DCS Enable flag for the selected radio index
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioDcsScanning()

int wifi_getRadioDcsScanning ( int  radioIndex,
unsigned char *  output_bool 
)

Get DCS of the selected wifi radio channel's enable/disable status.

Device.WiFi.Radio.{i}.X_RDKCENTRAL_COM_DCSEnable

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[out]output_boolDCS Enable flag for the selected radio index, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioDcsChannelMetrics()

int wifi_getRadioDcsChannelMetrics ( int  radioIndex,
wifi_channelMetrics_t input_output_channelMetrics_array,
int  array_size 
)

Get radio Channel Metrics.

Parameters
[in]radioIndexIndex of Wi-Fi radio
[out]input_output_channelMetrics_arraycaller allocated buffer
[out]array_sizeThe count for wifi_channelMetrics_t that caller allocated
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and should not invoke any blocking system calls. This is blocking call.

◆ wifi_pushRadioChannel()

int wifi_pushRadioChannel ( int  radioIndex,
unsigned int  channel 
)

Instantlly change the radio Channel.

Use Channels Switch Announcements (CSAs) (in 802.11h) to notify the client, and channel change instantly. Do not save wifi config (channel change is not persistent over wifi reboot).

Parameters
[in]radioIndexIndex of Wi-Fi radio
[in]channelnet channel
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and should not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Deprecated

◆ wifi_pushRadioChannel2()

int wifi_pushRadioChannel2 ( int  radioIndex,
unsigned int  channel,
unsigned int  channel_width_MHz,
unsigned int  csa_beacon_count 
)

This HAL API is used to change the channel to destination channel, with destination bandwidth.

Parameters
[in]radioIndexIndex of Wi-Fi radio
[in]channelnet channel
[in]channel_width_MHzchannel frequency
[in]csa_beacon_countSpecifies how long CSA need to be announced.
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and should not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioDfsSupport()

int wifi_getRadioDfsSupport ( int  radioIndex,
unsigned char *  output_bool 
)

Get radio DFS support.

Device.WiFi.Radio.{i}.X_COMCAST-COM_DfsSupported

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[out]output_boolGet DFS support for the selected radio index in the pre-allocated buffer
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get radio DFS support.
Device.WiFi.Radio.{i}.X_COMCAST-COM_DfsSupported

Parameters
radioIndex- Index of Wi-Fi radio channel
output_bool- Get DFS support for the selected radio index in the pre-allocated buffer
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioDfsEnable()

int wifi_getRadioDfsEnable ( int  radioIndex,
unsigned char *  output_bool 
)

Get the Dfs enable status.

Data model parameter used to check the DFS enable status is, Device.WiFi.Radio.{i}.X_COMCAST-COM_DfsEnable

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[out]output_boolGet DFS Enable status of the selected radio channel
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get the Dfs enable status. Data model parameter used to check the DFS enable status is,
Device.WiFi.Radio.{i}.X_COMCAST-COM_DfsEnable

Parameters
radioIndex- Index of Wi-Fi radio channel
output_bool- Get DFS Enable status of the selected radio channel
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setRadioDfsEnable()

int wifi_setRadioDfsEnable ( int  radioIndex,
unsigned char  enabled 
)

Set the Dfs enable status.

Data model parameter used to check the DFS enable status is "Device.WiFi.Radio.{i}.X_COMCAST-COM_DfsEnable".

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[in]enableSet DFS Enable status of the selected radio channel
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Set the Dfs enable status. Data model parameter used to check the DFS enable status is "Device.WiFi.Radio.{i}.X_COMCAST-COM_DfsEnable".

Parameters
radioIndex- Index of Wi-Fi radio channel
enable- Set DFS Enable status of the selected radio channel
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioAutoChannelRefreshPeriodSupported()

int wifi_getRadioAutoChannelRefreshPeriodSupported ( int  radioIndex,
unsigned char *  output_bool 
)

Check if the driver support the AutoChannelRefreshPeriod.

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[out]output_boolGet auto channel refresh period support for the selected radio channel in the pre-allocated bool buffer.
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Check if the driver support the AutoChannelRefreshPeriod.

Parameters
radioIndex- Index of Wi-Fi radio channel
output_bool- Get auto channel refresh period support for the selected radio channel in the pre-allocated bool buffer.
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioAutoChannelRefreshPeriod()

int wifi_getRadioAutoChannelRefreshPeriod ( int  radioIndex,
unsigned long *  output_ulong 
)

Get the DCS refresh period in seconds.

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[out]output_ulongThe refresh period.
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Check if the driver support the AutoChannelRefreshPeriod.

Parameters
radioIndex- Index of Wi-Fi radio channel
output_bool- Get auto channel refresh period support for the selected radio channel in the pre-allocated bool buffer.
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setRadioAutoChannelRefreshPeriod()

int wifi_setRadioAutoChannelRefreshPeriod ( int  radioIndex,
unsigned long  seconds 
)

Set the DCS refresh period in seconds.

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[in]secondsSet auto channel refresh period in seconds support for the selected radio channel.
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Set the DCS refresh period in seconds.

Parameters
radioIndex- Index of Wi-Fi radio channel
seconds- Set auto channel refresh period in seconds support for the selected radio channel
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioOperatingChannelBandwidth()

int wifi_getRadioOperatingChannelBandwidth ( int  radioIndex,
char *  output_string 
)

Get the Operating Channel Bandwidth. eg "20MHz", "40MHz", "80MHz", "80+80", "160".

The output_string is a max length 64 octet string that is allocated by the RDKB code. Implementations must ensure that strings are not longer than this.

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[out]output_stringGet operating channel bandwidth for the selected radio channel in the pre-allocated char buffer.
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get the Operating Channel Bandwidth. eg "20MHz", "40MHz", "80MHz", "80+80", "160". The output_string is a max length 64 octet string that is allocated by the RDKB code. Implementations must ensure that strings are not longer than this.

Parameters
radioIndex- Index of Wi-Fi radio channel
output_string- Get operating channel bandwidth for the selected radio channel in the pre-allocated char buffer
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setRadioOperatingChannelBandwidth()

int wifi_setRadioOperatingChannelBandwidth ( int  radioIndex,
char *  bandwidth 
)

Set the Operating Channel Bandwidth. eg "20MHz", "40MHz", "80MHz", "80+80", "160".

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[in]bandwidthSet operating channel bandwidth for the selected radio channel
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Set the Operating Channel Bandwidth. eg "20MHz", "40MHz", "80MHz", "80+80", "160".

Parameters
radioIndex- Index of Wi-Fi radio channel
bandwidth- Set operating channel bandwidth for the selected radio channel
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioExtChannel()

int wifi_getRadioExtChannel ( int  radioIndex,
char *  output_string 
)

Get the secondary extension channel position.

"AboveControlChannel" or "BelowControlChannel". (this is for 40MHz and 80MHz bandwith only). The output_string is a max length 64 octet string that is allocated by the RDKB code. Implementations must ensure that strings are not longer than this. Device.WiFi.Radio.{i}.ExtensionChannel

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[out]output_stringSecondary extension channel position, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get the secondary extension channel position, "AboveControlChannel" or "BelowControlChannel". (this is for 40MHz and 80MHz bandwith only). The output_string is a max length 64 octet string that is allocated by the RDKB code. Implementations must ensure that strings are not longer than this.
Device.WiFi.Radio.{i}.ExtensionChannel

Parameters
radioIndex- Index of Wi-Fi radio channel
output_string- Secondary extension channel position, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setRadioExtChannel()

int wifi_setRadioExtChannel ( int  radioIndex,
char *  string 
)

Set the secondary extension channel position.

"AboveControlChannel" or "BelowControlChannel". (this is for 40MHz and 80MHz bandwith only). Device.WiFi.Radio.{i}.ExtensionChannel

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[in]stringSecondary extension channel position
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Set the secondary extension channel position, "AboveControlChannel" or "BelowControlChannel". (this is for 40MHz and 80MHz bandwith only).
Device.WiFi.Radio.{i}.ExtensionChannel

Parameters
radioIndex- Index of Wi-Fi radio channel
string- Secondary extension channel position
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioGuardInterval()

int wifi_getRadioGuardInterval ( int  radioIndex,
char *  output_string 
)

Get the guard interval value. eg "400nsec" or "800nsec".

The output_string is a max length 64 octet string that is allocated by the RDKB code. Implementations must ensure that strings are not longer than this. Device.WiFi.Radio.{i}.GuardInterval

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[out]output_stringGuard interval value, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get the guard interval value. eg "400nsec" or "800nsec". The output_string is a max length 64 octet string that is allocated by the RDKB code. Implementations must ensure that strings are not longer than this.
Device.WiFi.Radio.{i}.GuardInterval

Parameters
radioIndex- Index of Wi-Fi radio channel
output_string- Guard interval value, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setRadioGuardInterval()

int wifi_setRadioGuardInterval ( int  radioIndex,
char *  string 
)

Set the guard interval value. eg "400nsec" or "800nsec".

Device.WiFi.Radio.{i}.GuardInterval

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[in]stringGuard interval value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Set the guard interval value. eg "400nsec" or "800nsec".
Device.WiFi.Radio.{i}.GuardInterval

Parameters
radioIndex- Index of Wi-Fi radio channel
string- Guard interval value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioMCS()

int wifi_getRadioMCS ( int  radioIndex,
int *  output_INT 
)

Get the Modulation Coding Scheme index, eg: "-1", "1", "15".

Device.WiFi.Radio.{i}.MCS

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[out]output_INTModulation Coding Scheme index, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get the Modulation Coding Scheme index, eg: "-1", "1", "15".
Device.WiFi.Radio.{i}.MCS

Parameters
radioIndex- Index of Wi-Fi radio channel
output_INT- Modulation Coding Scheme index, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setRadioMCS()

int wifi_setRadioMCS ( int  radioIndex,
int  MCS 
)

Set the Modulation Coding Scheme index, eg: "-1", "1", "15".

Device.WiFi.Radio.{i}.MCS

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[in]MCSModulation Coding Scheme index value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Set the Modulation Coding Scheme index, eg: "-1", "1", "15".
Device.WiFi.Radio.{i}.MCS

Parameters
radioIndex- Index of Wi-Fi radio channel
MCS- Modulation Coding Scheme index value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioTransmitPowerSupported()

int wifi_getRadioTransmitPowerSupported ( int  radioIndex,
char *  output_list 
)

Get supported Transmit Power list, eg : "0,25,50,75,100".

The output_list is a max length 64 octet string that is allocated by the RDKB code. Implementations must ensure that strings are not longer than this. Device.WiFi.Radio.{i}.TransmitPowerSupported

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[out]output_listTransmit power list, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get supported Transmit Power list, eg : "0,25,50,75,100". The output_list is a max length 64 octet string that is allocated by the RDKB code. Implementations must ensure that strings are not longer than this.
Device.WiFi.Radio.{i}.TransmitPowerSupported

Parameters
radioIndex- Index of Wi-Fi radio channel
output_list- Transmit power list, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioTransmitPower()

int wifi_getRadioTransmitPower ( int  radioIndex,
unsigned long *  output_ulong 
)

Get current Transmit Power in dBm units.

The transmit power value is in dBm units of full power for this radio. Device.WiFi.Radio.{i}.TransmitPower

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[out]output_ulongCurrent Transmit power value, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get current Transmit Power, eg "75", "100". The transmite power level is in units of full power for this radio.
Device.WiFi.Radio.{i}.TransmitPower

Parameters
radioIndex- Index of Wi-Fi radio channel
ULONG*output_ulong - Current Transmit power value, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioPercentageTransmitPower()

int wifi_getRadioPercentageTransmitPower ( int  radioIndex,
unsigned long *  output_ulong 
)

Get current Transmit Power level in units of full power.

The transmit power is a percentage value of full power for this radio.

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[out]output_ulongCurrent Transmit power percentage value, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setRadioTransmitPower()

int wifi_setRadioTransmitPower ( int  radioIndex,
unsigned long  TransmitPower 
)

Set current Transmit Power, eg "75", "100".

The transmit power level is in units of full power for this radio. Device.WiFi.Radio.{i}.TransmitPower

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[in]TransmitPowerTransmit power value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Set current Transmit Power, eg "75", "100". The transmite power level is in units of full power for this radio.
Device.WiFi.Radio.{i}.TransmitPower

Parameters
radioIndex- Index of Wi-Fi radio channel
TransmitPower- Transmit power value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioIEEE80211hSupported()

int wifi_getRadioIEEE80211hSupported ( int  radioIndex,
unsigned char *  Supported 
)

Get 80211h Supported.

80211h solves interference with satellites and radar using the same 5 GHz frequency band. Device.WiFi.Radio.{i}.IEEE80211hSupported

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[out]Supported80211h Supported, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get 80211h Supported.
80211h solves interference with satellites and radar using the same 5 GHz frequency band.
Device.WiFi.Radio.{i}.IEEE80211hSupported

Parameters
radioIndex- Index of Wi-Fi radio channel
Supported- 80211h Supported, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioIEEE80211hEnabled()

int wifi_getRadioIEEE80211hEnabled ( int  radioIndex,
unsigned char *  enable 
)

Get 80211h feature enable.

Device.WiFi.Radio.{i}.IEEE80211hEnabled

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[out]enable80211h feature enable, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get 80211h feature enable.
Device.WiFi.Radio.{i}.IEEE80211hEnabled

Parameters
radioIndex- Index of Wi-Fi radio channel
enable- 80211h feature enable, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setRadioIEEE80211hEnabled()

int wifi_setRadioIEEE80211hEnabled ( int  radioIndex,
unsigned char  enable 
)

Set 80211h feature enable.

Device.WiFi.Radio.{i}.IEEE80211hEnabled

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[in]enable80211h feature enable
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Set 80211h feature enable.
Device.WiFi.Radio.{i}.IEEE80211hEnabled

Parameters
radioIndex- Index of Wi-Fi radio channel
enable- 80211h feature enable
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioCarrierSenseThresholdRange()

int wifi_getRadioCarrierSenseThresholdRange ( int  radioIndex,
int *  output 
)

Indicates the Carrier Sense ranges supported by the radio.

It is measured in dBm. Refer section A.2.3.2 of CableLabs Wi-Fi MGMT Specification. Device.WiFi.Radio.{i}.RegulatoryDomain Device.WiFi.Radio.{i}.X_COMCAST-COM_CarrierSenseThresholdRange

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[out]outputCarrier sense threshold range, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Indicates the Carrier Sense ranges supported by the radio. It is measured in dBm. Refer section A.2.3.2 of CableLabs Wi-Fi MGMT Specification.
Device.WiFi.Radio.{i}.RegulatoryDomain
Device.WiFi.Radio.{i}.X_COMCAST-COM_CarrierSenseThresholdRange

Parameters
radioIndex- Index of Wi-Fi radio channel
output- Carrier sense threshold range, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioCarrierSenseThresholdInUse()

int wifi_getRadioCarrierSenseThresholdInUse ( int  radioIndex,
int *  output 
)

The RSSI signal level at which CS/CCA detects a busy condition.

This attribute enables Access Points to increase minimum sensitivity to avoid detecting busy condition from multiple/weak Wi-Fi sources in dense Wi-Fi environments. It is measured in dBm. Refer section A.2.3.2 of CableLabs Wi-Fi MGMT Specification. Device.WiFi.Radio.{i}.X_COMCAST-COM_CarrierSenseThresholdInUse

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[out]outputCarrier sense threshold in use, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

The RSSI signal level at which CS/CCA detects a busy condition. This attribute enables APs to increase minimum sensitivity to avoid detecting busy condition from multiple/weak Wi-Fi sources in dense Wi-Fi environments. It is measured in dBm. Refer section A.2.3.2 of CableLabs Wi-Fi MGMT Specification.
Device.WiFi.Radio.{i}.X_COMCAST-COM_CarrierSenseThresholdInUse

Parameters
radioIndex- Index of Wi-Fi radio channel
output- Carrier sense threshold in use, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setRadioCarrierSenseThresholdInUse()

int wifi_setRadioCarrierSenseThresholdInUse ( int  radioIndex,
int  threshold 
)

Set Carrier sense threshold in use for the selected radio index.

The RSSI signal level at which CS/CCA detects a busy condition. This attribute enables Access Point to increase minimum sensitivity to avoid detecting busy condition from multiple/weak Wi-Fi sources in dense Wi-Fi environments. It is measured in dBm. Device.WiFi.Radio.{i}.X_COMCAST-COM_CarrierSenseThresholdInUse

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[in]thresholdCarrier sense threshold, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Set Carrier sense threshold in use for the selected radio index. The RSSI signal level at which CS/CCA detects a busy condition. This attribute enables APs to increase minimum sensitivity to avoid detecting busy condition from multiple/weak Wi-Fi sources in dense Wi-Fi environments. It is measured in dBm.
Device.WiFi.Radio.{i}.X_COMCAST-COM_CarrierSenseThresholdInUse

Parameters
radioIndex- Index of Wi-Fi radio channel
threshold- Carrier sense threshold, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioBeaconPeriod()

int wifi_getRadioBeaconPeriod ( int  radioIndex,
unsigned int *  output 
)

Gets the time interval between transmitting beacons (expressed in milliseconds).

This parameter is based ondot11BeaconPeriod from [802.11-2012]. Device.WiFi.Radio.{i}.BeaconPeriod

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[out]outputRadio Beacon period, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Time interval between transmitting beacons (expressed in milliseconds). This parameter is based ondot11BeaconPeriod from [802.11-2012].
Device.WiFi.Radio.{i}.BeaconPeriod

Parameters
radioIndex- Index of Wi-Fi radio channel
output- Radio Beacon period, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setRadioBeaconPeriod()

int wifi_setRadioBeaconPeriod ( int  radioIndex,
unsigned int  BeaconPeriod 
)

Sets the time interval between transmitting beacons (expressed in milliseconds).

This parameter is based ondot11BeaconPeriod from [802.11-2012]. Device.WiFi.Radio.{i}.BeaconPeriod

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[in]BeaconPeriodRadio Beacon period
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Time interval between transmitting beacons (expressed in milliseconds). This parameter is based ondot11BeaconPeriod from [802.11-2012].
Device.WiFi.Radio.{i}.BeaconPeriod

Parameters
radioIndex- Index of Wi-Fi radio channel
BeaconPeriod- Radio Beacon period
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioBasicDataTransmitRates()

int wifi_getRadioBasicDataTransmitRates ( int  radioIndex,
char *  output 
)

Get the set of data rates, in Mbps.

This has to be supported by all stations that desire to join this BSS. The stations have to be able to receive and transmit at each of the data rates listed inBasicDataTransmitRates. For example, a value of "1,2", indicates that stations support 1 Mbps and 2 Mbps. Most control packets use a data rate in BasicDataTransmitRates. Device.WiFi.Radio.{i}.BasicDataTransmitRates

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[out]outputComma-separated list of strings, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get the set of data rates, in Mbps, that have to be supported by all stations that desire to join this BSS. The stations have to be able to receive and transmit at each of the data rates listed inBasicDataTransmitRates. For example, a value of "1,2", indicates that stations support 1 Mbps and 2 Mbps. Most control packets use a data rate in BasicDataTransmitRates.
Device.WiFi.Radio.{i}.BasicDataTransmitRates

Parameters
radioIndex- Index of Wi-Fi radio channel
output- Comma-separated list of strings, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setRadioBasicDataTransmitRates()

int wifi_setRadioBasicDataTransmitRates ( int  radioIndex,
char *  TransmitRates 
)

Set the data rates, in Mbps.

This have to be supported by all stations that desire to join this BSS. The stations have to be able to receive and transmit at each of the data rates listed inBasicDataTransmitRates. For example, a value of "1,2", indicates that stations support 1 Mbps and 2 Mbps. Most control packets use a data rate in BasicDataTransmitRates. Device.WiFi.Radio.{i}.BasicDataTransmitRates

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[in]TransmitRatesComma-separated list of strings
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Set the data rates, in Mbps, that have to be supported by all stations that desire to join this BSS. The stations have to be able to receive and transmit at each of the data rates listed inBasicDataTransmitRates. For example, a value of "1,2", indicates that stations support 1 Mbps and 2 Mbps. Most control packets use a data rate in BasicDataTransmitRates.
Device.WiFi.Radio.{i}.BasicDataTransmitRates

Parameters
radioIndex- Index of Wi-Fi radio channel
TransmitRates- Comma-separated list of strings
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioSupportedDataTransmitRates()

int wifi_getRadioSupportedDataTransmitRates ( int  radioIndex,
char *  output_rates 
)

Get the supported data transmit rates in Mbps.

That have to be supported by all stations that desire to join this BSS. The stations have to be able to receive and transmit at each of the data rates listed in SupportedDataTransmitRates. For example, a value of "1,2", indicates that stations support 1 Mbps and 2 Mbps. Most control packets use a data rate in SupportedDataTransmitRates Device.WiFi.Radio.{i}.SupportedDataTransmitRates

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[out]output_ratesComma-separated list of strings, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioOperationalDataTransmitRates()

int wifi_getRadioOperationalDataTransmitRates ( int  radioIndex,
char *  output_rates 
)

Get the set of data rates, in Mbps, that have to be supported by all stations that desire to join this BSS.

The stations have to be able to receive and transmit at each of the data rates listed inOperationalDataTransmitRates. For example, a value of "1,2", indicates that stations support 1 Mbps and 2 Mbps. Most control packets use a data rate in OperationalDataTransmitRates. Device.WiFi.Radio.{i}.OperationalDataTransmitRates

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[out]output_ratesComma-separated list of strings, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setRadioOperationalDataTransmitRates()

int wifi_setRadioOperationalDataTransmitRates ( int  radioIndex,
char *  rates 
)

Set the data rates, in Mbps, that have to be supported by all stations that desire to join this BSS.

The stations should be able to receive and transmit at each of the data rates listed in OperationalDataTransmitRates. For example, a value of "1,2", indicates that stations support 1 Mbps and 2 Mbps. Most control packets use a data rate in OperationalDataTransmitRates. Device.WiFi.Radio.{i}.OperationalDataTransmitRates

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[out]ratesComma-separated list of strings
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioTrafficStats2()

int wifi_getRadioTrafficStats2 ( int  radioIndex,
wifi_radioTrafficStats2_t output_struct 
)

Get detail radio traffic static info.

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[out]output_structwifi_radioTrafficStats2_t *output_struct, all traffic stats info to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get detail radio traffic static info.

Parameters
radioIndex- Index of Wi-Fi radio channel
output_struct- wifi_radioTrafficStats2_t *output_struct, all traffic stats info to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setRadioTrafficStatsMeasure()

int wifi_setRadioTrafficStatsMeasure ( int  radioIndex,
wifi_radioTrafficStatsMeasure_t input_struct 
)

Set radio traffic static Measuring rules.

Device.WiFi.Radio.{i}.Stats.X_COMCAST-COM_RadioStatisticsMeasuringRate Device.WiFi.Radio.{i}.Stats.X_COMCAST-COM_RadioStatisticsMeasuringInterval

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[in]input_structwifi_radioTrafficStatsMeasure_t *input_struct, traffic stats measure info
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Set radio traffic static Measuring rules.
Device.WiFi.Radio.{i}.Stats.X_COMCAST-COM_RadioStatisticsMeasuringRate
Device.WiFi.Radio.{i}.Stats.X_COMCAST-COM_RadioStatisticsMeasuringInterval

Parameters
radioIndex- Index of Wi-Fi radio channel
input_struct- wifi_radioTrafficStatsMeasure_t *input_struct, traffic stats measure info
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setRadioTrafficStatsRadioStatisticsEnable()

int wifi_setRadioTrafficStatsRadioStatisticsEnable ( int  radioIndex,
unsigned char  enable 
)

Set radio traffic statistics enable.

Device.WiFi.Radio.{i}.Stats.X_COMCAST-COM_RadioStatisticsEnable bool writable

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[out]enableEnable/disable, traffic stats statistics
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Set radio traffic statistics enable.
Device.WiFi.Radio.{i}.Stats.X_COMCAST-COM_RadioStatisticsEnable bool writable

Parameters
radioIndex- Index of Wi-Fi radio channel
enable- Enable/disable, traffic stats statistics
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioStatsReceivedSignalLevel()

int wifi_getRadioStatsReceivedSignalLevel ( int  radioIndex,
int  signalIndex,
int *  SignalLevel 
)

Clients associated with the AP over a specific interval.

The histogram MUST have a range from -110to 0 dBm and MUST be divided in bins of 3 dBM, with bins aligning on the -110 dBm end of the range. Received signal levels equal to or greater than the smaller boundary of a bin and less than the larger boundary are included in the respective bin. The bin associated with the clients current received signal level MUST be incremented when a client associates with the AP. Additionally, the respective bins associated with each connected clients current received signal level MUST be incremented at the interval defined by "Radio Statistics Measuring Rate". The histogram bins MUST NOT be incremented at any other time. The histogram data collected during the interval MUST be published to the parameter only at the end of the interval defined by "Radio Statistics Measuring Interval". The underlying histogram data MUST be cleared at the start of each interval defined by "Radio Statistics Measuring Interval". If any of the parameter's representing this histogram is queried before the histogram has been updated with an initial set of data, it MUST return -1. Units dBm. Device.WiFi.Radio.{i}.Stats.X_COMCAST-COM_ReceivedSignalLevel.{i}.ReceivedSignalLevel

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[in]signalIndexSignal index
[out]

◆ wifi_applyRadioSettings()

int wifi_applyRadioSettings ( int  radioIndex)

This API is used to apply (push) all previously set radio level variables and make these settings active in the hardware.

Not all implementations may need this function. If not needed for a particular implementation simply return no-error (0).

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

This API is used to apply (push) all previously set radio level variables and make these settings active in the hardware. Not all implementations may need this function. If not needed for a particular implementation simply return no-error (0).

Parameters
radioIndex- Index of Wi-Fi radio channel
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioResetCount()

int wifi_getRadioResetCount ( int  radioIndex,
unsigned long *  output_int 
)

Get the radio reset count.

Parameters
[in]radioIndexIndex of Wi-Fi radio channel
[out]output_intReset count, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get the radio reset count.

Parameters
radioIndex- Index of Wi-Fi radio channel
output_int- Reset count, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getSSIDRadioIndex()

int wifi_getSSIDRadioIndex ( int  ssidIndex,
int *  radioIndex 
)

Get the radio index associated with the SSID entry.

Parameters
[in]ssidIndexSSID index
[out]radioIndexRadio index, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get the radio index associated with the SSID entry.

Parameters
ssidIndex- SSID index
radioIndex- Radio index, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getSSIDEnable()

int wifi_getSSIDEnable ( int  ssidIndex,
unsigned char *  output_bool 
)

Get SSID enable configuration parameters (not the SSID enable status).

Device.WiFi.SSID.{i}.Enable

Parameters
[in]ssidIndexSSID index
[out]output_boolSSID enable, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get SSID enable configuration parameters (not the SSID enable status).
Device.WiFi.SSID.{i}.Enable

Parameters
ssidIndex- SSID index
output_bool- SSID enable, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setSSIDEnable()

int wifi_setSSIDEnable ( int  ssidIndex,
unsigned char  enable 
)

Set SSID enable configuration parameters.

Device.WiFi.SSID.{i}.Enable

Parameters
[in]ssidIndexSSID index
[in]enableSSID enable value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Set SSID enable configuration parameters.
Device.WiFi.SSID.{i}.Enable

Parameters
ssidIndex- SSID index
enable- SSID enable value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getSSIDStatus()

int wifi_getSSIDStatus ( int  ssidIndex,
char *  output_string 
)

Get SSID enable status. Device.WiFi.SSID.{i}.Status.

Parameters
[in]ssidIndexSSID index
[out]output_stringSSID enable status, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get SSID enable status.
Device.WiFi.SSID.{i}.Status

Parameters
ssidIndex- SSID index
output_string- SSID enable status, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getSSIDName()

int wifi_getSSIDName ( int  apIndex,
char *  output_string 
)

Get SSID Name associated with the Access Point index.

Outputs a 32 byte or less string indicating the SSID name. Sring buffer must be preallocated by the caller. Device.WiFi.SSID.{i}.Name Device.WiFi.SSID.{i}.Alias

Parameters
[in]apIndexAccess Point index
[out]output_stringSSID name, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get SSID Name associated with the Access Point index. Outputs a 32 byte or less string indicating the SSID name. Sring buffer must be preallocated by the caller.
Device.WiFi.SSID.{i}.Name
Device.WiFi.SSID.{i}.Alias

Parameters
apIndex- Access Point index
output_string- SSID enable status, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getSSIDNameStatus()

int wifi_getSSIDNameStatus ( int  apIndex,
char *  output_string 
)

To read the run time ssid name.

Parameters
[in]apIndexAccess Point index
[out]output_stringSSID name, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setSSIDName()

int wifi_setSSIDName ( int  apIndex,
char *  ssid_string 
)

Set SSID Name associated with the Access Point index.

Device.WiFi.SSID.{i}.Name Device.WiFi.SSID.{i}.Alias Accepts a max 32 byte string and sets an internal variable to the SSID name.

Parameters
[in]apIndexAccess Point index
[out]ssid_stringSSID Name
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Set SSID Name associated with the Access Point index.
Device.WiFi.SSID.{i}.Name
Device.WiFi.SSID.{i}.Alias

Parameters
apIndex- Access Point index
ssid_string- SSID Name
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getBaseBSSID()

int wifi_getBaseBSSID ( int  ssidIndex,
char *  output_string 
)

Get the BSSID.

Device.WiFi.SSID.{i}.BSSID

Parameters
[in]ssidIndexSSID index
[out]output_stringBase BSSID, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get the BSSID.
Device.WiFi.SSID.{i}.BSSID

Parameters
ssidIndex- SSID index
output_string- Base BSSID, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getSSIDMACAddress()

int wifi_getSSIDMACAddress ( int  ssidIndex,
char *  output_string 
)

Get the MAC address associated with this Wifi SSID.

Device.WiFi.SSID.{i}.MACAddress

Parameters
[in]ssidIndexSSID index
[out]output_stringMAC Address, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get the MAC address associated with this Wifi SSID.
Device.WiFi.SSID.{i}.MACAddress

Parameters
ssidIndex- SSID index
output_string- MAC Address, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getSSIDTrafficStats2()

int wifi_getSSIDTrafficStats2 ( int  ssidIndex,
wifi_ssidTrafficStats2_t output_struct 
)

Get the basic SSID traffic static info.

Parameters
[in]ssidIndexSSID index
[out]output_structSSID traffic status.
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get the basic SSID traffic static info.

Parameters
ssidIndex- SSID index
output_struct- wifi_ssidTrafficStats2_t *output_struct SSID traffic stats, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_applySSIDSettings()

int wifi_applySSIDSettings ( int  ssidIndex)

Apply SSID and AP (in the case of Acess Point devices) to the hardware.

Not all implementations may need this function. If not needed for a particular implementation simply return no-error (0).

Parameters
[in]ssidIndexSSID index
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Apply SSID and AP (in the case of Acess Point devices) to the hardware. Not all implementations may need this function. If not needed for a particular implementation simply return no-error (0).

Parameters
ssidIndex- SSID index
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getNeighboringWiFiDiagnosticResult2()

int wifi_getNeighboringWiFiDiagnosticResult2 ( int  radioIndex,
wifi_neighbor_ap2_t **  neighbor_ap_array,
unsigned int *  output_array_size 
)

Start the wifi scan and get the result into output buffer for RDKB to parser.

The result will be used to manage endpoint list. HAL functon should allocate an data structure array, and return to caller with "neighbor_ap_array".

Parameters
[in]radioIndexRadio index
[out]neighbor_ap_arrayNeighbour access point info to be returned
[out]output_array_sizeLength of the output array.
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Start the wifi scan and get the result into output buffer for RDKB to parser. The result will be used to manage endpoint list. HAL funciton should allocate an data structure array, and return to caller with "neighbor_ap_array".

Parameters
radioIndex- Radio index
neighbor_ap_array- wifi_neighbor_ap2_t **neighbor_ap_array, neighbour access point info to be returned
output_array_size- UINT *output_array_size, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getNeighboringWiFiStatus()

int wifi_getNeighboringWiFiStatus ( int  radioIndex,
wifi_neighbor_ap2_t **  neighbor_ap_array,
unsigned int *  output_array_size 
)

Returns the Wifi scan status.

Parameters
[in]radioIndexRadio index
[out]neighbor_ap_arrayNeighbour access point info to be returned
[out]output_array_sizeLength of the output array.
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_startNeighborScan()

int wifi_startNeighborScan ( int  apIndex,
wifi_neighborScanMode_t  scan_mode,
int  dwell_time,
unsigned int  chan_num,
unsigned int *  chan_list 
)

This API initates the scanning.

Parameters
[in]apIndexThe index of access point array.
[out]scan_modeScan modes.
[out]dwell_timeAmount of time spent on each channel in the hopping sequence.
[out]chan_numThe channel number.
[out]chan_listList of channels.
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getSSIDTrafficStats()

int wifi_getSSIDTrafficStats ( int  ssidIndex,
wifi_ssidTrafficStats_t output_struct 
)

Deprecated: used for old RDKB code.

◆ wifi_getBasicTrafficStats()

int wifi_getBasicTrafficStats ( int  apIndex,
wifi_basicTrafficStats_t output_struct 
)

Outputs basic traffic stats per AP.

Deprecated: used for old RDKB code.

◆ wifi_getWifiTrafficStats()

int wifi_getWifiTrafficStats ( int  apIndex,
wifi_trafficStats_t output_struct 
)

Outputs more detailed traffic stats per AP.

Deprecated: used for old RDKB code.

◆ wifi_getNeighboringWiFiDiagnosticResult()

int wifi_getNeighboringWiFiDiagnosticResult ( wifi_neighbor_ap_t **  neighbor_ap_array,
unsigned int *  output_array_size 
)

Deprecated: used for old RDKB code.

◆ wifi_getAllAssociatedDeviceDetail()

int wifi_getAllAssociatedDeviceDetail ( int  apIndex,
unsigned long *  output_ulong,
wifi_device_t **  output_struct 
)

Deprecated: used for old RDKB code.

◆ wifi_getBandSteeringCapability()

int wifi_getBandSteeringCapability ( unsigned char *  support)

To get Band Steering Capability.

Device.WiFi.X_RDKCENTRAL-COM_BandSteering object Device.WiFi.X_RDKCENTRAL-COM_BandSteering.Capability bool r/o

Parameters
[out]supportBand Steering Capability support, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getBandSteeringEnable()

int wifi_getBandSteeringEnable ( unsigned char *  enable)

To get Band Steering enable status.

Device.WiFi.X_RDKCENTRAL-COM_BandSteering.Enable bool r/w

Parameters
[out]enableBand Steering enable status, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setBandSteeringEnable()

int wifi_setBandSteeringEnable ( unsigned char  enable)

To turn on/off Band steering.

Parameters
[in]enableBand Steering enable status
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getBandSteeringApGroup()

int wifi_getBandSteeringApGroup ( char *  output_ApGroup)

To get Band Steering Access Point group.

Parameters
[out]output_ApGroupBand Steering Access point group
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setBandSteeringApGroup()

int wifi_setBandSteeringApGroup ( char *  ApGroup)

To set Band Steering Access Point group.

Parameters
[in]ApGroup- Band Steering Access Point group
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioBandUtilization()

int wifi_getRadioBandUtilization ( int  radioIndex,
int *  output_percentage 
)

To read the radio band utilization.

Parameters
[in]radioIndexRadio Index
[out]output_percentageRadio band utilization percentage, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApAssociatedDevice()

int wifi_getApAssociatedDevice ( int  ap_index,
char *  output_buf,
int  output_buf_size 
)

Gets the ApAssociatedDevice list for client MAC addresses.

Parameters
[in]apIndexAccess Point index
[out]output_bufList for client MAC, to be returned
[out]output_buf_sizeBuffer length
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None

◆ wifi_getApDeviceRSSI()

int wifi_getApDeviceRSSI ( int  ap_index,
char *  MAC,
int *  output_RSSI 
)

Gets the RSSI value associated with the access point.

Parameters
[in]apIndexAccess Point index
[out]MACClient MAC in upcase format
[out]output_RSSIRSSI is in dbm
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None

◆ wifi_getApDeviceRxrate()

int wifi_getApDeviceRxrate ( int  ap_index,
char *  MAC,
int *  output_RxMb 
)

Gets the ApAssociatedDevice Rx Rate.

Parameters
[in]apIndexAccess Point index
[in]MACClient MAC in upcase format
[ut]output_RxMb Rx Rate in Mb
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None

◆ wifi_getApDeviceTxrate()

int wifi_getApDeviceTxrate ( int  ap_index,
char *  MAC,
int *  output_TxMb 
)

Gets the ApAssociatedDevice Tx Rate.

Parameters
[in]apIndexAccess Point index
[in]MACClient MAC in upcase format
[out]output_TxMbTx Rate in Mb
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None

◆ wifi_getBandSteeringBandUtilizationThreshold()

int wifi_getBandSteeringBandUtilizationThreshold ( int  radioIndex,
int *  pBuThreshold 
)

To set and read the band steering BandUtilizationThreshold parameters.

Device.WiFi.X_RDKCENTRAL-COM_BandSteering.BandSetting.{i}.UtilizationThreshold int r/w

Parameters
[in]radioIndexRadio Index
[out]pBuThresholdSteering bane utilization threshold, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setBandSteeringBandUtilizationThreshold()

int wifi_setBandSteeringBandUtilizationThreshold ( int  radioIndex,
int  buThreshold 
)

To set the band steering BandUtilizationThreshold parameters.

Device.WiFi.X_RDKCENTRAL-COM_BandSteering.BandSetting.{i}.UtilizationThreshold int r/w

Parameters
[in]radioIndexRadio Index
[in]buThresholdSteering bane utilization threshold
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getBandSteeringRSSIThreshold()

int wifi_getBandSteeringRSSIThreshold ( int  radioIndex,
int *  pRssiThreshold 
)

To read the band steering RSSIThreshold parameters.

Device.WiFi.X_RDKCENTRAL-COM_BandSteering.BandSetting.{i}.RSSIThreshold int r/w

Parameters
[in]radioIndexRadio Index
[in]pRssiThresholdBand steering RSSIThreshold value, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setBandSteeringRSSIThreshold()

int wifi_setBandSteeringRSSIThreshold ( int  radioIndex,
int  rssiThreshold 
)

To set the band steering RSSIThreshold parameters.

For 2.4G, the expectation is if the 2G rssi is below the set value steer to 2G For 5G, if the set value is greater than the set threshold value then steer to 5 Device.WiFi.X_RDKCENTRAL-COM_BandSteering.BandSetting.{i}.RSSIThreshold int r/w

Parameters
[in]radioIndexRadio Index
[in]rssiThresholdBand steering RSSIThreshold value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getBandSteeringPhyRateThreshold()

int wifi_getBandSteeringPhyRateThreshold ( int  radioIndex,
int *  pPrThreshold 
)

To read the band steering physical modulation rate threshold parameters.

Device.WiFi.X_RDKCENTRAL-COM_BandSteering.BandSetting.{i}.PhyRateThreshold int r/w

Parameters
[in]radioIndexRadio Index
[out]pPrThresholdPhysical modulation rate threshold value, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setBandSteeringPhyRateThreshold()

int wifi_setBandSteeringPhyRateThreshold ( int  radioIndex,
int  prThreshold 
)

To set the band steering physical modulation rate threshold parameters.

Device.WiFi.X_RDKCENTRAL-COM_BandSteering.BandSetting.{i}.PhyRateThreshold int r/w

Parameters
[in]radioIndexRadio Index
[in]prThresholdPhysical modulation rate threshold value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getBandSteeringOverloadInactiveTime()

int wifi_getBandSteeringOverloadInactiveTime ( int  radioIndex,
int *  overloadInactiveTime 
)

To read the inactivity time (in seconds) for steering under overload condition.

Device.WiFi.X_RDKCENTRAL-COM_BandSteering.BandSetting.{i}.OverloadInactiveTime int r/w

Parameters
[in]radioIndexRadio Index
[out]overloadInactiveTimeinactivity time (in seconds) for steering under overload condition
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setBandSteeringOverloadInactiveTime()

int wifi_setBandSteeringOverloadInactiveTime ( int  radioIndex,
int  overloadInactiveTime 
)

To set the inactivity time (in seconds) for steering under overload condition.

Device.WiFi.X_RDKCENTRAL-COM_BandSteering.BandSetting.{i}.OverloadInactiveTime int r/w

Parameters
[in]radioIndexRadio Index
[in]overloadInactiveTimeInactivity time (in seconds) for steering under overload condition
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getBandSteeringIdleInactiveTime()

int wifi_getBandSteeringIdleInactiveTime ( int  radioIndex,
int *  idleInactiveTime 
)

To read the inactivity time (in seconds) for steering under Idle condition.

Device.WiFi.X_RDKCENTRAL-COM_BandSteering.BandSetting.{i}.IdleInactiveTime int r/w

Parameters
[in]radioIndexRadio Index
[out]idleInactiveTimeInactivity time (in seconds) for steering under Idle condition
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setBandSteeringIdleInactiveTime()

int wifi_setBandSteeringIdleInactiveTime ( int  radioIndex,
int  idleInactiveTime 
)

To set the inactivity time (in seconds) for steering under Idle condition.

Device.WiFi.X_RDKCENTRAL-COM_BandSteering.BandSetting.{i}.IdleInactiveTime int r/w

Parameters
[in]radioIndexRadio Index
[in]idleInactiveTimeInactivity time (in seconds) for steering under Idle condition
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getBandSteeringLog()

int wifi_getBandSteeringLog ( int  record_index,
unsigned long *  pSteeringTime,
char *  pClientMAC,
int *  pSourceSSIDIndex,
int *  pDestSSIDIndex,
int *  pSteeringReason 
)

To get the band steering log.

If no steering or record_index is out of boundary, return -1. Device.WiFi.X_RDKCENTRAL-COM_BandSteering.History string r/o

Parameters
[in]record_indexRecord index
[out]pSteeringTimeReturns the UTC time in seconds
[in]pClientMACpClientMAC is pre allocated as 64bytes
[in]pSourceSSIDIndexSource SSID index
[in]pDestSSIDIndexDestination SSID index
[out]pSteeringReasonReturns the predefined steering trigger reason
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_factoryResetAP()

int wifi_factoryResetAP ( int  apIndex)

Restore Access point paramters to default without change other AP nor Radio parameters (No need to reboot wifi)

Parameters
[in]apIndexAccess Point index
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Restore AP paramters to default without change other AP nor Radio parameters (No need to reboot wifi)

Parameters
apIndex- Access Point index
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setRadioCtsProtectionEnable()

int wifi_setRadioCtsProtectionEnable ( int  apIndex,
unsigned char  enable 
)

Enables CTS protection for the radio used by this Access Point.

Parameters
[in]apIndexAccess Point index
[in]enableCTS protection enable value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Enables CTS protection for the radio used by this AP

Parameters
apIndex- Access Point index
enable- CTS protection enable value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setRadioObssCoexistenceEnable()

int wifi_setRadioObssCoexistenceEnable ( int  apIndex,
unsigned char  enable 
)

Enables OBSS Coexistence - fall back to 20MHz if necessary for the radio used by this AP.

Parameters
[in]apIndexAccess Point index
[in]enableOBSS Coexistence enable value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

enables OBSS Coexistence - fall back to 20MHz if necessary for the radio used by this AP.

Parameters
apIndex- Access Point index
enable- OBSS Coexistence enable value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setRadioFragmentationThreshold()

int wifi_setRadioFragmentationThreshold ( int  apIndex,
unsigned int  threshold 
)

Sets the fragmentation threshold in bytes for the radio used by this Access Point.

Parameters
[in]apIndexAccess Point index
[in]thresholdFragmentation Threshold value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Sets the fragmentation threshold in bytes for the radio used by this AP.

Parameters
apIndex- Access Point index
threshold- Fragmentation Threshold value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setRadioSTBCEnable()

int wifi_setRadioSTBCEnable ( int  radioIndex,
unsigned char  STBC_Enable 
)

Enable STBC mode in the hardware. 0 == not enabled, 1 == enabled.

Parameters
[in]radioIndexRadio index
[in]STBC_EnableSTBC mode enable value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Enable STBC mode in the hardware, 0 == not enabled, 1 == enabled.

Parameters
radioIndex- Radio index
STBC_Enable- STBC mode enable value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioAMSDUEnable()

int wifi_getRadioAMSDUEnable ( int  radioIndex,
unsigned char *  output_bool 
)

Outputs A-MSDU enable status, 0 == not enabled, 1 == enabled.

Parameters
[in]radioIndexRadio index
[out]output_boolA-MSDU enable status, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Outputs A-MSDU enable status, 0 == not enabled, 1 == enabled.

Parameters
radioIndex- Radio index
output_bool- A-MSDU enable status, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setRadioAMSDUEnable()

int wifi_setRadioAMSDUEnable ( int  radioIndex,
unsigned char  amsduEnable 
)

Enables A-MSDU in the hardware, 0 == not enabled, 1 == enabled.

Parameters
[in]radioIndexRadio index
[out]amsduEnableA-MSDU enable status value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Enables A-MSDU in the hardware, 0 == not enabled, 1 == enabled.

Parameters
radioIndex- Radio index
amsduEnable- A-MSDU enable status value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioTxChainMask()

int wifi_getRadioTxChainMask ( int  radioIndex,
int *  output_int 
)

Outputs the number of Tx streams.

Parameters
[in]radioIndexRadio index
[out]output_intNumber of Tx streams, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Outputs the number of Tx streams.

Parameters
radioIndex- Radio index
output_int- Number of Tx streams, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setRadioTxChainMask()

int wifi_setRadioTxChainMask ( int  radioIndex,
int  numStreams 
)

Sets the number of Tx streams to an environment variable.

Parameters
[in]radioIndexRadio index
[in]numStreamsNumber of Tx streams
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Sets the number of Tx streams to an enviornment variable.

Parameters
radioIndex- Radio index
numStreams- Number of Tx streams
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioRxChainMask()

int wifi_getRadioRxChainMask ( int  radioIndex,
int *  output_int 
)

Outputs the number of Rx streams.

Parameters
[in]radioIndexRadio index
[out]output_intNumber of Rx streams, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Outputs the number of Rx streams.

Parameters
radioIndex- Radio index
output_int- Number of Rx streams, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setRadioRxChainMask()

int wifi_setRadioRxChainMask ( int  radioIndex,
int  numStreams 
)

Sets the number of Rx streams to an environment variable.

Parameters
[in]radioIndexRadio index
[in]numStreamsNumber of Rx streams
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Sets the number of Rx streams to an enviornment variable.

Parameters
radioIndex- Radio index
numStreams- Number of Rx streams
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_pushBridgeInfo()

int wifi_pushBridgeInfo ( int  apIndex)

<Deprecated

Deprecated

◆ wifi_pushRadioChannelMode()

int wifi_pushRadioChannelMode ( int  radioIndex)

< Deprecated < Deprecated

Deprecated

◆ wifi_pushRadioTxChainMask()

int wifi_pushRadioTxChainMask ( int  radioIndex)

< Deprecated

Deprecated

◆ wifi_pushRadioRxChainMask()

int wifi_pushRadioRxChainMask ( int  radioIndex)

< Deprecated

Deprecated

◆ wifi_pushSSID()

int wifi_pushSSID ( int  apIndex,
char *  ssid 
)

Push the environment variable that is set by "wifi_setSsidName" to the hardware.

Parameters
[in]apIndexAccess Point index
[in]ssidWiFi SSID value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Push the enviornment varible that is set by "wifi_setSsidName" to the hardware.

Parameters
apIndex- Access Point index
ssid- WiFi SSID value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_pushSsidAdvertisementEnable()

int wifi_pushSsidAdvertisementEnable ( int  apIndex,
unsigned char  enable 
)

Push the environment variable that is set by "wifi_setApSsidAdvertisementEnable" to the hardware.

Parameters
[in]apIndexAccess Point index
[in]enableSSID Advertisement value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Push the enviornment varible that is set by "wifi_setApSsidAdvertisementEnable" to the hardware.

Parameters
apIndex- Access Point index
enable- SSID Advertisement value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioUpTime()

int wifi_getRadioUpTime ( int  radioIndex,
unsigned long *  uptime 
)

Get the number of seconds elapsed since radio is started.

Parameters
[in]radioIndexRadio index
[in]uptimeWifi uptime, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get the number of seconds elapsed since radio is started.

Parameters
radioIndex- Radio index
uptime- Wifi uptime, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioReverseDirectionGrantSupported()

int wifi_getRadioReverseDirectionGrantSupported ( int  radioIndex,
unsigned char *  output_bool 
)

Get radio RDG enable Support.

Parameters
[in]radioIndexRadio index
[out]output_boolRDG enable support value, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get radio RDG enable Support.

Parameters
radioIndex- Radio index
output_bool- RDG enable support value, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioReverseDirectionGrantEnable()

int wifi_getRadioReverseDirectionGrantEnable ( int  radioIndex,
unsigned char *  output_bool 
)

Get radio RDG enable setting.

Parameters
[in]radioIndexRadio index
[out]output_boolRDG enable setting value, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get radio RDG enable setting.

Parameters
radioIndex- Radio index
output_bool- RDG enable setting value, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setRadioReverseDirectionGrantEnable()

int wifi_setRadioReverseDirectionGrantEnable ( int  radioIndex,
unsigned char  enable 
)

Set radio RDG enable setting.

Parameters
[in]radioIndexRadio index
[in]enableRDG enable setting value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Set radio RDG enable setting.

Parameters
radioIndex- Radio index
enable- RDG enable setting value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioDeclineBARequestEnable()

int wifi_getRadioDeclineBARequestEnable ( int  radioIndex,
unsigned char *  output_bool 
)

Get radio ADDBA (ADD Block Acknowledgement) enable setting.

Parameters
[in]radioIndexRadio index
[out]output_boolRadio ADDBA enable setting value, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get radio ADDBA (ADD Block Acknowledgement) enable setting.

Parameters
radioIndex- Radio index
output_bool- Radio ADDBA enable setting value, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setRadioDeclineBARequestEnable()

int wifi_setRadioDeclineBARequestEnable ( int  radioIndex,
unsigned char  enable 
)

Set radio ADDBA (ADD Block Acknowledgement) enable setting.

Parameters
[in]radioIndexRadio index
[in]enableRadio ADDBA enable setting value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Set radio ADDBA (ADD Block Acknowledgement) enable setting.

Parameters
radioIndex- Radio index
enable- Radio ADDBA enable setting value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioAutoBlockAckEnable()

int wifi_getRadioAutoBlockAckEnable ( int  radioIndex,
unsigned char *  output_bool 
)

Get radio auto block ack enable setting.

Parameters
[in]radioIndexRadio index
[out]output_boolAuto block ack enable setting value, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get radio auto block ack enable setting.

Parameters
radioIndex- Radio index
output_bool- Auto block ack enable setting value, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setRadioAutoBlockAckEnable()

int wifi_setRadioAutoBlockAckEnable ( int  radioIndex,
unsigned char  enable 
)

Set radio auto block ack enable setting.

Parameters
[in]radioIndexRadio index
[in]enableAuto block ack enable setting value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Set radio auto block ack enable setting.

Parameters
radioIndex- Radio index
enable- Auto block ack enable setting value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadio11nGreenfieldSupported()

int wifi_getRadio11nGreenfieldSupported ( int  radioIndex,
unsigned char *  output_bool 
)

Get radio 11n pure mode enable support.

Parameters
[in]radioIndexRadio index
[out]output_boolRadio 11n pure mode enable support value, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get radio 11n pure mode enable support.

Parameters
radioIndex- Radio index
output_bool- Radio 11n pure mode enable support value, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadio11nGreenfieldEnable()

int wifi_getRadio11nGreenfieldEnable ( int  radioIndex,
unsigned char *  output_bool 
)

Get radio 11n pure mode enable setting.

Parameters
[in]radioIndexRadio index
[out]output_boolRadio 11n pure mode enable setting, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get radio 11n pure mode enable setting.

Parameters
radioIndex- Radio index
output_bool- Radio 11n pure mode enable setting, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setRadio11nGreenfieldEnable()

int wifi_setRadio11nGreenfieldEnable ( int  radioIndex,
unsigned char  enable 
)

Set radio 11n pure mode enable setting.

Parameters
[in]radioIndexRadio index
[in]enableRadio 11n pure mode enable setting
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Set radio 11n pure mode enable setting.

Parameters
radioIndex- Radio index
enable- Radio 11n pure mode enable setting
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getRadioIGMPSnoopingEnable()

int wifi_getRadioIGMPSnoopingEnable ( int  radioIndex,
unsigned char *  output_bool 
)

Get radio IGMP snooping enable setting.

Parameters
[in]radioIndexRadio index
[out]output_boolRadio IGMP snooping enable setting, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get radio IGMP snooping enable setting.

Parameters
radioIndex- Radio index
output_bool- Radio IGMP snooping enable setting, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setRadioIGMPSnoopingEnable()

int wifi_setRadioIGMPSnoopingEnable ( int  radioIndex,
unsigned char  enable 
)

Set radio IGMP snooping enable setting.

Parameters
[in]radioIndexRadio index
[out]enableRadio IGMP snooping enable setting
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Set radio IGMP snooping enable setting.

Parameters
radioIndex- Radio index
enable- Radio IGMP snooping enable setting
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_createAp()

int wifi_createAp ( int  apIndex,
int  radioIndex,
char *  essid,
unsigned char  hideSsid 
)

Creates a new access point and pushes these parameters to the hardware.

Parameters
[in]apIndexAccess Point index
[in]radioIndexRadio index
[in]essidSSID Name
[in]hideSsidTrue/False, to SSID advertisement enable value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

creates a new ap and pushes these parameters to the hardware.

Parameters
apIndex- Access Point index
radioIndex- Radio index
essid- SSID Name
hideSsid- True/False, to SSID advertisement enable value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_deleteAp()

int wifi_deleteAp ( int  apIndex)

Deletes this access point entry on the hardware, clears all internal variables associated with this access point.

Parameters
[in]apIndexAccess Point index
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Deletes this ap entry on the hardware, clears all internal variables associaated with this ap.

Parameters
apIndex- Access Point index
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApName()

int wifi_getApName ( int  apIndex,
char *  output_string 
)

Outputs a 16 byte or less name associated with the Access Point. String buffer must be pre-allocated by the caller.

Parameters
[in]apIndexAccess Point index
[out]output_stringAccess Point name, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Outputs a 16 byte or less name assocated with the AP.
String buffer must be pre-allocated by the caller.

Parameters
apIndex- Access Point index
output_string- Access Point name, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApIndexFromName()

int wifi_getApIndexFromName ( char *  inputSsidString,
int *  ouput_int 
)

Outputs the index number in that corresponds to the SSID string.

Parameters
[in]inputSsidStringWiFi SSID Name
[out]ouput_intAccess Point index, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Outputs the index number in that corresponds to the SSID string.

Parameters
inputSsidString- WiFi SSID Name
ouput_int- Access Point index, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApBeaconType()

int wifi_getApBeaconType ( int  apIndex,
char *  output_string 
)

Outputs a 32 byte or less string indicating the beacon type as "None", "Basic", "WPA", "11i", "WPAand11i".

Parameters
[in]apIndexAccess Point index
[out]output_stringBeacon type, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Outputs a 32 byte or less string indicating the beacon type as "None", "Basic", "WPA", "11i", "WPAand11i".

Parameters
apIndex- Access Point index
output_string- Beacon type, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setApBeaconType()

int wifi_setApBeaconType ( int  apIndex,
char *  beaconTypeString 
)

Sets the beacon type environment variable. Allowed input strings are "None", "Basic", "WPA, "11i", "WPAand11i".

Parameters
[in]apIndexAccess Point index
[in]beaconTypeStringBeacon type
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Sets the beacon type enviornment variable. Allowed input strings are "None", "Basic", "WPA, "11i", "WPAand11i".

Parameters
apIndex- Access Point index
beaconTypeString- Beacon type
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setApBeaconInterval()

int wifi_setApBeaconInterval ( int  apIndex,
int  beaconInterval 
)

Sets the beacon interval on the hardware for this Access Point.

Parameters
[in]apIndexAccess Point index
[in]beaconIntervalBeacon interval
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Sets the beacon interval on the hardware for this AP.

Parameters
apIndex- Access Point index
beaconInterval- Beacon interval
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setApDTIMInterval()

int wifi_setApDTIMInterval ( int  apIndex,
int  dtimInterval 
)

Sets the DTIM interval for this Access Point.

DTIM (Delivery Traffic Indication Message)

Parameters
[in]apIndexAccess Point index
[in]dtimIntervalDTIM interval
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Sets the DTIM interval for this AP.

Parameters
apIndex- Access Point index
dtimInterval- DTIM interval
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApRtsThresholdSupported()

int wifi_getApRtsThresholdSupported ( int  apIndex,
unsigned char *  output_bool 
)

Get the packet size threshold supported.

Parameters
[in]apIndexAccess Point index
[out]output_boolPacket size threshold supported, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get the packet size threshold supported.

Parameters
apIndex- Access Point index
output_bool- Packet size threshold supported, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setApRtsThreshold()

int wifi_setApRtsThreshold ( int  apIndex,
unsigned int  threshold 
)

Sets the packet size threshold in bytes to apply RTS/CTS backoff rules.

Parameters
[in]apIndexAccess Point index
[in]thresholdPacket size threshold
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Sets the packet size threshold in bytes to apply RTS/CTS backoff rules.

Parameters
apIndex- Access Point index
threshold- Packet size threshold
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApWpaEncryptionMode()

int wifi_getApWpaEncryptionMode ( int  apIndex,
char *  output_string 
)

Ouputs up to a 32 byte string as either "TKIPEncryption", "AESEncryption", or "TKIPandAESEncryption".

Parameters
[in]apIndexAccess Point index
[out]output_stringWPA Encryption mode, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setApWpaEncryptionMode()

int wifi_setApWpaEncryptionMode ( int  apIndex,
char *  encMode 
)

Sets the encyption mode environment variable.

Valid string format are:

  • TKIPEncryption
  • AESEncryption
  • TKIPandAESEncryption
Parameters
[in]apIndexAccess Point index
[in]encModeWPA Encryption mode
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Sets the encyption mode enviornment variable. Valid string format is "TKIPEncryption", "AESEncryption", or "TKIPandAESEncryption".

Parameters
apIndex- Access Point index
encMode- WPA Encryption mode
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_removeApSecVaribles()

int wifi_removeApSecVaribles ( int  apIndex)

Deletes internal security variable settings for this access point.

Parameters
[in]apIndexAccess Point index
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Deletes internal security varable settings for this ap.

Parameters
apIndex- Access Point index
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_disableApEncryption()

int wifi_disableApEncryption ( int  apIndex)

Changes the hardware settings to disable encryption on this access point.

Parameters
[in]apIndexAccess Point index
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

changes the hardware settings to disable encryption on this ap.

Parameters
apIndex- Access Point index
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setApAuthMode()

int wifi_setApAuthMode ( int  apIndex,
int  mode 
)

Set the authorization mode on this access point.

Mode mapping as: -1 open -2 shared -4 auto

Parameters
[in]apIndexAccess Point index
[in]modeAuthorization mode
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Set the authorization mode on this ap. mode mapping as: 1: open, 2: shared, 4:auto.

Parameters
apIndex- Access Point index
mode- Authorization mode
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setApBasicAuthenticationMode()

int wifi_setApBasicAuthenticationMode ( int  apIndex,
char *  authMode 
)

Sets an environment variable for the authMode.

Valid strings are "None", "EAPAuthentication" or "SharedAuthentication".

Parameters
[in]apIndexAccess Point index
[in]authModeAuthentication mode
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Sets an enviornment variable for the authMode. Valid strings are "None", "EAPAuthentication" or "SharedAuthentication".

Parameters
apIndex- Access Point index
authMode- Authentication mode
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApNumDevicesAssociated()

int wifi_getApNumDevicesAssociated ( int  apIndex,
unsigned long *  output_ulong 
)

Outputs the number of stations associated per Access Point.

Parameters
[in]apIndexAccess Point index
[out]output_ulongNumber of stations, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Outputs the number of stations associated per AP.

Parameters
apIndex- Access Point index
output_ulong- Number of stations, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_kickApAssociatedDevice()

int wifi_kickApAssociatedDevice ( int  apIndex,
char *  client_mac 
)

Manually removes any active wi-fi association with the device specified on this access point.

Parameters
[in]apIndexAccess Point index
[in]client_macClient device MAC address
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Manually removes any active wi-fi association with the device specified on this ap.

Parameters
apIndex- Access Point index
client_mac- Client device MAC address
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApRadioIndex()

int wifi_getApRadioIndex ( int  apIndex,
int *  output_int 
)

Outputs the radio index for the specified access point.

Parameters
[in]apIndexAccess Point index
[out]output_intRadio index, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Outputs the radio index for the specified ap.

Parameters
apIndex- Access Point index
output_int- Radio index, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setApRadioIndex()

int wifi_setApRadioIndex ( int  apIndex,
int  radioIndex 
)

Sets the radio index for the specific access point.

Parameters
[in]apIndexAccess Point index
[in]radioIndexRadio index
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Sets the radio index for the specific ap.

Parameters
apIndex- Access Point index
radioIndex- Radio index
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApAclDevices()

int wifi_getApAclDevices ( int  apIndex,
char *  macArray,
unsigned int  buf_size 
)

Get the ACL MAC list per Access Point.

Parameters
[in]apIndexAccess Point index
[out]macArrayMac Array list, to be returned // in formate as "11:22:33:44:55:66\n11:22:33:44:55:67\n"
[out]buf_sizeBuffer size for the mac array list
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get the ACL MAC list per AP.

Parameters
apIndex- Access Point index
macArray- Mac Array list, to be returned
buf_size- Buffer size for the mac array list
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_addApAclDevice()

int wifi_addApAclDevice ( int  apIndex,
char *  DeviceMacAddress 
)

Adds the mac address to the filter list.

Parameters
[in]apIndexAccess Point index
[in]DeviceMacAddressMac Address of a device
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Adds the mac address to the filter list.

Parameters
apIndex- Access Point index
DeviceMacAddress- Mac Address of a device
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_delApAclDevice()

int wifi_delApAclDevice ( int  apIndex,
char *  DeviceMacAddress 
)

Deletes the Device MAC address from the Access control filter list.

Parameters
[in]apIndexAccess Point index
[in]DeviceMacAddressMac Address of a device
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Deletes the mac address from the filter list.

Parameters
apIndex- Access Point index
DeviceMacAddress- Mac Address of a device
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_delApAclDevices()

int wifi_delApAclDevices ( int  apINdex)

Deletes all Device MAC address from the Access control filter list.

Parameters
[in]apIndexAccess Point index
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None

◆ wifi_getApAclDeviceNum()

int wifi_getApAclDeviceNum ( int  apIndex,
unsigned int *  output_uint 
)

Outputs the number of devices in the filter list.

Parameters
[in]apIndexAccess Point index
[out]output_uintNumber of devices, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Outputs the number of devices in the filter list.

Parameters
apIndex- Access Point index
output_uint- Number of devices, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_kickApAclAssociatedDevices()

int wifi_kickApAclAssociatedDevices ( int  apIndex,
unsigned char  enable 
)

Enable kick for devices on acl black list.

Parameters
[in]apIndexAccess Point index
[in]enableEnable/disable kick for devices on acl black list
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Enable kick for devices on acl black list.

Parameters
apIndex- Access Point index
enable- Enable/disable kick for devices on acl black list
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setApMacAddressControlMode()

int wifi_setApMacAddressControlMode ( int  apIndex,
int  filterMode 
)

Sets the mac address filter control mode.

  • 0 : filter as disabled
  • 1 : filter as whitelist
  • 2 : filter as blacklist.
Parameters
[in]apIndexAccess Point index
[in]filterModeMac Address filter control mode
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Sets the mac address filter control mode. 0 == filter disabled, 1 == filter as whitelist, 2 == filter as blacklist.

Parameters
apIndex- Access Point index
filterMode- Mac Address filter control mode
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApMacAddressControlMode()

int wifi_getApMacAddressControlMode ( int  apIndex,
int *  output_filterMode 
)

This function is to read the ACL mode.

Parameters
[in]apIndexAccess Point index
[out]output_filterModeMac Address control mode
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setApVlanEnable()

int wifi_setApVlanEnable ( int  apIndex,
unsigned char  VlanEnabled 
)

Enables internal gateway VLAN mode.

In this mode a Vlan tag is added to upstream (received) data packets before exiting the Wifi driver. VLAN tags in downstream data are stripped from data packets before transmission. Default is FALSE.

Parameters
[in]apIndexAccess Point index
[in]VlanEnabledInternal gateway VLAN mode
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Enables internal gateway VLAN mode. In this mode a Vlan tag is added to upstream (received) data packets before exiting the Wifi driver. VLAN tags in downstream data are stripped from data packets before transmission. Default is FALSE.

Parameters
apIndex- Access Point index
VlanEnabled- Internal gateway VLAN mode
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setApVlanID()

int wifi_setApVlanID ( int  apIndex,
int  vlanId 
)

Sets the vlan ID for this access point to an internal environment variable.

Parameters
[in]apIndexAccess Point index
[in]vlanIdVLAN ID
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Sets the vlan ID for this ap to an internal enviornment variable.

Parameters
apIndex- Access Point index
vlanId- VLAN ID
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApBridgeInfo()

int wifi_getApBridgeInfo ( int  index,
char *  bridgeName,
char *  IP,
char *  subnet 
)

Gets bridgeName, IP address and Subnet.

BridgeName is a maximum of 32 characters.

Parameters
[in]indexAccess Point index
[out]bridgeNameBridge name, to be returned
[out]IPIP Address, to be returned
[out]subnetSubnet, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Gets bridgeName, IP address and Subnet.BridgeName is a maximum of 32 characters.

Parameters
index- Access Point index
bridgeName- Bridge name, to be returned
IP- IP Address, to be returned
subnet- Subnet, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setApBridgeInfo()

int wifi_setApBridgeInfo ( int  apIndex,
char *  bridgeName,
char *  IP,
char *  subnet 
)

Sets bridgeName, IP address and Subnet to internal environment variables.

BridgeName is a maximum of 32 characters.

Parameters
[in]apIndexAccess Point index
[in]bridgeNameBridge name
[in]IPIP Address
[in]subnetSubnet
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Sets bridgeName, IP address and Subnet to internal enviornment variables. BridgeName is a maximum of 32 characters.

Parameters
apIndex- Access Point index
bridgeName- Bridge name
IP- IP Address
subnet- Subnet
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_resetApVlanCfg()

int wifi_resetApVlanCfg ( int  apIndex)

Reset the vlan configuration for this access point.

Parameters
[in]apIndexAccess Point index
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Reset the vlan configuration for this ap.

Parameters
apIndex- Access Point index
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_createHostApdConfig()

int wifi_createHostApdConfig ( int  apIndex,
unsigned char  createWpsCfg 
)

Creates configuration variables needed for WPA/WPS.

These variables are implementation dependent and in some implementations these variables are used by hostapd when it is started. Specific variables that are needed are dependent on the hostapd implementation. These variables are set by WPA/WPS security functions in this wifi HAL. If not needed for a particular implementation this function may simply return no error.

Parameters
[in]apIndexAccess Point index
[in]createWpsCfgEnable/Disable WPS Configuration creation
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Creates configuration variables needed for WPA/WPS. These variables are implementation dependent and in some implementations these variables are used by hostapd when it is started. Specific variables that are needed are dependent on the hostapd implementation. These variables are set by WPA/WPS security functions in this wifi HAL. If not needed for a particular implementation this function may simply return no error.

Parameters
apIndex- Access Point index
createWpsCfg- Enable/Disable WPS Configuration creation
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_startHostApd()

int wifi_startHostApd ( )

Starts hostapd.

Uses the variables in the hostapd config with format compatible with the specific hostapd implementation.

Parameters
None
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Starts hostapd, uses the variables in the hostapd config with format compatible with the specific hostapd implementation.

Parameters
None
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_stopHostApd()

int wifi_stopHostApd ( )

Stops hostapd.

Parameters
None
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Stops hostapd

Parameters
None
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setApEnable()

int wifi_setApEnable ( int  apIndex,
unsigned char  enable 
)

Sets the Access Point enable status variable for the specified access point.

Parameters
[in]apIndexAccess Point index
[in]enableEnable/Disable AP enable status variable
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Sets the AP enable status variable for the specified ap.

Parameters
apIndex- Access Point index
enable- Enable/Disable AP enable status variable
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_pushApEnable()

int wifi_pushApEnable ( int  apIndex,
unsigned char  Enable 
)

Dynamically enable/disable access point.

Parameters
[in]apIndexAccess Point index
[in]enableEnable/Disable AP enable status variable
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApEnable()

int wifi_getApEnable ( int  apIndex,
unsigned char *  output_bool 
)

Outputs the setting of the internal variable that is set by wifi_setEnable().

Parameters
[in]apIndexAccess Point index
[out]output_boolAP enable status, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Outputs the setting of the internal variable that is set by wifi_setEnable().

Parameters
apIndex- Access Point index
output_bool- AP enable status, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApStatus()

int wifi_getApStatus ( int  apIndex,
char *  output_string 
)

Outputs the AP "Enabled" "Disabled" status from driver.

Device.WiFi.AccessPoint.{i}.Status

Parameters
[in]apIndexAccess Point index
[out]output_stringAP status, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Outputs the AP "Enabled" "Disabled" status from driver.
Device.WiFi.AccessPoint.{i}.Status

Parameters
apIndex- Access Point index
output_string- AP status, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApSsidAdvertisementEnable()

int wifi_getApSsidAdvertisementEnable ( int  apIndex,
unsigned char *  output_bool 
)

Indicates whether or not beacons include the SSID name.

Outputs 1 if SSID on the AP is enabled, else ouputs 0. Device.WiFi.AccessPoint.{i}.SSIDAdvertisementEnabled

Parameters
[in]apIndexAccess Point index
[out]output_boolSSID Advertisement enabled, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Indicates whether or not beacons include the SSID name. Outputs 1 if SSID on the AP is enabled, else ouputs 0.
Device.WiFi.AccessPoint.{i}.SSIDAdvertisementEnabled

Parameters
apIndex- Access Point index
output_bool- SSID Advertisement enabled, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setApSsidAdvertisementEnable()

int wifi_setApSsidAdvertisementEnable ( int  apIndex,
unsigned char  enable 
)

Sets an internal variable for ssid advertisement.

Set to 1 to enable, set to 0 to disable. Device.WiFi.AccessPoint.{i}.SSIDAdvertisementEnabled

Parameters
[in]apIndexAccess Point index
[in]enableSSID Advertisement enable value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Sets an internal variable for ssid advertisement. Set to 1 to enable, set to 0 to disable.
Device.WiFi.AccessPoint.{i}.SSIDAdvertisementEnabled

Parameters
apIndex- Access Point index
enable- SSID Advertisement enable value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_pushApSsidAdvertisementEnable()

int wifi_pushApSsidAdvertisementEnable ( int  apIndex,
unsigned char  enable 
)

Push the ssid advertisement enable variable to the hardware.

Applying changs with wifi_applyRadioSettings().

Parameters
[in]apIndexAccess Point index
[in]enableSSID Advertisement enable value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Push the ssid advertisement enable variable to the hardware //Applying changs with wifi_applyRadioSettings().

Parameters
apIndex- Access Point index
enable- SSID Advertisement enable value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApRetryLimit()

int wifi_getApRetryLimit ( int  apIndex,
unsigned int *  output 
)

Get the maximum number of retransmission for a packet.

This corresponds to IEEE 802.11 parameter dot11ShortRetryLimit. Device.WiFi.AccessPoint.{i}.RetryLimit

Parameters
[in]apIndexAccess Point index
[out]outputMaximum number of retransmission for a packet, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get the maximum number of retransmission for a packet. This corresponds to IEEE 802.11 parameter dot11ShortRetryLimit.
Device.WiFi.AccessPoint.{i}.RetryLimit

Parameters
apIndex- Access Point index
output- Maximum number of retransmission for a packet, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setApRetryLimit()

int wifi_setApRetryLimit ( int  apIndex,
unsigned int  number 
)

Set the maximum number of retransmission for a packet.

This corresponds to IEEE 802.11 parameter dot11ShortRetryLimit. Device.WiFi.AccessPoint.{i}.RetryLimit

Parameters
[in]apIndexAccess Point index
[in]numberMaximum number of retransmission for a packet
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Set the maximum number of retransmission for a packet. This corresponds to IEEE 802.11 parameter dot11ShortRetryLimit.
Device.WiFi.AccessPoint.{i}.RetryLimit

Parameters
apIndex- Access Point index
number- Maximum number of retransmission for a packet
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApWMMCapability()

int wifi_getApWMMCapability ( int  apIndex,
unsigned char *  output 
)

Indicates whether this access point supports WiFi Multimedia (WMM) Access Categories (AC). Device.WiFi.AccessPoint.{i}.WMMCapability.

Parameters
[in]apIndexAccess Point index
[out]outputWMM capability, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Indicates whether this access point supports WiFi Multimedia (WMM) Access Categories (AC).
Device.WiFi.AccessPoint.{i}.WMMCapability

Parameters
apIndex- Access Point index
output- WMM capability, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApUAPSDCapability()

int wifi_getApUAPSDCapability ( int  apIndex,
unsigned char *  output 
)

Indicates whether this access point supports WMM Unscheduled Automatic Power Save Delivery (U-APSD).

U-APSD support implies WMM support. Device.WiFi.AccessPoint.{i}.UAPSDCapability

Parameters
[in]apIndexAccess Point index
[out]outputU-APSD capability, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Indicates whether this access point supports WMM Unscheduled Automatic Power Save Delivery (U-APSD). Note: U-APSD support implies WMM support.
Device.WiFi.AccessPoint.{i}.UAPSDCapability

Parameters
apIndex- Access Point index
output- U-APSD capability, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApWmmEnable()

int wifi_getApWmmEnable ( int  apIndex,
unsigned char *  output 
)

Indicates whether WMM support is currently enabled.

When enabled, this is indicated in beacon frames. Device.WiFi.AccessPoint.{i}.WMMEnable

Parameters
[in]apIndexAccess Point index
[out]outputWMM support enabled status, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Indicates whether WMM support is currently enabled. When enabled, this is indicated in beacon frames.
Device.WiFi.AccessPoint.{i}.WMMEnable

Parameters
apIndex- Access Point index
output- WMM support enabled status, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setApWmmEnable()

int wifi_setApWmmEnable ( int  apIndex,
unsigned char  enable 
)

Enables/disables WMM on the hardwawre for this AP. enable==1, disable == 0.

Parameters
[in]apIndexAccess Point index
[in]enableWMM support enabled status
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Enables/disables WMM on the hardwawre for this AP. enable==1, disable == 0.

Parameters
apIndex- Access Point index
enable- WMM support enabled status
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApWmmUapsdEnable()

int wifi_getApWmmUapsdEnable ( int  apIndex,
unsigned char *  output 
)

Indicates whether U-APSD support is currently enabled.

When enabled, this is indicated in beacon frames. U-APSD can only be enabled if WMM is also enabled. Device.WiFi.AccessPoint.{i}.UAPSDEnable

Parameters
[in]apIndexAccess Point index
[out]outputU-APSD support enabled status, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Indicates whether U-APSD support is currently enabled. When enabled, this is indicated in beacon frames. Note: U-APSD can only be enabled if WMM is also enabled.
Device.WiFi.AccessPoint.{i}.UAPSDEnable

Parameters
apIndex- Access Point index
output- U-APSD support enabled status, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setApWmmUapsdEnable()

int wifi_setApWmmUapsdEnable ( int  apIndex,
unsigned char  enable 
)

Enables/disables Automatic Power Save Delivery on the hardwarwe for this Access Point.

Parameters
[in]apIndexAccess Point index
[in]enableU-APSD enable/disable value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Enables/disables Automatic Power Save Delivery on the hardwarwe for this AP.

Parameters
apIndex- Access Point index
enable- U-APSD enable/disable value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setApWmmOgAckPolicy()

int wifi_setApWmmOgAckPolicy ( int  apIndex,
int  cla,
unsigned char  ackPolicy 
)

Sets the WMM ACK policy on the hardware.

AckPolicy false means do not acknowledge, true means acknowledge.

Parameters
[in]apIndexAccess Point index
[in]class
[in]ackPolicyAcknowledge policy
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Sets the WMM ACK policy on the hardware. AckPolicy false means do not acknowledge, true means acknowledge.

Parameters
apIndex- Access Point index
class
ackPolicy- Acknowledge policy
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApIsolationEnable()

int wifi_getApIsolationEnable ( int  apIndex,
unsigned char *  output 
)

Get Access Point isolation value.

A value of true means that the devices connected to the Access Point are isolated from all other devices within the home network (as is typically the case for a Wireless Hotspot). Device.WiFi.AccessPoint.{i}.IsolationEnable

Parameters
[in]apIndexAccess Point index
[out]outputAccess Point Isolation enable, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get AP isolation value.A value of true means that the devices connected to the Access Point are isolated from all other devices within the home network (as is typically the case for a Wireless Hotspot).
Device.WiFi.AccessPoint.{i}.IsolationEnable

Parameters
apIndex- Access Point index
output- AP Isolation enable, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setApIsolationEnable()

int wifi_setApIsolationEnable ( int  apIndex,
unsigned char  enable 
)

Enables or disables device isolation.

A value of true means that the devices connected to the Access Point are isolated from all other devices within the home network (as is typically the case for a Wireless Hotspot). Device.WiFi.AccessPoint.{i}.IsolationEnable

Parameters
[in]apIndexAccess Point index
[in]enableAccess Point Isolation enable value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Enables or disables device isolation. A value of true means that the devices connected to the Access Point are isolated from all other devices within the home network (as is typically the case for a Wireless Hotspot).
Device.WiFi.AccessPoint.{i}.IsolationEnable

Parameters
apIndex- Access Point index
enable- AP Isolation enable value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setApBeaconRate()

int wifi_setApBeaconRate ( int  apIndex,
char *  sBeaconRate 
)

Set Access Point Beacon TX rate.

Device.WiFi.AccessPoint.{i}.X_RDKCENTRAL-COM_BeaconRate

Parameters
[in]apIndexAccess point index will be 0, 2,4,6,8 10, 12, 14(for 2.4G) only;
[in]sBeaconRatesBeaconRate could be "1Mbps"; "5.5Mbps"; "6Mbps"; "2Mbps"; "11Mbps"; "12Mbps"; "24Mbps"
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApBeaconRate()

int wifi_getApBeaconRate ( int  apIndex,
char *  output_BeaconRate 
)

Get Access Point Beacon TX rate.

Device.WiFi.AccessPoint.{i}.X_RDKCENTRAL-COM_BeaconRate

Parameters
[in]apIndexIndex of Wi-Fi Access Point
[out]output_BeaconRateBeacon rate output
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApMaxAssociatedDevices()

int wifi_getApMaxAssociatedDevices ( int  apIndex,
unsigned int *  output 
)

Get maximum associated devices with the Access Point index.

The maximum number of devices that can simultaneously be connected to the access point. A value of 0 means that there is no specific limit. Device.WiFi.AccessPoint.{i}.MaxAssociatedDevices

Parameters
[in]apIndexAccess Point index
[out]outputMaximum associated devices, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get maximum associated devices with the Access Point index. The maximum number of devices that can simultaneously be connected to the access point. A value of 0 means that there is no specific limit.
Device.WiFi.AccessPoint.{i}.MaxAssociatedDevices

Parameters
apIndex- Access Point index
output- Maximum associated devices, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setApMaxAssociatedDevices()

int wifi_setApMaxAssociatedDevices ( int  apIndex,
unsigned int  number 
)

Set maximum associated devices with the Access Point index.

The maximum number of devices that can simultaneously be connected to the access point. A value of 0 means that there is no specific limit. Device.WiFi.AccessPoint.{i}.MaxAssociatedDevices

Parameters
[in]apIndexAccess Point index
[in]numberMaximum associated devices
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Set maximum associated devices with the Access Point index. The maximum number of devices that can simultaneously be connected to the access point. A value of 0 means that there is no specific limit.
Device.WiFi.AccessPoint.{i}.MaxAssociatedDevices

Parameters
apIndex- Access Point index
number- Maximum associated devices
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApAssociatedDevicesHighWatermarkThreshold()

int wifi_getApAssociatedDevicesHighWatermarkThreshold ( int  apIndex,
unsigned int *  output 
)

Get the HighWatermarkThreshold value, that is lesser than or equal to MaxAssociatedDevices.

Setting this parameter does not actually limit the number of clients that can associate with this access point as that is controlled by MaxAssociatedDevices. MaxAssociatedDevices or 50. The default value of this parameter should be equal to MaxAssociatedDevices. In case MaxAssociatedDevices is 0 (zero), the default value of this parameter should be 50. A value of 0 means that there is no specific limit and Watermark calculation algorithm should be turned off. Device.WiFi.AccessPoint.{i}.X_COMCAST-COM_AssociatedDevicesHighWatermarkThreshold

Parameters
[in]apIndexAccess Point index
[out]outputHighWatermarkThreshold value, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get the HighWatermarkThreshold value, that is lesser than or equal to MaxAssociatedDevices. Setting this parameter does not actually limit the number of clients that can associate with this access point as that is controlled by MaxAssociatedDevices. MaxAssociatedDevices or 50. The default value of this parameter should be equal to MaxAssociatedDevices. In case MaxAssociatedDevices is 0 (zero), the default value of this parameter should be 50. A value of 0 means that there is no specific limit and Watermark calculation algorithm should be turned off.
Device.WiFi.AccessPoint.{i}.X_COMCAST-COM_AssociatedDevicesHighWatermarkThreshold

Parameters
apIndex- Access Point index
output- HighWatermarkThreshold value, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setApAssociatedDevicesHighWatermarkThreshold()

int wifi_setApAssociatedDevicesHighWatermarkThreshold ( int  apIndex,
unsigned int  Threshold 
)

Set the HighWatermarkThreshold value, that is lesser than or equal to MaxAssociatedDevices.

Setting this parameter does not actually limit the number of clients that can associate with this access point as that is controlled by MaxAssociatedDevices. MaxAssociatedDevices or 50. The default value of this parameter should be equal to MaxAssociatedDevices. In case MaxAssociatedDevices is 0 (zero), the default value of this parameter should be 50. A value of 0 means that there is no specific limit and Watermark calculation algorithm should be turned off. Device.WiFi.AccessPoint.{i}.X_COMCAST-COM_AssociatedDevicesHighWatermarkThreshold

Parameters
[in]apIndexAccess Point index
[in]ThresholdHighWatermarkThreshold value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Set the HighWatermarkThreshold value, that is lesser than or equal to MaxAssociatedDevices. Setting this parameter does not actually limit the number of clients that can associate with this access point as that is controlled by MaxAssociatedDevices. MaxAssociatedDevices or 50. The default value of this parameter should be equal to MaxAssociatedDevices. In case MaxAssociatedDevices is 0 (zero), the default value of this parameter should be 50. A value of 0 means that there is no specific limit and Watermark calculation algorithm should be turned off.
Device.WiFi.AccessPoint.{i}.X_COMCAST-COM_AssociatedDevicesHighWatermarkThreshold

Parameters
apIndex- Access Point index
Threshold- HighWatermarkThreshold value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApAssociatedDevicesHighWatermarkThresholdReached()

int wifi_getApAssociatedDevicesHighWatermarkThresholdReached ( int  apIndex,
unsigned int *  output 
)

Get the number of times the current total number of associated device has reached the HighWatermarkThreshold value.

This calculation can be based on the parameter AssociatedDeviceNumberOfEntries as well. Implementation specifics about this parameter are left to the product group and the device vendors. It can be updated whenever there is a new client association request to the access point. Device.WiFi.AccessPoint.{i}.X_COMCAST-COM_AssociatedDevicesHighWatermarkThresholdReached

Parameters
[in]apIndexAccess Point index
[out]outputNumber of times the current total number of associated device has reached the HighWatermarkThreshold value, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get the number of times the current total number of associated device has reached the HighWatermarkThreshold value. This calculation can be based on the parameter AssociatedDeviceNumberOfEntries as well. Implementation specifics about this parameter are left to the product group and the device vendors. It can be updated whenever there is a new client association request to the access point.
Device.WiFi.AccessPoint.{i}.X_COMCAST-COM_AssociatedDevicesHighWatermarkThresholdReached

Parameters
apIndex- Access Point index
output- Number of times the current total number of associated device has reached the HighWatermarkThreshold value, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApAssociatedDevicesHighWatermark()

int wifi_getApAssociatedDevicesHighWatermark ( int  apIndex,
unsigned int *  output 
)

Maximum number of associated devices that have ever associated with the access point concurrently since the last reset of the device or WiFi module. Device.WiFi.AccessPoint.{i}.X_COMCAST-COM_AssociatedDevicesHighWatermark.

Parameters
[in]apIndexAccess Point index
[out]outputMaximum number of associated devices that have ever associated with the access point concurrently, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Maximum number of associated devices that have ever associated with the access point concurrently since the last reset of the device or WiFi module.
Device.WiFi.AccessPoint.{i}.X_COMCAST-COM_AssociatedDevicesHighWatermark

Parameters
apIndex- Access Point index
output- Maximum number of associated devices that have ever associated with the access point concurrently, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApAssociatedDevicesHighWatermarkDate()

int wifi_getApAssociatedDevicesHighWatermarkDate ( int  apIndex,
unsigned long *  output_in_seconds 
)

Get Date and Time at which the maximum number of associated devices ever associated with the access point concurrently since the last reset of the device or WiFi module.

In short when was X_COMCAST-COM_AssociatedDevicesHighWatermark updated This dateTime value is in UTC. Device.WiFi.AccessPoint.{i}.X_COMCAST-COM_AssociatedDevicesHighWatermarkDate

Parameters
[in]apIndexAccess Point index
[out]output_in_secondsDate and Time at which the maximum number of associated devices ever associated with the access point concurrenlty, to be returned.
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get Date and Time at which the maximum number of associated devices ever associated with the access point concurrenlty since the last reset of the device or WiFi module (or in short when was X_COMCAST-COM_AssociatedDevicesHighWatermark updated). This dateTime value is in UTC.
Device.WiFi.AccessPoint.{i}.X_COMCAST-COM_AssociatedDevicesHighWatermarkDate

Parameters
apIndex- Access Point index
output_in_seconds- Date and Time at which the maximum number of associated devices ever associated with the access point concurrenlty, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApSecurityModesSupported()

int wifi_getApSecurityModesSupported ( int  apIndex,
char *  output 
)

Indicates which security modes this AccessPoint instance is capable of supporting.

Each list item is an enumeration of:

  • None
  • WEP-64
  • WEP-128
  • WPA-Personal
  • WPA2-Personal
  • WPA-WPA2-Personal
  • WPA-Enterprise
  • WPA2-Enterprise
  • WPA-WPA2-Enterprise. Device.WiFi.AccessPoint.{i}.Security.ModesSupported
Parameters
[in]apIndexAccess Point index
[out]outputComma-separated list of security modes, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Indicates which security modes this AccessPoint instance is capable of supporting. Each list item is an enumeration of: None,WEP-64,WEP-128,WPA-Personal,WPA2-Personal,WPA-WPA2-Personal,WPA-Enterprise,WPA2-Enterprise,WPA-WPA2-Enterprise.
Device.WiFi.AccessPoint.{i}.Security.ModesSupported

Parameters
apIndex- Access Point index
output- Comma-separated list of security modes, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApSecurityModeEnabled()

int wifi_getApSecurityModeEnabled ( int  apIndex,
char *  output 
)

Get the Security modes supported.

The value MUST be a member of the list reported by the ModesSupported parameter. Indicates which security mode is enabled. Device.WiFi.AccessPoint.{i}.Security.ModeEnabled string W

Parameters
[in]apIndexAccess Point index
[out]outputEnabled security mode, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get the Security modes supported. The value MUST be a member of the list reported by the ModesSupported parameter. Indicates which security mode is enabled.
Device.WiFi.AccessPoint.{i}.Security.ModeEnabled string W

Parameters
apIndex- Access Point index
output- Enabled security mode, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setApSecurityModeEnabled()

int wifi_setApSecurityModeEnabled ( int  apIndex,
char *  encMode 
)

Enable supported security mode.

The value MUST be a member of the list reported by the ModesSupported parameter. Indicates which security mode is enabled. Device.WiFi.AccessPoint.{i}.Security.ModeEnabled string W

Parameters
[in]apIndexAccess Point index
[in]encModeSupported security mode
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Enable supported security mode. The value MUST be a member of the list reported by the ModesSupported parameter. Indicates which security mode is enabled.
Device.WiFi.AccessPoint.{i}.Security.ModeEnabled string W

Parameters
apIndex- Access Point index
encMode- Supported security mode
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApSecurityPreSharedKey()

int wifi_getApSecurityPreSharedKey ( int  apIndex,
char *  output_string 
)

Get PreSharedKey associated with a Access Point.

A literal PreSharedKey (PSK) expressed as a hexadecimal string. Device.WiFi.AccessPoint.{i}.Security.PreSharedKey

Parameters
[in]apIndexAccess Point index
[out]output_stringPreSharedKey, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get PreSharedKey associated with a AP. A literal PreSharedKey (PSK) expressed as a hexadecimal string.
Device.WiFi.AccessPoint.{i}.Security.PreSharedKey

Parameters
apIndex- Access Point index
output_string- PreSharedKey, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setApSecurityPreSharedKey()

int wifi_setApSecurityPreSharedKey ( int  apIndex,
char *  preSharedKey 
)

Set PreSharedKey associated with a Access Point.

A literal PreSharedKey (PSK) expressed as a hexadecimal string. Device.WiFi.AccessPoint.{i}.Security.PreSharedKey

Parameters
[in]apIndexAccess Point index
[in]preSharedKeyPreSharedKey
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Set PreSharedKey associated with a AP. A literal PreSharedKey (PSK) expressed as a hexadecimal string.
Device.WiFi.AccessPoint.{i}.Security.PreSharedKey

Parameters
apIndex- Access Point index
preSharedKey- PreSharedKey
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApSecurityKeyPassphrase()

int wifi_getApSecurityKeyPassphrase ( int  apIndex,
char *  output_string 
)

Get a passphrase from which the PreSharedKey is to be generated for WPA-Personal or WPA2-Personal or.

WPA-WPA2-Personal security modes.

Device.WiFi.AccessPoint.{i}.Security.KeyPassphrase string-(63) W

Parameters
[in]apIndexAccess Point index
[out]output_stringSecurity key passphrase, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get a passphrase from which the PreSharedKey is to be generated, for WPA-Personal or WPA2-Personal or WPA-WPA2-Personal security modes.
Device.WiFi.AccessPoint.{i}.Security.KeyPassphrase string-(63) W

Parameters
apIndex- Access Point index
output_string- Security key passphrase, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setApSecurityKeyPassphrase()

int wifi_setApSecurityKeyPassphrase ( int  apIndex,
char *  passPhrase 
)

Set a passphrase from which the PreSharedKey is to be generated, for WPA-Personal or WPA2-Personal or WPA-WPA2-Personal security modes.

Device.WiFi.AccessPoint.{i}.Security.KeyPassphrase string-(63) W

Parameters
[in]apIndexAccess Point index
[in]passPhraseSecurity key passphrase
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Set a passphrase from which the PreSharedKey is to be generated, for WPA-Personal or WPA2-Personal or WPA-WPA2-Personal security modes.
Device.WiFi.AccessPoint.{i}.Security.KeyPassphrase string-(63) W

Parameters
apIndex- Access Point index
passPhrase- Security key passphrase
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setApSecurityReset()

int wifi_setApSecurityReset ( int  apIndex)

When set to true, this AccessPoint instance's WiFi security settings are reset to their factory default values.

The affected settings include ModeEnabled, WEPKey, PreSharedKey and KeyPassphrase. Device.WiFi.AccessPoint.{i}.Security.Reset

Parameters
[in]apIndexAccess Point index
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

When set to true, this AccessPoint instance's WiFi security settings are reset to their factory default values. The affected settings include ModeEnabled, WEPKey, PreSharedKey and KeyPassphrase.
Device.WiFi.AccessPoint.{i}.Security.Reset

Parameters
apIndex- Access Point index
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApSecurityMFPConfig()

int wifi_getApSecurityMFPConfig ( int  apIndex,
char *  output_string 
)

To retrive the MFPConfig for each VAP.

The affected settings Device.WiFi.AccessPoint.{i}.Security.Reset

Parameters
[in]apIndexAccess Point index
[out]output_string.Preallocated buffer for 64bytes. Allowed output string are "Disabled", "Optional", "Required"
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setApSecurityMFPConfig()

int wifi_setApSecurityMFPConfig ( int  apIndex,
char *  MfpConfig 
)

the hal is used to set the MFP config for each VAP.

  1. mfpconfig need to be saved into wifi config in persistent way (so that it could be automatically applied after the wifi or vap restart)
  2. mfpconfig need to be applied right away.

The affected settings include Device.WiFi.AccessPoint.{i}.Security.Reset

Parameters
[in]apIndexAccess Point index
[in]MfpConfig,Theallowed string for MFPConfig are "Disabled", "Optional", "Required"
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApSecurityRadiusServer()

int wifi_getApSecurityRadiusServer ( int  apIndex,
char *  IP_output,
unsigned int *  Port_output,
char *  RadiusSecret_output 
)

Get the IP Address and port number of the RADIUS server, which are used for WLAN security.

RadiusServerIPAddr is only applicable when ModeEnabled is an Enterprise type (i.e. WPA-Enterprise, WPA2-Enterprise or WPA-WPA2-Enterprise). String is 64 bytes max. Device.WiFi.AccessPoint.{i}.Security.RadiusServerIPAddr Device.WiFi.AccessPoint.{i}.Security.RadiusServerPort Device.WiFi.AccessPoint.{i}.Security.RadiusSecret

Parameters
[in]IndexAccess Point index
[out]IP_outputIP Address, to be returned
[out]Port_outputPort output, to be returned
[out]RadiusSecret_outputRadius Secret output, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get the IP Address and port number of the RADIUS server, which are used for WLAN security. RadiusServerIPAddr is only applicable when ModeEnabled is an Enterprise type (i.e. WPA-Enterprise, WPA2-Enterprise or WPA-WPA2-Enterprise). String is 64 bytes max.
Device.WiFi.AccessPoint.{i}.Security.RadiusServerIPAddr
Device.WiFi.AccessPoint.{i}.Security.RadiusServerPort
Device.WiFi.AccessPoint.{i}.Security.RadiusSecret

Parameters
apIndex- Access Point index
IP_output- IP Address, to be returned
Port_output- Port output, to be returned
RadiusSecret_output- Radius Secret output, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setApSecurityRadiusServer()

int wifi_setApSecurityRadiusServer ( int  apIndex,
char *  IPAddress,
unsigned int  port,
char *  RadiusSecret 
)

Set the IP Address and port number of the RADIUS server, which are used for WLAN security.

RadiusServerIPAddr is only applicable when ModeEnabled is an Enterprise type (i.e. WPA-Enterprise, WPA2-Enterprise or WPA-WPA2-Enterprise). String is 64 bytes max. Device.WiFi.AccessPoint.{i}.Security.RadiusServerIPAddr Device.WiFi.AccessPoint.{i}.Security.RadiusServerPort Device.WiFi.AccessPoint.{i}.Security.RadiusSecret

Parameters
[in]apIndexAccess Point index
[in]IPAddressIP Address
[in]portPort
[in]RadiusSecretRadius Secret
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Set the IP Address and port number of the RADIUS server, which are used for WLAN security. RadiusServerIPAddr is only applicable when ModeEnabled is an Enterprise type (i.e. WPA-Enterprise, WPA2-Enterprise or WPA-WPA2-Enterprise). String is 64 bytes max.
Device.WiFi.AccessPoint.{i}.Security.RadiusServerIPAddr
Device.WiFi.AccessPoint.{i}.Security.RadiusServerPort
Device.WiFi.AccessPoint.{i}.Security.RadiusSecret

Parameters
apIndex- Access Point index
IPAddress- IP Address
port- Port
RadiusSecret- Radius Secret
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApSecuritySecondaryRadiusServer()

int wifi_getApSecuritySecondaryRadiusServer ( int  apIndex,
char *  IP_output,
unsigned int *  Port_output,
char *  RadiusSecret_output 
)

Get secondary IP Address, port number and RADIUS server.

Used for WLAN security. RadiusServerIPAddr is only applicable when ModeEnabled is an Enterprise type (i.e. WPA-Enterprise, WPA2-Enterprise or WPA-WPA2-Enterprise). String is 64 bytes max.

Parameters
[in]apIndexAccess Point index
[out]IP_outputIP Address, to be returned
[out]Port_outputPort,to be returned
[out]RadiusSecret_outputRadius Secret, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get secondary IP Address, port number and RADIUS server, which are used for WLAN security. RadiusServerIPAddr is only applicable when ModeEnabled is an Enterprise type (i.e. WPA-Enterprise, WPA2-Enterprise or WPA-WPA2-Enterprise). String is 64 bytes max.

Parameters
apIndex- Access Point index
IP_output- IP Address, to be returned
Port_output- Port,to be returned
RadiusSecret_output- Radius Secret, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setApSecuritySecondaryRadiusServer()

int wifi_setApSecuritySecondaryRadiusServer ( int  apIndex,
char *  IPAddress,
unsigned int  port,
char *  RadiusSecret 
)

Set secondary IP Address, port number and RADIUS server, which are used for WLAN security.

RadiusServerIPAddr is only applicable when ModeEnabled is an Enterprise type (i.e. WPA-Enterprise, WPA2-Enterprise or WPA-WPA2-Enterprise). String is 64 bytes max.

Parameters
[in]apIndexAccess Point index
[in]IPAddressIP Address
[in]portPort
[in]RadiusSecretRadius Secret
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Set secondary IP Address, port number and RADIUS server, which are used for WLAN security. RadiusServerIPAddr is only applicable when ModeEnabled is an Enterprise type (i.e. WPA-Enterprise, WPA2-Enterprise or WPA-WPA2-Enterprise). String is 64 bytes max.

Parameters
apIndex- Access Point index
IPAddress- IP Address
port- Port
RadiusSecret- Radius Secret
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApSecurityRadiusSettings()

int wifi_getApSecurityRadiusSettings ( int  apIndex,
wifi_radius_setting_t output 
)

Get Access Point security radius settings.

Device.WiFi.AccessPoint.{i}.Security.X_COMCAST-COM_RadiusSettings.

Parameters
[in]apIndexAccess Point index
[out]outputwifi_radius_setting_t info (*output), to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get Access Point security radius settings.
Device.WiFi.AccessPoint.{i}.Security.X_COMCAST-COM_RadiusSettings.

Parameters
apIndex- Access Point index
output- wifi_radius_setting_t info (*output), to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setApSecurityRadiusSettings()

int wifi_setApSecurityRadiusSettings ( int  apIndex,
wifi_radius_setting_t input 
)

Set Access Point security radius settings.

Device.WiFi.AccessPoint.{i}.Security.X_COMCAST-COM_RadiusSettings.

Parameters
[in]apIndexAccess Point index
[in]inputwifi_radius_setting_t info
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Set Access Point security radius settings.
Device.WiFi.AccessPoint.{i}.Security.X_COMCAST-COM_RadiusSettings.

Parameters
apIndex- Access Point index
input- wifi_radius_setting_t info
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApWpsEnable()

int wifi_getApWpsEnable ( int  apIndex,
unsigned char *  output_bool 
)

Outputs the WPS enable state of this access point in output_bool.

Device.WiFi.AccessPoint.{i}.WPS. Device.WiFi.AccessPoint.{i}.WPS.Enable

Parameters
[in]apIndexAccess Point index
[out]output_boolWPS enable state, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Outputs the WPS enable state of this ap in output_bool.
Device.WiFi.AccessPoint.{i}.WPS.
Device.WiFi.AccessPoint.{i}.WPS.Enable

Parameters
apIndex- Access Point index
output_bool- WPS enable state, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setApWpsEnable()

int wifi_setApWpsEnable ( int  apIndex,
unsigned char  enableValue 
)

Enables or disables WPS functionality for this access point.

Sets the WPS enable environment variable for this ap to the value of enableValue, 1==enabled, 0==disabled. Device.WiFi.AccessPoint.{i}.WPS. Device.WiFi.AccessPoint.{i}.WPS.Enable

Parameters
[in]apIndexAccess Point index
[in]enableValueWPS enable state
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Enables or disables WPS functionality for this access point. Sets the WPS enable enviornment variable for this ap to the value of enableValue, 1==enabled, 0==disabled.
Device.WiFi.AccessPoint.{i}.WPS.
Device.WiFi.AccessPoint.{i}.WPS.Enable

Parameters
apIndex- Access Point index
enableValue- WPS enable state
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApWpsConfigMethodsSupported()

int wifi_getApWpsConfigMethodsSupported ( int  apIndex,
char *  output 
)

Indicates WPS configuration methods supported by the device.

Device.WiFi.AccessPoint.{i}.WPS.ConfigMethodsSupported
Each list item is an enumeration of: USBFlashDrive,Ethernet,ExternalNFCToken,IntegratedNFCToken,NFCInterface,PushButton,PIN.

Parameters
[in]apIndexAccess Point index
[out]outputWPS configuration methods supported (Comma-separated list of strings), to be returned.
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Indicates WPS configuration methods supported by the device. Each list item is an enumeration of: USBFlashDrive,Ethernet,ExternalNFCToken,IntegratedNFCToken,NFCInterface,PushButton,PIN. Sets the WPS enable enviornment variable for this ap to the value of enableValue, 1==enabled, 0==disabled.
Device.WiFi.AccessPoint.{i}.WPS.ConfigMethodsSupported

Parameters
apIndex- Access Point index
output- WPS configuration methods supported (Comma-separated list of strings), to be returned.
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApWpsConfigMethodsEnabled()

int wifi_getApWpsConfigMethodsEnabled ( int  apIndex,
char *  output_string 
)

Indicates WPS configuration methods enabled on the device.

Each list item MUST be a member of the list reported by the ConfigMethodsSupported parameter. Device.WiFi.AccessPoint.{i}.WPS.ConfigMethodsEnabled string W

Parameters
[in]apIndexAccess Point index
[out]output_stringWPS configuration methods enabled, to be returned.
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Indicates WPS configuration methods enabled on the device. Each list item MUST be a member of the list reported by the ConfigMethodsSupported parameter.
Device.WiFi.AccessPoint.{i}.WPS.ConfigMethodsEnabled string W

Parameters
apIndex- Access Point index
output_string- WPS configuration methods enabled, to be returned.
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setApWpsConfigMethodsEnabled()

int wifi_setApWpsConfigMethodsEnabled ( int  apIndex,
char *  methodString 
)

Enable WPS configuration methods on the device.

Each list item MUST be a member of the list reported by the ConfigMethodsSupported parameter. Device.WiFi.AccessPoint.{i}.WPS.ConfigMethodsEnabled string W Sets an environment variable that specifies the WPS configuration method(s). methodString is a comma separated list of methods:

  • USBFlashDrive
  • Ethernet
  • ExternalNFCToken
  • IntegratedNFCToken
  • NFCInterface
  • PushButton
  • PIN
Parameters
[in]apIndexAccess Point index
[in]methodStringWPS configuration methods enabled.
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Enable WPS configuration methods on the device. Each list item MUST be a member of the list reported by the ConfigMethodsSupported parameter.
Device.WiFi.AccessPoint.{i}.WPS.ConfigMethodsEnabled string W

Parameters
apIndex- Access Point index
methodString- WPS configuration methods enabled.
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApWpsDevicePIN()

int wifi_getApWpsDevicePIN ( int  apIndex,
unsigned long *  output_ulong 
)

Outputs the WPS device pin value, ulong_pin must be allocated by the caller.

Parameters
[in]apIndexAccess Point index
[in]output_ulongWPS Device PIN value, to be returned.
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Outputs the WPS device pin value, ulong_pin must be allocated by the caller.

Parameters
apIndex- Access Point index
output_ulong- WPS Device PIN value, to be returned.
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setApWpsDevicePIN()

int wifi_setApWpsDevicePIN ( int  apIndex,
unsigned long  pin 
)

Set an environment variable for the WPS pin for the selected Access Point.

Parameters
[in]apIndexAccess Point index
[in]pinWPS Device PIN value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Set an enviornment variable for the WPS pin for the selected AP.

Parameters
apIndex- Access Point index
pin- WPS Device PIN value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApWpsConfigurationState()

int wifi_getApWpsConfigurationState ( int  apIndex,
char *  output_string 
)

Get WPS configuration state.

Output string is either Not configured or Configured, max 32 characters.

Parameters
[in]apIndexAccess Point index
[in]output_stringWPS configuration state, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Get WPS configuration state. Output string is either Not configured or Configured, max 32 characters.

Parameters
apIndex- Access Point index
output_string- WPS configuration state, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setApWpsEnrolleePin()

int wifi_setApWpsEnrolleePin ( int  apIndex,
char *  pin 
)

Sets the WPS pin for this Access Point.

Parameters
[in]apIndexAccess Point index
[in]pinWPS enroll Pin
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Sets the WPS pin for this AP.

Parameters
apIndex- Access Point index
pin- WPS enroll Pin
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setApWpsButtonPush()

int wifi_setApWpsButtonPush ( int  apIndex)

This function is called when the WPS push button has been pressed for this AP.

Parameters
[in]apIndexAccess Point index
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

This function is called when the WPS push button has been pressed for this AP.

Parameters
apIndex- Access Point index
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_cancelApWPS()

int wifi_cancelApWPS ( int  apIndex)

Cancels WPS mode for this Access Point.

Parameters
[in]apIndexAccess Point index
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Cancels WPS mode for this AP.

Parameters
apIndex- Access Point index
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApManagementFramePowerControl()

int wifi_getApManagementFramePowerControl ( int  apIndex,
int *  output_dBm 
)

Get the ApManagementFramePowerControl.

Parameters
[in]apIndexAccess Point index
[out]output_dBmManagementFramePowerControl, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setApManagementFramePowerControl()

int wifi_setApManagementFramePowerControl ( int  apIndex,
int  dBm 
)

Sets the ApManagementFramePowerControl.

Parameters
[in]apIndexAccess Point index
[in]dBmRadioManagementFramePowerControl
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApAssociatedDeviceDiagnosticResult()

int wifi_getApAssociatedDeviceDiagnosticResult ( int  apIndex,
wifi_associated_dev_t **  associated_dev_array,
unsigned int *  output_array_size 
)

The function provides a list of the devices currently associated with the access point.

HAL funciton should allocate an data structure array, and return to caller with "associated_dev_array". Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}.

Parameters
[in]apIndexAccess Point index
[in]associated_dev_arrayAssociated device array, to be returned
[in]output_array_sizeArray size, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

HAL funciton should allocate an data structure array, and return to caller with "associated_dev_array".
Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}.

Parameters
apIndex- Access Point index
associated_dev_array- Associated device array, to be returned
output_array_size- Array size, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApAssociatedDeviceDiagnosticResult2()

int wifi_getApAssociatedDeviceDiagnosticResult2 ( int  apIndex,
wifi_associated_dev2_t **  associated_dev_array,
unsigned int *  output_array_size 
)

The function provides a list of the devices currently associated with the access point.

HAL funciton should allocate an data structure array, and return to caller with "associated_dev_array". Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}.

Parameters
[in]apIndexAccess Point index
[in]associated_dev_arrayAssociated device array, to be returned
[in]output_array_sizeArray size, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_getApAssociatedDeviceDiagnosticResult3()

int wifi_getApAssociatedDeviceDiagnosticResult3 ( int  apIndex,
wifi_associated_dev3_t **  associated_dev_array,
unsigned int *  output_array_size 
)

◆ wifi_getApAssociatedClientDiagnosticResult()

int wifi_getApAssociatedClientDiagnosticResult ( int  apIndex,
char *  mac_addr,
wifi_associated_dev3_t dev_conn 
)

◆ wifi_setClientDetailedStatisticsEnable()

int wifi_setClientDetailedStatisticsEnable ( int  radioIndex,
unsigned char  enable 
)

This function enabled/disabled collection of detailed statistics of associated clients on Access Point.

Parameters
[in]radioIndexRadio Index
[in]enableenable/disable
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_newApAssociatedDevice_callback_register()

void wifi_newApAssociatedDevice_callback_register ( wifi_newApAssociatedDevice_callback  callback_proc)

Callback registration function.

Parameters
[in]callback_procwifi_newApAssociatedDevice_callback callback function
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Callback registration function.

Parameters
callback_proc- wifi_newApAssociatedDevice_callback callback function
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_apDisassociatedDevice_callback_register()

void wifi_apDisassociatedDevice_callback_register ( wifi_apDisassociatedDevice_callback  callback_proc)

Callback registration function.

Parameters
[in]callback_procwifi_apDisassociatedDevice_callback callback function
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_apDeAuthEvent_callback_register()

void wifi_apDeAuthEvent_callback_register ( wifi_apDeAuthEvent_callback  callback_proc)

Callback registration function.

Parameters
[in]callback_procwifi_apDeAuthEvent_callback callback function
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None

◆ wifi_getRadioStatsEnable()

int wifi_getRadioStatsEnable ( int  radioIndex,
unsigned char *  output_enable 
)

This API returns the radio enabled status.

The radio status switch in driver include Transmission status, background channel scan, capacity status etc Radio Status should be disabled by default. If driver do not support those switch, or switch has enabled by default, please just fillup with stumb function.

Parameters
[in]radioIndexIndex of the radio array.
[out]output_enableRadio enabled status.
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setRadioStatsEnable()

int wifi_setRadioStatsEnable ( int  radioIndex,
unsigned char  enable 
)

This API is to enable/disable radio status.

Parameters
[in]radioIndexIndex of the radio array.
[out]output_enableRadio enabled status.
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Execution: Synchronous
Side Effects: None
Note
This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

◆ wifi_setApCsaDeauth()

int wifi_setApCsaDeauth ( int  apIndex,
int