common.h

   1
   2 #include "wifi_hal.h"
   3
   4 #ifndef __WIFI_HAL_COMMON_H__
   5 #define __WIFI_HAL_COMMON_H__
   6
   7 #ifdef LOG_TAG
   8 #undef LOG_TAG
   9 #endif
  10 #define LOG_TAG  "WifiHAL"
  11
  12 #include <utils/Log.h>
  13 #include "nl80211_copy.h"
  14 #include "sync.h"
  15
  16 #define SOCKET_BUFFER_SIZE      (32768U)
  17 #define RECV_BUF_SIZE           (4096)
  18 #define DEFAULT_EVENT_CB_SIZE   (64)
  19 #define DEFAULT_CMD_SIZE        (64)
  20 #define DOT11_OUI_LEN             3
  21
  22 typedef struct {
  23         int num_bssid;
  24         mac_addr bssids[MAX_BLACKLIST_BSSID];
  25 } wifi_bssid_params;
  26
  27 /*
  28  Vendor OUI - This is a unique identifier that identifies organization. Lets
  29  code Android specific functions with Google OUI; although vendors can do more
  30  with their own OUI's as well.
  31  */
  32
  33 const uint32_t GOOGLE_OUI = 0x001A11;
  34 /* TODO: define vendor OUI here */
  35
  36 typedef enum {
  37
  38     GSCAN_ATTRIBUTE_NUM_BUCKETS = 10,
  39     GSCAN_ATTRIBUTE_BASE_PERIOD,
  40     GSCAN_ATTRIBUTE_BUCKETS_BAND,
  41     GSCAN_ATTRIBUTE_BUCKET_ID,
  42     GSCAN_ATTRIBUTE_BUCKET_PERIOD,
  43     GSCAN_ATTRIBUTE_BUCKET_NUM_CHANNELS,
  44     GSCAN_ATTRIBUTE_BUCKET_CHANNELS,
  45     GSCAN_ATTRIBUTE_NUM_AP_PER_SCAN,
  46     GSCAN_ATTRIBUTE_REPORT_THRESHOLD,
  47     GSCAN_ATTRIBUTE_NUM_SCANS_TO_CACHE,
  48     GSCAN_ATTRIBUTE_REPORT_THRESHOLD_NUM_SCANS,
  49     GSCAN_ATTRIBUTE_BAND = GSCAN_ATTRIBUTE_BUCKETS_BAND,
  50
  51     GSCAN_ATTRIBUTE_ENABLE_FEATURE = 20,
  52     GSCAN_ATTRIBUTE_SCAN_RESULTS_COMPLETE,              /* indicates no more results */
  53     GSCAN_ATTRIBUTE_REPORT_EVENTS,
  54
  55     /* remaining reserved for additional attributes */
  56     GSCAN_ATTRIBUTE_NUM_OF_RESULTS = 30,
  57     GSCAN_ATTRIBUTE_SCAN_RESULTS,                       /* flat array of wifi_scan_result */
  58     GSCAN_ATTRIBUTE_NUM_CHANNELS,
  59     GSCAN_ATTRIBUTE_CHANNEL_LIST,
  60     GSCAN_ATTRIBUTE_SCAN_ID,
  61     GSCAN_ATTRIBUTE_SCAN_FLAGS,
  62     GSCAN_ATTRIBUTE_SCAN_BUCKET_BIT,
  63
  64     /* remaining reserved for additional attributes */
  65     GSCAN_ATTRIBUTE_RSSI_SAMPLE_SIZE = 60,
  66     GSCAN_ATTRIBUTE_LOST_AP_SAMPLE_SIZE,
  67     GSCAN_ATTRIBUTE_MIN_BREACHING,
  68     GSCAN_ATTRIBUTE_SIGNIFICANT_CHANGE_BSSIDS,
  69
  70     GSCAN_ATTRIBUTE_BUCKET_STEP_COUNT = 70,
  71     GSCAN_ATTRIBUTE_BUCKET_EXPONENT,
  72     GSCAN_ATTRIBUTE_BUCKET_MAX_PERIOD,
  73
  74     GSCAN_ATTRIBUTE_NUM_BSSID,
  75     GSCAN_ATTRIBUTE_BLACKLIST_BSSID,
  76
  77     GSCAN_ATTRIBUTE_MAX
  78
  79 } GSCAN_ATTRIBUTE;
  80
  81 /*
  82  This enum defines ranges for various commands; commands themselves
  83  can be defined in respective feature headers; i.e. find gscan command
  84  definitions in gscan.cpp
  85  */
  86
  87 typedef enum {
  88     /* don't use 0 as a valid subcommand */
  89     VENDOR_NL80211_SUBCMD_UNSPECIFIED,
  90
  91     /* define all vendor startup commands between 0x0 and 0x0FFF */
  92     VENDOR_NL80211_SUBCMD_RANGE_START = 0x0001,
  93     VENDOR_NL80211_SUBCMD_RANGE_END   = 0x0FFF,
  94
  95     /* define all GScan related commands between 0x1000 and 0x10FF */
  96     ANDROID_NL80211_SUBCMD_GSCAN_RANGE_START = 0x1000,
  97     ANDROID_NL80211_SUBCMD_GSCAN_RANGE_END   = 0x10FF,
  98
  99     /* define all NearbyDiscovery related commands between 0x1100 and 0x11FF */
 100     ANDROID_NL80211_SUBCMD_NBD_RANGE_START = 0x1100,
 101     ANDROID_NL80211_SUBCMD_NBD_RANGE_END   = 0x11FF,
 102
 103     /* define all RTT related commands between 0x1100 and 0x11FF */
 104     ANDROID_NL80211_SUBCMD_RTT_RANGE_START = 0x1100,
 105     ANDROID_NL80211_SUBCMD_RTT_RANGE_END   = 0x11FF,
 106
 107     ANDROID_NL80211_SUBCMD_LSTATS_RANGE_START = 0x1200,
 108     ANDROID_NL80211_SUBCMD_LSTATS_RANGE_END   = 0x12FF,
 109
 110     /* define all Logger related commands between 0x1400 and 0x14FF */
 111     ANDROID_NL80211_SUBCMD_DEBUG_RANGE_START = 0x1400,
 112     ANDROID_NL80211_SUBCMD_DEBUG_RANGE_END   = 0x14FF,
 113
 114     /* define all wifi offload related commands between 0x1400 and 0x14FF */
 115     ANDROID_NL80211_SUBCMD_WIFI_OFFLOAD_RANGE_START = 0x1400,
 116     ANDROID_NL80211_SUBCMD_WIFI_OFFLOAD_RANGE_END   = 0x14FF,
 117
 118     /* Range for NAN commands */
 119     ANDROID_NL80211_SUBCMD_NAN_RANGE_START = 0x1500,
 120     ANDROID_NL80211_SUBCMD_NAN_RANGE_END   = 0x15FF,
 121    /* This is reserved for future usage */
 122
 123     /* define all APF related commands between 0x1600 and 0x16FF */
 124     ANDROID_NL80211_SUBCMD_APF_RANGE_START = 0x1600,
 125     ANDROID_NL80211_SUBCMD_APF_RANGE_END   = 0x16FF,
 126
 127 } ANDROID_VENDOR_SUB_COMMAND;
 128
 129 typedef enum {
 130     SLSI_NL80211_VENDOR_SUBCMD_GET_CAPABILITIES = ANDROID_NL80211_SUBCMD_GSCAN_RANGE_START,
 131     SLSI_NL80211_VENDOR_SUBCMD_GET_VALID_CHANNELS,
 132     SLSI_NL80211_VENDOR_SUBCMD_ADD_GSCAN,
 133     SLSI_NL80211_VENDOR_SUBCMD_DEL_GSCAN,
 134     SLSI_NL80211_VENDOR_SUBCMD_GET_SCAN_RESULTS,
 135     /**********Deprecated now due to fapi updates.Do not remove*/
 136     SLSI_NL80211_VENDOR_SUBCMD_SET_BSSID_HOTLIST,
 137     SLSI_NL80211_VENDOR_SUBCMD_RESET_BSSID_HOTLIST,
 138     SLSI_NL80211_VENDOR_SUBCMD_GET_HOTLIST_RESULTS,
 139     SLSI_NL80211_VENDOR_SUBCMD_SET_SIGNIFICANT_CHANGE,
 140     SLSI_NL80211_VENDOR_SUBCMD_RESET_SIGNIFICANT_CHANGE,
 141     /******************************************/
 142     SLSI_NL80211_VENDOR_SUBCMD_SET_GSCAN_OUI,
 143     SLSI_NL80211_VENDOR_SUBCMD_SET_NODFS,
 144     SLSI_NL80211_VENDOR_SUBCMD_START_KEEP_ALIVE_OFFLOAD,
 145     SLSI_NL80211_VENDOR_SUBCMD_STOP_KEEP_ALIVE_OFFLOAD,
 146     SLSI_NL80211_VENDOR_SUBCMD_SET_BSSID_BLACKLIST,
 147     SLSI_NL80211_VENDOR_SUBCMD_SET_EPNO_LIST,
 148     SLSI_NL80211_VENDOR_SUBCMD_SET_HS_LIST,
 149     SLSI_NL80211_VENDOR_SUBCMD_RESET_HS_LIST,
 150     SLSI_NL80211_VENDOR_SUBCMD_SET_RSSI_MONITOR,
 151     SLSI_NL80211_VENDOR_SUBCMD_LLS_SET_INFO,
 152     SLSI_NL80211_VENDOR_SUBCMD_LLS_GET_INFO,
 153     SLSI_NL80211_VENDOR_SUBCMD_LLS_CLEAR_INFO,
 154     SLSI_NL80211_VENDOR_SUBCMD_GET_FEATURE_SET,
 155     SLSI_NL80211_VENDOR_SUBCMD_SET_COUNTRY_CODE,
 156     SLSI_NL80211_VENDOR_SUBCMD_CONFIGURE_ND_OFFLOAD,
 157     SLSI_NL80211_VENDOR_SUBCMD_GET_ROAMING_CAPABILITIES,
 158     SLSI_NL80211_VENDOR_SUBCMD_SET_ROAMING_STATE,
 159
 160     SLSI_NL80211_VENDOR_SUBCMD_NAN_ENABLE = ANDROID_NL80211_SUBCMD_NAN_RANGE_START,
 161     SLSI_NL80211_VENDOR_SUBCMD_NAN_DISABLE,
 162     SLSI_NL80211_VENDOR_SUBCMD_NAN_PUBLISH,
 163     SLSI_NL80211_VENDOR_SUBCMD_NAN_PUBLISHCANCEL,
 164     SLSI_NL80211_VENDOR_SUBCMD_NAN_SUBSCRIBE,
 165     SLSI_NL80211_VENDOR_SUBCMD_NAN_SUBSCRIBECANCEL,
 166     SLSI_NL80211_VENDOR_SUBCMD_NAN_TXFOLLOWUP,
 167     SLSI_NL80211_VENDOR_SUBCMD_NAN_CONFIG,
 168     SLSI_NL80211_VENDOR_SUBCMD_NAN_CAPABILITIES,
 169     SLSI_NL80211_VENDOR_SUBCMD_RTT_GET_CAPABILITIES = ANDROID_NL80211_SUBCMD_RTT_RANGE_START,
 170     SLSI_NL80211_VENDOR_SUBCMD_RTT_RANGE_START,
 171     SLSI_NL80211_VENDOR_SUBCMD_RTT_RANGE_CANCEL,
 172
 173     SLSI_NL80211_VENDOR_SUBCMD_APF_SET_FILTER = ANDROID_NL80211_SUBCMD_APF_RANGE_START,
 174     SLSI_NL80211_VENDOR_SUBCMD_APF_GET_CAPABILITIES,
 175     SLSI_NL80211_VENDOR_SUBCMD_APF_READ_FILTER
 176 } WIFI_SUB_COMMAND;
 177
 178 typedef enum {
 179     /**********Deprecated now due to fapi updates.Do not remove*/
 180     GSCAN_EVENT_SIGNIFICANT_CHANGE_RESULTS ,
 181     GSCAN_EVENT_HOTLIST_RESULTS_FOUND,
 182     /******************************************/
 183     GSCAN_EVENT_SCAN_RESULTS_AVAILABLE,
 184     GSCAN_EVENT_FULL_SCAN_RESULTS,
 185     GSCAN_EVENT_COMPLETE_SCAN,
 186     /**********Deprecated now due to fapi updates.Do not remove*/
 187     GSCAN_EVENT_HOTLIST_RESULTS_LOST,
 188     /******************************************/
 189     WIFI_SUBCMD_KEY_MGMT_ROAM_AUTH, /* Handled by supplicant. not in Wifi-HAL */
 190     WIFI_HANGED_EVENT,
 191     WIFI_EPNO_EVENT,
 192     WIFI_HOTSPOT_MATCH,
 193     WIFI_RSSI_REPORT_EVENT,
 194     ENHANCE_LOGGER_RING_EVENT,
 195     ENHANCE_LOGGER_MEM_DUMP_EVENT,
 196     SLSI_NAN_EVENT_RESPONSE,
 197     SLSI_NAN_EVENT_PUBLISH_TERMINATED,
 198     SLSI_NAN_EVENT_MATCH,
 199     SLSI_NAN_EVENT_MATCH_EXPIRED,
 200     SLSI_NAN_EVENT_SUBSCRIBE_TERMINATED,
 201     SLSI_NAN_EVENT_FOLLOWUP,
 202     SLSI_NAN_EVENT_DISCOVERY_ENGINE,
 203     SLSI_NAN_EVENT_DISABLED,
 204     SLSI_RTT_RESULT_EVENT,
 205     SLSI_RTT_EVENT_COMPLETE,
 206     WIFI_ACS_EVENT,            /* Handled by supplicant. not in Wifi-HAL */
 207     SLSI_NL80211_VENDOR_FORWARD_BEACON,
 208     SLSI_NL80211_VENDOR_FORWARD_BEACON_ABORT,
 209     SLSI_NAN_EVENT_TRANSMIT_FOLLOWUP_STATUS
 210
 211 } WIFI_EVENT;
 212
 213 typedef void (*wifi_internal_event_handler) (wifi_handle handle, int events);
 214
 215 class WifiCommand;
 216
 217 typedef struct {
 218     int nl_cmd;
 219     uint32_t vendor_id;
 220     int vendor_subcmd;
 221     nl_recvmsg_msg_cb_t cb_func;
 222     void *cb_arg;
 223 } cb_info;
 224
 225 typedef struct {
 226     wifi_request_id id;
 227     WifiCommand *cmd;
 228 } cmd_info;
 229
 230 typedef struct {
 231     wifi_handle handle;                             // handle to wifi data
 232     char name[8+1];                                 // interface name + trailing null
 233     int  id;                                        // id to use when talking to driver
 234 } interface_info;
 235
 236 typedef struct {
 237
 238     struct nl_sock *cmd_sock;                       // command socket object
 239     struct nl_sock *event_sock;                     // event socket object
 240     int nl80211_family_id;                          // family id for 80211 driver
 241     int cleanup_socks[2];                           // sockets used to implement wifi_cleanup
 242
 243     bool in_event_loop;                             // Indicates that event loop is active
 244     bool clean_up;                                  // Indication to clean up the socket
 245
 246     wifi_internal_event_handler event_handler;      // default event handler
 247     wifi_cleaned_up_handler cleaned_up_handler;     // socket cleaned up handler
 248
 249     cb_info *event_cb;                              // event callbacks
 250     int num_event_cb;                               // number of event callbacks
 251     int alloc_event_cb;                             // number of allocated callback objects
 252     pthread_mutex_t cb_lock;                        // mutex for the event_cb access
 253
 254     cmd_info *cmd;                                  // Outstanding commands
 255     int num_cmd;                                    // number of commands
 256     int alloc_cmd;                                  // number of commands allocated
 257
 258     interface_info **interfaces;                    // array of interfaces
 259     int num_interfaces;                             // number of interfaces
 260
 261     WifiCommand *nanCmd;
 262
 263     // add other details
 264 } hal_info;
 265
 266 wifi_error wifi_register_handler(wifi_handle handle, int cmd, nl_recvmsg_msg_cb_t func, void *arg);
 267 wifi_error wifi_register_vendor_handler(wifi_handle handle,
 268             uint32_t id, int subcmd, nl_recvmsg_msg_cb_t func, void *arg);
 269
 270 void wifi_unregister_handler(wifi_handle handle, int cmd);
 271 void wifi_unregister_vendor_handler(wifi_handle handle, uint32_t id, int subcmd);
 272
 273 wifi_error wifi_register_cmd(wifi_handle handle, int id, WifiCommand *cmd);
 274 WifiCommand *wifi_unregister_cmd(wifi_handle handle, int id);
 275 WifiCommand *wifi_get_cmd(wifi_handle handle, int id);
 276 void wifi_unregister_cmd(wifi_handle handle, WifiCommand *cmd);
 277 wifi_error wifi_cancel_cmd(wifi_request_id id, wifi_interface_handle iface);
 278
 279 interface_info *getIfaceInfo(wifi_interface_handle);
 280 wifi_handle getWifiHandle(wifi_interface_handle handle);
 281 hal_info *getHalInfo(wifi_handle handle);
 282 hal_info *getHalInfo(wifi_interface_handle handle);
 283 wifi_handle getWifiHandle(hal_info *info);
 284 wifi_interface_handle getIfaceHandle(interface_info *info);
 285
 286 void wifi_set_nan_cmd(wifi_handle handle, WifiCommand *cmd);
 287 void wifi_reset_nan_cmd(wifi_handle handle);
 288 WifiCommand *wifi_get_nan_cmd(wifi_handle handle);
 289 // some common macros
 290
 291 #define min(x, y)       ((x) < (y) ? (x) : (y))
 292 #define max(x, y)       ((x) > (y) ? (x) : (y))
 293
 294 #define NULL_CHECK_RETURN(ptr, str, ret) \
 295     do { \
 296         if (!(ptr)) { \
 297             ALOGE("%s(): null pointer - #ptr (%s)\n", __FUNCTION__, str); \
 298             return ret; \
 299         } \
 300     } while (0)
 301 #endif
 302