qdf_trace.h 44 KB

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