qdf_trace.h 43 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458
  1. /*
  2. * Copyright (c) 2014-2019 The Linux Foundation. All rights reserved.
  3. *
  4. * Permission to use, copy, modify, and/or distribute this software for
  5. * any purpose with or without fee is hereby granted, provided that the
  6. * above copyright notice and this permission notice appear in all
  7. * copies.
  8. *
  9. * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
  10. * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
  11. * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
  12. * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
  13. * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
  14. * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  15. * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  16. * PERFORMANCE OF THIS SOFTWARE.
  17. */
  18. #if !defined(__QDF_TRACE_H)
  19. #define __QDF_TRACE_H
  20. /**
  21. * DOC: qdf_trace
  22. * QCA driver framework trace APIs
  23. * Trace, logging, and debugging definitions and APIs
  24. */
  25. /* Include Files */
  26. #include <qdf_types.h> /* For QDF_MODULE_ID... */
  27. #include <stdarg.h> /* For va_list... */
  28. #include <qdf_status.h>
  29. #include <qdf_nbuf.h>
  30. #include <i_qdf_types.h>
  31. #include <qdf_debugfs.h>
  32. /* Type declarations */
  33. #define FL(x) "%s: %d: " x, __func__, __LINE__
  34. #define QDF_TRACE_BUFFER_SIZE (512)
  35. /*
  36. * Extracts the 8-bit group id from the wmi command id by performing the
  37. * reverse operation of WMI_CMD_GRP_START_ID
  38. */
  39. #define QDF_WMI_MTRACE_GRP_ID(message_id) (((message_id) >> 12) & 0xFF)
  40. /*
  41. * Number of bits reserved for WMI mtrace command id
  42. */
  43. #define QDF_WMI_MTRACE_CMD_NUM_BITS 7
  44. /*
  45. * Extracts the 7-bit group specific command id from the wmi command id
  46. */
  47. #define QDF_WMI_MTRACE_CMD_ID(message_id) ((message_id) & 0x7F)
  48. #ifdef QDF_TRACE_PRINT_ENABLE
  49. #define QDF_DEFAULT_TRACE_LEVEL (1 << QDF_TRACE_LEVEL_INFO)
  50. #endif
  51. #define QDF_CATEGORY_INFO_U16(val) (((val >> 16) & 0x0000FFFF))
  52. #define QDF_TRACE_LEVEL_INFO_L16(val) (val & 0x0000FFFF)
  53. typedef int (qdf_abstract_print)(void *priv, const char *fmt, ...);
  54. /*
  55. * Log levels
  56. */
  57. #define QDF_DEBUG_FUNCTRACE 0x01
  58. #define QDF_DEBUG_LEVEL0 0x02
  59. #define QDF_DEBUG_LEVEL1 0x04
  60. #define QDF_DEBUG_LEVEL2 0x08
  61. #define QDF_DEBUG_LEVEL3 0x10
  62. #define QDF_DEBUG_ERROR 0x20
  63. #define QDF_DEBUG_CFG 0x40
  64. /* DP Trace Implementation */
  65. #ifdef CONFIG_DP_TRACE
  66. #define DPTRACE(p) p
  67. #define DPTRACE_PRINT(args...) \
  68. QDF_TRACE(QDF_MODULE_ID_QDF, QDF_TRACE_LEVEL_DEBUG, args)
  69. #else
  70. #define DPTRACE(p)
  71. #define DPTRACE_PRINT(args...)
  72. #endif
  73. /* By default Data Path module will have all log levels enabled, except debug
  74. * log level. Debug level will be left up to the framework or user space modules
  75. * to be enabled when issue is detected
  76. */
  77. #define QDF_DATA_PATH_TRACE_LEVEL \
  78. ((1 << QDF_TRACE_LEVEL_FATAL) | (1 << QDF_TRACE_LEVEL_ERROR) | \
  79. (1 << QDF_TRACE_LEVEL_WARN) | (1 << QDF_TRACE_LEVEL_INFO) | \
  80. (1 << QDF_TRACE_LEVEL_INFO_HIGH) | (1 << QDF_TRACE_LEVEL_INFO_MED) | \
  81. (1 << QDF_TRACE_LEVEL_INFO_LOW))
  82. /* Preprocessor definitions and constants */
  83. #define ASSERT_BUFFER_SIZE (512)
  84. #ifndef MAX_QDF_TRACE_RECORDS
  85. #define MAX_QDF_TRACE_RECORDS 4000
  86. #endif
  87. #define QDF_TRACE_DEFAULT_PDEV_ID 0xff
  88. #define INVALID_QDF_TRACE_ADDR 0xffffffff
  89. #define DEFAULT_QDF_TRACE_DUMP_COUNT 0
  90. /*
  91. * first parameter to iwpriv command - dump_dp_trace
  92. * iwpriv wlan0 dump_dp_trace 0 0 -> dump full buffer
  93. * iwpriv wlan0 dump_dp_trace 1 0 -> enable live view mode
  94. * iwpriv wlan0 dump_dp_trace 2 0 -> clear dp trace buffer
  95. * iwpriv wlan0 dump_dp_trace 3 0 -> disable live view mode
  96. */
  97. #define DUMP_DP_TRACE 0
  98. #define ENABLE_DP_TRACE_LIVE_MODE 1
  99. #define CLEAR_DP_TRACE_BUFFER 2
  100. #define DISABLE_DP_TRACE_LIVE_MODE 3
  101. #ifdef TRACE_RECORD
  102. #define MTRACE(p) p
  103. #else
  104. #define MTRACE(p) do { } while (0)
  105. #endif
  106. #define NO_SESSION 0xFF
  107. /**
  108. * typedef struct qdf_trace_record_s - keep trace record
  109. * @qtime: qtimer ticks
  110. * @time: user timestamp
  111. * @module: module name
  112. * @code: hold record of code
  113. * @session: hold record of session
  114. * @data: hold data
  115. * @pid: hold pid of the process
  116. */
  117. typedef struct qdf_trace_record_s {
  118. uint64_t qtime;
  119. char time[18];
  120. uint8_t module;
  121. uint8_t code;
  122. uint16_t session;
  123. uint32_t data;
  124. uint32_t pid;
  125. } qdf_trace_record_t, *tp_qdf_trace_record;
  126. /**
  127. * typedef struct s_qdf_trace_data - MTRACE logs are stored in ring buffer
  128. * @head: position of first record
  129. * @tail: position of last record
  130. * @num: count of total record
  131. * @num_since_last_dump: count from last dump
  132. * @enable: config for controlling the trace
  133. * @dump_count: Dump after number of records reach this number
  134. */
  135. typedef struct s_qdf_trace_data {
  136. uint32_t head;
  137. uint32_t tail;
  138. uint32_t num;
  139. uint16_t num_since_last_dump;
  140. uint8_t enable;
  141. uint16_t dump_count;
  142. } t_qdf_trace_data;
  143. #define CASE_RETURN_STRING(str) case ((str)): return (uint8_t *)(# str);
  144. #ifndef MAX_QDF_DP_TRACE_RECORDS
  145. #define MAX_QDF_DP_TRACE_RECORDS 2000
  146. #endif
  147. #define QDF_DP_TRACE_RECORD_SIZE 40
  148. #define INVALID_QDF_DP_TRACE_ADDR 0xffffffff
  149. #define QDF_DP_TRACE_VERBOSITY_HIGH 4
  150. #define QDF_DP_TRACE_VERBOSITY_MEDIUM 3
  151. #define QDF_DP_TRACE_VERBOSITY_LOW 2
  152. #define QDF_DP_TRACE_VERBOSITY_ULTRA_LOW 1
  153. #define QDF_DP_TRACE_VERBOSITY_BASE 0
  154. /**
  155. * enum QDF_DP_TRACE_ID - Generic ID to identify various events in data path
  156. * @QDF_DP_TRACE_INVALID - invalid
  157. * @QDF_DP_TRACE_DROP_PACKET_RECORD - record drop packet
  158. * @QDF_DP_TRACE_EAPOL_PACKET_RECORD - record EAPOL packet
  159. * @QDF_DP_TRACE_DHCP_PACKET_RECORD - record DHCP packet
  160. * @QDF_DP_TRACE_ARP_PACKET_RECORD - record ARP packet
  161. * @QDF_DP_TRACE_MGMT_PACKET_RECORD - record MGMT pacekt
  162. * @QDF_DP_TRACE_EVENT_RECORD - record events
  163. * @QDF_DP_TRACE_BASE_VERBOSITY - below this are part of base verbosity
  164. * @QDF_DP_TRACE_ICMP_PACKET_RECORD - record ICMP packet
  165. * @QDF_DP_TRACE_ICMPv6_PACKET_RECORD - record ICMPv6 packet
  166. * @QDF_DP_TRACE_HDD_TX_TIMEOUT - HDD tx timeout
  167. * @QDF_DP_TRACE_HDD_SOFTAP_TX_TIMEOUT- SOFTAP HDD tx timeout
  168. * @QDF_DP_TRACE_TX_CREDIT_RECORD - credit update record
  169. * @QDF_DP_TRACE_ULTRA_LOW_VERBOSITY - Below this is not logged for >4PPS
  170. * @QDF_DP_TRACE_TX_PACKET_RECORD - record 32 bytes of tx pkt at any layer
  171. * @QDF_DP_TRACE_RX_PACKET_RECORD - record 32 bytes of rx pkt at any layer
  172. * @QDF_DP_TRACE_HDD_TX_PACKET_RECORD - record 32 bytes of tx pkt at HDD
  173. * @QDF_DP_TRACE_HDD_RX_PACKET_RECORD - record 32 bytes of rx pkt at HDD
  174. * @QDF_DP_TRACE_LI_DP_TX_PACKET_RECORD - record data bytes of tx pkt at LI_DP
  175. * @QDF_DP_TRACE_LI_DP_RX_PACKET_RECORD - record data bytes of rx pkt at LI_DP
  176. * @QDF_DP_TRACE_LI_DP_FREE_PACKET_PTR_RECORD - tx completion ptr record for
  177. * lithium
  178. * @QDF_DP_TRACE_FREE_PACKET_PTR_RECORD - tx completion ptr record
  179. * @QDF_DP_TRACE_LOW_VERBOSITY - below this are part of low verbosity
  180. * @QDF_DP_TRACE_HDD_TX_PACKET_PTR_RECORD - HDD layer ptr record
  181. * @QDF_DP_TRACE_LI_DP_TX_PACKET_PTR_RECORD - Lithium DP layer ptr record
  182. * @QDF_DP_TRACE_RX_HDD_PACKET_PTR_RECORD - HDD RX record
  183. * @QDF_DP_TRACE_CE_PACKET_PTR_RECORD - CE layer ptr record
  184. * @QDF_DP_TRACE_CE_FAST_PACKET_PTR_RECORD- CE fastpath ptr record
  185. * @QDF_DP_TRACE_CE_FAST_PACKET_ERR_RECORD- CE fastpath error record
  186. * @QDF_DP_TRACE_RX_HTT_PACKET_PTR_RECORD - HTT RX record
  187. * @QDF_DP_TRACE_RX_OFFLOAD_HTT_PACKET_PTR_RECORD- HTT RX offload record
  188. * @QDF_DP_TRACE_RX_LI_DP_PACKET_PTR_RECORD - Lithium DP RX record
  189. * @QDF_DP_TRACE_MED_VERBOSITY - below this are part of med verbosity
  190. * @QDF_DP_TRACE_TXRX_QUEUE_PACKET_PTR_RECORD -tx queue ptr record
  191. * @QDF_DP_TRACE_TXRX_PACKET_PTR_RECORD - txrx packet ptr record
  192. * @QDF_DP_TRACE_TXRX_FAST_PACKET_PTR_RECORD - txrx fast path record
  193. * @QDF_DP_TRACE_HTT_PACKET_PTR_RECORD - htt packet ptr record
  194. * @QDF_DP_TRACE_HTC_PACKET_PTR_RECORD - htc packet ptr record
  195. * @QDF_DP_TRACE_HIF_PACKET_PTR_RECORD - hif packet ptr record
  196. * @QDF_DP_TRACE_RX_TXRX_PACKET_PTR_RECORD - txrx packet ptr record
  197. * @QDF_DP_TRACE_LI_DP_NULL_RX_PACKET_RECORD
  198. * - record data bytes of rx null_queue pkt at LI_DP
  199. * @QDF_DP_TRACE_HIGH_VERBOSITY - below this are part of high verbosity
  200. */
  201. enum QDF_DP_TRACE_ID {
  202. QDF_DP_TRACE_INVALID,
  203. QDF_DP_TRACE_DROP_PACKET_RECORD,
  204. QDF_DP_TRACE_EAPOL_PACKET_RECORD,
  205. QDF_DP_TRACE_DHCP_PACKET_RECORD,
  206. QDF_DP_TRACE_ARP_PACKET_RECORD,
  207. QDF_DP_TRACE_MGMT_PACKET_RECORD,
  208. QDF_DP_TRACE_EVENT_RECORD,
  209. QDF_DP_TRACE_BASE_VERBOSITY,
  210. QDF_DP_TRACE_ICMP_PACKET_RECORD,
  211. QDF_DP_TRACE_ICMPv6_PACKET_RECORD,
  212. QDF_DP_TRACE_HDD_TX_TIMEOUT,
  213. QDF_DP_TRACE_HDD_SOFTAP_TX_TIMEOUT,
  214. QDF_DP_TRACE_TX_CREDIT_RECORD,
  215. QDF_DP_TRACE_ULTRA_LOW_VERBOSITY,
  216. QDF_DP_TRACE_TX_PACKET_RECORD,
  217. QDF_DP_TRACE_RX_PACKET_RECORD,
  218. QDF_DP_TRACE_HDD_TX_PACKET_RECORD,
  219. QDF_DP_TRACE_HDD_RX_PACKET_RECORD,
  220. QDF_DP_TRACE_LI_DP_TX_PACKET_RECORD,
  221. QDF_DP_TRACE_LI_DP_RX_PACKET_RECORD,
  222. QDF_DP_TRACE_LI_DP_FREE_PACKET_PTR_RECORD,
  223. QDF_DP_TRACE_FREE_PACKET_PTR_RECORD,
  224. QDF_DP_TRACE_LOW_VERBOSITY,
  225. QDF_DP_TRACE_HDD_TX_PACKET_PTR_RECORD,
  226. QDF_DP_TRACE_LI_DP_TX_PACKET_PTR_RECORD,
  227. QDF_DP_TRACE_RX_HDD_PACKET_PTR_RECORD,
  228. QDF_DP_TRACE_CE_PACKET_PTR_RECORD,
  229. QDF_DP_TRACE_CE_FAST_PACKET_PTR_RECORD,
  230. QDF_DP_TRACE_CE_FAST_PACKET_ERR_RECORD,
  231. QDF_DP_TRACE_RX_HTT_PACKET_PTR_RECORD,
  232. QDF_DP_TRACE_RX_OFFLOAD_HTT_PACKET_PTR_RECORD,
  233. QDF_DP_TRACE_RX_LI_DP_PACKET_PTR_RECORD,
  234. QDF_DP_TRACE_MED_VERBOSITY,
  235. QDF_DP_TRACE_TXRX_QUEUE_PACKET_PTR_RECORD,
  236. QDF_DP_TRACE_TXRX_PACKET_PTR_RECORD,
  237. QDF_DP_TRACE_TXRX_FAST_PACKET_PTR_RECORD,
  238. QDF_DP_TRACE_HTT_PACKET_PTR_RECORD,
  239. QDF_DP_TRACE_HTC_PACKET_PTR_RECORD,
  240. QDF_DP_TRACE_HIF_PACKET_PTR_RECORD,
  241. QDF_DP_TRACE_RX_TXRX_PACKET_PTR_RECORD,
  242. QDF_DP_TRACE_LI_DP_NULL_RX_PACKET_RECORD,
  243. QDF_DP_TRACE_HIGH_VERBOSITY,
  244. QDF_DP_TRACE_MAX
  245. };
  246. /**
  247. * qdf_proto_dir - direction
  248. * @QDF_TX: TX direction
  249. * @QDF_RX: RX direction
  250. * @QDF_NA: not applicable
  251. */
  252. enum qdf_proto_dir {
  253. QDF_TX,
  254. QDF_RX,
  255. QDF_NA
  256. };
  257. /**
  258. * QDF_CREDIT_UPDATE_SOURCE - source of credit record
  259. * @QDF_TX_SCHED: Tx scheduler
  260. * @QDF_TX_COMP: TX completion
  261. * @QDF_TX_CREDIT_UPDATE: credit update indication
  262. * @QDF_HTT_ATTACH: HTT attach
  263. * @QDF_TX_HTT_MSG: HTT TX message
  264. */
  265. enum QDF_CREDIT_UPDATE_SOURCE {
  266. QDF_TX_SCHED,
  267. QDF_TX_COMP,
  268. QDF_TX_CREDIT_UPDATE,
  269. QDF_HTT_ATTACH,
  270. QDF_TX_HTT_MSG
  271. };
  272. /**
  273. * QDF_CREDIT_OPERATION - operation on credit
  274. * @QDF_CREDIT_INC: credit increment
  275. * @QDF_CREDIT_DEC: credit decrement
  276. * @QDF_CREDIT_ABS: Abosolute credit
  277. * @QDF_OP_NA: Not applicable
  278. */
  279. enum QDF_CREDIT_OPERATION {
  280. QDF_CREDIT_INC,
  281. QDF_CREDIT_DEC,
  282. QDF_CREDIT_ABS,
  283. QDF_OP_NA
  284. };
  285. /**
  286. * struct qdf_dp_trace_ptr_buf - pointer record buffer
  287. * @cookie: cookie value
  288. * @msdu_id: msdu_id
  289. * @status: completion status
  290. */
  291. struct qdf_dp_trace_ptr_buf {
  292. uint64_t cookie;
  293. uint16_t msdu_id;
  294. uint16_t status;
  295. };
  296. /**
  297. * struct qdf_dp_trace_proto_buf - proto packet buffer
  298. * @sa: source address
  299. * @da: destination address
  300. * @vdev_id : vdev id
  301. * @type: packet type
  302. * @subtype: packet subtype
  303. * @dir: direction
  304. */
  305. struct qdf_dp_trace_proto_buf {
  306. struct qdf_mac_addr sa;
  307. struct qdf_mac_addr da;
  308. uint8_t vdev_id;
  309. uint8_t type;
  310. uint8_t subtype;
  311. uint8_t dir;
  312. };
  313. /**
  314. * struct qdf_dp_trace_mgmt_buf - mgmt packet buffer
  315. * @vdev_id : vdev id
  316. * @type: packet type
  317. * @subtype: packet subtype
  318. */
  319. struct qdf_dp_trace_mgmt_buf {
  320. uint8_t vdev_id;
  321. uint8_t type;
  322. uint8_t subtype;
  323. };
  324. /**
  325. * struct qdf_dp_trace_credit_record - tx credit record
  326. * @source: credit record source
  327. * @operation: credit operation
  328. * @delta: delta of credit
  329. * @total_credits: total credit
  330. * @g0_credit: group 0 credit
  331. * @g1_credit: group 1 credit
  332. */
  333. struct qdf_dp_trace_credit_record {
  334. enum QDF_CREDIT_UPDATE_SOURCE source;
  335. enum QDF_CREDIT_OPERATION operation;
  336. int delta;
  337. int total_credits;
  338. int g0_credit;
  339. int g1_credit;
  340. };
  341. /**
  342. * struct qdf_dp_trace_event_buf - event buffer
  343. * @vdev_id : vdev id
  344. * @type: packet type
  345. * @subtype: packet subtype
  346. */
  347. struct qdf_dp_trace_event_buf {
  348. uint8_t vdev_id;
  349. uint8_t type;
  350. uint8_t subtype;
  351. };
  352. /**
  353. * struct qdf_dp_trace_data_buf - nbuf data buffer
  354. * @msdu_id : msdu id
  355. */
  356. struct qdf_dp_trace_data_buf {
  357. uint16_t msdu_id;
  358. };
  359. /**
  360. * struct qdf_dp_trace_record_s - Describes a record in DP trace
  361. * @time: time when it got stored
  362. * @code: Describes the particular event
  363. * @data: buffer to store data
  364. * @size: Length of the valid data stored in this record
  365. * @pid : process id which stored the data in this record
  366. */
  367. struct qdf_dp_trace_record_s {
  368. uint64_t time;
  369. uint8_t code;
  370. uint8_t data[QDF_DP_TRACE_RECORD_SIZE];
  371. uint8_t size;
  372. uint32_t pid;
  373. uint8_t pdev_id;
  374. };
  375. /**
  376. * struct qdf_dp_trace_data - Parameters to configure/control DP trace
  377. * @head: Position of first record
  378. * @tail: Position of last record
  379. * @num: Current index
  380. * @proto_bitmap: defines which protocol to be traced
  381. * @no_of_record: defines every nth packet to be traced
  382. * @num_records_to_dump: defines number of records to be dumped
  383. * @dump_counter: counter to track number of records dumped
  384. * @verbosity : defines verbosity level
  385. * @ini_conf_verbosity: Configured verbosity from INI
  386. * @enable: enable/disable DP trace
  387. * @count: current packet number
  388. * @live_mode_config: configuration as received during initialization
  389. * @live_mode: current live mode, enabled or disabled, can be throttled based
  390. * on throughput
  391. * @force_live_mode: flag to enable live mode all the time for all packets.
  392. * This can be set/unset from userspace and overrides other
  393. * live mode flags.
  394. * @dynamic_verbosity_modify: Dynamic user configured verbosity overrides all
  395. * @print_pkt_cnt: count of number of packets printed in live mode
  396. * @high_tput_thresh: thresh beyond which live mode is turned off
  397. * @thresh_time_limit: max time, in terms of BW timer intervals to wait,
  398. * for determining if high_tput_thresh has been crossed. ~1s
  399. * @arp_req: stats for arp reqs
  400. * @arp_resp: stats for arp resps
  401. * @icmp_req: stats for icmp reqs
  402. * @icmp_resp: stats for icmp resps
  403. * @dhcp_disc: stats for dhcp discover msgs
  404. * @dhcp_req: stats for dhcp req msgs
  405. * @dhcp_off: stats for dhcp offer msgs
  406. * @dhcp_ack: stats for dhcp ack msgs
  407. * @dhcp_nack: stats for dhcp nack msgs
  408. * @dhcp_others: stats for other dhcp pkts types
  409. * @eapol_m1: stats for eapol m1
  410. * @eapol_m2: stats for eapol m2
  411. * @eapol_m3: stats for eapol m3
  412. * @eapol_m4: stats for eapol m4
  413. * @eapol_others: stats for other eapol pkt types
  414. * @icmpv6_req: stats for icmpv6 reqs
  415. * @icmpv6_resp: stats for icmpv6 resps
  416. * @icmpv6_ns: stats for icmpv6 nss
  417. * @icmpv6_na: stats for icmpv6 nas
  418. * @icmpv6_rs: stats for icmpv6 rss
  419. * @icmpv6_ra: stats for icmpv6 ras
  420. */
  421. struct s_qdf_dp_trace_data {
  422. uint32_t head;
  423. uint32_t tail;
  424. uint32_t num;
  425. uint32_t proto_bitmap;
  426. uint8_t no_of_record;
  427. uint16_t num_records_to_dump;
  428. uint16_t dump_counter;
  429. uint8_t verbosity;
  430. uint8_t ini_conf_verbosity;
  431. bool enable;
  432. bool live_mode_config;
  433. bool live_mode;
  434. uint32_t curr_pos;
  435. uint32_t saved_tail;
  436. bool force_live_mode;
  437. bool dynamic_verbosity_modify;
  438. uint8_t print_pkt_cnt;
  439. uint8_t high_tput_thresh;
  440. uint16_t thresh_time_limit;
  441. /* Stats */
  442. uint32_t tx_count;
  443. uint32_t rx_count;
  444. u16 arp_req;
  445. u16 arp_resp;
  446. u16 dhcp_disc;
  447. u16 dhcp_req;
  448. u16 dhcp_off;
  449. u16 dhcp_ack;
  450. u16 dhcp_nack;
  451. u16 dhcp_others;
  452. u16 eapol_m1;
  453. u16 eapol_m2;
  454. u16 eapol_m3;
  455. u16 eapol_m4;
  456. u16 eapol_others;
  457. u16 icmp_req;
  458. u16 icmp_resp;
  459. u16 icmpv6_req;
  460. u16 icmpv6_resp;
  461. u16 icmpv6_ns;
  462. u16 icmpv6_na;
  463. u16 icmpv6_rs;
  464. u16 icmpv6_ra;
  465. };
  466. /**
  467. * struct qdf_dpt_debugfs_state - state to control read to debugfs file
  468. * @QDF_DPT_DEBUGFS_STATE_SHOW_STATE_INVALID: invalid state
  469. * @QDF_DPT_DEBUGFS_STATE_SHOW_STATE_INIT: initial state
  470. * @QDF_DPT_DEBUGFS_STATE_SHOW_IN_PROGRESS: read is in progress
  471. * @QDF_DPT_DEBUGFS_STATE_SHOW_COMPLETE: read complete
  472. */
  473. enum qdf_dpt_debugfs_state {
  474. QDF_DPT_DEBUGFS_STATE_SHOW_STATE_INVALID,
  475. QDF_DPT_DEBUGFS_STATE_SHOW_STATE_INIT,
  476. QDF_DPT_DEBUGFS_STATE_SHOW_IN_PROGRESS,
  477. QDF_DPT_DEBUGFS_STATE_SHOW_COMPLETE,
  478. };
  479. typedef void (*tp_qdf_trace_cb)(void *p_mac, tp_qdf_trace_record, uint16_t);
  480. typedef void (*tp_qdf_state_info_cb) (char **buf, uint16_t *size);
  481. #ifdef WLAN_FEATURE_MEMDUMP_ENABLE
  482. void qdf_register_debugcb_init(void);
  483. void qdf_register_debug_callback(QDF_MODULE_ID module_id,
  484. tp_qdf_state_info_cb qdf_state_infocb);
  485. QDF_STATUS qdf_state_info_dump_all(char *buf, uint16_t size,
  486. uint16_t *driver_dump_size);
  487. #else /* WLAN_FEATURE_MEMDUMP_ENABLE */
  488. static inline void qdf_register_debugcb_init(void)
  489. {
  490. }
  491. #endif /* WLAN_FEATURE_MEMDUMP_ENABLE */
  492. #ifdef TRACE_RECORD
  493. void qdf_trace_register(QDF_MODULE_ID, tp_qdf_trace_cb);
  494. void qdf_trace_init(void);
  495. void qdf_trace_deinit(void);
  496. void qdf_trace(uint8_t module, uint8_t code, uint16_t session, uint32_t data);
  497. void qdf_trace_enable(uint32_t, uint8_t enable);
  498. void qdf_trace_dump_all(void *, uint8_t, uint8_t, uint32_t, uint32_t);
  499. QDF_STATUS qdf_trace_spin_lock_init(void);
  500. #else
  501. #ifndef QDF_TRACE_PRINT_ENABLE
  502. static inline
  503. void qdf_trace_init(void)
  504. {
  505. }
  506. static inline
  507. void qdf_trace_deinit(void)
  508. {
  509. }
  510. static inline
  511. void qdf_trace_enable(uint32_t bitmask_of_module_id, uint8_t enable)
  512. {
  513. }
  514. static inline
  515. void qdf_trace(uint8_t module, uint8_t code, uint16_t session, uint32_t data)
  516. {
  517. }
  518. static inline
  519. void qdf_trace_dump_all(void *p_mac, uint8_t code, uint8_t session,
  520. uint32_t count, uint32_t bitmask_of_module)
  521. {
  522. }
  523. static inline
  524. QDF_STATUS qdf_trace_spin_lock_init(void)
  525. {
  526. return QDF_STATUS_E_INVAL;
  527. }
  528. #endif
  529. #endif
  530. #ifdef ENABLE_MTRACE_LOG
  531. /**
  532. * qdf_mtrace_log() - Logs a message tracepoint to DIAG
  533. * Infrastructure.
  534. * @src_module: Enum of source module (basically module id)
  535. * from where the message with message_id is posted.
  536. * @dst_module: Enum of destination module (basically module id)
  537. * to which the message with message_id is posted.
  538. * @message_id: Id of the message to be posted
  539. * @vdev_id: Vdev Id
  540. *
  541. * This function logs to the DIAG Infrastructure a tracepoint for a
  542. * message being sent from a source module to a destination module
  543. * with a specific ID for the benefit of a specific vdev.
  544. * For non-vdev messages vdev_id will be NO_SESSION
  545. * Return: None
  546. */
  547. void qdf_mtrace_log(QDF_MODULE_ID src_module, QDF_MODULE_ID dst_module,
  548. uint16_t message_id, uint8_t vdev_id);
  549. #else
  550. static inline
  551. void qdf_mtrace_log(QDF_MODULE_ID src_module, QDF_MODULE_ID dst_module,
  552. uint16_t message_id, uint8_t vdev_id)
  553. {
  554. }
  555. #endif
  556. #ifdef TRACE_RECORD
  557. /**
  558. * qdf_mtrace() - puts the messages in to ring-buffer
  559. * and logs a message tracepoint to DIAG Infrastructure.
  560. * @src_module: Enum of source module (basically module id)
  561. * from where the message with message_id is posted.
  562. * @dst_module: Enum of destination module (basically module id)
  563. * to which the message with message_id is posted.
  564. * @message_id: Id of the message to be posted
  565. * @vdev_id: Vdev Id
  566. * @data: Actual message contents
  567. *
  568. * This function will be called from each module which wants to record the
  569. * messages in circular queue. Before calling this function make sure you
  570. * have registered your module with qdf through qdf_trace_register function.
  571. * In addition of the recording the messages in circular queue this function
  572. * will log the message tracepoint to the DIAG infrastructure.
  573. * these logs will be later used by post processing script.
  574. *
  575. * Return: None
  576. */
  577. void qdf_mtrace(QDF_MODULE_ID src_module, QDF_MODULE_ID dst_module,
  578. uint16_t message_id, uint8_t vdev_id, uint32_t data);
  579. #else
  580. static inline
  581. void qdf_mtrace(QDF_MODULE_ID src_module, QDF_MODULE_ID dst_module,
  582. uint16_t message_id, uint8_t vdev_id, uint32_t data)
  583. {
  584. }
  585. #endif
  586. #ifdef CONFIG_DP_TRACE
  587. void qdf_dp_set_proto_bitmap(uint32_t val);
  588. void qdf_dp_trace_set_verbosity(uint32_t val);
  589. void qdf_dp_set_no_of_record(uint32_t val);
  590. #define QDF_DP_TRACE_RECORD_INFO_LIVE (0x1)
  591. #define QDF_DP_TRACE_RECORD_INFO_THROTTLED (0x1 << 1)
  592. /**
  593. * qdf_dp_trace_log_pkt() - log packet type enabled through iwpriv
  594. * @vdev_id: vdev_id
  595. * @skb: skb pointer
  596. * @dir: direction
  597. * @pdev_id: pdev_id
  598. *
  599. * Return: true: some protocol was logged, false: no protocol was logged.
  600. */
  601. bool qdf_dp_trace_log_pkt(uint8_t vdev_id, struct sk_buff *skb,
  602. enum qdf_proto_dir dir, uint8_t pdev_id);
  603. void qdf_dp_trace_init(bool live_mode_config, uint8_t thresh,
  604. uint16_t time_limit, uint8_t verbosity,
  605. uint32_t proto_bitmap);
  606. void qdf_dp_trace_deinit(void);
  607. void qdf_dp_trace_spin_lock_init(void);
  608. void qdf_dp_trace_set_value(uint32_t proto_bitmap, uint8_t no_of_records,
  609. uint8_t verbosity);
  610. void qdf_dp_trace_set_track(qdf_nbuf_t nbuf, enum qdf_proto_dir dir);
  611. void qdf_dp_trace(qdf_nbuf_t nbuf, enum QDF_DP_TRACE_ID code, uint8_t pdev_id,
  612. uint8_t *data, uint8_t size, enum qdf_proto_dir dir);
  613. void qdf_dp_trace_dump_all(uint32_t count, uint8_t pdev_id);
  614. /**
  615. * qdf_dpt_get_curr_pos_debugfs() - get curr position to start read
  616. * @file: debugfs file to read
  617. * @state: state to control read to debugfs file
  618. *
  619. * Return: curr pos
  620. */
  621. uint32_t qdf_dpt_get_curr_pos_debugfs(qdf_debugfs_file_t file,
  622. enum qdf_dpt_debugfs_state state);
  623. /**
  624. * qdf_dpt_dump_stats_debugfs() - dump DP Trace stats to debugfs file
  625. * @file: debugfs file to read
  626. * @curr_pos: curr position to start read
  627. *
  628. * Return: QDF_STATUS
  629. */
  630. QDF_STATUS qdf_dpt_dump_stats_debugfs(qdf_debugfs_file_t file,
  631. uint32_t curr_pos);
  632. /**
  633. * qdf_dpt_set_value_debugfs() - set value of DP Trace debugfs params
  634. * @proto_bitmap: defines which protocol to be traced
  635. * @no_of_record: defines every nth packet to be traced
  636. * @verbosity : defines verbosity level
  637. * @num_records_to_dump: defines number of records to be dumped
  638. *
  639. * Return: none
  640. */
  641. void qdf_dpt_set_value_debugfs(uint8_t proto_bitmap, uint8_t no_of_record,
  642. uint8_t verbosity, uint16_t num_records_to_dump);
  643. /**
  644. * qdf_dp_trace_dump_stats() - dump DP Trace stats
  645. *
  646. * Return: none
  647. */
  648. void qdf_dp_trace_dump_stats(void);
  649. typedef void (*tp_qdf_dp_trace_cb)(struct qdf_dp_trace_record_s*,
  650. uint16_t, uint8_t, uint8_t info);
  651. /**
  652. * qdf_dp_display_record() - Displays a record in DP trace
  653. * @record: pointer to a record in DP trace
  654. * @index: record index
  655. * @pdev_id: pdev id for the mgmt pkt
  656. * @info: info used to display pkt (live mode, throttling)
  657. *
  658. * Return: None
  659. */
  660. void qdf_dp_display_record(struct qdf_dp_trace_record_s *record,
  661. uint16_t index, uint8_t pdev_id,
  662. uint8_t info);
  663. /**
  664. * qdf_dp_display_ptr_record() - display record
  665. * @record: dptrace record
  666. * @rec_index: index
  667. * @pdev_id: pdev id for the mgmt pkt
  668. * @info: info used to display pkt (live mode, throttling)
  669. *
  670. * Return: none
  671. */
  672. void qdf_dp_display_ptr_record(struct qdf_dp_trace_record_s *record,
  673. uint16_t rec_index, uint8_t pdev_id,
  674. uint8_t info);
  675. /**
  676. * qdf_dp_display_proto_pkt() - display proto packet
  677. * @record: dptrace record
  678. * @index: index
  679. * @pdev_id: pdev id for the mgmt pkt
  680. * @info: info used to display pkt (live mode, throttling)
  681. *
  682. * Return: none
  683. */
  684. void qdf_dp_display_proto_pkt(struct qdf_dp_trace_record_s *record,
  685. uint16_t index, uint8_t pdev_id,
  686. uint8_t info);
  687. /**
  688. * qdf_dp_display_data_pkt_record() - Displays a data packet in DP trace
  689. * @record: pointer to a record in DP trace
  690. * @rec_index: record index
  691. * @pdev_id: pdev id
  692. * @info: display info regarding record
  693. *
  694. * Return: None
  695. */
  696. void
  697. qdf_dp_display_data_pkt_record(struct qdf_dp_trace_record_s *record,
  698. uint16_t rec_index, uint8_t pdev_id,
  699. uint8_t info);
  700. void qdf_dp_trace_ptr(qdf_nbuf_t nbuf, enum QDF_DP_TRACE_ID code,
  701. uint8_t pdev_id, uint8_t *data, uint8_t size,
  702. uint16_t msdu_id, uint16_t status);
  703. void qdf_dp_trace_throttle_live_mode(bool high_bw_request);
  704. /**
  705. * qdf_dp_trace_tput_policy() - Change verbosity based on the TPUT
  706. * @is_data_traffic: Is traffic more than low TPUT threashould
  707. *
  708. * Return: None
  709. */
  710. void qdf_dp_trace_apply_tput_policy(bool is_data_traffic);
  711. /**
  712. * qdf_dp_trace_data_pkt() - trace data packet
  713. * @nbuf: nbuf which needs to be traced
  714. * @pdev_id: pdev_id
  715. * @code: QDF_DP_TRACE_ID for the packet (TX or RX)
  716. * @msdu_id: tx desc id for the nbuf (Only applies to TX packets)
  717. * @dir: TX or RX packet direction
  718. *
  719. * Return: None
  720. */
  721. void qdf_dp_trace_data_pkt(qdf_nbuf_t nbuf, uint8_t pdev_id,
  722. enum QDF_DP_TRACE_ID code, uint16_t msdu_id,
  723. enum qdf_proto_dir dir);
  724. uint32_t qdf_dp_get_proto_bitmap(void);
  725. uint8_t qdf_dp_get_verbosity(void);
  726. uint8_t qdf_dp_get_no_of_record(void);
  727. /**
  728. * qdf_dp_trace_proto_pkt() - record proto packet
  729. * @code: dptrace code
  730. * @vdev_id: vdev id
  731. * @sa: source mac address
  732. * @da: destination mac address
  733. * @type: proto type
  734. * @subtype: proto subtype
  735. * @dir: direction
  736. * @pdev_id: pdev id
  737. * @print: to print this proto pkt or not
  738. *
  739. * Return: none
  740. */
  741. void
  742. qdf_dp_trace_proto_pkt(enum QDF_DP_TRACE_ID code, uint8_t vdev_id,
  743. uint8_t *sa, uint8_t *da, enum qdf_proto_type type,
  744. enum qdf_proto_subtype subtype, enum qdf_proto_dir dir,
  745. uint8_t pdev_id, bool print);
  746. void qdf_dp_trace_disable_live_mode(void);
  747. void qdf_dp_trace_enable_live_mode(void);
  748. void qdf_dp_trace_clear_buffer(void);
  749. /**
  750. * qdf_dp_trace_mgmt_pkt() - record mgmt packet
  751. * @code: dptrace code
  752. * @vdev_id: vdev id
  753. * @pdev_id: pdev_id
  754. * @type: proto type
  755. * @subtype: proto subtype
  756. *
  757. * Return: none
  758. */
  759. void qdf_dp_trace_mgmt_pkt(enum QDF_DP_TRACE_ID code, uint8_t vdev_id,
  760. uint8_t pdev_id, enum qdf_proto_type type,
  761. enum qdf_proto_subtype subtype);
  762. /**
  763. * qdf_dp_trace_credit_record() - record credit update
  764. * @source: source of record
  765. * @operation: credit operation
  766. * @delta: credit delta
  767. * @total_credits: total credit
  768. * @g0_credit: group 0 credit
  769. * @g1_credit: group 1 credit
  770. */
  771. void qdf_dp_trace_credit_record(enum QDF_CREDIT_UPDATE_SOURCE source,
  772. enum QDF_CREDIT_OPERATION operation,
  773. int delta, int total_credits,
  774. int g0_credit, int g1_credit);
  775. /**
  776. * qdf_dp_display_mgmt_pkt() - display proto packet
  777. * @record: dptrace record
  778. * @index: index
  779. * @pdev_id: pdev id for the mgmt pkt
  780. * @info: info used to display pkt (live mode, throttling)
  781. *
  782. * Return: none
  783. */
  784. void qdf_dp_display_mgmt_pkt(struct qdf_dp_trace_record_s *record,
  785. uint16_t index, uint8_t pdev_id, uint8_t info);
  786. /**
  787. * qdf_dp_display_credit_record() - display credit record
  788. * @record: dptrace record
  789. * @index: index
  790. * @pdev_id: pdev id
  791. * @info: metadeta info
  792. */
  793. void qdf_dp_display_credit_record(struct qdf_dp_trace_record_s *record,
  794. uint16_t index, uint8_t pdev_id,
  795. uint8_t info);
  796. /**
  797. * qdf_dp_display_event_record() - display event records
  798. * @record: dptrace record
  799. * @index: index
  800. * @pdev_id: pdev id for the mgmt pkt
  801. * @info: info used to display pkt (live mode, throttling)
  802. *
  803. * Return: none
  804. */
  805. void qdf_dp_display_event_record(struct qdf_dp_trace_record_s *record,
  806. uint16_t index, uint8_t pdev_id, uint8_t info);
  807. void qdf_dp_trace_record_event(enum QDF_DP_TRACE_ID code, uint8_t vdev_id,
  808. uint8_t pdev_id, enum qdf_proto_type type,
  809. enum qdf_proto_subtype subtype);
  810. #else
  811. static inline
  812. bool qdf_dp_trace_log_pkt(uint8_t vdev_id, struct sk_buff *skb,
  813. enum qdf_proto_dir dir, uint8_t pdev_id)
  814. {
  815. return false;
  816. }
  817. static inline
  818. void qdf_dp_trace_init(bool live_mode_config, uint8_t thresh,
  819. uint16_t time_limit, uint8_t verbosity,
  820. uint32_t proto_bitmap)
  821. {
  822. }
  823. static inline
  824. void qdf_dp_trace_deinit(void)
  825. {
  826. }
  827. static inline
  828. void qdf_dp_trace_set_track(qdf_nbuf_t nbuf, enum qdf_proto_dir dir)
  829. {
  830. }
  831. static inline
  832. void qdf_dp_trace_set_value(uint32_t proto_bitmap, uint8_t no_of_records,
  833. uint8_t verbosity)
  834. {
  835. }
  836. static inline
  837. void qdf_dp_trace_dump_all(uint32_t count, uint8_t pdev_id)
  838. {
  839. }
  840. static inline
  841. uint32_t qdf_dpt_get_curr_pos_debugfs(qdf_debugfs_file_t file,
  842. enum qdf_dpt_debugfs_state state)
  843. {
  844. return 0;
  845. }
  846. static inline
  847. QDF_STATUS qdf_dpt_dump_stats_debugfs(qdf_debugfs_file_t file,
  848. uint32_t curr_pos)
  849. {
  850. return QDF_STATUS_SUCCESS;
  851. }
  852. static inline
  853. void qdf_dpt_set_value_debugfs(uint8_t proto_bitmap, uint8_t no_of_record,
  854. uint8_t verbosity, uint16_t num_records_to_dump)
  855. {
  856. }
  857. static inline void qdf_dp_trace_dump_stats(void)
  858. {
  859. }
  860. static inline
  861. void qdf_dp_trace_disable_live_mode(void)
  862. {
  863. }
  864. static inline
  865. void qdf_dp_trace_enable_live_mode(void)
  866. {
  867. }
  868. static inline
  869. void qdf_dp_trace_throttle_live_mode(bool high_bw_request)
  870. {
  871. }
  872. static inline
  873. void qdf_dp_trace_clear_buffer(void)
  874. {
  875. }
  876. static inline
  877. void qdf_dp_trace_apply_tput_policy(bool is_data_traffic)
  878. {
  879. }
  880. static inline
  881. void qdf_dp_trace_data_pkt(qdf_nbuf_t nbuf, uint8_t pdev_id,
  882. enum QDF_DP_TRACE_ID code, uint16_t msdu_id,
  883. enum qdf_proto_dir dir)
  884. {
  885. }
  886. #endif
  887. void qdf_trace_display(void);
  888. void __printf(3, 4) qdf_snprintf(char *str_buffer, unsigned int size,
  889. char *str_format, ...);
  890. #define QDF_SNPRINTF qdf_snprintf
  891. #ifdef TSOSEG_DEBUG
  892. static inline void qdf_tso_seg_dbg_bug(char *msg)
  893. {
  894. qdf_print("%s", msg);
  895. QDF_BUG(0);
  896. };
  897. /**
  898. * qdf_tso_seg_dbg_init - initialize TSO segment debug structure
  899. * @tsoseg : structure to initialize
  900. *
  901. * TSO segment dbg structures are attached to qdf_tso_seg_elem_t
  902. * structures and are allocated only of TSOSEG_DEBUG is defined.
  903. * When allocated, at the time of the tso_seg_pool initialization,
  904. * which goes with tx_desc initialization (1:1), each structure holds
  905. * a number of (currently 16) history entries, basically describing
  906. * what operation has been performed on this particular tso_seg_elem.
  907. * This history buffer is a circular buffer and the current index is
  908. * held in an atomic variable called cur. It is incremented every
  909. * operation. Each of these operations are added with the function
  910. * qdf_tso_seg_dbg_record.
  911. * For each segment, this initialization function MUST be called PRIOR
  912. * TO any _dbg_record() function calls.
  913. * On free, qdf_tso_seg_elem structure is cleared (using qdf_tso_seg_dbg_zero)
  914. * which clears the tso_desc, BUT DOES NOT CLEAR THE HISTORY element.
  915. *
  916. * Return:
  917. * None
  918. */
  919. static inline
  920. void qdf_tso_seg_dbg_init(struct qdf_tso_seg_elem_t *tsoseg)
  921. {
  922. tsoseg->dbg.txdesc = NULL;
  923. qdf_atomic_init(&tsoseg->dbg.cur); /* history empty */
  924. }
  925. /**
  926. * qdf_tso_seg_dbg_record - add a history entry to TSO debug structure
  927. * @tsoseg : structure to initialize
  928. * @id : operation ID (identifies the caller)
  929. *
  930. * Adds a history entry to the history circular buffer. Each entry
  931. * contains an operation id (caller, as currently each ID is used only
  932. * once in the source, so it directly identifies the src line that invoked
  933. * the recording.
  934. *
  935. * qdf_tso_seg_dbg_record CAN ONLY BE CALLED AFTER the entry is initialized
  936. * by qdf_tso_seg_dbg_init.
  937. *
  938. * The entry to be added is written at the location pointed by the atomic
  939. * variable called cur. Cur is an ever increasing atomic variable. It is
  940. * masked so that only the lower 4 bits are used (16 history entries).
  941. *
  942. * Return:
  943. * int: the entry this record was recorded at
  944. */
  945. static inline
  946. int qdf_tso_seg_dbg_record(struct qdf_tso_seg_elem_t *tsoseg, short id)
  947. {
  948. int rc = -1;
  949. unsigned int c;
  950. qdf_assert(tsoseg);
  951. if (id == TSOSEG_LOC_ALLOC) {
  952. c = qdf_atomic_read(&tsoseg->dbg.cur);
  953. /* dont crash on the very first alloc on the segment */
  954. c &= 0x0f;
  955. /* allow only INIT and FREE ops before ALLOC */
  956. if (tsoseg->dbg.h[c].id >= id)
  957. qdf_tso_seg_dbg_bug("Rogue TSO seg alloc");
  958. }
  959. c = qdf_atomic_inc_return(&tsoseg->dbg.cur);
  960. c &= 0x0f;
  961. tsoseg->dbg.h[c].ts = qdf_get_log_timestamp();
  962. tsoseg->dbg.h[c].id = id;
  963. rc = c;
  964. return rc;
  965. };
  966. static inline void
  967. qdf_tso_seg_dbg_setowner(struct qdf_tso_seg_elem_t *tsoseg, void *owner)
  968. {
  969. if (tsoseg)
  970. tsoseg->dbg.txdesc = owner;
  971. };
  972. static inline void
  973. qdf_tso_seg_dbg_zero(struct qdf_tso_seg_elem_t *tsoseg)
  974. {
  975. memset(tsoseg, 0, offsetof(struct qdf_tso_seg_elem_t, dbg));
  976. return;
  977. };
  978. #else
  979. static inline
  980. void qdf_tso_seg_dbg_init(struct qdf_tso_seg_elem_t *tsoseg)
  981. {
  982. };
  983. static inline
  984. int qdf_tso_seg_dbg_record(struct qdf_tso_seg_elem_t *tsoseg, short id)
  985. {
  986. return 0;
  987. };
  988. static inline void qdf_tso_seg_dbg_bug(char *msg)
  989. {
  990. };
  991. static inline void
  992. qdf_tso_seg_dbg_setowner(struct qdf_tso_seg_elem_t *tsoseg, void *owner)
  993. {
  994. };
  995. static inline int
  996. qdf_tso_seg_dbg_zero(struct qdf_tso_seg_elem_t *tsoseg)
  997. {
  998. memset(tsoseg, 0, sizeof(struct qdf_tso_seg_elem_t));
  999. return 0;
  1000. };
  1001. #endif /* TSOSEG_DEBUG */
  1002. /**
  1003. * qdf_trace_hex_dump() - externally called hex dump function
  1004. * @module: Module identifier a member of the QDF_MODULE_ID enumeration that
  1005. * identifies the module issuing the trace message.
  1006. * @level: Trace level a member of the QDF_TRACE_LEVEL enumeration indicating
  1007. * the severity of the condition causing the trace message to be
  1008. * issued. More severe conditions are more likely to be logged.
  1009. * @data: The base address of the buffer to be logged.
  1010. * @buf_len: The size of the buffer to be logged.
  1011. *
  1012. * Checks the level of severity and accordingly prints the trace messages
  1013. *
  1014. * Return: None
  1015. */
  1016. void qdf_trace_hex_dump(QDF_MODULE_ID module, QDF_TRACE_LEVEL level,
  1017. void *data, int buf_len);
  1018. /**
  1019. * qdf_trace_hex_ascii_dump() - externally called hex and ascii dump function
  1020. * @module: Module identifier a member of the QDF_MODULE_ID enumeration that
  1021. * identifies the module issuing the trace message.
  1022. * @level: Trace level a member of the QDF_TRACE_LEVEL enumeration indicating
  1023. * the severity of the condition causing the trace message to be
  1024. * issued. More severe conditions are more likely to be logged.
  1025. * @data: The base address of the buffer to be logged.
  1026. * @buf_len: The size of the buffer to be logged.
  1027. *
  1028. * Checks the level of severity and accordingly prints the trace messages
  1029. *
  1030. * Return: None
  1031. */
  1032. void qdf_trace_hex_ascii_dump(QDF_MODULE_ID module, QDF_TRACE_LEVEL level,
  1033. void *data, int buf_len);
  1034. #define ERROR_CODE -1
  1035. #define QDF_MAX_NAME_SIZE 32
  1036. #define MAX_PRINT_CONFIG_SUPPORTED 32
  1037. #define MAX_SUPPORTED_CATEGORY QDF_MODULE_ID_MAX
  1038. /**
  1039. * qdf_set_pidx() - Sets the global qdf_pidx.
  1040. * @pidx : Index of print control object assigned to the module
  1041. *
  1042. */
  1043. void qdf_set_pidx(int pidx);
  1044. /**
  1045. * qdf_get_pidx() - Returns the global qdf_pidx.
  1046. *
  1047. * Return : Current qdf print index.
  1048. */
  1049. int qdf_get_pidx(void);
  1050. /*
  1051. * Shared print control index
  1052. * for converged debug framework
  1053. */
  1054. #define QDF_PRINT_IDX_SHARED -1
  1055. /**
  1056. * QDF_PRINT_INFO() - Generic wrapper API for logging
  1057. * @idx : Index of print control object
  1058. * @module : Module identifier. A member of QDF_MODULE_ID enumeration that
  1059. * identifies the module issuing the trace message
  1060. * @level : Trace level. A member of QDF_TRACE_LEVEL enumeration indicating
  1061. * the severity of the condition causing the trace message to be
  1062. * issued.
  1063. * @str_format : Format string that contains the message to be logged.
  1064. *
  1065. *
  1066. * This wrapper will be used for any generic logging messages. Wrapper will
  1067. * compile a call to converged QDF trace message API.
  1068. *
  1069. * Return : Nothing
  1070. *
  1071. */
  1072. void QDF_PRINT_INFO(unsigned int idx, QDF_MODULE_ID module,
  1073. QDF_TRACE_LEVEL level,
  1074. char *str_format, ...);
  1075. /**
  1076. * struct category_info : Category information structure
  1077. * @category_verbose_mask: Embeds information about category's verbose level
  1078. */
  1079. struct category_info {
  1080. uint16_t category_verbose_mask;
  1081. };
  1082. /**
  1083. * struct category_name_info : Category name information structure
  1084. * @category_name_str: Embeds information about category name
  1085. */
  1086. struct category_name_info {
  1087. unsigned char category_name_str[QDF_MAX_NAME_SIZE];
  1088. };
  1089. /**
  1090. * qdf_trace_msg_cmn()- Converged logging API
  1091. * @idx: Index of print control object assigned to the module
  1092. * @category: Category identifier. A member of the QDF_MODULE_ID enumeration
  1093. * that identifies the category issuing the trace message.
  1094. * @verbose: Verbose level. A member of the QDF_TRACE_LEVEL enumeration
  1095. * indicating the severity of the condition causing the trace
  1096. * message to be issued. More severe conditions are more likely
  1097. * to be logged.
  1098. * @str_format: Format string. The message to be logged. This format string
  1099. * contains printf-like replacement parameters, which follow this
  1100. * parameter in the variable argument list.
  1101. * @val: Variable argument list part of the log message
  1102. *
  1103. * Return: nothing
  1104. *
  1105. */
  1106. void qdf_trace_msg_cmn(unsigned int idx,
  1107. QDF_MODULE_ID category,
  1108. QDF_TRACE_LEVEL verbose,
  1109. const char *str_format,
  1110. va_list val);
  1111. /**
  1112. * struct qdf_print_ctrl: QDF Print Control structure
  1113. * Statically allocated objects of print control
  1114. * structure are declared that will support maximum of
  1115. * 32 print control objects. Any module that needs to
  1116. * register to the print control framework needs to
  1117. * obtain a print control object using
  1118. * qdf_print_ctrl_register API. It will have to pass
  1119. * pointer to category info structure, name and
  1120. * custom print function to be used if required.
  1121. * @name : Optional name for the control object
  1122. * @cat_info : Array of category_info struct
  1123. * @custom_print : Custom print handler
  1124. * @custom_ctxt : Custom print context
  1125. * @dbglvlmac_on : Flag to enable/disable MAC level filtering
  1126. * @in_use : Boolean to indicate if control object is in use
  1127. */
  1128. struct qdf_print_ctrl {
  1129. char name[QDF_MAX_NAME_SIZE];
  1130. struct category_info cat_info[MAX_SUPPORTED_CATEGORY];
  1131. void (*custom_print)(void *ctxt, const char *fmt, va_list args);
  1132. void *custom_ctxt;
  1133. #ifdef DBG_LVL_MAC_FILTERING
  1134. unsigned char dbglvlmac_on;
  1135. #endif
  1136. bool in_use;
  1137. };
  1138. /**
  1139. * qdf_print_ctrl_register() - Allocate QDF print control object, assign
  1140. * pointer to category info or print control
  1141. * structure and return the index to the callee
  1142. * @cinfo : Pointer to array of category info structure
  1143. * @custom_print_handler : Pointer to custom print handler
  1144. * @custom_ctx : Pointer to custom context
  1145. * @pctrl_name : Pointer to print control object name
  1146. *
  1147. * Return : Index of qdf_print_ctrl structure
  1148. *
  1149. */
  1150. int qdf_print_ctrl_register(const struct category_info *cinfo,
  1151. void *custom_print_handler,
  1152. void *custom_ctx,
  1153. const char *pctrl_name);
  1154. /**
  1155. * qdf_shared_print_ctrl_init() - Initialize the shared print ctrl obj with
  1156. * all categories set to the default level
  1157. *
  1158. * Return : void
  1159. *
  1160. */
  1161. void qdf_shared_print_ctrl_init(void);
  1162. /**
  1163. * qdf_print_setup() - Setup default values to all the print control objects
  1164. *
  1165. * Register new print control object for the callee
  1166. *
  1167. * Return : QDF_STATUS_SUCCESS on success and QDF_STATUS_E_FAILURE
  1168. * on failure
  1169. */
  1170. QDF_STATUS qdf_print_setup(void);
  1171. /**
  1172. * qdf_print_ctrl_cleanup() - Clean up a print control object
  1173. *
  1174. * Cleanup the print control object for the callee
  1175. *
  1176. * @pctrl : Index of print control object
  1177. *
  1178. * Return : QDF_STATUS_SUCCESS on success and QDF_STATUS_E_FAILURE on failure
  1179. */
  1180. QDF_STATUS qdf_print_ctrl_cleanup(unsigned int idx);
  1181. /**
  1182. * qdf_print_ctrl_shared_cleanup() - Clean up of the shared object
  1183. *
  1184. * Cleanup the shared print-ctrl-object
  1185. *
  1186. * Return : void
  1187. */
  1188. void qdf_shared_print_ctrl_cleanup(void);
  1189. /**
  1190. * qdf_print_set_category_verbose() - Enable/Disable category for a
  1191. * print control object with
  1192. * user provided verbose level
  1193. *
  1194. * @idx : Index of the print control object assigned to callee
  1195. * @category : Category information
  1196. * @verbose: Verbose information
  1197. * @is_set: Flag indicating if verbose level needs to be enabled or disabled
  1198. *
  1199. * Return : QDF_STATUS_SUCCESS for success and QDF_STATUS_E_FAILURE for failure
  1200. */
  1201. QDF_STATUS qdf_print_set_category_verbose(unsigned int idx,
  1202. QDF_MODULE_ID category,
  1203. QDF_TRACE_LEVEL verbose,
  1204. bool is_set);
  1205. /**
  1206. * qdf_log_dump_at_kernel_level() - Enable/Disable printk call
  1207. * @enable: Indicates whether printk is enabled in QDF_TRACE
  1208. *
  1209. * Return: void
  1210. */
  1211. void qdf_log_dump_at_kernel_level(bool enable);
  1212. /**
  1213. * qdf_logging_set_flush_timer() - Set the time period in which host logs
  1214. * should be flushed out to user-space
  1215. * @milliseconds: milliseconds after which the logs should be flushed out to
  1216. * user-space
  1217. *
  1218. * Return: QDF_STATUS_SUCCESS for success and QDF_STATUS_E_FAILURE for failure
  1219. */
  1220. int qdf_logging_set_flush_timer(uint32_t milliseconds);
  1221. /**
  1222. * qdf_logging_flush_logs() - Flush out the logs to user-space one time
  1223. *
  1224. * Return: void
  1225. */
  1226. void qdf_logging_flush_logs(void);
  1227. /**
  1228. * qdf_print_is_category_enabled() - Get category information for the
  1229. * print control object
  1230. *
  1231. * @idx : Index of print control object
  1232. * @category : Category information
  1233. *
  1234. * Return : Verbose enabled(true) or disabled(false) or invalid input (false)
  1235. */
  1236. bool qdf_print_is_category_enabled(unsigned int idx,
  1237. QDF_MODULE_ID category);
  1238. /**
  1239. * qdf_print_is_verbose_enabled() - Get verbose information of a category for
  1240. * the print control object
  1241. *
  1242. * @idx : Index of print control object
  1243. * @category : Category information
  1244. * @verbose : Verbose information
  1245. *
  1246. * Return : Verbose enabled(true) or disabled(false) or invalid input (false)
  1247. */
  1248. bool qdf_print_is_verbose_enabled(unsigned int idx,
  1249. QDF_MODULE_ID category,
  1250. QDF_TRACE_LEVEL verbose);
  1251. /**
  1252. * qdf_print_clean_node_flag() - Clean up node flag for print control object
  1253. *
  1254. * @idx : Index of print control object
  1255. *
  1256. * Return : None
  1257. */
  1258. void qdf_print_clean_node_flag(unsigned int idx);
  1259. #ifdef DBG_LVL_MAC_FILTERING
  1260. /**
  1261. * qdf_print_set_node_flag() - Set flag to enable MAC level filtering
  1262. *
  1263. * @idx : Index of print control object
  1264. * @enable : Enable/Disable bit sent by callee
  1265. *
  1266. * Return : QDF_STATUS_SUCCESS on Success and QDF_STATUS_E_FAILURE on Failure
  1267. */
  1268. QDF_STATUS qdf_print_set_node_flag(unsigned int idx,
  1269. uint8_t enable);
  1270. /**
  1271. * qdf_print_get_node_flag() - Get flag that controls MAC level filtering
  1272. *
  1273. * @idx : Index of print control object
  1274. *
  1275. * Return : Flag that indicates enable(1) or disable(0) or invalid(-1)
  1276. */
  1277. bool qdf_print_get_node_flag(unsigned int idx);
  1278. #endif
  1279. /**
  1280. * qdf_logging_init() - Initialize msg logging functionality
  1281. *
  1282. *
  1283. * Return : void
  1284. */
  1285. void qdf_logging_init(void);
  1286. /**
  1287. * qdf_logging_exit() - Cleanup msg logging functionality
  1288. *
  1289. *
  1290. * Return : void
  1291. */
  1292. void qdf_logging_exit(void);
  1293. #define QDF_SYMBOL_LEN __QDF_SYMBOL_LEN
  1294. /**
  1295. * qdf_sprint_symbol() - prints the name of a symbol into a string buffer
  1296. * @buffer: the string buffer to print into
  1297. * @addr: address of the symbol to lookup and print
  1298. *
  1299. * Return: number of characters printed
  1300. */
  1301. int qdf_sprint_symbol(char *buffer, void *addr);
  1302. /**
  1303. * qdf_minidump_log() - Log memory address to be included in minidump
  1304. * @start_addr: Start address of the memory to be dumped
  1305. * @size: Size in bytes
  1306. * @name: String to identify this entry
  1307. */
  1308. static inline
  1309. void qdf_minidump_log(void *start_addr, size_t size, const char *name)
  1310. {
  1311. __qdf_minidump_log(start_addr, size, name);
  1312. }
  1313. /**
  1314. * qdf_minidump_remove() - Remove memory address from minidump
  1315. * @addr: Start address of the memory previously added
  1316. */
  1317. static inline
  1318. void qdf_minidump_remove(void *addr)
  1319. {
  1320. __qdf_minidump_remove(addr);
  1321. }
  1322. #endif /* __QDF_TRACE_H */