//----------------------------------------------------------------------------// #ifndef __WIFI_API_H #define __WIFI_API_H #include "FreeRTOS.h" #include "wifi_constants.h" #include "wifi_structures.h" #include "wifi_util.h" #include "wifi_ind.h" #include #ifdef __cplusplus extern "C" { #endif /****************************************************** * Macros ******************************************************/ #define RTW_ENABLE_API_INFO #ifdef RTW_ENABLE_API_INFO #define RTW_API_INFO(args) do {printf args;} while(0) #else #define RTW_API_INFO(args) #endif #define MAC_ARG(x) ((u8*)(x))[0],((u8*)(x))[1],((u8*)(x))[2],((u8*)(x))[3],((u8*)(x))[4],((u8*)(x))[5] #define CMP_MAC( a, b ) (((a[0])==(b[0]))&& \ ((a[1])==(b[1]))&& \ ((a[2])==(b[2]))&& \ ((a[3])==(b[3]))&& \ ((a[4])==(b[4]))&& \ ((a[5])==(b[5]))) /****************************************************** * Constants ******************************************************/ #define SCAN_LONGEST_WAIT_TIME (4500) #define MAC_FMT "%02x:%02x:%02x:%02x:%02x:%02x" #define PSCAN_ENABLE 0x01 //enable for partial channel scan #define PSCAN_FAST_SURVEY 0x02 //set to select scan time to FAST_SURVEY_TO, otherwise SURVEY_TO #define PSCAN_SIMPLE_CONFIG 0x04 //set to select scan time to FAST_SURVEY_TO and resend probe request /****************************************************** * Type Definitions ******************************************************/ /** Scan result callback function pointer type * * @param result_ptr : A pointer to the pointer that indicates where to put the next scan result * @param user_data : User provided data */ typedef void (*rtw_scan_result_callback_t)( rtw_scan_result_t** result_ptr, void* user_data ); typedef rtw_result_t (*rtw_scan_result_handler_t)( rtw_scan_handler_result_t* malloced_scan_result ); /****************************************************** * Structures ******************************************************/ typedef struct { char *buf; int buf_len; } scan_buf_arg; /****************************************************** * Structures ******************************************************/ typedef struct internal_scan_handler{ rtw_scan_result_t** pap_details; rtw_scan_result_t * ap_details; int scan_cnt; rtw_bool_t scan_complete; unsigned char max_ap_size; rtw_scan_result_handler_t gscan_result_handler; #if SCAN_USE_SEMAPHORE void *scan_semaphore; #else int scan_running; #endif void* user_data; unsigned int scan_start_time; } internal_scan_handler_t; typedef struct { rtw_network_info_t network_info; void *join_sema; } internal_join_result_t; /****************************************************** * Function Declarations ******************************************************/ /** * Initialises Realtek WiFi API System * * - Initialises the required parts of the software platform * i.e. worker, event registering, semaphore, etc. * * - Initialises the RTW API thread which handles the asynchronous event * * @return RTW_SUCCESS if initialization is successful, RTW_ERROR otherwise */ int wifi_manager_init(void); /** Joins a Wi-Fi network * * Scans for, associates and authenticates with a Wi-Fi network. * On successful return, the system is ready to send data packets. * * @param[in] ssid : A null terminated string containing the SSID name of the network to join * @param[in] security_type : Authentication type: * - RTW_SECURITY_OPEN - Open Security * - RTW_SECURITY_WEP_PSK - WEP Security with open authentication * - RTW_SECURITY_WEP_SHARED - WEP Security with shared authentication * - RTW_SECURITY_WPA_TKIP_PSK - WPA Security * - RTW_SECURITY_WPA2_AES_PSK - WPA2 Security using AES cipher * - RTW_SECURITY_WPA2_TKIP_PSK - WPA2 Security using TKIP cipher * - RTW_SECURITY_WPA2_MIXED_PSK - WPA2 Security using AES and/or TKIP ciphers * @param[in] password : A byte array containing either the * cleartext security key for WPA/WPA2 * secured networks, or a pointer to * an array of rtw_wep_key_t * structures for WEP secured networks * @param[in] ssid_len : The length of the SSID in * bytes. * @param[in] password_len : The length of the security_key in * bytes. * @param[in] key_id : The index of the wep key. * @param[in] semaphore : A user provided semaphore that is flagged when the join is complete * * @return RTW_SUCCESS : when the system is joined and ready * to send data packets * RTW_ERROR : if an error occurred */ int wifi_connect( char *ssid, rtw_security_t security_type, char *password, int ssid_len, int password_len, int key_id, void *semaphore); int wifi_connect_bssid( unsigned char bssid[ETH_ALEN], char *ssid, rtw_security_t security_type, char *password, int bssid_len, int ssid_len, int password_len, int key_id, void *semaphore); /** Disassociates from a Wi-Fi network. * * @return RTW_SUCCESS : On successful disassociation from * the AP * RTW_ERROR : If an error occurred */ int wifi_disconnect(void); /** Check if the interface specified is up. * * @return RTW_TRUE : If it's up * RTW_FALSE : If it's not */ int wifi_is_connected_to_ap(void); /*check if wifi has connected to AP before dhcp * * @return RTW_SUCCESS:if conneced RTW_ERROR :if not connect */ int wifi_is_up(rtw_interface_t interface); /** Determines if a particular interface is ready to transceive ethernet packets * * @param Radio interface to check, options are * RTW_STA_INTERFACE, RTW_AP_INTERFACE * @return RTW_SUCCESS : if the interface is ready to * transceive ethernet packets * @return RTW_NOTFOUND : no AP with a matching SSID was * found * @return RTW_NOT_AUTHENTICATED: a matching AP was found but * it won't let you * authenticate. This can * occur if this device is * in the block list on the * AP. * @return RTW_NOT_KEYED: the device has authenticated and * associated but has not completed * the key exchange. This can occur * if the passphrase is incorrect. * @return RTW_ERROR : if the interface is not ready to * transceive ethernet packets */ int wifi_is_ready_to_transceive(rtw_interface_t interface); /** ---------------------------------------------------------------------- * WARNING : This function is for internal use only! * ---------------------------------------------------------------------- * This function sets the current Media Access Control (MAC) address of the * 802.11 device. * * @param[in] mac Wi-Fi MAC address * @return RTW_SUCCESS or RTW_ERROR */ int wifi_set_mac_address(char * mac); /** Retrieves the current Media Access Control (MAC) address * (or Ethernet hardware address) of the 802.11 device * * @param mac Pointer to a variable that the current MAC address will be written to * @return RTW_SUCCESS or RTW_ERROR */ int wifi_get_mac_address(char * mac); /** Enables powersave mode * * @return @ref rtw_result_t */ int wifi_enable_powersave(void); /** Disables 802.11 power save mode * * @return RTW_SUCCESS : if power save mode was successfully * disabled * RTW_ERROR : if power save mode was not successfully * disabled */ int wifi_disable_powersave(void); /** Gets the tx power in index units * * @param dbm : The variable to receive the tx power in index. * * @return RTW_SUCCESS : if successful * RTW_ERROR : if not successful */ int wifi_get_txpower(int *poweridx); /** Sets the tx power in index units * * @param dbm : The desired tx power in index. * * @return RTW_SUCCESS : if tx power was successfully set * RTW_ERROR : if tx power was not successfully set */ int wifi_set_txpower(int poweridx); /** Get the associated clients with SoftAP * * @param client_list_buffer : the location where the client * list will be stored * @param buffer_length : the buffer length. * * @return RTW_SUCCESS : if result was successfully get * RTW_ERROR : if result was not successfully get */ int wifi_get_associated_client_list(void * client_list_buffer, unsigned short buffer_length); /** Get the SoftAP information * * @param ap_info : the location where the AP info will be * stored * @param security : the security type. * * @return RTW_SUCCESS : if result was successfully get * RTW_ERROR : if result was not successfully get */ int wifi_get_ap_info(rtw_bss_info_t * ap_info, rtw_security_t* security); /** Set the country code to driver to determine the channel set * * @param country_code : the country code. * * @return RTW_SUCCESS : if result was successfully set * RTW_ERROR : if result was not successfully set */ int wifi_set_country(rtw_country_code_t country_code); /** Retrieve the latest RSSI value * * @param rssi: The location where the RSSI value will be stored * * @return RTW_SUCCESS : if the RSSI was succesfully retrieved * RTW_ERROR : if the RSSI was not retrieved */ int wifi_get_rssi(int *pRSSI); /** Set the current channel on STA interface * * @param channel : The desired channel * * @return RTW_SUCCESS : if the channel was successfully set * RTW_ERROR : if the channel was not successfully * set */ int wifi_set_channel(int channel); /** Get the current channel on STA interface * * @param channel : A pointer to the variable where the * channel value will be written * * @return RTW_SUCCESS : if the channel was successfully read * RTW_ERROR : if the channel was not successfully * read */ int wifi_get_channel(int *channel); /** Registers interest in a multicast address * Once a multicast address has been registered, all packets detected on the * medium destined for that address are forwarded to the host. * Otherwise they are ignored. * * @param mac: Ethernet MAC address * * @return RTW_SUCCESS : if the address was registered * successfully * RTW_ERROR : if the address was not registered */ int wifi_register_multicast_address(rtw_mac_t *mac); /** Unregisters interest in a multicast address * Once a multicast address has been unregistered, all packets detected on the * medium destined for that address are ignored. * * @param mac: Ethernet MAC address * * @return RTW_SUCCESS : if the address was unregistered * successfully * RTW_ERROR : if the address was not unregistered */ int wifi_unregister_multicast_address(rtw_mac_t *mac); int wifi_rf_on(void); int wifi_rf_off(void); /** Turn on the Wi-Fi device * * - Bring the Wireless interface "Up" * - Initialises the driver thread which arbitrates access * to the SDIO/SPI bus * * @param mode: wifi work mode * * @return RTW_SUCCESS : if the WiFi chip was initialised * successfully * RTW_ERROR : if the WiFi chip was not initialised * successfully */ int wifi_on(rtw_mode_t mode); /** * Turn off the Wi-Fi device * * - Bring the Wireless interface "Down" * - De-Initialises the driver thread which arbitrates access * to the SDIO/SPI bus * * @return RTW_SUCCESS if deinitialization is successful, * RTW_ERROR otherwise */ int wifi_off(void); /** * Set IPS/LPS mode * * @param[in] ips_mode : The desired IPS mode. It become effective when wlan enter ips. * @param[in] lps_mode : The desired LPS mode. It become effective when wlan enter lps. * * @return RTW_SUCCESS if setting LPS mode successful * RTW_ERROR otherwise */ int wifi_set_power_mode(unsigned char ips_mode, unsigned char lps_mode); /** * Set TDMA parameters * * @param[in] slot_period : We separate TBTT into 2 or 3 slots. * If we separate TBTT into 2 slots, then slot_period should be larger or equal to 50ms. * It means 2 slot period is * slot_period, 100-slot_period * If we separate TBTT into 3 slots, then slot_period should be less or equal to 33ms. * It means 3 slot period is * 100 - 2 * slot_period, slot_period, slot_period * @param[in] rfon_period_len_1: rf on period of slot 1 * @param[in] rfon_period_len_2: rf on period of slot 2 * @param[in] rfon_period_len_3: rf on period of slot 3 * * @return RTW_SUCCESS if setting TDMA parameters successful * RTW_ERROR otherwise */ int wifi_set_tdma_param(unsigned char slot_period, unsigned char rfon_period_len_1, unsigned char rfon_period_len_2, unsigned char rfon_period_len_3); /** * Set LPS DTIM * * @param[in] dtim : In LPS, the package can be buffered at AP side. * STA leave LPS until dtim count of packages buffered at AP side. * * @return RTW_SUCCESS if setting LPS dtim successful * RTW_ERROR otherwise */ int wifi_set_lps_dtim(unsigned char dtim); /** * Get LPS DTIM * * @param[out] dtim : In LPS, the package can be buffered at AP side. * STA leave LPS until dtim count of packages buffered at AP side. * * @return RTW_SUCCESS if getting LPS dtim successful * RTW_ERROR otherwise */ int wifi_get_lps_dtim(unsigned char *dtim); /** Starts an infrastructure WiFi network * * @warning If a STA interface is active when this function is called, the softAP will\n * start on the same channel as the STA. It will NOT use the channel provided! * * @param[in] ssid : A null terminated string containing * the SSID name of the network to join * @param[in] security_type : Authentication type: \n * - RTW_SECURITY_OPEN - Open Security \n * - RTW_SECURITY_WPA_TKIP_PSK - WPA Security \n * - RTW_SECURITY_WPA2_AES_PSK - WPA2 Security using AES cipher \n * - RTW_SECURITY_WPA2_MIXED_PSK - WPA2 Security using AES and/or TKIP ciphers \n * - WEP security is NOT IMPLEMENTED. It is NOT SECURE! \n * @param[in] password : A byte array containing the cleartext * security key for the network * @param[in] ssid_len : The length of the SSID in * bytes. * @param[in] password_len : The length of the security_key in * bytes. * @param[in] channel : 802.11 channel number * * @return RTW_SUCCESS : if successfully creates an AP * RTW_ERROR : if an error occurred */ int wifi_start_ap( char *ssid, rtw_security_t security_type, char *password, int ssid_len, int password_len, int channel); /** Starts an infrastructure WiFi network with hidden SSID * * @warning If a STA interface is active when this function is called, the softAP will\n * start on the same channel as the STA. It will NOT use the channel provided! * * @param[in] ssid : A null terminated string containing * the SSID name of the network to join * @param[in] security_type : Authentication type: \n * - RTW_SECURITY_OPEN - Open Security \n * - RTW_SECURITY_WPA_TKIP_PSK - WPA Security \n * - RTW_SECURITY_WPA2_AES_PSK - WPA2 Security using AES cipher \n * - RTW_SECURITY_WPA2_MIXED_PSK - WPA2 Security using AES and/or TKIP ciphers \n * - WEP security is NOT IMPLEMENTED. It is NOT SECURE! \n * @param[in] password : A byte array containing the cleartext * security key for the network * @param[in] ssid_len : The length of the SSID in * bytes. * @param[in] password_len : The length of the security_key in * bytes. * @param[in] channel : 802.11 channel number * * @return RTW_SUCCESS : if successfully creates an AP * RTW_ERROR : if an error occurred */ int wifi_start_ap_with_hidden_ssid( char *ssid, rtw_security_t security_type, char *password, int ssid_len, int password_len, int channel); /** Initiates a scan to search for 802.11 networks. * * The scan progressively accumulates results over time, and * may take between 1 and 3 seconds to complete. The results of * the scan will be individually provided to the callback * function. Note: The callback function will be executed in * the context of the RTW thread. * * @param[in] scan_type : Specifies whether the scan should * be Active, Passive or scan * Prohibited channels * @param[in] bss_type : Specifies whether the scan should * search for Infrastructure * networks (those using an Access * Point), Ad-hoc networks, or both * types. * @param result_ptr[in] : Scan specific ssid. The first 4 * bytes is ssid lenth, and ssid name * append after it. * If no specific ssid need to scan, * PLEASE CLEAN result_ptr before pass * it into parameter. * @param result_ptr[out] : a pointer to a pointer to a result * storage structure. * * @note : When scanning specific channels, devices with a * strong signal strength on nearby channels may be * detected * * @return RTW_SUCCESS or RTW_ERROR */ int wifi_scan(rtw_scan_type_t scan_type, rtw_bss_type_t bss_type, void* result_ptr); /** Initiates a scan to search for 802.11 networks, a higher * level API based on wifi_scan to simplify the scan * operation. * * The scan results will be list by the order of RSSI. * It may demand hundreds bytes memory during scan * processing according to the quantity of AP nearby. * * @param results_handler[in] : the callback function which * will receive and process the result data. * @param user_data[in] : user specific data that will be * passed directly to the callback function * * @note : Callback must not use blocking functions, since it is * called from the context of the RTW thread. * @note : The callback, user_data variables will * be referenced after the function returns. Those * variables must remain valid until the scan is * complete. * * @return RTW_SUCCESS or RTW_ERROR */ int wifi_scan_networks(rtw_scan_result_handler_t results_handler, void* user_data); int wifi_scan_networks_with_ssid(int (results_handler)(char*, int, char *, void *), void* user_data, int scan_buflen, char* ssid, int ssid_len); /** Set the partical scan * * @param channel_list[in] : the channel set the scan will * stay on * @param pscan_config[in] : the pscan_config of the channel set * * @param length[in] : the channel list length * * @return RTW_SUCCESS or RTW_ERROR */ int wifi_set_pscan_chan(__u8 * channel_list,__u8 * pscan_config, __u8 length); /** Get the network information * * @param ifname[in] : the name of the interface we are care * @param pSetting[in] : the location where the network * information will be stored * * @return RTW_SUCCESS or RTW_ERROR */ int wifi_get_setting(const char *ifname,rtw_wifi_setting_t *pSetting); /** Show the network information * * @param ifname[in] : the name of the interface we are care * @param pSetting[in] : the location where the network * information was stored * * @return RTW_SUCCESS or RTW_ERROR */ int wifi_show_setting(const char *ifname,rtw_wifi_setting_t *pSetting); /** Set the network mode according to the data rate it's * supported * * @param mode[in] : the network mode * * @return RTW_SUCCESS or RTW_ERROR */ int wifi_set_network_mode(rtw_network_mode_t mode); /** Set the chip to worke in the promisc mode * * @param enabled[in] : enabled can be set 0, 1 and 2. if enabled is zero, disable the promisc, else enable the promisc. * 0 means disable the promisc * 1 means enable the promisc * 2 means enable the promisc special for length is used * @param callback[in] : the callback function which will * receive and process the netowork data. * @param len_used[in] : specify if the the promisc length is * used. * * @return RTW_SUCCESS or RTW_ERROR */ int wifi_set_promisc(rtw_rcr_level_t enabled, void (*callback)(unsigned char*, unsigned int, void*), unsigned char len_used); /** Set the wps phase * * @param is_trigger_wps[in] : to trigger wps function or not * * @return RTW_SUCCESS or RTW_ERROR */ int wifi_set_wps_phase(unsigned char is_trigger_wps); /** Restarts an infrastructure WiFi network * * @warning If a STA interface is active when this function is called, the softAP will\n * start on the same channel as the STA. It will NOT use the channel provided! * * @param[in] ssid : A null terminated string containing * the SSID name of the network to join * @param[in] security_type : Authentication type: \n * - RTW_SECURITY_OPEN - Open Security \n * - RTW_SECURITY_WPA_TKIP_PSK - WPA Security \n * - RTW_SECURITY_WPA2_AES_PSK - WPA2 Security using AES cipher \n * - RTW_SECURITY_WPA2_MIXED_PSK - WPA2 Security using AES and/or TKIP ciphers \n * - WEP security is NOT IMPLEMENTED. It is NOT SECURE! \n * @param[in] password : A byte array containing the cleartext * security key for the network * @param[in] ssid_len : The length of the SSID in * bytes. * @param[in] password_len : The length of the security_key in * bytes. * @param[in] channel : 802.11 channel number * * @return RTW_SUCCESS : if successfully creates an AP * RTW_ERROR : if an error occurred */ int wifi_restart_ap( unsigned char *ssid, rtw_security_t security_type, unsigned char *password, int ssid_len, int password_len, int channel); int wifi_config_autoreconnect(__u8 mode, __u8 retyr_times, __u16 timeout); int wifi_set_autoreconnect(__u8 mode); int wifi_get_autoreconnect(__u8 *mode); int wifi_get_last_error(void); /** Present device disconnect reason while connecting * *@return RTW_NO_ERROR = 0, * RTW_NONE_NETWORK = 1, * RTW_CONNECT_FAIL = 2, * RTW_WRONG_PASSWORD = 3 , * RTW_DHCP_FAIL = 4, * RTW_UNKNOWN, initial status */ #ifdef CONFIG_CUSTOM_IE #ifndef BIT #define BIT(x) ((__u32)1 << (x)) #endif #ifndef _CUSTOM_IE_TYPE_ #define _CUSTOM_IE_TYPE_ enum CUSTOM_IE_TYPE{ PROBE_REQ = BIT(0), PROBE_RSP = BIT(1), BEACON = BIT(2), }; #endif /* _CUSTOM_IE_TYPE_ */ /* ie format * +-----------+--------+-----------------------+ * |element ID | length | content in length byte| * +-----------+--------+-----------------------+ * * type: refer to CUSTOM_IE_TYPE */ #ifndef _CUS_IE_ #define _CUS_IE_ typedef struct _cus_ie{ __u8 *ie; __u8 type; }cus_ie, *p_cus_ie; #endif /* _CUS_IE_ */ int wifi_add_custom_ie(void *cus_ie, int ie_num); int wifi_update_custom_ie(void *cus_ie, int ie_index); int wifi_del_custom_ie(void); #endif #ifdef CONFIG_PROMISC void wifi_init_packet_filter(void); int wifi_add_packet_filter(unsigned char filter_id, rtw_packet_filter_pattern_t *patt, rtw_packet_filter_rule_e rule); int wifi_enable_packet_filter(unsigned char filter_id); int wifi_disable_packet_filter(unsigned char filter_id); int wifi_remove_packet_filter(unsigned char filter_id); #endif #ifdef __cplusplus } #endif #endif // __WIFI_API_H //----------------------------------------------------------------------------//