include/hardware_legacy/wifi_hal.h

   1 /*
   2  * Copyright (C) 2014 The Android Open Source Project
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef __WIFI_HAL_H__
  18 #define __WIFI_HAL_H__
  19
  20 #ifdef __cplusplus
  21 extern "C"
  22 {
  23 #endif
  24 #include <stdint.h>
  25
  26 /* WiFi Common definitions */
  27 /* channel operating width */
  28 typedef enum {
  29     WIFI_CHAN_WIDTH_20    = 0,
  30     WIFI_CHAN_WIDTH_40    = 1,
  31     WIFI_CHAN_WIDTH_80    = 2,
  32     WIFI_CHAN_WIDTH_160   = 3,
  33     WIFI_CHAN_WIDTH_80P80 = 4,
  34     WIFI_CHAN_WIDTH_5     = 5,
  35     WIFI_CHAN_WIDTH_10    = 6,
  36     WIFI_CHAN_WIDTH_INVALID = -1
  37 } wifi_channel_width;
  38
  39 typedef int wifi_radio;
  40 typedef int wifi_channel;
  41
  42 typedef struct {
  43     wifi_channel_width width;
  44     int center_frequency0;
  45     int center_frequency1;
  46     int primary_frequency;
  47 } wifi_channel_spec;
  48
  49 typedef enum {
  50     WIFI_SUCCESS = 0,
  51     WIFI_ERROR_NONE = 0,
  52     WIFI_ERROR_UNKNOWN = -1,
  53     WIFI_ERROR_UNINITIALIZED = -2,
  54     WIFI_ERROR_NOT_SUPPORTED = -3,
  55     WIFI_ERROR_NOT_AVAILABLE = -4,              // Not available right now, but try later
  56     WIFI_ERROR_INVALID_ARGS = -5,
  57     WIFI_ERROR_INVALID_REQUEST_ID = -6,
  58     WIFI_ERROR_TIMED_OUT = -7,
  59     WIFI_ERROR_TOO_MANY_REQUESTS = -8,          // Too many instances of this request
  60     WIFI_ERROR_OUT_OF_MEMORY = -9
  61 } wifi_error;
  62
  63 typedef unsigned char byte;
  64 typedef unsigned char u8;
  65 typedef signed char s8;
  66 typedef uint16_t u16;
  67 typedef uint32_t u32;
  68 typedef int32_t s32;
  69 typedef uint64_t u64;
  70 typedef int64_t s64;
  71 typedef int wifi_request_id;
  72 typedef int wifi_channel;                       // indicates channel frequency in MHz
  73 typedef int wifi_rssi;
  74 typedef byte mac_addr[6];
  75 typedef byte oui[3];
  76 typedef int64_t wifi_timestamp;                 // In microseconds (us)
  77 typedef int64_t wifi_timespan;                  // In nanoseconds  (ns)
  78
  79 typedef struct wifi_info *wifi_handle;
  80 typedef struct wifi_interface_info *wifi_interface_handle;
  81
  82 /* Initialize/Cleanup */
  83
  84 wifi_error wifi_initialize(wifi_handle *handle);
  85 typedef void (*wifi_cleaned_up_handler) (wifi_handle handle);
  86 void wifi_cleanup(wifi_handle handle, wifi_cleaned_up_handler handler);
  87 void wifi_event_loop(wifi_handle handle);
  88
  89 /* Error handling */
  90 void wifi_get_error_info(wifi_error err, const char **msg); // return a pointer to a static string
  91
  92 /* Feature enums */
  93 #define WIFI_FEATURE_INFRA              0x0001      // Basic infrastructure mode
  94 #define WIFI_FEATURE_INFRA_5G           0x0002      // Support for 5 GHz Band
  95 #define WIFI_FEATURE_HOTSPOT            0x0004      // Support for GAS/ANQP
  96 #define WIFI_FEATURE_P2P                0x0008      // Wifi-Direct
  97 #define WIFI_FEATURE_SOFT_AP            0x0010      // Soft AP
  98 #define WIFI_FEATURE_GSCAN              0x0020      // Google-Scan APIs
  99 #define WIFI_FEATURE_NAN                0x0040      // Neighbor Awareness Networking
 100 #define WIFI_FEATURE_D2D_RTT            0x0080      // Device-to-device RTT
 101 #define WIFI_FEATURE_D2AP_RTT           0x0100      // Device-to-AP RTT
 102 #define WIFI_FEATURE_BATCH_SCAN         0x0200      // Batched Scan (legacy)
 103 #define WIFI_FEATURE_PNO                0x0400      // Preferred network offload
 104 #define WIFI_FEATURE_ADDITIONAL_STA     0x0800      // Support for two STAs
 105 #define WIFI_FEATURE_TDLS               0x1000      // Tunnel directed link setup
 106 #define WIFI_FEATURE_TDLS_OFFCHANNEL    0x2000      // Support for TDLS off channel
 107 #define WIFI_FEATURE_EPR                0x4000      // Enhanced power reporting
 108 #define WIFI_FEATURE_AP_STA             0x8000      // Support for AP STA Concurrency
 109 #define WIFI_FEATURE_LINK_LAYER_STATS  0x10000      // Link layer stats collection
 110 #define WIFI_FEATURE_LOGGER            0x20000      // WiFi Logger
 111 #define WIFI_FEATURE_HAL_EPNO          0x40000      // WiFi PNO enhanced
 112
 113 // Add more features here
 114
 115
 116 typedef int feature_set;
 117
 118 #define IS_MASK_SET(mask, flags)        ((flags & mask) == mask)
 119 #define IS_MASK_RESET(mask, flags)      ((flags & mask) == 0)
 120
 121 #define IS_SUPPORTED_FEATURE(feature, featureSet)       IS_MASK_SET(feature, fetureSet)
 122 #define IS_UNSUPPORTED_FEATURE(feature, featureSet)     IS_MASK_RESET(feature, fetureSet)
 123
 124 /* Feature set */
 125 wifi_error wifi_get_supported_feature_set(wifi_interface_handle handle, feature_set *set);
 126
 127 /*
 128  * Each row represents a valid feature combination;
 129  * all other combinations are invalid!
 130  */
 131 wifi_error wifi_get_concurrency_matrix(wifi_interface_handle handle, int set_size_max,
 132         feature_set set[], int *set_size);
 133
 134 /* multiple interface support */
 135
 136 wifi_error wifi_get_ifaces(wifi_handle handle, int *num_ifaces, wifi_interface_handle **ifaces);
 137 wifi_error wifi_get_iface_name(wifi_interface_handle iface, char *name, size_t size);
 138
 139 /* Configuration events */
 140
 141 typedef struct {
 142     void (*on_country_code_changed)(char code[2]);      // We can get this from supplicant too
 143
 144     // More event handlers
 145 } wifi_event_handler;
 146
 147 typedef struct {
 148         void (*on_rssi_threshold_breached)(wifi_request_id id, u8 *cur_bssid, s8 cur_rssi);
 149 } wifi_rssi_event_handler;
 150
 151 wifi_error wifi_set_iface_event_handler(wifi_request_id id, wifi_interface_handle iface, wifi_event_handler eh);
 152 wifi_error wifi_reset_iface_event_handler(wifi_request_id id, wifi_interface_handle iface);
 153
 154 wifi_error wifi_set_nodfs_flag(wifi_interface_handle handle, u32 nodfs);
 155
 156 /* include various feature headers */
 157
 158 #include "gscan.h"
 159 #include "link_layer_stats.h"
 160 #include "rtt.h"
 161 #include "tdls.h"
 162 #include "wifi_logger.h"
 163 #include "wifi_config.h"
 164 #include "wifi_nan.h"
 165 //wifi HAL function pointer table
 166 typedef struct {
 167     wifi_error (* wifi_initialize) (wifi_handle *);
 168     void (* wifi_cleanup) (wifi_handle, wifi_cleaned_up_handler);
 169     void (*wifi_event_loop)(wifi_handle);
 170     void (* wifi_get_error_info) (wifi_error , const char **);
 171     wifi_error (* wifi_get_supported_feature_set) (wifi_interface_handle, feature_set *);
 172     wifi_error (* wifi_get_concurrency_matrix) (wifi_interface_handle, int, feature_set *, int *);
 173     wifi_error (* wifi_set_scanning_mac_oui) (wifi_interface_handle, unsigned char *);
 174     wifi_error (* wifi_get_supported_channels)(wifi_handle, int *, wifi_channel *);
 175     wifi_error (* wifi_is_epr_supported)(wifi_handle);
 176     wifi_error (* wifi_get_ifaces) (wifi_handle , int *, wifi_interface_handle **);
 177     wifi_error (* wifi_get_iface_name) (wifi_interface_handle, char *name, size_t);
 178     wifi_error (* wifi_set_iface_event_handler) (wifi_request_id,wifi_interface_handle ,
 179             wifi_event_handler);
 180     wifi_error (* wifi_reset_iface_event_handler) (wifi_request_id, wifi_interface_handle);
 181     wifi_error (* wifi_start_gscan) (wifi_request_id, wifi_interface_handle, wifi_scan_cmd_params,
 182             wifi_scan_result_handler);
 183     wifi_error (* wifi_stop_gscan)(wifi_request_id, wifi_interface_handle);
 184     wifi_error (* wifi_get_cached_gscan_results)(wifi_interface_handle, byte, int,
 185             wifi_cached_scan_results *, int *);
 186     wifi_error (* wifi_set_bssid_hotlist)(wifi_request_id, wifi_interface_handle,
 187             wifi_bssid_hotlist_params, wifi_hotlist_ap_found_handler);
 188     wifi_error (* wifi_reset_bssid_hotlist)(wifi_request_id, wifi_interface_handle);
 189     wifi_error (* wifi_set_significant_change_handler)(wifi_request_id, wifi_interface_handle,
 190             wifi_significant_change_params, wifi_significant_change_handler);
 191     wifi_error (* wifi_reset_significant_change_handler)(wifi_request_id, wifi_interface_handle);
 192     wifi_error (* wifi_get_gscan_capabilities)(wifi_interface_handle, wifi_gscan_capabilities *);
 193     wifi_error (* wifi_set_link_stats) (wifi_interface_handle, wifi_link_layer_params);
 194     wifi_error (* wifi_get_link_stats) (wifi_request_id,wifi_interface_handle,
 195             wifi_stats_result_handler);
 196     wifi_error (* wifi_clear_link_stats)(wifi_interface_handle,u32, u32 *, u8, u8 *);
 197     wifi_error (* wifi_get_valid_channels)(wifi_interface_handle,int, int, wifi_channel *, int *);
 198     wifi_error (* wifi_rtt_range_request)(wifi_request_id, wifi_interface_handle, unsigned,
 199             wifi_rtt_config[], wifi_rtt_event_handler);
 200     wifi_error (* wifi_rtt_range_cancel)(wifi_request_id,  wifi_interface_handle, unsigned,
 201             mac_addr[]);
 202     wifi_error (* wifi_get_rtt_capabilities)(wifi_interface_handle, wifi_rtt_capabilities *);
 203     wifi_error (* wifi_set_nodfs_flag)(wifi_interface_handle, u32);
 204     wifi_error (* wifi_start_logging)(wifi_interface_handle, u32, u32, u32, u32, char *);
 205     wifi_error (* wifi_set_epno_list)(int, wifi_interface_info *, int, wifi_epno_network *,
 206             wifi_epno_handler);
 207     wifi_error (* wifi_set_country_code)(wifi_interface_handle, const char *);
 208     wifi_error (* wifi_get_firmware_memory_dump)( wifi_interface_handle iface,
 209             wifi_firmware_memory_dump_handler handler);
 210     wifi_error (* wifi_set_log_handler)(wifi_request_id id, wifi_interface_handle iface,
 211         wifi_ring_buffer_data_handler handler);
 212     wifi_error (* wifi_set_alert_handler)(wifi_request_id id, wifi_interface_handle iface,
 213         wifi_alert_handler handler);
 214     wifi_error (* wifi_get_firmware_version)(wifi_interface_handle iface, char *buffer,
 215             int buffer_size);
 216     wifi_error (* wifi_get_ring_buffers_status)(wifi_interface_handle iface,
 217             u32 *num_rings, wifi_ring_buffer_status *status);
 218     wifi_error (* wifi_get_logger_supported_feature_set)(wifi_interface_handle iface,
 219             unsigned int *support);
 220     wifi_error (* wifi_get_ring_data)(wifi_interface_handle iface, char *ring_name);
 221     wifi_error (* wifi_enable_tdls)(wifi_interface_handle, mac_addr, wifi_tdls_params *,
 222             wifi_tdls_handler);
 223     wifi_error (* wifi_disable_tdls)(wifi_interface_handle, mac_addr);
 224     wifi_error (*wifi_get_tdls_status) (wifi_interface_handle, mac_addr, wifi_tdls_status *);
 225     wifi_error (*wifi_get_tdls_capabilities)(wifi_interface_handle iface,
 226             wifi_tdls_capabilities *capabilities);
 227     wifi_error (* wifi_get_driver_version)(wifi_interface_handle iface, char *buffer,
 228             int buffer_size);
 229     wifi_error (* wifi_set_passpoint_list)(wifi_request_id id, wifi_interface_handle iface,
 230             int num, wifi_passpoint_network *networks, wifi_passpoint_event_handler handler);
 231     wifi_error (* wifi_reset_passpoint_list)(wifi_request_id id, wifi_interface_handle iface);
 232     wifi_error (*wifi_set_bssid_blacklist)(wifi_request_id id, wifi_interface_handle iface,
 233                   wifi_bssid_params params);
 234     wifi_error (*wifi_enable_lazy_roam)(wifi_request_id id,
 235                 wifi_interface_handle iface, int enable);
 236     wifi_error (*wifi_set_bssid_preference)(wifi_request_id id, wifi_interface_handle iface,
 237                                             int num_bssid, wifi_bssid_preference *prefs);
 238     wifi_error (*wifi_set_gscan_roam_params)(wifi_request_id id, wifi_interface_handle iface,
 239                                                 wifi_roam_params * params);
 240     wifi_error (*wifi_set_ssid_white_list)(wifi_request_id id, wifi_interface_handle iface,
 241                                int num_networks, wifi_ssid *ssids);
 242     wifi_error (*wifi_set_lci) (wifi_request_id id, wifi_interface_handle iface,
 243                                      wifi_lci_information *lci);
 244     wifi_error (*wifi_set_lcr) (wifi_request_id id, wifi_interface_handle iface,
 245                                      wifi_lcr_information *lcr);
 246     wifi_error (*wifi_start_sending_offloaded_packet)(wifi_request_id id,
 247                                 wifi_interface_handle iface, u8 *ip_packet, u16 ip_packet_len,
 248                                 u8 *src_mac_addr, u8 *dst_mac_addr, u32 period_msec);
 249     wifi_error (*wifi_stop_sending_offloaded_packet)(wifi_request_id id,
 250                                 wifi_interface_handle iface);
 251     wifi_error (*wifi_start_rssi_monitoring)(wifi_request_id id, wifi_interface_handle
 252                         iface, s8 max_rssi, s8 min_rssi, wifi_rssi_event_handler eh);
 253     wifi_error (*wifi_stop_rssi_monitoring)(wifi_request_id id, wifi_interface_handle iface);
 254 } wifi_hal_fn;
 255 wifi_error init_wifi_vendor_hal_func_table(wifi_hal_fn *fn);
 256 #ifdef __cplusplus
 257 }
 258 #endif
 259
 260 #endif
 261