common.h

   1
   2 #include "wifi_hal.h"
   3
   4 #ifndef __WIFI_HAL_COMMON_H__
   5 #define __WIFI_HAL_COMMON_H__
   6
   7 #define LOG_TAG  "WifiHAL"
   8
   9 #include <utils/Log.h>
  10 #include "nl80211_copy.h"
  11 #include "sync.h"
  12
  13 #define SOCKET_BUFFER_SIZE      (32768U)
  14 #define RECV_BUF_SIZE           (4096)
  15 #define DEFAULT_EVENT_CB_SIZE   (64)
  16 #define DEFAULT_CMD_SIZE        (64)
  17 #define DOT11_OUI_LEN             3
  18
  19 /*
  20  Vendor OUI - This is a unique identifier that identifies organization. Lets
  21  code Android specific functions with Google OUI; although vendors can do more
  22  with their own OUI's as well.
  23  */
  24
  25 const uint32_t GOOGLE_OUI = 0x001A11;
  26 /* TODO: define vendor OUI here */
  27
  28
  29 /*
  30  This enum defines ranges for various commands; commands themselves
  31  can be defined in respective feature headers; i.e. find gscan command
  32  definitions in gscan.cpp
  33  */
  34
  35 typedef enum {
  36     /* don't use 0 as a valid subcommand */
  37     VENDOR_NL80211_SUBCMD_UNSPECIFIED,
  38
  39     /* define all vendor startup commands between 0x0 and 0x0FFF */
  40     VENDOR_NL80211_SUBCMD_RANGE_START = 0x0001,
  41     VENDOR_NL80211_SUBCMD_RANGE_END   = 0x0FFF,
  42
  43     /* define all GScan related commands between 0x1000 and 0x10FF */
  44     ANDROID_NL80211_SUBCMD_GSCAN_RANGE_START = 0x1000,
  45     ANDROID_NL80211_SUBCMD_GSCAN_RANGE_END   = 0x10FF,
  46
  47     /* define all NearbyDiscovery related commands between 0x1100 and 0x11FF */
  48     ANDROID_NL80211_SUBCMD_NBD_RANGE_START = 0x1100,
  49     ANDROID_NL80211_SUBCMD_NBD_RANGE_END   = 0x11FF,
  50
  51     /* define all RTT related commands between 0x1100 and 0x11FF */
  52     ANDROID_NL80211_SUBCMD_RTT_RANGE_START = 0x1100,
  53     ANDROID_NL80211_SUBCMD_RTT_RANGE_END   = 0x11FF,
  54
  55     ANDROID_NL80211_SUBCMD_LSTATS_RANGE_START = 0x1200,
  56     ANDROID_NL80211_SUBCMD_LSTATS_RANGE_END   = 0x12FF,
  57
  58     /* define all wifi offload related commands between 0x1400 and 0x14FF */
  59     ANDROID_NL80211_SUBCMD_WIFI_OFFLOAD_RANGE_START = 0x1400,
  60     ANDROID_NL80211_SUBCMD_WIFI_OFFLOAD_RANGE_END   = 0x14FF,
  61
  62    /* This is reserved for future usage */
  63
  64 } ANDROID_VENDOR_SUB_COMMAND;
  65
  66 typedef enum {
  67     SLSI_NL80211_VENDOR_SUBCMD_GET_CAPABILITIES = ANDROID_NL80211_SUBCMD_GSCAN_RANGE_START,
  68     SLSI_NL80211_VENDOR_SUBCMD_GET_VALID_CHANNELS,
  69     SLSI_NL80211_VENDOR_SUBCMD_ADD_GSCAN,
  70     SLSI_NL80211_VENDOR_SUBCMD_DEL_GSCAN,
  71     SLSI_NL80211_VENDOR_SUBCMD_GET_SCAN_RESULTS,
  72     SLSI_NL80211_VENDOR_SUBCMD_SET_BSSID_HOTLIST,
  73     SLSI_NL80211_VENDOR_SUBCMD_RESET_BSSID_HOTLIST,
  74     SLSI_NL80211_VENDOR_SUBCMD_GET_HOTLIST_RESULTS,
  75     SLSI_NL80211_VENDOR_SUBCMD_SET_SIGNIFICANT_CHANGE,
  76     SLSI_NL80211_VENDOR_SUBCMD_RESET_SIGNIFICANT_CHANGE,
  77     SLSI_NL80211_VENDOR_SUBCMD_SET_GSCAN_OUI,
  78     SLSI_NL80211_VENDOR_SUBCMD_SET_NODFS,
  79     SLSI_NL80211_VENDOR_SUBCMD_SET_BSSID_BLACKLIST,
  80     /*Add any GSCAN subcmds before this*/
  81     SLSI_NL80211_VENDOR_SUBCMD_START_KEEP_ALIVE_OFFLOAD,
  82     SLSI_NL80211_VENDOR_SUBCMD_STOP_KEEP_ALIVE_OFFLOAD,
  83
  84 } WIFI_SUB_COMMAND;
  85
  86 typedef enum {
  87     GSCAN_EVENT_SIGNIFICANT_CHANGE_RESULTS ,
  88     GSCAN_EVENT_HOTLIST_RESULTS_FOUND,
  89     GSCAN_EVENT_SCAN_RESULTS_AVAILABLE,
  90     GSCAN_EVENT_FULL_SCAN_RESULTS,
  91     GSCAN_EVENT_COMPLETE_SCAN,
  92     GSCAN_EVENT_HOTLIST_RESULTS_LOST
  93 } WIFI_EVENT;
  94
  95 typedef void (*wifi_internal_event_handler) (wifi_handle handle, int events);
  96
  97 class WifiCommand;
  98
  99 typedef struct {
 100     int nl_cmd;
 101     uint32_t vendor_id;
 102     int vendor_subcmd;
 103     nl_recvmsg_msg_cb_t cb_func;
 104     void *cb_arg;
 105 } cb_info;
 106
 107 typedef struct {
 108     wifi_request_id id;
 109     WifiCommand *cmd;
 110 } cmd_info;
 111
 112 typedef struct {
 113     wifi_handle handle;                             // handle to wifi data
 114     char name[8+1];                                 // interface name + trailing null
 115     int  id;                                        // id to use when talking to driver
 116 } interface_info;
 117
 118 typedef struct {
 119
 120     struct nl_sock *cmd_sock;                       // command socket object
 121     struct nl_sock *event_sock;                     // event socket object
 122     int nl80211_family_id;                          // family id for 80211 driver
 123     int cleanup_socks[2];                           // sockets used to implement wifi_cleanup
 124
 125     bool in_event_loop;                             // Indicates that event loop is active
 126     bool clean_up;                                  // Indication to clean up the socket
 127
 128     wifi_internal_event_handler event_handler;      // default event handler
 129     wifi_cleaned_up_handler cleaned_up_handler;     // socket cleaned up handler
 130
 131     cb_info *event_cb;                              // event callbacks
 132     int num_event_cb;                               // number of event callbacks
 133     int alloc_event_cb;                             // number of allocated callback objects
 134     pthread_mutex_t cb_lock;                        // mutex for the event_cb access
 135
 136     cmd_info *cmd;                                  // Outstanding commands
 137     int num_cmd;                                    // number of commands
 138     int alloc_cmd;                                  // number of commands allocated
 139
 140     interface_info **interfaces;                    // array of interfaces
 141     int num_interfaces;                             // number of interfaces
 142
 143
 144     // add other details
 145 } hal_info;
 146
 147 wifi_error wifi_register_handler(wifi_handle handle, int cmd, nl_recvmsg_msg_cb_t func, void *arg);
 148 wifi_error wifi_register_vendor_handler(wifi_handle handle,
 149             uint32_t id, int subcmd, nl_recvmsg_msg_cb_t func, void *arg);
 150
 151 void wifi_unregister_handler(wifi_handle handle, int cmd);
 152 void wifi_unregister_vendor_handler(wifi_handle handle, uint32_t id, int subcmd);
 153
 154 wifi_error wifi_register_cmd(wifi_handle handle, int id, WifiCommand *cmd);
 155 WifiCommand *wifi_unregister_cmd(wifi_handle handle, int id);
 156 WifiCommand *wifi_get_cmd(wifi_handle handle, int id);
 157 void wifi_unregister_cmd(wifi_handle handle, WifiCommand *cmd);
 158
 159 interface_info *getIfaceInfo(wifi_interface_handle);
 160 wifi_handle getWifiHandle(wifi_interface_handle handle);
 161 hal_info *getHalInfo(wifi_handle handle);
 162 hal_info *getHalInfo(wifi_interface_handle handle);
 163 wifi_handle getWifiHandle(hal_info *info);
 164 wifi_interface_handle getIfaceHandle(interface_info *info);
 165
 166
 167 // some common macros
 168
 169 #define min(x, y)       ((x) < (y) ? (x) : (y))
 170 #define max(x, y)       ((x) > (y) ? (x) : (y))
 171
 172 #endif
 173