wifi/wifi_hal/common.h - device/linaro/poplar - Git at Google

 /*
  * Copyright (C) 2017 The Android Open Source Project
  *
  * Portions copyright (C) 2017 Broadcom Limited
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *     http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */

 #include "wifi_hal.h"

 #ifndef __WIFI_HAL_COMMON_H__
 #define __WIFI_HAL_COMMON_H__

 #define LOG_TAG  "WifiHAL"

 #include <log/log.h>
 #include "nl80211_copy.h"
 #include "sync.h"

 #define SOCKET_BUFFER_SIZE      (32768U)
 #define RECV_BUF_SIZE           (4096)
 #define DEFAULT_EVENT_CB_SIZE   (64)
 #define DEFAULT_CMD_SIZE        (64)
 #define DOT11_OUI_LEN             3
 #define DOT11_MAX_SSID_LEN        32

 #define MAX_PROBE_RESP_IE_LEN      2048
 /*
  Vendor OUI - This is a unique identifier that identifies organization. Lets
  code Android specific functions with Google OUI; although vendors can do more
  with their own OUI's as well.
  */

 const uint32_t GOOGLE_OUI = 0x001A11;
 /* TODO: define vendor OUI here */


 /*
  This enum defines ranges for various commands; commands themselves
  can be defined in respective feature headers; i.e. find gscan command
  definitions in gscan.cpp
  */

 typedef enum {
     /* don't use 0 as a valid subcommand */
     VENDOR_NL80211_SUBCMD_UNSPECIFIED,

     /* define all vendor startup commands between 0x0 and 0x0FFF */
     VENDOR_NL80211_SUBCMD_RANGE_START = 0x0001,
     VENDOR_NL80211_SUBCMD_RANGE_END   = 0x0FFF,

     /* define all GScan related commands between 0x1000 and 0x10FF */
     ANDROID_NL80211_SUBCMD_GSCAN_RANGE_START = 0x1000,
     ANDROID_NL80211_SUBCMD_GSCAN_RANGE_END   = 0x10FF,

     /* define all NearbyDiscovery related commands between 0x1100 and 0x11FF */
     ANDROID_NL80211_SUBCMD_NBD_RANGE_START = 0x1100,
     ANDROID_NL80211_SUBCMD_NBD_RANGE_END   = 0x11FF,

     /* define all RTT related commands between 0x1100 and 0x11FF */
     ANDROID_NL80211_SUBCMD_RTT_RANGE_START = 0x1100,
     ANDROID_NL80211_SUBCMD_RTT_RANGE_END   = 0x11FF,

     ANDROID_NL80211_SUBCMD_LSTATS_RANGE_START = 0x1200,
     ANDROID_NL80211_SUBCMD_LSTATS_RANGE_END   = 0x12FF,

     /* define all Logger related commands between 0x1400 and 0x14FF */
     ANDROID_NL80211_SUBCMD_DEBUG_RANGE_START = 0x1400,
     ANDROID_NL80211_SUBCMD_DEBUG_RANGE_END   = 0x14FF,

     /* define all wifi offload related commands between 0x1600 and 0x16FF */
     ANDROID_NL80211_SUBCMD_WIFI_OFFLOAD_RANGE_START = 0x1600,
     ANDROID_NL80211_SUBCMD_WIFI_OFFLOAD_RANGE_END   = 0x16FF,

     /* define all NAN related commands between 0x1700 and 0x17FF */
     ANDROID_NL80211_SUBCMD_NAN_RANGE_START = 0x1700,
     ANDROID_NL80211_SUBCMD_NAN_RANGE_END   = 0x17FF,

     /* define all Android Packet Filter related commands between 0x1800 and 0x18FF */
     ANDROID_NL80211_SUBCMD_PKT_FILTER_RANGE_START = 0x1800,
     ANDROID_NL80211_SUBCMD_PKT_FILTER_RANGE_END   = 0x18FF,

     /* This is reserved for future usage */

 } ANDROID_VENDOR_SUB_COMMAND;

 typedef enum {

     GSCAN_SUBCMD_GET_CAPABILITIES = ANDROID_NL80211_SUBCMD_GSCAN_RANGE_START,

     GSCAN_SUBCMD_SET_CONFIG,                            /* 0x1001 */

     GSCAN_SUBCMD_SET_SCAN_CONFIG,                       /* 0x1002 */
     GSCAN_SUBCMD_ENABLE_GSCAN,                          /* 0x1003 */
     GSCAN_SUBCMD_GET_SCAN_RESULTS,                      /* 0x1004 */
     GSCAN_SUBCMD_SCAN_RESULTS,                          /* 0x1005 */

     GSCAN_SUBCMD_SET_HOTLIST,                           /* 0x1006 */

     GSCAN_SUBCMD_SET_SIGNIFICANT_CHANGE_CONFIG,         /* 0x1007 */
     GSCAN_SUBCMD_ENABLE_FULL_SCAN_RESULTS,              /* 0x1008 */
     GSCAN_SUBCMD_GET_CHANNEL_LIST,                       /* 0x1009 */

     WIFI_SUBCMD_GET_FEATURE_SET,                         /* 0x100A */
     WIFI_SUBCMD_GET_FEATURE_SET_MATRIX,                  /* 0x100B */
     WIFI_SUBCMD_SET_PNO_RANDOM_MAC_OUI,                  /* 0x100C */
     WIFI_SUBCMD_NODFS_SET,                               /* 0x100D */
     WIFI_SUBCMD_SET_COUNTRY_CODE,                             /* 0x100E */
     /* Add more sub commands here */
     GSCAN_SUBCMD_SET_EPNO_SSID,                          /* 0x100F */

     WIFI_SUBCMD_SET_SSID_WHITE_LIST,                    /* 0x1010 */
     WIFI_SUBCMD_SET_ROAM_PARAMS,                        /* 0x1011 */
     WIFI_SUBCMD_ENABLE_LAZY_ROAM,                       /* 0x1012 */
     WIFI_SUBCMD_SET_BSSID_PREF,                         /* 0x1013 */
     WIFI_SUBCMD_SET_BSSID_BLACKLIST,                     /* 0x1014 */

     GSCAN_SUBCMD_ANQPO_CONFIG,                          /* 0x1015 */
     WIFI_SUBCMD_SET_RSSI_MONITOR,                       /* 0x1016 */
     WIFI_SUBCMD_CONFIG_ND_OFFLOAD,                      /* 0x1017 */
     /* Add more sub commands here */

     GSCAN_SUBCMD_MAX,

     APF_SUBCMD_GET_CAPABILITIES = ANDROID_NL80211_SUBCMD_PKT_FILTER_RANGE_START,
     APF_SUBCMD_SET_FILTER,
 } WIFI_SUB_COMMAND;

 typedef enum {
     BRCM_RESERVED1,
     BRCM_RESERVED2,
     GSCAN_EVENT_SIGNIFICANT_CHANGE_RESULTS ,
     GSCAN_EVENT_HOTLIST_RESULTS_FOUND,
     GSCAN_EVENT_SCAN_RESULTS_AVAILABLE,
     GSCAN_EVENT_FULL_SCAN_RESULTS,
     RTT_EVENT_COMPLETE,
     GSCAN_EVENT_COMPLETE_SCAN,
     GSCAN_EVENT_HOTLIST_RESULTS_LOST,
     GSCAN_EVENT_EPNO_EVENT,
     GOOGLE_DEBUG_RING_EVENT,
     GOOGLE_DEBUG_MEM_DUMP_EVENT,
     GSCAN_EVENT_ANQPO_HOTSPOT_MATCH,
     GOOGLE_RSSI_MONITOR_EVENT
 } WIFI_EVENT;

 typedef void (*wifi_internal_event_handler) (wifi_handle handle, int events);

 class WifiCommand;

 typedef struct {
     int nl_cmd;
     uint32_t vendor_id;
     int vendor_subcmd;
     nl_recvmsg_msg_cb_t cb_func;
     void *cb_arg;
 } cb_info;

 typedef struct {
     wifi_request_id id;
     WifiCommand *cmd;
 } cmd_info;

 typedef struct {
     wifi_handle handle;                             // handle to wifi data
     char name[IFNAMSIZ+1];                          // interface name + trailing null
     int  id;                                        // id to use when talking to driver
 } interface_info;

 typedef struct {

     struct nl_sock *cmd_sock;                       // command socket object
     struct nl_sock *event_sock;                     // event socket object
     int nl80211_family_id;                          // family id for 80211 driver
     int cleanup_socks[2];                           // sockets used to implement wifi_cleanup

     bool in_event_loop;                             // Indicates that event loop is active
     bool clean_up;                                  // Indication to exit since cleanup has started

     wifi_internal_event_handler event_handler;      // default event handler
     wifi_cleaned_up_handler cleaned_up_handler;     // socket cleaned up handler

     cb_info *event_cb;                              // event callbacks
     int num_event_cb;                               // number of event callbacks
     int alloc_event_cb;                             // number of allocated callback objects
     pthread_mutex_t cb_lock;                        // mutex for the event_cb access

     cmd_info *cmd;                                  // Outstanding commands
     int num_cmd;                                    // number of commands
     int alloc_cmd;                                  // number of commands allocated

     interface_info **interfaces;                    // array of interfaces
     int num_interfaces;                             // number of interfaces


     // add other details
 } hal_info;

 #define PNO_SSID_FOUND  0x1
 #define PNO_SSID_LOST    0x2

 typedef struct wifi_pno_result {
     unsigned char ssid[DOT11_MAX_SSID_LEN];
     unsigned char ssid_len;
     signed char rssi;
     u16 channel;
     u16 flags;
     mac_addr  bssid;
 } wifi_pno_result_t;

 typedef struct wifi_gscan_result {
     u64 ts;                           // Time of discovery
     u8 ssid[DOT11_MAX_SSID_LEN+1];    // null terminated
     mac_addr bssid;                   // BSSID
     u32 channel;                      // channel frequency in MHz
     s32 rssi;                         // in db
     u64 rtt;                          // in nanoseconds
     u64 rtt_sd;                       // standard deviation in rtt
     u16 beacon_period;                // units are Kusec
     u16 capability;                   // Capability information
     u32 pad;
 } wifi_gscan_result_t;

 typedef struct wifi_gscan_full_result {
     wifi_gscan_result_t fixed;
     u32 scan_ch_bucket;              // scan chbucket bitmask
     u32 ie_length;                   // byte length of Information Elements
     u8  ie_data[1];                  // IE data to follow
 } wifi_gscan_full_result_t;

 wifi_error wifi_register_handler(wifi_handle handle, int cmd, nl_recvmsg_msg_cb_t func, void *arg);
 wifi_error wifi_register_vendor_handler(wifi_handle handle,
             uint32_t id, int subcmd, nl_recvmsg_msg_cb_t func, void *arg);

 void wifi_unregister_handler(wifi_handle handle, int cmd);
 void wifi_unregister_vendor_handler(wifi_handle handle, uint32_t id, int subcmd);

 wifi_error wifi_register_cmd(wifi_handle handle, int id, WifiCommand *cmd);
 WifiCommand *wifi_unregister_cmd(wifi_handle handle, int id);
 WifiCommand *wifi_get_cmd(wifi_handle handle, int id);
 void wifi_unregister_cmd(wifi_handle handle, WifiCommand *cmd);

 interface_info *getIfaceInfo(wifi_interface_handle);
 wifi_handle getWifiHandle(wifi_interface_handle handle);
 hal_info *getHalInfo(wifi_handle handle);
 hal_info *getHalInfo(wifi_interface_handle handle);
 wifi_handle getWifiHandle(hal_info *info);
 wifi_interface_handle getIfaceHandle(interface_info *info);
 wifi_error wifi_cancel_cmd(wifi_request_id id, wifi_interface_handle iface);

 // some common macros

 #define min(x, y)       ((x) < (y) ? (x) : (y))
 #define max(x, y)       ((x) > (y) ? (x) : (y))

 #define NULL_CHECK_RETURN(ptr, str, ret) \
     do { \
         if (!(ptr)) { \
             ALOGE("%s(): null pointer - #ptr (%s)\n", __FUNCTION__, str); \
             return ret; \
         } \
     } while (0)

 #endif
	/*
	* Copyright (C) 2017 The Android Open Source Project
	*
	* Portions copyright (C) 2017 Broadcom Limited
	*
	* Licensed under the Apache License, Version 2.0 (the "License");
	* you may not use this file except in compliance with the License.
	* You may obtain a copy of the License at
	*
	* http://www.apache.org/licenses/LICENSE-2.0
	*
	* Unless required by applicable law or agreed to in writing, software
	* distributed under the License is distributed on an "AS IS" BASIS,
	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	* See the License for the specific language governing permissions and
	* limitations under the License.
	*/

	#include "wifi_hal.h"

	#ifndef __WIFI_HAL_COMMON_H__
	#define __WIFI_HAL_COMMON_H__

	#define LOG_TAG "WifiHAL"

	#include <log/log.h>
	#include "nl80211_copy.h"
	#include "sync.h"

	#define SOCKET_BUFFER_SIZE (32768U)
	#define RECV_BUF_SIZE (4096)
	#define DEFAULT_EVENT_CB_SIZE (64)
	#define DEFAULT_CMD_SIZE (64)
	#define DOT11_OUI_LEN 3
	#define DOT11_MAX_SSID_LEN 32

	#define MAX_PROBE_RESP_IE_LEN 2048
	/*
	Vendor OUI - This is a unique identifier that identifies organization. Lets
	code Android specific functions with Google OUI; although vendors can do more
	with their own OUI's as well.
	*/

	const uint32_t GOOGLE_OUI = 0x001A11;
	/* TODO: define vendor OUI here */


	/*
	This enum defines ranges for various commands; commands themselves
	can be defined in respective feature headers; i.e. find gscan command
	definitions in gscan.cpp
	*/

	typedef enum {
	/* don't use 0 as a valid subcommand */
	VENDOR_NL80211_SUBCMD_UNSPECIFIED,

	/* define all vendor startup commands between 0x0 and 0x0FFF */
	VENDOR_NL80211_SUBCMD_RANGE_START = 0x0001,
	VENDOR_NL80211_SUBCMD_RANGE_END = 0x0FFF,

	/* define all GScan related commands between 0x1000 and 0x10FF */
	ANDROID_NL80211_SUBCMD_GSCAN_RANGE_START = 0x1000,
	ANDROID_NL80211_SUBCMD_GSCAN_RANGE_END = 0x10FF,

	/* define all NearbyDiscovery related commands between 0x1100 and 0x11FF */
	ANDROID_NL80211_SUBCMD_NBD_RANGE_START = 0x1100,
	ANDROID_NL80211_SUBCMD_NBD_RANGE_END = 0x11FF,

	/* define all RTT related commands between 0x1100 and 0x11FF */
	ANDROID_NL80211_SUBCMD_RTT_RANGE_START = 0x1100,
	ANDROID_NL80211_SUBCMD_RTT_RANGE_END = 0x11FF,

	ANDROID_NL80211_SUBCMD_LSTATS_RANGE_START = 0x1200,
	ANDROID_NL80211_SUBCMD_LSTATS_RANGE_END = 0x12FF,

	/* define all Logger related commands between 0x1400 and 0x14FF */
	ANDROID_NL80211_SUBCMD_DEBUG_RANGE_START = 0x1400,
	ANDROID_NL80211_SUBCMD_DEBUG_RANGE_END = 0x14FF,

	/* define all wifi offload related commands between 0x1600 and 0x16FF */
	ANDROID_NL80211_SUBCMD_WIFI_OFFLOAD_RANGE_START = 0x1600,
	ANDROID_NL80211_SUBCMD_WIFI_OFFLOAD_RANGE_END = 0x16FF,

	/* define all NAN related commands between 0x1700 and 0x17FF */
	ANDROID_NL80211_SUBCMD_NAN_RANGE_START = 0x1700,
	ANDROID_NL80211_SUBCMD_NAN_RANGE_END = 0x17FF,

	/* define all Android Packet Filter related commands between 0x1800 and 0x18FF */
	ANDROID_NL80211_SUBCMD_PKT_FILTER_RANGE_START = 0x1800,
	ANDROID_NL80211_SUBCMD_PKT_FILTER_RANGE_END = 0x18FF,

	/* This is reserved for future usage */

	} ANDROID_VENDOR_SUB_COMMAND;

	typedef enum {

	GSCAN_SUBCMD_GET_CAPABILITIES = ANDROID_NL80211_SUBCMD_GSCAN_RANGE_START,

	GSCAN_SUBCMD_SET_CONFIG, /* 0x1001 */

	GSCAN_SUBCMD_SET_SCAN_CONFIG, /* 0x1002 */
	GSCAN_SUBCMD_ENABLE_GSCAN, /* 0x1003 */
	GSCAN_SUBCMD_GET_SCAN_RESULTS, /* 0x1004 */
	GSCAN_SUBCMD_SCAN_RESULTS, /* 0x1005 */

	GSCAN_SUBCMD_SET_HOTLIST, /* 0x1006 */

	GSCAN_SUBCMD_SET_SIGNIFICANT_CHANGE_CONFIG, /* 0x1007 */
	GSCAN_SUBCMD_ENABLE_FULL_SCAN_RESULTS, /* 0x1008 */
	GSCAN_SUBCMD_GET_CHANNEL_LIST, /* 0x1009 */

	WIFI_SUBCMD_GET_FEATURE_SET, /* 0x100A */
	WIFI_SUBCMD_GET_FEATURE_SET_MATRIX, /* 0x100B */
	WIFI_SUBCMD_SET_PNO_RANDOM_MAC_OUI, /* 0x100C */
	WIFI_SUBCMD_NODFS_SET, /* 0x100D */
	WIFI_SUBCMD_SET_COUNTRY_CODE, /* 0x100E */
	/* Add more sub commands here */
	GSCAN_SUBCMD_SET_EPNO_SSID, /* 0x100F */

	WIFI_SUBCMD_SET_SSID_WHITE_LIST, /* 0x1010 */
	WIFI_SUBCMD_SET_ROAM_PARAMS, /* 0x1011 */
	WIFI_SUBCMD_ENABLE_LAZY_ROAM, /* 0x1012 */
	WIFI_SUBCMD_SET_BSSID_PREF, /* 0x1013 */
	WIFI_SUBCMD_SET_BSSID_BLACKLIST, /* 0x1014 */

	GSCAN_SUBCMD_ANQPO_CONFIG, /* 0x1015 */
	WIFI_SUBCMD_SET_RSSI_MONITOR, /* 0x1016 */
	WIFI_SUBCMD_CONFIG_ND_OFFLOAD, /* 0x1017 */
	/* Add more sub commands here */

	GSCAN_SUBCMD_MAX,

	APF_SUBCMD_GET_CAPABILITIES = ANDROID_NL80211_SUBCMD_PKT_FILTER_RANGE_START,
	APF_SUBCMD_SET_FILTER,
	} WIFI_SUB_COMMAND;

	typedef enum {
	BRCM_RESERVED1,
	BRCM_RESERVED2,
	GSCAN_EVENT_SIGNIFICANT_CHANGE_RESULTS ,
	GSCAN_EVENT_HOTLIST_RESULTS_FOUND,
	GSCAN_EVENT_SCAN_RESULTS_AVAILABLE,
	GSCAN_EVENT_FULL_SCAN_RESULTS,
	RTT_EVENT_COMPLETE,
	GSCAN_EVENT_COMPLETE_SCAN,
	GSCAN_EVENT_HOTLIST_RESULTS_LOST,
	GSCAN_EVENT_EPNO_EVENT,
	GOOGLE_DEBUG_RING_EVENT,
	GOOGLE_DEBUG_MEM_DUMP_EVENT,
	GSCAN_EVENT_ANQPO_HOTSPOT_MATCH,
	GOOGLE_RSSI_MONITOR_EVENT
	} WIFI_EVENT;

	typedef void (*wifi_internal_event_handler) (wifi_handle handle, int events);

	class WifiCommand;

	typedef struct {
	int nl_cmd;
	uint32_t vendor_id;
	int vendor_subcmd;
	nl_recvmsg_msg_cb_t cb_func;
	void *cb_arg;
	} cb_info;

	typedef struct {
	wifi_request_id id;
	WifiCommand *cmd;
	} cmd_info;

	typedef struct {
	wifi_handle handle; // handle to wifi data
	char name[IFNAMSIZ+1]; // interface name + trailing null
	int id; // id to use when talking to driver
	} interface_info;

	typedef struct {

	struct nl_sock *cmd_sock; // command socket object
	struct nl_sock *event_sock; // event socket object
	int nl80211_family_id; // family id for 80211 driver
	int cleanup_socks[2]; // sockets used to implement wifi_cleanup

	bool in_event_loop; // Indicates that event loop is active
	bool clean_up; // Indication to exit since cleanup has started

	wifi_internal_event_handler event_handler; // default event handler
	wifi_cleaned_up_handler cleaned_up_handler; // socket cleaned up handler

	cb_info *event_cb; // event callbacks
	int num_event_cb; // number of event callbacks
	int alloc_event_cb; // number of allocated callback objects
	pthread_mutex_t cb_lock; // mutex for the event_cb access

	cmd_info *cmd; // Outstanding commands
	int num_cmd; // number of commands
	int alloc_cmd; // number of commands allocated

	interface_info **interfaces; // array of interfaces
	int num_interfaces; // number of interfaces


	// add other details
	} hal_info;

	#define PNO_SSID_FOUND 0x1
	#define PNO_SSID_LOST 0x2

	typedef struct wifi_pno_result {
	unsigned char ssid[DOT11_MAX_SSID_LEN];
	unsigned char ssid_len;
	signed char rssi;
	u16 channel;
	u16 flags;
	mac_addr bssid;
	} wifi_pno_result_t;

	typedef struct wifi_gscan_result {
	u64 ts; // Time of discovery
	u8 ssid[DOT11_MAX_SSID_LEN+1]; // null terminated
	mac_addr bssid; // BSSID
	u32 channel; // channel frequency in MHz
	s32 rssi; // in db
	u64 rtt; // in nanoseconds
	u64 rtt_sd; // standard deviation in rtt
	u16 beacon_period; // units are Kusec
	u16 capability; // Capability information
	u32 pad;
	} wifi_gscan_result_t;

	typedef struct wifi_gscan_full_result {
	wifi_gscan_result_t fixed;
	u32 scan_ch_bucket; // scan chbucket bitmask
	u32 ie_length; // byte length of Information Elements
	u8 ie_data[1]; // IE data to follow
	} wifi_gscan_full_result_t;

	wifi_error wifi_register_handler(wifi_handle handle, int cmd, nl_recvmsg_msg_cb_t func, void *arg);
	wifi_error wifi_register_vendor_handler(wifi_handle handle,
	uint32_t id, int subcmd, nl_recvmsg_msg_cb_t func, void *arg);

	void wifi_unregister_handler(wifi_handle handle, int cmd);
	void wifi_unregister_vendor_handler(wifi_handle handle, uint32_t id, int subcmd);

	wifi_error wifi_register_cmd(wifi_handle handle, int id, WifiCommand *cmd);
	WifiCommand *wifi_unregister_cmd(wifi_handle handle, int id);
	WifiCommand *wifi_get_cmd(wifi_handle handle, int id);
	void wifi_unregister_cmd(wifi_handle handle, WifiCommand *cmd);

	interface_info *getIfaceInfo(wifi_interface_handle);
	wifi_handle getWifiHandle(wifi_interface_handle handle);
	hal_info *getHalInfo(wifi_handle handle);
	hal_info *getHalInfo(wifi_interface_handle handle);
	wifi_handle getWifiHandle(hal_info *info);
	wifi_interface_handle getIfaceHandle(interface_info *info);
	wifi_error wifi_cancel_cmd(wifi_request_id id, wifi_interface_handle iface);

	// some common macros

	#define min(x, y) ((x) < (y) ? (x) : (y))
	#define max(x, y) ((x) > (y) ? (x) : (y))

	#define NULL_CHECK_RETURN(ptr, str, ret) \
	do { \
	if (!(ptr)) { \
	ALOGE("%s(): null pointer - #ptr (%s)\n", __FUNCTION__, str); \
	return ret; \
	} \
	} while (0)

	#endif