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