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