1 /* 2 * Copyright (c) 2011, 2016-2020 The Linux Foundation. All rights reserved. 3 * Copyright (c) 2010, Atheros Communications Inc. 4 * All Rights Reserved. 5 * 6 * Permission to use, copy, modify, and/or distribute this software for 7 * any purpose with or without fee is hereby granted, provided that the 8 * above copyright notice and this permission notice appear in all 9 * copies. 10 * 11 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL 12 * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED 13 * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE 14 * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL 15 * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR 16 * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER 17 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR 18 * PERFORMANCE OF THIS SOFTWARE. 19 */ 20 21 /** 22 * DOC: This file has dfs IOCTL Defines. 23 */ 24 25 #ifndef _DFS_IOCTL_H_ 26 #define _DFS_IOCTL_H_ 27 28 #define DFS_MUTE_TIME 1 29 #define DFS_SET_THRESH 2 30 #define DFS_GET_THRESH 3 31 #define DFS_GET_USENOL 4 32 #define DFS_SET_USENOL 5 33 #define DFS_RADARDETECTS 6 34 #define DFS_BANGRADAR 7 35 #define DFS_SHOW_NOL 8 36 #define DFS_DISABLE_DETECT 9 37 #define DFS_ENABLE_DETECT 10 38 #define DFS_DISABLE_FFT 11 39 #define DFS_ENABLE_FFT 12 40 #define DFS_SET_DEBUG_LEVEL 13 41 #define DFS_GET_NOL 14 42 #define DFS_SET_NOL 15 43 44 #define DFS_SET_FALSE_RSSI_THRES 16 45 #define DFS_SET_PEAK_MAG 17 46 #define DFS_IGNORE_CAC 18 47 #define DFS_SET_NOL_TIMEOUT 19 48 #define DFS_GET_CAC_VALID_TIME 20 49 #define DFS_SET_CAC_VALID_TIME 21 50 #define DFS_SHOW_NOLHISTORY 22 51 #define DFS_SHOW_PRECAC_LISTS 23 52 #define DFS_RESET_PRECAC_LISTS 24 53 #define DFS_SET_DISABLE_RADAR_MARKING 25 54 #define DFS_GET_DISABLE_RADAR_MARKING 26 55 56 #define DFS_INJECT_SEQUENCE 27 57 #define DFS_ALLOW_HW_PULSES 28 58 #define DFS_SET_PRI_MULTIPILER 29 59 60 #define RESTRICTED_80P80_START_FREQ 5660 61 #define RESTRICTED_80P80_END_FREQ 5805 62 63 /* Check if the given frequencies are within restricted 80P80 start freq(5660) 64 * and end freq (5805). 65 */ 66 #define CHAN_WITHIN_RESTRICTED_80P80(cfreq1, cfreq2) \ 67 ((((cfreq1) >= RESTRICTED_80P80_START_FREQ) && \ 68 ((cfreq1) <= RESTRICTED_80P80_END_FREQ) && \ 69 ((cfreq2) >= RESTRICTED_80P80_START_FREQ) && \ 70 ((cfreq2) <= RESTRICTED_80P80_END_FREQ)) ? true : false) 71 72 /* 73 * Spectral IOCTLs use DFS_LAST_IOCTL as the base. 74 * This must always be the last IOCTL in DFS and have 75 * the highest value. 76 */ 77 #define DFS_LAST_IOCTL 29 78 79 #ifndef DFS_CHAN_MAX 80 #define DFS_CHAN_MAX 25 81 #endif 82 83 /** 84 * struct dfsreq_nolelem - NOL elements. 85 * @nol_freq: NOL channel frequency. 86 * @nol_chwidth: NOL channel width. 87 * @nol_start_us: OS microseconds when the NOL timer started. 88 * @nol_timeout_ms: Nol timeout value in msec. 89 */ 90 91 struct dfsreq_nolelem { 92 uint16_t nol_freq; 93 uint16_t nol_chwidth; 94 uint64_t nol_start_us; 95 uint32_t nol_timeout_ms; 96 }; 97 98 struct dfsreq_nolinfo { 99 uint32_t dfs_ch_nchans; 100 struct dfsreq_nolelem dfs_nol[DFS_CHAN_MAX]; 101 }; 102 103 /* 104 * IOCTL parameter types 105 */ 106 107 #define DFS_PARAM_FIRPWR 1 108 #define DFS_PARAM_RRSSI 2 109 #define DFS_PARAM_HEIGHT 3 110 #define DFS_PARAM_PRSSI 4 111 #define DFS_PARAM_INBAND 5 112 /* 5413 specific parameters */ 113 #define DFS_PARAM_RELPWR 7 114 #define DFS_PARAM_RELSTEP 8 115 #define DFS_PARAM_MAXLEN 9 116 117 /** 118 * struct dfs_ioctl_params - DFS ioctl params. 119 * @dfs_firpwr: FIR pwr out threshold. 120 * @dfs_rrssi: Radar rssi thresh. 121 * @dfs_height: Pulse height thresh. 122 * @dfs_prssi: Pulse rssi thresh. 123 * @dfs_inband: Inband thresh. 124 * @dfs_relpwr: Pulse relative pwr thresh. 125 * @dfs_relstep: Pulse relative step thresh. 126 * @dfs_maxlen: Pulse max duration. 127 */ 128 struct dfs_ioctl_params { 129 int32_t dfs_firpwr; 130 int32_t dfs_rrssi; 131 int32_t dfs_height; 132 int32_t dfs_prssi; 133 int32_t dfs_inband; 134 int32_t dfs_relpwr; 135 int32_t dfs_relstep; 136 int32_t dfs_maxlen; 137 }; 138 139 /* Types of Bangradar commands: 140 * @DFS_BANGRADAR_FOR_ALL_SUBCHANS : Bangradar with no arguments. 141 * All the subchannels in the current 142 * channel shall be added. 143 * @DFS_BANGRADAR_FOR_ALL_SUBCHANS_OF_SEGID : Bangradar with 1 (seg_id) argument 144 * All subchannels of the specific 145 * seg_id shall be added. 146 * @DFS_BANGRADAR_FOR_SPECIFIC_SUBCHANS : Bangradar with all (segment ID, 147 * is_chirp and frequency offset) 148 * arguments. 149 * Only radar infected subchannels 150 * of the specific seg_id shall be 151 * added. 152 * 153 * (Unless all arguments are given, we cannot determine which specific 154 * subchannels to simulate the radar on, hence simulate in all subchans). 155 */ 156 enum dfs_bangradar_types { 157 DFS_NO_BANGRADAR = 0, 158 DFS_BANGRADAR_FOR_ALL_SUBCHANS, 159 DFS_BANGRADAR_FOR_ALL_SUBCHANS_OF_SEGID, 160 DFS_BANGRADAR_FOR_SPECIFIC_SUBCHANS, 161 DFS_INVALID_BANGRADAR_TYPE 162 }; 163 164 /** 165 * struct dfs_bangradar_params - DFS bangradar params. 166 * @bangradar_type: Type of Bangradar. 167 * @seg_id: Segment ID information. 168 * @is_chirp: Chirp radar or not. 169 * @freq_offset: Frequency offset at which radar was found. 170 * @detector_id: Detector ID corresponding to primary/agile detectors. 171 */ 172 struct dfs_bangradar_params { 173 enum dfs_bangradar_types bangradar_type; 174 uint8_t seg_id; 175 uint8_t is_chirp; 176 int32_t freq_offset; 177 uint8_t detector_id; 178 }; 179 #define DFS_IOCTL_PARAM_NOVAL 65535 180 #define DFS_IOCTL_PARAM_ENABLE 0x8000 181 182 /* Random channel flags */ 183 /* Flag to exclude current operating channels */ 184 #define DFS_RANDOM_CH_FLAG_NO_CURR_OPE_CH 0x0001 /* 0000 0000 0000 0001 */ 185 186 /* Flag to exclude weather channels */ 187 #define DFS_RANDOM_CH_FLAG_NO_WEATHER_CH 0x0002 /* 0000 0000 0000 0010 */ 188 189 /* Flag to exclude indoor channels */ 190 #define DFS_RANDOM_CH_FLAG_NO_LOWER_5G_CH 0x0004 /* 0000 0000 0000 0100 */ 191 192 /* Flag to exclude outdoor channels */ 193 #define DFS_RANDOM_CH_FLAG_NO_UPEER_5G_CH 0x0008 /* 0000 0000 0000 1000 */ 194 195 /* Flag to exclude dfs channels */ 196 #define DFS_RANDOM_CH_FLAG_NO_DFS_CH 0x0010 /* 0000 0000 0001 0000 */ 197 198 /* Flag to exclude all 5GHz channels */ 199 #define DFS_RANDOM_CH_FLAG_NO_5GHZ_CH 0x0020 /* 0000 0000 0010 0000 */ 200 201 /* Flag to exclude all 2.4GHz channels */ 202 #define DFS_RANDOM_CH_FLAG_NO_2GHZ_CH 0x0040 /* 0000 0000 0100 0000 */ 203 204 /* Flag to enable Reduced BW Agile DFS */ 205 #define DFS_RANDOM_CH_FLAG_ENABLE_REDUCED_BW 0x0080 /* 0000 0000 1000 0000 */ 206 207 /* Flag to exclude Japan W53 channnels */ 208 #define DFS_RANDOM_CH_FLAG_NO_JAPAN_W53_CH 0x0100 /* 0000 0001 0000 0000 */ 209 210 /* Restricted 80P80 MHz is enabled */ 211 #define DFS_RANDOM_CH_FLAG_RESTRICTED_80P80_ENABLED 0x0200 212 /* 0000 0010 0000 0000 */ 213 214 /* Flag to exclude all 6GHz channels */ 215 #define DFS_RANDOM_CH_FLAG_NO_6GHZ_CH 0x00400 /* 0000 0100 0000 0000 */ 216 217 /** 218 * struct wlan_dfs_caps - DFS capability structure. 219 * @wlan_dfs_ext_chan_ok: Can radar be detected on the extension chan? 220 * @wlan_dfs_combined_rssi_ok: Can use combined radar RSSI? 221 * @wlan_dfs_use_enhancement: This flag is used to indicate if radar 222 * detection scheme should use enhanced chirping 223 * detection algorithm. This flag also determines 224 * if certain radar data should be discarded to 225 * minimize false detection of radar. 226 * @wlan_strong_signal_diversiry: Strong Signal fast diversity count. 227 * @wlan_chip_is_bb_tlv: Chip is BB TLV? 228 * @wlan_chip_is_over_sampled: Is Over sampled. 229 * @wlan_chip_is_ht160: IS VHT160? 230 * @wlan_chip_is_false_detect: Is False detected? 231 * @wlan_fastdiv_val: Goes with wlan_strong_signal_diversiry: If we 232 * have fast diversity capability, read off 233 * Strong Signal fast diversity count set in the 234 * ini file, and store so we can restore the 235 * value when radar is disabled. 236 */ 237 struct wlan_dfs_caps { 238 uint32_t wlan_dfs_ext_chan_ok:1, 239 wlan_dfs_combined_rssi_ok:1, 240 wlan_dfs_use_enhancement:1, 241 wlan_strong_signal_diversiry:1, 242 wlan_chip_is_bb_tlv:1, 243 wlan_chip_is_over_sampled:1, 244 wlan_chip_is_ht160:1, 245 wlan_chip_is_false_detect:1; 246 uint32_t wlan_fastdiv_val; 247 }; 248 249 /** 250 * struct wlan_dfs_phyerr_param - DFS Phyerr structure. 251 * @pe_firpwr: FIR pwr out threshold. 252 * @pe_rrssi: Radar rssi thresh. 253 * @pe_height: Pulse height thresh. 254 * @pe_prssi: Pulse rssi thresh. 255 * @pe_inband: Inband thresh. 256 * @pe_relpwr: Relative power threshold in 0.5dB steps. 257 * @pe_relstep: Pulse Relative step threshold in 0.5dB steps. 258 * @pe_maxlen: Max length of radar sign in 0.8us units. 259 * @pe_usefir128: Use the average in-band power measured over 128 cycles. 260 * @pe_blockradar: Enable to block radar check if pkt detect is done via OFDM 261 * weak signal detect or pkt is detected immediately after tx 262 * to rx transition. 263 * @pe_enmaxrssi: Enable to use the max rssi instead of the last rssi during 264 * fine gain changes for radar detection. 265 */ 266 struct wlan_dfs_phyerr_param { 267 int32_t pe_firpwr; 268 int32_t pe_rrssi; 269 int32_t pe_height; 270 int32_t pe_prssi; 271 int32_t pe_inband; 272 uint32_t pe_relpwr; 273 uint32_t pe_relstep; 274 uint32_t pe_maxlen; 275 bool pe_usefir128; 276 bool pe_blockradar; 277 bool pe_enmaxrssi; 278 }; 279 280 /** 281 * enum WLAN_DFS_EVENTS - DFS Events that will be sent to userspace 282 * @WLAN_EV_RADAR_DETECTED: Radar is detected 283 * @WLAN_EV_CAC_RESET: CAC started or CAC completed status is reset 284 * @WLAN_EV_CAC_STARTED: CAC timer has started 285 * @WLAN_EV_CAC_COMPLETED: CAC timer completed 286 * @WLAN_EV_NOL_STARTED: NOL started 287 * @WLAN_EV_NOL_FINISHED: NOL Completed 288 * @WLAN_EV_PCAC_STARTED: PreCAC Started 289 * @WLAN_EV_PCAC_COMPLETED: PreCAC Completed 290 * 291 * DFS events such as radar detected, CAC started, 292 * CAC completed, NOL started, NOL finished 293 */ 294 enum WLAN_DFS_EVENTS { 295 WLAN_EV_RADAR_DETECTED, 296 WLAN_EV_CAC_RESET, 297 WLAN_EV_CAC_STARTED, 298 WLAN_EV_CAC_COMPLETED, 299 WLAN_EV_NOL_STARTED, 300 WLAN_EV_NOL_FINISHED, 301 WLAN_EV_PCAC_STARTED, 302 WLAN_EV_PCAC_COMPLETED, 303 }; 304 305 #if defined(WLAN_DFS_PARTIAL_OFFLOAD) && defined(WLAN_DFS_SYNTHETIC_RADAR) 306 /** 307 * Structure of Pulse to be injected into the DFS Module 308 * ****************************************************** 309 * Header 310 * ====== 311 * ----------|--------------| 312 * num_pulses| total_len_seq| 313 * ----------|--------------| 314 * Buffer Contents per pulse: 315 * ========================== 316 * ------|----------|-----------|----------|-----------|---------------|-------- 317 * r_rssi|r_ext_rssi|r_rs_tstamp|r_fulltsf |fft_datalen|total_len_pulse|FFT 318 * | | | | | |Buffer.. 319 * ------|----------|-----------|----------|-----------|---------------|-------- 320 */ 321 322 /** 323 * struct synthetic_pulse - Radar Pulse Structure to be filled on reading the 324 * user file. 325 * @r_rssi: RSSI of the pulse. 326 * @r_ext_rssi: Extension Channel RSSI. 327 * @r_rs_tstamp: Timestamp. 328 * @r_fulltsf: TSF64. 329 * @fft_datalen: Total len of FFT. 330 * @total_len_pulse: Total len of the pulse. 331 * @fft_buf: Pointer to fft data. 332 */ 333 334 struct synthetic_pulse { 335 uint8_t r_rssi; 336 uint8_t r_ext_rssi; 337 uint32_t r_rs_tstamp; 338 uint64_t r_fulltsf; 339 uint16_t fft_datalen; 340 uint16_t total_len_pulse; 341 unsigned char *fft_buf; 342 } qdf_packed; 343 344 /** 345 * struct synthetic_seq - Structure to hold an array of pointers to the 346 * pulse structure. 347 * @num_pulses: Total num of pulses in the sequence. 348 * @total_len_seq: Total len of the sequence. 349 * @pulse: Array of pointers to synthetic_pulse structure. 350 */ 351 352 struct synthetic_seq { 353 uint8_t num_pulses; 354 uint32_t total_len_seq; 355 struct synthetic_pulse *pulse[0]; 356 }; 357 358 /** 359 * struct seq_store - Structure to hold an array of pointers to the synthetic 360 * sequence structure. 361 * @num_sequence: Total number of "sequence of pulses" in the file. 362 * @seq_arr: Array of pointers to synthetic_seq structure. 363 */ 364 365 struct seq_store { 366 uint8_t num_sequence; 367 struct synthetic_seq *seq_arr[0]; 368 }; 369 #endif /* WLAN_DFS_PARTIAL_OFFLOAD && WLAN_DFS_SYNTHETIC_RADAR */ 370 371 /** 372 * enum dfs_agile_sm_evt - DFS Agile SM events. 373 * @DFS_AGILE_SM_EV_AGILE_START: Event to start AGILE PreCAC/RCAC. 374 * @DFS_AGILE_SM_EV_AGILE_DOWN: Event to stop AGILE PreCAC/RCAC.. 375 * @DFS_AGILE_SM_EV_AGILE_DONE: Event to complete AGILE PreCAC/RCAC.. 376 * @DFS_AGILE_SM_EV_ADFS_RADAR: Event to restart AGILE PreCAC/RCAC after radar. 377 */ 378 enum dfs_agile_sm_evt { 379 DFS_AGILE_SM_EV_AGILE_START = 0, 380 DFS_AGILE_SM_EV_AGILE_STOP = 1, 381 DFS_AGILE_SM_EV_AGILE_DONE = 2, 382 DFS_AGILE_SM_EV_ADFS_RADAR = 3, 383 }; 384 385 /** 386 * enum precac_status_for_chan - preCAC status for channels. 387 * @DFS_NO_PRECAC_COMPLETED_CHANS: None of the channels are preCAC completed. 388 * @DFS_PRECAC_COMPLETED_CHAN: A given channel is preCAC completed. 389 * @DFS_PRECAC_REQUIRED_CHAN: A given channel required preCAC. 390 * @DFS_INVALID_PRECAC_STATUS: Invalid status. 391 * 392 * Note: "DFS_NO_PRECAC_COMPLETED_CHANS" has more priority than 393 * "DFS_PRECAC_COMPLETED_CHAN". This is because if the preCAC list does not 394 * have any channel that completed preCAC, "DFS_NO_PRECAC_COMPLETED_CHANS" 395 * is returned and search for preCAC completion (DFS_PRECAC_COMPLETED_CHAN) 396 * for a given channel is not done. 397 */ 398 enum precac_status_for_chan { 399 DFS_NO_PRECAC_COMPLETED_CHANS, 400 DFS_PRECAC_COMPLETED_CHAN, 401 DFS_PRECAC_REQUIRED_CHAN, 402 DFS_INVALID_PRECAC_STATUS, 403 }; 404 405 #endif /* _DFS_IOCTL_H_ */ 406