 |
RDK-B
|
|
RDK-B
|
Data Structures | |
| struct | _wifi_GASConfiguration_t |
Macros | |
| #define | GAS_CFG_TYPE_SUPPORTED 1 |
Typedefs | |
| typedef INT(* | wifi_vapstatus_callback) (INT apIndex, wifi_vapstatus_t status) |
| This call back will be invoked when VAP status changes. More... | |
| typedef INT(* | wifi_analytics_callback) (CHAR *fmt,...) |
| This call back will be invoked when HAL wants to log catasrophic failures. More... | |
| 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) |
| typedef INT(* | wifi_scanResults_callback) (wifi_radio_index_t index, wifi_bss_info_t **bss, UINT *num_bss) |
| typedef INT(* | wifi_staConnectionStatus_callback) (INT apIndex, wifi_bss_info_t *bss_dev, wifi_station_stats_t *sta) |
Enumerations | |
| enum | wifi_vapstatus_t { wifi_vapstatus_down, wifi_vapstatus_up } |
| VAP status possible values. More... | |
Functions | |
| INT | wifi_getWifiTrafficStats (INT apIndex, wifi_trafficStats_t *output_struct) |
| Outputs more detailed traffic stats per AP. 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_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_setApRtsThreshold (INT apIndex, UINT threshold) |
| Sets the packet size threshold in bytes to apply RTS/CTS backoff rules. 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_getApNumDevicesAssociated (INT apIndex, ULONG *output_ulong) |
| Outputs the number of stations associated per Access Point. More... | |
| INT | wifi_getApRadioIndex (INT apIndex, INT *output_int) |
| Outputs the radio index for the specified access point. More... | |
| INT | wifi_delApAclDevices (INT apINdex) |
| Get the ACL MAC list per Access Point. More... | |
| INT | wifi_getApAclDeviceNum (INT apIndex, UINT *output_uint) |
| Outputs the number of devices in the filter list. More... | |
| INT | wifi_kickApAclAssociatedDevices (INT apIndex, BOOL 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_setApVlanID (INT apIndex, INT vlanId) |
| Sets the vlan ID for this access point to an internal environment variable. More... | |
| INT | wifi_resetApVlanCfg (INT apIndex) |
| Reset the vlan configuration for this access point. More... | |
| INT | wifi_setApEnable (INT apIndex, BOOL enable) |
| Sets the Access Point enable status variable for the specified access point. More... | |
| INT | wifi_getApEnable (INT apIndex, BOOL *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, BOOL *output_bool) |
| Indicates whether or not beacons include the SSID name. More... | |
| INT | wifi_setApSsidAdvertisementEnable (INT apIndex, BOOL enable) |
| Sets an internal variable for ssid advertisement. More... | |
| INT | wifi_getApRetryLimit (INT apIndex, UINT *output) |
| Get the maximum number of retransmission for a packet. More... | |
| INT | wifi_setApRetryLimit (INT apIndex, UINT number) |
| Set the maximum number of retransmission for a packet. More... | |
| INT | wifi_getApWmmEnable (INT apIndex, BOOL *output) |
| Indicates whether WMM support is currently enabled. More... | |
| INT | wifi_setApWmmEnable (INT apIndex, BOOL enable) |
| Enables/disables WMM on the hardwawre for this AP. enable==1, disable == 0. More... | |
| INT | wifi_getApWmmUapsdEnable (INT apIndex, BOOL *output) |
| Indicates whether U-APSD support is currently enabled. More... | |
| INT | wifi_setApWmmUapsdEnable (INT apIndex, BOOL enable) |
| Enables/disables Automatic Power Save Delivery on the hardwarwe for this Access Point. More... | |
| INT | wifi_setApWmmOgAckPolicy (INT apIndex, INT cla, BOOL ackPolicy) |
| Sets the WMM ACK policy on the hardware. More... | |
| INT | wifi_getApIsolationEnable (INT apIndex, BOOL *output) |
| Get Access Point isolation value. More... | |
| INT | wifi_setApIsolationEnable (INT apIndex, BOOL 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, UINT *output) |
| Get maximum associated devices with the Access Point index. More... | |
| INT | wifi_setApMaxAssociatedDevices (INT apIndex, UINT number) |
| Set maximum associated devices with the Access Point index. 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, UINT *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, UINT 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, UINT *Port_output, CHAR *RadiusSecret_output) |
| Get secondary IP Address, port number and RADIUS server. More... | |
| INT | wifi_setApSecuritySecondaryRadiusServer (INT apIndex, CHAR *IPAddress, UINT port, CHAR *RadiusSecret) |
| Set secondary IP Address, port number and RADIUS server, which are used for WLAN security. More... | |
| INT | wifi_getApDASRadiusServer (INT apIndex, CHAR *IP_output, UINT *Port_output, CHAR *RadiusdasSecret_output) |
| INT | wifi_setApDASRadiusServer (INT apIndex, CHAR *IPAddress, UINT port, CHAR *RadiusdasSecret) |
| Set the IP Address and port number of the RADIUS DAS server, which are used for WLAN security. More... | |
| INT | wifi_enableGreylistAccessControl (BOOL enable) |
| This function is to enable or disable grey list Access Control on all applicable VAP. 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_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... | |
| 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_setInterworkingAccessNetworkType (INT apIndex, INT accessNetworkType) |
| INT | wifi_getInterworkingAccessNetworkType (INT apIndex, UINT *output_uint) |
| INT | wifi_getApInterworkingServiceEnable (INT apIndex, BOOL *output_bool) |
| Get the Interworking Service enable/disable value for the AP. More... | |
| INT | wifi_setApInterworkingServiceEnable (INT apIndex, BOOL 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_mgmt_frame_callbacks_register (wifi_receivedMgmtFrame_callback mgmtRxCallback) |
| void | wifi_csi_callback_register (wifi_csi_callback callback_proc) |
| CSI call back registration function. Callback will be executed when the CSI data is available from the HAL. if CSI engine is disabled, this callback should not be executed. More... | |
| INT | wifi_enableCSIEngine (INT apIndex, mac_address_t sta, BOOL enable) |
| INT | wifi_sendDataFrame (INT apIndex, mac_address_t sta, UCHAR *data, UINT len, BOOL insert_llc, UINT eth_proto, wifi_data_priority_t prio) |
| INT | wifi_sendActionFrame (INT apIndex, mac_address_t sta, UINT frequency, UCHAR *frame, UINT len) |
| INT | wifi_applyGASConfiguration (wifi_GASConfiguration_t *input_struct) |
| INT | wifi_setCountryIe (INT apIndex, BOOL enabled) |
| INT | wifi_getCountryIe (INT apIndex, BOOL *enabled) |
| INT | wifi_setLayer2TrafficInspectionFiltering (INT apIndex, BOOL enabled) |
| INT | wifi_getLayer2TrafficInspectionFiltering (INT apIndex, BOOL *enabled) |
| INT | wifi_setDownStreamGroupAddress (INT apIndex, BOOL disabled) |
| INT | wifi_getDownStreamGroupAddress (INT apIndex, BOOL *disabled) |
| INT | wifi_setBssLoad (INT apIndex, BOOL enabled) |
| INT | wifi_getBssLoad (INT apIndex, BOOL *enabled) |
| INT | wifi_setProxyArp (INT apIndex, BOOL enabled) |
| INT | wifi_getProxyArp (INT apIndex, BOOL *enable) |
| INT | wifi_pushApHotspotElement (INT apIndex, BOOL enabled) |
| INT | wifi_getApHotspotElement (INT apIndex, BOOL *enabled) |
| INT | wifi_pushApRoamingConsortiumElement (INT apIndex, wifi_roamingConsortiumElement_t *infoElement) |
| INT | wifi_getApRoamingConsortiumElement (INT apIndex, wifi_roamingConsortiumElement_t *infoElement) |
| INT | wifi_setP2PCrossConnect (INT apIndex, BOOL disabled) |
| INT | wifi_getP2PCrossConnect (INT apIndex, BOOL *disabled) |
| INT | wifi_getTWTsessions (INT ap_index, UINT maxNumberSessions, wifi_twt_sessions_t *twtSessions, UINT *numSessionReturned) |
| get all the TWT session(individual or Broadcast) connected to that AP Index . More... | |
| INT | wifi_setBroadcastTWTSchedule (INT ap_index, wifi_twt_params_t twtParams, BOOL create, INT *sessionID) |
| Create or update a broadcast TWT Session More... | |
| INT | wifi_setTeardownTWTSession (INT ap_index, INT sessionID) |
| teardown the individual session or the broadcast session associate to the MAC More... | |
| INT | wifi_createVAP (wifi_radio_index_t index, wifi_vap_info_map_t *map) |
| INT | wifi_getRadioVapInfoMap (wifi_radio_index_t index, wifi_vap_info_map_t *map) |
| INT | wifi_setApSecurity (INT ap_index, wifi_vap_security_t *security) |
| INT | wifi_getApSecurity (INT ap_index, wifi_vap_security_t *security) |
| INT | wifi_getAPCapabilities (INT ap_index, wifi_ap_capabilities_t *apCapabilities) |
| INT | wifi_getApWpsConfiguration (INT ap_index, wifi_wps_t *wpsConfig) |
| INT | wifi_setApWpsConfiguration (INT ap_index, wifi_wps_t *wpsConfig) |
| INT | wifi_getLibhostapd (BOOL *output_bool) |
| INT | wifi_updateLibHostApdConfig (int apIndex) |
| INT | wifi_vapstatus_callback_register (wifi_vapstatus_callback callback) |
| VAP Status call back registration function. More... | |
| INT | wifi_hal_analytics_callback_register (wifi_analytics_callback callback) |
| VAP Status call back registration function. More... | |
| INT | wifi_getBandSteeringEnable (BOOL *enable) |
| To get Band Steering enable status. More... | |
| INT | wifi_setBandSteeringEnable (BOOL 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_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, ULONG *pSteeringTime, CHAR *pClientMAC, INT *pSourceSSIDIndex, INT *pDestSSIDIndex, INT *pSteeringReason) |
| To get the band steering log. More... | |
| INT | wifi_getApAssociatedDevicesHighWatermarkThreshold (INT apIndex, UINT *output) |
| Get the HighWatermarkThreshold value, that is lesser than or equal to MaxAssociatedDevices. More... | |
| INT | wifi_setApAssociatedDevicesHighWatermarkThreshold (INT apIndex, UINT Threshold) |
| Set the HighWatermarkThreshold value, that is lesser than or equal to MaxAssociatedDevices. More... | |
| INT | wifi_getApAssociatedDevicesHighWatermarkThresholdReached (INT apIndex, UINT *output) |
| Get the number of times the current total number of associated device has reached the HighWatermarkThreshold value. More... | |
| INT | wifi_getApAssociatedDevicesHighWatermark (INT apIndex, UINT *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. More... | |
| INT | wifi_getApAssociatedDevicesHighWatermarkDate (INT apIndex, ULONG *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_setFastBSSTransitionActivated (INT apIndex, UCHAR activate) |
| INT | wifi_getBSSTransitionActivated (INT apIndex, BOOL *activate) |
| Get the Fast Transition capability value. More... | |
| INT | wifi_setEAP_Param (UINT apIndex, UINT value, char *param) |
| Get the Fast Transition over DS activated value. @description 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... | |
| INT | wifi_getEAP_Param (UINT apIndex, wifi_eap_config_t *output) |
| INT | wifi_getFTOverDSActivated (INT apIndex, BOOL *activate) |
| INT | wifi_setFTOverDSActivated (INT apIndex, BOOL *activate) |
| Set the Fast Transition over DS activated value. See 802.11-2016 section 13.3. More... | |
| INT | wifi_getFTMobilityDomainID (INT apIndex, UCHAR mobilityDomain[2]) |
| Get the Fast Transition Mobility Domain value. See 802.11-2016 section 13.3. More... | |
| INT | wifi_setFTMobilityDomainID (INT apIndex, UCHAR mobilityDomain[2]) |
| Set the Fast Transition Mobility Domain value. See 802.11-2016 section 13.3. More... | |
| INT | wifi_getFTResourceRequestSupported (INT apIndex, BOOL *supported) |
| Get the Fast Transition Resource Request Support value. See 802.11-2016 section 13.3. More... | |
| INT | wifi_setFTResourceRequestSupported (INT apIndex, BOOL *supported) |
| Set the Fast Transition Resource Request Support value. See 802.11-2016 section 13.3. More... | |
| INT | wifi_getFTR0KeyLifetime (INT apIndex, UINT *lifetime) |
| Get the Fast Transition R0 Key Lifetime value. See 802.11-2016 section 13.4.2. More... | |
| INT | wifi_setFTR0KeyLifetime (INT apIndex, UINT *lifetime) |
| Set the Fast Transition R0 Key Lifetime value. See 802.11-2016 section 13.4.2. More... | |
| INT | wifi_getFTR0KeyHolderID (INT apIndex, UCHAR *keyHolderID) |
| Get the Fast Transition R0 Key Holder ID value. See 802.11-2016 section 13.3. More... | |
| INT | wifi_setFTR0KeyHolderID (INT apIndex, UCHAR *keyHolderID) |
| Set the Fast Transition R0 Key Holder ID value. See 802.11-2016 section 13.3. More... | |
| INT | wifi_getFTR1KeyHolderID (INT apIndex, UCHAR *keyHolderID) |
| Get the Fast Transition R1 Key Holder ID value. See 802.11-2016 section 13.3. More... | |
| INT | wifi_setFTR1KeyHolderID (INT apIndex, UCHAR *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_setBSSTransitionActivation (UINT apIndex, BOOL 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 (UINT apIndex, BOOL *activate) |
| INT | wifi_setNeighborReportActivation (UINT apIndex, BOOL activate) |
| INT | wifi_getNeighborReportActivation (UINT apIndex, BOOL *activate) |
| int | wifi_getHalVersion (char *output_string) |
| 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) |
| int | wifi_setRadioCountryCode (int radioIndex, char *CountryCode) |
| int | wifi_getRadioNumberOfEntries (unsigned long *output) |
| int | wifi_getSSIDNumberOfEntries (unsigned long *output) |
| int | wifi_getRadioEnable (int radioIndex, unsigned char *output_bool) |
| int | wifi_setRadioEnable (int radioIndex, unsigned char enable) |
| int | wifi_getRadioStatus (int radioIndex, unsigned char *output_bool) |
| int | wifi_getRadioIfName (int radioIndex, char *output_string) |
| int | wifi_getRadioMaxBitRate (int radioIndex, char *output_string) |
| int | wifi_getRadioSupportedFrequencyBands (int radioIndex, char *output_string) |
| int | wifi_getRadioOperatingFrequencyBand (int radioIndex, char *output_string) |
| int | wifi_getRadioSupportedStandards (int radioIndex, char *output_string) |
| int | wifi_getRadioStandard (int radioIndex, char *output_string, unsigned char *gOnly, unsigned char *nOnly, unsigned char *acOnly) |
| int | wifi_setRadioChannelMode (int radioIndex, char *channelMode, unsigned char gOnlyFlag, unsigned char nOnlyFlag, unsigned char acOnlyFlag) |
| int | wifi_getRadioPossibleChannels (int radioIndex, char *output_string) |
| int | wifi_getRadioChannelsInUse (int radioIndex, char *output_string) |
| int | wifi_getRadioChannel (int radioIndex, unsigned long *output_ulong) |
| int | wifi_setRadioChannel (int radioIndex, unsigned long channel) |
| int | wifi_setRadioAutoChannelEnable (int radioIndex, unsigned char enable) |
| int | wifi_getRadioAutoChannelSupported (int radioIndex, unsigned char *output_bool) |
| int | wifi_getRadioAutoChannelEnable (int radioIndex, unsigned char *output_bool) |
| int | wifi_getRadioDCSSupported (int radioIndex, unsigned char *output_bool) |
| int | wifi_getRadioDCSEnable (int radioIndex, unsigned char *output_bool) |
| int | wifi_setRadioDCSEnable (int radioIndex, unsigned char enable) |
| int | wifi_getRadioDCSChannelPool (int radioIndex, char *output_pool) |
| int | wifi_setRadioDCSChannelPool (int radioIndex, char *pool) |
| int | wifi_getRadioDCSScanTime (int radioIndex, int *output_interval_seconds, int *output_dwell_milliseconds) |
| int | wifi_setRadioDCSScanTime (int radioIndex, int interval_seconds, int dwell_milliseconds) |
| int | wifi_getRadioDfsSupport (int radioIndex, unsigned char *output_bool) |
| int | wifi_getRadioDfsEnable (int radioIndex, unsigned char *output_bool) |
| int | wifi_setRadioDfsEnable (int radioIndex, unsigned char enabled) |
| int | wifi_getRadioAutoChannelRefreshPeriodSupported (int radioIndex, unsigned char *output_bool) |
| int | wifi_getRadioAutoChannelRefreshPeriod (int radioIndex, unsigned long *output_ulong) |
| int | wifi_setRadioAutoChannelRefreshPeriod (int radioIndex, unsigned long seconds) |
| int | wifi_getRadioOperatingChannelBandwidth (int radioIndex, char *output_string) |
| int | wifi_setRadioOperatingChannelBandwidth (int radioIndex, char *bandwidth) |
| int | wifi_getRadioExtChannel (int radioIndex, char *output_string) |
| int | wifi_setRadioExtChannel (int radioIndex, char *string) |
| int | wifi_getRadioGuardInterval (int radioIndex, char *output_string) |
| int | wifi_setRadioGuardInterval (int radioIndex, char *string) |
| int | wifi_getRadioMCS (int radioIndex, int *output_INT) |
| int | wifi_setRadioMCS (int radioIndex, int MCS) |
| int | wifi_getRadioTransmitPowerSupported (int radioIndex, char *output_list) |
| int | wifi_getRadioTransmitPower (int radioIndex, unsigned long *output_ulong) |
| int | wifi_setRadioTransmitPower (int radioIndex, unsigned long TransmitPower) |
| int | wifi_getRadioIEEE80211hSupported (int radioIndex, unsigned char *Supported) |
| int | wifi_getRadioIEEE80211hEnabled (int radioIndex, unsigned char *enable) |
| int | wifi_setRadioIEEE80211hEnabled (int radioIndex, unsigned char enable) |
| int | wifi_getRadioCarrierSenseThresholdRange (int radioIndex, int *output) |
| int | wifi_getRadioCarrierSenseThresholdInUse (int radioIndex, int *output) |
| int | wifi_setRadioCarrierSenseThresholdInUse (int radioIndex, int threshold) |
| int | wifi_getRadioBeaconPeriod (int radioIndex, unsigned int *output) |
| int | wifi_setRadioBeaconPeriod (int radioIndex, unsigned int BeaconPeriod) |
| int | wifi_getRadioBasicDataTransmitRates (int radioIndex, char *output) |
| int | wifi_setRadioBasicDataTransmitRates (int radioIndex, char *TransmitRates) |
| int | wifi_getRadioTrafficStats2 (int radioIndex, wifi_radioTrafficStats2_t *output_struct) |
| int | wifi_setRadioTrafficStatsMeasure (int radioIndex, wifi_radioTrafficStatsMeasure_t *input_struct) |
| int | wifi_setRadioTrafficStatsRadioStatisticsEnable (int radioIndex, unsigned char enable) |
| int | wifi_getRadioStatsReceivedSignalLevel (int radioIndex, int signalIndex, int *SignalLevel) |
| int | wifi_applyRadioSettings (int radioIndex) |
| int | wifi_getRadioResetCount (int radioIndex, unsigned long *output_int) |
| int | wifi_getSSIDRadioIndex (int ssidIndex, int *radioIndex) |
| int | wifi_getSSIDEnable (int ssidIndex, unsigned char *output_bool) |
| int | wifi_setSSIDEnable (int ssidIndex, unsigned char enable) |
| int | wifi_getSSIDStatus (int ssidIndex, char *output_string) |
| int | wifi_getSSIDName (int apIndex, char *output_string) |
| int | wifi_setSSIDName (int apIndex, char *ssid_string) |
| int | wifi_getBaseBSSID (int ssidIndex, char *output_string) |
| int | wifi_getSSIDMACAddress (int ssidIndex, char *output_string) |
| int | wifi_getSSIDTrafficStats2 (int ssidIndex, wifi_ssidTrafficStats2_t *output_struct) |
| int | wifi_applySSIDSettings (int ssidIndex) |
| int | wifi_getNeighboringWiFiDiagnosticResult2 (int radioIndex, wifi_neighbor_ap2_t **neighbor_ap_array, unsigned int *output_array_size) |
| int | wifi_getSSIDTrafficStats (int ssidIndex, wifi_ssidTrafficStats_t *output_struct) |
| int | wifi_getBasicTrafficStats (int apIndex, wifi_basicTrafficStats_t *output_struct) |
| int | wifi_getWifiTrafficStats (int apIndex, wifi_trafficStats_t *output_struct) |
| 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_setRadioCtsProtectionEnable (int apIndex, unsigned char enable) |
| int | wifi_setRadioObssCoexistenceEnable (int apIndex, unsigned char enable) |
| int | wifi_setRadioFragmentationThreshold (int apIndex, unsigned int threshold) |
| int | wifi_setRadioSTBCEnable (int radioIndex, unsigned char STBC_Enable) |
| int | wifi_getRadioAMSDUEnable (int radioIndex, unsigned char *output_bool) |
| int | wifi_setRadioAMSDUEnable (int radioIndex, unsigned char amsduEnable) |
| int | wifi_getRadioTxChainMask (int radioIndex, int *output_int) |
| int | wifi_setRadioTxChainMask (int radioIndex, int numStreams) |
| int | wifi_getRadioRxChainMask (int radioIndex, int *output_int) |
| int | wifi_setRadioRxChainMask (int radioIndex, int numStreams) |
| int | wifi_pushBridgeInfo (int apIndex) |
| int | wifi_pushRadioChannel (int radioIndex, unsigned int channel) |
| int | wifi_pushRadioChannelMode (int radioIndex) |
| int | wifi_pushRadioTxChainMask (int radioIndex) |
| int | wifi_pushRadioRxChainMask (int radioIndex) |
| int | wifi_pushSSID (int apIndex, char *ssid) |
| int | wifi_pushSsidAdvertisementEnable (int apIndex, unsigned char enable) |
| int | wifi_getRadioUpTime (int radioIndex, unsigned long *uptime) |
| int | wifi_getRadioReverseDirectionGrantSupported (int radioIndex, unsigned char *output_bool) |
| int | wifi_getRadioReverseDirectionGrantEnable (int radioIndex, unsigned char *output_bool) |
| int | wifi_setRadioReverseDirectionGrantEnable (int radioIndex, unsigned char enable) |
| int | wifi_getRadioDeclineBARequestEnable (int radioIndex, unsigned char *output_bool) |
| int | wifi_setRadioDeclineBARequestEnable (int radioIndex, unsigned char enable) |
| int | wifi_getRadioAutoBlockAckEnable (int radioIndex, unsigned char *output_bool) |
| int | wifi_setRadioAutoBlockAckEnable (int radioIndex, unsigned char enable) |
| int | wifi_getRadio11nGreenfieldSupported (int radioIndex, unsigned char *output_bool) |
| int | wifi_getRadio11nGreenfieldEnable (int radioIndex, unsigned char *output_bool) |
| int | wifi_setRadio11nGreenfieldEnable (int radioIndex, unsigned char enable) |
| int | wifi_getRadioIGMPSnoopingEnable (int radioIndex, unsigned char *output_bool) |
| int | wifi_setRadioIGMPSnoopingEnable (int radioIndex, unsigned char enable) |
| int | wifi_createAp (int apIndex, int radioIndex, char *essid, unsigned char hideSsid) |
| int | wifi_deleteAp (int apIndex) |
| int | wifi_getApName (int apIndex, char *output_string) |
| int | wifi_getApIndexFromName (char *inputSsidString, int *ouput_int) |
| int | wifi_getApBeaconType (int apIndex, char *output_string) |
| int | wifi_setApBeaconType (int apIndex, char *beaconTypeString) |
| int | wifi_setApBeaconInterval (int apIndex, int beaconInterval) |
| int | wifi_setApDTIMInterval (int apIndex, int dtimInterval) |
| int | wifi_getApRtsThresholdSupported (int apIndex, unsigned char *output_bool) |
| int | wifi_setApRtsThreshold (int apIndex, unsigned int threshold) |
| int | wifi_getApWpaEncryptoinMode (int apIndex, char *output_string) |
| int | wifi_setApWpaEncryptionMode (int apIndex, char *encMode) |
| int | wifi_removeApSecVaribles (int apIndex) |
| int | wifi_disableApEncryption (int apIndex) |
| int | wifi_setApAuthMode (int apIndex, int mode) |
| int | wifi_setApBasicAuthenticationMode (int apIndex, char *authMode) |
| int | wifi_getApNumDevicesAssociated (int apIndex, unsigned long *output_ulong) |
| int | wifi_kickApAssociatedDevice (int apIndex, char *client_mac) |
| int | wifi_getApRadioIndex (int apIndex, int *output_int) |
| int | wifi_setApRadioIndex (int apIndex, int radioIndex) |
| int | wifi_getApAclDevices (int apIndex, char *macArray, unsigned int buf_size) |
| int | wifi_addApAclDevice (int apIndex, char *DeviceMacAddress) |
| int | wifi_delApAclDevice (int apIndex, char *DeviceMacAddress) |
| int | wifi_getApAclDeviceNum (int apIndex, unsigned int *output_uint) |
| int | wifi_kickApAclAssociatedDevices (int apIndex, unsigned char enable) |
| int | wifi_setApMacAddressControlMode (int apIndex, int filterMode) |
| int | wifi_setApVlanEnable (int apIndex, unsigned char VlanEnabled) |
| int | wifi_setApVlanID (int apIndex, int vlanId) |
| int | wifi_getApBridgeInfo (int index, char *bridgeName, char *IP, char *subnet) |
| int | wifi_setApBridgeInfo (int apIndex, char *bridgeName, char *IP, char *subnet) |
| int | wifi_resetApVlanCfg (int apIndex) |
| 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) |
| int | wifi_getApEnable (int apIndex, unsigned char *output_bool) |
| int | wifi_getApStatus (int apIndex, char *output_string) |
| int | wifi_getApSsidAdvertisementEnable (int apIndex, unsigned char *output_bool) |
| int | wifi_setApSsidAdvertisementEnable (int apIndex, unsigned char enable) |
| int | wifi_pushApSsidAdvertisementEnable (int apIndex, unsigned char enable) |
| int | wifi_getApRetryLimit (int apIndex, unsigned int *output) |
| int | wifi_setApRetryLimit (int apIndex, unsigned int number) |
| int | wifi_getApWMMCapability (int apIndex, unsigned char *output) |
| int | wifi_getApUAPSDCapability (int apIndex, unsigned char *output) |
| int | wifi_getApWmmEnable (int apIndex, unsigned char *output) |
| int | wifi_setApWmmEnable (int apIndex, unsigned char enable) |
| int | wifi_getApWmmUapsdEnable (int apIndex, unsigned char *output) |
| int | wifi_setApWmmUapsdEnable (int apIndex, unsigned char enable) |
| int | wifi_setApWmmOgAckPolicy (int apIndex, int class, unsigned char ackPolicy) |
| int | wifi_getApIsolationEnable (int apIndex, unsigned char *output) |
| int | wifi_setApIsolationEnable (int apIndex, unsigned char enable) |
| int | wifi_getApMaxAssociatedDevices (int apIndex, unsigned int *output) |
| int | wifi_setApMaxAssociatedDevices (int apIndex, unsigned int number) |
| int | wifi_getApAssociatedDevicesHighWatermarkThreshold (int apIndex, unsigned int *output) |
| int | wifi_setApAssociatedDevicesHighWatermarkThreshold (int apIndex, unsigned int Threshold) |
| int | wifi_getApAssociatedDevicesHighWatermarkThresholdReached (int apIndex, unsigned int *output) |
| int | wifi_getApAssociatedDevicesHighWatermark (int apIndex, unsigned int *output) |
| int | wifi_getApAssociatedDevicesHighWatermarkDate (int apIndex, unsigned long *output_in_seconds) |
| int | wifi_getApSecurityModesSupported (int apIndex, char *output) |
| int | wifi_getApSecurityModeEnabled (int apIndex, char *output) |
| int | wifi_setApSecurityModeEnabled (int apIndex, char *encMode) |
| int | wifi_getApSecurityPreSharedKey (int apIndex, char *output_string) |
| int | wifi_setApSecurityPreSharedKey (int apIndex, char *preSharedKey) |
| int | wifi_getApSecurityKeyPassphrase (int apIndex, char *output_string) |
| int | wifi_setApSecurityKeyPassphrase (int apIndex, char *passPhrase) |
| int | wifi_setApSecurityReset (int apIndex) |
| int | wifi_getApSecurityRadiusServer (int apIndex, char *IP_output, unsigned int *Port_output, char *RadiusSecret_output) |
| int | wifi_setApSecurityRadiusServer (int apIndex, char *IPAddress, unsigned int port, char *RadiusSecret) |
| int | wifi_getApSecuritySecondaryRadiusServer (int apIndex, char *IP_output, unsigned int *Port_output, char *RadiusSecret_output) |
| int | wifi_setApSecuritySecondaryRadiusServer (int apIndex, char *IPAddress, unsigned int port, char *RadiusSecret) |
| int | wifi_getApSecurityRadiusSettings (int apIndex, wifi_radius_setting_t *output) |
| int | wifi_setApSecurityRadiusSettings (int apIndex, wifi_radius_setting_t *input) |
| int | wifi_getApWpsEnable (int apIndex, unsigned char *output_bool) |
| int | wifi_setApWpsEnable (int apIndex, unsigned char enableValue) |
| int | wifi_getApWpsConfigMethodsSupported (int apIndex, char *output) |
| int | wifi_getApWpsConfigMethodsEnabled (int apIndex, char *output_string) |
| int | wifi_setApWpsConfigMethodsEnabled (int apIndex, char *methodString) |
| int | wifi_getApWpsDevicePIN (int apIndex, unsigned long *output_ulong) |
| int | wifi_setApWpsDevicePIN (int apIndex, unsigned long pin) |
| int | wifi_getApWpsConfigurationState (int apIndex, char *output_string) |
| int | wifi_setApWpsEnrolleePin (int apIndex, char *pin) |
| int | wifi_setApWpsButtonPush (int apIndex) |
| int | wifi_cancelApWPS (int apIndex) |
| int | wifi_getApAssociatedDeviceDiagnosticResult (int apIndex, wifi_associated_dev_t **associated_dev_array, unsigned int *output_array_size) |
| 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) |
| void | wifi_apAuthEvent_callback_register (wifi_apAuthEvent_callback callback_proc) |
| INT | wifi_getRadioChannelStats (INT radioIndex, wifi_channelStats_t *input_output_channelStats_array, INT array_size) |
| Get the channels utilization status. More... | |
| INT | wifi_getApAssociatedDeviceRxStatsResult (INT radioIndex, mac_address_t *clientMacAddress, wifi_associated_dev_rate_info_rx_stats_t **stats_array, UINT *output_array_size, ULLONG *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, UINT *output_array_size, ULLONG *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, ULLONG *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, ULLONG *handle) |
| Get the associated device status. More... | |
| INT | wifi_getSSIDRadioIndex (INT ssidIndex, INT *radioIndex) |
| Get the radio index associated with the SSID entry. More... | |
| INT | wifi_applySSIDSettings (INT ssidIndex) |
| Apply SSID and AP (in the case of Acess Point devices) to the hardware. More... | |
| INT | wifi_startNeighborScan (INT apIndex, wifi_neighborScanMode_t scan_mode, INT dwell_time, UINT chan_num, UINT *chan_list) |
| This API initates the scanning. 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... | |
| void | wifi_steerTriggered_callback_register (wifi_steerTriggered_callback callback_proc, CHAR *module) |
| 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 (UINT steeringgroupIndex, INT apIndex, mac_address_t client_mac, wifi_steering_clientConfig_t *config) |
| Add Client Config to apIndex. More... | |
| INT | wifi_steering_clientRemove (UINT steeringgroupIndex, INT apIndex, mac_address_t client_mac) |
| Remove Client Config from apIndex. More... | |
| INT | wifi_steering_clientMeasure (UINT steeringgroupIndex, INT apIndex, mac_address_t client_mac) |
| Initiate Instant Client RSSI Measurement. More... | |
| INT | wifi_steering_clientDisconnect (UINT steeringgroupIndex, INT apIndex, mac_address_t client_mac, wifi_disconnectType_t type, UINT reason) |
| Initiate a Client Disconnect. More... | |
| INT | wifi_BTMQueryRequest_callback_register (UINT apIndex, wifi_BTMQueryRequest_callback btmQueryCallback, wifi_BTMResponse_callback btmResponseCallback) |
| BTM Query callback registration function. More... | |
| INT | wifi_RMBeaconRequestCallbackRegister (UINT apIndex, wifi_RMBeaconReport_callback beaconReportCallback) |
| INT | wifi_RMBeaconRequestCallbackUnregister (UINT apIndex, wifi_RMBeaconReport_callback beaconReportCallback) |
| INT | wifi_cancelRMBeaconRequest (UINT apIndex, UCHAR dialogToken) |
| int | wifi_getHalCapability (wifi_hal_capability_t *cap) |
| Get HAL Capabilities. More... | |
| INT | wifi_getRadioResetCount (INT radioIndex, ULONG *output_int) |
| Get the radio reset count. More... | |
| INT | wifi_getRadioEnable (INT radioIndex, BOOL *output_bool) |
| Get the Radio enable config parameter. More... | |
| INT | wifi_setRadioEnable (INT radioIndex, BOOL enable) |
| Set the Radio enable config parameter. More... | |
| INT | wifi_getRadioStatus (INT radioIndex, BOOL *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_getRadioDfsEnable (INT radioIndex, BOOL *output_bool) |
| Get the Dfs enable status. More... | |
| INT | wifi_setRadioDfsEnable (INT radioIndex, BOOL enabled) |
| Set the Dfs enable status. More... | |
| INT | wifi_getRadioDfsAtBootUpEnable (INT radioIndex, BOOL *enable) |
| Get the Dfs enable on Bootup status. More... | |
| INT | wifi_setRadioDfsAtBootUpEnable (INT radioIndex, BOOL enable) |
| Set the Dfs enable on Bootup status. 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_getRadioTransmitPower (INT radioIndex, ULONG *output_ulong) |
| Get current Transmit Power in dBm units. More... | |
| INT | wifi_getRadioPercentageTransmitPower (INT radioIndex, ULONG *output_ulong) |
| Get current Transmit Power level in units of full power. More... | |
| INT | wifi_setRadioTransmitPower (INT radioIndex, ULONG TransmitPower) |
| Set current Transmit Power, eg "75", "100". 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_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_setRadioCtsProtectionEnable (INT apIndex, BOOL enable) |
| Enables CTS protection for the radio used by this Access Point. More... | |
| INT | wifi_setRadioObssCoexistenceEnable (INT apIndex, BOOL enable) |
| Enables OBSS Coexistence - fall back to 20MHz if necessary for the radio used by this AP. More... | |
| INT | wifi_setRadioFragmentationThreshold (INT apIndex, UINT threshold) |
| Sets the fragmentation threshold in bytes for the radio used by this Access Point. More... | |
| INT | wifi_setRadioSTBCEnable (INT radioIndex, BOOL STBC_Enable) |
| Enable STBC mode in the hardware. 0 == not enabled, 1 == enabled. More... | |
| INT | wifi_getRadioAMSDUEnable (INT radioIndex, BOOL *output_bool) |
| Outputs A-MSDU enable status, 0 == not enabled, 1 == enabled. More... | |
| INT | wifi_setRadioAMSDUEnable (INT radioIndex, BOOL amsduEnable) |
| Enables A-MSDU in the hardware, 0 == not enabled, 1 == enabled. More... | |
| INT | wifi_getRadioUpTime (INT radioIndex, ULONG *uptime) |
| Get the number of seconds elapsed since radio is started. More... | |
| INT | wifi_getRadioReverseDirectionGrantSupported (INT radioIndex, BOOL *output_bool) |
| Get radio RDG enable Support. More... | |
| INT | wifi_getRadioAutoBlockAckEnable (INT radioIndex, BOOL *output_bool) |
| Get radio auto block ack enable setting. More... | |
| INT | wifi_setRadioAutoBlockAckEnable (INT radioIndex, BOOL enable) |
| Set radio auto block ack enable setting. More... | |
| INT | wifi_getRadioIGMPSnoopingEnable (INT radioIndex, BOOL *output_bool) |
| Get radio IGMP snooping enable setting. More... | |
| INT | wifi_setRadioIGMPSnoopingEnable (INT radioIndex, BOOL enable) |
| Set radio IGMP snooping enable setting. More... | |
| INT | wifi_setZeroDFSState (UINT radioIndex, BOOL enable, BOOL precac) |
| Set Zero DFS State. More... | |
| INT | wifi_getZeroDFSState (UINT radioIndex, BOOL *enable, BOOL *precac) |
| Get Zero DFS State. More... | |
| INT | wifi_setDownlinkMuType (INT radio_index, wifi_dl_mu_type_t mu_type) |
| INT | wifi_getDownlinkMuType (INT radio_index, wifi_dl_mu_type_t *mu_type) |
| INT | wifi_setUplinkMuType (INT radio_index, wifi_ul_mu_type_t mu_type) |
| INT | wifi_getUplinkMuType (INT radio_index, wifi_ul_mu_type_t *mu_type) |
| INT | wifi_setGuardInterval (INT radio_index, wifi_guard_interval_t guard_interval) |
| INT | wifi_getGuardInterval (INT radio_index, wifi_guard_interval_t *guard_interval) |
| INT | wifi_setBSSColor (INT radio_index, UCHAR color) |
| INT | wifi_getBSSColor (INT radio_index, UCHAR *color) |
| INT | wifi_getAvailableBSSColor (INT radio_index, INT maxNumberColors, UCHAR *colorList, INT *numColorReturned) |
| Get the list of avaiable BSS color. More... | |
| INT | wifi_getMuEdca (INT radio_index, wifi_access_category_t ac, wifi_edca_t *edca) |
| Get MU (Multi-User) EDCA (Enhanced Distributed Channel Access) parameter. More... | |
| INT | wifi_setDownlinkDataAckType (INT radio_index, wifi_dl_data_ack_type_t ack_type) |
| INT | wifi_get80211axDefaultParameters (INT radio_index, wifi_80211ax_params_t *params) |
| INT | wifi_setRadioOperatingParameters (wifi_radio_index_t index, wifi_radio_operationParam_t *operationParam) |
| Set Radio Operating Parameters. More... | |
| INT | wifi_getRadioOperatingParameters (wifi_radio_index_t index, wifi_radio_operationParam_t *operationParam) |
| Get Radio Operating Parameters. More... | |
| INT | wifi_getScanResults (wifi_radio_index_t index, wifi_channel_t *channel, wifi_bss_info_t **bss, UINT *num_bss) |
| void | wifi_scanResults_callback_register (wifi_scanResults_callback callback_proc) |
| INT | wifi_connect (INT ap_index, wifi_bss_info_t *bss) |
| INT | wifi_disconnect (INT ap_index) |
| INT | wifi_getStationCapability (INT ap_index, wifi_sta_capability_t *cap) |
| INT | wifi_findNetworks (INT ap_index, wifi_channel_t *channel, wifi_bss_info_t **bss, UINT *num_bss) |
| INT | wifi_getStationStats (INT ap_index, wifi_station_stats_t *sta) |
| void | wifi_staConnectionStatus_callback_register (wifi_staConnectionStatus_callback callback_proc) |
| INT | wifi_getRadioTrafficStats2 (INT radioIndex, wifi_radioTrafficStats2_t *output_struct) |
| Get detail radio traffic static info. More... | |
| INT | wifi_getSSIDTrafficStats2 (INT ssidIndex, wifi_ssidTrafficStats2_t *output_struct) |
| Get the basic SSID traffic static info. More... | |
| INT | wifi_getRadioBandUtilization (INT radioIndex, INT *output_percentage) |
| To read the radio band utilization. More... | |
| INT | wifi_getApAssociatedDeviceDiagnosticResult3 (INT apIndex, wifi_associated_dev3_t **associated_dev_array, UINT *output_array_size) |
| INT | wifi_setClientDetailedStatisticsEnable (INT radioIndex, BOOL enable) |
| This function enabled/disabled collection of detailed statistics of associated clients on Access Point. More... | |
| INT | wifi_getRadioStatsEnable (INT radioIndex, BOOL *output_enable) |
| This API returns the radio enabled status. More... | |
| INT | wifi_setRadioStatsEnable (INT radioIndex, BOOL enable) |
| This API is to enable/disable radio status. More... | |
| INT | wifi_getVAPTelemetry (UINT apIndex, wifi_VAPTelemetry_t *telemetry) |
| struct _wifi_GASConfiguration_t |
Definition at line 2066 of file wifi_hal_ap.h.
Data Fields | |
| UINT | AdvertisementID |
| BOOL | PauseForServerResponse |
| UINT | ResponseTimeout |
| UINT | ComeBackDelay |
| UINT | ResponseBufferingTime |
| UINT | QueryResponseLengthLimit |
| UINT _wifi_GASConfiguration_t::AdvertisementID |
Definition at line 2067 of file wifi_hal_ap.h.
| BOOL _wifi_GASConfiguration_t::PauseForServerResponse |
Definition at line 2068 of file wifi_hal_ap.h.
| UINT _wifi_GASConfiguration_t::ResponseTimeout |
Definition at line 2069 of file wifi_hal_ap.h.
| UINT _wifi_GASConfiguration_t::ComeBackDelay |
Definition at line 2070 of file wifi_hal_ap.h.
| UINT _wifi_GASConfiguration_t::ResponseBufferingTime |
Definition at line 2071 of file wifi_hal_ap.h.
| UINT _wifi_GASConfiguration_t::QueryResponseLengthLimit |
Definition at line 2072 of file wifi_hal_ap.h.
| #define GAS_CFG_TYPE_SUPPORTED 1 |
Definition at line 2063 of file wifi_hal_ap.h.
| typedef INT(* wifi_vapstatus_callback) (INT apIndex, wifi_vapstatus_t status) |
This call back will be invoked when VAP status changes.
| [in] | apIndex | VAP Index |
| [in] | status | VAP status |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Definition at line 2670 of file wifi_hal_ap.h.
This call back will be invoked when HAL wants to log catasrophic failures.
| [in] | fmt | format |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Definition at line 2708 of file wifi_hal_ap.h.
| typedef int( * wifi_newApAssociatedDevice_callback) (int apIndex, wifi_associated_dev_t *associated_dev) |
@description This call back will be invoked when new wifi client come to associate to AP.
| apIndex | - Access Point Index |
| associated_dev | - wifi_associated_dev_t *associated_dev, associated device info |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Definition at line 4904 of file wifi_hal_emu.h.
| typedef int( * wifi_apAuthEvent_callback) (int apIndex, char *MAC, int event_type) |
Definition at line 5427 of file wifi_hal_emu.h.
| typedef INT( * wifi_scanResults_callback) (wifi_radio_index_t index, wifi_bss_info_t **bss, UINT *num_bss) |
Definition at line 1016 of file wifi_hal_radio.h.
| typedef INT( * wifi_staConnectionStatus_callback) (INT apIndex, wifi_bss_info_t *bss_dev, wifi_station_stats_t *sta) |
Definition at line 139 of file wifi_hal_sta.h.
| enum wifi_vapstatus_t |
VAP status possible values.
| Enumerator | |
|---|---|
| wifi_vapstatus_down | |
| wifi_vapstatus_up | |
Definition at line 2647 of file wifi_hal_ap.h.
| INT wifi_getWifiTrafficStats | ( | INT | apIndex, |
| wifi_trafficStats_t * | output_struct | ||
| ) |
Outputs more detailed traffic stats per AP.
| int wifi_factoryResetAP | ( | int | apIndex | ) |
Restore Access point paramters to default without change other AP nor Radio parameters (No need to reboot wifi)
| [in] | apIndex | Access Point index |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
@description Restore AP paramters to default without change other AP nor Radio parameters (No need to reboot wifi)
| apIndex | - Access Point index |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Deletes this access point entry on the hardware, clears all internal variables associated with this access point.
| [in] | apIndex | Access Point index |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Outputs a 16 byte or less name associated with the Access Point. String buffer must be pre-allocated by the caller.
| [in] | apIndex | Access Point index |
| [out] | output_string | Access Point name, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Sets the packet size threshold in bytes to apply RTS/CTS backoff rules.
| [in] | apIndex | Access Point index |
| [in] | threshold | Packet size threshold |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Deletes internal security variable settings for this access point.
| [in] | apIndex | Access Point index |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Changes the hardware settings to disable encryption on this access point.
| [in] | apIndex | Access Point index |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Outputs the number of stations associated per Access Point.
| [in] | apIndex | Access Point index |
| [out] | output_ulong | Number of stations, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Outputs the radio index for the specified access point.
| [in] | apIndex | Access Point index |
| [out] | output_int | Radio index, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Get the ACL MAC list per Access Point.
| [in] | apIndex | Access Point index |
| [out] | macArray | Mac Array list, to be returned // in formate as "11:22:33:44:55:66\n11:22:33:44:55:67\n" |
| [in] | maxArraySize | Array size |
| [out] | output_numEntries | size list returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Adds the mac address to the filter list.
| [in] | apIndex | Access Point index |
| [in] | DeviceMacAddress | Mac Address of a device |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Deletes all Device MAC address from the Access control filter list.
| [in] | apIndex | Access Point index |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Outputs the number of devices in the filter list.
| [in] | apIndex | Access Point index |
| [out] | output_uint | Number of devices, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Enable kick for devices on acl black list.
| [in] | apIndex | Access Point index |
| [in] | enable | Enable/disable kick for devices on acl black list |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Sets the mac address filter control mode.
| [in] | apIndex | Access Point index |
| [in] | filterMode | Mac Address filter control mode |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
This function is to read the ACL mode.
| [in] | apIndex | Access Point index |
| [out] | output_filterMode | Mac Address control mode |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Sets the vlan ID for this access point to an internal environment variable.
| [in] | apIndex | Access Point index |
| [in] | vlanId | VLAN ID |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Reset the vlan configuration for this access point.
| [in] | apIndex | Access Point index |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Sets the Access Point enable status variable for the specified access point.
| [in] | apIndex | Access Point index |
| [in] | enable | Enable/Disable AP enable status variable |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Outputs the setting of the internal variable that is set by wifi_setEnable().
| [in] | apIndex | Access Point index |
| [out] | output_bool | AP enable status, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Outputs the AP "Enabled" "Disabled" status from driver.
| [in] | apIndex | Access Point index |
| [out] | output_string | AP status, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Indicates whether or not beacons include the SSID name.
Outputs 1 if SSID on the AP is enabled, else ouputs 0.
| [in] | apIndex | Access Point index |
| [out] | output_bool | SSID Advertisement enabled, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Sets an internal variable for ssid advertisement.
Set to 1 to enable, set to 0 to disable.
| [in] | apIndex | Access Point index |
| [in] | enable | SSID Advertisement enable value |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Get the maximum number of retransmission for a packet.
This corresponds to IEEE 802.11 parameter dot11ShortRetryLimit.
| [in] | apIndex | Access Point index |
| [out] | output | Maximum number of retransmission for a packet, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Set the maximum number of retransmission for a packet.
This corresponds to IEEE 802.11 parameter dot11ShortRetryLimit.
| [in] | apIndex | Access Point index |
| [in] | number | Maximum number of retransmission for a packet |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Indicates whether WMM support is currently enabled.
When enabled, this is indicated in beacon frames.
| [in] | apIndex | Access Point index |
| [out] | output | WMM support enabled status, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Enables/disables WMM on the hardwawre for this AP. enable==1, disable == 0.
| [in] | apIndex | Access Point index |
| [in] | enable | WMM support enabled status |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
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.
| [in] | apIndex | Access Point index |
| [out] | output | U-APSD support enabled status, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Enables/disables Automatic Power Save Delivery on the hardwarwe for this Access Point.
| [in] | apIndex | Access Point index |
| [in] | enable | U-APSD enable/disable value |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Sets the WMM ACK policy on the hardware.
AckPolicy false means do not acknowledge, true means acknowledge.
| [in] | apIndex | Access Point index |
| [in] | class | |
| [in] | ackPolicy | Acknowledge policy |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
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).
| [in] | apIndex | Access Point index |
| [out] | output | Access Point Isolation enable, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
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).
| [in] | apIndex | Access Point index |
| [in] | enable | Access Point Isolation enable value |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Set Access Point Beacon TX rate.
| [in] | apIndex | Access point index will be 0, 2,4,6,8 10, 12, 14(for 2.4G) only; |
| [in] | sBeaconRate | sBeaconRate could be "1Mbps"; "5.5Mbps"; "6Mbps"; "2Mbps"; "11Mbps"; "12Mbps"; "24Mbps" |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Get Access Point Beacon TX rate.
| [in] | apIndex | Index of Wi-Fi Access Point |
| [out] | output_BeaconRate | Beacon rate output |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
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.
| [in] | apIndex | Access Point index |
| [out] | output | Maximum associated devices, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
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.
| [in] | apIndex | Access Point index |
| [in] | number | Maximum associated devices |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
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.
| [in] | apIndex | Access Point index |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
To retrive the MFPConfig for each VAP.
| [in] | apIndex | Access Point index |
| [out] | output_string. | Preallocated buffer for 64bytes. Allowed output string are "Disabled", "Optional", "Required" |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
the hal is used to set the MFP config for each VAP.
| [in] | apIndex | Access Point index |
| [in] | MfpConfig,The | allowed string for MFPConfig are "Disabled", "Optional", "Required" |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| INT wifi_getApSecurityRadiusServer | ( | INT | apIndex, |
| CHAR * | IP_output, | ||
| UINT * | 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.
| [in] | Index | Access Point index |
| [out] | IP_output | IP Address, to be returned |
| [out] | Port_output | Port output, to be returned |
| [out] | RadiusSecret_output | Radius Secret output, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| INT wifi_setApSecurityRadiusServer | ( | INT | apIndex, |
| CHAR * | IPAddress, | ||
| UINT | 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.
| [in] | apIndex | Access Point index |
| [in] | IPAddress | IP Address |
| [in] | port | Port |
| [in] | RadiusSecret | Radius Secret |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| INT wifi_getApSecuritySecondaryRadiusServer | ( | INT | apIndex, |
| CHAR * | IP_output, | ||
| UINT * | 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.
| [in] | apIndex | Access Point index |
| [out] | IP_output | IP Address, to be returned |
| [out] | Port_output | Port,to be returned |
| [out] | RadiusSecret_output | Radius Secret, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| INT wifi_setApSecuritySecondaryRadiusServer | ( | INT | apIndex, |
| CHAR * | IPAddress, | ||
| UINT | 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.
| [in] | apIndex | Access Point index |
| [in] | IPAddress | IP Address |
| [in] | port | Port |
| [in] | RadiusSecret | Radius Secret |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| INT wifi_getApDASRadiusServer | ( | INT | apIndex, |
| CHAR * | IP_output, | ||
| UINT * | Port_output, | ||
| CHAR * | RadiusdasSecret_output | ||
| ) |
Set the IP Address and port number of the RADIUS DAS server, which are used for WLAN security.
Device.WiFi.AccessPoint.{i}.Security.RadiusDASIPAddr Device.WiFi.AccessPoint.{i}.Security.RadiusDASPort Device.WiFi.AccessPoint.{i}.Security.RadiusDASSecret
| [in] | IPAddress | IP Address |
| [in] | port | Port |
| [in] | RadiusdasSecret | Radius Secret |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
This function is to enable or disable grey list Access Control on all applicable VAP.
| [in] | enable | enable access control if true, disable if false |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| INT wifi_getApSecurityRadiusSettings | ( | INT | apIndex, |
| wifi_radius_setting_t * | output | ||
| ) |
Get Access Point security radius settings.
| [in] | apIndex | Access Point index |
| [out] | output | wifi_radius_setting_t info (*output), to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| INT wifi_setApSecurityRadiusSettings | ( | INT | apIndex, |
| wifi_radius_setting_t * | input | ||
| ) |
Set Access Point security radius settings.
| [in] | apIndex | Access Point index |
| [in] | input | wifi_radius_setting_t info |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Get WPS configuration state.
Output string is either Not configured or Configured, max 32 characters.
| [in] | apIndex | Access Point index |
| [in] | output_string | WPS configuration state, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Sets the WPS pin for this Access Point.
| [in] | apIndex | Access Point index |
| [in] | pin | WPS enroll Pin |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
This function is called when the WPS push button has been pressed for this AP.
| [in] | apIndex | Access Point index |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Cancels WPS mode for this Access Point.
| [in] | apIndex | Access Point index |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Get the ApManagementFramePowerControl.
| [in] | apIndex | Access Point index |
| [out] | output_dBm | ManagementFramePowerControl, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Sets the ApManagementFramePowerControl.
| [in] | apIndex | Access Point index |
| [in] | dBm | RadioManagementFramePowerControl |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| void wifi_newApAssociatedDevice_callback_register | ( | wifi_newApAssociatedDevice_callback | callback_proc | ) |
Callback registration function.
| [in] | callback_proc | wifi_newApAssociatedDevice_callback callback function |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
@description Callback registration function.
| callback_proc | - wifi_newApAssociatedDevice_callback callback function |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| void wifi_apDisassociatedDevice_callback_register | ( | wifi_apDisassociatedDevice_callback | callback_proc | ) |
Callback registration function.
| [in] | callback_proc | wifi_apDisassociatedDevice_callback callback function |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| void wifi_apDeAuthEvent_callback_register | ( | wifi_apDeAuthEvent_callback | callback_proc | ) |
Callback registration function.
| [in] | callback_proc | wifi_apDeAuthEvent_callback callback function |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Get the Interworking Service enable/disable value for the AP.
| [in] | apIndex | Index of the Access Point. |
| [in] | output_bool | Indication as to whether the AP Interworking Service is enabled (true) or disabled (false). |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Set the Interworking Service enable/disable value for the AP.
| [in] | apIndex | Index of the Access Point. |
| [in] | input_bool | Value to set the Interworking Service enable to, true or false. |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| INT wifi_getApInterworkingElement | ( | INT | apIndex, |
| wifi_InterworkingElement_t * | output_struct | ||
| ) |
Get the Interworking Element that will be sent by the AP.
| [in] | apIndex | Index of the Access Point. |
| [in] | output_struct | Interworking Element. |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| INT wifi_pushApInterworkingElement | ( | INT | apIndex, |
| wifi_InterworkingElement_t * | infoEelement | ||
| ) |
| INT wifi_mgmt_frame_callbacks_register | ( | wifi_receivedMgmtFrame_callback | mgmtRxCallback | ) |
| void wifi_csi_callback_register | ( | wifi_csi_callback | callback_proc | ) |
CSI call back registration function. Callback will be executed when the CSI data is available from the HAL. if CSI engine is disabled, this callback should not be executed.
| [in] | callback | wifi_csi_callback callback function |
| INT wifi_enableCSIEngine | ( | INT | apIndex, |
| mac_address_t | sta, | ||
| BOOL | enable | ||
| ) |
| INT wifi_sendDataFrame | ( | INT | apIndex, |
| mac_address_t | sta, | ||
| UCHAR * | data, | ||
| UINT | len, | ||
| BOOL | insert_llc, | ||
| UINT | eth_proto, | ||
| wifi_data_priority_t | prio | ||
| ) |
| INT wifi_sendActionFrame | ( | INT | apIndex, |
| mac_address_t | sta, | ||
| UINT | frequency, | ||
| UCHAR * | frame, | ||
| UINT | len | ||
| ) |
| INT wifi_applyGASConfiguration | ( | wifi_GASConfiguration_t * | input_struct | ) |
| INT wifi_pushApRoamingConsortiumElement | ( | INT | apIndex, |
| wifi_roamingConsortiumElement_t * | infoElement | ||
| ) |
| INT wifi_getApRoamingConsortiumElement | ( | INT | apIndex, |
| wifi_roamingConsortiumElement_t * | infoElement | ||
| ) |
| INT wifi_getTWTsessions | ( | INT | ap_index, |
| UINT | maxNumberSessions, | ||
| wifi_twt_sessions_t * | twtSessions, | ||
| UINT * | numSessionReturned | ||
| ) |
get all the TWT session(individual or Broadcast) connected to that AP Index .
| [in] | ap_index | access point index |
| [in] | maxNumberSessions | maximum number of session to copy in the list |
| [out] | twtSessions | pointer to the sessions information |
| [out] | numSessionReturned | num of seesion copied the list |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| INT wifi_setBroadcastTWTSchedule | ( | INT | ap_index, |
| wifi_twt_params_t | twtParams, | ||
| BOOL | create, | ||
| INT * | sessionID | ||
| ) |
Create or update a broadcast TWT Session
| [in] | ap_index | access point index |
| [in] | twtParams | twt params to create or update a broadcast TWT session |
| [in] | create | Flag to indicate if it should create a new broadcast TWT Session |
| [in/out] | sessionID Input when create flag is false and session exist; and output when create flag is true, in this case sessionID is the ID for the new session |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
teardown the individual session or the broadcast session associate to the MAC
| [in] | ap_index | access point index |
| [in] | sessionID | TWT session to be teardown |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| INT wifi_createVAP | ( | wifi_radio_index_t | index, |
| wifi_vap_info_map_t * | map | ||
| ) |
| INT wifi_getRadioVapInfoMap | ( | wifi_radio_index_t | index, |
| wifi_vap_info_map_t * | map | ||
| ) |
| INT wifi_updateLibHostApdConfig | ( | int | apIndex | ) |
| INT wifi_vapstatus_callback_register | ( | wifi_vapstatus_callback | callback | ) |
VAP Status call back registration function.
| [in] | callback | wifi_vapstatus_callback callback function |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| INT wifi_hal_analytics_callback_register | ( | wifi_analytics_callback | callback | ) |
VAP Status call back registration function.
| [in] | callback | wifi_analytics_callback callback function |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
To get Band Steering enable status.
| [out] | enable | Band Steering enable status, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
To turn on/off Band steering.
| [in] | enable | Band Steering enable status |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| INT wifi_getBandSteeringApGroup | ( | char * | output_ApGroup | ) |
To get Band Steering Access Point group.
| [out] | output_ApGroup | Band Steering Access point group |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| INT wifi_setBandSteeringApGroup | ( | char * | ApGroup | ) |
To set Band Steering Access Point group.
| [in] | ApGroup | - Band Steering Access Point group |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
To set and read the band steering BandUtilizationThreshold parameters.
| [in] | radioIndex | Radio Index |
| [out] | pBuThreshold | Steering bane utilization threshold, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
To set the band steering BandUtilizationThreshold parameters.
| [in] | radioIndex | Radio Index |
| [in] | buThreshold | Steering bane utilization threshold |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
To read the band steering RSSIThreshold parameters.
| [in] | radioIndex | Radio Index |
| [in] | pRssiThreshold | Band steering RSSIThreshold value, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
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
| [in] | radioIndex | Radio Index |
| [in] | rssiThreshold | Band steering RSSIThreshold value |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
To read the band steering physical modulation rate threshold parameters.
| [in] | radioIndex | Radio Index |
| [out] | pPrThreshold | Physical modulation rate threshold value, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
To set the band steering physical modulation rate threshold parameters.
| [in] | radioIndex | Radio Index |
| [in] | prThreshold | Physical modulation rate threshold value |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
To read the inactivity time (in seconds) for steering under overload condition.
| [in] | radioIndex | Radio Index |
| [out] | overloadInactiveTime | inactivity time (in seconds) for steering under overload condition |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
To set the inactivity time (in seconds) for steering under overload condition.
| [in] | radioIndex | Radio Index |
| [in] | overloadInactiveTime | Inactivity time (in seconds) for steering under overload condition |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
To read the inactivity time (in seconds) for steering under Idle condition.
| [in] | radioIndex | Radio Index |
| [out] | idleInactiveTime | Inactivity time (in seconds) for steering under Idle condition |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
To set the inactivity time (in seconds) for steering under Idle condition.
| [in] | radioIndex | Radio Index |
| [in] | idleInactiveTime | Inactivity time (in seconds) for steering under Idle condition |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| INT wifi_getBandSteeringLog | ( | INT | record_index, |
| ULONG * | 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.
| [in] | record_index | Record index |
| [out] | pSteeringTime | Returns the UTC time in seconds |
| [in] | pClientMAC | pClientMAC is pre allocated as 64bytes |
| [in] | pSourceSSIDIndex | Source SSID index |
| [in] | pDestSSIDIndex | Destination SSID index |
| [out] | pSteeringReason | Returns the predefined steering trigger reason |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
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.
| [in] | apIndex | Access Point index |
| [out] | output | HighWatermarkThreshold value, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
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.
| [in] | apIndex | Access Point index |
| [in] | Threshold | HighWatermarkThreshold value |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
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.
| [in] | apIndex | Access Point index |
| [out] | output | Number of times the current total number of associated device has reached the HighWatermarkThreshold value, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Maximum number of associated devices that have ever associated with the access point concurrently since the last reset of the device or WiFi module.
| [in] | apIndex | Access Point index |
| [out] | output | Maximum number of associated devices that have ever associated with the access point concurrently, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
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 AssociatedDevicesHighWatermark updated This dateTime value is in UTC.
| [in] | apIndex | Access Point index |
| [out] | output_in_seconds | Date and Time at which the maximum number of associated devices ever associated with the access point concurrenlty, to be returned. |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Get the Fast Transition capability value.
| apIndex | - AP Index the setting applies to. |
| activate | - 0 = disabled, 1 = full FT support, 2 = adaptive support. |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected. |
Get the Fast Transition over DS activated value.
@description 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.
| [in] | apIndex | - VAP number |
| [in] | value | - Either timeout or retry value |
| [in] | param | - Pramater string name to be configured as follows eapolkey(timeout or retries), eapidentityrequest(timeout or retries), eaprequest(timeout or retries) |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected. |
| INT wifi_getEAP_Param | ( | UINT | apIndex, |
| wifi_eap_config_t * | output | ||
| ) |
Set the Fast Transition over DS activated value. See 802.11-2016 section 13.3.
| apIndex | - AP Index the setting applies to. |
| activate | - True for activated (enabled), false for not activated (disabled). |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected. |
Get the Fast Transition Mobility Domain value. See 802.11-2016 section 13.3.
| apIndex | - AP Index the setting applies to. |
| mobilityDomain | - Value of the FT Mobility Domain for this AP. |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected. |
Set the Fast Transition Mobility Domain value.
See 802.11-2016 section 13.3.
| apIndex | - AP Index the setting applies to. |
| mobilityDomain | - Value of the FT Mobility Domain for this AP. |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected. |
Get the Fast Transition Resource Request Support value. See 802.11-2016 section 13.3.
| apIndex | - AP Index the setting applies to. |
| supported | - True is FT resource request supported, false is not supported. |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected. |
Set the Fast Transition Resource Request Support value.
See 802.11-2016 section 13.3.
| apIndex | - AP Index the setting applies to. |
| suppored | - True is FT resource request supported, false is not supported. |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected. |
Get the Fast Transition R0 Key Lifetime value.
See 802.11-2016 section 13.4.2.
| apIndex | - AP Index the setting applies to. |
| lifetime | - R0 Key Lifetime. |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected. |
Set the Fast Transition R0 Key Lifetime value.
See 802.11-2016 section 13.4.2.
| apIndex | - AP Index the setting applies to. |
| lifetime | - R0 Key Lifetime. |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected. |
Get the Fast Transition R0 Key Holder ID value.
See 802.11-2016 section 13.3.
| apIndex | - AP Index the setting applies to. |
| keyHolderID | - R0 Key Holder ID string. |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected. |
Set the Fast Transition R0 Key Holder ID value.
See 802.11-2016 section 13.3.
| apIndex | - AP Index the setting applies to. |
| keyHolderID | - R0 Key Holder ID string. |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected. |
Get the Fast Transition R1 Key Holder ID value.
See 802.11-2016 section 13.3.
| apIndex | - AP Index the setting applies to. |
| keyHolderID | - R0 Key Holder ID string. |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected. |
Set the Fast Transition R1 Key Holder ID value.
See 802.11-2016 section 13.3.
| apIndex | - AP Index the setting applies to. |
| keyHolderID | - R0 Key Holder ID string. |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected. |
| INT wifi_pushApFastTransitionConfig | ( | INT | apIndex, |
| wifi_FastTransitionConfig_t * | ftData | ||
| ) |
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.
| apIndex | - AP Index the setting applies to. |
| activate | - True for activate false for deactivate. |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected. |
@description Get the BTM capability of activated or deactivated, same as enabled or disabled.
| apIndex | - AP Index the setting applies to. |
| activate | - True for activate false for deactivate. |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected. |
| int wifi_getHalVersion | ( | char * | output_string | ) |
@description Get the wifi hal version in string, eg "2.0.0". WIFI_HAL_MAJOR_VERSION.WIFI_HAL_MINOR_VERSION.WIFI_HAL_MAINTENANCE_VERSION
| output_string | - WiFi Hal version, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_factoryReset | ( | ) |
Clears internal variables to implement a factory reset of the Wi-Fi subsystem.
@description 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.
| None |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
A Specific implementation may dictate some functionalities since different hardware implementations may have different requirements.
| None |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| INT wifi_factoryResetRadios | ( | ) |
Restore all radio parameters without touching access point parameters.
@description Restore all radio parameters without touching access point parameters. Resets Implementation specifics may dictate some functionality since different hardware implementations may have different requirements.
| None |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
A Specific implementation may dictate some functionalities since different hardware implementations may have different requirements.
| None |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| INT wifi_factoryResetRadio | ( | int | radioIndex | ) |
Restore selected radio parameters without touching access point parameters.
@description Restore selected radio parameters without touching access point parameters
| radioIndex | - Index of Wi-Fi Radio channel |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| radioIndex | Index of Wi-Fi Radio channel |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int wifi_setLED | ( | int | radioIndex, |
| unsigned char | enable | ||
| ) |
Set the system LED status.
@description Set the system LED status
| radioIndex | - Index of Wi-Fi Radio channel |
| enable | - LED status |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| radioIndex | Index of Wi-Fi Radio channel |
| enable | LED status |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected |
| int wifi_init | ( | ) |
This function call initializes all Wi-Fi radios.
@description This function call initializes all Wi-Fi radios. Implementation specifics may dictate the functionality since different hardware implementations may have different initilization requirements.
| None |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
A specific implementation may dictate some functionality since different hardware implementations may have different initilization requirements.
| None |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_reset | ( | ) |
Resets the Wifi subsystem. This includes reset of all Access Point variables.
@description 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.
| None |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Implementation specifics may dictate what is actualy reset since different hardware implementations may have different requirements.
| None |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_down | ( | ) |
Turns off transmit power for the entire Wifi subsystem, for all radios.
@description 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.
| None |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Implementation specifics may dictate some functionality since different hardware implementations may have different requirements.
| None |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_createInitialConfigFiles | ( | ) |
This function creates wifi configuration files.
@description 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.
| None |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
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.
| None |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioCountryCode | ( | int | radioIndex, |
| char * | output_string | ||
| ) |
@description Outputs the country code to a max 64 character string
| radioIndex | - Index of Wi-Fi radio channel |
| output_string | - Country code, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setRadioCountryCode | ( | int | radioIndex, |
| char * | CountryCode | ||
| ) |
@description Set the country code for selected Wi-Fi radio channel.
| radioIndex | - Index of Wi-Fi radio channel |
| CountryCode | - Country code |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioNumberOfEntries | ( | unsigned long * | output | ) |
@description Get the total number of radios in this wifi subsystem
| output | - Total no. of radios, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getSSIDNumberOfEntries | ( | unsigned long * | output | ) |
@description Get the total number of SSID entries in this wifi subsystem
| output | - Total no. of SSID entries, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioEnable | ( | int | radioIndex, |
| unsigned char * | output_bool | ||
| ) |
@description Get the Radio enable config parameter
| radioIndex | - Index of Wi-Fi radio channel |
| output_bool | - Radio Enable status, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setRadioEnable | ( | int | radioIndex, |
| unsigned char | enable | ||
| ) |
@description Set the Radio enable config parameter
| radioIndex | - Index of Wi-Fi radio channel |
| enable | - Set the selected radio's status as Enable/Disable |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioStatus | ( | int | radioIndex, |
| unsigned char * | output_bool | ||
| ) |
@description Get the Radio enable status
| radioIndex | - Index of Wi-Fi radio channel |
| output_bool | - Selected radio's enable status, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioIfName | ( | int | radioIndex, |
| char * | output_string | ||
| ) |
@description Get the Radio Interface name from platform, eg "wifi0"
| radioIndex | - Index of Wi-Fi radio channel |
| output_string | - Interface name, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioMaxBitRate | ( | int | radioIndex, |
| char * | output_string | ||
| ) |
@description 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.
| radioIndex | - Index of Wi-Fi radio channel |
| output_string | - Maximum bit rate supported, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioSupportedFrequencyBands | ( | int | radioIndex, |
| char * | output_string | ||
| ) |
@description 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.
| radioIndex | - Index of Wi-Fi radio channel |
| output_string | - Supported frequency bands, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioOperatingFrequencyBand | ( | int | radioIndex, |
| char * | output_string | ||
| ) |
@description 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.
| radioIndex | - Index of Wi-Fi radio channel |
| output_string | - Operating frequency band, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioSupportedStandards | ( | int | radioIndex, |
| char * | output_string | ||
| ) |
@description 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.
| radioIndex | - Index of Wi-Fi radio channel |
| output_string | - Supported radio mode, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioStandard | ( | int | radioIndex, |
| char * | output_string, | ||
| unsigned char * | gOnly, | ||
| unsigned char * | nOnly, | ||
| unsigned char * | acOnly | ||
| ) |
@description 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.
| 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" |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setRadioChannelMode | ( | int | radioIndex, |
| char * | channelMode, | ||
| unsigned char | gOnlyFlag, | ||
| unsigned char | nOnlyFlag, | ||
| unsigned char | acOnlyFlag | ||
| ) |
@description Set the radio operating mode, and pure mode flag.
| 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 |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioPossibleChannels | ( | int | radioIndex, |
| char * | output_string | ||
| ) |
@description 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.
| radioIndex | - Index of Wi-Fi radio channel |
| output_string | - List of supported radio channels, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioChannelsInUse | ( | int | radioIndex, |
| char * | output_string | ||
| ) |
@description 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.
| radioIndex | - Index of Wi-Fi radio channel |
| output_string | - List of supported radio channels, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioChannel | ( | int | radioIndex, |
| unsigned long * | output_ulong | ||
| ) |
@description Get the running channel number.
| radioIndex | - Index of Wi-Fi radio channel |
| output_ulong | - Running channel number, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setRadioChannel | ( | int | radioIndex, |
| unsigned long | channel | ||
| ) |
@description Set the running channel number.
| radioIndex | - Index of Wi-Fi radio channel |
| channel | - Channel number to be set as running wifi radio channel |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setRadioAutoChannelEnable | ( | int | radioIndex, |
| unsigned char | enable | ||
| ) |
@description 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))
| radioIndex | - Index of Wi-Fi radio channel |
| enable | - Enable/Disable selected radio channel as auto channel radio |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioAutoChannelSupported | ( | int | radioIndex, |
| unsigned char * | output_bool | ||
| ) |
@description Check if the driver support the AutoChannel.
Device.WiFi.Radio.{i}.AutoChannelSupported
| radioIndex | - Index of Wi-Fi radio channel |
| BOOL | *output_bool - Value of Auto Channel Supported, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioAutoChannelEnable | ( | int | radioIndex, |
| unsigned char * | output_bool | ||
| ) |
@description Get the AutoChannel enable status.
| radioIndex | - Index of Wi-Fi radio channel |
| BOOL | *output_bool - Auto Channel Enabled status, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioDCSSupported | ( | int | radioIndex, |
| unsigned char * | output_bool | ||
| ) |
@description Device.WiFi.Radio.{i}.X_COMCAST-COM_DCSSupported. Check if the driver support the DCS
| radioIndex | - Index of Wi-Fi radio channel |
| output_bool | - DCS Supported flag for the radio index, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioDCSEnable | ( | int | radioIndex, |
| unsigned char * | output_bool | ||
| ) |
@description Get DCS of the selected wifi radio channel's enable/disable status.
Device.WiFi.Radio.{i}.X_COMCAST-COM_DCSEnable
| radioIndex | - Index of Wi-Fi radio channel |
| output_bool | - DCS Enable flag for the selected radio index, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setRadioDCSEnable | ( | int | radioIndex, |
| unsigned char | enable | ||
| ) |
@description Enable/Disable selected wifi radio channel's DCS.
Device.WiFi.Radio.{i}.X_COMCAST-COM_DCSEnable
| radioIndex | - Index of Wi-Fi radio channel |
| enable | - Set the value of DCS Enable flag for the selected radio index |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioDCSChannelPool | ( | int | radioIndex, |
| char * | output_pool | ||
| ) |
@description 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.
| radioIndex | - Index of Wi-Fi radio channel |
| output_pool | - DCS channel pool for the selected radio index,to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setRadioDCSChannelPool | ( | int | radioIndex, |
| char * | pool | ||
| ) |
@description 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.
| radioIndex | - Index of Wi-Fi radio channel |
| pool | - Set DCS channel pool for the selected radio index |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioDCSScanTime | ( | int | radioIndex, |
| int * | output_interval_seconds, | ||
| int * | output_dwell_milliseconds | ||
| ) |
@description Get radio DCS scan time.
| 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 |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setRadioDCSScanTime | ( | int | radioIndex, |
| int | interval_seconds, | ||
| int | dwell_milliseconds | ||
| ) |
@description Set radio DCS scan time.
| radioIndex | - Index of Wi-Fi radio channel |
| interval_seconds | - Set the interval time in seconds |
| dwell_milliseconds | - Set the dwell time in milliseconds |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioDfsSupport | ( | int | radioIndex, |
| unsigned char * | output_bool | ||
| ) |
@description Get radio DFS support.
Device.WiFi.Radio.{i}.X_COMCAST-COM_DfsSupported
| radioIndex | - Index of Wi-Fi radio channel |
| output_bool | - Get DFS support for the selected radio index in the pre-allocated buffer |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioDfsEnable | ( | int | radioIndex, |
| unsigned char * | output_bool | ||
| ) |
@description Get the Dfs enable status. Data model parameter used to check the DFS enable status is,
Device.WiFi.Radio.{i}.X_COMCAST-COM_DfsEnable
| radioIndex | - Index of Wi-Fi radio channel |
| output_bool | - Get DFS Enable status of the selected radio channel |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setRadioDfsEnable | ( | int | radioIndex, |
| unsigned char | enabled | ||
| ) |
@description Set the Dfs enable status. Data model parameter used to check the DFS enable status is "Device.WiFi.Radio.{i}.X_COMCAST-COM_DfsEnable".
| radioIndex | - Index of Wi-Fi radio channel |
| enable | - Set DFS Enable status of the selected radio channel |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioAutoChannelRefreshPeriodSupported | ( | int | radioIndex, |
| unsigned char * | output_bool | ||
| ) |
@description Check if the driver support the AutoChannelRefreshPeriod.
| 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. |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioAutoChannelRefreshPeriod | ( | int | radioIndex, |
| unsigned long * | output_ulong | ||
| ) |
@description Check if the driver support the AutoChannelRefreshPeriod.
| 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. |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setRadioAutoChannelRefreshPeriod | ( | int | radioIndex, |
| unsigned long | seconds | ||
| ) |
@description Set the DCS refresh period in seconds.
| radioIndex | - Index of Wi-Fi radio channel |
| seconds | - Set auto channel refresh period in seconds support for the selected radio channel |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioOperatingChannelBandwidth | ( | int | radioIndex, |
| char * | output_string | ||
| ) |
@description 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.
| radioIndex | - Index of Wi-Fi radio channel |
| output_string | - Get operating channel bandwidth for the selected radio channel in the pre-allocated char buffer |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setRadioOperatingChannelBandwidth | ( | int | radioIndex, |
| char * | bandwidth | ||
| ) |
@description Set the Operating Channel Bandwidth. eg "20MHz", "40MHz", "80MHz", "80+80", "160".
| radioIndex | - Index of Wi-Fi radio channel |
| bandwidth | - Set operating channel bandwidth for the selected radio channel |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioExtChannel | ( | int | radioIndex, |
| char * | output_string | ||
| ) |
@description 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
| radioIndex | - Index of Wi-Fi radio channel |
| output_string | - Secondary extension channel position, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setRadioExtChannel | ( | int | radioIndex, |
| char * | string | ||
| ) |
@description Set the secondary extension channel position, "AboveControlChannel" or "BelowControlChannel". (this is for 40MHz and 80MHz bandwith only).
Device.WiFi.Radio.{i}.ExtensionChannel
| radioIndex | - Index of Wi-Fi radio channel |
| string | - Secondary extension channel position |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioGuardInterval | ( | int | radioIndex, |
| char * | output_string | ||
| ) |
@description 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
| radioIndex | - Index of Wi-Fi radio channel |
| output_string | - Guard interval value, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setRadioGuardInterval | ( | int | radioIndex, |
| char * | string | ||
| ) |
@description Set the guard interval value. eg "400nsec" or "800nsec".
Device.WiFi.Radio.{i}.GuardInterval
| radioIndex | - Index of Wi-Fi radio channel |
| string | - Guard interval value |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioMCS | ( | int | radioIndex, |
| int * | output_INT | ||
| ) |
@description Get the Modulation Coding Scheme index, eg: "-1", "1", "15".
Device.WiFi.Radio.{i}.MCS
| radioIndex | - Index of Wi-Fi radio channel |
| output_INT | - Modulation Coding Scheme index, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setRadioMCS | ( | int | radioIndex, |
| int | MCS | ||
| ) |
@description Set the Modulation Coding Scheme index, eg: "-1", "1", "15".
Device.WiFi.Radio.{i}.MCS
| radioIndex | - Index of Wi-Fi radio channel |
| MCS | - Modulation Coding Scheme index value |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioTransmitPowerSupported | ( | int | radioIndex, |
| char * | output_list | ||
| ) |
@description 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
| radioIndex | - Index of Wi-Fi radio channel |
| output_list | - Transmit power list, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioTransmitPower | ( | int | radioIndex, |
| unsigned long * | output_ulong | ||
| ) |
@description 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
| radioIndex | - Index of Wi-Fi radio channel |
| ULONG | *output_ulong - Current Transmit power value, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setRadioTransmitPower | ( | int | radioIndex, |
| unsigned long | TransmitPower | ||
| ) |
@description 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
| radioIndex | - Index of Wi-Fi radio channel |
| TransmitPower | - Transmit power value |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioIEEE80211hSupported | ( | int | radioIndex, |
| unsigned char * | Supported | ||
| ) |
@description Get 80211h Supported.
80211h solves interference with satellites and radar using the same 5 GHz frequency band.
Device.WiFi.Radio.{i}.IEEE80211hSupported
| radioIndex | - Index of Wi-Fi radio channel |
| Supported | - 80211h Supported, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioIEEE80211hEnabled | ( | int | radioIndex, |
| unsigned char * | enable | ||
| ) |
@description Get 80211h feature enable.
Device.WiFi.Radio.{i}.IEEE80211hEnabled
| radioIndex | - Index of Wi-Fi radio channel |
| enable | - 80211h feature enable, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setRadioIEEE80211hEnabled | ( | int | radioIndex, |
| unsigned char | enable | ||
| ) |
@description Set 80211h feature enable.
Device.WiFi.Radio.{i}.IEEE80211hEnabled
| radioIndex | - Index of Wi-Fi radio channel |
| enable | - 80211h feature enable |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioCarrierSenseThresholdRange | ( | int | radioIndex, |
| int * | output | ||
| ) |
@description 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
| radioIndex | - Index of Wi-Fi radio channel |
| output | - Carrier sense threshold range, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioCarrierSenseThresholdInUse | ( | int | radioIndex, |
| int * | output | ||
| ) |
@description 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
| radioIndex | - Index of Wi-Fi radio channel |
| output | - Carrier sense threshold in use, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setRadioCarrierSenseThresholdInUse | ( | int | radioIndex, |
| int | threshold | ||
| ) |
@description 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
| radioIndex | - Index of Wi-Fi radio channel |
| threshold | - Carrier sense threshold, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioBeaconPeriod | ( | int | radioIndex, |
| unsigned int * | output | ||
| ) |
@description Time interval between transmitting beacons (expressed in milliseconds). This parameter is based ondot11BeaconPeriod from [802.11-2012].
Device.WiFi.Radio.{i}.BeaconPeriod
| radioIndex | - Index of Wi-Fi radio channel |
| output | - Radio Beacon period, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setRadioBeaconPeriod | ( | int | radioIndex, |
| unsigned int | BeaconPeriod | ||
| ) |
@description Time interval between transmitting beacons (expressed in milliseconds). This parameter is based ondot11BeaconPeriod from [802.11-2012].
Device.WiFi.Radio.{i}.BeaconPeriod
| radioIndex | - Index of Wi-Fi radio channel |
| BeaconPeriod | - Radio Beacon period |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioBasicDataTransmitRates | ( | int | radioIndex, |
| char * | output | ||
| ) |
@description 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
| radioIndex | - Index of Wi-Fi radio channel |
| output | - Comma-separated list of strings, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setRadioBasicDataTransmitRates | ( | int | radioIndex, |
| char * | TransmitRates | ||
| ) |
@description 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
| radioIndex | - Index of Wi-Fi radio channel |
| TransmitRates | - Comma-separated list of strings |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioTrafficStats2 | ( | int | radioIndex, |
| wifi_radioTrafficStats2_t * | output_struct | ||
| ) |
@description Get detail radio traffic static info.
| radioIndex | - Index of Wi-Fi radio channel |
| output_struct | - wifi_radioTrafficStats2_t *output_struct, all traffic stats info to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setRadioTrafficStatsMeasure | ( | int | radioIndex, |
| wifi_radioTrafficStatsMeasure_t * | input_struct | ||
| ) |
@description Set radio traffic static Measuring rules.
Device.WiFi.Radio.{i}.Stats.X_COMCAST-COM_RadioStatisticsMeasuringRate
Device.WiFi.Radio.{i}.Stats.X_COMCAST-COM_RadioStatisticsMeasuringInterval
| radioIndex | - Index of Wi-Fi radio channel |
| input_struct | - wifi_radioTrafficStatsMeasure_t *input_struct, traffic stats measure info |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setRadioTrafficStatsRadioStatisticsEnable | ( | int | radioIndex, |
| unsigned char | enable | ||
| ) |
@description Set radio traffic statistics enable.
Device.WiFi.Radio.{i}.Stats.X_COMCAST-COM_RadioStatisticsEnable bool writable
| radioIndex | - Index of Wi-Fi radio channel |
| enable | - Enable/disable, traffic stats statistics |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioStatsReceivedSignalLevel | ( | int | radioIndex, |
| int | signalIndex, | ||
| int * | SignalLevel | ||
| ) |
@description 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 client?s current received signal level MUST be incremented when a client associates with the AP. Additionally, the respective bins associated with each connected client?s current received signal level MUST be incremented at the interval defined by "Radio Statistics Measuring Rate". The histogram?s 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
| radioIndex | - Index of Wi-Fi radio channel |
| signalIndex | - Signal index |
| SignalLevel | - Signal level, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_applyRadioSettings | ( | int | radioIndex | ) |
@description 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).
| radioIndex | - Index of Wi-Fi radio channel |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioResetCount | ( | int | radioIndex, |
| unsigned long * | output_int | ||
| ) |
@description Get the radio reset count.
| radioIndex | - Index of Wi-Fi radio channel |
| output_int | - Reset count, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getSSIDRadioIndex | ( | int | ssidIndex, |
| int * | radioIndex | ||
| ) |
@description Get the radio index associated with the SSID entry.
| ssidIndex | - SSID index |
| radioIndex | - Radio index, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getSSIDEnable | ( | int | ssidIndex, |
| unsigned char * | output_bool | ||
| ) |
@description Get SSID enable configuration parameters (not the SSID enable status).
Device.WiFi.SSID.{i}.Enable
| ssidIndex | - SSID index |
| output_bool | - SSID enable, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setSSIDEnable | ( | int | ssidIndex, |
| unsigned char | enable | ||
| ) |
@description Set SSID enable configuration parameters.
Device.WiFi.SSID.{i}.Enable
| ssidIndex | - SSID index |
| enable | - SSID enable value |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getSSIDStatus | ( | int | ssidIndex, |
| char * | output_string | ||
| ) |
@description Get SSID enable status.
Device.WiFi.SSID.{i}.Status
| ssidIndex | - SSID index |
| output_string | - SSID enable status, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getSSIDName | ( | int | apIndex, |
| char * | output_string | ||
| ) |
@description 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
| apIndex | - Access Point index |
| output_string | - SSID enable status, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setSSIDName | ( | int | apIndex, |
| char * | ssid_string | ||
| ) |
@description Set SSID Name associated with the Access Point index.
Device.WiFi.SSID.{i}.Name
Device.WiFi.SSID.{i}.Alias
| apIndex | - Access Point index |
| ssid_string | - SSID Name |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getBaseBSSID | ( | int | ssidIndex, |
| char * | output_string | ||
| ) |
@description Get the BSSID.
Device.WiFi.SSID.{i}.BSSID
| ssidIndex | - SSID index |
| output_string | - Base BSSID, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getSSIDMACAddress | ( | int | ssidIndex, |
| char * | output_string | ||
| ) |
@description Get the MAC address associated with this Wifi SSID.
Device.WiFi.SSID.{i}.MACAddress
| ssidIndex | - SSID index |
| output_string | - MAC Address, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getSSIDTrafficStats2 | ( | int | ssidIndex, |
| wifi_ssidTrafficStats2_t * | output_struct | ||
| ) |
@description Get the basic SSID traffic static info.
| ssidIndex | - SSID index |
| output_struct | - wifi_ssidTrafficStats2_t *output_struct SSID traffic stats, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_applySSIDSettings | ( | int | ssidIndex | ) |
@description 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).
| ssidIndex | - SSID index |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getNeighboringWiFiDiagnosticResult2 | ( | int | radioIndex, |
| wifi_neighbor_ap2_t ** | neighbor_ap_array, | ||
| unsigned int * | output_array_size | ||
| ) |
@description 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".
| 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 |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getSSIDTrafficStats | ( | int | ssidIndex, |
| wifi_ssidTrafficStats_t * | output_struct | ||
| ) |
Deprecated: used for old RDKB code.
| int wifi_getBasicTrafficStats | ( | int | apIndex, |
| wifi_basicTrafficStats_t * | output_struct | ||
| ) |
Deprecated: used for old RDKB code.
| int wifi_getWifiTrafficStats | ( | int | apIndex, |
| wifi_trafficStats_t * | output_struct | ||
| ) |
Deprecated: used for old RDKB code.
| int wifi_getNeighboringWiFiDiagnosticResult | ( | wifi_neighbor_ap_t ** | neighbor_ap_array, |
| unsigned int * | output_array_size | ||
| ) |
Deprecated: used for old RDKB code.
| int wifi_getAllAssociatedDeviceDetail | ( | int | apIndex, |
| unsigned long * | output_ulong, | ||
| wifi_device_t ** | output_struct | ||
| ) |
Deprecated: used for old RDKB code.
| int wifi_setRadioCtsProtectionEnable | ( | int | apIndex, |
| unsigned char | enable | ||
| ) |
@description Enables CTS protection for the radio used by this AP
| apIndex | - Access Point index |
| enable | - CTS protection enable value |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setRadioObssCoexistenceEnable | ( | int | apIndex, |
| unsigned char | enable | ||
| ) |
@description enables OBSS Coexistence - fall back to 20MHz if necessary for the radio used by this AP.
| apIndex | - Access Point index |
| enable | - OBSS Coexistence enable value |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setRadioFragmentationThreshold | ( | int | apIndex, |
| unsigned int | threshold | ||
| ) |
@description Sets the fragmentation threshold in bytes for the radio used by this AP.
| apIndex | - Access Point index |
| threshold | - Fragmentation Threshold value |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setRadioSTBCEnable | ( | int | radioIndex, |
| unsigned char | STBC_Enable | ||
| ) |
@description Enable STBC mode in the hardware, 0 == not enabled, 1 == enabled.
| radioIndex | - Radio index |
| STBC_Enable | - STBC mode enable value |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioAMSDUEnable | ( | int | radioIndex, |
| unsigned char * | output_bool | ||
| ) |
@description Outputs A-MSDU enable status, 0 == not enabled, 1 == enabled.
| radioIndex | - Radio index |
| output_bool | - A-MSDU enable status, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setRadioAMSDUEnable | ( | int | radioIndex, |
| unsigned char | amsduEnable | ||
| ) |
@description Enables A-MSDU in the hardware, 0 == not enabled, 1 == enabled.
| radioIndex | - Radio index |
| amsduEnable | - A-MSDU enable status value |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioTxChainMask | ( | int | radioIndex, |
| int * | output_int | ||
| ) |
@description Outputs the number of Tx streams.
| radioIndex | - Radio index |
| output_int | - Number of Tx streams, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setRadioTxChainMask | ( | int | radioIndex, |
| int | numStreams | ||
| ) |
@description Sets the number of Tx streams to an enviornment variable.
| radioIndex | - Radio index |
| numStreams | - Number of Tx streams |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioRxChainMask | ( | int | radioIndex, |
| int * | output_int | ||
| ) |
@description Outputs the number of Rx streams.
| radioIndex | - Radio index |
| output_int | - Number of Rx streams, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setRadioRxChainMask | ( | int | radioIndex, |
| int | numStreams | ||
| ) |
@description Sets the number of Rx streams to an enviornment variable.
| radioIndex | - Radio index |
| numStreams | - Number of Rx streams |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_pushBridgeInfo | ( | int | apIndex | ) |
Deprecated
| int wifi_pushRadioChannel | ( | int | radioIndex, |
| unsigned int | channel | ||
| ) |
Deprecated
| int wifi_pushRadioChannelMode | ( | int | radioIndex | ) |
Deprecated
| int wifi_pushRadioTxChainMask | ( | int | radioIndex | ) |
Deprecated
| int wifi_pushRadioRxChainMask | ( | int | radioIndex | ) |
Deprecated
| int wifi_pushSSID | ( | int | apIndex, |
| char * | ssid | ||
| ) |
@description Push the enviornment varible that is set by "wifi_setSsidName" to the hardware.
| apIndex | - Access Point index |
| ssid | - WiFi SSID value |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_pushSsidAdvertisementEnable | ( | int | apIndex, |
| unsigned char | enable | ||
| ) |
@description Push the enviornment varible that is set by "wifi_setApSsidAdvertisementEnable" to the hardware.
| apIndex | - Access Point index |
| enable | - SSID Advertisement value |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioUpTime | ( | int | radioIndex, |
| unsigned long * | uptime | ||
| ) |
@description Get the number of seconds elapsed since radio is started.
| radioIndex | - Radio index |
| uptime | - Wifi uptime, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioReverseDirectionGrantSupported | ( | int | radioIndex, |
| unsigned char * | output_bool | ||
| ) |
@description Get radio RDG enable Support.
| radioIndex | - Radio index |
| output_bool | - RDG enable support value, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioReverseDirectionGrantEnable | ( | int | radioIndex, |
| unsigned char * | output_bool | ||
| ) |
@description Get radio RDG enable setting.
| radioIndex | - Radio index |
| output_bool | - RDG enable setting value, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setRadioReverseDirectionGrantEnable | ( | int | radioIndex, |
| unsigned char | enable | ||
| ) |
@description Set radio RDG enable setting.
| radioIndex | - Radio index |
| enable | - RDG enable setting value |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioDeclineBARequestEnable | ( | int | radioIndex, |
| unsigned char * | output_bool | ||
| ) |
@description Get radio ADDBA (ADD Block Acknowledgement) enable setting.
| radioIndex | - Radio index |
| output_bool | - Radio ADDBA enable setting value, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setRadioDeclineBARequestEnable | ( | int | radioIndex, |
| unsigned char | enable | ||
| ) |
@description Set radio ADDBA (ADD Block Acknowledgement) enable setting.
| radioIndex | - Radio index |
| enable | - Radio ADDBA enable setting value |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioAutoBlockAckEnable | ( | int | radioIndex, |
| unsigned char * | output_bool | ||
| ) |
@description Get radio auto block ack enable setting.
| radioIndex | - Radio index |
| output_bool | - Auto block ack enable setting value, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setRadioAutoBlockAckEnable | ( | int | radioIndex, |
| unsigned char | enable | ||
| ) |
@description Set radio auto block ack enable setting.
| radioIndex | - Radio index |
| enable | - Auto block ack enable setting value |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadio11nGreenfieldSupported | ( | int | radioIndex, |
| unsigned char * | output_bool | ||
| ) |
@description Get radio 11n pure mode enable support.
| radioIndex | - Radio index |
| output_bool | - Radio 11n pure mode enable support value, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadio11nGreenfieldEnable | ( | int | radioIndex, |
| unsigned char * | output_bool | ||
| ) |
@description Get radio 11n pure mode enable setting.
| radioIndex | - Radio index |
| output_bool | - Radio 11n pure mode enable setting, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setRadio11nGreenfieldEnable | ( | int | radioIndex, |
| unsigned char | enable | ||
| ) |
@description Set radio 11n pure mode enable setting.
| radioIndex | - Radio index |
| enable | - Radio 11n pure mode enable setting |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getRadioIGMPSnoopingEnable | ( | int | radioIndex, |
| unsigned char * | output_bool | ||
| ) |
@description Get radio IGMP snooping enable setting.
| radioIndex | - Radio index |
| output_bool | - Radio IGMP snooping enable setting, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setRadioIGMPSnoopingEnable | ( | int | radioIndex, |
| unsigned char | enable | ||
| ) |
@description Set radio IGMP snooping enable setting.
| radioIndex | - Radio index |
| enable | - Radio IGMP snooping enable setting |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_createAp | ( | int | apIndex, |
| int | radioIndex, | ||
| char * | essid, | ||
| unsigned char | hideSsid | ||
| ) |
@description creates a new ap and pushes these parameters to the hardware.
| apIndex | - Access Point index |
| radioIndex | - Radio index |
| essid | - SSID Name |
| hideSsid | - True/False, to SSID advertisement enable value |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_deleteAp | ( | int | apIndex | ) |
@description Deletes this ap entry on the hardware, clears all internal variables associaated with this ap.
| apIndex | - Access Point index |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getApName | ( | int | apIndex, |
| char * | output_string | ||
| ) |
@description Outputs a 16 byte or less name assocated with the AP.
String buffer must be pre-allocated by the caller.
| apIndex | - Access Point index |
| output_string | - Access Point name, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getApIndexFromName | ( | char * | inputSsidString, |
| int * | ouput_int | ||
| ) |
@description Outputs the index number in that corresponds to the SSID string.
| inputSsidString | - WiFi SSID Name |
| ouput_int | - Access Point index, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getApBeaconType | ( | int | apIndex, |
| char * | output_string | ||
| ) |
@description Outputs a 32 byte or less string indicating the beacon type as "None", "Basic", "WPA", "11i", "WPAand11i".
| apIndex | - Access Point index |
| output_string | - Beacon type, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setApBeaconType | ( | int | apIndex, |
| char * | beaconTypeString | ||
| ) |
@description Sets the beacon type enviornment variable. Allowed input strings are "None", "Basic", "WPA, "11i", "WPAand11i".
| apIndex | - Access Point index |
| beaconTypeString | - Beacon type |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setApBeaconInterval | ( | int | apIndex, |
| int | beaconInterval | ||
| ) |
@description Sets the beacon interval on the hardware for this AP.
| apIndex | - Access Point index |
| beaconInterval | - Beacon interval |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setApDTIMInterval | ( | int | apIndex, |
| int | dtimInterval | ||
| ) |
@description Sets the DTIM interval for this AP.
| apIndex | - Access Point index |
| dtimInterval | - DTIM interval |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getApRtsThresholdSupported | ( | int | apIndex, |
| unsigned char * | output_bool | ||
| ) |
@description Get the packet size threshold supported.
| apIndex | - Access Point index |
| output_bool | - Packet size threshold supported, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setApRtsThreshold | ( | int | apIndex, |
| unsigned int | threshold | ||
| ) |
@description Sets the packet size threshold in bytes to apply RTS/CTS backoff rules.
| apIndex | - Access Point index |
| threshold | - Packet size threshold |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getApWpaEncryptoinMode | ( | int | apIndex, |
| char * | output_string | ||
| ) |
@description ouputs up to a 32 byte string as either "TKIPEncryption", "AESEncryption", or "TKIPandAESEncryption".
| apIndex | - Access Point index |
| output_string | - WPA Encryption mode, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setApWpaEncryptionMode | ( | int | apIndex, |
| char * | encMode | ||
| ) |
@description Sets the encyption mode enviornment variable. Valid string format is "TKIPEncryption", "AESEncryption", or "TKIPandAESEncryption".
| apIndex | - Access Point index |
| encMode | - WPA Encryption mode |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_removeApSecVaribles | ( | int | apIndex | ) |
@description Deletes internal security varable settings for this ap.
| apIndex | - Access Point index |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_disableApEncryption | ( | int | apIndex | ) |
@description changes the hardware settings to disable encryption on this ap.
| apIndex | - Access Point index |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setApAuthMode | ( | int | apIndex, |
| int | mode | ||
| ) |
@description Set the authorization mode on this ap. mode mapping as: 1: open, 2: shared, 4:auto.
| apIndex | - Access Point index |
| mode | - Authorization mode |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setApBasicAuthenticationMode | ( | int | apIndex, |
| char * | authMode | ||
| ) |
@description Sets an enviornment variable for the authMode. Valid strings are "None", "EAPAuthentication" or "SharedAuthentication".
| apIndex | - Access Point index |
| authMode | - Authentication mode |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getApNumDevicesAssociated | ( | int | apIndex, |
| unsigned long * | output_ulong | ||
| ) |
@description Outputs the number of stations associated per AP.
| apIndex | - Access Point index |
| output_ulong | - Number of stations, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_kickApAssociatedDevice | ( | int | apIndex, |
| char * | client_mac | ||
| ) |
@description Manually removes any active wi-fi association with the device specified on this ap.
| apIndex | - Access Point index |
| client_mac | - Client device MAC address |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getApRadioIndex | ( | int | apIndex, |
| int * | output_int | ||
| ) |
@description Outputs the radio index for the specified ap.
| apIndex | - Access Point index |
| output_int | - Radio index, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setApRadioIndex | ( | int | apIndex, |
| int | radioIndex | ||
| ) |
@description Sets the radio index for the specific ap.
| apIndex | - Access Point index |
| radioIndex | - Radio index |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getApAclDevices | ( | int | apIndex, |
| char * | macArray, | ||
| unsigned int | buf_size | ||
| ) |
@description Get the ACL MAC list per AP.
| apIndex | - Access Point index |
| macArray | - Mac Array list, to be returned |
| buf_size | - Buffer size for the mac array list |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_addApAclDevice | ( | int | apIndex, |
| char * | DeviceMacAddress | ||
| ) |
@description Adds the mac address to the filter list.
| apIndex | - Access Point index |
| DeviceMacAddress | - Mac Address of a device |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_delApAclDevice | ( | int | apIndex, |
| char * | DeviceMacAddress | ||
| ) |
@description Deletes the mac address from the filter list.
| apIndex | - Access Point index |
| DeviceMacAddress | - Mac Address of a device |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getApAclDeviceNum | ( | int | apIndex, |
| unsigned int * | output_uint | ||
| ) |
@description Outputs the number of devices in the filter list.
| apIndex | - Access Point index |
| output_uint | - Number of devices, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_kickApAclAssociatedDevices | ( | int | apIndex, |
| unsigned char | enable | ||
| ) |
@description Enable kick for devices on acl black list.
| apIndex | - Access Point index |
| enable | - Enable/disable kick for devices on acl black list |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setApMacAddressControlMode | ( | int | apIndex, |
| int | filterMode | ||
| ) |
@description Sets the mac address filter control mode. 0 == filter disabled, 1 == filter as whitelist, 2 == filter as blacklist.
| apIndex | - Access Point index |
| filterMode | - Mac Address filter control mode |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setApVlanEnable | ( | int | apIndex, |
| unsigned char | VlanEnabled | ||
| ) |
@description 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.
| apIndex | - Access Point index |
| VlanEnabled | - Internal gateway VLAN mode |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setApVlanID | ( | int | apIndex, |
| int | vlanId | ||
| ) |
@description Sets the vlan ID for this ap to an internal enviornment variable.
| apIndex | - Access Point index |
| vlanId | - VLAN ID |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getApBridgeInfo | ( | int | index, |
| char * | bridgeName, | ||
| char * | IP, | ||
| char * | subnet | ||
| ) |
@description Gets bridgeName, IP address and Subnet.BridgeName is a maximum of 32 characters.
| index | - Access Point index |
| bridgeName | - Bridge name, to be returned |
| IP | - IP Address, to be returned |
| subnet | - Subnet, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setApBridgeInfo | ( | int | apIndex, |
| char * | bridgeName, | ||
| char * | IP, | ||
| char * | subnet | ||
| ) |
@description Sets bridgeName, IP address and Subnet to internal enviornment variables. BridgeName is a maximum of 32 characters.
| apIndex | - Access Point index |
| bridgeName | - Bridge name |
| IP | - IP Address |
| subnet | - Subnet |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_resetApVlanCfg | ( | int | apIndex | ) |
@description Reset the vlan configuration for this ap.
| apIndex | - Access Point index |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_createHostApdConfig | ( | int | apIndex, |
| unsigned char | createWpsCfg | ||
| ) |
Creates configuration variables needed for WPA/WPS.
@description 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.
| apIndex | - Access Point index |
| createWpsCfg | - Enable/Disable WPS Configuration creation |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
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.
| [in] | apIndex | Access Point index |
| [in] | createWpsCfg | Enable/Disable WPS Configuration creation |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_startHostApd | ( | ) |
Starts hostapd.
@description Starts hostapd, uses the variables in the hostapd config with format compatible with the specific hostapd implementation.
| None |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Uses the variables in the hostapd config with format compatible with the specific hostapd implementation.
| None |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_stopHostApd | ( | ) |
Stops hostapd.
@description Stops hostapd
| None |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| None |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setApEnable | ( | int | apIndex, |
| unsigned char | enable | ||
| ) |
@description Sets the AP enable status variable for the specified ap.
| apIndex | - Access Point index |
| enable | - Enable/Disable AP enable status variable |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getApEnable | ( | int | apIndex, |
| unsigned char * | output_bool | ||
| ) |
@description Outputs the setting of the internal variable that is set by wifi_setEnable().
| apIndex | - Access Point index |
| output_bool | - AP enable status, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getApStatus | ( | int | apIndex, |
| char * | output_string | ||
| ) |
@description Outputs the AP "Enabled" "Disabled" status from driver.
Device.WiFi.AccessPoint.{i}.Status
| apIndex | - Access Point index |
| output_string | - AP status, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getApSsidAdvertisementEnable | ( | int | apIndex, |
| unsigned char * | output_bool | ||
| ) |
@description 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
| apIndex | - Access Point index |
| output_bool | - SSID Advertisement enabled, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setApSsidAdvertisementEnable | ( | int | apIndex, |
| unsigned char | enable | ||
| ) |
@description Sets an internal variable for ssid advertisement. Set to 1 to enable, set to 0 to disable.
Device.WiFi.AccessPoint.{i}.SSIDAdvertisementEnabled
| apIndex | - Access Point index |
| enable | - SSID Advertisement enable value |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_pushApSsidAdvertisementEnable | ( | int | apIndex, |
| unsigned char | enable | ||
| ) |
@description Push the ssid advertisement enable variable to the hardware //Applying changs with wifi_applyRadioSettings().
| apIndex | - Access Point index |
| enable | - SSID Advertisement enable value |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getApRetryLimit | ( | int | apIndex, |
| unsigned int * | output | ||
| ) |
@description Get the maximum number of retransmission for a packet. This corresponds to IEEE 802.11 parameter dot11ShortRetryLimit.
Device.WiFi.AccessPoint.{i}.RetryLimit
| apIndex | - Access Point index |
| output | - Maximum number of retransmission for a packet, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setApRetryLimit | ( | int | apIndex, |
| unsigned int | number | ||
| ) |
@description Set the maximum number of retransmission for a packet. This corresponds to IEEE 802.11 parameter dot11ShortRetryLimit.
Device.WiFi.AccessPoint.{i}.RetryLimit
| apIndex | - Access Point index |
| number | - Maximum number of retransmission for a packet |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getApWMMCapability | ( | int | apIndex, |
| unsigned char * | output | ||
| ) |
@description Indicates whether this access point supports WiFi Multimedia (WMM) Access Categories (AC).
Device.WiFi.AccessPoint.{i}.WMMCapability
| apIndex | - Access Point index |
| output | - WMM capability, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getApUAPSDCapability | ( | int | apIndex, |
| unsigned char * | output | ||
| ) |
@description 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
| apIndex | - Access Point index |
| output | - U-APSD capability, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getApWmmEnable | ( | int | apIndex, |
| unsigned char * | output | ||
| ) |
@description Indicates whether WMM support is currently enabled. When enabled, this is indicated in beacon frames.
Device.WiFi.AccessPoint.{i}.WMMEnable
| apIndex | - Access Point index |
| output | - WMM support enabled status, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setApWmmEnable | ( | int | apIndex, |
| unsigned char | enable | ||
| ) |
@description Enables/disables WMM on the hardwawre for this AP. enable==1, disable == 0.
| apIndex | - Access Point index |
| enable | - WMM support enabled status |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getApWmmUapsdEnable | ( | int | apIndex, |
| unsigned char * | output | ||
| ) |
@description 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
| apIndex | - Access Point index |
| output | - U-APSD support enabled status, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setApWmmUapsdEnable | ( | int | apIndex, |
| unsigned char | enable | ||
| ) |
@description Enables/disables Automatic Power Save Delivery on the hardwarwe for this AP.
| apIndex | - Access Point index |
| enable | - U-APSD enable/disable value |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setApWmmOgAckPolicy | ( | int | apIndex, |
| int | class, | ||
| unsigned char | ackPolicy | ||
| ) |
@description Sets the WMM ACK policy on the hardware. AckPolicy false means do not acknowledge, true means acknowledge.
| apIndex | - Access Point index |
| class | |
| ackPolicy | - Acknowledge policy |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getApIsolationEnable | ( | int | apIndex, |
| unsigned char * | output | ||
| ) |
@description 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
| apIndex | - Access Point index |
| output | - AP Isolation enable, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setApIsolationEnable | ( | int | apIndex, |
| unsigned char | enable | ||
| ) |
@description 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
| apIndex | - Access Point index |
| enable | - AP Isolation enable value |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getApMaxAssociatedDevices | ( | int | apIndex, |
| unsigned int * | output | ||
| ) |
@description 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
| apIndex | - Access Point index |
| output | - Maximum associated devices, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setApMaxAssociatedDevices | ( | int | apIndex, |
| unsigned int | number | ||
| ) |
@description 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
| apIndex | - Access Point index |
| number | - Maximum associated devices |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getApAssociatedDevicesHighWatermarkThreshold | ( | int | apIndex, |
| unsigned int * | output | ||
| ) |
@description 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
| apIndex | - Access Point index |
| output | - HighWatermarkThreshold value, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setApAssociatedDevicesHighWatermarkThreshold | ( | int | apIndex, |
| unsigned int | Threshold | ||
| ) |
@description 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
| apIndex | - Access Point index |
| Threshold | - HighWatermarkThreshold value |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getApAssociatedDevicesHighWatermarkThresholdReached | ( | int | apIndex, |
| unsigned int * | output | ||
| ) |
@description 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
| apIndex | - Access Point index |
| output | - Number of times the current total number of associated device has reached the HighWatermarkThreshold value, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getApAssociatedDevicesHighWatermark | ( | int | apIndex, |
| unsigned int * | output | ||
| ) |
@description 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
| apIndex | - Access Point index |
| output | - Maximum number of associated devices that have ever associated with the access point concurrently, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getApAssociatedDevicesHighWatermarkDate | ( | int | apIndex, |
| unsigned long * | output_in_seconds | ||
| ) |
@description 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
| 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 |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getApSecurityModesSupported | ( | int | apIndex, |
| char * | output | ||
| ) |
@description 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
| apIndex | - Access Point index |
| output | - Comma-separated list of security modes, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getApSecurityModeEnabled | ( | int | apIndex, |
| char * | output | ||
| ) |
@description 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
| apIndex | - Access Point index |
| output | - Enabled security mode, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setApSecurityModeEnabled | ( | int | apIndex, |
| char * | encMode | ||
| ) |
@description 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
| apIndex | - Access Point index |
| encMode | - Supported security mode |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getApSecurityPreSharedKey | ( | int | apIndex, |
| char * | output_string | ||
| ) |
@description Get PreSharedKey associated with a AP. A literal PreSharedKey (PSK) expressed as a hexadecimal string.
Device.WiFi.AccessPoint.{i}.Security.PreSharedKey
| apIndex | - Access Point index |
| output_string | - PreSharedKey, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setApSecurityPreSharedKey | ( | int | apIndex, |
| char * | preSharedKey | ||
| ) |
@description Set PreSharedKey associated with a AP. A literal PreSharedKey (PSK) expressed as a hexadecimal string.
Device.WiFi.AccessPoint.{i}.Security.PreSharedKey
| apIndex | - Access Point index |
| preSharedKey | - PreSharedKey |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getApSecurityKeyPassphrase | ( | int | apIndex, |
| char * | output_string | ||
| ) |
@description 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
| apIndex | - Access Point index |
| output_string | - Security key passphrase, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setApSecurityKeyPassphrase | ( | int | apIndex, |
| char * | passPhrase | ||
| ) |
@description 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
| apIndex | - Access Point index |
| passPhrase | - Security key passphrase |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setApSecurityReset | ( | int | apIndex | ) |
@description 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
| apIndex | - Access Point index |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getApSecurityRadiusServer | ( | int | apIndex, |
| char * | IP_output, | ||
| unsigned int * | Port_output, | ||
| char * | RadiusSecret_output | ||
| ) |
@description 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
| 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 |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setApSecurityRadiusServer | ( | int | apIndex, |
| char * | IPAddress, | ||
| unsigned int | port, | ||
| char * | RadiusSecret | ||
| ) |
@description 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
| apIndex | - Access Point index |
| IPAddress | - IP Address |
| port | - Port |
| RadiusSecret | - Radius Secret |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getApSecuritySecondaryRadiusServer | ( | int | apIndex, |
| char * | IP_output, | ||
| unsigned int * | Port_output, | ||
| char * | RadiusSecret_output | ||
| ) |
@description 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.
| apIndex | - Access Point index |
| IP_output | - IP Address, to be returned |
| Port_output | - Port,to be returned |
| RadiusSecret_output | - Radius Secret, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setApSecuritySecondaryRadiusServer | ( | int | apIndex, |
| char * | IPAddress, | ||
| unsigned int | port, | ||
| char * | RadiusSecret | ||
| ) |
@description 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.
| apIndex | - Access Point index |
| IPAddress | - IP Address |
| port | - Port |
| RadiusSecret | - Radius Secret |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getApSecurityRadiusSettings | ( | int | apIndex, |
| wifi_radius_setting_t * | output | ||
| ) |
@description Get Access Point security radius settings.
Device.WiFi.AccessPoint.{i}.Security.X_COMCAST-COM_RadiusSettings.
| apIndex | - Access Point index |
| output | - wifi_radius_setting_t info (*output), to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setApSecurityRadiusSettings | ( | int | apIndex, |
| wifi_radius_setting_t * | input | ||
| ) |
@description Set Access Point security radius settings.
Device.WiFi.AccessPoint.{i}.Security.X_COMCAST-COM_RadiusSettings.
| apIndex | - Access Point index |
| input | - wifi_radius_setting_t info |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getApWpsEnable | ( | int | apIndex, |
| unsigned char * | output_bool | ||
| ) |
@description Outputs the WPS enable state of this ap in output_bool.
Device.WiFi.AccessPoint.{i}.WPS.
Device.WiFi.AccessPoint.{i}.WPS.Enable
| apIndex | - Access Point index |
| output_bool | - WPS enable state, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setApWpsEnable | ( | int | apIndex, |
| unsigned char | enableValue | ||
| ) |
@description 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
| apIndex | - Access Point index |
| enableValue | - WPS enable state |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getApWpsConfigMethodsSupported | ( | int | apIndex, |
| char * | output | ||
| ) |
@description 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
| apIndex | - Access Point index |
| output | - WPS configuration methods supported (Comma-separated list of strings), to be returned. |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getApWpsConfigMethodsEnabled | ( | int | apIndex, |
| char * | output_string | ||
| ) |
@description 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
| apIndex | - Access Point index |
| output_string | - WPS configuration methods enabled, to be returned. |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setApWpsConfigMethodsEnabled | ( | int | apIndex, |
| char * | methodString | ||
| ) |
@description 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
| apIndex | - Access Point index |
| methodString | - WPS configuration methods enabled. |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getApWpsDevicePIN | ( | int | apIndex, |
| unsigned long * | output_ulong | ||
| ) |
@description Outputs the WPS device pin value, ulong_pin must be allocated by the caller.
| apIndex | - Access Point index |
| output_ulong | - WPS Device PIN value, to be returned. |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setApWpsDevicePIN | ( | int | apIndex, |
| unsigned long | pin | ||
| ) |
@description Set an enviornment variable for the WPS pin for the selected AP.
| apIndex | - Access Point index |
| pin | - WPS Device PIN value |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getApWpsConfigurationState | ( | int | apIndex, |
| char * | output_string | ||
| ) |
@description Get WPS configuration state. Output string is either Not configured or Configured, max 32 characters.
| apIndex | - Access Point index |
| output_string | - WPS configuration state, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setApWpsEnrolleePin | ( | int | apIndex, |
| char * | pin | ||
| ) |
@description Sets the WPS pin for this AP.
| apIndex | - Access Point index |
| pin | - WPS enroll Pin |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_setApWpsButtonPush | ( | int | apIndex | ) |
@description This function is called when the WPS push button has been pressed for this AP.
| apIndex | - Access Point index |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_cancelApWPS | ( | int | apIndex | ) |
@description Cancels WPS mode for this AP.
| apIndex | - Access Point index |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getApAssociatedDeviceDiagnosticResult | ( | int | apIndex, |
| wifi_associated_dev_t ** | associated_dev_array, | ||
| unsigned int * | output_array_size | ||
| ) |
@description HAL funciton should allocate an data structure array, and return to caller with "associated_dev_array".
Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}.
| apIndex | - Access Point index |
| associated_dev_array | - Associated device array, to be returned |
| output_array_size | - Array size, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| void KillHostapd | ( | ) |
@description Killing the running hostapd and restart the hostapd with current configuration.
| None |
| unsigned char checkWifi | ( | ) |
@description Check whether hostapd is up or not.
| None |
| unsigned char checkLanInterface | ( | ) |
@description Check whether wlan0 interface is up or not.
| None |
| int CcspHal_change_config_value | ( | char * | field_name, |
| char * | field_value, | ||
| char * | buf, | ||
| unsigned int * | nbytes | ||
| ) |
@description Passing inputs to hostapd configuration file.
| field_name | - Field Name |
| field_value | - Field Value |
| buf | - Buffer |
| nbytes | - Size of buffer |
| int do_MacFilter_Addrule | ( | ) |
@description To Add Wifi MacFiltering Rule Chain.
| None |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int do_MacFilter_Delrule | ( | ) |
@description To Delete Wifi MacFiltering Rule Chain.
| None |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int do_MacFilter_Update | ( | char * | Operation, |
| int | i_macFiltCnt, | ||
| COSA_DML_WIFI_AP_MAC_FILTER * | i_macFiltTabPtr, | ||
| int | count, | ||
| struct hostDetails * | hostPtr | ||
| ) |
@description To Update Wifi MacFiltering Rule Chain.
| Operation | - Operation, to update mac filtering rule chain |
| i_macFiltCnt | - MAC filter count |
| i_macFiltTabPtr | - COSA_DML_WIFI_AP_MAC_FILTER *i_macFiltTabPtr, Mac Filter table pointer |
| count | - count |
| hostPtr | - hostDetails *hostPtr, Host Details |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| int wifi_getApIndexForWiFiBand | ( | wifi_band | band | ) |
@description Get the AP index for requested WiFi Band.
| wifi_band | - WiFi band for which AP Index is required |
| 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_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 | ||
| ) |
| void wifi_apAuthEvent_callback_register | ( | wifi_apAuthEvent_callback | callback_proc | ) |
| INT wifi_getRadioChannelStats | ( | INT | radioIndex, |
| wifi_channelStats_t * | input_output_channelStats_array, | ||
| INT | array_size | ||
| ) |
Get the channels utilization status.
| [in] | radioIndex | The index of the radio |
| [in,out] | input_output_channelStats_array | The array initially filled with requested channel numbers. The same array is used as an output with channel statistics details. Data for each channel must be written to the corresponding element of the array. When array_size = 0, the API returns ONCHAN stats in a single wifi_channelStats_t element. |
| [out] | array_size | The length of the output array |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| INT wifi_getApAssociatedDeviceRxStatsResult | ( | INT | radioIndex, |
| mac_address_t * | clientMacAddress, | ||
| wifi_associated_dev_rate_info_rx_stats_t ** | stats_array, | ||
| UINT * | output_array_size, | ||
| ULLONG * | handle | ||
| ) |
Get the associated client per rate receive status.
| [in] | radioIndex | The index of radio array. |
| [in] | clientMacAddress | Client mac address UCHAR[6] |
| [out] | stats_array | Client receive status |
| [out] | output_array_size | The length of output array |
| [out] | handle | Status validation handle used to determine reconnects; increases for every association. |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| INT wifi_getApAssociatedDeviceTxStatsResult | ( | INT | radioIndex, |
| mac_address_t * | clientMacAddress, | ||
| wifi_associated_dev_rate_info_tx_stats_t ** | stats_array, | ||
| UINT * | output_array_size, | ||
| ULLONG * | handle | ||
| ) |
Get the associated client per rate transmission status.
| [in] | radioIndex | The index of radio array. |
| [in] | clientMacAddress | Client mac address UCHAR[6] |
| [out] | stats_array | Client transmission status |
| [out] | output_array_size | The length of output array |
| [out] | handle | Status validation handle used to determine reconnects; increases for every association. |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| INT wifi_getApAssociatedDeviceTidStatsResult | ( | INT | radioIndex, |
| mac_address_t * | clientMacAddress, | ||
| wifi_associated_dev_tid_stats_t * | tid_stats, | ||
| ULLONG * | handle | ||
| ) |
Get the associated client per rate transmission status.
| [in] | radioIndex | The index of radio array |
| [in] | clientMacAddress | client mac address UCHAR[6] |
| [out] | stats | wifi_associated_dev_tid_stats_t *stats, client status |
| [in] | handle | Status validation handle used to determine reconnects incremented for every association |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| INT wifi_getApAssociatedDeviceStats | ( | INT | apIndex, |
| mac_address_t * | clientMacAddress, | ||
| wifi_associated_dev_stats_t * | associated_dev_stats, | ||
| ULLONG * | handle | ||
| ) |
Get the associated device status.
| [in] | apIndex | The index of access point array |
| [in] | clientMacAddress | client mac address UCHAR[6] |
| [out] | associated_dev_stats | Associated device status |
| [in] | handle | Status validation handle used to determine reconnects; increases for every association |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Get the radio index associated with the SSID entry.
| [in] | ssidIndex | SSID index |
| [out] | radioIndex | Radio index, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
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).
| [in] | ssidIndex | SSID index |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| INT wifi_startNeighborScan | ( | INT | apIndex, |
| wifi_neighborScanMode_t | scan_mode, | ||
| INT | dwell_time, | ||
| UINT | chan_num, | ||
| UINT * | chan_list | ||
| ) |
This API initates the scanning.
| [in] | apIndex | The index of access point array. |
| [out] | scan_mode | Scan modes. |
| [out] | dwell_time | Amount of time spent on each channel in the hopping sequence. |
| [out] | chan_num | The channel number. |
| [out] | chan_list | List of channels. |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
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.
This makes that client scan and re-connect faster then if we were to do nothing. This is an "automatic" kick-mac type of functionality, that happens during the CSA process. What happens is that after all clients should have moved to the new channel, and just before the radio moves to the new channel, it will broadcast (or unicast all clients) a deauth packet. This helps clients who don't understand or ignore CSA to quickly realize the ap is gone/moved channels, and to scan and reconnect quickly.
| [in] | apIndex | The index of access point array |
| [in] | mode | Enum value indicates none, unicast, broadcast |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Enable/Disable scan filter in the driver.
When scanfilter is enabled in the driver, we configure two values: enable: yes/no, and essid : <string>. When essid is blank (apIndex==-1), the configured SSID on that interface is used. when it's not empty (apIndex==0 to 15), the filter will apply to whatever ssid is provided.
| [in] | apIndex | The index of access point array |
| [in] | mode | Enum value indicates disabled/enabled |
| [in] | essid | Extended Service Set Identifier |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| void wifi_steerTriggered_callback_register | ( | wifi_steerTriggered_callback | callback_proc, |
| CHAR * | module | ||
| ) |
| INT wifi_steering_eventRegister | ( | wifi_steering_eventCB_t | event_cb | ) |
Register for Steering Event Callbacks.
This is called by the upper layer to register for steering event callbacks.
| [in] | event_cb | Event callback function pointer. |
| INT wifi_steering_eventUnregister | ( | void | ) |
Unregister for Steering Event Callbacks.
This is called by the upper layer to stop receiving event callbacks.
| INT wifi_steering_clientSet | ( | UINT | steeringgroupIndex, |
| INT | apIndex, | ||
| mac_address_t | client_mac, | ||
| wifi_steering_clientConfig_t * | config | ||
| ) |
Add Client Config to apIndex.
The upper layer calls this funciton to add/modify per-client configuration config of client_mac for apIndex
| [in] | steeringgroupIndex | Wifi Steering Group index |
| [in] | apIndex | Accesspoint index the client config should be added to |
| [in] | client_mac | The Client's MAC address. If client_mac is not there, the hal need to add record, else, the hal need to update the config |
| [in] | config | The client configuration |
| INT wifi_steering_clientRemove | ( | UINT | steeringgroupIndex, |
| INT | apIndex, | ||
| mac_address_t | client_mac | ||
| ) |
Remove Client Config from apIndex.
The upper layer calls this function to remove per-client configuration of client_mac from apIndex
| [in] | steeringgroupIndex | Wifi Steering Group index |
| [in] | apIndex | Access point index, the client config to be removed. |
| [in] | client_mac | The Client's MAC address |
| INT wifi_steering_clientMeasure | ( | UINT | steeringgroupIndex, |
| INT | apIndex, | ||
| mac_address_t | client_mac | ||
| ) |
Initiate Instant Client RSSI Measurement.
This initiates an instant client RSSI measurement. The recommended method of performing this measurement is to send five NUL wifi frames to the client, and average the RSSI of the ACK frames returned. This averaged RSSI value should be sent back using WIFI_STEERING_EVENT_RSSI steering event type. Instant measurement improves user experience by not reacting to false-positive RSSI crossings. If for some reason instant measurement is not supported, the function should return RETURN_ERR and set errno to ENOTSUP.
| [in] | steeringgroupIndex | Wifi Steering Group index |
| [in] | apIndex | Access point index, the client config should be added to |
| [in] | client_mac | The Client's MAC address |
| INT wifi_steering_clientDisconnect | ( | UINT | steeringgroupIndex, |
| INT | apIndex, | ||
| mac_address_t | client_mac, | ||
| wifi_disconnectType_t | type, | ||
| UINT | reason | ||
| ) |
Initiate a Client Disconnect.
This is used by the upper layer to kick off a client, for steering purposes.
| [in] | steeringgroupIndex | Wifi Steering Group index |
| [in] | apIndex | The access point index, the client config should be added to |
| [in] | client_mac | The Client's MAC address |
| [in] | type | Disconnect Type |
| [in] | reason | Reason code to provide in deauth/disassoc frame. |
| INT wifi_BTMQueryRequest_callback_register | ( | UINT | apIndex, |
| wifi_BTMQueryRequest_callback | btmQueryCallback, | ||
| wifi_BTMResponse_callback | btmResponseCallback | ||
| ) |
BTM Query callback registration function.
| callback_proc | - wifi_newApAssociatedDevice_callback callback function |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected. |
| RETURN_OK | if successful. |
| RETURN_ERR | if any error is detected. |
| INT wifi_RMBeaconRequestCallbackRegister | ( | UINT | apIndex, |
| wifi_RMBeaconReport_callback | beaconReportCallback | ||
| ) |
| INT wifi_RMBeaconRequestCallbackUnregister | ( | UINT | apIndex, |
| wifi_RMBeaconReport_callback | beaconReportCallback | ||
| ) |
| int wifi_getHalCapability | ( | wifi_hal_capability_t * | cap | ) |
Get HAL Capabilities.
| [out] | cap | HAL Capabilities |
This API will return features/configuration supported by the HAL
| WIFI_HAL_SUCCESS | if successful |
| WIFI_HAL_ERROR | if an generic error is detected |
| WIFI_HAL_INTERNAL_ERROR | if an internal error is detected |
| WIFI_HAL_UNSUPPORTED | if the API is not supported |
| WIFI_HAL_INVALID_ARGUMENTS | if any of the arguments is invalid |
| WIFI_HAL_INVALID_VALUE | if the value is invalid |
Get the radio reset count.
| [in] | radioIndex | Index of Wi-Fi radio channel |
| [out] | output_int | Reset count, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Get the Radio enable config parameter.
| [in] | radioIndex | Index of Wi-Fi radio channel |
| [out] | output_bool | Radio Enable status, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Set the Radio enable config parameter.
| [in] | radioIndex | Index of Wi-Fi radio channel |
| [in] | enable | Set the selected radio's status as Enable/Disable |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Get the Radio enable status.
| [in] | radioIndex | Index of Wi-Fi radio channel |
| [out] | output_bool | Selected radio's enable status, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Get the Radio Interface name from platform, eg "wifi0".
| radioIndex | Index of Wi-Fi radio channel |
| output_string | Interface name, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Get the Dfs enable status.
| [in] | radioIndex | Index of Wi-Fi radio channel |
| [out] | output_bool | Get DFS Enable status of the selected radio channel |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Set the Dfs enable status.
| [in] | radioIndex | Index of Wi-Fi radio channel |
| [in] | enable | Set DFS Enable status of the selected radio channel |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Get the Dfs enable on Bootup status.
| [in] | radioIndex | Index of Wi-Fi radio channel |
| [out] | enable | Get DFS Enable on bootup status of the selected radio channel |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Set the Dfs enable on Bootup status.
| [in] | radioIndex | Index of Wi-Fi radio channel |
| [in] | enable | Set DFS Enable on Bootup status of the selected radio channel |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Get the Modulation Coding Scheme index, eg: "-1", "1", "15".
| [in] | radioIndex | Index of Wi-Fi radio channel |
| [out] | output_INT | Modulation Coding Scheme index, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Set the Modulation Coding Scheme index, eg: "-1", "1", "15".
| [in] | radioIndex | Index of Wi-Fi radio channel |
| [in] | MCS | Modulation Coding Scheme index value |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Get current Transmit Power in dBm units.
The transmit power value is in dBm units of full power for this radio.
| [in] | radioIndex | Index of Wi-Fi radio channel |
| [out] | output_ulong | Current Transmit power value, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Get current Transmit Power level in units of full power.
The transmit power is a percentage value of full power for this radio.
| [in] | radioIndex | Index of Wi-Fi radio channel |
| [out] | output_ulong | Current Transmit power percentage value, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Set current Transmit Power, eg "75", "100".
The transmit power level is in units of full power for this radio.
| [in] | radioIndex | Index of Wi-Fi radio channel |
| [in] | TransmitPower | Transmit power value |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
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.
| [in] | radioIndex | Index of Wi-Fi radio channel |
| [out] | output | Carrier sense threshold range, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
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.
| [in] | radioIndex | Index of Wi-Fi radio channel |
| [out] | output | Carrier sense threshold in use, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
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.
| [in] | radioIndex | Index of Wi-Fi radio channel |
| [in] | threshold | Carrier sense threshold, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
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).
| [in] | radioIndex | Index of Wi-Fi radio channel |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Enables CTS protection for the radio used by this Access Point.
| [in] | apIndex | Access Point index |
| [in] | enable | CTS protection enable value |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Enables OBSS Coexistence - fall back to 20MHz if necessary for the radio used by this AP.
| [in] | apIndex | Access Point index |
| [in] | enable | OBSS Coexistence enable value |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Sets the fragmentation threshold in bytes for the radio used by this Access Point.
| [in] | apIndex | Access Point index |
| [in] | threshold | Fragmentation Threshold value |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Enable STBC mode in the hardware. 0 == not enabled, 1 == enabled.
| [in] | radioIndex | Radio index |
| [in] | STBC_Enable | STBC mode enable value |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Outputs A-MSDU enable status, 0 == not enabled, 1 == enabled.
| [in] | radioIndex | Radio index |
| [out] | output_bool | A-MSDU enable status, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Enables A-MSDU in the hardware, 0 == not enabled, 1 == enabled.
| [in] | radioIndex | Radio index |
| [out] | amsduEnable | A-MSDU enable status value |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Get the number of seconds elapsed since radio is started.
| [in] | radioIndex | Radio index |
| [in] | uptime | Wifi uptime, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Get radio RDG enable Support.
| [in] | radioIndex | Radio index |
| [out] | output_bool | RDG enable support value, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Get radio auto block ack enable setting.
| [in] | radioIndex | Radio index |
| [out] | output_bool | Auto block ack enable setting value, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Set radio auto block ack enable setting.
| [in] | radioIndex | Radio index |
| [in] | enable | Auto block ack enable setting value |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Get radio IGMP snooping enable setting.
| [in] | radioIndex | Radio index |
| [out] | output_bool | Radio IGMP snooping enable setting, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Set radio IGMP snooping enable setting.
| [in] | radioIndex | Radio index |
| [out] | enable | Radio IGMP snooping enable setting |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Set Zero DFS State.
The Zero DFS feature can be enabled or disabled. For EU countries the "Pre-CAC" can be also set. If the "Pre-CAC" is set, then after passing background CAC driver can start background CAC on the next channel.
| [in] | radioIndex | Index of Wi-Fi radio |
| [in] | enabled | True if ZeroDFS must be enabled, false otherwise. |
| [in] | precac | Valid only for EU regulatory domain. If set, after passing requested backgronund CAN, driver can start background CAC on the next channel. |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
Get Zero DFS State.
The Zero DFS feature can be enabled or disabled. For EU countries the "Pre-CAC" can be also set. If the "Pre-CAC" is set, then after passing background CAC driver can start background CAC on next channel.
| [in] | radioIndex | Index of Wi-Fi radio |
| [out] | enabled | True if ZeroDFS is enabled, false otherwise. |
| [out] | precac | Valid only for EU regulatory domain. If true, then driver can start background CAC on the next channel. |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| INT wifi_setDownlinkMuType | ( | INT | radio_index, |
| wifi_dl_mu_type_t | mu_type | ||
| ) |
| INT wifi_getDownlinkMuType | ( | INT | radio_index, |
| wifi_dl_mu_type_t * | mu_type | ||
| ) |
| INT wifi_setUplinkMuType | ( | INT | radio_index, |
| wifi_ul_mu_type_t | mu_type | ||
| ) |
| INT wifi_getUplinkMuType | ( | INT | radio_index, |
| wifi_ul_mu_type_t * | mu_type | ||
| ) |
| INT wifi_setGuardInterval | ( | INT | radio_index, |
| wifi_guard_interval_t | guard_interval | ||
| ) |
| INT wifi_getGuardInterval | ( | INT | radio_index, |
| wifi_guard_interval_t * | guard_interval | ||
| ) |
| INT wifi_getAvailableBSSColor | ( | INT | radio_index, |
| INT | maxNumberColors, | ||
| UCHAR * | colorList, | ||
| INT * | numColorReturned | ||
| ) |
Get the list of avaiable BSS color.
This API return a list of availables BSS color that can be used to to configure the radio using wifi_setBSSColor API. This list should be created based on neighbours BSS color and the station reports.
| [in] | radio_index | Index of Wi-Fi radio |
| [in] | maxNumberColors | Maximum number of color that can be retuned |
| [out] | colorList | The list of avaiable BSS color |
| [out] | numColorReturned | Number of color returned in the list |
| WIFI_HAL_SUCCESS | if successful |
| WIFI_HAL_ERROR | if an generic error is detected |
| WIFI_HAL_INTERNAL_ERROR | if an internal error is detected |
| WIFI_HAL_UNSUPPORTED | if the API is not supported |
| WIFI_HAL_INVALID_ARGUMENTS | if any of the arguments is invalid |
| WIFI_HAL_INVALID_VALUE | if the value is invalid |
| INT wifi_getMuEdca | ( | INT | radio_index, |
| wifi_access_category_t | ac, | ||
| wifi_edca_t * | edca | ||
| ) |
Get MU (Multi-User) EDCA (Enhanced Distributed Channel Access) parameter.
| [in] | radio_index | Index of Wi-Fi radio |
| [in] | ac | The Access Category |
| [out] | edca | The MU EDCA parameters |
| WIFI_HAL_SUCCESS | if successful |
| WIFI_HAL_ERROR | if an generic error is detected |
| WIFI_HAL_INTERNAL_ERROR | if an internal error is detected |
| WIFI_HAL_UNSUPPORTED | if the API is not supported |
| WIFI_HAL_INVALID_ARGUMENTS | if any of the arguments is invalid |
| WIFI_HAL_INVALID_VALUE | if the value is invalid |
| INT wifi_setDownlinkDataAckType | ( | INT | radio_index, |
| wifi_dl_data_ack_type_t | ack_type | ||
| ) |
| INT wifi_get80211axDefaultParameters | ( | INT | radio_index, |
| wifi_80211ax_params_t * | params | ||
| ) |
| INT wifi_setRadioOperatingParameters | ( | wifi_radio_index_t | index, |
| wifi_radio_operationParam_t * | operationParam | ||
| ) |
Set Radio Operating Parameters.
This API is used to configured all radio operation parameter in a single set. it includes channel number, channelWidth, mode and auto channel configuration.
| [in] | radio_index | Index of Wi-Fi radio |
| [in] | operationParam | Radio Operating Parameters |
| WIFI_HAL_SUCCESS | if successful |
| WIFI_HAL_ERROR | if an generic error is detected |
| WIFI_HAL_INTERNAL_ERROR | if an internal error is detected |
| WIFI_HAL_UNSUPPORTED | if the API is not supported |
| WIFI_HAL_INVALID_ARGUMENTS | if any of the arguments is invalid |
| WIFI_HAL_INVALID_VALUE | if the value is invalid |
| INT wifi_getRadioOperatingParameters | ( | wifi_radio_index_t | index, |
| wifi_radio_operationParam_t * | operationParam | ||
| ) |
Get Radio Operating Parameters.
| [in] | radio_index | Index of Wi-Fi radio |
| [out] | operationParam | Radio Operating Parameters |
| WIFI_HAL_SUCCESS | if successful |
| WIFI_HAL_ERROR | if an generic error is detected |
| WIFI_HAL_INTERNAL_ERROR | if an internal error is detected |
| WIFI_HAL_UNSUPPORTED | if the API is not supported |
| WIFI_HAL_INVALID_ARGUMENTS | if any of the arguments is invalid |
| WIFI_HAL_INVALID_VALUE | if the value is invalid |
| INT wifi_getScanResults | ( | wifi_radio_index_t | index, |
| wifi_channel_t * | channel, | ||
| wifi_bss_info_t ** | bss, | ||
| UINT * | num_bss | ||
| ) |
Description: Return scan results Parameters : ap_index - index of client VAP channel - scan channel bss - bss stats num_bss - number of bss returned
| void wifi_scanResults_callback_register | ( | wifi_scanResults_callback | callback_proc | ) |
Description: To connect the client VAP to specified BSS Parameters : ap_index - VAP index wifi_bss_info_t - Information about BSS that client will connect to
Description: To disconnect client Parameters : ap_index - index of client VAP
| INT wifi_getStationCapability | ( | INT | ap_index, |
| wifi_sta_capability_t * | cap | ||
| ) |
Description: To get client Parameters : ap_index - index of client VAP capability - wifi_client_capabilities_t structure
| INT wifi_findNetworks | ( | INT | ap_index, |
| wifi_channel_t * | channel, | ||
| wifi_bss_info_t ** | bss, | ||
| UINT * | num_bss | ||
| ) |
Description: To get client Parameters : ap_index - index of client VAP channel - channel number and band information bss - array of wifi_bss_info_t structure allocated by HAL layer and to be freed by caller num_bss - number in array
| INT wifi_getStationStats | ( | INT | ap_index, |
| wifi_station_stats_t * | sta | ||
| ) |
Description: Return the station stats Parameters : ap_index - index of client VAP sta - station stats
| void wifi_staConnectionStatus_callback_register | ( | wifi_staConnectionStatus_callback | callback_proc | ) |
| INT wifi_getRadioTrafficStats2 | ( | INT | radioIndex, |
| wifi_radioTrafficStats2_t * | output_struct | ||
| ) |
Get detail radio traffic static info.
| [in] | radioIndex | Index of Wi-Fi radio channel |
| [out] | output_struct | wifi_radioTrafficStats2_t *output_struct, all traffic stats info to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| INT wifi_getSSIDTrafficStats2 | ( | INT | ssidIndex, |
| wifi_ssidTrafficStats2_t * | output_struct | ||
| ) |
Get the basic SSID traffic static info.
| [in] | ssidIndex | SSID index |
| [out] | output_struct | SSID traffic status. |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
To read the radio band utilization.
| [in] | radioIndex | Radio Index |
| [out] | output_percentage | Radio band utilization percentage, to be returned |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| INT wifi_getApAssociatedDeviceDiagnosticResult3 | ( | INT | apIndex, |
| wifi_associated_dev3_t ** | associated_dev_array, | ||
| UINT * | output_array_size | ||
| ) |
This function enabled/disabled collection of detailed statistics of associated clients on Access Point.
| [in] | radioIndex | Radio Index |
| [in] | enable | enable/disable |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
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.
| [in] | radioIndex | Index of the radio array. |
| [out] | output_enable | Radio enabled status. |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
This API is to enable/disable radio status.
| [in] | radioIndex | Index of the radio array. |
| [out] | output_enable | Radio enabled status. |
| RETURN_OK | if successful |
| RETURN_ERR | if any error is detected |
| INT wifi_getVAPTelemetry | ( | UINT | apIndex, |
| wifi_VAPTelemetry_t * | telemetry | ||
| ) |
| UINT wifi_station_stats_t::vap_index |
Definition at line 37 of file wifi_hal_sta.h.
| wifi_connection_status_t wifi_station_stats_t::connect_status |
Definition at line 38 of file wifi_hal_sta.h.
| UINT wifi_station_stats_t::channel |
Definition at line 39 of file wifi_hal_sta.h.
| UINT wifi_station_stats_t::channelWidth |
Definition at line 40 of file wifi_hal_sta.h.
| UINT wifi_station_stats_t::op_class |
Definition at line 41 of file wifi_hal_sta.h.
1.8.17