Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1/******************************************************************************
2 *
3 * Module Name: utdebug - Debug print routines
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2008, Intel Corp.
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
47ACPI_MODULE_NAME("utdebug")
48#ifdef ACPI_DEBUG_OUTPUT
49static acpi_thread_id acpi_gbl_prev_thread_id;
50static char *acpi_gbl_fn_entry_str = "----Entry";
51static char *acpi_gbl_fn_exit_str = "----Exit-";
52
53/* Local prototypes */
54
55static 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
69void acpi_ut_init_stack_ptr_trace(void)
70{
71 acpi_size current_sp;
72
73 acpi_gbl_entry_stack_pointer = ¤t_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
88void acpi_ut_track_stack_ptr(void)
89{
90 acpi_size current_sp;
91
92 if (¤t_sp < acpi_gbl_lowest_stack_pointer) {
93 acpi_gbl_lowest_stack_pointer = ¤t_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
115static 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
156void ACPI_INTERNAL_VAR_XFACE
157acpi_ut_debug_print(u32 requested_debug_level,
158 u32 line_number,
159 const char *function_name,
160 const char *module_name,
161 u32 component_id, const char *format, ...)
162{
163 acpi_thread_id thread_id;
164 va_list args;
165
166 /*
167 * Stay silent if the debug level or component ID is disabled
168 */
169 if (!(requested_debug_level & acpi_dbg_level) ||
170 !(component_id & acpi_dbg_layer)) {
171 return;
172 }
173
174 /*
175 * Thread tracking and context switch notification
176 */
177 thread_id = acpi_os_get_thread_id();
178 if (thread_id != acpi_gbl_prev_thread_id) {
179 if (ACPI_LV_THREADS & acpi_dbg_level) {
180 acpi_os_printf
181 ("\n**** Context Switch from TID %lX to TID %lX ****\n\n",
182 (unsigned long)acpi_gbl_prev_thread_id,
183 (unsigned long)thread_id);
184 }
185
186 acpi_gbl_prev_thread_id = thread_id;
187 }
188
189 /*
190 * Display the module name, current line number, thread ID (if requested),
191 * current procedure nesting level, and the current procedure name
192 */
193 acpi_os_printf("%8s-%04ld ", module_name, line_number);
194
195 if (ACPI_LV_THREADS & acpi_dbg_level) {
196 acpi_os_printf("[%04lX] ", (unsigned long)thread_id);
197 }
198
199 acpi_os_printf("[%02ld] %-22.22s: ",
200 acpi_gbl_nesting_level,
201 acpi_ut_trim_function_name(function_name));
202
203 va_start(args, format);
204 acpi_os_vprintf(format, args);
205 va_end(args);
206}
207
208ACPI_EXPORT_SYMBOL(acpi_ut_debug_print)
209
210/*******************************************************************************
211 *
212 * FUNCTION: acpi_ut_debug_print_raw
213 *
214 * PARAMETERS: requested_debug_level - Requested debug print level
215 * line_number - Caller's line number
216 * function_name - Caller's procedure name
217 * module_name - Caller's module name
218 * component_id - Caller's component ID
219 * Format - Printf format field
220 * ... - Optional printf arguments
221 *
222 * RETURN: None
223 *
224 * DESCRIPTION: Print message with no headers. Has same interface as
225 * debug_print so that the same macros can be used.
226 *
227 ******************************************************************************/
228void ACPI_INTERNAL_VAR_XFACE
229acpi_ut_debug_print_raw(u32 requested_debug_level,
230 u32 line_number,
231 const char *function_name,
232 const char *module_name,
233 u32 component_id, const char *format, ...)
234{
235 va_list args;
236
237 if (!(requested_debug_level & acpi_dbg_level) ||
238 !(component_id & acpi_dbg_layer)) {
239 return;
240 }
241
242 va_start(args, format);
243 acpi_os_vprintf(format, args);
244 va_end(args);
245}
246
247ACPI_EXPORT_SYMBOL(acpi_ut_debug_print_raw)
248
249/*******************************************************************************
250 *
251 * FUNCTION: acpi_ut_trace
252 *
253 * PARAMETERS: line_number - Caller's line number
254 * function_name - Caller's procedure name
255 * module_name - Caller's module name
256 * component_id - Caller's component ID
257 *
258 * RETURN: None
259 *
260 * DESCRIPTION: Function entry trace. Prints only if TRACE_FUNCTIONS bit is
261 * set in debug_level
262 *
263 ******************************************************************************/
264void
265acpi_ut_trace(u32 line_number,
266 const char *function_name,
267 const char *module_name, u32 component_id)
268{
269
270 acpi_gbl_nesting_level++;
271 acpi_ut_track_stack_ptr();
272
273 acpi_ut_debug_print(ACPI_LV_FUNCTIONS,
274 line_number, function_name, module_name,
275 component_id, "%s\n", acpi_gbl_fn_entry_str);
276}
277
278ACPI_EXPORT_SYMBOL(acpi_ut_trace)
279
280/*******************************************************************************
281 *
282 * FUNCTION: acpi_ut_trace_ptr
283 *
284 * PARAMETERS: line_number - Caller's line number
285 * function_name - Caller's procedure name
286 * module_name - Caller's module name
287 * component_id - Caller's component ID
288 * Pointer - Pointer to display
289 *
290 * RETURN: None
291 *
292 * DESCRIPTION: Function entry trace. Prints only if TRACE_FUNCTIONS bit is
293 * set in debug_level
294 *
295 ******************************************************************************/
296void
297acpi_ut_trace_ptr(u32 line_number,
298 const char *function_name,
299 const char *module_name, u32 component_id, void *pointer)
300{
301 acpi_gbl_nesting_level++;
302 acpi_ut_track_stack_ptr();
303
304 acpi_ut_debug_print(ACPI_LV_FUNCTIONS,
305 line_number, function_name, module_name,
306 component_id, "%s %p\n", acpi_gbl_fn_entry_str,
307 pointer);
308}
309
310/*******************************************************************************
311 *
312 * FUNCTION: acpi_ut_trace_str
313 *
314 * PARAMETERS: line_number - Caller's line number
315 * function_name - Caller's procedure name
316 * module_name - Caller's module name
317 * component_id - Caller's component ID
318 * String - Additional string to display
319 *
320 * RETURN: None
321 *
322 * DESCRIPTION: Function entry trace. Prints only if TRACE_FUNCTIONS bit is
323 * set in debug_level
324 *
325 ******************************************************************************/
326
327void
328acpi_ut_trace_str(u32 line_number,
329 const char *function_name,
330 const char *module_name, u32 component_id, char *string)
331{
332
333 acpi_gbl_nesting_level++;
334 acpi_ut_track_stack_ptr();
335
336 acpi_ut_debug_print(ACPI_LV_FUNCTIONS,
337 line_number, function_name, module_name,
338 component_id, "%s %s\n", acpi_gbl_fn_entry_str,
339 string);
340}
341
342/*******************************************************************************
343 *
344 * FUNCTION: acpi_ut_trace_u32
345 *
346 * PARAMETERS: line_number - Caller's line number
347 * function_name - Caller's procedure name
348 * module_name - Caller's module name
349 * component_id - Caller's component ID
350 * Integer - Integer to display
351 *
352 * RETURN: None
353 *
354 * DESCRIPTION: Function entry trace. Prints only if TRACE_FUNCTIONS bit is
355 * set in debug_level
356 *
357 ******************************************************************************/
358
359void
360acpi_ut_trace_u32(u32 line_number,
361 const char *function_name,
362 const char *module_name, u32 component_id, u32 integer)
363{
364
365 acpi_gbl_nesting_level++;
366 acpi_ut_track_stack_ptr();
367
368 acpi_ut_debug_print(ACPI_LV_FUNCTIONS,
369 line_number, function_name, module_name,
370 component_id, "%s %08X\n", acpi_gbl_fn_entry_str,
371 integer);
372}
373
374/*******************************************************************************
375 *
376 * FUNCTION: acpi_ut_exit
377 *
378 * PARAMETERS: line_number - Caller's line number
379 * function_name - Caller's procedure name
380 * module_name - Caller's module name
381 * component_id - Caller's component ID
382 *
383 * RETURN: None
384 *
385 * DESCRIPTION: Function exit trace. Prints only if TRACE_FUNCTIONS bit is
386 * set in debug_level
387 *
388 ******************************************************************************/
389
390void
391acpi_ut_exit(u32 line_number,
392 const char *function_name,
393 const char *module_name, u32 component_id)
394{
395
396 acpi_ut_debug_print(ACPI_LV_FUNCTIONS,
397 line_number, function_name, module_name,
398 component_id, "%s\n", acpi_gbl_fn_exit_str);
399
400 acpi_gbl_nesting_level--;
401}
402
403ACPI_EXPORT_SYMBOL(acpi_ut_exit)
404
405/*******************************************************************************
406 *
407 * FUNCTION: acpi_ut_status_exit
408 *
409 * PARAMETERS: line_number - Caller's line number
410 * function_name - Caller's procedure name
411 * module_name - Caller's module name
412 * component_id - Caller's component ID
413 * Status - Exit status code
414 *
415 * RETURN: None
416 *
417 * DESCRIPTION: Function exit trace. Prints only if TRACE_FUNCTIONS bit is
418 * set in debug_level. Prints exit status also.
419 *
420 ******************************************************************************/
421void
422acpi_ut_status_exit(u32 line_number,
423 const char *function_name,
424 const char *module_name,
425 u32 component_id, acpi_status status)
426{
427
428 if (ACPI_SUCCESS(status)) {
429 acpi_ut_debug_print(ACPI_LV_FUNCTIONS,
430 line_number, function_name, module_name,
431 component_id, "%s %s\n",
432 acpi_gbl_fn_exit_str,
433 acpi_format_exception(status));
434 } else {
435 acpi_ut_debug_print(ACPI_LV_FUNCTIONS,
436 line_number, function_name, module_name,
437 component_id, "%s ****Exception****: %s\n",
438 acpi_gbl_fn_exit_str,
439 acpi_format_exception(status));
440 }
441
442 acpi_gbl_nesting_level--;
443}
444
445ACPI_EXPORT_SYMBOL(acpi_ut_status_exit)
446
447/*******************************************************************************
448 *
449 * FUNCTION: acpi_ut_value_exit
450 *
451 * PARAMETERS: line_number - Caller's line number
452 * function_name - Caller's procedure name
453 * module_name - Caller's module name
454 * component_id - Caller's component ID
455 * Value - Value to be printed with exit msg
456 *
457 * RETURN: None
458 *
459 * DESCRIPTION: Function exit trace. Prints only if TRACE_FUNCTIONS bit is
460 * set in debug_level. Prints exit value also.
461 *
462 ******************************************************************************/
463void
464acpi_ut_value_exit(u32 line_number,
465 const char *function_name,
466 const char *module_name,
467 u32 component_id, acpi_integer value)
468{
469
470 acpi_ut_debug_print(ACPI_LV_FUNCTIONS,
471 line_number, function_name, module_name,
472 component_id, "%s %8.8X%8.8X\n",
473 acpi_gbl_fn_exit_str, ACPI_FORMAT_UINT64(value));
474
475 acpi_gbl_nesting_level--;
476}
477
478ACPI_EXPORT_SYMBOL(acpi_ut_value_exit)
479
480/*******************************************************************************
481 *
482 * FUNCTION: acpi_ut_ptr_exit
483 *
484 * PARAMETERS: line_number - Caller's line number
485 * function_name - Caller's procedure name
486 * module_name - Caller's module name
487 * component_id - Caller's component ID
488 * Ptr - Pointer to display
489 *
490 * RETURN: None
491 *
492 * DESCRIPTION: Function exit trace. Prints only if TRACE_FUNCTIONS bit is
493 * set in debug_level. Prints exit value also.
494 *
495 ******************************************************************************/
496void
497acpi_ut_ptr_exit(u32 line_number,
498 const char *function_name,
499 const char *module_name, u32 component_id, u8 *ptr)
500{
501
502 acpi_ut_debug_print(ACPI_LV_FUNCTIONS,
503 line_number, function_name, module_name,
504 component_id, "%s %p\n", acpi_gbl_fn_exit_str, ptr);
505
506 acpi_gbl_nesting_level--;
507}
508
509#endif
510
511/*******************************************************************************
512 *
513 * FUNCTION: acpi_ut_dump_buffer
514 *
515 * PARAMETERS: Buffer - Buffer to dump
516 * Count - Amount to dump, in bytes
517 * Display - BYTE, WORD, DWORD, or QWORD display
518 * component_iD - Caller's component ID
519 *
520 * RETURN: None
521 *
522 * DESCRIPTION: Generic dump buffer in both hex and ascii.
523 *
524 ******************************************************************************/
525
526void acpi_ut_dump_buffer2(u8 * buffer, u32 count, u32 display)
527{
528 u32 i = 0;
529 u32 j;
530 u32 temp32;
531 u8 buf_char;
532
533 if (!buffer) {
534 acpi_os_printf("Null Buffer Pointer in DumpBuffer!\n");
535 return;
536 }
537
538 if ((count < 4) || (count & 0x01)) {
539 display = DB_BYTE_DISPLAY;
540 }
541
542 /* Nasty little dump buffer routine! */
543
544 while (i < count) {
545
546 /* Print current offset */
547
548 acpi_os_printf("%6.4X: ", i);
549
550 /* Print 16 hex chars */
551
552 for (j = 0; j < 16;) {
553 if (i + j >= count) {
554
555 /* Dump fill spaces */
556
557 acpi_os_printf("%*s", ((display * 2) + 1), " ");
558 j += display;
559 continue;
560 }
561
562 switch (display) {
563 case DB_BYTE_DISPLAY:
564 default: /* Default is BYTE display */
565
566 acpi_os_printf("%02X ",
567 buffer[(acpi_size) i + j]);
568 break;
569
570 case DB_WORD_DISPLAY:
571
572 ACPI_MOVE_16_TO_32(&temp32,
573 &buffer[(acpi_size) i + j]);
574 acpi_os_printf("%04X ", temp32);
575 break;
576
577 case DB_DWORD_DISPLAY:
578
579 ACPI_MOVE_32_TO_32(&temp32,
580 &buffer[(acpi_size) i + j]);
581 acpi_os_printf("%08X ", temp32);
582 break;
583
584 case DB_QWORD_DISPLAY:
585
586 ACPI_MOVE_32_TO_32(&temp32,
587 &buffer[(acpi_size) i + j]);
588 acpi_os_printf("%08X", temp32);
589
590 ACPI_MOVE_32_TO_32(&temp32,
591 &buffer[(acpi_size) i + j +
592 4]);
593 acpi_os_printf("%08X ", temp32);
594 break;
595 }
596
597 j += display;
598 }
599
600 /*
601 * Print the ASCII equivalent characters but watch out for the bad
602 * unprintable ones (printable chars are 0x20 through 0x7E)
603 */
604 acpi_os_printf(" ");
605 for (j = 0; j < 16; j++) {
606 if (i + j >= count) {
607 acpi_os_printf("\n");
608 return;
609 }
610
611 buf_char = buffer[(acpi_size) i + j];
612 if (ACPI_IS_PRINT(buf_char)) {
613 acpi_os_printf("%c", buf_char);
614 } else {
615 acpi_os_printf(".");
616 }
617 }
618
619 /* Done with that line. */
620
621 acpi_os_printf("\n");
622 i += 16;
623 }
624
625 return;
626}
627
628/*******************************************************************************
629 *
630 * FUNCTION: acpi_ut_dump_buffer
631 *
632 * PARAMETERS: Buffer - Buffer to dump
633 * Count - Amount to dump, in bytes
634 * Display - BYTE, WORD, DWORD, or QWORD display
635 * component_iD - Caller's component ID
636 *
637 * RETURN: None
638 *
639 * DESCRIPTION: Generic dump buffer in both hex and ascii.
640 *
641 ******************************************************************************/
642
643void acpi_ut_dump_buffer(u8 * buffer, u32 count, u32 display, u32 component_id)
644{
645
646 /* Only dump the buffer if tracing is enabled */
647
648 if (!((ACPI_LV_TABLES & acpi_dbg_level) &&
649 (component_id & acpi_dbg_layer))) {
650 return;
651 }
652
653 acpi_ut_dump_buffer2(buffer, count, display);
654}