target_if_spectral.h 52 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579
  1. /*
  2. * Copyright (c) 2011,2017-2018 The Linux Foundation. All rights reserved.
  3. *
  4. *
  5. * Permission to use, copy, modify, and/or distribute this software for
  6. * any purpose with or without fee is hereby granted, provided that the
  7. * above copyright notice and this permission notice appear in all
  8. * copies.
  9. *
  10. * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
  11. * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
  12. * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
  13. * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
  14. * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
  15. * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  16. * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  17. * PERFORMANCE OF THIS SOFTWARE.
  18. */
  19. #ifndef _TARGET_IF_SPECTRAL_H_
  20. #define _TARGET_IF_SPECTRAL_H_
  21. #include <wlan_objmgr_cmn.h>
  22. #include <wlan_objmgr_psoc_obj.h>
  23. #include <wlan_objmgr_pdev_obj.h>
  24. #include <wlan_objmgr_vdev_obj.h>
  25. #include <qdf_lock.h>
  26. #include <wlan_spectral_public_structs.h>
  27. #include <reg_services_public_struct.h>
  28. #include <target_if_direct_buf_rx_api.h>
  29. #ifdef WIN32
  30. #pragma pack(push, target_if_spectral, 1)
  31. #define __ATTRIB_PACK
  32. #else
  33. #ifndef __ATTRIB_PACK
  34. #define __ATTRIB_PACK __attribute__ ((packed))
  35. #endif
  36. #endif
  37. #define spectral_log(level, args...) \
  38. QDF_PRINT_INFO(QDF_PRINT_IDX_SHARED, QDF_MODULE_ID_SPECTRAL, level, ## args)
  39. #define spectral_logfl(level, format, args...) \
  40. spectral_log(level, FL(format), ## args)
  41. #define spectral_fatal(format, args...) \
  42. spectral_logfl(QDF_TRACE_LEVEL_FATAL, format, ## args)
  43. #define spectral_err(format, args...) \
  44. spectral_logfl(QDF_TRACE_LEVEL_ERROR, format, ## args)
  45. #define spectral_warn(format, args...) \
  46. spectral_logfl(QDF_TRACE_LEVEL_WARN, format, ## args)
  47. #define spectral_info(format, args...) \
  48. spectral_logfl(QDF_TRACE_LEVEL_INFO, format, ## args)
  49. #define spectral_debug(format, args...) \
  50. spectral_logfl(QDF_TRACE_LEVEL_DEBUG, format, ## args)
  51. #define STATUS_PASS 1
  52. #define STATUS_FAIL 0
  53. #undef spectral_dbg_line
  54. #define spectral_dbg_line() \
  55. spectral_debug("----------------------------------------------------\n")
  56. #undef spectral_ops_not_registered
  57. #define spectral_ops_not_registered(str) \
  58. spectral_info("SPECTRAL : %s not registered\n", (str))
  59. #undef not_yet_implemented
  60. #define not_yet_implemented() \
  61. spectral_info("SPECTRAL : %s : %d Not yet implemented\n", \
  62. __func__, __LINE__)
  63. #define SPECTRAL_HT20_NUM_BINS 56
  64. #define SPECTRAL_HT20_FFT_LEN 56
  65. #define SPECTRAL_HT20_DC_INDEX (SPECTRAL_HT20_FFT_LEN / 2)
  66. #define SPECTRAL_HT20_DATA_LEN 60
  67. #define SPECTRAL_HT20_TOTAL_DATA_LEN (SPECTRAL_HT20_DATA_LEN + 3)
  68. #define SPECTRAL_HT40_TOTAL_NUM_BINS 128
  69. #define SPECTRAL_HT40_DATA_LEN 135
  70. #define SPECTRAL_HT40_TOTAL_DATA_LEN (SPECTRAL_HT40_DATA_LEN + 3)
  71. #define SPECTRAL_HT40_FFT_LEN 128
  72. #define SPECTRAL_HT40_DC_INDEX (SPECTRAL_HT40_FFT_LEN / 2)
  73. /*
  74. * Used for the SWAR to obtain approximate combined rssi
  75. * in secondary 80Mhz segment
  76. */
  77. #define OFFSET_CH_WIDTH_20 65
  78. #define OFFSET_CH_WIDTH_40 62
  79. #define OFFSET_CH_WIDTH_80 56
  80. #define OFFSET_CH_WIDTH_160 50
  81. #ifdef BIG_ENDIAN_HOST
  82. #define SPECTRAL_MESSAGE_COPY_CHAR_ARRAY(destp, srcp, len) do { \
  83. int j; \
  84. uint32_t *src, *dest; \
  85. src = (uint32_t *)(srcp); \
  86. dest = (uint32_t *)(destp); \
  87. for (j = 0; j < roundup((len), sizeof(uint32_t)) / 4; j++) { \
  88. *(dest + j) = qdf_le32_to_cpu(*(src + j)); \
  89. } \
  90. } while (0)
  91. #else
  92. #define SPECTRAL_MESSAGE_COPY_CHAR_ARRAY(destp, srcp, len) \
  93. OS_MEMCPY((destp), (srcp), (len));
  94. #endif
  95. #define DUMMY_NF_VALUE (-123)
  96. /* 5 categories x (lower + upper) bands */
  97. #define MAX_INTERF 10
  98. #define HOST_MAX_ANTENNA 3
  99. /* Mask for time stamp from descriptor */
  100. #define SPECTRAL_TSMASK 0xFFFFFFFF
  101. #define SPECTRAL_SIGNATURE 0xdeadbeef
  102. /* START of spectral GEN II HW specific details */
  103. #define SPECTRAL_PHYERR_SIGNATURE_GEN2 0xbb
  104. #define TLV_TAG_SPECTRAL_SUMMARY_REPORT_GEN2 0xF9
  105. #define TLV_TAG_ADC_REPORT_GEN2 0xFA
  106. #define TLV_TAG_SEARCH_FFT_REPORT_GEN2 0xFB
  107. /**
  108. * struct spectral_search_fft_info_gen2 - spectral search fft report for gen2
  109. * @relpwr_db: Total bin power in db
  110. * @num_str_bins_ib: Number of strong bins
  111. * @base_pwr: Base power
  112. * @total_gain_info: Total gain
  113. * @fft_chn_idx: FFT chain on which report is originated
  114. * @avgpwr_db: Average power in db
  115. * @peak_mag: Peak power seen in the bins
  116. * @peak_inx: Index of bin holding peak power
  117. */
  118. struct spectral_search_fft_info_gen2 {
  119. uint32_t relpwr_db;
  120. uint32_t num_str_bins_ib;
  121. uint32_t base_pwr;
  122. uint32_t total_gain_info;
  123. uint32_t fft_chn_idx;
  124. uint32_t avgpwr_db;
  125. uint32_t peak_mag;
  126. int16_t peak_inx;
  127. };
  128. /*
  129. * XXX Check if we should be handling the endinness difference in some
  130. * other way opaque to the host
  131. */
  132. #ifdef BIG_ENDIAN_HOST
  133. /**
  134. * struct spectral_phyerr_tlv_gen2 - phyerr tlv info for big endian host
  135. * @signature: signature
  136. * @tag: tag
  137. * @length: length
  138. */
  139. struct spectral_phyerr_tlv_gen2 {
  140. uint8_t signature;
  141. uint8_t tag;
  142. uint16_t length;
  143. } __ATTRIB_PACK;
  144. #else
  145. /**
  146. * struct spectral_phyerr_tlv_gen2 - phyerr tlv info for little endian host
  147. * @length: length
  148. * @tag: tag
  149. * @signature: signature
  150. */
  151. struct spectral_phyerr_tlv_gen2 {
  152. uint16_t length;
  153. uint8_t tag;
  154. uint8_t signature;
  155. } __ATTRIB_PACK;
  156. #endif /* BIG_ENDIAN_HOST */
  157. /**
  158. * struct spectral_phyerr_hdr_gen2 - phyerr header for gen2 HW
  159. * @hdr_a: Header[0:31]
  160. * @hdr_b: Header[32:63]
  161. */
  162. struct spectral_phyerr_hdr_gen2 {
  163. uint32_t hdr_a;
  164. uint32_t hdr_b;
  165. };
  166. /*
  167. * Segment ID information for 80+80.
  168. *
  169. * If the HW micro-architecture specification extends this DWORD for other
  170. * purposes, then redefine+rename accordingly. For now, the specification
  171. * mentions only segment ID (though this doesn't require an entire DWORD)
  172. * without mention of any generic terminology for the DWORD, or any reservation.
  173. * We use nomenclature accordingly.
  174. */
  175. typedef uint32_t SPECTRAL_SEGID_INFO;
  176. /**
  177. * struct spectral_phyerr_fft_gen2 - fft info in phyerr event
  178. * @buf: fft report
  179. */
  180. struct spectral_phyerr_fft_gen2 {
  181. uint8_t buf[0];
  182. };
  183. /* END of spectral GEN II HW specific details */
  184. /* START of spectral GEN III HW specific details */
  185. #define get_bitfield(value, size, pos) \
  186. (((value) >> (pos)) & ((1 << (size)) - 1))
  187. #define unsigned_to_signed(value, width) \
  188. (((value) >= (1 << ((width) - 1))) ? \
  189. (value - (1 << (width))) : (value))
  190. #define SPECTRAL_PHYERR_SIGNATURE_GEN3 (0xFA)
  191. #define TLV_TAG_SPECTRAL_SUMMARY_REPORT_GEN3 (0x02)
  192. #define TLV_TAG_SEARCH_FFT_REPORT_GEN3 (0x03)
  193. #define SPECTRAL_PHYERR_TLVSIZE_GEN3 (4)
  194. #define PHYERR_HDR_SIG_POS \
  195. (offsetof(struct spectral_phyerr_fft_report_gen3, fft_hdr_sig))
  196. #define PHYERR_HDR_TAG_POS \
  197. (offsetof(struct spectral_phyerr_fft_report_gen3, fft_hdr_tag))
  198. #define SPECTRAL_FFT_BINS_POS \
  199. (offsetof(struct spectral_phyerr_fft_report_gen3, buf))
  200. /**
  201. * struct phyerr_info - spectral search fft report for gen3
  202. * @data: handle to phyerror buffer
  203. * @datalen: length of phyerror bufer
  204. * @p_rfqual: rf quality matrices
  205. * @p_chaninfo: pointer to chaninfo
  206. * @tsf64: 64 bit TSF
  207. * @acs_stats: acs stats
  208. */
  209. struct phyerr_info {
  210. uint8_t *data;
  211. uint32_t datalen;
  212. struct target_if_spectral_rfqual_info *p_rfqual;
  213. struct target_if_spectral_chan_info *p_chaninfo;
  214. uint64_t tsf64;
  215. struct target_if_spectral_acs_stats *acs_stats;
  216. };
  217. /**
  218. * struct spectral_search_fft_info_gen3 - spectral search fft report for gen3
  219. * @timestamp: Timestamp at which fft report was generated
  220. * @fft_detector_id: Which radio generated this report
  221. * @fft_num: The FFT count number. Set to 0 for short FFT.
  222. * @fft_radar_check: NA for spectral
  223. * @fft_peak_sidx: Index of bin with maximum power
  224. * @fft_chn_idx: Rx chain index
  225. * @fft_base_pwr_db: Base power in dB
  226. * @fft_total_gain_db: Total gain in dB
  227. * @fft_num_str_bins_ib: Number of strong bins in the report
  228. * @fft_peak_mag: Peak magnitude
  229. * @fft_avgpwr_db: Average power in dB
  230. * @fft_relpwr_db: Relative power in dB
  231. */
  232. struct spectral_search_fft_info_gen3 {
  233. uint32_t timestamp;
  234. uint32_t fft_detector_id;
  235. uint32_t fft_num;
  236. uint32_t fft_radar_check;
  237. int32_t fft_peak_sidx;
  238. uint32_t fft_chn_idx;
  239. uint32_t fft_base_pwr_db;
  240. uint32_t fft_total_gain_db;
  241. uint32_t fft_num_str_bins_ib;
  242. int32_t fft_peak_mag;
  243. uint32_t fft_avgpwr_db;
  244. uint32_t fft_relpwr_db;
  245. };
  246. /**
  247. * struct spectral_phyerr_sfftreport_gen3 - fft info in phyerr event
  248. * @fft_timestamp: Timestamp at which fft report was generated
  249. * @fft_hdr_sig: signature
  250. * @fft_hdr_tag: tag
  251. * @fft_hdr_length: length
  252. * @hdr_a: Header[0:31]
  253. * @hdr_b: Header[32:63]
  254. * @hdr_c: Header[64:95]
  255. * @resv: Header[96:127]
  256. * @buf: fft bins
  257. */
  258. struct spectral_phyerr_fft_report_gen3 {
  259. uint32_t fft_timestamp;
  260. #ifdef BIG_ENDIAN_HOST
  261. uint8_t fft_hdr_sig;
  262. uint8_t fft_hdr_tag;
  263. uint16_t fft_hdr_length;
  264. #else
  265. uint16_t fft_hdr_length;
  266. uint8_t fft_hdr_tag;
  267. uint8_t fft_hdr_sig;
  268. #endif /* BIG_ENDIAN_HOST */
  269. uint32_t hdr_a;
  270. uint32_t hdr_b;
  271. uint32_t hdr_c;
  272. uint32_t resv;
  273. uint8_t buf[0];
  274. } __ATTRIB_PACK;
  275. /**
  276. * struct spectral_sscan_report_gen3 - spectral report in phyerr event
  277. * @sscan_timestamp: Timestamp at which fft report was generated
  278. * @sscan_hdr_sig: signature
  279. * @sscan_hdr_tag: tag
  280. * @sscan_hdr_length: length
  281. * @hdr_a: Header[0:31]
  282. * @resv: Header[32:63]
  283. * @hdr_b: Header[64:95]
  284. * @resv: Header[96:127]
  285. */
  286. struct spectral_sscan_report_gen3 {
  287. u_int32_t sscan_timestamp;
  288. #ifdef BIG_ENDIAN_HOST
  289. u_int8_t sscan_hdr_sig;
  290. u_int8_t sscan_hdr_tag;
  291. u_int16_t sscan_hdr_length;
  292. #else
  293. u_int16_t sscan_hdr_length;
  294. u_int8_t sscan_hdr_tag;
  295. u_int8_t sscan_hdr_sig;
  296. #endif /* BIG_ENDIAN_HOST */
  297. u_int32_t hdr_a;
  298. u_int32_t res1;
  299. u_int32_t hdr_b;
  300. u_int32_t res2;
  301. } __ATTRIB_PACK;
  302. /* END of spectral GEN III HW specific details */
  303. typedef signed char pwr_dbm;
  304. /**
  305. * enum spectral_gen - spectral hw generation
  306. * @SPECTRAL_GEN1 : spectral hw gen 1
  307. * @SPECTRAL_GEN2 : spectral hw gen 2
  308. * @SPECTRAL_GEN3 : spectral hw gen 3
  309. */
  310. enum spectral_gen {
  311. SPECTRAL_GEN1,
  312. SPECTRAL_GEN2,
  313. SPECTRAL_GEN3,
  314. };
  315. #if ATH_PERF_PWR_OFFLOAD
  316. /**
  317. * enum target_if_spectral_info - Enumerations for specifying which spectral
  318. * information (among parameters and states)
  319. * is desired.
  320. * @TARGET_IF_SPECTRAL_INFO_ACTIVE: Indicated whether spectral is active
  321. * @TARGET_IF_SPECTRAL_INFO_ENABLED: Indicated whether spectral is enabled
  322. * @TARGET_IF_SPECTRAL_INFO_PARAMS: Config params
  323. */
  324. enum target_if_spectral_info {
  325. TARGET_IF_SPECTRAL_INFO_ACTIVE,
  326. TARGET_IF_SPECTRAL_INFO_ENABLED,
  327. TARGET_IF_SPECTRAL_INFO_PARAMS,
  328. };
  329. #endif /* ATH_PERF_PWR_OFFLOAD */
  330. /* forward declaration */
  331. struct target_if_spectral;
  332. /**
  333. * struct target_if_spectral_chan_info - Channel information
  334. * @center_freq1: center frequency 1 in MHz
  335. * @center_freq2: center frequency 2 in MHz -valid only for
  336. * 11ACVHT 80PLUS80 mode
  337. * @chan_width: channel width in MHz
  338. */
  339. struct target_if_spectral_chan_info {
  340. uint16_t center_freq1;
  341. uint16_t center_freq2;
  342. uint8_t chan_width;
  343. };
  344. /**
  345. * struct target_if_spectral_acs_stats - EACS stats from spectral samples
  346. * @nfc_ctl_rssi: Control chan rssi
  347. * @nfc_ext_rssi: Extension chan rssi
  348. * @ctrl_nf: Control chan Noise Floor
  349. * @ext_nf: Extension chan Noise Floor
  350. */
  351. struct target_if_spectral_acs_stats {
  352. int8_t nfc_ctl_rssi;
  353. int8_t nfc_ext_rssi;
  354. int8_t ctrl_nf;
  355. int8_t ext_nf;
  356. };
  357. /**
  358. * struct target_if_spectral_perchain_rssi_info - per chain rssi info
  359. * @rssi_pri20: Rssi of primary 20 Mhz
  360. * @rssi_sec20: Rssi of secondary 20 Mhz
  361. * @rssi_sec40: Rssi of secondary 40 Mhz
  362. * @rssi_sec80: Rssi of secondary 80 Mhz
  363. */
  364. struct target_if_spectral_perchain_rssi_info {
  365. int8_t rssi_pri20;
  366. int8_t rssi_sec20;
  367. int8_t rssi_sec40;
  368. int8_t rssi_sec80;
  369. };
  370. /**
  371. * struct target_if_spectral_rfqual_info - RF measurement information
  372. * @rssi_comb: RSSI Information
  373. * @pc_rssi_info: XXX : For now, we know we are getting information
  374. * for only 4 chains at max. For future extensions
  375. * use a define
  376. * @noise_floor: Noise floor information
  377. */
  378. struct target_if_spectral_rfqual_info {
  379. int8_t rssi_comb;
  380. struct target_if_spectral_perchain_rssi_info pc_rssi_info[4];
  381. int16_t noise_floor[4];
  382. };
  383. #define GET_TARGET_IF_SPECTRAL_OPS(spectral) \
  384. ((struct target_if_spectral_ops *)(&((spectral)->spectral_ops)))
  385. /**
  386. * struct target_if_spectral_ops - spectral low level ops table
  387. * @get_tsf64: Get 64 bit TSF value
  388. * @get_capability: Get capability info
  389. * @set_rxfilter: Set rx filter
  390. * @get_rxfilter: Get rx filter
  391. * @is_spectral_active: Check whether icm is active
  392. * @is_spectral_enabled: Check whether spectral is enabled
  393. * @start_spectral_scan: Start spectral scan
  394. * @stop_spectral_scan: Stop spectral scan
  395. * @get_extension_channel: Get extension channel
  396. * @get_ctl_noisefloor: Get control noise floor
  397. * @get_ext_noisefloor: Get extension noise floor
  398. * @configure_spectral: Set spectral configurations
  399. * @get_spectral_config: Get spectral configurations
  400. * @get_ent_spectral_mask: Get spectral mask
  401. * @get_mac_address: Get mac address
  402. * @get_current_channel: Get current channel
  403. * @reset_hw: Reset HW
  404. * @get_chain_noise_floor: Get Channel noise floor
  405. * @spectral_process_phyerr: Process phyerr event
  406. */
  407. struct target_if_spectral_ops {
  408. uint64_t (*get_tsf64)(void *arg);
  409. uint32_t (*get_capability)(
  410. void *arg, enum spectral_capability_type type);
  411. uint32_t (*set_rxfilter)(void *arg, int rxfilter);
  412. uint32_t (*get_rxfilter)(void *arg);
  413. uint32_t (*is_spectral_active)(void *arg);
  414. uint32_t (*is_spectral_enabled)(void *arg);
  415. uint32_t (*start_spectral_scan)(void *arg);
  416. uint32_t (*stop_spectral_scan)(void *arg);
  417. uint32_t (*get_extension_channel)(void *arg);
  418. int8_t (*get_ctl_noisefloor)(void *arg);
  419. int8_t (*get_ext_noisefloor)(void *arg);
  420. uint32_t (*configure_spectral)(
  421. void *arg,
  422. struct spectral_config *params);
  423. uint32_t (*get_spectral_config)(
  424. void *arg,
  425. struct spectral_config *params);
  426. uint32_t (*get_ent_spectral_mask)(void *arg);
  427. uint32_t (*get_mac_address)(void *arg, char *addr);
  428. uint32_t (*get_current_channel)(void *arg);
  429. uint32_t (*reset_hw)(void *arg);
  430. uint32_t (*get_chain_noise_floor)(void *arg, int16_t *nf_buf);
  431. int (*spectral_process_phyerr)(struct target_if_spectral *spectral,
  432. uint8_t *data, uint32_t datalen,
  433. struct target_if_spectral_rfqual_info *p_rfqual,
  434. struct target_if_spectral_chan_info *p_chaninfo,
  435. uint64_t tsf64,
  436. struct target_if_spectral_acs_stats *acs_stats);
  437. };
  438. /**
  439. * struct target_if_spectral_stats - spectral stats info
  440. * @num_spectral_detects: Total num. of spectral detects
  441. * @total_phy_errors: Total number of phyerrors
  442. * @owl_phy_errors: Indicated phyerrors in old gen1 chipsets
  443. * @pri_phy_errors: Phyerrors in primary channel
  444. * @ext_phy_errors: Phyerrors in secondary channel
  445. * @dc_phy_errors: Phyerrors due to dc
  446. * @early_ext_phy_errors: Early secondary channel phyerrors
  447. * @bwinfo_errors: Bandwidth info errors
  448. * @datalen_discards: Invalid data length errors, seen in gen1 chipsets
  449. * @rssi_discards bw: Indicates reports dropped due to RSSI threshold
  450. * @last_reset_tstamp: Last reset time stamp
  451. */
  452. struct target_if_spectral_stats {
  453. uint32_t num_spectral_detects;
  454. uint32_t total_phy_errors;
  455. uint32_t owl_phy_errors;
  456. uint32_t pri_phy_errors;
  457. uint32_t ext_phy_errors;
  458. uint32_t dc_phy_errors;
  459. uint32_t early_ext_phy_errors;
  460. uint32_t bwinfo_errors;
  461. uint32_t datalen_discards;
  462. uint32_t rssi_discards;
  463. uint64_t last_reset_tstamp;
  464. };
  465. /**
  466. * struct target_if_spectral_event - spectral event structure
  467. * @se_ts: Original 15 bit recv timestamp
  468. * @se_full_ts: 64-bit full timestamp from interrupt time
  469. * @se_rssi: Rssi of spectral event
  470. * @se_bwinfo: Rssi of spectral event
  471. * @se_dur: Duration of spectral pulse
  472. * @se_chanindex: Channel of event
  473. * @se_list: List of spectral events
  474. */
  475. struct target_if_spectral_event {
  476. uint32_t se_ts;
  477. uint64_t se_full_ts;
  478. uint8_t se_rssi;
  479. uint8_t se_bwinfo;
  480. uint8_t se_dur;
  481. uint8_t se_chanindex;
  482. STAILQ_ENTRY(spectral_event) se_list;
  483. };
  484. /**
  485. * struct target_if_chain_noise_pwr_info - Noise power info for each channel
  486. * @rptcount: Count of reports in pwr array
  487. * @un_cal_nf: Uncalibrated noise floor
  488. * @factory_cal_nf: Noise floor as calibrated at the factory for module
  489. * @median_pwr: Median power (median of pwr array)
  490. * @pwr: Power reports
  491. */
  492. struct target_if_chain_noise_pwr_info {
  493. int rptcount;
  494. pwr_dbm un_cal_nf;
  495. pwr_dbm factory_cal_nf;
  496. pwr_dbm median_pwr;
  497. pwr_dbm pwr[];
  498. } __ATTRIB_PACK;
  499. /**
  500. * struct target_if_spectral_chan_stats - Channel information
  501. * @cycle_count: Cycle count
  502. * @channel_load: Channel load
  503. * @per: Period
  504. * @noisefloor: Noise floor
  505. * @comp_usablity: Computed usability
  506. * @maxregpower: Maximum allowed regulatary power
  507. * @comp_usablity_sec80: Computed usability of secondary 80 Mhz
  508. * @maxregpower_sec80: Max regulatory power in secondary 80 Mhz
  509. */
  510. struct target_if_spectral_chan_stats {
  511. int cycle_count;
  512. int channel_load;
  513. int per;
  514. int noisefloor;
  515. uint16_t comp_usablity;
  516. int8_t maxregpower;
  517. uint16_t comp_usablity_sec80;
  518. int8_t maxregpower_sec80;
  519. };
  520. #if ATH_PERF_PWR_OFFLOAD
  521. /**
  522. * struct target_if_spectral_cache - Cache used to minimize WMI operations
  523. * in offload architecture
  524. * @osc_spectral_enabled: Whether Spectral is enabled
  525. * @osc_spectral_active: Whether spectral is active
  526. * XXX: Ideally, we should NOT cache this
  527. * since the hardware can self clear the bit,
  528. * the firmware can possibly stop spectral due to
  529. * intermittent off-channel activity, etc
  530. * A WMI read command should be introduced to handle
  531. * this This will be discussed.
  532. * @osc_params: Spectral parameters
  533. * @osc_is_valid: Whether the cache is valid
  534. */
  535. struct target_if_spectral_cache {
  536. uint8_t osc_spectral_enabled;
  537. uint8_t osc_spectral_active;
  538. struct spectral_config osc_params;
  539. uint8_t osc_is_valid;
  540. };
  541. /**
  542. * struct target_if_spectral_param_state_info - Structure used to represent and
  543. * manage spectral information
  544. * (parameters and states)
  545. * @osps_lock: Lock to synchronize accesses to information
  546. * @osps_cache: Cacheable' information
  547. */
  548. struct target_if_spectral_param_state_info {
  549. qdf_spinlock_t osps_lock;
  550. struct target_if_spectral_cache osps_cache;
  551. /* XXX - Non-cacheable information goes here, in the future */
  552. };
  553. #endif /* ATH_PERF_PWR_OFFLOAD */
  554. struct vdev_spectral_configure_params;
  555. struct vdev_spectral_enable_params;
  556. /**
  557. * struct wmi_spectral_cmd_ops - structure used holding the operations
  558. * related to wmi commands on spectral parameters.
  559. * @wmi_spectral_configure_cmd_send:
  560. * @wmi_spectral_enable_cmd_send:
  561. */
  562. struct wmi_spectral_cmd_ops {
  563. QDF_STATUS (*wmi_spectral_configure_cmd_send)(
  564. void *wmi_hdl,
  565. struct vdev_spectral_configure_params *param);
  566. QDF_STATUS (*wmi_spectral_enable_cmd_send)(
  567. void *wmi_hdl,
  568. struct vdev_spectral_enable_params *param);
  569. };
  570. /**
  571. * struct target_if_spectral - main spectral structure
  572. * @pdev: Pointer to pdev
  573. * @spectral_ops: Target if internal Spectral low level operations table
  574. * @capability: Spectral capabilities structure
  575. * @spectral_lock: Lock used for internal Spectral operations
  576. * @spectral_curchan_radindex: Current channel spectral index
  577. * @spectral_extchan_radindex: Extension channel spectral index
  578. * @spectraldomain: Current Spectral domain
  579. * @spectral_proc_phyerr: Flags to process for PHY errors
  580. * @spectral_defaultparams: Default PHY params per Spectral stat
  581. * @spectral_stats: Spectral related stats
  582. * @events: Events structure
  583. * @sc_spectral_ext_chan_ok: Can spectral be detected on the extension channel?
  584. * @sc_spectral_combined_rssi_ok: Can use combined spectral RSSI?
  585. * @sc_spectral_20_40_mode: Is AP in 20-40 mode?
  586. * @sc_spectral_noise_pwr_cal: Noise power cal required?
  587. * @sc_spectral_non_edma: Is the spectral capable device Non-EDMA?
  588. * @upper_is_control: Upper segment is primary
  589. * @upper_is_extension: Upper segment is secondary
  590. * @lower_is_control: Lower segment is primary
  591. * @lower_is_extension: Lower segment is secondary
  592. * @sc_spectraltest_ieeechan: IEEE channel number to return to after a spectral
  593. * mute test
  594. * @spectral_numbins: Number of bins
  595. * @spectral_fft_len: FFT length
  596. * @spectral_data_len: Total phyerror report length
  597. * @lb_edge_extrabins: Number of extra bins on left band edge
  598. * @rb_edge_extrabins: Number of extra bins on right band edge
  599. * @spectral_max_index_offset: Max FFT index offset (20 MHz mode)
  600. * @spectral_upper_max_index_offset: Upper max FFT index offset (20/40 MHz mode)
  601. * @spectral_lower_max_index_offset: Lower max FFT index offset (20/40 MHz mode)
  602. * @spectral_dc_index: At which index DC is present
  603. * @send_single_packet: Deprecated
  604. * @spectral_sent_msg: Indicates whether we send report to upper layers
  605. * @params: Spectral parameters
  606. * @last_capture_time: Indicates timestamp of previouse report
  607. * @num_spectral_data: Number of Spectral samples received in current session
  608. * @total_spectral_data: Total number of Spectral samples received
  609. * @max_rssi: Maximum RSSI
  610. * @detects_control_channel: NA
  611. * @detects_extension_channel: NA
  612. * @detects_below_dc: NA
  613. * @detects_above_dc: NA
  614. * @sc_scanning: Indicates active wifi scan
  615. * @sc_spectral_scan: Indicates active specral scan
  616. * @sc_spectral_full_scan: Deprecated
  617. * @scan_start_tstamp: Deprecated
  618. * @last_tstamp: Deprecated
  619. * @first_tstamp: Deprecated
  620. * @spectral_samp_count: Deprecated
  621. * @sc_spectral_samp_count: Deprecated
  622. * @noise_pwr_reports_reqd: Number of noise power reports required
  623. * @noise_pwr_reports_recv: Number of noise power reports received
  624. * @noise_pwr_reports_lock: Lock used for Noise power report processing
  625. * @noise_pwr_chain_ctl: Noise power report - control channel
  626. * @noise_pwr_chain_ext: Noise power report - extension channel
  627. * @chaninfo: Channel statistics
  628. * @tsf64: Latest TSF Value
  629. * @param_info: Offload architecture Spectral parameter cache information
  630. * @ch_width: Indicates Channel Width 20/40/80/160 MHz with values 0, 1, 2, 3
  631. * respectively
  632. * @diag_stats: Diagnostic statistics
  633. * @is_160_format: Indicates whether information provided by HW is in altered
  634. * format for 802.11ac 160/80+80 MHz support (QCA9984 onwards)
  635. * @is_lb_edge_extrabins_format: Indicates whether information provided by
  636. * HW has 4 extra bins, at left band edge, for report mode 2
  637. * @is_rb_edge_extrabins_format: Indicates whether information provided
  638. * by HW has 4 extra bins, at right band edge, for report mode 2
  639. * @is_sec80_rssi_war_required: Indicates whether the software workaround is
  640. * required to obtain approximate combined RSSI for secondary 80Mhz segment
  641. * @simctx: Spectral Simulation context
  642. * @spectral_gen: Spectral hardware generation
  643. * @hdr_sig_exp: Expected signature in PHYERR TLV header, for the given hardware
  644. * generation
  645. * @tag_sscan_summary_exp: Expected Spectral Scan Summary tag in PHYERR TLV
  646. * header, for the given hardware generation
  647. * @tag_sscan_fft_exp: Expected Spectral Scan FFT report tag in PHYERR TLV
  648. * header, for the given hardware generation
  649. * @tlvhdr_size: Expected PHYERR TLV header size, for the given hardware
  650. * generation
  651. * @nl_cb: Netlink callbacks
  652. * @use_nl_bcast: Whether to use Netlink broadcast/unicast
  653. * @send_phy_data: Send data to the applicaton layer
  654. * @inband_fftbin_size_adj: Whether to carry out FFT bin size adjustment for
  655. * in-band report format. This would be required on some chipsets under the
  656. * following circumstances: In report mode 2 only the in-band bins are DMA'ed.
  657. * Scatter/gather is used. However, the HW generates all bins, not just in-band,
  658. * and reports the number of bins accordingly. The subsystem arranging for the
  659. * DMA cannot change this value. On such chipsets the adjustment required at the
  660. * host driver is to check if report format is 2, and if so halve the number of
  661. * bins reported to get the number actually DMA'ed.
  662. */
  663. struct target_if_spectral {
  664. struct wlan_objmgr_pdev *pdev_obj;
  665. struct target_if_spectral_ops spectral_ops;
  666. struct spectral_caps capability;
  667. qdf_spinlock_t spectral_lock;
  668. int16_t spectral_curchan_radindex;
  669. int16_t spectral_extchan_radindex;
  670. uint32_t spectraldomain;
  671. uint32_t spectral_proc_phyerr;
  672. struct spectral_config spectral_defaultparams;
  673. struct target_if_spectral_stats spectral_stats;
  674. struct target_if_spectral_event *events;
  675. unsigned int sc_spectral_ext_chan_ok:1,
  676. sc_spectral_combined_rssi_ok:1,
  677. sc_spectral_20_40_mode:1,
  678. sc_spectral_noise_pwr_cal:1,
  679. sc_spectral_non_edma:1;
  680. int upper_is_control;
  681. int upper_is_extension;
  682. int lower_is_control;
  683. int lower_is_extension;
  684. uint8_t sc_spectraltest_ieeechan;
  685. int spectral_numbins;
  686. int spectral_fft_len;
  687. int spectral_data_len;
  688. /*
  689. * For 11ac chipsets prior to AR900B version 2.0, a max of 512 bins are
  690. * delivered. However, there can be additional bins reported for
  691. * AR900B version 2.0 and QCA9984 as described next:
  692. *
  693. * AR900B version 2.0: An additional tone is processed on the right
  694. * hand side in order to facilitate detection of radar pulses out to
  695. * the extreme band-edge of the channel frequency. Since the HW design
  696. * processes four tones at a time, this requires one additional Dword
  697. * to be added to the search FFT report.
  698. *
  699. * QCA9984: When spectral_scan_rpt_mode = 2, i.e 2-dword summary +
  700. * 1x-oversampled bins (in-band) per FFT, then 8 more bins
  701. * (4 more on left side and 4 more on right side)are added.
  702. */
  703. int lb_edge_extrabins;
  704. int rb_edge_extrabins;
  705. int spectral_max_index_offset;
  706. int spectral_upper_max_index_offset;
  707. int spectral_lower_max_index_offset;
  708. int spectral_dc_index;
  709. int send_single_packet;
  710. int spectral_sent_msg;
  711. int classify_scan;
  712. os_timer_t classify_timer;
  713. struct spectral_config params;
  714. struct spectral_classifier_params classifier_params;
  715. int last_capture_time;
  716. int num_spectral_data;
  717. int total_spectral_data;
  718. int max_rssi;
  719. int detects_control_channel;
  720. int detects_extension_channel;
  721. int detects_below_dc;
  722. int detects_above_dc;
  723. int sc_scanning;
  724. int sc_spectral_scan;
  725. int sc_spectral_full_scan;
  726. uint64_t scan_start_tstamp;
  727. uint32_t last_tstamp;
  728. uint32_t first_tstamp;
  729. uint32_t spectral_samp_count;
  730. uint32_t sc_spectral_samp_count;
  731. int noise_pwr_reports_reqd;
  732. int noise_pwr_reports_recv;
  733. qdf_spinlock_t noise_pwr_reports_lock;
  734. struct target_if_chain_noise_pwr_info
  735. *noise_pwr_chain_ctl[HOST_MAX_ANTENNA];
  736. struct target_if_chain_noise_pwr_info
  737. *noise_pwr_chain_ext[HOST_MAX_ANTENNA];
  738. uint64_t tsf64;
  739. #if ATH_PERF_PWR_OFFLOAD
  740. struct target_if_spectral_param_state_info param_info;
  741. #endif
  742. uint32_t ch_width;
  743. struct spectral_diag_stats diag_stats;
  744. bool is_160_format;
  745. bool is_lb_edge_extrabins_format;
  746. bool is_rb_edge_extrabins_format;
  747. bool is_sec80_rssi_war_required;
  748. #ifdef QCA_SUPPORT_SPECTRAL_SIMULATION
  749. void *simctx;
  750. #endif
  751. enum spectral_gen spectral_gen;
  752. uint8_t hdr_sig_exp;
  753. uint8_t tag_sscan_summary_exp;
  754. uint8_t tag_sscan_fft_exp;
  755. uint8_t tlvhdr_size;
  756. struct wmi_spectral_cmd_ops param_wmi_cmd_ops;
  757. struct spectral_nl_cb nl_cb;
  758. bool use_nl_bcast;
  759. int (*send_phy_data)(struct wlan_objmgr_pdev *pdev);
  760. u_int8_t fftbin_size_war;
  761. u_int8_t inband_fftbin_size_adj;
  762. };
  763. /**
  764. * struct target_if_samp_msg_params - Spectral Analysis Messaging Protocol
  765. * data format
  766. * @rssi: RSSI (except for secondary 80 segment)
  767. * @rssi_sec80: RSSI for secondary 80 segment
  768. * @lower_rssi: RSSI of lower band
  769. * @upper_rssi: RSSI of upper band
  770. * @chain_ctl_rssi: RSSI for control channel, for all antennas
  771. * @chain_ext_rssi: RSSI for extension channel, for all antennas
  772. * @bwinfo: bandwidth info
  773. * @data_len: length of FFT data (except for secondary 80 segment)
  774. * @data_len_sec80: length of FFT data for secondary 80 segment
  775. * @tstamp: timestamp
  776. * @last_tstamp: last time stamp
  777. * @max_mag: maximum magnitude (except for secondary 80 segment)
  778. * @max_mag_sec80: maximum magnitude for secondary 80 segment
  779. * @max_index: index of max magnitude (except for secondary 80 segment)
  780. * @max_index_sec80: index of max magnitude for secondary 80 segment
  781. * @max_exp: max exp
  782. * @peak: peak frequency (obsolete)
  783. * @pwr_count: number of FFT bins (except for secondary 80 segment)
  784. * @pwr_count_sec80: number of FFT bins in secondary 80 segment
  785. * @nb_lower: This is deprecated
  786. * @nb_upper: This is deprecated
  787. * @max_upper_index: index of max mag in upper band
  788. * @max_lower_index: index of max mag in lower band
  789. * @bin_pwr_data: Contains FFT magnitudes (except for secondary 80 segment)
  790. * @bin_pwr_data_sec80: Contains FFT magnitudes for the secondary 80 segment
  791. * @freq: Center frequency of primary 20MHz channel in MHz
  792. * @vhtop_ch_freq_seg1: VHT operation first segment center frequency in MHz
  793. * @vhtop_ch_freq_seg2: VHT operation second segment center frequency in MHz
  794. * @freq_loading: spectral control duty cycles
  795. * @noise_floor: current noise floor (except for secondary 80 segment)
  796. * @noise_floor_sec80: current noise floor for secondary 80 segment
  797. * @interf_list: List of interfernce sources
  798. * @classifier_params: classifier parameters
  799. * @sc: classifier parameters
  800. */
  801. struct target_if_samp_msg_params {
  802. int8_t rssi;
  803. int8_t rssi_sec80;
  804. int8_t lower_rssi;
  805. int8_t upper_rssi;
  806. int8_t chain_ctl_rssi[HOST_MAX_ANTENNA];
  807. int8_t chain_ext_rssi[HOST_MAX_ANTENNA];
  808. uint16_t bwinfo;
  809. uint16_t datalen;
  810. uint16_t datalen_sec80;
  811. uint32_t tstamp;
  812. uint32_t last_tstamp;
  813. uint16_t max_mag;
  814. uint16_t max_mag_sec80;
  815. uint16_t max_index;
  816. uint16_t max_index_sec80;
  817. uint8_t max_exp;
  818. int peak;
  819. int pwr_count;
  820. int pwr_count_sec80;
  821. int8_t nb_lower;
  822. int8_t nb_upper;
  823. uint16_t max_lower_index;
  824. uint16_t max_upper_index;
  825. uint8_t *bin_pwr_data;
  826. uint8_t *bin_pwr_data_sec80;
  827. uint16_t freq;
  828. uint16_t vhtop_ch_freq_seg1;
  829. uint16_t vhtop_ch_freq_seg2;
  830. uint16_t freq_loading;
  831. int16_t noise_floor;
  832. int16_t noise_floor_sec80;
  833. struct interf_src_rsp interf_list;
  834. struct spectral_classifier_params classifier_params;
  835. struct ath_softc *sc;
  836. };
  837. /**
  838. * target_if_spectral_dump_fft() - Dump Spectral FFT
  839. * @pfft: Pointer to Spectral Phyerr FFT
  840. * @fftlen: FFT length
  841. *
  842. * Return: Success or failure
  843. */
  844. int target_if_spectral_dump_fft(uint8_t *pfft, int fftlen);
  845. /**
  846. * target_if_dbg_print_samp_param() - Print contents of SAMP struct
  847. * @p: Pointer to SAMP message
  848. *
  849. * Return: Void
  850. */
  851. void target_if_dbg_print_samp_param(struct target_if_samp_msg_params *p);
  852. /**
  853. * target_if_get_offset_swar_sec80() - Get offset for SWAR according to
  854. * the channel width
  855. * @channel_width: Channel width
  856. *
  857. * Return: Offset for SWAR
  858. */
  859. uint32_t target_if_get_offset_swar_sec80(uint32_t channel_width);
  860. /**
  861. * target_if_sptrl_register_tx_ops() - Register Spectral target_if Tx Ops
  862. * @tx_ops: Tx Ops
  863. *
  864. * Return: void
  865. */
  866. void target_if_sptrl_register_tx_ops(struct wlan_lmac_if_tx_ops *tx_ops);
  867. /**
  868. * target_if_spectral_create_samp_msg() - Create the spectral samp message
  869. * @spectral : Pointer to spectral internal structure
  870. * @params : spectral samp message parameters
  871. *
  872. * API to create the spectral samp message
  873. *
  874. * Return: void
  875. */
  876. void target_if_spectral_create_samp_msg(
  877. struct target_if_spectral *spectral,
  878. struct target_if_samp_msg_params *params);
  879. /**
  880. * target_if_spectral_process_phyerr_gen3() - Process phyerror event for gen3
  881. * @pdev: Pointer to pdev object
  882. * @payload: Pointer to spectral report
  883. *
  884. * Process phyerror event for gen3
  885. *
  886. * Return: Success/Failure
  887. */
  888. int target_if_spectral_process_phyerr_gen3(
  889. struct wlan_objmgr_pdev *pdev,
  890. struct direct_buf_rx_data *payload);
  891. /**
  892. * target_if_process_phyerr_gen2() - Process PHY Error for gen2
  893. * @spectral: Pointer to Spectral object
  894. * @data: Pointer to phyerror event buffer
  895. * @datalen: Data length
  896. * @p_rfqual: RF quality info
  897. * @p_chaninfo: Channel info
  898. * @tsf64: 64 bit tsf timestamp
  899. * @acs_stats: ACS stats
  900. *
  901. * Process PHY Error for gen2
  902. *
  903. * Return: Success/Failure
  904. */
  905. int target_if_process_phyerr_gen2(
  906. struct target_if_spectral *spectral,
  907. uint8_t *data,
  908. uint32_t datalen, struct target_if_spectral_rfqual_info *p_rfqual,
  909. struct target_if_spectral_chan_info *p_chaninfo,
  910. uint64_t tsf64,
  911. struct target_if_spectral_acs_stats *acs_stats);
  912. /**
  913. * target_if_spectral_send_intf_found_msg() - Indicate to application layer that
  914. * interference has been found
  915. * @pdev: Pointer to pdev
  916. * @cw_int: 1 if CW interference is found, 0 if WLAN interference is found
  917. * @dcs_enabled: 1 if DCS is enabled, 0 if DCS is disabled
  918. *
  919. * Send message to application layer
  920. * indicating that interference has been found
  921. *
  922. * Return: None
  923. */
  924. void target_if_spectral_send_intf_found_msg(
  925. struct wlan_objmgr_pdev *pdev,
  926. uint16_t cw_int, uint32_t dcs_enabled);
  927. /**
  928. * target_if_stop_spectral_scan() - Stop spectral scan
  929. * @pdev: Pointer to pdev object
  930. *
  931. * API to stop the current on-going spectral scan
  932. *
  933. * Return: None
  934. */
  935. void target_if_stop_spectral_scan(struct wlan_objmgr_pdev *pdev);
  936. /**
  937. * target_if_spectral_get_vdev() - Get pointer to vdev to be used for Spectral
  938. * operations
  939. * @spectral: Pointer to Spectral target_if internal private data
  940. *
  941. * Spectral operates on pdev. However, in order to retrieve some WLAN
  942. * properties, a vdev is required. To facilitate this, the function returns the
  943. * first vdev in our pdev. The caller should release the reference to the vdev
  944. * once it is done using it.
  945. * TODO: If the framework later provides an API to obtain the first active
  946. * vdev, then it would be preferable to use this API.
  947. *
  948. * Return: Pointer to vdev on success, NULL on failure
  949. */
  950. struct wlan_objmgr_vdev *target_if_spectral_get_vdev(
  951. struct target_if_spectral *spectral);
  952. /**
  953. * target_if_spectral_dump_hdr_gen2() - Dump Spectral header for gen2
  954. * @phdr: Pointer to Spectral Phyerr Header
  955. *
  956. * Dump Spectral header
  957. *
  958. * Return: Success/Failure
  959. */
  960. int target_if_spectral_dump_hdr_gen2(struct spectral_phyerr_hdr_gen2 *phdr);
  961. /**
  962. * target_if_get_combrssi_sec80_seg_gen2() - Get approximate combined RSSI
  963. * for Secondary 80 segment
  964. * @spectral: Pointer to spectral object
  965. * @p_sfft_sec80: Pointer to search fft info of secondary 80 segment
  966. *
  967. * Get approximate combined RSSI for Secondary 80 segment
  968. *
  969. * Return: Combined RSSI for secondary 80Mhz segment
  970. */
  971. int8_t target_if_get_combrssi_sec80_seg_gen2(
  972. struct target_if_spectral *spectral,
  973. struct spectral_search_fft_info_gen2 *p_sfft_sec80);
  974. /**
  975. * target_if_spectral_dump_tlv_gen2() - Dump Spectral TLV for gen2
  976. * @ptlv: Pointer to Spectral Phyerr TLV
  977. * @is_160_format: Indicates 160 format
  978. *
  979. * Dump Spectral TLV for gen2
  980. *
  981. * Return: Success/Failure
  982. */
  983. int target_if_spectral_dump_tlv_gen2(
  984. struct spectral_phyerr_tlv_gen2 *ptlv, bool is_160_format);
  985. /**
  986. * target_if_spectral_dump_phyerr_data_gen2() - Dump Spectral
  987. * related PHY Error for gen2
  988. * @data: Pointer to phyerror buffer
  989. * @datalen: Data length
  990. * @is_160_format: Indicates 160 format
  991. *
  992. * Dump Spectral related PHY Error for gen2
  993. *
  994. * Return: Success/Failure
  995. */
  996. int target_if_spectral_dump_phyerr_data_gen2(
  997. uint8_t *data,
  998. uint32_t datalen,
  999. bool is_160_format);
  1000. /**
  1001. * target_if_dump_fft_report_gen3() - Dump FFT Report for gen3
  1002. * @spectral: Pointer to Spectral object
  1003. * @p_fft_report: Pointer to fft report
  1004. * @p_sfft: Pointer to search fft report
  1005. *
  1006. * Dump FFT Report for gen3
  1007. *
  1008. * Return: Success/Failure
  1009. */
  1010. int target_if_dump_fft_report_gen3(struct target_if_spectral *spectral,
  1011. struct spectral_phyerr_fft_report_gen3 *p_fft_report,
  1012. struct spectral_search_fft_info_gen3 *p_sfft);
  1013. /**
  1014. * target_if_dbg_print_samp_msg() - Print contents of SAMP Message
  1015. * @p: Pointer to SAMP message
  1016. *
  1017. * Print contents of SAMP Message
  1018. *
  1019. * Return: Void
  1020. */
  1021. void target_if_dbg_print_samp_msg(struct spectral_samp_msg *pmsg);
  1022. /**
  1023. * target_if_process_sfft_report_gen3() - Process Search FFT Report for gen3
  1024. * @p_fft_report: Pointer to fft report
  1025. * @p_sfft: Pointer to search fft report
  1026. *
  1027. * Process Search FFT Report for gen3
  1028. *
  1029. * Return: Success/Failure
  1030. */
  1031. int target_if_process_sfft_report_gen3(
  1032. struct spectral_phyerr_fft_report_gen3 *p_fft_report,
  1033. struct spectral_search_fft_info_gen3 *p_fft_info);
  1034. /**
  1035. * get_target_if_spectral_handle_from_pdev() - Get handle to target_if internal
  1036. * Spectral data
  1037. * @pdev: Pointer to pdev
  1038. *
  1039. * Return: Handle to target_if internal Spectral data on success, NULL on
  1040. * failure
  1041. */
  1042. static inline
  1043. struct target_if_spectral *get_target_if_spectral_handle_from_pdev(
  1044. struct wlan_objmgr_pdev *pdev)
  1045. {
  1046. struct target_if_spectral *spectral = NULL;
  1047. struct wlan_objmgr_psoc *psoc = NULL;
  1048. psoc = wlan_pdev_get_psoc(pdev);
  1049. spectral = (struct target_if_spectral *)
  1050. psoc->soc_cb.rx_ops.sptrl_rx_ops.sptrlro_get_target_handle(
  1051. pdev);
  1052. return spectral;
  1053. }
  1054. /**
  1055. * target_if_vdev_get_chan_freq() - Get the operating channel frequency of a
  1056. * given vdev
  1057. * @pdev: Pointer to vdev
  1058. *
  1059. * Get the operating channel frequency of a given vdev
  1060. *
  1061. * Return: Operating channel frequency of a vdev
  1062. */
  1063. static inline
  1064. int16_t target_if_vdev_get_chan_freq(struct wlan_objmgr_vdev *vdev)
  1065. {
  1066. struct wlan_objmgr_psoc *psoc = NULL;
  1067. psoc = wlan_vdev_get_psoc(vdev);
  1068. if (!psoc) {
  1069. spectral_err("psoc is NULL");
  1070. return -EINVAL;
  1071. }
  1072. return psoc->soc_cb.rx_ops.sptrl_rx_ops.sptrlro_vdev_get_chan_freq(
  1073. vdev);
  1074. }
  1075. /**
  1076. * target_if_vdev_get_ch_width() - Get the operating channel bandwidth of a
  1077. * given vdev
  1078. * @pdev: Pointer to vdev
  1079. *
  1080. * Get the operating channel bandwidth of a given vdev
  1081. *
  1082. * Return: channel bandwidth enumeration corresponding to the vdev
  1083. */
  1084. static inline
  1085. enum phy_ch_width target_if_vdev_get_ch_width(struct wlan_objmgr_vdev *vdev)
  1086. {
  1087. struct wlan_objmgr_psoc *psoc = NULL;
  1088. psoc = wlan_vdev_get_psoc(vdev);
  1089. if (!psoc) {
  1090. spectral_err("psoc is NULL");
  1091. return CH_WIDTH_INVALID;
  1092. }
  1093. return psoc->soc_cb.rx_ops.sptrl_rx_ops.sptrlro_vdev_get_ch_width(
  1094. vdev);
  1095. }
  1096. /**
  1097. * target_if_vdev_get_sec20chan_freq_mhz() - Get the frequency of secondary
  1098. * 20 MHz channel for a given vdev
  1099. * @pdev: Pointer to vdev
  1100. *
  1101. * Get the frequency of secondary 20Mhz channel for a given vdev
  1102. *
  1103. * Return: Frequency of secondary 20Mhz channel for a given vdev
  1104. */
  1105. static inline
  1106. int target_if_vdev_get_sec20chan_freq_mhz(
  1107. struct wlan_objmgr_vdev *vdev,
  1108. uint16_t *sec20chan_freq)
  1109. {
  1110. struct wlan_objmgr_psoc *psoc = NULL;
  1111. psoc = wlan_vdev_get_psoc(vdev);
  1112. if (!psoc) {
  1113. spectral_err("psoc is NULL");
  1114. return -EINVAL;
  1115. }
  1116. return psoc->soc_cb.rx_ops.sptrl_rx_ops.
  1117. sptrlro_vdev_get_sec20chan_freq_mhz(vdev, sec20chan_freq);
  1118. }
  1119. /**
  1120. * target_if_spectral_set_rxchainmask() - Set Spectral Rx chainmask
  1121. * @pdev: Pointer to pdev
  1122. * @spectral_rx_chainmask: Spectral Rx chainmask
  1123. *
  1124. * Return: None
  1125. */
  1126. static inline
  1127. void target_if_spectral_set_rxchainmask(struct wlan_objmgr_pdev *pdev,
  1128. uint8_t spectral_rx_chainmask)
  1129. {
  1130. struct target_if_spectral *spectral = NULL;
  1131. spectral = get_target_if_spectral_handle_from_pdev(pdev);
  1132. spectral->params.ss_chn_mask = spectral_rx_chainmask;
  1133. }
  1134. /**
  1135. * target_if_spectral_process_phyerr() - Process Spectral PHY error
  1136. * @pdev: Pointer to pdev
  1137. * @data: PHY error data received from FW
  1138. * @datalen: Length of data
  1139. * @p_rfqual: Pointer to RF Quality information
  1140. * @p_chaninfo: Pointer to channel information
  1141. * @tsf: TSF time instance at which the Spectral sample was received
  1142. * @acs_stats: ACS stats
  1143. *
  1144. * Process Spectral PHY error by extracting necessary information from the data
  1145. * sent by FW, and send the extracted information to application layer.
  1146. *
  1147. * Return: None
  1148. */
  1149. static inline
  1150. void target_if_spectral_process_phyerr(
  1151. struct wlan_objmgr_pdev *pdev,
  1152. uint8_t *data, uint32_t datalen,
  1153. struct target_if_spectral_rfqual_info *p_rfqual,
  1154. struct target_if_spectral_chan_info *p_chaninfo,
  1155. uint64_t tsf64,
  1156. struct target_if_spectral_acs_stats *acs_stats)
  1157. {
  1158. struct target_if_spectral *spectral = NULL;
  1159. struct target_if_spectral_ops *p_sops = NULL;
  1160. spectral = get_target_if_spectral_handle_from_pdev(pdev);
  1161. p_sops = GET_TARGET_IF_SPECTRAL_OPS(spectral);
  1162. p_sops->spectral_process_phyerr(spectral, data, datalen,
  1163. p_rfqual, p_chaninfo,
  1164. tsf64, acs_stats);
  1165. }
  1166. /**
  1167. * target_if_sops_is_spectral_enabled() - Get whether Spectral is enabled
  1168. * @arg: Pointer to handle for Spectral target_if internal private data
  1169. *
  1170. * Function to check whether Spectral is enabled
  1171. *
  1172. * Return: True if Spectral is enabled, false if Spectral is not enabled
  1173. */
  1174. uint32_t target_if_sops_is_spectral_enabled(void *arg);
  1175. /**
  1176. * target_if_sops_is_spectral_active() - Get whether Spectral is active
  1177. * @arg: Pointer to handle for Spectral target_if internal private data
  1178. *
  1179. * Function to check whether Spectral is active
  1180. *
  1181. * Return: True if Spectral is active, false if Spectral is not active
  1182. */
  1183. uint32_t target_if_sops_is_spectral_active(void *arg);
  1184. /**
  1185. * target_if_sops_start_spectral_scan() - Start Spectral scan
  1186. * @arg: Pointer to handle for Spectral target_if internal private data
  1187. *
  1188. * Function to start spectral scan
  1189. *
  1190. * Return: 0 on success else failure
  1191. */
  1192. uint32_t target_if_sops_start_spectral_scan(void *arg);
  1193. /**
  1194. * target_if_sops_stop_spectral_scan() - Stop Spectral scan
  1195. * @arg: Pointer to handle for Spectral target_if internal private data
  1196. *
  1197. * Function to stop spectral scan
  1198. *
  1199. * Return: 0 in case of success, -1 on failure
  1200. */
  1201. uint32_t target_if_sops_stop_spectral_scan(void *arg);
  1202. /**
  1203. * target_if_spectral_get_extension_channel() - Get the current Extension
  1204. * channel (in MHz)
  1205. * @arg: Pointer to handle for Spectral target_if internal private data
  1206. *
  1207. * Return: Current Extension channel (in MHz) on success, 0 on failure or if
  1208. * extension channel is not present.
  1209. */
  1210. uint32_t target_if_spectral_get_extension_channel(void *arg);
  1211. /**
  1212. * target_if_spectral_get_current_channel() - Get the current channel (in MHz)
  1213. * @arg: Pointer to handle for Spectral target_if internal private data
  1214. *
  1215. * Return: Current channel (in MHz) on success, 0 on failure
  1216. */
  1217. uint32_t target_if_spectral_get_current_channel(void *arg);
  1218. /**
  1219. * target_if_spectral_reset_hw() - Reset the hardware
  1220. * @arg: Pointer to handle for Spectral target_if internal private data
  1221. *
  1222. * This is only a placeholder since it is not currently required in the offload
  1223. * case.
  1224. *
  1225. * Return: 0
  1226. */
  1227. uint32_t target_if_spectral_reset_hw(void *arg);
  1228. /**
  1229. * target_if_spectral_get_chain_noise_floor() - Get the Chain noise floor from
  1230. * Noisefloor history buffer
  1231. * @arg: Pointer to handle for Spectral target_if internal private data
  1232. * @nf_buf: Pointer to buffer into which chain Noise Floor data should be copied
  1233. *
  1234. * This is only a placeholder since it is not currently required in the offload
  1235. * case.
  1236. *
  1237. * Return: 0
  1238. */
  1239. uint32_t target_if_spectral_get_chain_noise_floor(void *arg, int16_t *nf_buf);
  1240. /**
  1241. * target_if_spectral_get_ext_noisefloor() - Get the extension channel
  1242. * noisefloor
  1243. * @arg: Pointer to handle for Spectral target_if internal private data
  1244. *
  1245. * This is only a placeholder since it is not currently required in the offload
  1246. * case.
  1247. *
  1248. * Return: 0
  1249. */
  1250. int8_t target_if_spectral_get_ext_noisefloor(void *arg);
  1251. /**
  1252. * target_if_spectral_get_ctl_noisefloor() - Get the control channel noisefloor
  1253. * @arg: Pointer to handle for Spectral target_if internal private data
  1254. *
  1255. * This is only a placeholder since it is not currently required in the offload
  1256. * case.
  1257. *
  1258. * Return: 0
  1259. */
  1260. int8_t target_if_spectral_get_ctl_noisefloor(void *arg);
  1261. /**
  1262. * target_if_spectral_get_capability() - Get whether a given Spectral hardware
  1263. * capability is available
  1264. * @arg: Pointer to handle for Spectral target_if internal private data
  1265. * @type: Spectral hardware capability type
  1266. *
  1267. * Return: True if the capability is available, false if the capability is not
  1268. * available
  1269. */
  1270. uint32_t target_if_spectral_get_capability(
  1271. void *arg, enum spectral_capability_type type);
  1272. /**
  1273. * target_if_spectral_set_rxfilter() - Set the RX Filter before Spectral start
  1274. * @arg: Pointer to handle for Spectral target_if internal private data
  1275. * @rxfilter: Rx filter to be used
  1276. *
  1277. * Note: This is only a placeholder function. It is not currently required since
  1278. * FW should be taking care of setting the required filters.
  1279. *
  1280. * Return: 0
  1281. */
  1282. uint32_t target_if_spectral_set_rxfilter(void *arg, int rxfilter);
  1283. /**
  1284. * target_if_spectral_sops_configure_params() - Configure user supplied Spectral
  1285. * parameters
  1286. * @arg: Pointer to handle for Spectral target_if internal private data
  1287. * @params: Spectral parameters
  1288. *
  1289. * Return: 0 in case of success, -1 on failure
  1290. */
  1291. uint32_t target_if_spectral_sops_configure_params(
  1292. void *arg, struct spectral_config *params);
  1293. /**
  1294. * target_if_spectral_get_rxfilter() - Get the current RX Filter settings
  1295. * @arg: Pointer to handle for Spectral target_if internal private data
  1296. *
  1297. * Note: This is only a placeholder function. It is not currently required since
  1298. * FW should be taking care of setting the required filters.
  1299. *
  1300. * Return: 0
  1301. */
  1302. uint32_t target_if_spectral_get_rxfilter(void *arg);
  1303. /**
  1304. * target_if_pdev_spectral_deinit() - De-initialize target_if Spectral
  1305. * functionality for the given pdev
  1306. * @pdev: Pointer to pdev object
  1307. *
  1308. * Return: None
  1309. */
  1310. void target_if_pdev_spectral_deinit(struct wlan_objmgr_pdev *pdev);
  1311. /**
  1312. * target_if_set_spectral_config() - Set spectral config
  1313. * @pdev: Pointer to pdev object
  1314. * @threshtype: config type
  1315. * @value: config value
  1316. *
  1317. * API to set spectral configurations
  1318. *
  1319. * Return: 0 in case of success, -1 on failure
  1320. */
  1321. int target_if_set_spectral_config(struct wlan_objmgr_pdev *pdev,
  1322. const uint32_t threshtype,
  1323. const uint32_t value);
  1324. /**
  1325. * target_if_pdev_spectral_init() - Initialize target_if Spectral
  1326. * functionality for the given pdev
  1327. * @pdev: Pointer to pdev object
  1328. *
  1329. * Return: On success, pointer to Spectral target_if internal private data, on
  1330. * failure, NULL
  1331. */
  1332. void *target_if_pdev_spectral_init(struct wlan_objmgr_pdev *pdev);
  1333. /**
  1334. * target_if_spectral_sops_get_params() - Get user configured Spectral
  1335. * parameters
  1336. * @arg: Pointer to handle for Spectral target_if internal private data
  1337. * @params: Pointer to buffer into which Spectral parameters should be copied
  1338. *
  1339. * Return: 0 in case of success, -1 on failure
  1340. */
  1341. uint32_t target_if_spectral_sops_get_params(
  1342. void *arg, struct spectral_config *params);
  1343. /**
  1344. * target_if_init_spectral_capability() - Initialize Spectral capability
  1345. * @spectral: Pointer to Spectral target_if internal private data
  1346. *
  1347. * This is a workaround.
  1348. *
  1349. * Return: None
  1350. */
  1351. void target_if_init_spectral_capability(struct target_if_spectral *spectral);
  1352. /**
  1353. * target_if_start_spectral_scan() - Start spectral scan
  1354. * @pdev: Pointer to pdev object
  1355. *
  1356. * API to start spectral scan
  1357. *
  1358. * Return: 0 in case of success, -1 on failure
  1359. */
  1360. int target_if_start_spectral_scan(struct wlan_objmgr_pdev *pdev);
  1361. /**
  1362. * target_if_get_spectral_config() - Get spectral configuration
  1363. * @pdev: Pointer to pdev object
  1364. * @param: Pointer to spectral_config structure in which the configuration
  1365. * should be returned
  1366. *
  1367. * API to get the current spectral configuration
  1368. *
  1369. * Return: 0 in case of success, -1 on failure
  1370. */
  1371. void target_if_get_spectral_config(struct wlan_objmgr_pdev *pdev,
  1372. struct spectral_config *param);
  1373. /**
  1374. * target_if_spectral_scan_enable_params() - Enable use of desired Spectral
  1375. * parameters
  1376. * @spectral: Pointer to Spectral target_if internal private data
  1377. * @spectral_params: Pointer to Spectral parameters
  1378. *
  1379. * Enable use of desired Spectral parameters by configuring them into HW, and
  1380. * starting Spectral scan
  1381. *
  1382. * Return: 0 on success, 1 on failure
  1383. */
  1384. int target_if_spectral_scan_enable_params(
  1385. struct target_if_spectral *spectral, struct spectral_config *spectral_params);
  1386. /**
  1387. * target_if_is_spectral_active() - Get whether Spectral is active
  1388. * @pdev: Pointer to pdev object
  1389. *
  1390. * Return: True if Spectral is active, false if Spectral is not active
  1391. */
  1392. bool target_if_is_spectral_active(struct wlan_objmgr_pdev *pdev);
  1393. /**
  1394. * target_if_is_spectral_enabled() - Get whether Spectral is enabled
  1395. * @pdev: Pointer to pdev object
  1396. *
  1397. * Return: True if Spectral is enabled, false if Spectral is not enabled
  1398. */
  1399. bool target_if_is_spectral_enabled(struct wlan_objmgr_pdev *pdev);
  1400. /**
  1401. * target_if_set_debug_level() - Set debug level for Spectral
  1402. * @pdev: Pointer to pdev object
  1403. * @debug_level: Debug level
  1404. *
  1405. * Return: 0 in case of success
  1406. */
  1407. int target_if_set_debug_level(struct wlan_objmgr_pdev *pdev,
  1408. uint32_t debug_level);
  1409. /**
  1410. * target_if_get_debug_level() - Get debug level for Spectral
  1411. * @pdev: Pointer to pdev object
  1412. *
  1413. * Return: Current debug level
  1414. */
  1415. uint32_t target_if_get_debug_level(struct wlan_objmgr_pdev *pdev);
  1416. /**
  1417. * target_if_get_spectral_capinfo() - Get Spectral capability information
  1418. * @pdev: Pointer to pdev object
  1419. * @outdata: Buffer into which data should be copied
  1420. *
  1421. * Return: void
  1422. */
  1423. void target_if_get_spectral_capinfo(
  1424. struct wlan_objmgr_pdev *pdev,
  1425. void *outdata);
  1426. /**
  1427. * target_if_get_spectral_diagstats() - Get Spectral diagnostic statistics
  1428. * @pdev: Pointer to pdev object
  1429. * @outdata: Buffer into which data should be copied
  1430. *
  1431. * Return: void
  1432. */
  1433. void target_if_get_spectral_diagstats(struct wlan_objmgr_pdev *pdev,
  1434. void *outdata);
  1435. /*
  1436. * target_if_spectral_send_tlv_to_host - target_if_spectral_send_tlv_to_host
  1437. * @spectral: Send the TLV information to Host
  1438. * @data: Pointer to the TLV
  1439. * @datalen: tlv length
  1440. *
  1441. * Return: Success/Failure
  1442. *
  1443. */
  1444. int target_if_spectral_send_tlv_to_host(
  1445. struct target_if_spectral *spectral,
  1446. uint8_t *data, uint32_t datalen);
  1447. void target_if_register_wmi_spectral_cmd_ops(
  1448. struct wlan_objmgr_pdev *pdev,
  1449. struct wmi_spectral_cmd_ops *cmd_ops);
  1450. #ifdef WIN32
  1451. #pragma pack(pop, target_if_spectral)
  1452. #endif
  1453. #ifdef __ATTRIB_PACK
  1454. #undef __ATTRIB_PACK
  1455. #endif
  1456. #endif /* _TARGET_IF_SPECTRAL_H_ */