qdf_trace.h 38 KB

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