drivers/acpi/utilities/utdebug.c

   1 /******************************************************************************
   2  *
   3  * Module Name: utdebug - Debug print routines
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2007, R. Byron Moore
   9  * All rights reserved.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions, and the following disclaimer,
  16  *    without modification.
  17  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  18  *    substantially similar to the "NO WARRANTY" disclaimer below
  19  *    ("Disclaimer") and any redistribution must be conditioned upon
  20  *    including a substantially similar Disclaimer requirement for further
  21  *    binary redistribution.
  22  * 3. Neither the names of the above-listed copyright holders nor the names
  23  *    of any contributors may be used to endorse or promote products derived
  24  *    from this software without specific prior written permission.
  25  *
  26  * Alternatively, this software may be distributed under the terms of the
  27  * GNU General Public License ("GPL") version 2 as published by the Free
  28  * Software Foundation.
  29  *
  30  * NO WARRANTY
  31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  32  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  33  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  34  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  35  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  39  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  40  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  41  * POSSIBILITY OF SUCH DAMAGES.
  42  */
  43
  44 #include <acpi/acpi.h>
  45
  46 #define _COMPONENT          ACPI_UTILITIES
  47 ACPI_MODULE_NAME("utdebug")
  48 #ifdef ACPI_DEBUG_OUTPUT
  49 static acpi_thread_id acpi_gbl_prev_thread_id;
  50 static char *acpi_gbl_fn_entry_str = "----Entry";
  51 static char *acpi_gbl_fn_exit_str = "----Exit-";
  52
  53 /* Local prototypes */
  54
  55 static const char *acpi_ut_trim_function_name(const char *function_name);
  56
  57 /*******************************************************************************
  58  *
  59  * FUNCTION:    acpi_ut_init_stack_ptr_trace
  60  *
  61  * PARAMETERS:  None
  62  *
  63  * RETURN:      None
  64  *
  65  * DESCRIPTION: Save the current CPU stack pointer at subsystem startup
  66  *
  67  ******************************************************************************/
  68
  69 void acpi_ut_init_stack_ptr_trace(void)
  70 {
  71         acpi_size current_sp;
  72
  73         acpi_gbl_entry_stack_pointer = &current_sp;
  74 }
  75
  76 /*******************************************************************************
  77  *
  78  * FUNCTION:    acpi_ut_track_stack_ptr
  79  *
  80  * PARAMETERS:  None
  81  *
  82  * RETURN:      None
  83  *
  84  * DESCRIPTION: Save the current CPU stack pointer
  85  *
  86  ******************************************************************************/
  87
  88 void acpi_ut_track_stack_ptr(void)
  89 {
  90         acpi_size current_sp;
  91
  92         if (&current_sp < acpi_gbl_lowest_stack_pointer) {
  93                 acpi_gbl_lowest_stack_pointer = &current_sp;
  94         }
  95
  96         if (acpi_gbl_nesting_level > acpi_gbl_deepest_nesting) {
  97                 acpi_gbl_deepest_nesting = acpi_gbl_nesting_level;
  98         }
  99 }
 100
 101 /*******************************************************************************
 102  *
 103  * FUNCTION:    acpi_ut_trim_function_name
 104  *
 105  * PARAMETERS:  function_name       - Ascii string containing a procedure name
 106  *
 107  * RETURN:      Updated pointer to the function name
 108  *
 109  * DESCRIPTION: Remove the "Acpi" prefix from the function name, if present.
 110  *              This allows compiler macros such as __func__ to be used
 111  *              with no change to the debug output.
 112  *
 113  ******************************************************************************/
 114
 115 static const char *acpi_ut_trim_function_name(const char *function_name)
 116 {
 117
 118         /* All Function names are longer than 4 chars, check is safe */
 119
 120         if (*(ACPI_CAST_PTR(u32, function_name)) == ACPI_PREFIX_MIXED) {
 121
 122                 /* This is the case where the original source has not been modified */
 123
 124                 return (function_name + 4);
 125         }
 126
 127         if (*(ACPI_CAST_PTR(u32, function_name)) == ACPI_PREFIX_LOWER) {
 128
 129                 /* This is the case where the source has been 'linuxized' */
 130
 131                 return (function_name + 5);
 132         }
 133
 134         return (function_name);
 135 }
 136
 137 /*******************************************************************************
 138  *
 139  * FUNCTION:    acpi_ut_debug_print
 140  *
 141  * PARAMETERS:  requested_debug_level - Requested debug print level
 142  *              line_number         - Caller's line number (for error output)
 143  *              function_name       - Caller's procedure name
 144  *              module_name         - Caller's module name
 145  *              component_id        - Caller's component ID
 146  *              Format              - Printf format field
 147  *              ...                 - Optional printf arguments
 148  *
 149  * RETURN:      None
 150  *
 151  * DESCRIPTION: Print error message with prefix consisting of the module name,
 152  *              line number, and component ID.
 153  *
 154  ******************************************************************************/
 155
 156 void ACPI_INTERNAL_VAR_XFACE
 157 acpi_ut_debug_print(u32 requested_debug_level,
 158                     u32 line_number,
 159                     const char *function_name,
 160                     char *module_name, u32 component_id, char *format, ...)
 161 {
 162         acpi_thread_id thread_id;
 163         va_list args;
 164
 165         /*
 166          * Stay silent if the debug level or component ID is disabled
 167          */
 168         if (!(requested_debug_level & acpi_dbg_level) ||
 169             !(component_id & acpi_dbg_layer)) {
 170                 return;
 171         }
 172
 173         /*
 174          * Thread tracking and context switch notification
 175          */
 176         thread_id = acpi_os_get_thread_id();
 177         if (thread_id != acpi_gbl_prev_thread_id) {
 178                 if (ACPI_LV_THREADS & acpi_dbg_level) {
 179                         acpi_os_printf
 180                             ("\n**** Context Switch from TID %lX to TID %lX ****\n\n",
 181                              (unsigned long)acpi_gbl_prev_thread_id,
 182                              (unsigned long)thread_id);
 183                 }
 184
 185                 acpi_gbl_prev_thread_id = thread_id;
 186         }
 187
 188         /*
 189          * Display the module name, current line number, thread ID (if requested),
 190          * current procedure nesting level, and the current procedure name
 191          */
 192         acpi_os_printf("%8s-%04ld ", module_name, line_number);
 193
 194         if (ACPI_LV_THREADS & acpi_dbg_level) {
 195                 acpi_os_printf("[%04lX] ", (unsigned long)thread_id);
 196         }
 197
 198         acpi_os_printf("[%02ld] %-22.22s: ",
 199                        acpi_gbl_nesting_level,
 200                        acpi_ut_trim_function_name(function_name));
 201
 202         va_start(args, format);
 203         acpi_os_vprintf(format, args);
 204 }
 205
 206 ACPI_EXPORT_SYMBOL(acpi_ut_debug_print)
 207
 208 /*******************************************************************************
 209  *
 210  * FUNCTION:    acpi_ut_debug_print_raw
 211  *
 212  * PARAMETERS:  requested_debug_level - Requested debug print level
 213  *              line_number         - Caller's line number
 214  *              function_name       - Caller's procedure name
 215  *              module_name         - Caller's module name
 216  *              component_id        - Caller's component ID
 217  *              Format              - Printf format field
 218  *              ...                 - Optional printf arguments
 219  *
 220  * RETURN:      None
 221  *
 222  * DESCRIPTION: Print message with no headers.  Has same interface as
 223  *              debug_print so that the same macros can be used.
 224  *
 225  ******************************************************************************/
 226 void ACPI_INTERNAL_VAR_XFACE
 227 acpi_ut_debug_print_raw(u32 requested_debug_level,
 228                         u32 line_number,
 229                         const char *function_name,
 230                         char *module_name, u32 component_id, char *format, ...)
 231 {
 232         va_list args;
 233
 234         if (!(requested_debug_level & acpi_dbg_level) ||
 235             !(component_id & acpi_dbg_layer)) {
 236                 return;
 237         }
 238
 239         va_start(args, format);
 240         acpi_os_vprintf(format, args);
 241 }
 242
 243 ACPI_EXPORT_SYMBOL(acpi_ut_debug_print_raw)
 244
 245 /*******************************************************************************
 246  *
 247  * FUNCTION:    acpi_ut_trace
 248  *
 249  * PARAMETERS:  line_number         - Caller's line number
 250  *              function_name       - Caller's procedure name
 251  *              module_name         - Caller's module name
 252  *              component_id        - Caller's component ID
 253  *
 254  * RETURN:      None
 255  *
 256  * DESCRIPTION: Function entry trace.  Prints only if TRACE_FUNCTIONS bit is
 257  *              set in debug_level
 258  *
 259  ******************************************************************************/
 260 void
 261 acpi_ut_trace(u32 line_number,
 262               const char *function_name, char *module_name, u32 component_id)
 263 {
 264
 265         acpi_gbl_nesting_level++;
 266         acpi_ut_track_stack_ptr();
 267
 268         acpi_ut_debug_print(ACPI_LV_FUNCTIONS,
 269                             line_number, function_name, module_name,
 270                             component_id, "%s\n", acpi_gbl_fn_entry_str);
 271 }
 272
 273 ACPI_EXPORT_SYMBOL(acpi_ut_trace)
 274
 275 /*******************************************************************************
 276  *
 277  * FUNCTION:    acpi_ut_trace_ptr
 278  *
 279  * PARAMETERS:  line_number         - Caller's line number
 280  *              function_name       - Caller's procedure name
 281  *              module_name         - Caller's module name
 282  *              component_id        - Caller's component ID
 283  *              Pointer             - Pointer to display
 284  *
 285  * RETURN:      None
 286  *
 287  * DESCRIPTION: Function entry trace.  Prints only if TRACE_FUNCTIONS bit is
 288  *              set in debug_level
 289  *
 290  ******************************************************************************/
 291 void
 292 acpi_ut_trace_ptr(u32 line_number,
 293                   const char *function_name,
 294                   char *module_name, u32 component_id, void *pointer)
 295 {
 296         acpi_gbl_nesting_level++;
 297         acpi_ut_track_stack_ptr();
 298
 299         acpi_ut_debug_print(ACPI_LV_FUNCTIONS,
 300                             line_number, function_name, module_name,
 301                             component_id, "%s %p\n", acpi_gbl_fn_entry_str,
 302                             pointer);
 303 }
 304
 305 /*******************************************************************************
 306  *
 307  * FUNCTION:    acpi_ut_trace_str
 308  *
 309  * PARAMETERS:  line_number         - Caller's line number
 310  *              function_name       - Caller's procedure name
 311  *              module_name         - Caller's module name
 312  *              component_id        - Caller's component ID
 313  *              String              - Additional string to display
 314  *
 315  * RETURN:      None
 316  *
 317  * DESCRIPTION: Function entry trace.  Prints only if TRACE_FUNCTIONS bit is
 318  *              set in debug_level
 319  *
 320  ******************************************************************************/
 321
 322 void
 323 acpi_ut_trace_str(u32 line_number,
 324                   const char *function_name,
 325                   char *module_name, u32 component_id, char *string)
 326 {
 327
 328         acpi_gbl_nesting_level++;
 329         acpi_ut_track_stack_ptr();
 330
 331         acpi_ut_debug_print(ACPI_LV_FUNCTIONS,
 332                             line_number, function_name, module_name,
 333                             component_id, "%s %s\n", acpi_gbl_fn_entry_str,
 334                             string);
 335 }
 336
 337 /*******************************************************************************
 338  *
 339  * FUNCTION:    acpi_ut_trace_u32
 340  *
 341  * PARAMETERS:  line_number         - Caller's line number
 342  *              function_name       - Caller's procedure name
 343  *              module_name         - Caller's module name
 344  *              component_id        - Caller's component ID
 345  *              Integer             - Integer to display
 346  *
 347  * RETURN:      None
 348  *
 349  * DESCRIPTION: Function entry trace.  Prints only if TRACE_FUNCTIONS bit is
 350  *              set in debug_level
 351  *
 352  ******************************************************************************/
 353
 354 void
 355 acpi_ut_trace_u32(u32 line_number,
 356                   const char *function_name,
 357                   char *module_name, u32 component_id, u32 integer)
 358 {
 359
 360         acpi_gbl_nesting_level++;
 361         acpi_ut_track_stack_ptr();
 362
 363         acpi_ut_debug_print(ACPI_LV_FUNCTIONS,
 364                             line_number, function_name, module_name,
 365                             component_id, "%s %08X\n", acpi_gbl_fn_entry_str,
 366                             integer);
 367 }
 368
 369 /*******************************************************************************
 370  *
 371  * FUNCTION:    acpi_ut_exit
 372  *
 373  * PARAMETERS:  line_number         - Caller's line number
 374  *              function_name       - Caller's procedure name
 375  *              module_name         - Caller's module name
 376  *              component_id        - Caller's component ID
 377  *
 378  * RETURN:      None
 379  *
 380  * DESCRIPTION: Function exit trace.  Prints only if TRACE_FUNCTIONS bit is
 381  *              set in debug_level
 382  *
 383  ******************************************************************************/
 384
 385 void
 386 acpi_ut_exit(u32 line_number,
 387              const char *function_name, char *module_name, u32 component_id)
 388 {
 389
 390         acpi_ut_debug_print(ACPI_LV_FUNCTIONS,
 391                             line_number, function_name, module_name,
 392                             component_id, "%s\n", acpi_gbl_fn_exit_str);
 393
 394         acpi_gbl_nesting_level--;
 395 }
 396
 397 ACPI_EXPORT_SYMBOL(acpi_ut_exit)
 398
 399 /*******************************************************************************
 400  *
 401  * FUNCTION:    acpi_ut_status_exit
 402  *
 403  * PARAMETERS:  line_number         - Caller's line number
 404  *              function_name       - Caller's procedure name
 405  *              module_name         - Caller's module name
 406  *              component_id        - Caller's component ID
 407  *              Status              - Exit status code
 408  *
 409  * RETURN:      None
 410  *
 411  * DESCRIPTION: Function exit trace.  Prints only if TRACE_FUNCTIONS bit is
 412  *              set in debug_level. Prints exit status also.
 413  *
 414  ******************************************************************************/
 415 void
 416 acpi_ut_status_exit(u32 line_number,
 417                     const char *function_name,
 418                     char *module_name, u32 component_id, acpi_status status)
 419 {
 420
 421         if (ACPI_SUCCESS(status)) {
 422                 acpi_ut_debug_print(ACPI_LV_FUNCTIONS,
 423                                     line_number, function_name, module_name,
 424                                     component_id, "%s %s\n",
 425                                     acpi_gbl_fn_exit_str,
 426                                     acpi_format_exception(status));
 427         } else {
 428                 acpi_ut_debug_print(ACPI_LV_FUNCTIONS,
 429                                     line_number, function_name, module_name,
 430                                     component_id, "%s ****Exception****: %s\n",
 431                                     acpi_gbl_fn_exit_str,
 432                                     acpi_format_exception(status));
 433         }
 434
 435         acpi_gbl_nesting_level--;
 436 }
 437
 438 ACPI_EXPORT_SYMBOL(acpi_ut_status_exit)
 439
 440 /*******************************************************************************
 441  *
 442  * FUNCTION:    acpi_ut_value_exit
 443  *
 444  * PARAMETERS:  line_number         - Caller's line number
 445  *              function_name       - Caller's procedure name
 446  *              module_name         - Caller's module name
 447  *              component_id        - Caller's component ID
 448  *              Value               - Value to be printed with exit msg
 449  *
 450  * RETURN:      None
 451  *
 452  * DESCRIPTION: Function exit trace.  Prints only if TRACE_FUNCTIONS bit is
 453  *              set in debug_level. Prints exit value also.
 454  *
 455  ******************************************************************************/
 456 void
 457 acpi_ut_value_exit(u32 line_number,
 458                    const char *function_name,
 459                    char *module_name, u32 component_id, acpi_integer value)
 460 {
 461
 462         acpi_ut_debug_print(ACPI_LV_FUNCTIONS,
 463                             line_number, function_name, module_name,
 464                             component_id, "%s %8.8X%8.8X\n",
 465                             acpi_gbl_fn_exit_str, ACPI_FORMAT_UINT64(value));
 466
 467         acpi_gbl_nesting_level--;
 468 }
 469
 470 ACPI_EXPORT_SYMBOL(acpi_ut_value_exit)
 471
 472 /*******************************************************************************
 473  *
 474  * FUNCTION:    acpi_ut_ptr_exit
 475  *
 476  * PARAMETERS:  line_number         - Caller's line number
 477  *              function_name       - Caller's procedure name
 478  *              module_name         - Caller's module name
 479  *              component_id        - Caller's component ID
 480  *              Ptr                 - Pointer to display
 481  *
 482  * RETURN:      None
 483  *
 484  * DESCRIPTION: Function exit trace.  Prints only if TRACE_FUNCTIONS bit is
 485  *              set in debug_level. Prints exit value also.
 486  *
 487  ******************************************************************************/
 488 void
 489 acpi_ut_ptr_exit(u32 line_number,
 490                  const char *function_name,
 491                  char *module_name, u32 component_id, u8 * ptr)
 492 {
 493
 494         acpi_ut_debug_print(ACPI_LV_FUNCTIONS,
 495                             line_number, function_name, module_name,
 496                             component_id, "%s %p\n", acpi_gbl_fn_exit_str, ptr);
 497
 498         acpi_gbl_nesting_level--;
 499 }
 500
 501 #endif
 502
 503 /*******************************************************************************
 504  *
 505  * FUNCTION:    acpi_ut_dump_buffer
 506  *
 507  * PARAMETERS:  Buffer              - Buffer to dump
 508  *              Count               - Amount to dump, in bytes
 509  *              Display             - BYTE, WORD, DWORD, or QWORD display
 510  *              component_iD        - Caller's component ID
 511  *
 512  * RETURN:      None
 513  *
 514  * DESCRIPTION: Generic dump buffer in both hex and ascii.
 515  *
 516  ******************************************************************************/
 517
 518 void acpi_ut_dump_buffer2(u8 * buffer, u32 count, u32 display)
 519 {
 520         acpi_native_uint i = 0;
 521         acpi_native_uint j;
 522         u32 temp32;
 523         u8 buf_char;
 524
 525         if (!buffer) {
 526                 acpi_os_printf("Null Buffer Pointer in DumpBuffer!\n");
 527                 return;
 528         }
 529
 530         if ((count < 4) || (count & 0x01)) {
 531                 display = DB_BYTE_DISPLAY;
 532         }
 533
 534         /* Nasty little dump buffer routine! */
 535
 536         while (i < count) {
 537
 538                 /* Print current offset */
 539
 540                 acpi_os_printf("%6.4X: ", (u32) i);
 541
 542                 /* Print 16 hex chars */
 543
 544                 for (j = 0; j < 16;) {
 545                         if (i + j >= count) {
 546
 547                                 /* Dump fill spaces */
 548
 549                                 acpi_os_printf("%*s", ((display * 2) + 1), " ");
 550                                 j += (acpi_native_uint) display;
 551                                 continue;
 552                         }
 553
 554                         switch (display) {
 555                         case DB_BYTE_DISPLAY:
 556                         default:        /* Default is BYTE display */
 557
 558                                 acpi_os_printf("%02X ", buffer[i + j]);
 559                                 break;
 560
 561                         case DB_WORD_DISPLAY:
 562
 563                                 ACPI_MOVE_16_TO_32(&temp32, &buffer[i + j]);
 564                                 acpi_os_printf("%04X ", temp32);
 565                                 break;
 566
 567                         case DB_DWORD_DISPLAY:
 568
 569                                 ACPI_MOVE_32_TO_32(&temp32, &buffer[i + j]);
 570                                 acpi_os_printf("%08X ", temp32);
 571                                 break;
 572
 573                         case DB_QWORD_DISPLAY:
 574
 575                                 ACPI_MOVE_32_TO_32(&temp32, &buffer[i + j]);
 576                                 acpi_os_printf("%08X", temp32);
 577
 578                                 ACPI_MOVE_32_TO_32(&temp32, &buffer[i + j + 4]);
 579                                 acpi_os_printf("%08X ", temp32);
 580                                 break;
 581                         }
 582
 583                         j += (acpi_native_uint) display;
 584                 }
 585
 586                 /*
 587                  * Print the ASCII equivalent characters but watch out for the bad
 588                  * unprintable ones (printable chars are 0x20 through 0x7E)
 589                  */
 590                 acpi_os_printf(" ");
 591                 for (j = 0; j < 16; j++) {
 592                         if (i + j >= count) {
 593                                 acpi_os_printf("\n");
 594                                 return;
 595                         }
 596
 597                         buf_char = buffer[i + j];
 598                         if (ACPI_IS_PRINT(buf_char)) {
 599                                 acpi_os_printf("%c", buf_char);
 600                         } else {
 601                                 acpi_os_printf(".");
 602                         }
 603                 }
 604
 605                 /* Done with that line. */
 606
 607                 acpi_os_printf("\n");
 608                 i += 16;
 609         }
 610
 611         return;
 612 }
 613
 614 /*******************************************************************************
 615  *
 616  * FUNCTION:    acpi_ut_dump_buffer
 617  *
 618  * PARAMETERS:  Buffer              - Buffer to dump
 619  *              Count               - Amount to dump, in bytes
 620  *              Display             - BYTE, WORD, DWORD, or QWORD display
 621  *              component_iD        - Caller's component ID
 622  *
 623  * RETURN:      None
 624  *
 625  * DESCRIPTION: Generic dump buffer in both hex and ascii.
 626  *
 627  ******************************************************************************/
 628
 629 void acpi_ut_dump_buffer(u8 * buffer, u32 count, u32 display, u32 component_id)
 630 {
 631
 632         /* Only dump the buffer if tracing is enabled */
 633
 634         if (!((ACPI_LV_TABLES & acpi_dbg_level) &&
 635               (component_id & acpi_dbg_layer))) {
 636                 return;
 637         }
 638
 639         acpi_ut_dump_buffer2(buffer, count, display);
 640 }