1 /* 2 * Debug/trace/assert driver definitions for Dongle Host Driver. 3 * 4 * Copyright (C) 1999-2019, Broadcom. 5 * 6 * Unless you and Broadcom execute a separate written software license 7 * agreement governing use of this software, this software is licensed to you 8 * under the terms of the GNU General Public License version 2 (the "GPL"), 9 * available at http://www.broadcom.com/licenses/GPLv2.php, with the 10 * following added to such license: 11 * 12 * As a special exception, the copyright holders of this software give you 13 * permission to link this software with independent modules, and to copy and 14 * distribute the resulting executable under terms of your choice, provided that 15 * you also meet, for each linked independent module, the terms and conditions 16 * of the license of that module. An independent module is a module which is 17 * not derived from this software. The special exception does not apply to any 18 * modifications of the software. 19 * 20 * Notwithstanding the above, under no circumstances may you combine this 21 * software in any way with any other Broadcom software provided under a license 22 * other than the GPL, without Broadcom's express prior written consent. 23 * 24 * 25 * <<Broadcom-WL-IPTag/Open:>> 26 * 27 * $Id: dhd_dbg.h 798329 2019-01-08 05:40:39Z $ 28 */ 29 30 #ifndef _dhd_dbg_ 31 #define _dhd_dbg_ 32 33 #ifdef DHD_LOG_DUMP 34 extern char *dhd_log_dump_get_timestamp(void); 35 extern void dhd_log_dump_write(int type, char *binary_data, int binary_len, 36 const char *fmt, ...); 37 #ifndef _DHD_LOG_DUMP_DEFINITIONS_ 38 #define _DHD_LOG_DUMP_DEFINITIONS_ 39 #define GENERAL_LOG_HDR \ 40 "\n-------------------- General log ---------------------------\n" 41 #define PRESERVE_LOG_HDR \ 42 "\n-------------------- Preserve log ---------------------------\n" 43 #define SPECIAL_LOG_HDR \ 44 "\n-------------------- Special log ---------------------------\n" 45 #define DHD_DUMP_LOG_HDR \ 46 "\n-------------------- 'dhd dump' log -----------------------\n" 47 #define EXT_TRAP_LOG_HDR \ 48 "\n-------------------- Extended trap data -------------------\n" 49 #define HEALTH_CHK_LOG_HDR \ 50 "\n-------------------- Health check data --------------------\n" 51 #ifdef DHD_DUMP_PCIE_RINGS 52 #define FLOWRING_DUMP_HDR \ 53 "\n-------------------- Flowring dump --------------------\n" 54 #endif /* DHD_DUMP_PCIE_RINGS */ 55 #define DHD_LOG_DUMP_WRITE(fmt, ...) \ 56 dhd_log_dump_write(DLD_BUF_TYPE_GENERAL, NULL, 0, fmt, ##__VA_ARGS__) 57 #define DHD_LOG_DUMP_WRITE_EX(fmt, ...) \ 58 dhd_log_dump_write(DLD_BUF_TYPE_SPECIAL, NULL, 0, fmt, ##__VA_ARGS__) 59 #define DHD_LOG_DUMP_WRITE_PRSRV(fmt, ...) \ 60 dhd_log_dump_write(DLD_BUF_TYPE_PRESERVE, NULL, 0, fmt, ##__VA_ARGS__) 61 #endif /* !_DHD_LOG_DUMP_DEFINITIONS_ */ 62 #define CONCISE_DUMP_BUFLEN 16 * 1024 63 #define ECNTRS_LOG_HDR \ 64 "\n-------------------- Ecounters log --------------------------\n" 65 #ifdef DHD_STATUS_LOGGING 66 #define STATUS_LOG_HDR \ 67 "\n-------------------- Status log -----------------------\n" 68 #endif /* DHD_STATUS_LOGGING */ 69 #define RTT_LOG_HDR \ 70 "\n-------------------- RTT log --------------------------\n" 71 #define COOKIE_LOG_HDR \ 72 "\n-------------------- Cookie List ----------------------------\n" 73 #endif /* DHD_LOG_DUMP */ 74 75 #if defined(DHD_DEBUG) 76 77 /* NON-NDIS cases */ 78 #ifdef DHD_LOG_DUMP 79 /* Common case for EFI and non EFI */ 80 #define DHD_ERROR(args) \ 81 do { \ 82 if (dhd_msg_level & DHD_ERROR_VAL) { \ 83 printf args; \ 84 DHD_LOG_DUMP_WRITE("[%s]: ", dhd_log_dump_get_timestamp()); \ 85 DHD_LOG_DUMP_WRITE args; \ 86 } \ 87 } while (0) 88 89 /* !defined(DHD_EFI) and defined(DHD_LOG_DUMP) */ 90 #define DHD_INFO(args) \ 91 do { \ 92 if (dhd_msg_level & DHD_INFO_VAL) \ 93 printf args; \ 94 } while (0) 95 #else /* DHD_LOG_DUMP */ 96 /* !defined(DHD_LOG_DUMP cases) */ 97 #define DHD_ERROR(args) \ 98 do { \ 99 if (dhd_msg_level & DHD_ERROR_VAL) \ 100 printf args; \ 101 } while (0) 102 #define DHD_INFO(args) \ 103 do { \ 104 if (dhd_msg_level & DHD_INFO_VAL) \ 105 printf args; \ 106 } while (0) 107 #endif /* DHD_LOG_DUMP */ 108 109 #define DHD_TRACE(args) \ 110 do { \ 111 if (dhd_msg_level & DHD_TRACE_VAL) \ 112 printf args; \ 113 } while (0) 114 115 #ifdef DHD_LOG_DUMP 116 /* LOG_DUMP defines common to EFI and NON-EFI */ 117 #define DHD_ERROR_MEM(args) \ 118 do { \ 119 if (dhd_msg_level & DHD_ERROR_VAL) { \ 120 if (dhd_msg_level & DHD_ERROR_MEM_VAL) { \ 121 printf args; \ 122 } \ 123 DHD_LOG_DUMP_WRITE("[%s]: ", dhd_log_dump_get_timestamp()); \ 124 DHD_LOG_DUMP_WRITE args; \ 125 } \ 126 } while (0) 127 #define DHD_IOVAR_MEM(args) \ 128 do { \ 129 if (dhd_msg_level & DHD_ERROR_VAL) { \ 130 if (dhd_msg_level & DHD_IOVAR_MEM_VAL) { \ 131 printf args; \ 132 } \ 133 DHD_LOG_DUMP_WRITE("[%s]: ", dhd_log_dump_get_timestamp()); \ 134 DHD_LOG_DUMP_WRITE args; \ 135 } \ 136 } while (0) 137 #define DHD_LOG_MEM(args) \ 138 do { \ 139 if (dhd_msg_level & DHD_ERROR_VAL) { \ 140 DHD_LOG_DUMP_WRITE("[%s]: ", dhd_log_dump_get_timestamp()); \ 141 DHD_LOG_DUMP_WRITE args; \ 142 } \ 143 } while (0) 144 /* NON-EFI builds with LOG DUMP enabled */ 145 #define DHD_EVENT(args) \ 146 do { \ 147 if (dhd_msg_level & DHD_EVENT_VAL) { \ 148 printf args; \ 149 DHD_LOG_DUMP_WRITE("[%s]: ", dhd_log_dump_get_timestamp()); \ 150 DHD_LOG_DUMP_WRITE args; \ 151 } \ 152 } while (0) 153 #define DHD_PRSRV_MEM(args) \ 154 do { \ 155 if (dhd_msg_level & DHD_EVENT_VAL) { \ 156 if (dhd_msg_level & DHD_PRSRV_MEM_VAL) \ 157 printf args; \ 158 DHD_LOG_DUMP_WRITE_PRSRV("[%s]: ", dhd_log_dump_get_timestamp()); \ 159 DHD_LOG_DUMP_WRITE_PRSRV args; \ 160 } \ 161 } while (0) 162 163 /* Re-using 'DHD_MSGTRACE_VAL' for controlling printing of ecounter binary event 164 * logs to console and debug dump -- need to cleanup in the future to use 165 * separate 'DHD_ECNTR_VAL' bitmap flag. 'DHD_MSGTRACE_VAL' will be defined only 166 * for non-android builds. 167 */ 168 #define DHD_ECNTR_LOG(args) \ 169 do { \ 170 if (dhd_msg_level & DHD_EVENT_VAL) { \ 171 if (dhd_msg_level & DHD_MSGTRACE_VAL) { \ 172 printf args; \ 173 DHD_LOG_DUMP_WRITE("[%s]: ", dhd_log_dump_get_timestamp()); \ 174 DHD_LOG_DUMP_WRITE args; \ 175 } \ 176 } \ 177 } while (0) 178 179 #define DHD_ERROR_EX(args) \ 180 do { \ 181 if (dhd_msg_level & DHD_ERROR_VAL) { \ 182 printf args; \ 183 DHD_LOG_DUMP_WRITE_EX("[%s]: ", dhd_log_dump_get_timestamp()); \ 184 DHD_LOG_DUMP_WRITE_EX args; \ 185 } \ 186 } while (0) 187 188 #define DHD_MSGTRACE_LOG(args) \ 189 do { \ 190 if (dhd_msg_level & DHD_MSGTRACE_VAL) { \ 191 printf args; \ 192 } \ 193 DHD_LOG_DUMP_WRITE("[%s]: ", dhd_log_dump_get_timestamp()); \ 194 DHD_LOG_DUMP_WRITE args; \ 195 } while (0) 196 #else /* DHD_LOG_DUMP */ 197 /* !DHD_LOG_DUMP */ 198 #define DHD_MSGTRACE_LOG(args) \ 199 do { \ 200 if (dhd_msg_level & DHD_MSGTRACE_VAL) \ 201 printf args; \ 202 } while (0) 203 #define DHD_ERROR_MEM(args) DHD_ERROR(args) 204 #define DHD_IOVAR_MEM(args) DHD_ERROR(args) 205 #define DHD_LOG_MEM(args) DHD_ERROR(args) 206 #define DHD_EVENT(args) \ 207 do { \ 208 if (dhd_msg_level & DHD_EVENT_VAL) \ 209 printf args; \ 210 } while (0) 211 #define DHD_ECNTR_LOG(args) DHD_EVENT(args) 212 #define DHD_PRSRV_MEM(args) DHD_EVENT(args) 213 #define DHD_ERROR_EX(args) DHD_ERROR(args) 214 #endif /* DHD_LOG_DUMP */ 215 216 #define DHD_DATA(args) \ 217 do { \ 218 if (dhd_msg_level & DHD_DATA_VAL) \ 219 printf args; \ 220 } while (0) 221 #define DHD_CTL(args) \ 222 do { \ 223 if (dhd_msg_level & DHD_CTL_VAL) \ 224 printf args; \ 225 } while (0) 226 #define DHD_TIMER(args) \ 227 do { \ 228 if (dhd_msg_level & DHD_TIMER_VAL) \ 229 printf args; \ 230 } while (0) 231 #define DHD_HDRS(args) \ 232 do { \ 233 if (dhd_msg_level & DHD_HDRS_VAL) \ 234 printf args; \ 235 } while (0) 236 #define DHD_BYTES(args) \ 237 do { \ 238 if (dhd_msg_level & DHD_BYTES_VAL) \ 239 printf args; \ 240 } while (0) 241 #define DHD_INTR(args) \ 242 do { \ 243 if (dhd_msg_level & DHD_INTR_VAL) \ 244 printf args; \ 245 } while (0) 246 #define DHD_GLOM(args) \ 247 do { \ 248 if (dhd_msg_level & DHD_GLOM_VAL) \ 249 printf args; \ 250 } while (0) 251 #define DHD_BTA(args) \ 252 do { \ 253 if (dhd_msg_level & DHD_BTA_VAL) \ 254 printf args; \ 255 } while (0) 256 #define DHD_ISCAN(args) \ 257 do { \ 258 if (dhd_msg_level & DHD_ISCAN_VAL) \ 259 printf args; \ 260 } while (0) 261 #define DHD_ARPOE(args) \ 262 do { \ 263 if (dhd_msg_level & DHD_ARPOE_VAL) \ 264 printf args; \ 265 } while (0) 266 #define DHD_REORDER(args) \ 267 do { \ 268 if (dhd_msg_level & DHD_REORDER_VAL) \ 269 printf args; \ 270 } while (0) 271 #define DHD_PNO(args) \ 272 do { \ 273 if (dhd_msg_level & DHD_PNO_VAL) \ 274 printf args; \ 275 } while (0) 276 #define DHD_RTT(args) \ 277 do { \ 278 if (dhd_msg_level & DHD_RTT_VAL) \ 279 printf args; \ 280 } while (0) 281 #define DHD_PKT_MON(args) \ 282 do { \ 283 if (dhd_msg_level & DHD_PKT_MON_VAL) \ 284 printf args; \ 285 } while (0) 286 287 #if defined(DHD_LOG_DUMP) 288 #if defined(DHD_LOG_PRINT_RATE_LIMIT) 289 #define DHD_FWLOG(args) \ 290 do { \ 291 if (dhd_msg_level & DHD_FWLOG_VAL) { \ 292 if (!log_print_threshold) \ 293 printf args; \ 294 DHD_LOG_DUMP_WRITE args; \ 295 } \ 296 } while (0) 297 #else 298 #define DHD_FWLOG(args) \ 299 do { \ 300 if (dhd_msg_level & DHD_FWLOG_VAL) { \ 301 printf args; \ 302 DHD_LOG_DUMP_WRITE args; \ 303 } \ 304 } while (0) 305 #endif // endif 306 #else /* DHD_LOG_DUMP */ 307 #define DHD_FWLOG(args) \ 308 do { \ 309 if (dhd_msg_level & DHD_FWLOG_VAL) \ 310 printf args; \ 311 } while (0) 312 #endif /* DHD_LOG_DUMP */ 313 314 #define DHD_DBGIF(args) \ 315 do { \ 316 if (dhd_msg_level & DHD_DBGIF_VAL) \ 317 printf args; \ 318 } while (0) 319 320 #ifdef DHD_PCIE_NATIVE_RUNTIMEPM 321 #define DHD_RPM(args) \ 322 do { \ 323 if (dhd_msg_level & DHD_RPM_VAL) \ 324 printf args; \ 325 } while (0) 326 #endif /* DHD_PCIE_NATIVE_RUNTIMEPM */ 327 328 #define DHD_TRACE_HW4 DHD_TRACE 329 #define DHD_INFO_HW4 DHD_INFO 330 #define DHD_ERROR_NO_HW4 DHD_ERROR 331 332 #define DHD_ERROR_ON() (dhd_msg_level & DHD_ERROR_VAL) 333 #define DHD_TRACE_ON() (dhd_msg_level & DHD_TRACE_VAL) 334 #define DHD_INFO_ON() (dhd_msg_level & DHD_INFO_VAL) 335 #define DHD_DATA_ON() (dhd_msg_level & DHD_DATA_VAL) 336 #define DHD_CTL_ON() (dhd_msg_level & DHD_CTL_VAL) 337 #define DHD_TIMER_ON() (dhd_msg_level & DHD_TIMER_VAL) 338 #define DHD_HDRS_ON() (dhd_msg_level & DHD_HDRS_VAL) 339 #define DHD_BYTES_ON() (dhd_msg_level & DHD_BYTES_VAL) 340 #define DHD_INTR_ON() (dhd_msg_level & DHD_INTR_VAL) 341 #define DHD_GLOM_ON() (dhd_msg_level & DHD_GLOM_VAL) 342 #define DHD_EVENT_ON() (dhd_msg_level & DHD_EVENT_VAL) 343 #define DHD_BTA_ON() (dhd_msg_level & DHD_BTA_VAL) 344 #define DHD_ISCAN_ON() (dhd_msg_level & DHD_ISCAN_VAL) 345 #define DHD_ARPOE_ON() (dhd_msg_level & DHD_ARPOE_VAL) 346 #define DHD_REORDER_ON() (dhd_msg_level & DHD_REORDER_VAL) 347 #define DHD_NOCHECKDIED_ON() (dhd_msg_level & DHD_NOCHECKDIED_VAL) 348 #define DHD_PNO_ON() (dhd_msg_level & DHD_PNO_VAL) 349 #define DHD_RTT_ON() (dhd_msg_level & DHD_RTT_VAL) 350 #define DHD_MSGTRACE_ON() (dhd_msg_level & DHD_MSGTRACE_VAL) 351 #define DHD_FWLOG_ON() (dhd_msg_level & DHD_FWLOG_VAL) 352 #define DHD_DBGIF_ON() (dhd_msg_level & DHD_DBGIF_VAL) 353 #define DHD_PKT_MON_ON() (dhd_msg_level & DHD_PKT_MON_VAL) 354 #define DHD_PKT_MON_DUMP_ON() (dhd_msg_level & DHD_PKT_MON_DUMP_VAL) 355 #ifdef DHD_PCIE_NATIVE_RUNTIMEPM 356 #define DHD_RPM_ON() (dhd_msg_level & DHD_RPM_VAL) 357 #endif /* DHD_PCIE_NATIVE_RUNTIMEPM */ 358 359 #else /* defined(BCMDBG) || defined(DHD_DEBUG) */ 360 361 #define DHD_ERROR(args) \ 362 do { \ 363 if (dhd_msg_level & DHD_ERROR_VAL) \ 364 printf args; \ 365 } while (0) 366 #define DHD_TRACE(args) 367 #define DHD_INFO(args) 368 369 #define DHD_DATA(args) 370 #define DHD_CTL(args) 371 #define DHD_TIMER(args) 372 #define DHD_HDRS(args) 373 #define DHD_BYTES(args) 374 #define DHD_INTR(args) 375 #define DHD_GLOM(args) 376 377 #define DHD_EVENT(args) 378 #define DHD_ECNTR_LOG(args) DHD_EVENT(args) 379 380 #define DHD_PRSRV_MEM(args) DHD_EVENT(args) 381 382 #define DHD_BTA(args) 383 #define DHD_ISCAN(args) 384 #define DHD_ARPOE(args) 385 #define DHD_REORDER(args) 386 #define DHD_PNO(args) 387 #define DHD_RTT(args) 388 #define DHD_PKT_MON(args) 389 390 #define DHD_MSGTRACE_LOG(args) 391 #define DHD_FWLOG(args) 392 393 #define DHD_DBGIF(args) 394 395 #define DHD_ERROR_MEM(args) DHD_ERROR(args) 396 #define DHD_IOVAR_MEM(args) DHD_ERROR(args) 397 #define DHD_LOG_MEM(args) DHD_ERROR(args) 398 #define DHD_ERROR_EX(args) DHD_ERROR(args) 399 400 #define DHD_TRACE_HW4 DHD_TRACE 401 #define DHD_INFO_HW4 DHD_INFO 402 #define DHD_ERROR_NO_HW4 DHD_ERROR 403 404 #define DHD_ERROR_ON() 0 405 #define DHD_TRACE_ON() 0 406 #define DHD_INFO_ON() 0 407 #define DHD_DATA_ON() 0 408 #define DHD_CTL_ON() 0 409 #define DHD_TIMER_ON() 0 410 #define DHD_HDRS_ON() 0 411 #define DHD_BYTES_ON() 0 412 #define DHD_INTR_ON() 0 413 #define DHD_GLOM_ON() 0 414 #define DHD_EVENT_ON() 0 415 #define DHD_BTA_ON() 0 416 #define DHD_ISCAN_ON() 0 417 #define DHD_ARPOE_ON() 0 418 #define DHD_REORDER_ON() 0 419 #define DHD_NOCHECKDIED_ON() 0 420 #define DHD_PNO_ON() 0 421 #define DHD_RTT_ON() 0 422 #define DHD_PKT_MON_ON() 0 423 #define DHD_PKT_MON_DUMP_ON() 0 424 #define DHD_MSGTRACE_ON() 0 425 #define DHD_FWLOG_ON() 0 426 #define DHD_DBGIF_ON() 0 427 #ifdef DHD_PCIE_NATIVE_RUNTIMEPM 428 #define DHD_RPM_ON() 0 429 #endif /* DHD_PCIE_NATIVE_RUNTIMEPM */ 430 #endif // endif 431 432 #define PRINT_RATE_LIMIT_PERIOD 5000000u /* 5s in units of us */ 433 #define DHD_ERROR_RLMT(args) \ 434 do { \ 435 if (dhd_msg_level & DHD_ERROR_VAL) { \ 436 static uint64 __err_ts = 0; \ 437 static uint32 __err_cnt = 0; \ 438 uint64 __cur_ts = 0; \ 439 __cur_ts = OSL_SYSUPTIME_US(); \ 440 if (__err_ts == 0 || \ 441 (__cur_ts > __err_ts && \ 442 (__cur_ts - __err_ts > PRINT_RATE_LIMIT_PERIOD))) { \ 443 __err_ts = __cur_ts; \ 444 DHD_ERROR(args); \ 445 DHD_ERROR(("[Repeats %u times]\n", __err_cnt)); \ 446 __err_cnt = 0; \ 447 } else { \ 448 ++__err_cnt; \ 449 } \ 450 } \ 451 } while (0) 452 453 /* even in non-BCMDBG builds, logging of dongle iovars should be available */ 454 #define DHD_DNGL_IOVAR_SET(args) \ 455 do { \ 456 if (dhd_msg_level & DHD_DNGL_IOVAR_SET_VAL) \ 457 printf args; \ 458 } while (0) 459 460 #define DHD_LOG(args) 461 462 #define DHD_BLOG(cp, size) 463 464 #define DHD_NONE(args) 465 extern int dhd_msg_level; 466 #ifdef DHD_LOG_PRINT_RATE_LIMIT 467 extern int log_print_threshold; 468 #endif /* DHD_LOG_PRINT_RATE_LIMIT */ 469 470 #define DHD_RTT_MEM(args) DHD_LOG_MEM(args) 471 #define DHD_RTT_ERR(args) DHD_ERROR(args) 472 473 /* Defines msg bits */ 474 #include <dhdioctl.h> 475 476 #endif /* _dhd_dbg_ */ 477