include/hardware_legacy/wifi_hal.h

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