Merge KeystoneQ-ww-20190522
[GitHub/MotorolaMobilityLLC/hardware-samsung_slsi-scsc_wifibt-wifi_hal.git] / common.h
CommitLineData
7753f181
DD
1
2#include "wifi_hal.h"
3
4#ifndef __WIFI_HAL_COMMON_H__
5#define __WIFI_HAL_COMMON_H__
6
d3a587e8
JPS
7#ifdef LOG_TAG
8#undef LOG_TAG
9#endif
7753f181
DD
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
02b2b8ab
S
22typedef struct {
23 int num_bssid;
24 mac_addr bssids[MAX_BLACKLIST_BSSID];
25} wifi_bssid_params;
26
7753f181
DD
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
33const uint32_t GOOGLE_OUI = 0x001A11;
34/* TODO: define vendor OUI here */
35
02b2b8ab
S
36typedef 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
66 GSCAN_ATTRIBUTE_SSID = 40,
67 GSCAN_ATTRIBUTE_BSSID,
68 GSCAN_ATTRIBUTE_CHANNEL,
69 GSCAN_ATTRIBUTE_RSSI,
70 GSCAN_ATTRIBUTE_TIMESTAMP,
71 GSCAN_ATTRIBUTE_RTT,
72 GSCAN_ATTRIBUTE_RTTSD,
73
74 /* remaining reserved for additional attributes */
75
76 GSCAN_ATTRIBUTE_HOTLIST_BSSIDS = 50,
77 GSCAN_ATTRIBUTE_RSSI_LOW,
78 GSCAN_ATTRIBUTE_RSSI_HIGH,
79 GSCAN_ATTRIBUTE_HOTLIST_ELEM,
80 GSCAN_ATTRIBUTE_HOTLIST_FLUSH,
81 GSCAN_ATTRIBUTE_CHANNEL_NUMBER,
82
83 /* remaining reserved for additional attributes */
84 GSCAN_ATTRIBUTE_RSSI_SAMPLE_SIZE = 60,
85 GSCAN_ATTRIBUTE_LOST_AP_SAMPLE_SIZE,
86 GSCAN_ATTRIBUTE_MIN_BREACHING,
87 GSCAN_ATTRIBUTE_SIGNIFICANT_CHANGE_BSSIDS,
88
89 GSCAN_ATTRIBUTE_BUCKET_STEP_COUNT = 70,
90 GSCAN_ATTRIBUTE_BUCKET_EXPONENT,
91 GSCAN_ATTRIBUTE_BUCKET_MAX_PERIOD,
92
93 GSCAN_ATTRIBUTE_NUM_BSSID,
94 GSCAN_ATTRIBUTE_BLACKLIST_BSSID,
95
96 GSCAN_ATTRIBUTE_MAX
97
98} GSCAN_ATTRIBUTE;
7753f181
DD
99
100/*
101 This enum defines ranges for various commands; commands themselves
102 can be defined in respective feature headers; i.e. find gscan command
103 definitions in gscan.cpp
104 */
105
106typedef enum {
107 /* don't use 0 as a valid subcommand */
108 VENDOR_NL80211_SUBCMD_UNSPECIFIED,
109
110 /* define all vendor startup commands between 0x0 and 0x0FFF */
111 VENDOR_NL80211_SUBCMD_RANGE_START = 0x0001,
112 VENDOR_NL80211_SUBCMD_RANGE_END = 0x0FFF,
113
114 /* define all GScan related commands between 0x1000 and 0x10FF */
115 ANDROID_NL80211_SUBCMD_GSCAN_RANGE_START = 0x1000,
116 ANDROID_NL80211_SUBCMD_GSCAN_RANGE_END = 0x10FF,
117
118 /* define all NearbyDiscovery related commands between 0x1100 and 0x11FF */
119 ANDROID_NL80211_SUBCMD_NBD_RANGE_START = 0x1100,
120 ANDROID_NL80211_SUBCMD_NBD_RANGE_END = 0x11FF,
121
122 /* define all RTT related commands between 0x1100 and 0x11FF */
123 ANDROID_NL80211_SUBCMD_RTT_RANGE_START = 0x1100,
124 ANDROID_NL80211_SUBCMD_RTT_RANGE_END = 0x11FF,
125
126 ANDROID_NL80211_SUBCMD_LSTATS_RANGE_START = 0x1200,
127 ANDROID_NL80211_SUBCMD_LSTATS_RANGE_END = 0x12FF,
128
cdc775c7
HG
129 /* define all Logger related commands between 0x1400 and 0x14FF */
130 ANDROID_NL80211_SUBCMD_DEBUG_RANGE_START = 0x1400,
131 ANDROID_NL80211_SUBCMD_DEBUG_RANGE_END = 0x14FF,
132
3c0c6ab1
PG
133 /* define all wifi offload related commands between 0x1400 and 0x14FF */
134 ANDROID_NL80211_SUBCMD_WIFI_OFFLOAD_RANGE_START = 0x1400,
135 ANDROID_NL80211_SUBCMD_WIFI_OFFLOAD_RANGE_END = 0x14FF,
136
d3a587e8
JPS
137 /* Range for NAN commands */
138 ANDROID_NL80211_SUBCMD_NAN_RANGE_START = 0x1500,
139 ANDROID_NL80211_SUBCMD_NAN_RANGE_END = 0x15FF,
3c0c6ab1 140 /* This is reserved for future usage */
7753f181
DD
141
142} ANDROID_VENDOR_SUB_COMMAND;
143
144typedef enum {
145 SLSI_NL80211_VENDOR_SUBCMD_GET_CAPABILITIES = ANDROID_NL80211_SUBCMD_GSCAN_RANGE_START,
146 SLSI_NL80211_VENDOR_SUBCMD_GET_VALID_CHANNELS,
147 SLSI_NL80211_VENDOR_SUBCMD_ADD_GSCAN,
148 SLSI_NL80211_VENDOR_SUBCMD_DEL_GSCAN,
149 SLSI_NL80211_VENDOR_SUBCMD_GET_SCAN_RESULTS,
150 SLSI_NL80211_VENDOR_SUBCMD_SET_BSSID_HOTLIST,
151 SLSI_NL80211_VENDOR_SUBCMD_RESET_BSSID_HOTLIST,
152 SLSI_NL80211_VENDOR_SUBCMD_GET_HOTLIST_RESULTS,
153 SLSI_NL80211_VENDOR_SUBCMD_SET_SIGNIFICANT_CHANGE,
154 SLSI_NL80211_VENDOR_SUBCMD_RESET_SIGNIFICANT_CHANGE,
155 SLSI_NL80211_VENDOR_SUBCMD_SET_GSCAN_OUI,
3c0c6ab1
PG
156 SLSI_NL80211_VENDOR_SUBCMD_SET_NODFS,
157 SLSI_NL80211_VENDOR_SUBCMD_START_KEEP_ALIVE_OFFLOAD,
6ff2d683
JPS
158 SLSI_NL80211_VENDOR_SUBCMD_STOP_KEEP_ALIVE_OFFLOAD,
159 SLSI_NL80211_VENDOR_SUBCMD_SET_BSSID_BLACKLIST,
160 SLSI_NL80211_VENDOR_SUBCMD_SET_EPNO_LIST,
161 SLSI_NL80211_VENDOR_SUBCMD_SET_HS_LIST,
f425b4a8 162 SLSI_NL80211_VENDOR_SUBCMD_RESET_HS_LIST,
d583845d
JPS
163 SLSI_NL80211_VENDOR_SUBCMD_SET_RSSI_MONITOR,
164 SLSI_NL80211_VENDOR_SUBCMD_LLS_SET_INFO,
165 SLSI_NL80211_VENDOR_SUBCMD_LLS_GET_INFO,
0318783f 166 SLSI_NL80211_VENDOR_SUBCMD_LLS_CLEAR_INFO,
1fdbd4c1 167 SLSI_NL80211_VENDOR_SUBCMD_GET_FEATURE_SET,
de14a5c9 168 SLSI_NL80211_VENDOR_SUBCMD_SET_COUNTRY_CODE,
d3a587e8 169 SLSI_NL80211_VENDOR_SUBCMD_CONFIGURE_ND_OFFLOAD,
47e18f37
JPS
170 SLSI_NL80211_VENDOR_SUBCMD_GET_ROAMING_CAPABILITIES,
171 SLSI_NL80211_VENDOR_SUBCMD_SET_ROAMING_STATE,
d3a587e8
JPS
172
173 SLSI_NL80211_VENDOR_SUBCMD_NAN_ENABLE = ANDROID_NL80211_SUBCMD_NAN_RANGE_START,
174 SLSI_NL80211_VENDOR_SUBCMD_NAN_DISABLE,
175 SLSI_NL80211_VENDOR_SUBCMD_NAN_PUBLISH,
176 SLSI_NL80211_VENDOR_SUBCMD_NAN_PUBLISHCANCEL,
177 SLSI_NL80211_VENDOR_SUBCMD_NAN_SUBSCRIBE,
178 SLSI_NL80211_VENDOR_SUBCMD_NAN_SUBSCRIBECANCEL,
179 SLSI_NL80211_VENDOR_SUBCMD_NAN_TXFOLLOWUP,
180 SLSI_NL80211_VENDOR_SUBCMD_NAN_CONFIG,
47e18f37
JPS
181 SLSI_NL80211_VENDOR_SUBCMD_NAN_CAPABILITIES,
182 SLSI_NL80211_VENDOR_SUBCMD_RTT_GET_CAPABILITIES = ANDROID_NL80211_SUBCMD_RTT_RANGE_START,
183 SLSI_NL80211_VENDOR_SUBCMD_RTT_RANGE_START,
184 SLSI_NL80211_VENDOR_SUBCMD_RTT_RANGE_CANCEL
7753f181
DD
185} WIFI_SUB_COMMAND;
186
187typedef enum {
188 GSCAN_EVENT_SIGNIFICANT_CHANGE_RESULTS ,
189 GSCAN_EVENT_HOTLIST_RESULTS_FOUND,
190 GSCAN_EVENT_SCAN_RESULTS_AVAILABLE,
191 GSCAN_EVENT_FULL_SCAN_RESULTS,
192 GSCAN_EVENT_COMPLETE_SCAN,
6ff2d683
JPS
193 GSCAN_EVENT_HOTLIST_RESULTS_LOST,
194 WIFI_SUBCMD_KEY_MGMT_ROAM_AUTH, /* Handled by supplicant. not in Wifi-HAL */
195 WIFI_HANGED_EVENT,
196 WIFI_EPNO_EVENT,
f425b4a8 197 WIFI_HOTSPOT_MATCH,
cdc775c7
HG
198 WIFI_RSSI_REPORT_EVENT,
199 ENHANCE_LOGGER_RING_EVENT,
d3a587e8
JPS
200 ENHANCE_LOGGER_MEM_DUMP_EVENT,
201 /* NAN events start */
202 SLSI_NAN_EVENT_RESPONSE,
203 SLSI_NAN_EVENT_PUBLISH_TERMINATED,
204 SLSI_NAN_EVENT_MATCH,
205 SLSI_NAN_EVENT_MATCH_EXPIRED,
206 SLSI_NAN_EVENT_SUBSCRIBE_TERMINATED,
207 SLSI_NAN_EVENT_FOLLOWUP,
208 SLSI_NAN_EVENT_DISCOVERY_ENGINE,
47e18f37 209 SLSI_NAN_EVENT_DISABLED,
d3a587e8 210 /* NAN events end */
47e18f37
JPS
211 SLSI_RTT_RESULT_EVENT,
212 SLSI_RTT_EVENT_COMPLETE
f425b4a8 213
7753f181
DD
214} WIFI_EVENT;
215
216typedef void (*wifi_internal_event_handler) (wifi_handle handle, int events);
217
218class WifiCommand;
219
220typedef struct {
221 int nl_cmd;
222 uint32_t vendor_id;
223 int vendor_subcmd;
224 nl_recvmsg_msg_cb_t cb_func;
225 void *cb_arg;
226} cb_info;
227
228typedef struct {
229 wifi_request_id id;
230 WifiCommand *cmd;
231} cmd_info;
232
233typedef struct {
234 wifi_handle handle; // handle to wifi data
235 char name[8+1]; // interface name + trailing null
236 int id; // id to use when talking to driver
237} interface_info;
238
239typedef struct {
240
241 struct nl_sock *cmd_sock; // command socket object
242 struct nl_sock *event_sock; // event socket object
243 int nl80211_family_id; // family id for 80211 driver
244 int cleanup_socks[2]; // sockets used to implement wifi_cleanup
245
246 bool in_event_loop; // Indicates that event loop is active
247 bool clean_up; // Indication to clean up the socket
248
249 wifi_internal_event_handler event_handler; // default event handler
250 wifi_cleaned_up_handler cleaned_up_handler; // socket cleaned up handler
251
252 cb_info *event_cb; // event callbacks
253 int num_event_cb; // number of event callbacks
254 int alloc_event_cb; // number of allocated callback objects
255 pthread_mutex_t cb_lock; // mutex for the event_cb access
256
257 cmd_info *cmd; // Outstanding commands
258 int num_cmd; // number of commands
259 int alloc_cmd; // number of commands allocated
260
261 interface_info **interfaces; // array of interfaces
262 int num_interfaces; // number of interfaces
263
264
265 // add other details
266} hal_info;
267
268wifi_error wifi_register_handler(wifi_handle handle, int cmd, nl_recvmsg_msg_cb_t func, void *arg);
269wifi_error wifi_register_vendor_handler(wifi_handle handle,
270 uint32_t id, int subcmd, nl_recvmsg_msg_cb_t func, void *arg);
271
272void wifi_unregister_handler(wifi_handle handle, int cmd);
273void wifi_unregister_vendor_handler(wifi_handle handle, uint32_t id, int subcmd);
274
275wifi_error wifi_register_cmd(wifi_handle handle, int id, WifiCommand *cmd);
276WifiCommand *wifi_unregister_cmd(wifi_handle handle, int id);
277WifiCommand *wifi_get_cmd(wifi_handle handle, int id);
278void wifi_unregister_cmd(wifi_handle handle, WifiCommand *cmd);
f425b4a8 279wifi_error wifi_cancel_cmd(wifi_request_id id, wifi_interface_handle iface);
7753f181
DD
280
281interface_info *getIfaceInfo(wifi_interface_handle);
282wifi_handle getWifiHandle(wifi_interface_handle handle);
283hal_info *getHalInfo(wifi_handle handle);
284hal_info *getHalInfo(wifi_interface_handle handle);
285wifi_handle getWifiHandle(hal_info *info);
286wifi_interface_handle getIfaceHandle(interface_info *info);
287
288
289// some common macros
290
291#define min(x, y) ((x) < (y) ? (x) : (y))
292#define max(x, y) ((x) > (y) ? (x) : (y))
293
cdc775c7
HG
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)
7753f181
DD
301#endif
302