target_if_spectral.h 81 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453
  1. /*
  2. * Copyright (c) 2011,2017-2020 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. #ifdef DIRECT_BUF_RX_ENABLE
  29. #include <target_if_direct_buf_rx_api.h>
  30. #endif
  31. #ifdef WIN32
  32. #pragma pack(push, target_if_spectral, 1)
  33. #define __ATTRIB_PACK
  34. #else
  35. #ifndef __ATTRIB_PACK
  36. #define __ATTRIB_PACK __attribute__ ((packed))
  37. #endif
  38. #endif
  39. #include <spectral_defs_i.h>
  40. #include <wmi_unified_param.h>
  41. #define FREQ_OFFSET_10MHZ (10)
  42. #define FREQ_OFFSET_40MHZ (40)
  43. #define FREQ_OFFSET_80MHZ (80)
  44. #ifndef SPECTRAL_USE_NL_BCAST
  45. #define SPECTRAL_USE_NL_BCAST (0)
  46. #endif
  47. #define STATUS_PASS 1
  48. #define STATUS_FAIL 0
  49. #undef spectral_dbg_line
  50. #define spectral_dbg_line() \
  51. spectral_debug("----------------------------------------------------")
  52. #undef spectral_ops_not_registered
  53. #define spectral_ops_not_registered(str) \
  54. spectral_info("SPECTRAL : %s not registered\n", (str))
  55. #undef not_yet_implemented
  56. #define not_yet_implemented() \
  57. spectral_info("SPECTRAL : %s : %d Not yet implemented\n", \
  58. __func__, __LINE__)
  59. #define SPECTRAL_HT20_NUM_BINS 56
  60. #define SPECTRAL_HT20_FFT_LEN 56
  61. #define SPECTRAL_HT20_DC_INDEX (SPECTRAL_HT20_FFT_LEN / 2)
  62. #define SPECTRAL_HT20_DATA_LEN 60
  63. #define SPECTRAL_HT20_TOTAL_DATA_LEN (SPECTRAL_HT20_DATA_LEN + 3)
  64. #define SPECTRAL_HT40_TOTAL_NUM_BINS 128
  65. #define SPECTRAL_HT40_DATA_LEN 135
  66. #define SPECTRAL_HT40_TOTAL_DATA_LEN (SPECTRAL_HT40_DATA_LEN + 3)
  67. #define SPECTRAL_HT40_FFT_LEN 128
  68. #define SPECTRAL_HT40_DC_INDEX (SPECTRAL_HT40_FFT_LEN / 2)
  69. /*
  70. * Used for the SWAR to obtain approximate combined rssi
  71. * in secondary 80Mhz segment
  72. */
  73. #define OFFSET_CH_WIDTH_20 65
  74. #define OFFSET_CH_WIDTH_40 62
  75. #define OFFSET_CH_WIDTH_80 56
  76. #define OFFSET_CH_WIDTH_160 50
  77. /* Min and max for relevant Spectral params */
  78. #define SPECTRAL_PARAM_FFT_SIZE_MIN_GEN2 (1)
  79. #define SPECTRAL_PARAM_FFT_SIZE_MAX_GEN2 (9)
  80. #define SPECTRAL_PARAM_FFT_SIZE_MIN_GEN3 (5)
  81. #define SPECTRAL_PARAM_FFT_SIZE_MAX_GEN3_DEFAULT (9)
  82. #define SPECTRAL_PARAM_FFT_SIZE_MAX_GEN3_QCN9000 (10)
  83. #define SPECTRAL_PARAM_RPT_MODE_MIN (0)
  84. #define SPECTRAL_PARAM_RPT_MODE_MAX (3)
  85. #define MAX_FFTBIN_VALUE (255)
  86. /* DBR ring debug size for Spectral */
  87. #define SPECTRAL_DBR_RING_DEBUG_SIZE 512
  88. #ifdef BIG_ENDIAN_HOST
  89. #define SPECTRAL_MESSAGE_COPY_CHAR_ARRAY(destp, srcp, len) do { \
  90. int j; \
  91. uint32_t *src, *dest; \
  92. src = (uint32_t *)(srcp); \
  93. dest = (uint32_t *)(destp); \
  94. for (j = 0; j < roundup((len), sizeof(uint32_t)) / 4; j++) { \
  95. *(dest + j) = qdf_le32_to_cpu(*(src + j)); \
  96. } \
  97. } while (0)
  98. #else
  99. #define SPECTRAL_MESSAGE_COPY_CHAR_ARRAY(destp, srcp, len) \
  100. OS_MEMCPY((destp), (srcp), (len));
  101. #endif
  102. #define DUMMY_NF_VALUE (-123)
  103. /* 5 categories x (lower + upper) bands */
  104. #define MAX_INTERF 10
  105. #define HOST_MAX_ANTENNA 3
  106. /* Mask for time stamp from descriptor */
  107. #define SPECTRAL_TSMASK 0xFFFFFFFF
  108. #define SPECTRAL_SIGNATURE 0xdeadbeef
  109. /* Signature to write onto spectral buffer and then later validate */
  110. #define MEM_POISON_SIGNATURE (htobe32(0xdeadbeef))
  111. /* START of spectral GEN II HW specific details */
  112. #define SPECTRAL_PHYERR_SIGNATURE_GEN2 0xbb
  113. #define TLV_TAG_SPECTRAL_SUMMARY_REPORT_GEN2 0xF9
  114. #define TLV_TAG_ADC_REPORT_GEN2 0xFA
  115. #define TLV_TAG_SEARCH_FFT_REPORT_GEN2 0xFB
  116. /**
  117. * enum spectral_160mhz_report_delivery_state - 160 MHz state machine states
  118. * @SPECTRAL_REPORT_WAIT_PRIMARY80: Wait for primary80 report
  119. * @SPECTRAL_REPORT_RX_PRIMARY80: Receive primary 80 report
  120. * @SPECTRAL_REPORT_WAIT_SECONDARY80: Wait for secondory 80 report
  121. * @SPECTRAL_REPORT_RX_SECONDARY80: Receive secondary 80 report
  122. */
  123. enum spectral_160mhz_report_delivery_state {
  124. SPECTRAL_REPORT_WAIT_PRIMARY80,
  125. SPECTRAL_REPORT_RX_PRIMARY80,
  126. SPECTRAL_REPORT_WAIT_SECONDARY80,
  127. SPECTRAL_REPORT_RX_SECONDARY80,
  128. };
  129. /**
  130. * enum spectral_detector_id - Spectral detector id
  131. * @SPECTRAL_DETECTOR_ID_0: Spectral detector 0
  132. * @SPECTRAL_DETECTOR_ID_1: Spectral detector 1
  133. * @SPECTRAL_DETECTOR_ID_2: Spectral detector 2
  134. * @SPECTRAL_DETECTOR_ID_MAX: Max Spectral detector ID
  135. * @SPECTRAL_DETECTOR_ID_INVALID: Invalid Spectral detector ID
  136. */
  137. enum spectral_detector_id {
  138. SPECTRAL_DETECTOR_ID_0,
  139. SPECTRAL_DETECTOR_ID_1,
  140. SPECTRAL_DETECTOR_ID_2,
  141. SPECTRAL_DETECTOR_ID_MAX,
  142. SPECTRAL_DETECTOR_ID_INVALID = 0xff,
  143. };
  144. /**
  145. * struct spectral_search_fft_info_gen2 - spectral search fft report for gen2
  146. * @relpwr_db: Total bin power in db
  147. * @num_str_bins_ib: Number of strong bins
  148. * @base_pwr: Base power
  149. * @total_gain_info: Total gain
  150. * @fft_chn_idx: FFT chain on which report is originated
  151. * @avgpwr_db: Average power in db
  152. * @peak_mag: Peak power seen in the bins
  153. * @peak_inx: Index of bin holding peak power
  154. */
  155. struct spectral_search_fft_info_gen2 {
  156. uint32_t relpwr_db;
  157. uint32_t num_str_bins_ib;
  158. uint32_t base_pwr;
  159. uint32_t total_gain_info;
  160. uint32_t fft_chn_idx;
  161. uint32_t avgpwr_db;
  162. uint32_t peak_mag;
  163. int16_t peak_inx;
  164. };
  165. /*
  166. * XXX Check if we should be handling the endinness difference in some
  167. * other way opaque to the host
  168. */
  169. #ifdef BIG_ENDIAN_HOST
  170. /**
  171. * struct spectral_phyerr_tlv_gen2 - phyerr tlv info for big endian host
  172. * @signature: signature
  173. * @tag: tag
  174. * @length: length
  175. */
  176. struct spectral_phyerr_tlv_gen2 {
  177. uint8_t signature;
  178. uint8_t tag;
  179. uint16_t length;
  180. } __ATTRIB_PACK;
  181. #else
  182. /**
  183. * struct spectral_phyerr_tlv_gen2 - phyerr tlv info for little endian host
  184. * @length: length
  185. * @tag: tag
  186. * @signature: signature
  187. */
  188. struct spectral_phyerr_tlv_gen2 {
  189. uint16_t length;
  190. uint8_t tag;
  191. uint8_t signature;
  192. } __ATTRIB_PACK;
  193. #endif /* BIG_ENDIAN_HOST */
  194. /**
  195. * struct spectral_phyerr_hdr_gen2 - phyerr header for gen2 HW
  196. * @hdr_a: Header[0:31]
  197. * @hdr_b: Header[32:63]
  198. */
  199. struct spectral_phyerr_hdr_gen2 {
  200. uint32_t hdr_a;
  201. uint32_t hdr_b;
  202. };
  203. /*
  204. * Segment ID information for 80+80.
  205. *
  206. * If the HW micro-architecture specification extends this DWORD for other
  207. * purposes, then redefine+rename accordingly. For now, the specification
  208. * mentions only segment ID (though this doesn't require an entire DWORD)
  209. * without mention of any generic terminology for the DWORD, or any reservation.
  210. * We use nomenclature accordingly.
  211. */
  212. typedef uint32_t SPECTRAL_SEGID_INFO;
  213. /**
  214. * struct spectral_phyerr_fft_gen2 - fft info in phyerr event
  215. * @buf: fft report
  216. */
  217. struct spectral_phyerr_fft_gen2 {
  218. uint8_t buf[0];
  219. };
  220. /* END of spectral GEN II HW specific details */
  221. /* START of spectral GEN III HW specific details */
  222. #define get_bitfield(value, size, pos) \
  223. (((value) >> (pos)) & ((1 << (size)) - 1))
  224. #define unsigned_to_signed(value, width) \
  225. (((value) >= (1 << ((width) - 1))) ? \
  226. (value - (1 << (width))) : (value))
  227. #define SSCAN_SUMMARY_REPORT_HDR_A_DETECTOR_ID_POS_GEN3 (29)
  228. #define SSCAN_SUMMARY_REPORT_HDR_A_DETECTOR_ID_SIZE_GEN3 (2)
  229. #define SSCAN_SUMMARY_REPORT_HDR_A_AGC_TOTAL_GAIN_POS_GEN3 (0)
  230. #define SSCAN_SUMMARY_REPORT_HDR_A_AGC_TOTAL_GAIN_SIZE_GEN3 (8)
  231. #define SSCAN_SUMMARY_REPORT_HDR_A_INBAND_PWR_DB_POS_GEN3 (18)
  232. #define SSCAN_SUMMARY_REPORT_HDR_A_INBAND_PWR_DB_SIZE_GEN3 (10)
  233. #define SSCAN_SUMMARY_REPORT_HDR_A_PRI80_POS_GEN3 (31)
  234. #define SSCAN_SUMMARY_REPORT_HDR_A_PRI80_SIZE_GEN3 (1)
  235. #define SSCAN_SUMMARY_REPORT_HDR_B_GAINCHANGE_POS_GEN3_V1 (30)
  236. #define SSCAN_SUMMARY_REPORT_HDR_B_GAINCHANGE_SIZE_GEN3_V1 (1)
  237. #define SSCAN_SUMMARY_REPORT_HDR_C_GAINCHANGE_POS_GEN3_V2 (16)
  238. #define SSCAN_SUMMARY_REPORT_HDR_C_GAINCHANGE_SIZE_GEN3_V2 (1)
  239. #define SPECTRAL_REPORT_LTS_HDR_LENGTH_POS_GEN3 (0)
  240. #define SPECTRAL_REPORT_LTS_HDR_LENGTH_SIZE_GEN3 (16)
  241. #define SPECTRAL_REPORT_LTS_TAG_POS_GEN3 (16)
  242. #define SPECTRAL_REPORT_LTS_TAG_SIZE_GEN3 (8)
  243. #define SPECTRAL_REPORT_LTS_SIGNATURE_POS_GEN3 (24)
  244. #define SPECTRAL_REPORT_LTS_SIGNATURE_SIZE_GEN3 (8)
  245. #define SPECTRAL_PHYERR_SIGNATURE_GEN3 (0xFA)
  246. #define TLV_TAG_SPECTRAL_SUMMARY_REPORT_GEN3 (0x02)
  247. #define TLV_TAG_SEARCH_FFT_REPORT_GEN3 (0x03)
  248. #define SPECTRAL_PHYERR_TLVSIZE_GEN3 (4)
  249. #define NUM_SPECTRAL_DETECTORS_GEN3_V1 (3)
  250. #define NUM_SPECTRAL_DETECTORS_GEN3_V2 (2)
  251. #define FFT_REPORT_HEADER_LENGTH_GEN3_V2 (24)
  252. #define FFT_REPORT_HEADER_LENGTH_GEN3_V1 (16)
  253. #define NUM_PADDING_BYTES_SSCAN_SUMARY_REPORT_GEN3_V1 (0)
  254. #define NUM_PADDING_BYTES_SSCAN_SUMARY_REPORT_GEN3_V2 (16)
  255. #define SPECTRAL_PHYERR_HDR_LTS_POS \
  256. (offsetof(struct spectral_phyerr_fft_report_gen3, fft_hdr_lts))
  257. #define SPECTRAL_FFT_BINS_POS \
  258. (offsetof(struct spectral_phyerr_fft_report_gen3, buf))
  259. /**
  260. * struct phyerr_info - spectral search fft report for gen3
  261. * @data: handle to phyerror buffer
  262. * @datalen: length of phyerror bufer
  263. * @p_rfqual: rf quality matrices
  264. * @p_chaninfo: pointer to chaninfo
  265. * @tsf64: 64 bit TSF
  266. * @acs_stats: acs stats
  267. */
  268. struct phyerr_info {
  269. uint8_t *data;
  270. uint32_t datalen;
  271. struct target_if_spectral_rfqual_info *p_rfqual;
  272. struct target_if_spectral_chan_info *p_chaninfo;
  273. uint64_t tsf64;
  274. struct target_if_spectral_acs_stats *acs_stats;
  275. };
  276. /**
  277. * struct spectral_search_fft_info_gen3 - spectral search fft report for gen3
  278. * @timestamp: Timestamp at which fft report was generated
  279. * @fft_detector_id: Which radio generated this report
  280. * @fft_num: The FFT count number. Set to 0 for short FFT.
  281. * @fft_radar_check: NA for spectral
  282. * @fft_peak_sidx: Index of bin with maximum power
  283. * @fft_chn_idx: Rx chain index
  284. * @fft_base_pwr_db: Base power in dB
  285. * @fft_total_gain_db: Total gain in dB
  286. * @fft_num_str_bins_ib: Number of strong bins in the report
  287. * @fft_peak_mag: Peak magnitude
  288. * @fft_avgpwr_db: Average power in dB
  289. * @fft_relpwr_db: Relative power in dB
  290. */
  291. struct spectral_search_fft_info_gen3 {
  292. uint32_t timestamp;
  293. uint32_t fft_detector_id;
  294. uint32_t fft_num;
  295. uint32_t fft_radar_check;
  296. int32_t fft_peak_sidx;
  297. uint32_t fft_chn_idx;
  298. uint32_t fft_base_pwr_db;
  299. uint32_t fft_total_gain_db;
  300. uint32_t fft_num_str_bins_ib;
  301. int32_t fft_peak_mag;
  302. uint32_t fft_avgpwr_db;
  303. uint32_t fft_relpwr_db;
  304. };
  305. /**
  306. * struct spectral_phyerr_sfftreport_gen3 - fft info in phyerr event
  307. * @fft_timestamp: Timestamp at which fft report was generated
  308. * @fft_hdr_lts: length, tag, signature fields
  309. * @hdr_a: Header[0:31]
  310. * @hdr_b: Header[32:63]
  311. * @hdr_c: Header[64:95]
  312. * @resv: Header[96:127]
  313. * @buf: fft bins
  314. */
  315. struct spectral_phyerr_fft_report_gen3 {
  316. uint32_t fft_timestamp;
  317. uint32_t fft_hdr_lts;
  318. uint32_t hdr_a;
  319. uint32_t hdr_b;
  320. uint32_t hdr_c;
  321. uint32_t resv;
  322. uint8_t buf[0];
  323. } __ATTRIB_PACK;
  324. /**
  325. * struct sscan_report_fields_gen3 - Fields of spectral report
  326. * @sscan_agc_total_gain: The AGC total gain in DB.
  327. * @inband_pwr_db: The in-band power of the signal in 1/2 DB steps
  328. * @sscan_gainchange: This bit is set to 1 if a gainchange occurred during
  329. * the spectral scan FFT. Software may choose to
  330. * disregard the results.
  331. * @sscan_pri80: This is set to 1 to indicate that the Spectral scan was
  332. * performed on the pri80 segment. Software may choose to
  333. * disregard the FFT sample if this is set to 1 but detector ID
  334. * does not correspond to the ID for the pri80 segment.
  335. */
  336. struct sscan_report_fields_gen3 {
  337. uint8_t sscan_agc_total_gain;
  338. int16_t inband_pwr_db;
  339. uint8_t sscan_gainchange;
  340. uint8_t sscan_pri80;
  341. };
  342. /**
  343. * struct spectral_sscan_summary_report_gen3 - Spectral summary report
  344. * event
  345. * @sscan_timestamp: Timestamp at which fft report was generated
  346. * @sscan_hdr_lts: length, tag, signature fields
  347. * @hdr_a: Header[0:31]
  348. * @resv: Header[32:63]
  349. * @hdr_b: Header[64:95]
  350. * @hdr_c: Header[96:127]
  351. */
  352. struct spectral_sscan_summary_report_gen3 {
  353. u_int32_t sscan_timestamp;
  354. u_int32_t sscan_hdr_lts;
  355. u_int32_t hdr_a;
  356. u_int32_t res1;
  357. u_int32_t hdr_b;
  358. u_int32_t hdr_c;
  359. } __ATTRIB_PACK;
  360. #ifdef DIRECT_BUF_RX_ENABLE
  361. /**
  362. * struct Spectral_report - spectral report
  363. * @data: Report buffer
  364. * @noisefloor: Noise floor values
  365. * @reset_delay: Time taken for warm reset in us
  366. * @cfreq1: center frequency 1
  367. * @cfreq2: center frequency 2
  368. * @ch_width: channel width
  369. */
  370. struct spectral_report {
  371. uint8_t *data;
  372. int32_t noisefloor[DBR_MAX_CHAINS];
  373. uint32_t reset_delay;
  374. uint32_t cfreq1;
  375. uint32_t cfreq2;
  376. uint32_t ch_width;
  377. };
  378. #endif
  379. /* END of spectral GEN III HW specific details */
  380. typedef signed char pwr_dbm;
  381. /**
  382. * enum spectral_gen - spectral hw generation
  383. * @SPECTRAL_GEN1 : spectral hw gen 1
  384. * @SPECTRAL_GEN2 : spectral hw gen 2
  385. * @SPECTRAL_GEN3 : spectral hw gen 3
  386. */
  387. enum spectral_gen {
  388. SPECTRAL_GEN1,
  389. SPECTRAL_GEN2,
  390. SPECTRAL_GEN3,
  391. };
  392. /**
  393. * enum spectral_fftbin_size_war - spectral fft bin size war
  394. * @SPECTRAL_FFTBIN_SIZE_NO_WAR : No WAR applicable for Spectral FFT bin size
  395. * @SPECTRAL_FFTBIN_SIZE_2BYTE_TO_1BYTE : Spectral FFT bin size: Retain only
  396. * least significant byte from 2 byte
  397. * FFT bin transferred by HW
  398. * @SPECTRAL_FFTBIN_SIZE_4BYTE_TO_1BYTE : Spectral FFT bin size: Retain only
  399. * least significant byte from 4 byte
  400. * FFT bin transferred by HW
  401. */
  402. enum spectral_fftbin_size_war {
  403. SPECTRAL_FFTBIN_SIZE_NO_WAR = 0,
  404. SPECTRAL_FFTBIN_SIZE_WAR_2BYTE_TO_1BYTE = 1,
  405. SPECTRAL_FFTBIN_SIZE_WAR_4BYTE_TO_1BYTE = 2,
  406. };
  407. /**
  408. * enum spectral_report_format_version - This represents the report format
  409. * version number within each Spectral generation.
  410. * @SPECTRAL_REPORT_FORMAT_VERSION_1 : version 1
  411. * @SPECTRAL_REPORT_FORMAT_VERSION_2 : version 2
  412. */
  413. enum spectral_report_format_version {
  414. SPECTRAL_REPORT_FORMAT_VERSION_1,
  415. SPECTRAL_REPORT_FORMAT_VERSION_2,
  416. };
  417. /**
  418. * struct spectral_fft_bin_len_adj_swar - Encapsulate information required for
  419. * Spectral FFT bin length adjusting software WARS.
  420. * @inband_fftbin_size_adj: Whether to carry out FFT bin size adjustment for
  421. * in-band report format. This would be required on some chipsets under the
  422. * following circumstances: In report mode 2 only the in-band bins are DMA'ed.
  423. * Scatter/gather is used. However, the HW generates all bins, not just in-band,
  424. * and reports the number of bins accordingly. The subsystem arranging for the
  425. * DMA cannot change this value. On such chipsets the adjustment required at the
  426. * host driver is to check if report format is 2, and if so halve the number of
  427. * bins reported to get the number actually DMA'ed.
  428. * @null_fftbin_adj: Whether to remove NULL FFT bins for report mode (1) in
  429. * which only summary of metrics for each completed FFT + spectral scan summary
  430. * report are to be provided. This would be required on some chipsets under the
  431. * following circumstances: In report mode 1, HW reports a length corresponding
  432. * to all bins, and provides bins with value 0. This is because the subsystem
  433. * arranging for the FFT information does not arrange for DMA of FFT bin values
  434. * (as expected), but cannot arrange for a smaller length to be reported by HW.
  435. * In these circumstances, the driver would have to disregard the NULL bins and
  436. * report a bin count of 0 to higher layers.
  437. * @packmode_fftbin_size_adj: Pack mode in HW refers to packing of each Spectral
  438. * FFT bin into 2 bytes. But due to a bug HW reports 2 times the expected length
  439. * when packmode is enabled. This SWAR compensates this bug by dividing the
  440. * length with 2.
  441. * @fftbin_size_war: Type of FFT bin size SWAR
  442. */
  443. struct spectral_fft_bin_len_adj_swar {
  444. u_int8_t inband_fftbin_size_adj;
  445. u_int8_t null_fftbin_adj;
  446. uint8_t packmode_fftbin_size_adj;
  447. enum spectral_fftbin_size_war fftbin_size_war;
  448. };
  449. /**
  450. * struct spectral_report_params - Parameters related to format of Spectral
  451. * report.
  452. * @version: This represents the report format version number within each
  453. * Spectral generation.
  454. * @ssumaary_padding_bytes: Number of bytes of padding after Spectral summary
  455. * report
  456. * @fft_report_hdr_len: Number of bytes in the header of the FFT report. This
  457. * has to be subtracted from the length field of FFT report to find the length
  458. * of FFT bins.
  459. * @fragmentation_160: This indicates whether Spectral reports in 160/80p80 is
  460. * fragmented.
  461. * @max_agile_ch_width: Maximum agile BW supported by the target
  462. * @detid_mode_table: Detector ID to Spectral scan mode table
  463. * @num_spectral_detectors: Total number of Spectral detectors
  464. * @marker: Describes the boundaries of pri80, 5 MHz and sec80 bins
  465. */
  466. struct spectral_report_params {
  467. enum spectral_report_format_version version;
  468. uint8_t ssumaary_padding_bytes;
  469. uint8_t fft_report_hdr_len;
  470. bool fragmentation_160[SPECTRAL_SCAN_MODE_MAX];
  471. enum phy_ch_width max_agile_ch_width;
  472. enum spectral_scan_mode detid_mode_table[SPECTRAL_DETECTOR_ID_MAX];
  473. uint8_t num_spectral_detectors;
  474. struct spectral_fft_bin_markers_160_165mhz
  475. marker[SPECTRAL_SCAN_MODE_MAX];
  476. };
  477. /**
  478. * struct spectral_param_min_max - Spectral parameter minimum and maximum values
  479. * @fft_size_min: Minimum value of fft_size
  480. * @fft_size_max: Maximum value of fft_size for each BW
  481. */
  482. struct spectral_param_min_max {
  483. uint16_t fft_size_min;
  484. uint16_t fft_size_max[CH_WIDTH_MAX];
  485. };
  486. /**
  487. * struct spectral_timestamp_swar - Spectral time stamp WAR related parameters
  488. * @timestamp_war_offset: Offset to be added to correct timestamp
  489. * @target_reset_count: Number of times target exercised the reset routine
  490. * @last_fft_timestamp: last fft report timestamp
  491. */
  492. struct spectral_timestamp_war {
  493. uint32_t timestamp_war_offset[SPECTRAL_SCAN_MODE_MAX];
  494. uint64_t target_reset_count;
  495. uint32_t last_fft_timestamp[SPECTRAL_SCAN_MODE_MAX];
  496. };
  497. #if ATH_PERF_PWR_OFFLOAD
  498. /**
  499. * enum target_if_spectral_info - Enumerations for specifying which spectral
  500. * information (among parameters and states)
  501. * is desired.
  502. * @TARGET_IF_SPECTRAL_INFO_ACTIVE: Indicated whether spectral is active
  503. * @TARGET_IF_SPECTRAL_INFO_ENABLED: Indicated whether spectral is enabled
  504. * @TARGET_IF_SPECTRAL_INFO_PARAMS: Config params
  505. */
  506. enum target_if_spectral_info {
  507. TARGET_IF_SPECTRAL_INFO_ACTIVE,
  508. TARGET_IF_SPECTRAL_INFO_ENABLED,
  509. TARGET_IF_SPECTRAL_INFO_PARAMS,
  510. };
  511. #endif /* ATH_PERF_PWR_OFFLOAD */
  512. /* forward declaration */
  513. struct target_if_spectral;
  514. /**
  515. * struct target_if_spectral_chan_info - Channel information
  516. * @center_freq1: center frequency 1 in MHz
  517. * @center_freq2: center frequency 2 in MHz -valid only for
  518. * 11ACVHT 80PLUS80 mode
  519. * @chan_width: channel width in MHz
  520. */
  521. struct target_if_spectral_chan_info {
  522. uint16_t center_freq1;
  523. uint16_t center_freq2;
  524. uint8_t chan_width;
  525. };
  526. /**
  527. * struct target_if_spectral_acs_stats - EACS stats from spectral samples
  528. * @nfc_ctl_rssi: Control chan rssi
  529. * @nfc_ext_rssi: Extension chan rssi
  530. * @ctrl_nf: Control chan Noise Floor
  531. * @ext_nf: Extension chan Noise Floor
  532. */
  533. struct target_if_spectral_acs_stats {
  534. int8_t nfc_ctl_rssi;
  535. int8_t nfc_ext_rssi;
  536. int8_t ctrl_nf;
  537. int8_t ext_nf;
  538. };
  539. /**
  540. * struct target_if_spectral_perchain_rssi_info - per chain rssi info
  541. * @rssi_pri20: Rssi of primary 20 Mhz
  542. * @rssi_sec20: Rssi of secondary 20 Mhz
  543. * @rssi_sec40: Rssi of secondary 40 Mhz
  544. * @rssi_sec80: Rssi of secondary 80 Mhz
  545. */
  546. struct target_if_spectral_perchain_rssi_info {
  547. int8_t rssi_pri20;
  548. int8_t rssi_sec20;
  549. int8_t rssi_sec40;
  550. int8_t rssi_sec80;
  551. };
  552. /**
  553. * struct target_if_spectral_rfqual_info - RF measurement information
  554. * @rssi_comb: RSSI Information
  555. * @pc_rssi_info: XXX : For now, we know we are getting information
  556. * for only 4 chains at max. For future extensions
  557. * use a define
  558. * @noise_floor: Noise floor information
  559. */
  560. struct target_if_spectral_rfqual_info {
  561. int8_t rssi_comb;
  562. struct target_if_spectral_perchain_rssi_info pc_rssi_info[4];
  563. int16_t noise_floor[4];
  564. };
  565. #define GET_TARGET_IF_SPECTRAL_OPS(spectral) \
  566. ((struct target_if_spectral_ops *)(&((spectral)->spectral_ops)))
  567. /**
  568. * struct target_if_spectral_ops - spectral low level ops table
  569. * @get_tsf64: Get 64 bit TSF value
  570. * @get_capability: Get capability info
  571. * @set_rxfilter: Set rx filter
  572. * @get_rxfilter: Get rx filter
  573. * @is_spectral_active: Check whether icm is active
  574. * @is_spectral_enabled: Check whether spectral is enabled
  575. * @start_spectral_scan: Start spectral scan
  576. * @stop_spectral_scan: Stop spectral scan
  577. * @get_extension_channel: Get extension channel
  578. * @get_ctl_noisefloor: Get control noise floor
  579. * @get_ext_noisefloor: Get extension noise floor
  580. * @configure_spectral: Set spectral configurations
  581. * @get_spectral_config: Get spectral configurations
  582. * @get_ent_spectral_mask: Get spectral mask
  583. * @get_mac_address: Get mac address
  584. * @get_current_channel: Get current channel
  585. * @reset_hw: Reset HW
  586. * @get_chain_noise_floor: Get Channel noise floor
  587. * @spectral_process_phyerr: Process phyerr event
  588. * @process_spectral_report: Process spectral report
  589. * @byte_swap_headers: Apply byte-swap on report headers
  590. * @byte_swap_fft_bins: Apply byte-swap on FFT bins
  591. */
  592. struct target_if_spectral_ops {
  593. uint64_t (*get_tsf64)(void *arg);
  594. uint32_t (*get_capability)(
  595. void *arg, enum spectral_capability_type type);
  596. uint32_t (*set_rxfilter)(void *arg, int rxfilter);
  597. uint32_t (*get_rxfilter)(void *arg);
  598. uint32_t (*is_spectral_active)(void *arg,
  599. enum spectral_scan_mode smode);
  600. uint32_t (*is_spectral_enabled)(void *arg,
  601. enum spectral_scan_mode smode);
  602. uint32_t (*start_spectral_scan)(void *arg,
  603. enum spectral_scan_mode smode,
  604. enum spectral_cp_error_code *err);
  605. uint32_t (*stop_spectral_scan)(void *arg,
  606. enum spectral_scan_mode smode);
  607. uint32_t (*get_extension_channel)(void *arg,
  608. enum spectral_scan_mode smode);
  609. int8_t (*get_ctl_noisefloor)(void *arg);
  610. int8_t (*get_ext_noisefloor)(void *arg);
  611. uint32_t (*configure_spectral)(
  612. void *arg,
  613. struct spectral_config *params,
  614. enum spectral_scan_mode smode);
  615. uint32_t (*get_spectral_config)(
  616. void *arg,
  617. struct spectral_config *params,
  618. enum spectral_scan_mode smode);
  619. uint32_t (*get_ent_spectral_mask)(void *arg);
  620. uint32_t (*get_mac_address)(void *arg, char *addr);
  621. uint32_t (*get_current_channel)(void *arg,
  622. enum spectral_scan_mode smode);
  623. uint32_t (*reset_hw)(void *arg);
  624. uint32_t (*get_chain_noise_floor)(void *arg, int16_t *nf_buf);
  625. int (*spectral_process_phyerr)(struct target_if_spectral *spectral,
  626. uint8_t *data, uint32_t datalen,
  627. struct target_if_spectral_rfqual_info *p_rfqual,
  628. struct target_if_spectral_chan_info *p_chaninfo,
  629. uint64_t tsf64,
  630. struct target_if_spectral_acs_stats *acs_stats);
  631. int (*process_spectral_report)(struct wlan_objmgr_pdev *pdev,
  632. void *payload);
  633. QDF_STATUS (*byte_swap_headers)(
  634. struct target_if_spectral *spectral,
  635. void *data);
  636. QDF_STATUS (*byte_swap_fft_bins)(
  637. struct spectral_fft_bin_len_adj_swar *swar,
  638. void *bin_pwr_data, size_t num_fftbins);
  639. };
  640. /**
  641. * struct target_if_spectral_stats - spectral stats info
  642. * @num_spectral_detects: Total num. of spectral detects
  643. * @total_phy_errors: Total number of phyerrors
  644. * @owl_phy_errors: Indicated phyerrors in old gen1 chipsets
  645. * @pri_phy_errors: Phyerrors in primary channel
  646. * @ext_phy_errors: Phyerrors in secondary channel
  647. * @dc_phy_errors: Phyerrors due to dc
  648. * @early_ext_phy_errors: Early secondary channel phyerrors
  649. * @bwinfo_errors: Bandwidth info errors
  650. * @datalen_discards: Invalid data length errors, seen in gen1 chipsets
  651. * @rssi_discards bw: Indicates reports dropped due to RSSI threshold
  652. * @last_reset_tstamp: Last reset time stamp
  653. */
  654. struct target_if_spectral_stats {
  655. uint32_t num_spectral_detects;
  656. uint32_t total_phy_errors;
  657. uint32_t owl_phy_errors;
  658. uint32_t pri_phy_errors;
  659. uint32_t ext_phy_errors;
  660. uint32_t dc_phy_errors;
  661. uint32_t early_ext_phy_errors;
  662. uint32_t bwinfo_errors;
  663. uint32_t datalen_discards;
  664. uint32_t rssi_discards;
  665. uint64_t last_reset_tstamp;
  666. };
  667. /**
  668. * struct target_if_spectral_event - spectral event structure
  669. * @se_ts: Original 15 bit recv timestamp
  670. * @se_full_ts: 64-bit full timestamp from interrupt time
  671. * @se_rssi: Rssi of spectral event
  672. * @se_bwinfo: Rssi of spectral event
  673. * @se_dur: Duration of spectral pulse
  674. * @se_chanindex: Channel of event
  675. * @se_list: List of spectral events
  676. */
  677. struct target_if_spectral_event {
  678. uint32_t se_ts;
  679. uint64_t se_full_ts;
  680. uint8_t se_rssi;
  681. uint8_t se_bwinfo;
  682. uint8_t se_dur;
  683. uint8_t se_chanindex;
  684. STAILQ_ENTRY(spectral_event) se_list;
  685. };
  686. /**
  687. * struct target_if_chain_noise_pwr_info - Noise power info for each channel
  688. * @rptcount: Count of reports in pwr array
  689. * @un_cal_nf: Uncalibrated noise floor
  690. * @factory_cal_nf: Noise floor as calibrated at the factory for module
  691. * @median_pwr: Median power (median of pwr array)
  692. * @pwr: Power reports
  693. */
  694. struct target_if_chain_noise_pwr_info {
  695. int rptcount;
  696. pwr_dbm un_cal_nf;
  697. pwr_dbm factory_cal_nf;
  698. pwr_dbm median_pwr;
  699. pwr_dbm pwr[];
  700. } __ATTRIB_PACK;
  701. /**
  702. * struct target_if_spectral_chan_stats - Channel information
  703. * @cycle_count: Cycle count
  704. * @channel_load: Channel load
  705. * @per: Period
  706. * @noisefloor: Noise floor
  707. * @comp_usablity: Computed usability
  708. * @maxregpower: Maximum allowed regulatary power
  709. * @comp_usablity_sec80: Computed usability of secondary 80 Mhz
  710. * @maxregpower_sec80: Max regulatory power in secondary 80 Mhz
  711. */
  712. struct target_if_spectral_chan_stats {
  713. int cycle_count;
  714. int channel_load;
  715. int per;
  716. int noisefloor;
  717. uint16_t comp_usablity;
  718. int8_t maxregpower;
  719. uint16_t comp_usablity_sec80;
  720. int8_t maxregpower_sec80;
  721. };
  722. #if ATH_PERF_PWR_OFFLOAD
  723. /**
  724. * struct target_if_spectral_cache - Cache used to minimize WMI operations
  725. * in offload architecture
  726. * @osc_spectral_enabled: Whether Spectral is enabled
  727. * @osc_spectral_active: Whether spectral is active
  728. * XXX: Ideally, we should NOT cache this
  729. * since the hardware can self clear the bit,
  730. * the firmware can possibly stop spectral due to
  731. * intermittent off-channel activity, etc
  732. * A WMI read command should be introduced to handle
  733. * this This will be discussed.
  734. * @osc_params: Spectral parameters
  735. * @osc_is_valid: Whether the cache is valid
  736. */
  737. struct target_if_spectral_cache {
  738. uint8_t osc_spectral_enabled;
  739. uint8_t osc_spectral_active;
  740. struct spectral_config osc_params;
  741. uint8_t osc_is_valid;
  742. };
  743. /**
  744. * struct target_if_spectral_param_state_info - Structure used to represent and
  745. * manage spectral information
  746. * (parameters and states)
  747. * @osps_lock: Lock to synchronize accesses to information
  748. * @osps_cache: Cacheable' information
  749. */
  750. struct target_if_spectral_param_state_info {
  751. qdf_spinlock_t osps_lock;
  752. struct target_if_spectral_cache osps_cache;
  753. /* XXX - Non-cacheable information goes here, in the future */
  754. };
  755. #endif /* ATH_PERF_PWR_OFFLOAD */
  756. struct vdev_spectral_configure_params;
  757. struct vdev_spectral_enable_params;
  758. /**
  759. * struct spectral_wmi_ops - structure used holding the operations
  760. * related to Spectral WMI
  761. * @wmi_spectral_configure_cmd_send: Configure Spectral parameters
  762. * @wmi_spectral_enable_cmd_send: Enable/Disable Spectral
  763. * @wmi_spectral_crash_inject: Inject FW crash
  764. * @wmi_extract_pdev_sscan_fw_cmd_fixed_param: Extract Fixed params from
  765. * start scan response event
  766. * @wmi_extract_pdev_sscan_fft_bin_index: Extract TLV which describes FFT
  767. * bin indices from start scan response event
  768. * @wmi_unified_register_event_handler: Register WMI event handler
  769. * @wmi_unified_unregister_event_handler: Unregister WMI event handler
  770. * @wmi_service_enabled: API to check whether a given WMI service is enabled
  771. */
  772. struct spectral_wmi_ops {
  773. QDF_STATUS (*wmi_spectral_configure_cmd_send)(
  774. wmi_unified_t wmi_hdl,
  775. struct vdev_spectral_configure_params *param);
  776. QDF_STATUS (*wmi_spectral_enable_cmd_send)(
  777. wmi_unified_t wmi_hdl,
  778. struct vdev_spectral_enable_params *param);
  779. QDF_STATUS (*wmi_spectral_crash_inject)(
  780. wmi_unified_t wmi_handle, struct crash_inject *param);
  781. QDF_STATUS (*wmi_extract_pdev_sscan_fw_cmd_fixed_param)(
  782. wmi_unified_t wmi_handle, uint8_t *evt_buf,
  783. struct spectral_startscan_resp_params *param);
  784. QDF_STATUS (*wmi_extract_pdev_sscan_fft_bin_index)(
  785. wmi_unified_t wmi_handle, uint8_t *evt_buf,
  786. struct spectral_fft_bin_markers_160_165mhz *param);
  787. QDF_STATUS (*wmi_unified_register_event_handler)(
  788. wmi_unified_t wmi_handle,
  789. wmi_conv_event_id event_id,
  790. wmi_unified_event_handler handler_func,
  791. uint8_t rx_ctx);
  792. QDF_STATUS (*wmi_unified_unregister_event_handler)(
  793. wmi_unified_t wmi_handle,
  794. wmi_conv_event_id event_id);
  795. bool (*wmi_service_enabled)(wmi_unified_t wmi_handle,
  796. uint32_t service_id);
  797. };
  798. /**
  799. * struct spectral_tgt_ops - structure used holding the operations
  800. * related to target operations
  801. * @tgt_get_psoc_from_scn_hdl: Function to get psoc from scn
  802. */
  803. struct spectral_tgt_ops {
  804. struct wlan_objmgr_psoc *(*tgt_get_psoc_from_scn_hdl)(void *scn_handle);
  805. };
  806. /**
  807. * struct spectral_param_properties - structure holding Spectral
  808. * parameter properties
  809. * @supported: Parameter is supported or not
  810. * @common_all_modes: Parameter should be common for all modes or not
  811. */
  812. struct spectral_param_properties {
  813. bool supported;
  814. bool common_all_modes;
  815. };
  816. /**
  817. * struct target_if_finite_spectral_scan_params - Parameters related to finite
  818. * Spectral scan
  819. * @finite_spectral_scan: Indicates the Spectrl scan is finite/infinite
  820. * @num_reports_expected: Number of Spectral reports expected from target for a
  821. * finite Spectral scan
  822. */
  823. struct target_if_finite_spectral_scan_params {
  824. bool finite_spectral_scan;
  825. uint32_t num_reports_expected;
  826. };
  827. /**
  828. * struct target_if_spectral - main spectral structure
  829. * @pdev: Pointer to pdev
  830. * @spectral_ops: Target if internal Spectral low level operations table
  831. * @capability: Spectral capabilities structure
  832. * @properties: Spectral parameter properties per mode
  833. * @spectral_lock: Lock used for internal Spectral operations
  834. * @vdev_id: VDEV id for all spectral modes
  835. * @spectral_curchan_radindex: Current channel spectral index
  836. * @spectral_extchan_radindex: Extension channel spectral index
  837. * @spectraldomain: Current Spectral domain
  838. * @spectral_proc_phyerr: Flags to process for PHY errors
  839. * @spectral_defaultparams: Default PHY params per Spectral stat
  840. * @spectral_stats: Spectral related stats
  841. * @events: Events structure
  842. * @sc_spectral_ext_chan_ok: Can spectral be detected on the extension channel?
  843. * @sc_spectral_combined_rssi_ok: Can use combined spectral RSSI?
  844. * @sc_spectral_20_40_mode: Is AP in 20-40 mode?
  845. * @sc_spectral_noise_pwr_cal: Noise power cal required?
  846. * @sc_spectral_non_edma: Is the spectral capable device Non-EDMA?
  847. * @upper_is_control: Upper segment is primary
  848. * @upper_is_extension: Upper segment is secondary
  849. * @lower_is_control: Lower segment is primary
  850. * @lower_is_extension: Lower segment is secondary
  851. * @sc_spectraltest_ieeechan: IEEE channel number to return to after a spectral
  852. * mute test
  853. * @spectral_numbins: Number of bins
  854. * @spectral_fft_len: FFT length
  855. * @spectral_data_len: Total phyerror report length
  856. * @lb_edge_extrabins: Number of extra bins on left band edge
  857. * @rb_edge_extrabins: Number of extra bins on right band edge
  858. * @spectral_max_index_offset: Max FFT index offset (20 MHz mode)
  859. * @spectral_upper_max_index_offset: Upper max FFT index offset (20/40 MHz mode)
  860. * @spectral_lower_max_index_offset: Lower max FFT index offset (20/40 MHz mode)
  861. * @spectral_dc_index: At which index DC is present
  862. * @send_single_packet: Deprecated
  863. * @spectral_sent_msg: Indicates whether we send report to upper layers
  864. * @params: Spectral parameters
  865. * @last_capture_time: Indicates timestamp of previouse report
  866. * @num_spectral_data: Number of Spectral samples received in current session
  867. * @total_spectral_data: Total number of Spectral samples received
  868. * @max_rssi: Maximum RSSI
  869. * @detects_control_channel: NA
  870. * @detects_extension_channel: NA
  871. * @detects_below_dc: NA
  872. * @detects_above_dc: NA
  873. * @sc_scanning: Indicates active wifi scan
  874. * @sc_spectral_scan: Indicates active specral scan
  875. * @sc_spectral_full_scan: Deprecated
  876. * @scan_start_tstamp: Deprecated
  877. * @last_tstamp: Deprecated
  878. * @first_tstamp: Deprecated
  879. * @spectral_samp_count: Deprecated
  880. * @sc_spectral_samp_count: Deprecated
  881. * @noise_pwr_reports_reqd: Number of noise power reports required
  882. * @noise_pwr_reports_recv: Number of noise power reports received
  883. * @noise_pwr_reports_lock: Lock used for Noise power report processing
  884. * @noise_pwr_chain_ctl: Noise power report - control channel
  885. * @noise_pwr_chain_ext: Noise power report - extension channel
  886. * @chaninfo: Channel statistics
  887. * @tsf64: Latest TSF Value
  888. * @param_info: Offload architecture Spectral parameter cache information
  889. * @ch_width: Indicates Channel Width 20/40/80/160 MHz for each Spectral mode
  890. * @diag_stats: Diagnostic statistics
  891. * @is_160_format: Indicates whether information provided by HW is in altered
  892. * format for 802.11ac 160/80+80 MHz support (QCA9984 onwards)
  893. * @is_lb_edge_extrabins_format: Indicates whether information provided by
  894. * HW has 4 extra bins, at left band edge, for report mode 2
  895. * @is_rb_edge_extrabins_format: Indicates whether information provided
  896. * by HW has 4 extra bins, at right band edge, for report mode 2
  897. * @is_sec80_rssi_war_required: Indicates whether the software workaround is
  898. * required to obtain approximate combined RSSI for secondary 80Mhz segment
  899. * @simctx: Spectral Simulation context
  900. * @spectral_gen: Spectral hardware generation
  901. * @hdr_sig_exp: Expected signature in PHYERR TLV header, for the given hardware
  902. * generation
  903. * @tag_sscan_summary_exp: Expected Spectral Scan Summary tag in PHYERR TLV
  904. * header, for the given hardware generation
  905. * @tag_sscan_fft_exp: Expected Spectral Scan FFT report tag in PHYERR TLV
  906. * header, for the given hardware generation
  907. * @tlvhdr_size: Expected PHYERR TLV header size, for the given hardware
  908. * generation
  909. * @nl_cb: Netlink callbacks
  910. * @use_nl_bcast: Whether to use Netlink broadcast/unicast
  911. * @send_phy_data: Send data to the application layer for a particular msg type
  912. * @len_adj_swar: Spectral fft bin length adjustment SWAR related info
  913. * @timestamp_war: Spectral time stamp WAR related info
  914. * @dbr_ring_debug: Whether Spectral DBR ring debug is enabled
  915. * @dbr_buff_debug: Whether Spectral DBR buffer debug is enabled
  916. * @direct_dma_support: Whether Direct-DMA is supported on the current radio
  917. * @prev_tstamp: Timestamp of the previously received sample, which has to be
  918. * compared with the current tstamp to check descrepancy
  919. * @rparams: Parameters related to Spectral report structure
  920. * @param_min_max: Spectral parameter's minimum and maximum values
  921. * @finite_scan: Parameters for finite Spectral scan
  922. */
  923. struct target_if_spectral {
  924. struct wlan_objmgr_pdev *pdev_obj;
  925. struct target_if_spectral_ops spectral_ops;
  926. struct spectral_caps capability;
  927. struct spectral_param_properties
  928. properties[SPECTRAL_SCAN_MODE_MAX][SPECTRAL_PARAM_MAX];
  929. qdf_spinlock_t spectral_lock;
  930. uint8_t vdev_id[SPECTRAL_SCAN_MODE_MAX];
  931. int16_t spectral_curchan_radindex;
  932. int16_t spectral_extchan_radindex;
  933. uint32_t spectraldomain;
  934. uint32_t spectral_proc_phyerr;
  935. struct spectral_config spectral_defaultparams;
  936. struct target_if_spectral_stats spectral_stats;
  937. struct target_if_spectral_event *events;
  938. unsigned int sc_spectral_ext_chan_ok:1,
  939. sc_spectral_combined_rssi_ok:1,
  940. sc_spectral_20_40_mode:1,
  941. sc_spectral_noise_pwr_cal:1,
  942. sc_spectral_non_edma:1;
  943. int upper_is_control;
  944. int upper_is_extension;
  945. int lower_is_control;
  946. int lower_is_extension;
  947. uint8_t sc_spectraltest_ieeechan;
  948. int spectral_numbins;
  949. int spectral_fft_len;
  950. int spectral_data_len;
  951. /*
  952. * For 11ac chipsets prior to AR900B version 2.0, a max of 512 bins are
  953. * delivered. However, there can be additional bins reported for
  954. * AR900B version 2.0 and QCA9984 as described next:
  955. *
  956. * AR900B version 2.0: An additional tone is processed on the right
  957. * hand side in order to facilitate detection of radar pulses out to
  958. * the extreme band-edge of the channel frequency. Since the HW design
  959. * processes four tones at a time, this requires one additional Dword
  960. * to be added to the search FFT report.
  961. *
  962. * QCA9984: When spectral_scan_rpt_mode = 2, i.e 2-dword summary +
  963. * 1x-oversampled bins (in-band) per FFT, then 8 more bins
  964. * (4 more on left side and 4 more on right side)are added.
  965. */
  966. int lb_edge_extrabins;
  967. int rb_edge_extrabins;
  968. int spectral_max_index_offset;
  969. int spectral_upper_max_index_offset;
  970. int spectral_lower_max_index_offset;
  971. int spectral_dc_index;
  972. int send_single_packet;
  973. int spectral_sent_msg;
  974. int classify_scan;
  975. qdf_timer_t classify_timer;
  976. struct spectral_config params[SPECTRAL_SCAN_MODE_MAX];
  977. bool params_valid[SPECTRAL_SCAN_MODE_MAX];
  978. struct spectral_classifier_params classifier_params;
  979. int last_capture_time;
  980. int num_spectral_data;
  981. int total_spectral_data;
  982. int max_rssi;
  983. int detects_control_channel;
  984. int detects_extension_channel;
  985. int detects_below_dc;
  986. int detects_above_dc;
  987. int sc_scanning;
  988. int sc_spectral_scan;
  989. int sc_spectral_full_scan;
  990. uint64_t scan_start_tstamp;
  991. uint32_t last_tstamp;
  992. uint32_t first_tstamp;
  993. uint32_t spectral_samp_count;
  994. uint32_t sc_spectral_samp_count;
  995. int noise_pwr_reports_reqd;
  996. int noise_pwr_reports_recv;
  997. qdf_spinlock_t noise_pwr_reports_lock;
  998. struct target_if_chain_noise_pwr_info
  999. *noise_pwr_chain_ctl[HOST_MAX_ANTENNA];
  1000. struct target_if_chain_noise_pwr_info
  1001. *noise_pwr_chain_ext[HOST_MAX_ANTENNA];
  1002. uint64_t tsf64;
  1003. #if ATH_PERF_PWR_OFFLOAD
  1004. struct target_if_spectral_param_state_info
  1005. param_info[SPECTRAL_SCAN_MODE_MAX];
  1006. #endif
  1007. enum phy_ch_width ch_width[SPECTRAL_SCAN_MODE_MAX];
  1008. struct spectral_diag_stats diag_stats;
  1009. bool is_160_format;
  1010. bool is_lb_edge_extrabins_format;
  1011. bool is_rb_edge_extrabins_format;
  1012. bool is_sec80_rssi_war_required;
  1013. #ifdef QCA_SUPPORT_SPECTRAL_SIMULATION
  1014. void *simctx;
  1015. #endif
  1016. enum spectral_gen spectral_gen;
  1017. uint8_t hdr_sig_exp;
  1018. uint8_t tag_sscan_summary_exp;
  1019. uint8_t tag_sscan_fft_exp;
  1020. uint8_t tlvhdr_size;
  1021. struct spectral_nl_cb nl_cb;
  1022. bool use_nl_bcast;
  1023. int (*send_phy_data)(struct wlan_objmgr_pdev *pdev,
  1024. enum spectral_msg_type smsg_type);
  1025. struct spectral_fft_bin_len_adj_swar len_adj_swar;
  1026. struct spectral_timestamp_war timestamp_war;
  1027. enum spectral_160mhz_report_delivery_state
  1028. state_160mhz_delivery[SPECTRAL_SCAN_MODE_MAX];
  1029. bool dbr_ring_debug;
  1030. bool dbr_buff_debug;
  1031. bool direct_dma_support;
  1032. uint32_t prev_tstamp;
  1033. struct spectral_report_params rparams;
  1034. struct spectral_param_min_max param_min_max;
  1035. struct target_if_finite_spectral_scan_params
  1036. finite_scan[SPECTRAL_SCAN_MODE_MAX];
  1037. };
  1038. /**
  1039. * struct target_if_psoc_spectral - Target if psoc Spectral object
  1040. * @psoc_obj: psoc object
  1041. * @wmi_ops: Spectral WMI operations
  1042. */
  1043. struct target_if_psoc_spectral {
  1044. struct wlan_objmgr_psoc *psoc_obj;
  1045. struct spectral_wmi_ops wmi_ops;
  1046. };
  1047. /**
  1048. * struct target_if_samp_msg_params - Spectral Analysis Messaging Protocol
  1049. * data format
  1050. * @rssi: RSSI (except for secondary 80 segment)
  1051. * @rssi_sec80: RSSI for secondary 80 segment
  1052. * @lower_rssi: RSSI of lower band
  1053. * @upper_rssi: RSSI of upper band
  1054. * @chain_ctl_rssi: RSSI for control channel, for all antennas
  1055. * @chain_ext_rssi: RSSI for extension channel, for all antennas
  1056. * @bwinfo: bandwidth info
  1057. * @data_len: length of FFT data (except for secondary 80 segment)
  1058. * @data_len_sec80: length of FFT data for secondary 80 segment
  1059. * @tstamp: timestamp
  1060. * @last_tstamp: last time stamp
  1061. * @max_mag: maximum magnitude (except for secondary 80 segment)
  1062. * @max_mag_sec80: maximum magnitude for secondary 80 segment
  1063. * @max_index: index of max magnitude (except for secondary 80 segment)
  1064. * @max_index_sec80: index of max magnitude for secondary 80 segment
  1065. * @max_exp: max exp
  1066. * @peak: peak frequency (obsolete)
  1067. * @pwr_count: number of FFT bins (except for secondary 80 segment)
  1068. * @pwr_count_5mhz: number of FFT bins in extra 5 MHz in
  1069. * 165 MHz/restricted 80p80 mode
  1070. * @pwr_count_sec80: number of FFT bins in secondary 80 segment
  1071. * @nb_lower: This is deprecated
  1072. * @nb_upper: This is deprecated
  1073. * @max_upper_index: index of max mag in upper band
  1074. * @max_lower_index: index of max mag in lower band
  1075. * @bin_pwr_data: Contains FFT magnitudes (except for secondary 80 segment)
  1076. * @bin_pwr_data_5mhz: Contains FFT magnitudes for the extra 5 MHz
  1077. * in 165 MHz/restricted 80p80 mode
  1078. * @bin_pwr_data_sec80: Contains FFT magnitudes for the secondary 80 segment
  1079. * @freq: Center frequency of primary 20MHz channel in MHz
  1080. * @vhtop_ch_freq_seg1: VHT operation first segment center frequency in MHz
  1081. * @vhtop_ch_freq_seg2: VHT operation second segment center frequency in MHz
  1082. * @agile_freq1: Center frequency in MHz of the entire span(for 80+80 MHz
  1083. * agile Scan it is primary 80 MHz span) across which
  1084. * Agile Spectral is carried out. Applicable only for Agile
  1085. * Spectral samples.
  1086. * @agile_freq2: Center frequency in MHz of the secondary 80 MHz span
  1087. * across which Agile Spectral is carried out. Applicable
  1088. * only for Agile Spectral samples in 80+80 MHz mode.
  1089. * @freq_loading: spectral control duty cycles
  1090. * @noise_floor: current noise floor (except for secondary 80 segment)
  1091. * @noise_floor_sec80: current noise floor for secondary 80 segment
  1092. * @interf_list: List of interfernce sources
  1093. * @classifier_params: classifier parameters
  1094. * @sc: classifier parameters
  1095. * @pri80ind: Indication from hardware that the sample was received on the
  1096. * primary 80 MHz segment. If this is set when smode =
  1097. * SPECTRAL_SCAN_MODE_AGILE, it indicates that Spectral was carried out on
  1098. * pri80 instead of the Agile frequency due to a channel switch - Software may
  1099. * choose to ignore the sample in this case.
  1100. * @pri80ind_sec80: Indication from hardware that the sample was received on the
  1101. * primary 80 MHz segment instead of the secondary 80 MHz segment due to a
  1102. * channel switch - Software may choose to ignore the sample if this is set.
  1103. * Applicable only if smode = SPECTRAL_SCAN_MODE_NORMAL and for 160/80+80 MHz
  1104. * Spectral operation and if the chipset supports fragmented 160/80+80 MHz
  1105. * operation.
  1106. * @last_raw_timestamp: Previous FFT report's raw timestamp. In case of 160MHz
  1107. * it will be primary 80 segment's timestamp as both primary & secondary
  1108. * segment's timestamps are expected to be almost equal
  1109. * @timestamp_war_offset: Offset calculated based on reset_delay and
  1110. * last_raw_stamp. It will be added to raw_timestamp to get tstamp.
  1111. * @raw_timestamp: FFT timestamp reported by HW on primary segment.
  1112. * @raw_timestamp_sec80: FFT timestamp reported by HW on secondary 80 segment.
  1113. * @reset_delay: Time gap between the last spectral report before reset and the
  1114. * end of reset.
  1115. * @target_reset_count: Indicates the the number of times the target went
  1116. * through reset routine after spectral was enabled.
  1117. */
  1118. struct target_if_samp_msg_params {
  1119. int8_t rssi;
  1120. int8_t rssi_sec80;
  1121. int8_t lower_rssi;
  1122. int8_t upper_rssi;
  1123. int8_t chain_ctl_rssi[HOST_MAX_ANTENNA];
  1124. int8_t chain_ext_rssi[HOST_MAX_ANTENNA];
  1125. uint16_t bwinfo;
  1126. uint16_t datalen;
  1127. uint16_t datalen_sec80;
  1128. uint32_t tstamp;
  1129. uint32_t last_tstamp;
  1130. uint16_t max_mag;
  1131. uint16_t max_mag_sec80;
  1132. uint16_t max_index;
  1133. uint16_t max_index_sec80;
  1134. uint8_t max_exp;
  1135. int peak;
  1136. int pwr_count;
  1137. int pwr_count_5mhz;
  1138. int pwr_count_sec80;
  1139. int8_t nb_lower;
  1140. int8_t nb_upper;
  1141. uint16_t max_lower_index;
  1142. uint16_t max_upper_index;
  1143. uint8_t *bin_pwr_data;
  1144. uint8_t *bin_pwr_data_5mhz;
  1145. uint8_t *bin_pwr_data_sec80;
  1146. uint16_t freq;
  1147. uint16_t vhtop_ch_freq_seg1;
  1148. uint16_t vhtop_ch_freq_seg2;
  1149. uint16_t agile_freq1;
  1150. uint16_t agile_freq2;
  1151. uint16_t freq_loading;
  1152. int16_t noise_floor;
  1153. int16_t noise_floor_sec80;
  1154. struct interf_src_rsp interf_list;
  1155. struct spectral_classifier_params classifier_params;
  1156. struct ath_softc *sc;
  1157. uint8_t agc_total_gain;
  1158. uint8_t agc_total_gain_sec80;
  1159. uint8_t gainchange;
  1160. uint8_t gainchange_sec80;
  1161. enum spectral_scan_mode smode;
  1162. uint8_t pri80ind;
  1163. uint8_t pri80ind_sec80;
  1164. uint32_t last_raw_timestamp;
  1165. uint32_t timestamp_war_offset;
  1166. uint32_t raw_timestamp;
  1167. uint32_t raw_timestamp_sec80;
  1168. uint32_t reset_delay;
  1169. uint32_t target_reset_count;
  1170. };
  1171. /**
  1172. * struct target_if_spectral_agile_mode_cap - Structure to hold agile
  1173. * Spetcral scan capability
  1174. * @agile_spectral_cap: agile Spectral scan capability for 20/40/80 MHz
  1175. * @agile_spectral_cap_160: agile Spectral scan capability for 160 MHz
  1176. * @agile_spectral_cap_80p80: agile Spectral scan capability for 80+80 MHz
  1177. */
  1178. struct target_if_spectral_agile_mode_cap {
  1179. bool agile_spectral_cap;
  1180. bool agile_spectral_cap_160;
  1181. bool agile_spectral_cap_80p80;
  1182. };
  1183. #ifdef WLAN_CONV_SPECTRAL_ENABLE
  1184. /**
  1185. * target_if_spectral_dump_fft() - Dump Spectral FFT
  1186. * @pfft: Pointer to Spectral Phyerr FFT
  1187. * @fftlen: FFT length
  1188. *
  1189. * Return: Success or failure
  1190. */
  1191. int target_if_spectral_dump_fft(uint8_t *pfft, int fftlen);
  1192. /**
  1193. * target_if_dbg_print_samp_param() - Print contents of SAMP struct
  1194. * @p: Pointer to SAMP message
  1195. *
  1196. * Return: Void
  1197. */
  1198. void target_if_dbg_print_samp_param(struct target_if_samp_msg_params *p);
  1199. /**
  1200. * target_if_get_offset_swar_sec80() - Get offset for SWAR according to
  1201. * the channel width
  1202. * @channel_width: Channel width
  1203. *
  1204. * Return: Offset for SWAR
  1205. */
  1206. uint32_t target_if_get_offset_swar_sec80(uint32_t channel_width);
  1207. /**
  1208. * target_if_sptrl_register_tx_ops() - Register Spectral target_if Tx Ops
  1209. * @tx_ops: Tx Ops
  1210. *
  1211. * Return: void
  1212. */
  1213. void target_if_sptrl_register_tx_ops(struct wlan_lmac_if_tx_ops *tx_ops);
  1214. /**
  1215. * target_if_spectral_create_samp_msg() - Create the spectral samp message
  1216. * @spectral : Pointer to spectral internal structure
  1217. * @params : spectral samp message parameters
  1218. *
  1219. * API to create the spectral samp message
  1220. *
  1221. * Return: void
  1222. */
  1223. void target_if_spectral_create_samp_msg(
  1224. struct target_if_spectral *spectral,
  1225. struct target_if_samp_msg_params *params);
  1226. /**
  1227. * target_if_spectral_process_phyerr_gen3() - Process phyerror event for gen3
  1228. * @pdev: Pointer to pdev object
  1229. * @payload: Pointer to spectral report
  1230. *
  1231. * Process phyerror event for gen3
  1232. *
  1233. * Return: Success/Failure
  1234. */
  1235. int target_if_spectral_process_report_gen3(
  1236. struct wlan_objmgr_pdev *pdev,
  1237. void *buf);
  1238. /**
  1239. * target_if_process_phyerr_gen2() - Process PHY Error for gen2
  1240. * @spectral: Pointer to Spectral object
  1241. * @data: Pointer to phyerror event buffer
  1242. * @datalen: Data length
  1243. * @p_rfqual: RF quality info
  1244. * @p_chaninfo: Channel info
  1245. * @tsf64: 64 bit tsf timestamp
  1246. * @acs_stats: ACS stats
  1247. *
  1248. * Process PHY Error for gen2
  1249. *
  1250. * Return: Success/Failure
  1251. */
  1252. int target_if_process_phyerr_gen2(
  1253. struct target_if_spectral *spectral,
  1254. uint8_t *data,
  1255. uint32_t datalen, struct target_if_spectral_rfqual_info *p_rfqual,
  1256. struct target_if_spectral_chan_info *p_chaninfo,
  1257. uint64_t tsf64,
  1258. struct target_if_spectral_acs_stats *acs_stats);
  1259. /**
  1260. * target_if_spectral_send_intf_found_msg() - Indicate to application layer that
  1261. * interference has been found
  1262. * @pdev: Pointer to pdev
  1263. * @cw_int: 1 if CW interference is found, 0 if WLAN interference is found
  1264. * @dcs_enabled: 1 if DCS is enabled, 0 if DCS is disabled
  1265. *
  1266. * Send message to application layer
  1267. * indicating that interference has been found
  1268. *
  1269. * Return: None
  1270. */
  1271. void target_if_spectral_send_intf_found_msg(
  1272. struct wlan_objmgr_pdev *pdev,
  1273. uint16_t cw_int, uint32_t dcs_enabled);
  1274. /**
  1275. * target_if_stop_spectral_scan() - Stop spectral scan
  1276. * @pdev: Pointer to pdev object
  1277. * @smode: Spectral scan mode
  1278. * @err: Pointer to error code
  1279. *
  1280. * API to stop the current on-going spectral scan
  1281. *
  1282. * Return: QDF_STATUS_SUCCESS in case of success, else QDF_STATUS_E_FAILURE
  1283. */
  1284. QDF_STATUS target_if_stop_spectral_scan(struct wlan_objmgr_pdev *pdev,
  1285. const enum spectral_scan_mode smode,
  1286. enum spectral_cp_error_code *err);
  1287. /**
  1288. * target_if_spectral_get_vdev() - Get pointer to vdev to be used for Spectral
  1289. * operations
  1290. * @spectral: Pointer to Spectral target_if internal private data
  1291. * @smode: spectral scan mode
  1292. *
  1293. * Spectral operates on pdev. However, in order to retrieve some WLAN
  1294. * properties, a vdev is required. To facilitate this, the function returns the
  1295. * first vdev in our pdev. The caller should release the reference to the vdev
  1296. * once it is done using it.
  1297. * TODO: If the framework later provides an API to obtain the first active
  1298. * vdev, then it would be preferable to use this API.
  1299. *
  1300. * Return: Pointer to vdev on success, NULL on failure
  1301. */
  1302. struct wlan_objmgr_vdev *target_if_spectral_get_vdev(
  1303. struct target_if_spectral *spectral,
  1304. enum spectral_scan_mode smode);
  1305. /**
  1306. * target_if_spectral_dump_hdr_gen2() - Dump Spectral header for gen2
  1307. * @phdr: Pointer to Spectral Phyerr Header
  1308. *
  1309. * Dump Spectral header
  1310. *
  1311. * Return: Success/Failure
  1312. */
  1313. int target_if_spectral_dump_hdr_gen2(struct spectral_phyerr_hdr_gen2 *phdr);
  1314. /**
  1315. * target_if_get_combrssi_sec80_seg_gen2() - Get approximate combined RSSI
  1316. * for Secondary 80 segment
  1317. * @spectral: Pointer to spectral object
  1318. * @p_sfft_sec80: Pointer to search fft info of secondary 80 segment
  1319. *
  1320. * Get approximate combined RSSI for Secondary 80 segment
  1321. *
  1322. * Return: Combined RSSI for secondary 80Mhz segment
  1323. */
  1324. int8_t target_if_get_combrssi_sec80_seg_gen2(
  1325. struct target_if_spectral *spectral,
  1326. struct spectral_search_fft_info_gen2 *p_sfft_sec80);
  1327. /**
  1328. * target_if_spectral_dump_tlv_gen2() - Dump Spectral TLV for gen2
  1329. * @ptlv: Pointer to Spectral Phyerr TLV
  1330. * @is_160_format: Indicates 160 format
  1331. *
  1332. * Dump Spectral TLV for gen2
  1333. *
  1334. * Return: Success/Failure
  1335. */
  1336. int target_if_spectral_dump_tlv_gen2(
  1337. struct spectral_phyerr_tlv_gen2 *ptlv, bool is_160_format);
  1338. /**
  1339. * target_if_spectral_dump_phyerr_data_gen2() - Dump Spectral
  1340. * related PHY Error for gen2
  1341. * @data: Pointer to phyerror buffer
  1342. * @datalen: Data length
  1343. * @is_160_format: Indicates 160 format
  1344. *
  1345. * Dump Spectral related PHY Error for gen2
  1346. *
  1347. * Return: Success/Failure
  1348. */
  1349. int target_if_spectral_dump_phyerr_data_gen2(
  1350. uint8_t *data,
  1351. uint32_t datalen,
  1352. bool is_160_format);
  1353. /**
  1354. * target_if_dbg_print_samp_msg() - Print contents of SAMP Message
  1355. * @p: Pointer to SAMP message
  1356. *
  1357. * Print contents of SAMP Message
  1358. *
  1359. * Return: Void
  1360. */
  1361. void target_if_dbg_print_samp_msg(struct spectral_samp_msg *pmsg);
  1362. /**
  1363. * get_target_if_spectral_handle_from_pdev() - Get handle to target_if internal
  1364. * Spectral data
  1365. * @pdev: Pointer to pdev
  1366. *
  1367. * Return: Handle to target_if internal Spectral data on success, NULL on
  1368. * failure
  1369. */
  1370. static inline
  1371. struct target_if_spectral *get_target_if_spectral_handle_from_pdev(
  1372. struct wlan_objmgr_pdev *pdev)
  1373. {
  1374. struct target_if_spectral *spectral;
  1375. struct wlan_objmgr_psoc *psoc;
  1376. struct wlan_lmac_if_rx_ops *rx_ops;
  1377. if (!pdev) {
  1378. spectral_err("pdev is null");
  1379. return NULL;
  1380. }
  1381. psoc = wlan_pdev_get_psoc(pdev);
  1382. if (!psoc) {
  1383. spectral_err("psoc is null");
  1384. return NULL;
  1385. }
  1386. rx_ops = wlan_psoc_get_lmac_if_rxops(psoc);
  1387. if (!rx_ops) {
  1388. spectral_err("rx_ops is null");
  1389. return NULL;
  1390. }
  1391. spectral = (struct target_if_spectral *)
  1392. rx_ops->sptrl_rx_ops.sptrlro_get_pdev_target_handle(pdev);
  1393. return spectral;
  1394. }
  1395. /**
  1396. * get_target_if_spectral_handle_from_psoc() - Get handle to psoc target_if
  1397. * internal Spectral data
  1398. * @psoc: Pointer to psoc
  1399. *
  1400. * Return: Handle to target_if psoc internal Spectral data on success, NULL on
  1401. * failure
  1402. */
  1403. static inline
  1404. struct target_if_psoc_spectral *get_target_if_spectral_handle_from_psoc(
  1405. struct wlan_objmgr_psoc *psoc)
  1406. {
  1407. struct wlan_lmac_if_rx_ops *rx_ops;
  1408. struct target_if_psoc_spectral *psoc_spectral;
  1409. if (!psoc) {
  1410. spectral_err("psoc is null");
  1411. return NULL;
  1412. }
  1413. rx_ops = wlan_psoc_get_lmac_if_rxops(psoc);
  1414. if (!rx_ops) {
  1415. spectral_err("rx_ops is null");
  1416. return NULL;
  1417. }
  1418. psoc_spectral = (struct target_if_psoc_spectral *)
  1419. rx_ops->sptrl_rx_ops.sptrlro_get_psoc_target_handle(psoc);
  1420. return psoc_spectral;
  1421. }
  1422. /**
  1423. * target_if_vdev_get_chan_freq() - Get the operating channel frequency of a
  1424. * given vdev
  1425. * @pdev: Pointer to vdev
  1426. *
  1427. * Get the operating channel frequency of a given vdev
  1428. *
  1429. * Return: Operating channel frequency of a vdev
  1430. */
  1431. static inline
  1432. int16_t target_if_vdev_get_chan_freq(struct wlan_objmgr_vdev *vdev)
  1433. {
  1434. struct wlan_objmgr_psoc *psoc = NULL;
  1435. struct wlan_lmac_if_rx_ops *rx_ops;
  1436. psoc = wlan_vdev_get_psoc(vdev);
  1437. if (!psoc) {
  1438. spectral_err("psoc is NULL");
  1439. return -EINVAL;
  1440. }
  1441. rx_ops = wlan_psoc_get_lmac_if_rxops(psoc);
  1442. if (!rx_ops) {
  1443. spectral_err("rx_ops is null");
  1444. return -EINVAL;
  1445. }
  1446. return rx_ops->sptrl_rx_ops.sptrlro_vdev_get_chan_freq(
  1447. vdev);
  1448. }
  1449. /**
  1450. * target_if_vdev_get_chan_freq_seg2() - Get center frequency of secondary 80 of
  1451. * given vdev
  1452. * @vdev: Pointer to vdev
  1453. *
  1454. * Get the center frequency of secondary 80 of given vdev
  1455. *
  1456. * Return: center frequency of secondary 80
  1457. */
  1458. static inline
  1459. int16_t target_if_vdev_get_chan_freq_seg2(struct wlan_objmgr_vdev *vdev)
  1460. {
  1461. struct wlan_objmgr_psoc *psoc = NULL;
  1462. struct wlan_lmac_if_rx_ops *rx_ops;
  1463. psoc = wlan_vdev_get_psoc(vdev);
  1464. if (!psoc) {
  1465. spectral_err("psoc is NULL");
  1466. return -EINVAL;
  1467. }
  1468. rx_ops = wlan_psoc_get_lmac_if_rxops(psoc);
  1469. if (!rx_ops) {
  1470. spectral_err("rx_ops is null");
  1471. return -EINVAL;
  1472. }
  1473. return rx_ops->sptrl_rx_ops.sptrlro_vdev_get_chan_freq_seg2(vdev);
  1474. }
  1475. /**
  1476. * target_if_vdev_get_ch_width() - Get the operating channel bandwidth of a
  1477. * given vdev
  1478. * @pdev: Pointer to vdev
  1479. *
  1480. * Get the operating channel bandwidth of a given vdev
  1481. *
  1482. * Return: channel bandwidth enumeration corresponding to the vdev
  1483. */
  1484. static inline
  1485. enum phy_ch_width target_if_vdev_get_ch_width(struct wlan_objmgr_vdev *vdev)
  1486. {
  1487. struct wlan_objmgr_psoc *psoc = NULL;
  1488. enum phy_ch_width ch_width;
  1489. struct wlan_lmac_if_rx_ops *rx_ops;
  1490. psoc = wlan_vdev_get_psoc(vdev);
  1491. if (!psoc) {
  1492. spectral_err("psoc is NULL");
  1493. return CH_WIDTH_INVALID;
  1494. }
  1495. rx_ops = wlan_psoc_get_lmac_if_rxops(psoc);
  1496. if (!rx_ops) {
  1497. spectral_err("rx_ops is null");
  1498. return CH_WIDTH_INVALID;
  1499. }
  1500. ch_width = rx_ops->sptrl_rx_ops.sptrlro_vdev_get_ch_width(vdev);
  1501. if (ch_width == CH_WIDTH_160MHZ) {
  1502. int16_t cfreq2;
  1503. cfreq2 = target_if_vdev_get_chan_freq_seg2(vdev);
  1504. if (cfreq2 < 0) {
  1505. spectral_err("Invalid value for cfreq2 %d", cfreq2);
  1506. return CH_WIDTH_INVALID;
  1507. }
  1508. /* Use non zero cfreq2 to identify 80p80 */
  1509. if (cfreq2)
  1510. ch_width = CH_WIDTH_80P80MHZ;
  1511. }
  1512. return ch_width;
  1513. }
  1514. /**
  1515. * target_if_vdev_get_sec20chan_freq_mhz() - Get the frequency of secondary
  1516. * 20 MHz channel for a given vdev
  1517. * @pdev: Pointer to vdev
  1518. *
  1519. * Get the frequency of secondary 20Mhz channel for a given vdev
  1520. *
  1521. * Return: Frequency of secondary 20Mhz channel for a given vdev
  1522. */
  1523. static inline
  1524. int target_if_vdev_get_sec20chan_freq_mhz(
  1525. struct wlan_objmgr_vdev *vdev,
  1526. uint16_t *sec20chan_freq)
  1527. {
  1528. struct wlan_objmgr_psoc *psoc = NULL;
  1529. struct wlan_lmac_if_rx_ops *rx_ops;
  1530. psoc = wlan_vdev_get_psoc(vdev);
  1531. if (!psoc) {
  1532. spectral_err("psoc is NULL");
  1533. return -EINVAL;
  1534. }
  1535. rx_ops = wlan_psoc_get_lmac_if_rxops(psoc);
  1536. if (!rx_ops) {
  1537. spectral_err("rx_ops is null");
  1538. return -EINVAL;
  1539. }
  1540. return rx_ops->sptrl_rx_ops.
  1541. sptrlro_vdev_get_sec20chan_freq_mhz(vdev, sec20chan_freq);
  1542. }
  1543. /**
  1544. * target_if_spectral_is_feature_disabled_psoc() - Check if Spectral feature is
  1545. * disabled for a given psoc
  1546. * @psoc: Pointer to psoc
  1547. *
  1548. * Return: true or false
  1549. */
  1550. static inline
  1551. bool target_if_spectral_is_feature_disabled_psoc(struct wlan_objmgr_psoc *psoc)
  1552. {
  1553. struct wlan_lmac_if_rx_ops *rx_ops;
  1554. if (!psoc) {
  1555. spectral_err("psoc is NULL");
  1556. return true;
  1557. }
  1558. rx_ops = wlan_psoc_get_lmac_if_rxops(psoc);
  1559. if (!rx_ops) {
  1560. spectral_err("rx_ops is null");
  1561. return true;
  1562. }
  1563. if (rx_ops->sptrl_rx_ops.
  1564. sptrlro_spectral_is_feature_disabled_psoc)
  1565. return rx_ops->sptrl_rx_ops.
  1566. sptrlro_spectral_is_feature_disabled_psoc(psoc);
  1567. return true;
  1568. }
  1569. /**
  1570. * target_if_spectral_is_feature_disabled_pdev() - Check if Spectral feature is
  1571. * disabled for a given pdev
  1572. * @pdev: Pointer to pdev
  1573. *
  1574. * Return: true or false
  1575. */
  1576. static inline
  1577. bool target_if_spectral_is_feature_disabled_pdev(struct wlan_objmgr_pdev *pdev)
  1578. {
  1579. struct wlan_lmac_if_rx_ops *rx_ops;
  1580. struct wlan_objmgr_psoc *psoc;
  1581. if (!pdev) {
  1582. spectral_err("pdev is NULL");
  1583. return true;
  1584. }
  1585. psoc = wlan_pdev_get_psoc(pdev);
  1586. if (!psoc) {
  1587. spectral_err("psoc is NULL");
  1588. return true;
  1589. }
  1590. rx_ops = wlan_psoc_get_lmac_if_rxops(psoc);
  1591. if (!rx_ops) {
  1592. spectral_err("rx_ops is null");
  1593. return true;
  1594. }
  1595. if (rx_ops->sptrl_rx_ops.
  1596. sptrlro_spectral_is_feature_disabled_pdev)
  1597. return rx_ops->sptrl_rx_ops.
  1598. sptrlro_spectral_is_feature_disabled_pdev(pdev);
  1599. return true;
  1600. }
  1601. /**
  1602. * target_if_spectral_set_rxchainmask() - Set Spectral Rx chainmask
  1603. * @pdev: Pointer to pdev
  1604. * @spectral_rx_chainmask: Spectral Rx chainmask
  1605. *
  1606. * Return: None
  1607. */
  1608. static inline
  1609. void target_if_spectral_set_rxchainmask(struct wlan_objmgr_pdev *pdev,
  1610. uint8_t spectral_rx_chainmask)
  1611. {
  1612. struct wlan_objmgr_psoc *psoc = NULL;
  1613. struct target_if_spectral *spectral = NULL;
  1614. enum spectral_scan_mode smode = SPECTRAL_SCAN_MODE_NORMAL;
  1615. struct wlan_lmac_if_rx_ops *rx_ops;
  1616. psoc = wlan_pdev_get_psoc(pdev);
  1617. if (!psoc) {
  1618. spectral_err("psoc is NULL");
  1619. return;
  1620. }
  1621. rx_ops = wlan_psoc_get_lmac_if_rxops(psoc);
  1622. if (!rx_ops) {
  1623. spectral_err("rx_ops is null");
  1624. return;
  1625. }
  1626. if (smode >= SPECTRAL_SCAN_MODE_MAX) {
  1627. spectral_err("Invalid Spectral mode %u", smode);
  1628. return;
  1629. }
  1630. if (rx_ops->sptrl_rx_ops.
  1631. sptrlro_spectral_is_feature_disabled_pdev(pdev)) {
  1632. spectral_info("Spectral feature is disabled");
  1633. return;
  1634. }
  1635. spectral = get_target_if_spectral_handle_from_pdev(pdev);
  1636. if (!spectral) {
  1637. spectral_err("Spectral target if object is null");
  1638. return;
  1639. }
  1640. /* set chainmask for all the modes */
  1641. for (; smode < SPECTRAL_SCAN_MODE_MAX; smode++)
  1642. spectral->params[smode].ss_chn_mask = spectral_rx_chainmask;
  1643. }
  1644. /**
  1645. * target_if_spectral_process_phyerr() - Process Spectral PHY error
  1646. * @pdev: Pointer to pdev
  1647. * @data: PHY error data received from FW
  1648. * @datalen: Length of data
  1649. * @p_rfqual: Pointer to RF Quality information
  1650. * @p_chaninfo: Pointer to channel information
  1651. * @tsf: TSF time instance at which the Spectral sample was received
  1652. * @acs_stats: ACS stats
  1653. *
  1654. * Process Spectral PHY error by extracting necessary information from the data
  1655. * sent by FW, and send the extracted information to application layer.
  1656. *
  1657. * Return: None
  1658. */
  1659. static inline
  1660. void target_if_spectral_process_phyerr(
  1661. struct wlan_objmgr_pdev *pdev,
  1662. uint8_t *data, uint32_t datalen,
  1663. struct target_if_spectral_rfqual_info *p_rfqual,
  1664. struct target_if_spectral_chan_info *p_chaninfo,
  1665. uint64_t tsf64,
  1666. struct target_if_spectral_acs_stats *acs_stats)
  1667. {
  1668. struct target_if_spectral *spectral = NULL;
  1669. struct target_if_spectral_ops *p_sops = NULL;
  1670. spectral = get_target_if_spectral_handle_from_pdev(pdev);
  1671. if (!spectral) {
  1672. spectral_err("Spectral target if object is null");
  1673. return;
  1674. }
  1675. p_sops = GET_TARGET_IF_SPECTRAL_OPS(spectral);
  1676. p_sops->spectral_process_phyerr(spectral, data, datalen,
  1677. p_rfqual, p_chaninfo,
  1678. tsf64, acs_stats);
  1679. }
  1680. static QDF_STATUS
  1681. target_if_get_spectral_msg_type(enum spectral_scan_mode smode,
  1682. enum spectral_msg_type *msg_type) {
  1683. switch (smode) {
  1684. case SPECTRAL_SCAN_MODE_NORMAL:
  1685. *msg_type = SPECTRAL_MSG_NORMAL_MODE;
  1686. break;
  1687. case SPECTRAL_SCAN_MODE_AGILE:
  1688. *msg_type = SPECTRAL_MSG_AGILE_MODE;
  1689. break;
  1690. default:
  1691. spectral_err("Invalid spectral mode");
  1692. return QDF_STATUS_E_FAILURE;
  1693. }
  1694. return QDF_STATUS_SUCCESS;
  1695. }
  1696. static inline bool
  1697. is_ch_width_160_or_80p80(enum phy_ch_width ch_width)
  1698. {
  1699. return (ch_width == CH_WIDTH_160MHZ || ch_width == CH_WIDTH_80P80MHZ);
  1700. }
  1701. /**
  1702. * init_160mhz_delivery_state_machine() - Initialize 160MHz Spectral
  1703. * state machine
  1704. * @spectral: Pointer to Spectral
  1705. *
  1706. * Initialize 160MHz Spectral state machine
  1707. *
  1708. * Return: void
  1709. */
  1710. static inline void
  1711. init_160mhz_delivery_state_machine(struct target_if_spectral *spectral)
  1712. {
  1713. uint8_t smode;
  1714. smode = 0;
  1715. for (; smode < SPECTRAL_SCAN_MODE_MAX; smode++)
  1716. spectral->state_160mhz_delivery[smode] =
  1717. SPECTRAL_REPORT_WAIT_PRIMARY80;
  1718. }
  1719. /**
  1720. * reset_160mhz_delivery_state_machine() - Reset 160MHz Spectral state machine
  1721. * @spectral: Pointer to Spectral
  1722. *
  1723. * Reset 160MHz Spectral state machine
  1724. *
  1725. * Return: void
  1726. */
  1727. static inline void
  1728. reset_160mhz_delivery_state_machine(struct target_if_spectral *spectral,
  1729. enum spectral_scan_mode smode)
  1730. {
  1731. enum spectral_msg_type smsg_type;
  1732. QDF_STATUS ret;
  1733. if (smode >= SPECTRAL_SCAN_MODE_MAX) {
  1734. spectral_err_rl("Invalid Spectral mode %d", smode);
  1735. return;
  1736. }
  1737. if (is_ch_width_160_or_80p80(spectral->ch_width[smode])) {
  1738. spectral->state_160mhz_delivery[smode] =
  1739. SPECTRAL_REPORT_WAIT_PRIMARY80;
  1740. ret = target_if_get_spectral_msg_type(smode, &smsg_type);
  1741. if (QDF_IS_STATUS_ERROR(ret)) {
  1742. spectral_err("Failed to get spectral message type");
  1743. return;
  1744. }
  1745. spectral->nl_cb.free_sbuff(spectral->pdev_obj,
  1746. smsg_type);
  1747. }
  1748. }
  1749. /**
  1750. * is_secondaryseg_expected() - Is waiting for secondary 80 report
  1751. * @spectral: Pointer to Spectral
  1752. * @smode: Spectral scan mode
  1753. *
  1754. * Return true if secondary 80 report expected and mode is 160 MHz
  1755. *
  1756. * Return: true or false
  1757. */
  1758. static inline
  1759. bool is_secondaryseg_expected(struct target_if_spectral *spectral,
  1760. enum spectral_scan_mode smode)
  1761. {
  1762. return
  1763. (is_ch_width_160_or_80p80(spectral->ch_width[smode]) &&
  1764. spectral->rparams.fragmentation_160[smode] &&
  1765. (spectral->state_160mhz_delivery[smode] ==
  1766. SPECTRAL_REPORT_WAIT_SECONDARY80));
  1767. }
  1768. /**
  1769. * is_primaryseg_expected() - Is waiting for primary 80 report
  1770. * @spectral: Pointer to Spectral
  1771. * @smode: Spectral scan mode
  1772. *
  1773. * Return true if mode is 160 Mhz and primary 80 report expected or
  1774. * mode is not 160 Mhz
  1775. *
  1776. * Return: true or false
  1777. */
  1778. static inline
  1779. bool is_primaryseg_expected(struct target_if_spectral *spectral,
  1780. enum spectral_scan_mode smode)
  1781. {
  1782. return
  1783. (!is_ch_width_160_or_80p80(spectral->ch_width[smode]) ||
  1784. !spectral->rparams.fragmentation_160[smode] ||
  1785. (spectral->state_160mhz_delivery[smode] ==
  1786. SPECTRAL_REPORT_WAIT_PRIMARY80));
  1787. }
  1788. /**
  1789. * is_primaryseg_rx_inprog() - Is primary 80 report processing is in progress
  1790. * @spectral: Pointer to Spectral
  1791. * @smode: Spectral scan mode
  1792. *
  1793. * Is primary 80 report processing is in progress
  1794. *
  1795. * Return: true or false
  1796. */
  1797. static inline
  1798. bool is_primaryseg_rx_inprog(struct target_if_spectral *spectral,
  1799. enum spectral_scan_mode smode)
  1800. {
  1801. return
  1802. (!is_ch_width_160_or_80p80(spectral->ch_width[smode]) ||
  1803. spectral->spectral_gen == SPECTRAL_GEN2 ||
  1804. (spectral->spectral_gen == SPECTRAL_GEN3 &&
  1805. (!spectral->rparams.fragmentation_160[smode] ||
  1806. spectral->state_160mhz_delivery[smode] ==
  1807. SPECTRAL_REPORT_RX_PRIMARY80)));
  1808. }
  1809. /**
  1810. * is_secondaryseg_rx_inprog() - Is secondary80 report processing is in progress
  1811. * @spectral: Pointer to Spectral
  1812. * @smode: Spectral scan mode
  1813. *
  1814. * Is secondary 80 report processing is in progress
  1815. *
  1816. * Return: true or false
  1817. */
  1818. static inline
  1819. bool is_secondaryseg_rx_inprog(struct target_if_spectral *spectral,
  1820. enum spectral_scan_mode smode)
  1821. {
  1822. return
  1823. (is_ch_width_160_or_80p80(spectral->ch_width[smode]) &&
  1824. (spectral->spectral_gen == SPECTRAL_GEN2 ||
  1825. ((spectral->spectral_gen == SPECTRAL_GEN3) &&
  1826. (!spectral->rparams.fragmentation_160[smode] ||
  1827. spectral->state_160mhz_delivery[smode] ==
  1828. SPECTRAL_REPORT_RX_SECONDARY80))));
  1829. }
  1830. /**
  1831. * target_if_160mhz_delivery_state_change() - State transition for 160Mhz
  1832. * Spectral
  1833. * @spectral: Pointer to spectral object
  1834. * @smode: Spectral scan mode
  1835. * @detector_id: Detector id
  1836. *
  1837. * Move the states of state machine for 160MHz spectral scan report receive
  1838. *
  1839. * Return: QDF_STATUS
  1840. */
  1841. QDF_STATUS
  1842. target_if_160mhz_delivery_state_change(struct target_if_spectral *spectral,
  1843. enum spectral_scan_mode smode,
  1844. uint8_t detector_id);
  1845. /**
  1846. * target_if_sops_is_spectral_enabled() - Get whether Spectral is enabled
  1847. * @arg: Pointer to handle for Spectral target_if internal private data
  1848. * @smode: Spectral scan mode
  1849. *
  1850. * Function to check whether Spectral is enabled
  1851. *
  1852. * Return: True if Spectral is enabled, false if Spectral is not enabled
  1853. */
  1854. uint32_t target_if_sops_is_spectral_enabled(void *arg,
  1855. enum spectral_scan_mode smode);
  1856. /**
  1857. * target_if_sops_is_spectral_active() - Get whether Spectral is active
  1858. * @arg: Pointer to handle for Spectral target_if internal private data
  1859. * @smode: Spectral scan mode
  1860. *
  1861. * Function to check whether Spectral is active
  1862. *
  1863. * Return: True if Spectral is active, false if Spectral is not active
  1864. */
  1865. uint32_t target_if_sops_is_spectral_active(void *arg,
  1866. enum spectral_scan_mode smode);
  1867. /**
  1868. * target_if_sops_start_spectral_scan() - Start Spectral scan
  1869. * @arg: Pointer to handle for Spectral target_if internal private data
  1870. * @smode: Spectral scan mode
  1871. * @err: Pointer to error code
  1872. *
  1873. * Function to start spectral scan
  1874. *
  1875. * Return: 0 on success else failure
  1876. */
  1877. uint32_t target_if_sops_start_spectral_scan(void *arg,
  1878. enum spectral_scan_mode smode,
  1879. enum spectral_cp_error_code *err);
  1880. /**
  1881. * target_if_sops_stop_spectral_scan() - Stop Spectral scan
  1882. * @arg: Pointer to handle for Spectral target_if internal private data
  1883. * @smode: Spectral scan mode
  1884. *
  1885. * Function to stop spectral scan
  1886. *
  1887. * Return: 0 in case of success, -1 on failure
  1888. */
  1889. uint32_t target_if_sops_stop_spectral_scan(void *arg,
  1890. enum spectral_scan_mode smode);
  1891. /**
  1892. * target_if_spectral_get_extension_channel() - Get the current Extension
  1893. * channel (in MHz)
  1894. * @arg: Pointer to handle for Spectral target_if internal private data
  1895. * @smode: Spectral scan mode
  1896. *
  1897. * Return: Current Extension channel (in MHz) on success, 0 on failure or if
  1898. * extension channel is not present.
  1899. */
  1900. uint32_t
  1901. target_if_spectral_get_extension_channel(void *arg,
  1902. enum spectral_scan_mode smode);
  1903. /**
  1904. * target_if_spectral_get_current_channel() - Get the current channel (in MHz)
  1905. * @arg: Pointer to handle for Spectral target_if internal private data
  1906. * @smode: Spectral scan mode
  1907. *
  1908. * Return: Current channel (in MHz) on success, 0 on failure
  1909. */
  1910. uint32_t
  1911. target_if_spectral_get_current_channel(void *arg,
  1912. enum spectral_scan_mode smode);
  1913. /**
  1914. * target_if_spectral_reset_hw() - Reset the hardware
  1915. * @arg: Pointer to handle for Spectral target_if internal private data
  1916. *
  1917. * This is only a placeholder since it is not currently required in the offload
  1918. * case.
  1919. *
  1920. * Return: 0
  1921. */
  1922. uint32_t target_if_spectral_reset_hw(void *arg);
  1923. /**
  1924. * target_if_spectral_get_chain_noise_floor() - Get the Chain noise floor from
  1925. * Noisefloor history buffer
  1926. * @arg: Pointer to handle for Spectral target_if internal private data
  1927. * @nf_buf: Pointer to buffer into which chain Noise Floor data should be copied
  1928. *
  1929. * This is only a placeholder since it is not currently required in the offload
  1930. * case.
  1931. *
  1932. * Return: 0
  1933. */
  1934. uint32_t target_if_spectral_get_chain_noise_floor(void *arg, int16_t *nf_buf);
  1935. /**
  1936. * target_if_spectral_get_ext_noisefloor() - Get the extension channel
  1937. * noisefloor
  1938. * @arg: Pointer to handle for Spectral target_if internal private data
  1939. *
  1940. * This is only a placeholder since it is not currently required in the offload
  1941. * case.
  1942. *
  1943. * Return: 0
  1944. */
  1945. int8_t target_if_spectral_get_ext_noisefloor(void *arg);
  1946. /**
  1947. * target_if_spectral_get_ctl_noisefloor() - Get the control channel noisefloor
  1948. * @arg: Pointer to handle for Spectral target_if internal private data
  1949. *
  1950. * This is only a placeholder since it is not currently required in the offload
  1951. * case.
  1952. *
  1953. * Return: 0
  1954. */
  1955. int8_t target_if_spectral_get_ctl_noisefloor(void *arg);
  1956. /**
  1957. * target_if_spectral_get_capability() - Get whether a given Spectral hardware
  1958. * capability is available
  1959. * @arg: Pointer to handle for Spectral target_if internal private data
  1960. * @type: Spectral hardware capability type
  1961. *
  1962. * Return: True if the capability is available, false if the capability is not
  1963. * available
  1964. */
  1965. uint32_t target_if_spectral_get_capability(
  1966. void *arg, enum spectral_capability_type type);
  1967. /**
  1968. * target_if_spectral_set_rxfilter() - Set the RX Filter before Spectral start
  1969. * @arg: Pointer to handle for Spectral target_if internal private data
  1970. * @rxfilter: Rx filter to be used
  1971. *
  1972. * Note: This is only a placeholder function. It is not currently required since
  1973. * FW should be taking care of setting the required filters.
  1974. *
  1975. * Return: 0
  1976. */
  1977. uint32_t target_if_spectral_set_rxfilter(void *arg, int rxfilter);
  1978. /**
  1979. * target_if_spectral_sops_configure_params() - Configure user supplied Spectral
  1980. * parameters
  1981. * @arg: Pointer to handle for Spectral target_if internal private data
  1982. * @params: Spectral parameters
  1983. * @smode: Spectral scan mode
  1984. *
  1985. * Return: 0 in case of success, -1 on failure
  1986. */
  1987. uint32_t target_if_spectral_sops_configure_params(
  1988. void *arg, struct spectral_config *params,
  1989. enum spectral_scan_mode smode);
  1990. /**
  1991. * target_if_spectral_get_rxfilter() - Get the current RX Filter settings
  1992. * @arg: Pointer to handle for Spectral target_if internal private data
  1993. *
  1994. * Note: This is only a placeholder function. It is not currently required since
  1995. * FW should be taking care of setting the required filters.
  1996. *
  1997. * Return: 0
  1998. */
  1999. uint32_t target_if_spectral_get_rxfilter(void *arg);
  2000. /**
  2001. * target_if_pdev_spectral_deinit() - De-initialize target_if Spectral
  2002. * functionality for the given pdev
  2003. * @pdev: Pointer to pdev object
  2004. *
  2005. * Return: None
  2006. */
  2007. void target_if_pdev_spectral_deinit(struct wlan_objmgr_pdev *pdev);
  2008. /**
  2009. * target_if_set_spectral_config() - Set spectral config
  2010. * @pdev: Pointer to pdev object
  2011. * @param: Spectral parameter id and value
  2012. * @smode: Spectral scan mode
  2013. * @err: Pointer to Spectral error code
  2014. *
  2015. * API to set spectral configurations
  2016. *
  2017. * Return: QDF_STATUS_SUCCESS in case of success, else QDF_STATUS_E_FAILURE
  2018. */
  2019. QDF_STATUS target_if_set_spectral_config(struct wlan_objmgr_pdev *pdev,
  2020. const struct spectral_cp_param *param,
  2021. const enum spectral_scan_mode smode,
  2022. enum spectral_cp_error_code *err);
  2023. /**
  2024. * target_if_pdev_spectral_init() - Initialize target_if Spectral
  2025. * functionality for the given pdev
  2026. * @pdev: Pointer to pdev object
  2027. *
  2028. * Return: On success, pointer to Spectral target_if internal private data, on
  2029. * failure, NULL
  2030. */
  2031. void *target_if_pdev_spectral_init(struct wlan_objmgr_pdev *pdev);
  2032. /**
  2033. * target_if_spectral_sops_get_params() - Get user configured Spectral
  2034. * parameters
  2035. * @arg: Pointer to handle for Spectral target_if internal private data
  2036. * @params: Pointer to buffer into which Spectral parameters should be copied
  2037. * @smode: Spectral scan mode
  2038. *
  2039. * Return: 0 in case of success, -1 on failure
  2040. */
  2041. uint32_t target_if_spectral_sops_get_params(
  2042. void *arg, struct spectral_config *params,
  2043. enum spectral_scan_mode smode);
  2044. /**
  2045. * target_if_init_spectral_capability() - Initialize Spectral capability
  2046. *
  2047. * @spectral: Pointer to Spectral target_if internal private data
  2048. * @target_type: target type
  2049. *
  2050. * This is a workaround.
  2051. *
  2052. * Return: QDF_STATUS
  2053. */
  2054. QDF_STATUS
  2055. target_if_init_spectral_capability(struct target_if_spectral *spectral,
  2056. uint32_t target_type);
  2057. /**
  2058. * target_if_start_spectral_scan() - Start spectral scan
  2059. * @pdev: Pointer to pdev object
  2060. * @vdev_id: VDEV id
  2061. * @smode: Spectral scan mode
  2062. * @err: Spectral error code
  2063. *
  2064. * API to start spectral scan
  2065. *
  2066. * Return: QDF_STATUS_SUCCESS in case of success, else QDF_STATUS_E_FAILURE
  2067. */
  2068. QDF_STATUS target_if_start_spectral_scan(struct wlan_objmgr_pdev *pdev,
  2069. uint8_t vdev_id,
  2070. enum spectral_scan_mode smode,
  2071. enum spectral_cp_error_code *err);
  2072. /**
  2073. * target_if_get_spectral_config() - Get spectral configuration
  2074. * @pdev: Pointer to pdev object
  2075. * @param: Pointer to spectral_config structure in which the configuration
  2076. * should be returned
  2077. * @smode: Spectral scan mode
  2078. *
  2079. * API to get the current spectral configuration
  2080. *
  2081. * Return: QDF_STATUS_SUCCESS in case of success, else QDF_STATUS_E_FAILURE
  2082. */
  2083. QDF_STATUS target_if_get_spectral_config(struct wlan_objmgr_pdev *pdev,
  2084. struct spectral_config *param,
  2085. enum spectral_scan_mode smode);
  2086. /**
  2087. * target_if_spectral_scan_enable_params() - Enable use of desired Spectral
  2088. * parameters
  2089. * @spectral: Pointer to Spectral target_if internal private data
  2090. * @spectral_params: Pointer to Spectral parameters
  2091. * @smode: Spectral scan mode
  2092. * @err: Spectral error code
  2093. *
  2094. * Enable use of desired Spectral parameters by configuring them into HW, and
  2095. * starting Spectral scan
  2096. *
  2097. * Return: 0 on success, 1 on failure
  2098. */
  2099. int target_if_spectral_scan_enable_params(
  2100. struct target_if_spectral *spectral,
  2101. struct spectral_config *spectral_params,
  2102. enum spectral_scan_mode smode,
  2103. enum spectral_cp_error_code *err);
  2104. /**
  2105. * target_if_is_spectral_active() - Get whether Spectral is active
  2106. * @pdev: Pointer to pdev object
  2107. * @smode: Spectral scan mode
  2108. *
  2109. * Return: True if Spectral is active, false if Spectral is not active
  2110. */
  2111. bool target_if_is_spectral_active(struct wlan_objmgr_pdev *pdev,
  2112. enum spectral_scan_mode smode);
  2113. /**
  2114. * target_if_is_spectral_enabled() - Get whether Spectral is enabled
  2115. * @pdev: Pointer to pdev object
  2116. * @smode: Spectral scan mode
  2117. *
  2118. * Return: True if Spectral is enabled, false if Spectral is not enabled
  2119. */
  2120. bool target_if_is_spectral_enabled(struct wlan_objmgr_pdev *pdev,
  2121. enum spectral_scan_mode smode);
  2122. /**
  2123. * target_if_set_debug_level() - Set debug level for Spectral
  2124. * @pdev: Pointer to pdev object
  2125. * @debug_level: Debug level
  2126. *
  2127. * Return: QDF_STATUS_SUCCESS in case of success, else QDF_STATUS_E_FAILURE
  2128. *
  2129. */
  2130. QDF_STATUS target_if_set_debug_level(struct wlan_objmgr_pdev *pdev,
  2131. uint32_t debug_level);
  2132. /**
  2133. * target_if_get_debug_level() - Get debug level for Spectral
  2134. * @pdev: Pointer to pdev object
  2135. *
  2136. * Return: Current debug level
  2137. */
  2138. uint32_t target_if_get_debug_level(struct wlan_objmgr_pdev *pdev);
  2139. /**
  2140. * target_if_get_spectral_capinfo() - Get Spectral capability information
  2141. * @pdev: Pointer to pdev object
  2142. * @scaps: Buffer into which data should be copied
  2143. *
  2144. * Return: QDF_STATUS_SUCCESS in case of success, else QDF_STATUS_E_FAILURE
  2145. */
  2146. QDF_STATUS target_if_get_spectral_capinfo(struct wlan_objmgr_pdev *pdev,
  2147. struct spectral_caps *scaps);
  2148. /**
  2149. * target_if_get_spectral_diagstats() - Get Spectral diagnostic statistics
  2150. * @pdev: Pointer to pdev object
  2151. * @stats: Buffer into which data should be copied
  2152. *
  2153. * Return: QDF_STATUS_SUCCESS in case of success, else QDF_STATUS_E_FAILURE
  2154. */
  2155. QDF_STATUS target_if_get_spectral_diagstats(struct wlan_objmgr_pdev *pdev,
  2156. struct spectral_diag_stats *stats);
  2157. QDF_STATUS
  2158. target_if_160mhz_delivery_state_change(struct target_if_spectral *spectral,
  2159. enum spectral_scan_mode smode,
  2160. uint8_t detector_id);
  2161. #ifdef DIRECT_BUF_RX_ENABLE
  2162. /**
  2163. * target_if_consume_sfft_report_gen3() - Process fft report for gen3
  2164. * @spectral: Pointer to spectral object
  2165. * @report: Pointer to spectral report
  2166. *
  2167. * Process fft report for gen3
  2168. *
  2169. * Return: Success/Failure
  2170. */
  2171. int
  2172. target_if_consume_spectral_report_gen3(
  2173. struct target_if_spectral *spectral,
  2174. struct spectral_report *report);
  2175. #endif
  2176. /**
  2177. * target_if_spectral_fw_hang() - Crash the FW from Spectral module
  2178. * @spectral: Pointer to Spectral LMAC object
  2179. *
  2180. * Return: QDF_STATUS of operation
  2181. */
  2182. QDF_STATUS target_if_spectral_fw_hang(struct target_if_spectral *spectral);
  2183. /**
  2184. * target_if_spectral_finite_scan_update() - Update scan count for finite scan
  2185. * and stop Spectral scan when required
  2186. * @spectral: Pointer to Spectral target_if internal private data
  2187. * @smode: Spectral scan mode
  2188. *
  2189. * This API decrements the number of Spectral reports expected from target for
  2190. * a finite Spectral scan. When expected number of reports are received from
  2191. * target Spectral scan is stopped.
  2192. *
  2193. * Return: QDF_STATUS on success
  2194. */
  2195. QDF_STATUS
  2196. target_if_spectral_finite_scan_update(struct target_if_spectral *spectral,
  2197. enum spectral_scan_mode smode);
  2198. /**
  2199. * target_if_spectral_is_finite_scan() - Check Spectral scan is finite/infinite
  2200. * @spectral: Pointer to Spectral target_if internal private data
  2201. * @smode: Spectral scan mode
  2202. *
  2203. * API to check whether Spectral scan is finite/infinite for the give mode.
  2204. * A non zero scan count indicates that scan is finite. Scan count of 0
  2205. * indicates an infinite Spectral scan.
  2206. *
  2207. * Return: QDF_STATUS on success
  2208. */
  2209. QDF_STATUS
  2210. target_if_spectral_is_finite_scan(struct target_if_spectral *spectral,
  2211. enum spectral_scan_mode smode,
  2212. bool *finite_spectral_scan);
  2213. #ifdef BIG_ENDIAN_HOST
  2214. /**
  2215. * target_if_byte_swap_spectral_headers_gen3() - Apply byte-swap on headers
  2216. * @spectral: Pointer to Spectral target_if internal private data
  2217. * @data: Pointer to the start of Spectral Scan Summary report
  2218. *
  2219. * This API is only required for Big-endian Host platforms.
  2220. * It applies 32-bit byte-swap on Spectral Scan Summary and Search FFT reports
  2221. * and copies them back to the source location.
  2222. * Padding bytes that lie between the reports won't be touched.
  2223. *
  2224. * Return: QDF_STATUS_SUCCESS in case of success, else QDF_STATUS_E_FAILURE
  2225. */
  2226. QDF_STATUS target_if_byte_swap_spectral_headers_gen3(
  2227. struct target_if_spectral *spectral,
  2228. void *data);
  2229. /**
  2230. * target_if_byte_swap_spectral_fft_bins_gen3() - Apply byte-swap on FFT bins
  2231. * @spectral: Pointer to Spectral FFT bin length adjustment WAR
  2232. * @bin_pwr_data: Pointer to the start of FFT bins
  2233. * @pwr_count: Number of FFT bins
  2234. *
  2235. * This API is only required for Big-endian Host platforms.
  2236. * It applies pack-mode-aware byte-swap on the FFT bins as below:
  2237. * 1. pack-mode 0 (i.e., 1 FFT bin per DWORD):
  2238. * Reads the least significant 2 bytes of each DWORD, applies 16-bit
  2239. * byte-swap on that value, and copies it back to the source location.
  2240. * 2. pack-mode 1 (i.e., 2 FFT bins per DWORD):
  2241. * Reads each FFT bin, applies 16-bit byte-swap on that value,
  2242. * and copies it back to the source location.
  2243. * 3. pack-mode 2 (4 FFT bins per DWORD):
  2244. * Nothing
  2245. *
  2246. * Return: QDF_STATUS_SUCCESS in case of success, else QDF_STATUS_E_FAILURE
  2247. */
  2248. QDF_STATUS target_if_byte_swap_spectral_fft_bins_gen3(
  2249. struct spectral_fft_bin_len_adj_swar *swar,
  2250. void *bin_pwr_data, size_t pwr_count);
  2251. #endif /* BIG_ENDIAN_HOST */
  2252. #ifdef WIN32
  2253. #pragma pack(pop, target_if_spectral)
  2254. #endif
  2255. #ifdef __ATTRIB_PACK
  2256. #undef __ATTRIB_PACK
  2257. #endif
  2258. #endif /* WLAN_CONV_SPECTRAL_ENABLE */
  2259. #endif /* _TARGET_IF_SPECTRAL_H_ */