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