1 2 #include "wifi_hal.h" 3 #include "gscan.h" 4 5 #ifndef __WIFI_HAL_RTT_H__ 6 #define __WIFI_HAL_RTT_H__ 7 8 /* Ranging status */ 9 typedef enum { 10 RTT_STATUS_SUCCESS = 0, 11 RTT_STATUS_FAILURE = 1, // general failure status 12 RTT_STATUS_FAIL_NO_RSP = 2, // target STA does not respond to request 13 RTT_STATUS_FAIL_REJECTED = 3, // request rejected. Applies to 2-sided RTT only 14 RTT_STATUS_FAIL_NOT_SCHEDULED_YET = 4, 15 RTT_STATUS_FAIL_TM_TIMEOUT = 5, // timing measurement times out 16 RTT_STATUS_FAIL_AP_ON_DIFF_CHANNEL = 6, // Target on different channel, cannot range 17 RTT_STATUS_FAIL_NO_CAPABILITY = 7, // ranging not supported 18 RTT_STATUS_ABORTED = 8, // request aborted for unknown reason 19 RTT_STATUS_FAIL_INVALID_TS = 9, // Invalid T1-T4 timestamp 20 RTT_STATUS_FAIL_PROTOCOL = 10, // 11mc protocol failed 21 RTT_STATUS_FAIL_SCHEDULE = 11, // request could not be scheduled 22 RTT_STATUS_FAIL_BUSY_TRY_LATER = 12, // responder cannot collaborate at time of request 23 RTT_STATUS_INVALID_REQ = 13, // bad request args 24 RTT_STATUS_NO_WIFI = 14, // WiFi not enabled 25 RTT_STATUS_FAIL_FTM_PARAM_OVERRIDE = 15, // Responder overrides param info, cannot range with new params 26 RTT_STATUS_NAN_RANGING_PROTOCOL_FAILURE =16, //Negotiation failure 27 RTT_STATUS_NAN_RANGING_CONCURRENCY_NOT_SUPPORTED=17, //concurrency not supported (NDP+RTT) 28 } wifi_rtt_status; 29 30 /* RTT peer type */ 31 typedef enum { 32 RTT_PEER_AP = 0x1, 33 RTT_PEER_STA = 0x2, 34 RTT_PEER_P2P_GO = 0x3, 35 RTT_PEER_P2P_CLIENT = 0x4, 36 RTT_PEER_NAN = 0x5 37 } rtt_peer_type; 38 39 /* RTT Measurement Bandwidth */ 40 typedef enum { 41 WIFI_RTT_BW_UNSPECIFIED = 0x00, 42 WIFI_RTT_BW_5 = 0x01, 43 WIFI_RTT_BW_10 = 0x02, 44 WIFI_RTT_BW_20 = 0x04, 45 WIFI_RTT_BW_40 = 0x08, 46 WIFI_RTT_BW_80 = 0x10, 47 WIFI_RTT_BW_160 = 0x20, 48 WIFI_RTT_BW_320 = 0x40 49 } wifi_rtt_bw; 50 51 /* RTT Measurement Preamble */ 52 typedef enum { 53 WIFI_RTT_PREAMBLE_LEGACY = 0x1, 54 WIFI_RTT_PREAMBLE_HT = 0x2, 55 WIFI_RTT_PREAMBLE_VHT = 0x4, 56 WIFI_RTT_PREAMBLE_HE = 0x8, 57 WIFI_RTT_PREAMBLE_EHT = 0x10, 58 } wifi_rtt_preamble; 59 60 /* RTT Type */ 61 typedef enum { 62 RTT_TYPE_1_SIDED = 0x1, 63 RTT_TYPE_2_SIDED = 0x2, 64 } wifi_rtt_type; 65 66 /* RTT configuration */ 67 typedef struct { 68 mac_addr addr; // peer device mac address 69 wifi_rtt_type type; // 1-sided or 2-sided RTT 70 rtt_peer_type peer; // optional - peer device hint (STA, P2P, AP) 71 wifi_channel_info channel; // Required for STA-AP mode, optional for P2P, NBD etc. 72 unsigned burst_period; // Time interval between bursts (units: 100 ms). 73 // Applies to 1-sided and 2-sided RTT multi-burst requests. 74 // Range: 0-31, 0: no preference by initiator (2-sided RTT) 75 unsigned num_burst; // Total number of RTT bursts to be executed. It will be 76 // specified in the same way as the parameter "Number of 77 // Burst Exponent" found in the FTM frame format. It 78 // applies to both: 1-sided RTT and 2-sided RTT. Valid 79 // values are 0 to 15 as defined in 802.11mc std. 80 // 0 means single shot 81 // The implication of this parameter on the maximum 82 // number of RTT results is the following: 83 // for 1-sided RTT: max num of RTT results = (2^num_burst)*(num_frames_per_burst) 84 // for 2-sided RTT: max num of RTT results = (2^num_burst)*(num_frames_per_burst - 1) 85 unsigned num_frames_per_burst; // num of frames per burst. 86 // Minimum value = 1, Maximum value = 31 87 // For 2-sided this equals the number of FTM frames 88 // to be attempted in a single burst. This also 89 // equals the number of FTM frames that the 90 // initiator will request that the responder send 91 // in a single frame. 92 unsigned num_retries_per_rtt_frame; // number of retries for a failed RTT frame. Applies 93 // to 1-sided RTT only. Minimum value = 0, Maximum value = 3 94 95 //following fields are only valid for 2-side RTT 96 unsigned num_retries_per_ftmr; // Maximum number of retries that the initiator can 97 // retry an FTMR frame. 98 // Minimum value = 0, Maximum value = 3 99 byte LCI_request; // 1: request LCI, 0: do not request LCI 100 byte LCR_request; // 1: request LCR, 0: do not request LCR 101 unsigned burst_duration; // Applies to 1-sided and 2-sided RTT. Valid values will 102 // be 2-11 and 15 as specified by the 802.11mc std for 103 // the FTM parameter burst duration. In a multi-burst 104 // request, if responder overrides with larger value, 105 // the initiator will return failure. In a single-burst 106 // request if responder overrides with larger value, 107 // the initiator will sent TMR_STOP to terminate RTT 108 // at the end of the burst_duration it requested. 109 wifi_rtt_preamble preamble; // RTT preamble to be used in the RTT frames 110 wifi_rtt_bw bw; // RTT BW to be used in the RTT frames 111 } wifi_rtt_config; 112 113 /* RTT results */ 114 typedef struct { 115 mac_addr addr; // device mac address 116 unsigned burst_num; // burst number in a multi-burst request 117 unsigned measurement_number; // Total RTT measurement frames attempted 118 unsigned success_number; // Total successful RTT measurement frames 119 byte number_per_burst_peer; // Maximum number of "FTM frames per burst" supported by 120 // the responder STA. Applies to 2-sided RTT only. 121 // If reponder overrides with larger value: 122 // - for single-burst request initiator will truncate the 123 // larger value and send a TMR_STOP after receiving as 124 // many frames as originally requested. 125 // - for multi-burst request, initiator will return 126 // failure right away. 127 wifi_rtt_status status; // ranging status 128 byte retry_after_duration; // When status == RTT_STATUS_FAIL_BUSY_TRY_LATER, 129 // this will be the time provided by the responder as to 130 // when the request can be tried again. Applies to 2-sided 131 // RTT only. In sec, 1-31sec. 132 wifi_rtt_type type; // RTT type 133 wifi_rssi rssi; // average rssi in 0.5 dB steps e.g. 143 implies -71.5 dB 134 wifi_rssi rssi_spread; // rssi spread in 0.5 dB steps e.g. 5 implies 2.5 dB spread (optional) 135 wifi_rate tx_rate; // 1-sided RTT: TX rate of RTT frame. 136 // 2-sided RTT: TX rate of initiator's Ack in response to FTM frame. 137 wifi_rate rx_rate; // 1-sided RTT: TX rate of Ack from other side. 138 // 2-sided RTT: TX rate of FTM frame coming from responder. 139 wifi_timespan rtt; // round trip time in picoseconds 140 wifi_timespan rtt_sd; // rtt standard deviation in picoseconds 141 wifi_timespan rtt_spread; // difference between max and min rtt times recorded in picoseconds 142 int distance_mm; // distance in mm (optional) 143 int distance_sd_mm; // standard deviation in mm (optional) 144 int distance_spread_mm; // difference between max and min distance recorded in mm (optional) 145 wifi_timestamp ts; // time of the measurement (in microseconds since boot) 146 int burst_duration; // in ms, actual time taken by the FW to finish one burst 147 // measurement. Applies to 1-sided and 2-sided RTT. 148 int negotiated_burst_num; // Number of bursts allowed by the responder. Applies 149 // to 2-sided RTT only. 150 wifi_information_element *LCI; // for 11mc only 151 wifi_information_element *LCR; // for 11mc only 152 } wifi_rtt_result; 153 154 /* RTT results version 2 */ 155 typedef struct { 156 wifi_rtt_result rtt_result; // Legacy wifi rtt result structure 157 wifi_channel frequency; // primary channel frequency (MHz) used for ranging measurements 158 // If frequency is unknown, this will be set to |UNSPECIFIED(-1)| 159 wifi_rtt_bw packet_bw; // RTT packet bandwidth is an average BW of the BWs of RTT frames. 160 // Cap the average close to a specific valid RttBw. 161 } wifi_rtt_result_v2; 162 163 /* RTT result callbacks */ 164 typedef struct { 165 /* 166 * This callback is deprecated on Android 14 and onwards. 167 * Newer implementations should support on_rtt_results_v2 callback 168 */ 169 void (*on_rtt_results) (wifi_request_id id, unsigned num_results, wifi_rtt_result *rtt_result[]); 170 /* Called when vendor implementation supports sending RTT results version 2 */ 171 void (*on_rtt_results_v2) (wifi_request_id id, unsigned num_results, wifi_rtt_result_v2 *rtt_result_v2[]); 172 } wifi_rtt_event_handler; 173 174 /* API to request RTT measurement */ 175 wifi_error wifi_rtt_range_request(wifi_request_id id, wifi_interface_handle iface, 176 unsigned num_rtt_config, wifi_rtt_config rtt_config[], wifi_rtt_event_handler handler); 177 178 /* API to cancel RTT measurements */ 179 wifi_error wifi_rtt_range_cancel(wifi_request_id id, wifi_interface_handle iface, 180 unsigned num_devices, mac_addr addr[]); 181 182 /* NBD ranging channel map */ 183 typedef struct { 184 wifi_channel availablity[32]; // specifies the channel map for each of the 16 TU windows 185 // frequency of 0 => unspecified; which means firmware is 186 // free to do whatever it wants in this window. 187 } wifi_channel_map; 188 189 /* API to start publishing the channel map on responder device in a NBD cluster. 190 Responder device will take this request and schedule broadcasting the channel map 191 in a NBD ranging attribute in a SDF. DE will automatically remove the ranging 192 attribute from the OTA queue after number of DW specified by num_dw 193 where Each DW is 512 TUs apart */ 194 wifi_error wifi_rtt_channel_map_set(wifi_request_id id, 195 wifi_interface_handle iface, wifi_channel_map *params, unsigned num_dw); 196 197 /* API to clear the channel map on the responder device in a NBD cluster. 198 Responder device will cancel future ranging channel request, starting from “next” 199 DW interval and will also stop broadcasting NBD ranging attribute in SDF */ 200 wifi_error wifi_rtt_channel_map_clear(wifi_request_id id, wifi_interface_handle iface); 201 202 // Preamble definition for bit mask used in wifi_rtt_capabilities 203 #define PREAMBLE_LEGACY 0x1 204 #define PREAMBLE_HT 0x2 205 #define PREAMBLE_VHT 0x4 206 #define PREAMBLE_HE 0x8 207 #define PREAMBLE_EHT 0x10 208 209 // BW definition for bit mask used in wifi_rtt_capabilities 210 #define BW_5_SUPPORT 0x1 211 #define BW_10_SUPPORT 0x2 212 #define BW_20_SUPPORT 0x4 213 #define BW_40_SUPPORT 0x8 214 #define BW_80_SUPPORT 0x10 215 #define BW_160_SUPPORT 0x20 216 #define BW_320_SUPPORT 0x40 217 218 /* RTT Capabilities */ 219 typedef struct { 220 byte rtt_one_sided_supported; // if 1-sided rtt data collection is supported 221 byte rtt_ftm_supported; // if ftm rtt data collection is supported 222 byte lci_support; // if initiator supports LCI request. Applies to 2-sided RTT 223 byte lcr_support; // if initiator supports LCR request. Applies to 2-sided RTT 224 byte preamble_support; // bit mask indicates what preamble is supported by initiator 225 byte bw_support; // bit mask indicates what BW is supported by initiator 226 byte responder_supported; // if 11mc responder mode is supported 227 byte mc_version; // draft 11mc spec version supported by chip. For instance, 228 // version 4.0 should be 40 and version 4.3 should be 43 etc. 229 } wifi_rtt_capabilities; 230 231 /* RTT capabilities of the device */ 232 wifi_error wifi_get_rtt_capabilities(wifi_interface_handle iface, wifi_rtt_capabilities *capabilities); 233 234 /* debugging definitions */ 235 enum { 236 RTT_DEBUG_DISABLE, 237 RTT_DEBUG_LOG, 238 RTT_DEBUG_PROTO, 239 RTT_DEBUG_BURST, 240 RTT_DEBUG_ACCURACY, 241 RTT_DEBUG_LOGDETAIL 242 }; //rtt debug type 243 244 enum { 245 RTT_DEBUG_FORMAT_TXT, 246 RTT_DEBUG_FORMAT_BINARY 247 }; //rtt debug format 248 249 typedef struct rtt_debug { 250 unsigned version; 251 unsigned len; // total length of after len field 252 unsigned type; // rtt debug type 253 unsigned format; //rtt debug format 254 char dbuf[0]; // debug content 255 } rtt_debug_t; 256 257 /* set configuration for debug */ 258 wifi_error wifi_rtt_debug_cfg(wifi_interface_handle h, unsigned rtt_dbg_type, char *cfgbuf, unsigned cfg_buf_size); 259 /* get the debug information */ 260 wifi_error wifi_rtt_debug_get(wifi_interface_handle h, rtt_debug_t **debugbuf); 261 /* free the debug buffer */ 262 wifi_error wifi_rtt_debug_free(wifi_interface_handle h, rtt_debug_t *debugbuf); 263 264 /* API for setting LCI/LCR information to be provided to a requestor */ 265 typedef enum { 266 WIFI_MOTION_NOT_EXPECTED = 0, // Not expected to change location 267 WIFI_MOTION_EXPECTED = 1, // Expected to change location 268 WIFI_MOTION_UNKNOWN = 2, // Movement pattern unknown 269 } wifi_motion_pattern; 270 271 typedef struct { 272 long latitude; // latitude in degrees * 2^25 , 2's complement 273 long longitude; // latitude in degrees * 2^25 , 2's complement 274 int altitude; // Altitude in units of 1/256 m 275 byte latitude_unc; // As defined in Section 2.3.2 of IETF RFC 6225 276 byte longitude_unc; // As defined in Section 2.3.2 of IETF RFC 6225 277 byte altitude_unc; // As defined in Section 2.4.5 from IETF RFC 6225: 278 279 //Following element for configuring the Z subelement 280 wifi_motion_pattern motion_pattern; 281 int floor; // floor in units of 1/16th of floor. 0x80000000 if unknown. 282 int height_above_floor; // in units of 1/64 m 283 int height_unc; // in units of 1/64 m. 0 if unknown 284 } wifi_lci_information; 285 286 typedef struct { 287 char country_code[2]; // country code 288 int length; // length of the info field 289 char civic_info[256]; // Civic info to be copied in FTM frame 290 } wifi_lcr_information; 291 292 // API to configure the LCI. Used in RTT Responder mode only 293 wifi_error wifi_set_lci(wifi_request_id id, wifi_interface_handle iface, 294 wifi_lci_information *lci); 295 296 // API to configure the LCR. Used in RTT Responder mode only. 297 wifi_error wifi_set_lcr(wifi_request_id id, wifi_interface_handle iface, 298 wifi_lcr_information *lcr); 299 300 /** 301 * RTT Responder information 302 */ 303 typedef struct { 304 wifi_channel_info channel; 305 wifi_rtt_preamble preamble; 306 } wifi_rtt_responder; 307 308 /** 309 * Get RTT responder information e.g. WiFi channel to enable responder on. 310 */ 311 wifi_error wifi_rtt_get_responder_info(wifi_interface_handle iface, 312 wifi_rtt_responder *responder_info); 313 314 /** 315 * Enable RTT responder mode. 316 * channel_hint - hint of the channel information where RTT responder should be enabled on. 317 * max_duration_seconds - timeout of responder mode. 318 * channel_used - channel used for RTT responder, NULL if responder is not enabled. 319 */ 320 wifi_error wifi_enable_responder(wifi_request_id id, wifi_interface_handle iface, 321 wifi_channel_info channel_hint, unsigned max_duration_seconds, 322 wifi_rtt_responder *responder_info); 323 324 /** 325 * Disable RTT responder mode. 326 */ 327 wifi_error wifi_disable_responder(wifi_request_id id, wifi_interface_handle iface); 328 329 #endif 330