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 #include "wifi_hal.h"
18 
19 #ifndef __WIFI_HAL_COMMON_H__
20 #define __WIFI_HAL_COMMON_H__
21 
22 #ifndef LOG_TAG
23 #define LOG_TAG  "WifiHAL"
24 #endif
25 
26 #include <stdint.h>
27 #include <fcntl.h>
28 #include <inttypes.h>
29 #include <sys/socket.h>
30 #include <netlink/genl/genl.h>
31 #include <netlink/genl/family.h>
32 #include <netlink/genl/ctrl.h>
33 #include <linux/rtnetlink.h>
34 #include <netpacket/packet.h>
35 #include <linux/filter.h>
36 #include <linux/errqueue.h>
37 
38 #include <linux/pkt_sched.h>
39 #include <netlink/object-api.h>
40 #include <netlink/netlink.h>
41 #include <netlink/socket.h>
42 
43 #include "nl80211_copy.h"
44 
45 #include <utils/Log.h>
46 #include "rb_wrapper.h"
47 #include "pkt_stats.h"
48 #include "wifihal_internal.h"
49 
50 #define SOCKET_BUFFER_SIZE      (32768U)
51 #define RECV_BUF_SIZE           (4096)
52 #define DEFAULT_EVENT_CB_SIZE   (64)
53 #define NUM_RING_BUFS           5
54 
55 #define MAC_ADDR_ARRAY(a) (a)[0], (a)[1], (a)[2], (a)[3], (a)[4], (a)[5]
56 #define MAC_ADDR_STR "%02x:%02x:%02x:%02x:%02x:%02x"
57 #define BIT(x) (1 << (x))
58 
59 typedef int16_t s16;
60 typedef int32_t s32;
61 typedef int64_t s64;
62 
63 typedef void (*wifi_internal_event_handler) (wifi_handle handle, int events);
64 
65 class WifiCommand;
66 
67 typedef struct {
68     int nl_cmd;
69     uint32_t vendor_id;
70     int vendor_subcmd;
71     nl_recvmsg_msg_cb_t cb_func;
72     void *cb_arg;
73 } cb_info;
74 
75 typedef struct {
76     wifi_request_id id;
77     WifiCommand *cmd;
78 } cmd_info;
79 
80 typedef struct {
81     wifi_handle handle;                             // handle to wifi data
82     char name[IFNAMSIZ+1];                          // interface name + trailing null
83     int  id;                                        // id to use when talking to driver
84 } interface_info;
85 
86 typedef struct {
87     wifi_gscan_capabilities gscan_capa;
88     wifi_roaming_capabilities roaming_capa;
89 } wifi_capa;
90 
91 struct gscan_event_handlers_s;
92 struct rssi_monitor_event_handler_s;
93 struct cld80211_ctx;
94 
95 typedef struct hal_info_s {
96 
97     struct nl_sock *cmd_sock;                       // command socket object
98     struct nl_sock *event_sock;                     // event socket object
99     struct nl_sock *user_sock;                      // user socket object
100     int nl80211_family_id;                          // family id for 80211 driver
101 
102     bool in_event_loop;                             // Indicates that event loop is active
103     bool clean_up;                                  // Indication to clean up the socket
104 
105     wifi_internal_event_handler event_handler;      // default event handler
106     wifi_cleaned_up_handler cleaned_up_handler;     // socket cleaned up handler
107 
108     cb_info *event_cb;                              // event callbacks
109     int num_event_cb;                               // number of event callbacks
110     int alloc_event_cb;                             // number of allocated callback objects
111     pthread_mutex_t cb_lock;                        // mutex for the event_cb access
112 
113     interface_info **interfaces;                    // array of interfaces
114     int num_interfaces;                             // number of interfaces
115 
116     feature_set supported_feature_set;
117     u32 supported_logger_feature_set;
118     // add other details
119     int user_sock_arg;
120     struct rb_info rb_infos[NUM_RING_BUFS];
121     void (*on_ring_buffer_data) (char *ring_name, char *buffer, int buffer_size,
122           wifi_ring_buffer_status *status);
123     void (*on_alert) (wifi_request_id id, char *buffer, int buffer_size, int err_code);
124     struct pkt_stats_s *pkt_stats;
125 
126     /* socket pair used to exit from blocking poll*/
127     int exit_sockets[2];
128     u32 rx_buf_size_allocated;
129     u32 rx_buf_size_occupied;
130     wifi_ring_buffer_entry *rx_aggr_pkts;
131     rx_aggr_stats aggr_stats;
132     u32 prev_seq_no;
133     // pointer to structure having various gscan_event_handlers
134     struct gscan_event_handlers_s *gscan_handlers;
135     /* mutex for the log_handler access*/
136     pthread_mutex_t lh_lock;
137     /* mutex for the alert_handler access*/
138     pthread_mutex_t ah_lock;
139     u32 firmware_bus_max_size;
140     bool fate_monitoring_enabled;
141     packet_fate_monitor_info *pkt_fate_stats;
142     /* mutex for the packet fate stats shared resource protection */
143     pthread_mutex_t pkt_fate_stats_lock;
144     struct rssi_monitor_event_handler_s *rssi_handlers;
145     wifi_capa capa;
146     struct cld80211_ctx *cldctx;
147     bool apf_enabled;
148 } hal_info;
149 
150 wifi_error wifi_register_handler(wifi_handle handle, int cmd, nl_recvmsg_msg_cb_t func, void *arg);
151 wifi_error wifi_register_vendor_handler(wifi_handle handle,
152             uint32_t id, int subcmd, nl_recvmsg_msg_cb_t func, void *arg);
153 
154 void wifi_unregister_handler(wifi_handle handle, int cmd);
155 void wifi_unregister_vendor_handler(wifi_handle handle, uint32_t id, int subcmd);
156 
157 interface_info *getIfaceInfo(wifi_interface_handle);
158 wifi_handle getWifiHandle(wifi_interface_handle handle);
159 hal_info *getHalInfo(wifi_handle handle);
160 hal_info *getHalInfo(wifi_interface_handle handle);
161 wifi_handle getWifiHandle(hal_info *info);
162 wifi_interface_handle getIfaceHandle(interface_info *info);
163 wifi_error initializeGscanHandlers(hal_info *info);
164 wifi_error cleanupGscanHandlers(hal_info *info);
165 wifi_error initializeRSSIMonitorHandler(hal_info *info);
166 wifi_error cleanupRSSIMonitorHandler(hal_info *info);
167 
168 lowi_cb_table_t *getLowiCallbackTable(u32 requested_lowi_capabilities);
169 
170 wifi_error wifi_start_sending_offloaded_packet(wifi_request_id id,
171         wifi_interface_handle iface, u8 *ip_packet, u16 ip_packet_len,
172         u8 *src_mac_addr, u8 *dst_mac_addr, u32 period_msec);
173 wifi_error wifi_stop_sending_offloaded_packet(wifi_request_id id,
174         wifi_interface_handle iface);
175 wifi_error wifi_start_rssi_monitoring(wifi_request_id id, wifi_interface_handle
176         iface, s8 max_rssi, s8 min_rssi, wifi_rssi_event_handler eh);
177 wifi_error wifi_stop_rssi_monitoring(wifi_request_id id, wifi_interface_handle iface);
178 wifi_error wifi_set_radio_mode_change_handler(wifi_request_id id, wifi_interface_handle
179         iface, wifi_radio_mode_change_handler eh);
180 wifi_error mapKernelErrortoWifiHalError(int kern_err);
181 // some common macros
182 
183 #define min(x, y)       ((x) < (y) ? (x) : (y))
184 #define max(x, y)       ((x) > (y) ? (x) : (y))
185 
186 #define REQUEST_ID_MAX 1000
187 #define get_requestid() ((arc4random()%REQUEST_ID_MAX) + 1)
188 #define WAIT_TIME_FOR_SET_REG_DOMAIN 50000
189 
190 #ifndef UNUSED
191 #define UNUSED(x)    (void)(x)
192 #endif
193 
194 #ifdef __cplusplus
195 extern "C"
196 {
197 #endif /* __cplusplus */
198 void hexdump(void *bytes, u16 len);
199 u8 get_rssi(u8 rssi_wo_noise_floor);
200 #ifdef __cplusplus
201 }
202 #endif /* __cplusplus */
203 
204 #endif
205 
206