Loading...
1/******************************************************************************
2 *
3 * Module Name: utdebug - Debug print/trace routines
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2016, 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#define EXPORT_ACPI_INTERFACES
45
46#include <acpi/acpi.h>
47#include "accommon.h"
48#include "acinterp.h"
49
50#define _COMPONENT ACPI_UTILITIES
51ACPI_MODULE_NAME("utdebug")
52
53#ifdef ACPI_DEBUG_OUTPUT
54static acpi_thread_id acpi_gbl_prev_thread_id = (acpi_thread_id) 0xFFFFFFFF;
55static char *acpi_gbl_fn_entry_str = "----Entry";
56static char *acpi_gbl_fn_exit_str = "----Exit-";
57
58/* Local prototypes */
59
60static const char *acpi_ut_trim_function_name(const char *function_name);
61
62/*******************************************************************************
63 *
64 * FUNCTION: acpi_ut_init_stack_ptr_trace
65 *
66 * PARAMETERS: None
67 *
68 * RETURN: None
69 *
70 * DESCRIPTION: Save the current CPU stack pointer at subsystem startup
71 *
72 ******************************************************************************/
73
74void acpi_ut_init_stack_ptr_trace(void)
75{
76 acpi_size current_sp;
77
78 acpi_gbl_entry_stack_pointer = ¤t_sp;
79}
80
81/*******************************************************************************
82 *
83 * FUNCTION: acpi_ut_track_stack_ptr
84 *
85 * PARAMETERS: None
86 *
87 * RETURN: None
88 *
89 * DESCRIPTION: Save the current CPU stack pointer
90 *
91 ******************************************************************************/
92
93void acpi_ut_track_stack_ptr(void)
94{
95 acpi_size current_sp;
96
97 if (¤t_sp < acpi_gbl_lowest_stack_pointer) {
98 acpi_gbl_lowest_stack_pointer = ¤t_sp;
99 }
100
101 if (acpi_gbl_nesting_level > acpi_gbl_deepest_nesting) {
102 acpi_gbl_deepest_nesting = acpi_gbl_nesting_level;
103 }
104}
105
106/*******************************************************************************
107 *
108 * FUNCTION: acpi_ut_trim_function_name
109 *
110 * PARAMETERS: function_name - Ascii string containing a procedure name
111 *
112 * RETURN: Updated pointer to the function name
113 *
114 * DESCRIPTION: Remove the "Acpi" prefix from the function name, if present.
115 * This allows compiler macros such as __func__ to be used
116 * with no change to the debug output.
117 *
118 ******************************************************************************/
119
120static const char *acpi_ut_trim_function_name(const char *function_name)
121{
122
123 /* All Function names are longer than 4 chars, check is safe */
124
125 if (*(ACPI_CAST_PTR(u32, function_name)) == ACPI_PREFIX_MIXED) {
126
127 /* This is the case where the original source has not been modified */
128
129 return (function_name + 4);
130 }
131
132 if (*(ACPI_CAST_PTR(u32, function_name)) == ACPI_PREFIX_LOWER) {
133
134 /* This is the case where the source has been 'linuxized' */
135
136 return (function_name + 5);
137 }
138
139 return (function_name);
140}
141
142/*******************************************************************************
143 *
144 * FUNCTION: acpi_debug_print
145 *
146 * PARAMETERS: requested_debug_level - Requested debug print level
147 * line_number - Caller's line number (for error output)
148 * function_name - Caller's procedure name
149 * module_name - Caller's module name
150 * component_id - Caller's component ID
151 * format - Printf format field
152 * ... - Optional printf arguments
153 *
154 * RETURN: None
155 *
156 * DESCRIPTION: Print error message with prefix consisting of the module name,
157 * line number, and component ID.
158 *
159 ******************************************************************************/
160
161void ACPI_INTERNAL_VAR_XFACE
162acpi_debug_print(u32 requested_debug_level,
163 u32 line_number,
164 const char *function_name,
165 const char *module_name,
166 u32 component_id, const char *format, ...)
167{
168 acpi_thread_id thread_id;
169 va_list args;
170
171 /* Check if debug output enabled */
172
173 if (!ACPI_IS_DEBUG_ENABLED(requested_debug_level, component_id)) {
174 return;
175 }
176
177 /*
178 * Thread tracking and context switch notification
179 */
180 thread_id = acpi_os_get_thread_id();
181 if (thread_id != acpi_gbl_prev_thread_id) {
182 if (ACPI_LV_THREADS & acpi_dbg_level) {
183 acpi_os_printf
184 ("\n**** Context Switch from TID %u to TID %u ****\n\n",
185 (u32)acpi_gbl_prev_thread_id, (u32)thread_id);
186 }
187
188 acpi_gbl_prev_thread_id = thread_id;
189 acpi_gbl_nesting_level = 0;
190 }
191
192 /*
193 * Display the module name, current line number, thread ID (if requested),
194 * current procedure nesting level, and the current procedure name
195 */
196 acpi_os_printf("%9s-%04ld ", module_name, line_number);
197
198#ifdef ACPI_APPLICATION
199 /*
200 * For acpi_exec/iASL only, emit the thread ID and nesting level.
201 * Note: nesting level is really only useful during a single-thread
202 * execution. Otherwise, multiple threads will keep resetting the
203 * level.
204 */
205 if (ACPI_LV_THREADS & acpi_dbg_level) {
206 acpi_os_printf("[%u] ", (u32)thread_id);
207 }
208
209 acpi_os_printf("[%02ld] ", acpi_gbl_nesting_level);
210#endif
211
212 acpi_os_printf("%-22.22s: ", acpi_ut_trim_function_name(function_name));
213
214 va_start(args, format);
215 acpi_os_vprintf(format, args);
216 va_end(args);
217}
218
219ACPI_EXPORT_SYMBOL(acpi_debug_print)
220
221/*******************************************************************************
222 *
223 * FUNCTION: acpi_debug_print_raw
224 *
225 * PARAMETERS: requested_debug_level - Requested debug print level
226 * line_number - Caller's line number
227 * function_name - Caller's procedure name
228 * module_name - Caller's module name
229 * component_id - Caller's component ID
230 * format - Printf format field
231 * ... - Optional printf arguments
232 *
233 * RETURN: None
234 *
235 * DESCRIPTION: Print message with no headers. Has same interface as
236 * debug_print so that the same macros can be used.
237 *
238 ******************************************************************************/
239void ACPI_INTERNAL_VAR_XFACE
240acpi_debug_print_raw(u32 requested_debug_level,
241 u32 line_number,
242 const char *function_name,
243 const char *module_name,
244 u32 component_id, const char *format, ...)
245{
246 va_list args;
247
248 /* Check if debug output enabled */
249
250 if (!ACPI_IS_DEBUG_ENABLED(requested_debug_level, component_id)) {
251 return;
252 }
253
254 va_start(args, format);
255 acpi_os_vprintf(format, args);
256 va_end(args);
257}
258
259ACPI_EXPORT_SYMBOL(acpi_debug_print_raw)
260
261/*******************************************************************************
262 *
263 * FUNCTION: acpi_ut_trace
264 *
265 * PARAMETERS: line_number - Caller's line number
266 * function_name - Caller's procedure name
267 * module_name - Caller's module name
268 * component_id - Caller's component ID
269 *
270 * RETURN: None
271 *
272 * DESCRIPTION: Function entry trace. Prints only if TRACE_FUNCTIONS bit is
273 * set in debug_level
274 *
275 ******************************************************************************/
276void
277acpi_ut_trace(u32 line_number,
278 const char *function_name,
279 const char *module_name, u32 component_id)
280{
281
282 acpi_gbl_nesting_level++;
283 acpi_ut_track_stack_ptr();
284
285 /* Check if enabled up-front for performance */
286
287 if (ACPI_IS_DEBUG_ENABLED(ACPI_LV_FUNCTIONS, component_id)) {
288 acpi_debug_print(ACPI_LV_FUNCTIONS,
289 line_number, function_name, module_name,
290 component_id, "%s\n", acpi_gbl_fn_entry_str);
291 }
292}
293
294ACPI_EXPORT_SYMBOL(acpi_ut_trace)
295
296/*******************************************************************************
297 *
298 * FUNCTION: acpi_ut_trace_ptr
299 *
300 * PARAMETERS: line_number - Caller's line number
301 * function_name - Caller's procedure name
302 * module_name - Caller's module name
303 * component_id - Caller's component ID
304 * pointer - Pointer to display
305 *
306 * RETURN: None
307 *
308 * DESCRIPTION: Function entry trace. Prints only if TRACE_FUNCTIONS bit is
309 * set in debug_level
310 *
311 ******************************************************************************/
312void
313acpi_ut_trace_ptr(u32 line_number,
314 const char *function_name,
315 const char *module_name, u32 component_id, void *pointer)
316{
317
318 acpi_gbl_nesting_level++;
319 acpi_ut_track_stack_ptr();
320
321 /* Check if enabled up-front for performance */
322
323 if (ACPI_IS_DEBUG_ENABLED(ACPI_LV_FUNCTIONS, component_id)) {
324 acpi_debug_print(ACPI_LV_FUNCTIONS,
325 line_number, function_name, module_name,
326 component_id, "%s %p\n", acpi_gbl_fn_entry_str,
327 pointer);
328 }
329}
330
331/*******************************************************************************
332 *
333 * FUNCTION: acpi_ut_trace_str
334 *
335 * PARAMETERS: line_number - Caller's line number
336 * function_name - Caller's procedure name
337 * module_name - Caller's module name
338 * component_id - Caller's component ID
339 * string - Additional string to display
340 *
341 * RETURN: None
342 *
343 * DESCRIPTION: Function entry trace. Prints only if TRACE_FUNCTIONS bit is
344 * set in debug_level
345 *
346 ******************************************************************************/
347
348void
349acpi_ut_trace_str(u32 line_number,
350 const char *function_name,
351 const char *module_name, u32 component_id, char *string)
352{
353
354 acpi_gbl_nesting_level++;
355 acpi_ut_track_stack_ptr();
356
357 /* Check if enabled up-front for performance */
358
359 if (ACPI_IS_DEBUG_ENABLED(ACPI_LV_FUNCTIONS, component_id)) {
360 acpi_debug_print(ACPI_LV_FUNCTIONS,
361 line_number, function_name, module_name,
362 component_id, "%s %s\n", acpi_gbl_fn_entry_str,
363 string);
364 }
365}
366
367/*******************************************************************************
368 *
369 * FUNCTION: acpi_ut_trace_u32
370 *
371 * PARAMETERS: line_number - Caller's line number
372 * function_name - Caller's procedure name
373 * module_name - Caller's module name
374 * component_id - Caller's component ID
375 * integer - Integer to display
376 *
377 * RETURN: None
378 *
379 * DESCRIPTION: Function entry trace. Prints only if TRACE_FUNCTIONS bit is
380 * set in debug_level
381 *
382 ******************************************************************************/
383
384void
385acpi_ut_trace_u32(u32 line_number,
386 const char *function_name,
387 const char *module_name, u32 component_id, u32 integer)
388{
389
390 acpi_gbl_nesting_level++;
391 acpi_ut_track_stack_ptr();
392
393 /* Check if enabled up-front for performance */
394
395 if (ACPI_IS_DEBUG_ENABLED(ACPI_LV_FUNCTIONS, component_id)) {
396 acpi_debug_print(ACPI_LV_FUNCTIONS,
397 line_number, function_name, module_name,
398 component_id, "%s %08X\n",
399 acpi_gbl_fn_entry_str, integer);
400 }
401}
402
403/*******************************************************************************
404 *
405 * FUNCTION: acpi_ut_exit
406 *
407 * PARAMETERS: line_number - Caller's line number
408 * function_name - Caller's procedure name
409 * module_name - Caller's module name
410 * component_id - Caller's component ID
411 *
412 * RETURN: None
413 *
414 * DESCRIPTION: Function exit trace. Prints only if TRACE_FUNCTIONS bit is
415 * set in debug_level
416 *
417 ******************************************************************************/
418
419void
420acpi_ut_exit(u32 line_number,
421 const char *function_name,
422 const char *module_name, u32 component_id)
423{
424
425 /* Check if enabled up-front for performance */
426
427 if (ACPI_IS_DEBUG_ENABLED(ACPI_LV_FUNCTIONS, component_id)) {
428 acpi_debug_print(ACPI_LV_FUNCTIONS,
429 line_number, function_name, module_name,
430 component_id, "%s\n", acpi_gbl_fn_exit_str);
431 }
432
433 if (acpi_gbl_nesting_level) {
434 acpi_gbl_nesting_level--;
435 }
436}
437
438ACPI_EXPORT_SYMBOL(acpi_ut_exit)
439
440/*******************************************************************************
441 *
442 * FUNCTION: acpi_ut_status_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 * status - Exit status code
449 *
450 * RETURN: None
451 *
452 * DESCRIPTION: Function exit trace. Prints only if TRACE_FUNCTIONS bit is
453 * set in debug_level. Prints exit status also.
454 *
455 ******************************************************************************/
456void
457acpi_ut_status_exit(u32 line_number,
458 const char *function_name,
459 const char *module_name,
460 u32 component_id, acpi_status status)
461{
462
463 /* Check if enabled up-front for performance */
464
465 if (ACPI_IS_DEBUG_ENABLED(ACPI_LV_FUNCTIONS, component_id)) {
466 if (ACPI_SUCCESS(status)) {
467 acpi_debug_print(ACPI_LV_FUNCTIONS,
468 line_number, function_name,
469 module_name, component_id, "%s %s\n",
470 acpi_gbl_fn_exit_str,
471 acpi_format_exception(status));
472 } else {
473 acpi_debug_print(ACPI_LV_FUNCTIONS,
474 line_number, function_name,
475 module_name, component_id,
476 "%s ****Exception****: %s\n",
477 acpi_gbl_fn_exit_str,
478 acpi_format_exception(status));
479 }
480 }
481
482 if (acpi_gbl_nesting_level) {
483 acpi_gbl_nesting_level--;
484 }
485}
486
487ACPI_EXPORT_SYMBOL(acpi_ut_status_exit)
488
489/*******************************************************************************
490 *
491 * FUNCTION: acpi_ut_value_exit
492 *
493 * PARAMETERS: line_number - Caller's line number
494 * function_name - Caller's procedure name
495 * module_name - Caller's module name
496 * component_id - Caller's component ID
497 * value - Value to be printed with exit msg
498 *
499 * RETURN: None
500 *
501 * DESCRIPTION: Function exit trace. Prints only if TRACE_FUNCTIONS bit is
502 * set in debug_level. Prints exit value also.
503 *
504 ******************************************************************************/
505void
506acpi_ut_value_exit(u32 line_number,
507 const char *function_name,
508 const char *module_name, u32 component_id, u64 value)
509{
510
511 /* Check if enabled up-front for performance */
512
513 if (ACPI_IS_DEBUG_ENABLED(ACPI_LV_FUNCTIONS, component_id)) {
514 acpi_debug_print(ACPI_LV_FUNCTIONS,
515 line_number, function_name, module_name,
516 component_id, "%s %8.8X%8.8X\n",
517 acpi_gbl_fn_exit_str,
518 ACPI_FORMAT_UINT64(value));
519 }
520
521 if (acpi_gbl_nesting_level) {
522 acpi_gbl_nesting_level--;
523 }
524}
525
526ACPI_EXPORT_SYMBOL(acpi_ut_value_exit)
527
528/*******************************************************************************
529 *
530 * FUNCTION: acpi_ut_ptr_exit
531 *
532 * PARAMETERS: line_number - Caller's line number
533 * function_name - Caller's procedure name
534 * module_name - Caller's module name
535 * component_id - Caller's component ID
536 * ptr - Pointer to display
537 *
538 * RETURN: None
539 *
540 * DESCRIPTION: Function exit trace. Prints only if TRACE_FUNCTIONS bit is
541 * set in debug_level. Prints exit value also.
542 *
543 ******************************************************************************/
544void
545acpi_ut_ptr_exit(u32 line_number,
546 const char *function_name,
547 const char *module_name, u32 component_id, u8 *ptr)
548{
549
550 /* Check if enabled up-front for performance */
551
552 if (ACPI_IS_DEBUG_ENABLED(ACPI_LV_FUNCTIONS, component_id)) {
553 acpi_debug_print(ACPI_LV_FUNCTIONS,
554 line_number, function_name, module_name,
555 component_id, "%s %p\n", acpi_gbl_fn_exit_str,
556 ptr);
557 }
558
559 if (acpi_gbl_nesting_level) {
560 acpi_gbl_nesting_level--;
561 }
562}
563
564/*******************************************************************************
565 *
566 * FUNCTION: acpi_trace_point
567 *
568 * PARAMETERS: type - Trace event type
569 * begin - TRUE if before execution
570 * aml - Executed AML address
571 * pathname - Object path
572 * pointer - Pointer to the related object
573 *
574 * RETURN: None
575 *
576 * DESCRIPTION: Interpreter execution trace.
577 *
578 ******************************************************************************/
579
580void
581acpi_trace_point(acpi_trace_event_type type, u8 begin, u8 *aml, char *pathname)
582{
583
584 ACPI_FUNCTION_ENTRY();
585
586 acpi_ex_trace_point(type, begin, aml, pathname);
587
588#ifdef ACPI_USE_SYSTEM_TRACER
589 acpi_os_trace_point(type, begin, aml, pathname);
590#endif
591}
592
593ACPI_EXPORT_SYMBOL(acpi_trace_point)
594#endif
595#ifdef ACPI_APPLICATION
596/*******************************************************************************
597 *
598 * FUNCTION: acpi_log_error
599 *
600 * PARAMETERS: format - Printf format field
601 * ... - Optional printf arguments
602 *
603 * RETURN: None
604 *
605 * DESCRIPTION: Print error message to the console, used by applications.
606 *
607 ******************************************************************************/
608void ACPI_INTERNAL_VAR_XFACE acpi_log_error(const char *format, ...)
609{
610 va_list args;
611
612 va_start(args, format);
613 (void)acpi_ut_file_vprintf(ACPI_FILE_ERR, format, args);
614 va_end(args);
615}
616
617ACPI_EXPORT_SYMBOL(acpi_log_error)
618#endif
1/******************************************************************************
2 *
3 * Module Name: utdebug - Debug print routines
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2012, 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 <linux/export.h>
45#include <acpi/acpi.h>
46#include "accommon.h"
47
48#define _COMPONENT ACPI_UTILITIES
49ACPI_MODULE_NAME("utdebug")
50#ifdef ACPI_DEBUG_OUTPUT
51static acpi_thread_id acpi_gbl_prev_thread_id;
52static char *acpi_gbl_fn_entry_str = "----Entry";
53static char *acpi_gbl_fn_exit_str = "----Exit-";
54
55/* Local prototypes */
56
57static const char *acpi_ut_trim_function_name(const char *function_name);
58
59/*******************************************************************************
60 *
61 * FUNCTION: acpi_ut_init_stack_ptr_trace
62 *
63 * PARAMETERS: None
64 *
65 * RETURN: None
66 *
67 * DESCRIPTION: Save the current CPU stack pointer at subsystem startup
68 *
69 ******************************************************************************/
70
71void acpi_ut_init_stack_ptr_trace(void)
72{
73 acpi_size current_sp;
74
75 acpi_gbl_entry_stack_pointer = ¤t_sp;
76}
77
78/*******************************************************************************
79 *
80 * FUNCTION: acpi_ut_track_stack_ptr
81 *
82 * PARAMETERS: None
83 *
84 * RETURN: None
85 *
86 * DESCRIPTION: Save the current CPU stack pointer
87 *
88 ******************************************************************************/
89
90void acpi_ut_track_stack_ptr(void)
91{
92 acpi_size current_sp;
93
94 if (¤t_sp < acpi_gbl_lowest_stack_pointer) {
95 acpi_gbl_lowest_stack_pointer = ¤t_sp;
96 }
97
98 if (acpi_gbl_nesting_level > acpi_gbl_deepest_nesting) {
99 acpi_gbl_deepest_nesting = acpi_gbl_nesting_level;
100 }
101}
102
103/*******************************************************************************
104 *
105 * FUNCTION: acpi_ut_trim_function_name
106 *
107 * PARAMETERS: function_name - Ascii string containing a procedure name
108 *
109 * RETURN: Updated pointer to the function name
110 *
111 * DESCRIPTION: Remove the "Acpi" prefix from the function name, if present.
112 * This allows compiler macros such as __func__ to be used
113 * with no change to the debug output.
114 *
115 ******************************************************************************/
116
117static const char *acpi_ut_trim_function_name(const char *function_name)
118{
119
120 /* All Function names are longer than 4 chars, check is safe */
121
122 if (*(ACPI_CAST_PTR(u32, function_name)) == ACPI_PREFIX_MIXED) {
123
124 /* This is the case where the original source has not been modified */
125
126 return (function_name + 4);
127 }
128
129 if (*(ACPI_CAST_PTR(u32, function_name)) == ACPI_PREFIX_LOWER) {
130
131 /* This is the case where the source has been 'linuxized' */
132
133 return (function_name + 5);
134 }
135
136 return (function_name);
137}
138
139/*******************************************************************************
140 *
141 * FUNCTION: acpi_debug_print
142 *
143 * PARAMETERS: requested_debug_level - Requested debug print level
144 * line_number - Caller's line number (for error output)
145 * function_name - Caller's procedure name
146 * module_name - Caller's module name
147 * component_id - Caller's component ID
148 * Format - Printf format field
149 * ... - Optional printf arguments
150 *
151 * RETURN: None
152 *
153 * DESCRIPTION: Print error message with prefix consisting of the module name,
154 * line number, and component ID.
155 *
156 ******************************************************************************/
157
158void ACPI_INTERNAL_VAR_XFACE
159acpi_debug_print(u32 requested_debug_level,
160 u32 line_number,
161 const char *function_name,
162 const char *module_name,
163 u32 component_id, const char *format, ...)
164{
165 acpi_thread_id thread_id;
166 va_list args;
167
168 /*
169 * Stay silent if the debug level or component ID is disabled
170 */
171 if (!(requested_debug_level & acpi_dbg_level) ||
172 !(component_id & acpi_dbg_layer)) {
173 return;
174 }
175
176 /*
177 * Thread tracking and context switch notification
178 */
179 thread_id = acpi_os_get_thread_id();
180 if (thread_id != acpi_gbl_prev_thread_id) {
181 if (ACPI_LV_THREADS & acpi_dbg_level) {
182 acpi_os_printf
183 ("\n**** Context Switch from TID %u to TID %u ****\n\n",
184 (u32)acpi_gbl_prev_thread_id, (u32)thread_id);
185 }
186
187 acpi_gbl_prev_thread_id = thread_id;
188 }
189
190 /*
191 * Display the module name, current line number, thread ID (if requested),
192 * current procedure nesting level, and the current procedure name
193 */
194 acpi_os_printf("%8s-%04ld ", module_name, line_number);
195
196 if (ACPI_LV_THREADS & acpi_dbg_level) {
197 acpi_os_printf("[%u] ", (u32)thread_id);
198 }
199
200 acpi_os_printf("[%02ld] %-22.22s: ",
201 acpi_gbl_nesting_level,
202 acpi_ut_trim_function_name(function_name));
203
204 va_start(args, format);
205 acpi_os_vprintf(format, args);
206 va_end(args);
207}
208
209ACPI_EXPORT_SYMBOL(acpi_debug_print)
210
211/*******************************************************************************
212 *
213 * FUNCTION: acpi_debug_print_raw
214 *
215 * PARAMETERS: requested_debug_level - Requested debug print level
216 * line_number - Caller's line number
217 * function_name - Caller's procedure name
218 * module_name - Caller's module name
219 * component_id - Caller's component ID
220 * Format - Printf format field
221 * ... - Optional printf arguments
222 *
223 * RETURN: None
224 *
225 * DESCRIPTION: Print message with no headers. Has same interface as
226 * debug_print so that the same macros can be used.
227 *
228 ******************************************************************************/
229void ACPI_INTERNAL_VAR_XFACE
230acpi_debug_print_raw(u32 requested_debug_level,
231 u32 line_number,
232 const char *function_name,
233 const char *module_name,
234 u32 component_id, const char *format, ...)
235{
236 va_list args;
237
238 if (!(requested_debug_level & acpi_dbg_level) ||
239 !(component_id & acpi_dbg_layer)) {
240 return;
241 }
242
243 va_start(args, format);
244 acpi_os_vprintf(format, args);
245 va_end(args);
246}
247
248ACPI_EXPORT_SYMBOL(acpi_debug_print_raw)
249
250/*******************************************************************************
251 *
252 * FUNCTION: acpi_ut_trace
253 *
254 * PARAMETERS: line_number - Caller's line number
255 * function_name - Caller's procedure name
256 * module_name - Caller's module name
257 * component_id - Caller's component ID
258 *
259 * RETURN: None
260 *
261 * DESCRIPTION: Function entry trace. Prints only if TRACE_FUNCTIONS bit is
262 * set in debug_level
263 *
264 ******************************************************************************/
265void
266acpi_ut_trace(u32 line_number,
267 const char *function_name,
268 const char *module_name, u32 component_id)
269{
270
271 acpi_gbl_nesting_level++;
272 acpi_ut_track_stack_ptr();
273
274 acpi_debug_print(ACPI_LV_FUNCTIONS,
275 line_number, function_name, module_name, component_id,
276 "%s\n", acpi_gbl_fn_entry_str);
277}
278
279ACPI_EXPORT_SYMBOL(acpi_ut_trace)
280
281/*******************************************************************************
282 *
283 * FUNCTION: acpi_ut_trace_ptr
284 *
285 * PARAMETERS: line_number - Caller's line number
286 * function_name - Caller's procedure name
287 * module_name - Caller's module name
288 * component_id - Caller's component ID
289 * Pointer - Pointer to display
290 *
291 * RETURN: None
292 *
293 * DESCRIPTION: Function entry trace. Prints only if TRACE_FUNCTIONS bit is
294 * set in debug_level
295 *
296 ******************************************************************************/
297void
298acpi_ut_trace_ptr(u32 line_number,
299 const char *function_name,
300 const char *module_name, u32 component_id, void *pointer)
301{
302 acpi_gbl_nesting_level++;
303 acpi_ut_track_stack_ptr();
304
305 acpi_debug_print(ACPI_LV_FUNCTIONS,
306 line_number, function_name, module_name, component_id,
307 "%s %p\n", acpi_gbl_fn_entry_str, 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_debug_print(ACPI_LV_FUNCTIONS,
337 line_number, function_name, module_name, component_id,
338 "%s %s\n", acpi_gbl_fn_entry_str, string);
339}
340
341/*******************************************************************************
342 *
343 * FUNCTION: acpi_ut_trace_u32
344 *
345 * PARAMETERS: line_number - Caller's line number
346 * function_name - Caller's procedure name
347 * module_name - Caller's module name
348 * component_id - Caller's component ID
349 * Integer - Integer to display
350 *
351 * RETURN: None
352 *
353 * DESCRIPTION: Function entry trace. Prints only if TRACE_FUNCTIONS bit is
354 * set in debug_level
355 *
356 ******************************************************************************/
357
358void
359acpi_ut_trace_u32(u32 line_number,
360 const char *function_name,
361 const char *module_name, u32 component_id, u32 integer)
362{
363
364 acpi_gbl_nesting_level++;
365 acpi_ut_track_stack_ptr();
366
367 acpi_debug_print(ACPI_LV_FUNCTIONS,
368 line_number, function_name, module_name, component_id,
369 "%s %08X\n", acpi_gbl_fn_entry_str, integer);
370}
371
372/*******************************************************************************
373 *
374 * FUNCTION: acpi_ut_exit
375 *
376 * PARAMETERS: line_number - Caller's line number
377 * function_name - Caller's procedure name
378 * module_name - Caller's module name
379 * component_id - Caller's component ID
380 *
381 * RETURN: None
382 *
383 * DESCRIPTION: Function exit trace. Prints only if TRACE_FUNCTIONS bit is
384 * set in debug_level
385 *
386 ******************************************************************************/
387
388void
389acpi_ut_exit(u32 line_number,
390 const char *function_name,
391 const char *module_name, u32 component_id)
392{
393
394 acpi_debug_print(ACPI_LV_FUNCTIONS,
395 line_number, function_name, module_name, component_id,
396 "%s\n", acpi_gbl_fn_exit_str);
397
398 acpi_gbl_nesting_level--;
399}
400
401ACPI_EXPORT_SYMBOL(acpi_ut_exit)
402
403/*******************************************************************************
404 *
405 * FUNCTION: acpi_ut_status_exit
406 *
407 * PARAMETERS: line_number - Caller's line number
408 * function_name - Caller's procedure name
409 * module_name - Caller's module name
410 * component_id - Caller's component ID
411 * Status - Exit status code
412 *
413 * RETURN: None
414 *
415 * DESCRIPTION: Function exit trace. Prints only if TRACE_FUNCTIONS bit is
416 * set in debug_level. Prints exit status also.
417 *
418 ******************************************************************************/
419void
420acpi_ut_status_exit(u32 line_number,
421 const char *function_name,
422 const char *module_name,
423 u32 component_id, acpi_status status)
424{
425
426 if (ACPI_SUCCESS(status)) {
427 acpi_debug_print(ACPI_LV_FUNCTIONS,
428 line_number, function_name, module_name,
429 component_id, "%s %s\n", acpi_gbl_fn_exit_str,
430 acpi_format_exception(status));
431 } else {
432 acpi_debug_print(ACPI_LV_FUNCTIONS,
433 line_number, function_name, module_name,
434 component_id, "%s ****Exception****: %s\n",
435 acpi_gbl_fn_exit_str,
436 acpi_format_exception(status));
437 }
438
439 acpi_gbl_nesting_level--;
440}
441
442ACPI_EXPORT_SYMBOL(acpi_ut_status_exit)
443
444/*******************************************************************************
445 *
446 * FUNCTION: acpi_ut_value_exit
447 *
448 * PARAMETERS: line_number - Caller's line number
449 * function_name - Caller's procedure name
450 * module_name - Caller's module name
451 * component_id - Caller's component ID
452 * Value - Value to be printed with exit msg
453 *
454 * RETURN: None
455 *
456 * DESCRIPTION: Function exit trace. Prints only if TRACE_FUNCTIONS bit is
457 * set in debug_level. Prints exit value also.
458 *
459 ******************************************************************************/
460void
461acpi_ut_value_exit(u32 line_number,
462 const char *function_name,
463 const char *module_name, u32 component_id, u64 value)
464{
465
466 acpi_debug_print(ACPI_LV_FUNCTIONS,
467 line_number, function_name, module_name, component_id,
468 "%s %8.8X%8.8X\n", acpi_gbl_fn_exit_str,
469 ACPI_FORMAT_UINT64(value));
470
471 acpi_gbl_nesting_level--;
472}
473
474ACPI_EXPORT_SYMBOL(acpi_ut_value_exit)
475
476/*******************************************************************************
477 *
478 * FUNCTION: acpi_ut_ptr_exit
479 *
480 * PARAMETERS: line_number - Caller's line number
481 * function_name - Caller's procedure name
482 * module_name - Caller's module name
483 * component_id - Caller's component ID
484 * Ptr - Pointer to display
485 *
486 * RETURN: None
487 *
488 * DESCRIPTION: Function exit trace. Prints only if TRACE_FUNCTIONS bit is
489 * set in debug_level. Prints exit value also.
490 *
491 ******************************************************************************/
492void
493acpi_ut_ptr_exit(u32 line_number,
494 const char *function_name,
495 const char *module_name, u32 component_id, u8 *ptr)
496{
497
498 acpi_debug_print(ACPI_LV_FUNCTIONS,
499 line_number, function_name, module_name, component_id,
500 "%s %p\n", acpi_gbl_fn_exit_str, ptr);
501
502 acpi_gbl_nesting_level--;
503}
504
505#endif
506
507/*******************************************************************************
508 *
509 * FUNCTION: acpi_ut_dump_buffer
510 *
511 * PARAMETERS: Buffer - Buffer to dump
512 * Count - Amount to dump, in bytes
513 * Display - BYTE, WORD, DWORD, or QWORD display
514 * component_iD - Caller's component ID
515 *
516 * RETURN: None
517 *
518 * DESCRIPTION: Generic dump buffer in both hex and ascii.
519 *
520 ******************************************************************************/
521
522void acpi_ut_dump_buffer2(u8 * buffer, u32 count, u32 display)
523{
524 u32 i = 0;
525 u32 j;
526 u32 temp32;
527 u8 buf_char;
528
529 if (!buffer) {
530 acpi_os_printf("Null Buffer Pointer in DumpBuffer!\n");
531 return;
532 }
533
534 if ((count < 4) || (count & 0x01)) {
535 display = DB_BYTE_DISPLAY;
536 }
537
538 /* Nasty little dump buffer routine! */
539
540 while (i < count) {
541
542 /* Print current offset */
543
544 acpi_os_printf("%6.4X: ", i);
545
546 /* Print 16 hex chars */
547
548 for (j = 0; j < 16;) {
549 if (i + j >= count) {
550
551 /* Dump fill spaces */
552
553 acpi_os_printf("%*s", ((display * 2) + 1), " ");
554 j += display;
555 continue;
556 }
557
558 switch (display) {
559 case DB_BYTE_DISPLAY:
560 default: /* Default is BYTE display */
561
562 acpi_os_printf("%02X ",
563 buffer[(acpi_size) i + j]);
564 break;
565
566 case DB_WORD_DISPLAY:
567
568 ACPI_MOVE_16_TO_32(&temp32,
569 &buffer[(acpi_size) i + j]);
570 acpi_os_printf("%04X ", temp32);
571 break;
572
573 case DB_DWORD_DISPLAY:
574
575 ACPI_MOVE_32_TO_32(&temp32,
576 &buffer[(acpi_size) i + j]);
577 acpi_os_printf("%08X ", temp32);
578 break;
579
580 case DB_QWORD_DISPLAY:
581
582 ACPI_MOVE_32_TO_32(&temp32,
583 &buffer[(acpi_size) i + j]);
584 acpi_os_printf("%08X", temp32);
585
586 ACPI_MOVE_32_TO_32(&temp32,
587 &buffer[(acpi_size) i + j +
588 4]);
589 acpi_os_printf("%08X ", temp32);
590 break;
591 }
592
593 j += display;
594 }
595
596 /*
597 * Print the ASCII equivalent characters but watch out for the bad
598 * unprintable ones (printable chars are 0x20 through 0x7E)
599 */
600 acpi_os_printf(" ");
601 for (j = 0; j < 16; j++) {
602 if (i + j >= count) {
603 acpi_os_printf("\n");
604 return;
605 }
606
607 buf_char = buffer[(acpi_size) i + j];
608 if (ACPI_IS_PRINT(buf_char)) {
609 acpi_os_printf("%c", buf_char);
610 } else {
611 acpi_os_printf(".");
612 }
613 }
614
615 /* Done with that line. */
616
617 acpi_os_printf("\n");
618 i += 16;
619 }
620
621 return;
622}
623
624/*******************************************************************************
625 *
626 * FUNCTION: acpi_ut_dump_buffer
627 *
628 * PARAMETERS: Buffer - Buffer to dump
629 * Count - Amount to dump, in bytes
630 * Display - BYTE, WORD, DWORD, or QWORD display
631 * component_iD - Caller's component ID
632 *
633 * RETURN: None
634 *
635 * DESCRIPTION: Generic dump buffer in both hex and ascii.
636 *
637 ******************************************************************************/
638
639void acpi_ut_dump_buffer(u8 * buffer, u32 count, u32 display, u32 component_id)
640{
641
642 /* Only dump the buffer if tracing is enabled */
643
644 if (!((ACPI_LV_TABLES & acpi_dbg_level) &&
645 (component_id & acpi_dbg_layer))) {
646 return;
647 }
648
649 acpi_ut_dump_buffer2(buffer, count, display);
650}