Linux Audio

Check our new training course

Loading...
v3.1
  1/******************************************************************************
  2 *
  3 * Module Name: utdebug - Debug print routines
  4 *
  5 *****************************************************************************/
  6
  7/*
  8 * Copyright (C) 2000 - 2011, 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#include "accommon.h"
 46
 47#define _COMPONENT          ACPI_UTILITIES
 48ACPI_MODULE_NAME("utdebug")
 49#ifdef ACPI_DEBUG_OUTPUT
 50static acpi_thread_id acpi_gbl_prev_thread_id;
 51static char *acpi_gbl_fn_entry_str = "----Entry";
 52static char *acpi_gbl_fn_exit_str = "----Exit-";
 53
 54/* Local prototypes */
 55
 56static const char *acpi_ut_trim_function_name(const char *function_name);
 57
 58/*******************************************************************************
 59 *
 60 * FUNCTION:    acpi_ut_init_stack_ptr_trace
 61 *
 62 * PARAMETERS:  None
 63 *
 64 * RETURN:      None
 65 *
 66 * DESCRIPTION: Save the current CPU stack pointer at subsystem startup
 67 *
 68 ******************************************************************************/
 69
 70void acpi_ut_init_stack_ptr_trace(void)
 71{
 72	acpi_size current_sp;
 73
 74	acpi_gbl_entry_stack_pointer = &current_sp;
 75}
 76
 77/*******************************************************************************
 78 *
 79 * FUNCTION:    acpi_ut_track_stack_ptr
 80 *
 81 * PARAMETERS:  None
 82 *
 83 * RETURN:      None
 84 *
 85 * DESCRIPTION: Save the current CPU stack pointer
 86 *
 87 ******************************************************************************/
 88
 89void acpi_ut_track_stack_ptr(void)
 90{
 91	acpi_size current_sp;
 92
 93	if (&current_sp < acpi_gbl_lowest_stack_pointer) {
 94		acpi_gbl_lowest_stack_pointer = &current_sp;
 95	}
 96
 97	if (acpi_gbl_nesting_level > acpi_gbl_deepest_nesting) {
 98		acpi_gbl_deepest_nesting = acpi_gbl_nesting_level;
 99	}
100}
101
102/*******************************************************************************
103 *
104 * FUNCTION:    acpi_ut_trim_function_name
105 *
106 * PARAMETERS:  function_name       - Ascii string containing a procedure name
107 *
108 * RETURN:      Updated pointer to the function name
109 *
110 * DESCRIPTION: Remove the "Acpi" prefix from the function name, if present.
111 *              This allows compiler macros such as __func__ to be used
112 *              with no change to the debug output.
113 *
114 ******************************************************************************/
115
116static const char *acpi_ut_trim_function_name(const char *function_name)
117{
118
119	/* All Function names are longer than 4 chars, check is safe */
120
121	if (*(ACPI_CAST_PTR(u32, function_name)) == ACPI_PREFIX_MIXED) {
122
123		/* This is the case where the original source has not been modified */
124
125		return (function_name + 4);
126	}
127
128	if (*(ACPI_CAST_PTR(u32, function_name)) == ACPI_PREFIX_LOWER) {
129
130		/* This is the case where the source has been 'linuxized' */
131
132		return (function_name + 5);
133	}
134
135	return (function_name);
136}
137
138/*******************************************************************************
139 *
140 * FUNCTION:    acpi_debug_print
141 *
142 * PARAMETERS:  requested_debug_level - Requested debug print level
143 *              line_number         - Caller's line number (for error output)
144 *              function_name       - Caller's procedure name
145 *              module_name         - Caller's module name
146 *              component_id        - Caller's component ID
147 *              Format              - Printf format field
148 *              ...                 - Optional printf arguments
149 *
150 * RETURN:      None
151 *
152 * DESCRIPTION: Print error message with prefix consisting of the module name,
153 *              line number, and component ID.
154 *
155 ******************************************************************************/
156
157void ACPI_INTERNAL_VAR_XFACE
158acpi_debug_print(u32 requested_debug_level,
159		 u32 line_number,
160		 const char *function_name,
161		 const char *module_name,
162		 u32 component_id, const char *format, ...)
163{
164	acpi_thread_id thread_id;
165	va_list args;
166
167	/*
168	 * Stay silent if the debug level or component ID is disabled
169	 */
170	if (!(requested_debug_level & acpi_dbg_level) ||
171	    !(component_id & acpi_dbg_layer)) {
172		return;
173	}
174
175	/*
176	 * Thread tracking and context switch notification
177	 */
178	thread_id = acpi_os_get_thread_id();
179	if (thread_id != acpi_gbl_prev_thread_id) {
180		if (ACPI_LV_THREADS & acpi_dbg_level) {
181			acpi_os_printf
182			    ("\n**** Context Switch from TID %u to TID %u ****\n\n",
183			     (u32)acpi_gbl_prev_thread_id, (u32)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("[%u] ", (u32)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_debug_print)
209
210/*******************************************************************************
211 *
212 * FUNCTION:    acpi_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_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_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_debug_print(ACPI_LV_FUNCTIONS,
274			 line_number, function_name, module_name, component_id,
275			 "%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_debug_print(ACPI_LV_FUNCTIONS,
305			 line_number, function_name, module_name, component_id,
306			 "%s %p\n", acpi_gbl_fn_entry_str, pointer);
307}
308
309/*******************************************************************************
310 *
311 * FUNCTION:    acpi_ut_trace_str
312 *
313 * PARAMETERS:  line_number         - Caller's line number
314 *              function_name       - Caller's procedure name
315 *              module_name         - Caller's module name
316 *              component_id        - Caller's component ID
317 *              String              - Additional string to display
318 *
319 * RETURN:      None
320 *
321 * DESCRIPTION: Function entry trace.  Prints only if TRACE_FUNCTIONS bit is
322 *              set in debug_level
323 *
324 ******************************************************************************/
325
326void
327acpi_ut_trace_str(u32 line_number,
328		  const char *function_name,
329		  const char *module_name, u32 component_id, char *string)
330{
331
332	acpi_gbl_nesting_level++;
333	acpi_ut_track_stack_ptr();
334
335	acpi_debug_print(ACPI_LV_FUNCTIONS,
336			 line_number, function_name, module_name, component_id,
337			 "%s %s\n", acpi_gbl_fn_entry_str, string);
338}
339
340/*******************************************************************************
341 *
342 * FUNCTION:    acpi_ut_trace_u32
343 *
344 * PARAMETERS:  line_number         - Caller's line number
345 *              function_name       - Caller's procedure name
346 *              module_name         - Caller's module name
347 *              component_id        - Caller's component ID
348 *              Integer             - Integer to display
349 *
350 * RETURN:      None
351 *
352 * DESCRIPTION: Function entry trace.  Prints only if TRACE_FUNCTIONS bit is
353 *              set in debug_level
354 *
355 ******************************************************************************/
356
357void
358acpi_ut_trace_u32(u32 line_number,
359		  const char *function_name,
360		  const char *module_name, u32 component_id, u32 integer)
361{
362
363	acpi_gbl_nesting_level++;
364	acpi_ut_track_stack_ptr();
365
366	acpi_debug_print(ACPI_LV_FUNCTIONS,
367			 line_number, function_name, module_name, component_id,
368			 "%s %08X\n", acpi_gbl_fn_entry_str, integer);
369}
370
371/*******************************************************************************
372 *
373 * FUNCTION:    acpi_ut_exit
374 *
375 * PARAMETERS:  line_number         - Caller's line number
376 *              function_name       - Caller's procedure name
377 *              module_name         - Caller's module name
378 *              component_id        - Caller's component ID
379 *
380 * RETURN:      None
381 *
382 * DESCRIPTION: Function exit trace.  Prints only if TRACE_FUNCTIONS bit is
383 *              set in debug_level
384 *
385 ******************************************************************************/
386
387void
388acpi_ut_exit(u32 line_number,
389	     const char *function_name,
390	     const char *module_name, u32 component_id)
391{
392
393	acpi_debug_print(ACPI_LV_FUNCTIONS,
394			 line_number, function_name, module_name, component_id,
395			 "%s\n", acpi_gbl_fn_exit_str);
396
397	acpi_gbl_nesting_level--;
398}
399
400ACPI_EXPORT_SYMBOL(acpi_ut_exit)
401
402/*******************************************************************************
403 *
404 * FUNCTION:    acpi_ut_status_exit
405 *
406 * PARAMETERS:  line_number         - Caller's line number
407 *              function_name       - Caller's procedure name
408 *              module_name         - Caller's module name
409 *              component_id        - Caller's component ID
410 *              Status              - Exit status code
411 *
412 * RETURN:      None
413 *
414 * DESCRIPTION: Function exit trace.  Prints only if TRACE_FUNCTIONS bit is
415 *              set in debug_level. Prints exit status also.
416 *
417 ******************************************************************************/
418void
419acpi_ut_status_exit(u32 line_number,
420		    const char *function_name,
421		    const char *module_name,
422		    u32 component_id, acpi_status status)
423{
424
425	if (ACPI_SUCCESS(status)) {
426		acpi_debug_print(ACPI_LV_FUNCTIONS,
427				 line_number, function_name, module_name,
428				 component_id, "%s %s\n", acpi_gbl_fn_exit_str,
429				 acpi_format_exception(status));
430	} else {
431		acpi_debug_print(ACPI_LV_FUNCTIONS,
432				 line_number, function_name, module_name,
433				 component_id, "%s ****Exception****: %s\n",
434				 acpi_gbl_fn_exit_str,
435				 acpi_format_exception(status));
436	}
437
438	acpi_gbl_nesting_level--;
439}
440
441ACPI_EXPORT_SYMBOL(acpi_ut_status_exit)
442
443/*******************************************************************************
444 *
445 * FUNCTION:    acpi_ut_value_exit
446 *
447 * PARAMETERS:  line_number         - Caller's line number
448 *              function_name       - Caller's procedure name
449 *              module_name         - Caller's module name
450 *              component_id        - Caller's component ID
451 *              Value               - Value to be printed with exit msg
452 *
453 * RETURN:      None
454 *
455 * DESCRIPTION: Function exit trace.  Prints only if TRACE_FUNCTIONS bit is
456 *              set in debug_level. Prints exit value also.
457 *
458 ******************************************************************************/
459void
460acpi_ut_value_exit(u32 line_number,
461		   const char *function_name,
462		   const char *module_name, u32 component_id, u64 value)
463{
464
465	acpi_debug_print(ACPI_LV_FUNCTIONS,
466			 line_number, function_name, module_name, component_id,
467			 "%s %8.8X%8.8X\n", acpi_gbl_fn_exit_str,
468			 ACPI_FORMAT_UINT64(value));
469
470	acpi_gbl_nesting_level--;
471}
472
473ACPI_EXPORT_SYMBOL(acpi_ut_value_exit)
474
475/*******************************************************************************
476 *
477 * FUNCTION:    acpi_ut_ptr_exit
478 *
479 * PARAMETERS:  line_number         - Caller's line number
480 *              function_name       - Caller's procedure name
481 *              module_name         - Caller's module name
482 *              component_id        - Caller's component ID
483 *              Ptr                 - Pointer to display
484 *
485 * RETURN:      None
486 *
487 * DESCRIPTION: Function exit trace.  Prints only if TRACE_FUNCTIONS bit is
488 *              set in debug_level. Prints exit value also.
489 *
490 ******************************************************************************/
491void
492acpi_ut_ptr_exit(u32 line_number,
493		 const char *function_name,
494		 const char *module_name, u32 component_id, u8 *ptr)
495{
496
497	acpi_debug_print(ACPI_LV_FUNCTIONS,
498			 line_number, function_name, module_name, component_id,
499			 "%s %p\n", acpi_gbl_fn_exit_str, ptr);
500
501	acpi_gbl_nesting_level--;
502}
503
504#endif
505
506/*******************************************************************************
507 *
508 * FUNCTION:    acpi_ut_dump_buffer
509 *
510 * PARAMETERS:  Buffer              - Buffer to dump
511 *              Count               - Amount to dump, in bytes
512 *              Display             - BYTE, WORD, DWORD, or QWORD display
513 *              component_iD        - Caller's component ID
514 *
515 * RETURN:      None
516 *
517 * DESCRIPTION: Generic dump buffer in both hex and ascii.
518 *
519 ******************************************************************************/
520
521void acpi_ut_dump_buffer2(u8 * buffer, u32 count, u32 display)
522{
523	u32 i = 0;
524	u32 j;
525	u32 temp32;
526	u8 buf_char;
527
528	if (!buffer) {
529		acpi_os_printf("Null Buffer Pointer in DumpBuffer!\n");
530		return;
531	}
532
533	if ((count < 4) || (count & 0x01)) {
534		display = DB_BYTE_DISPLAY;
535	}
536
537	/* Nasty little dump buffer routine! */
538
539	while (i < count) {
540
541		/* Print current offset */
542
543		acpi_os_printf("%6.4X: ", i);
544
545		/* Print 16 hex chars */
546
547		for (j = 0; j < 16;) {
548			if (i + j >= count) {
549
550				/* Dump fill spaces */
551
552				acpi_os_printf("%*s", ((display * 2) + 1), " ");
553				j += display;
554				continue;
555			}
556
557			switch (display) {
558			case DB_BYTE_DISPLAY:
559			default:	/* Default is BYTE display */
560
561				acpi_os_printf("%02X ",
562					       buffer[(acpi_size) i + j]);
563				break;
564
565			case DB_WORD_DISPLAY:
566
567				ACPI_MOVE_16_TO_32(&temp32,
568						   &buffer[(acpi_size) i + j]);
569				acpi_os_printf("%04X ", temp32);
570				break;
571
572			case DB_DWORD_DISPLAY:
573
574				ACPI_MOVE_32_TO_32(&temp32,
575						   &buffer[(acpi_size) i + j]);
576				acpi_os_printf("%08X ", temp32);
577				break;
578
579			case DB_QWORD_DISPLAY:
580
581				ACPI_MOVE_32_TO_32(&temp32,
582						   &buffer[(acpi_size) i + j]);
583				acpi_os_printf("%08X", temp32);
584
585				ACPI_MOVE_32_TO_32(&temp32,
586						   &buffer[(acpi_size) i + j +
587							   4]);
588				acpi_os_printf("%08X ", temp32);
589				break;
590			}
591
592			j += display;
593		}
594
595		/*
596		 * Print the ASCII equivalent characters but watch out for the bad
597		 * unprintable ones (printable chars are 0x20 through 0x7E)
598		 */
599		acpi_os_printf(" ");
600		for (j = 0; j < 16; j++) {
601			if (i + j >= count) {
602				acpi_os_printf("\n");
603				return;
604			}
605
606			buf_char = buffer[(acpi_size) i + j];
607			if (ACPI_IS_PRINT(buf_char)) {
608				acpi_os_printf("%c", buf_char);
609			} else {
610				acpi_os_printf(".");
611			}
612		}
613
614		/* Done with that line. */
615
616		acpi_os_printf("\n");
617		i += 16;
618	}
619
620	return;
621}
622
623/*******************************************************************************
624 *
625 * FUNCTION:    acpi_ut_dump_buffer
626 *
627 * PARAMETERS:  Buffer              - Buffer to dump
628 *              Count               - Amount to dump, in bytes
629 *              Display             - BYTE, WORD, DWORD, or QWORD display
630 *              component_iD        - Caller's component ID
631 *
632 * RETURN:      None
633 *
634 * DESCRIPTION: Generic dump buffer in both hex and ascii.
635 *
636 ******************************************************************************/
637
638void acpi_ut_dump_buffer(u8 * buffer, u32 count, u32 display, u32 component_id)
639{
640
641	/* Only dump the buffer if tracing is enabled */
642
643	if (!((ACPI_LV_TABLES & acpi_dbg_level) &&
644	      (component_id & acpi_dbg_layer))) {
645		return;
646	}
647
648	acpi_ut_dump_buffer2(buffer, count, display);
649}
v3.5.6
  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 = &current_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 (&current_sp < acpi_gbl_lowest_stack_pointer) {
 95		acpi_gbl_lowest_stack_pointer = &current_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}