• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 #ifndef __WIFI_HAL_H__
18 #define __WIFI_HAL_H__
19 
20 #include <stdint.h>
21 
22 typedef enum {
23     WIFI_SUCCESS = 0,
24     WIFI_ERROR_NONE = 0,
25     WIFI_ERROR_UNKNOWN = -1,
26     WIFI_ERROR_UNINITIALIZED = -2,
27     WIFI_ERROR_NOT_SUPPORTED = -3,
28     WIFI_ERROR_NOT_AVAILABLE = -4,              // Not available right now, but try later
29     WIFI_ERROR_INVALID_ARGS = -5,
30     WIFI_ERROR_INVALID_REQUEST_ID = -6,
31     WIFI_ERROR_TIMED_OUT = -7,
32     WIFI_ERROR_TOO_MANY_REQUESTS = -8,          // Too many instances of this request
33     WIFI_ERROR_OUT_OF_MEMORY = -9
34 } wifi_error;
35 
36 typedef unsigned char byte;
37 typedef unsigned char u8;
38 typedef signed char s8;
39 typedef uint16_t u16;
40 typedef uint32_t u32;
41 typedef uint64_t u64;
42 typedef int wifi_request_id;
43 typedef int wifi_channel;                       // indicates channel frequency in MHz
44 typedef int wifi_rssi;
45 typedef byte mac_addr[6];
46 typedef byte oui[3];
47 typedef int64_t wifi_timestamp;                 // In microseconds (us)
48 typedef int64_t wifi_timespan;                  // In nanoseconds  (ns)
49 
50 struct wifi_info;
51 typedef wifi_info *wifi_handle;
52 struct wifi_interface_info;
53 typedef wifi_interface_info *wifi_interface_handle;
54 
55 /* Initialize/Cleanup */
56 
57 wifi_error wifi_initialize(wifi_handle *handle);
58 typedef void (*wifi_cleaned_up_handler) (wifi_handle handle);
59 void wifi_cleanup(wifi_handle handle, wifi_cleaned_up_handler handler);
60 void wifi_event_loop(wifi_handle handle);
61 
62 /* Error handling */
63 void wifi_get_error_info(wifi_error err, const char **msg); // return a pointer to a static string
64 
65 /* Feature enums */
66 #define WIFI_FEATURE_INFRA              0x0001      // Basic infrastructure mode
67 #define WIFI_FEATURE_INFRA_5G           0x0002      // Support for 5 GHz Band
68 #define WIFI_FEATURE_HOTSPOT            0x0004      // Support for GAS/ANQP
69 #define WIFI_FEATURE_P2P                0x0008      // Wifi-Direct
70 #define WIFI_FEATURE_SOFT_AP            0x0010      // Soft AP
71 #define WIFI_FEATURE_GSCAN              0x0020      // Google-Scan APIs
72 #define WIFI_FEATURE_NAN                0x0040      // Neighbor Awareness Networking
73 #define WIFI_FEATURE_D2D_RTT            0x0080      // Device-to-device RTT
74 #define WIFI_FEATURE_D2AP_RTT           0x0100      // Device-to-AP RTT
75 #define WIFI_FEATURE_BATCH_SCAN         0x0200      // Batched Scan (legacy)
76 #define WIFI_FEATURE_PNO                0x0400      // Preferred network offload
77 #define WIFI_FEATURE_ADDITIONAL_STA     0x0800      // Support for two STAs
78 #define WIFI_FEATURE_TDLS               0x1000      // Tunnel directed link setup
79 #define WIFI_FEATURE_TDLS_OFFCHANNEL    0x2000      // Support for TDLS off channel
80 #define WIFI_FEATURE_EPR                0x4000      // Enhanced power reporting
81 #define WIFI_FEATURE_AP_STA             0x8000      // Support for AP STA Concurrency
82 #define WIFI_FEATURE_LINK_LAYER_STATS  0x10000      // Link layer stats collection
83 // Add more features here
84 
85 typedef int feature_set;
86 
87 #define IS_MASK_SET(mask, flags)        ((flags & mask) == mask)
88 #define IS_MASK_RESET(mask, flags)      ((flags & mask) == 0)
89 
90 #define IS_SUPPORTED_FEATURE(feature, featureSet)       IS_MASK_SET(feature, fetureSet)
91 #define IS_UNSUPPORTED_FEATURE(feature, featureSet)     IS_MASK_RESET(feature, fetureSet)
92 
93 /* Feature set */
94 wifi_error wifi_get_supported_feature_set(wifi_interface_handle handle, feature_set *set);
95 
96 /*
97  * Each row represents a valid feature combination;
98  * all other combinations are invalid!
99  */
100 wifi_error wifi_get_concurrency_matrix(wifi_interface_handle handle, int set_size_max,
101        feature_set set[], int *set_size);
102 
103 /* multiple interface support */
104 
105 wifi_error wifi_get_ifaces(wifi_handle handle, int *num_ifaces, wifi_interface_handle **ifaces);
106 wifi_error wifi_get_iface_name(wifi_interface_handle iface, char *name, size_t size);
107 
108 /* Configuration events */
109 
110 typedef struct {
111     void (*on_country_code_changed)(char code[2]);      // We can get this from supplicant too
112 
113     // More event handlers
114 } wifi_event_handler;
115 
116 wifi_error wifi_set_iface_event_handler(wifi_request_id id, wifi_interface_handle iface, wifi_event_handler eh);
117 wifi_error wifi_reset_iface_event_handler(wifi_request_id id, wifi_interface_handle iface);
118 
119 wifi_error wifi_set_nodfs_flag(wifi_interface_handle handle, u32 nodfs);
120 
121 /* include various feature headers */
122 
123 #include "gscan.h"
124 #include "link_layer_stats.h"
125 #include "rtt.h"
126 #include "tdls.h"
127 
128 #endif
129 
130