xref: /illumos-gate/usr/src/common/acpica/executer/exdebug.c (revision 35786f6866ae52207d0f1a25fe7ca5f652f32ce0)
1 /******************************************************************************
2  *
3  * Module Name: exdebug - Support for stores to the AML Debug Object
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
12  * All rights reserved.
13  *
14  * 2. License
15  *
16  * 2.1. This is your license from Intel Corp. under its intellectual property
17  * rights. You may have additional license terms from the party that provided
18  * you this software, covering your right to use that party's intellectual
19  * property rights.
20  *
21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22  * copy of the source code appearing in this file ("Covered Code") an
23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24  * base code distributed originally by Intel ("Original Intel Code") to copy,
25  * make derivatives, distribute, use and display any portion of the Covered
26  * Code in any form, with the right to sublicense such rights; and
27  *
28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29  * license (with the right to sublicense), under only those claims of Intel
30  * patents that are infringed by the Original Intel Code, to make, use, sell,
31  * offer to sell, and import the Covered Code and derivative works thereof
32  * solely to the minimum extent necessary to exercise the above copyright
33  * license, and in no event shall the patent license extend to any additions
34  * to or modifications of the Original Intel Code. No other license or right
35  * is granted directly or by implication, estoppel or otherwise;
36  *
37  * The above copyright and patent license is granted only if the following
38  * conditions are met:
39  *
40  * 3. Conditions
41  *
42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43  * Redistribution of source code of any substantial portion of the Covered
44  * Code or modification with rights to further distribute source must include
45  * the above Copyright Notice, the above License, this list of Conditions,
46  * and the following Disclaimer and Export Compliance provision. In addition,
47  * Licensee must cause all Covered Code to which Licensee contributes to
48  * contain a file documenting the changes Licensee made to create that Covered
49  * Code and the date of any change. Licensee must include in that file the
50  * documentation of any changes made by any predecessor Licensee. Licensee
51  * must include a prominent statement that the modification is derived,
52  * directly or indirectly, from Original Intel Code.
53  *
54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55  * Redistribution of source code of any substantial portion of the Covered
56  * Code or modification without rights to further distribute source must
57  * include the following Disclaimer and Export Compliance provision in the
58  * documentation and/or other materials provided with distribution. In
59  * addition, Licensee may not authorize further sublicense of source of any
60  * portion of the Covered Code, and must include terms to the effect that the
61  * license from Licensee to its licensee is limited to the intellectual
62  * property embodied in the software Licensee provides to its licensee, and
63  * not to intellectual property embodied in modifications its licensee may
64  * make.
65  *
66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
67  * substantial portion of the Covered Code or modification must reproduce the
68  * above Copyright Notice, and the following Disclaimer and Export Compliance
69  * provision in the documentation and/or other materials provided with the
70  * distribution.
71  *
72  * 3.4. Intel retains all right, title, and interest in and to the Original
73  * Intel Code.
74  *
75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76  * Intel shall be used in advertising or otherwise to promote the sale, use or
77  * other dealings in products derived from or relating to the Covered Code
78  * without prior written authorization from Intel.
79  *
80  * 4. Disclaimer and Export Compliance
81  *
82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88  * PARTICULAR PURPOSE.
89  *
90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97  * LIMITED REMEDY.
98  *
99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
100  * software or system incorporating such software without first obtaining any
101  * required license or other approval from the U. S. Department of Commerce or
102  * any other agency or department of the United States Government. In the
103  * event Licensee exports any such software from the United States or
104  * re-exports any such software from a foreign destination, Licensee shall
105  * ensure that the distribution and export/re-export of the software is in
106  * compliance with all laws, regulations, orders, or other restrictions of the
107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108  * any of its subsidiaries will export/re-export any technical data, process,
109  * software, or service, directly or indirectly, to any country for which the
110  * United States government or any agency thereof requires an export license,
111  * other governmental approval, or letter of assurance, without first obtaining
112  * such license, approval or letter.
113  *
114  *****************************************************************************
115  *
116  * Alternatively, you may choose to be licensed under the terms of the
117  * following license:
118  *
119  * Redistribution and use in source and binary forms, with or without
120  * modification, are permitted provided that the following conditions
121  * are met:
122  * 1. Redistributions of source code must retain the above copyright
123  *    notice, this list of conditions, and the following disclaimer,
124  *    without modification.
125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126  *    substantially similar to the "NO WARRANTY" disclaimer below
127  *    ("Disclaimer") and any redistribution must be conditioned upon
128  *    including a substantially similar Disclaimer requirement for further
129  *    binary redistribution.
130  * 3. Neither the names of the above-listed copyright holders nor the names
131  *    of any contributors may be used to endorse or promote products derived
132  *    from this software without specific prior written permission.
133  *
134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145  *
146  * Alternatively, you may choose to be licensed under the terms of the
147  * GNU General Public License ("GPL") version 2 as published by the Free
148  * Software Foundation.
149  *
150  *****************************************************************************/
151 
152 #include "acpi.h"
153 #include "accommon.h"
154 #include "acinterp.h"
155 
156 
157 #define _COMPONENT          ACPI_EXECUTER
158         ACPI_MODULE_NAME    ("exdebug")
159 
160 
161 #ifndef ACPI_NO_ERROR_MESSAGES
162 /*******************************************************************************
163  *
164  * FUNCTION:    AcpiExDoDebugObject
165  *
166  * PARAMETERS:  SourceDesc          - Object to be output to "Debug Object"
167  *              Level               - Indentation level (used for packages)
168  *              Index               - Current package element, zero if not pkg
169  *
170  * RETURN:      None
171  *
172  * DESCRIPTION: Handles stores to the AML Debug Object. For example:
173  *              Store(INT1, Debug)
174  *
175  * This function is not compiled if ACPI_NO_ERROR_MESSAGES is set.
176  *
177  * This function is only enabled if AcpiGbl_EnableAmlDebugObject is set, or
178  * if ACPI_LV_DEBUG_OBJECT is set in the AcpiDbgLevel. Thus, in the normal
179  * operational case, stores to the debug object are ignored but can be easily
180  * enabled if necessary.
181  *
182  ******************************************************************************/
183 
184 void
AcpiExDoDebugObject(ACPI_OPERAND_OBJECT * SourceDesc,UINT32 Level,UINT32 Index)185 AcpiExDoDebugObject (
186     ACPI_OPERAND_OBJECT     *SourceDesc,
187     UINT32                  Level,
188     UINT32                  Index)
189 {
190     UINT32                  i;
191     UINT32                  Timer;
192     ACPI_OPERAND_OBJECT     *ObjectDesc;
193     UINT32                  Value;
194 
195 
196     ACPI_FUNCTION_TRACE_PTR (ExDoDebugObject, SourceDesc);
197 
198 
199     /* Output must be enabled via the DebugObject global or the DbgLevel */
200 
201     if (!AcpiGbl_EnableAmlDebugObject &&
202         !(AcpiDbgLevel & ACPI_LV_DEBUG_OBJECT))
203     {
204         return_VOID;
205     }
206 
207     /* Newline -- don't emit the line header */
208 
209     if (SourceDesc &&
210         (ACPI_GET_DESCRIPTOR_TYPE (SourceDesc) == ACPI_DESC_TYPE_OPERAND) &&
211         (SourceDesc->Common.Type == ACPI_TYPE_STRING))
212     {
213         if ((SourceDesc->String.Length == 1) &&
214             (*SourceDesc->String.Pointer == '\n'))
215         {
216             AcpiOsPrintf ("\n");
217             return_VOID;
218         }
219     }
220 
221     /*
222      * Print line header as long as we are not in the middle of an
223      * object display
224      */
225     if (!((Level > 0) && Index == 0))
226     {
227         if (AcpiGbl_DisplayDebugTimer)
228         {
229             /*
230              * We will emit the current timer value (in microseconds) with each
231              * debug output. Only need the lower 26 bits. This allows for 67
232              * million microseconds or 67 seconds before rollover.
233              *
234              * Convert 100 nanosecond units to microseconds
235              */
236             Timer = ((UINT32) AcpiOsGetTimer () / 10);
237             Timer &= 0x03FFFFFF;
238 
239             AcpiOsPrintf ("ACPI Debug: T=0x%8.8X %*s", Timer, Level, " ");
240         }
241         else
242         {
243             AcpiOsPrintf ("ACPI Debug: %*s", Level, " ");
244         }
245     }
246 
247     /* Display the index for package output only */
248 
249     if (Index > 0)
250     {
251        AcpiOsPrintf ("(%.2u) ", Index - 1);
252     }
253 
254     if (!SourceDesc)
255     {
256         AcpiOsPrintf ("[Null Object]\n");
257         return_VOID;
258     }
259 
260     if (ACPI_GET_DESCRIPTOR_TYPE (SourceDesc) == ACPI_DESC_TYPE_OPERAND)
261     {
262         /* No object type prefix needed for integers and strings */
263 
264         if ((SourceDesc->Common.Type != ACPI_TYPE_INTEGER) &&
265             (SourceDesc->Common.Type != ACPI_TYPE_STRING))
266         {
267             AcpiOsPrintf ("%s  ", AcpiUtGetObjectTypeName (SourceDesc));
268         }
269 
270         if (!AcpiUtValidInternalObject (SourceDesc))
271         {
272            AcpiOsPrintf ("%p, Invalid Internal Object!\n", SourceDesc);
273            return_VOID;
274         }
275     }
276     else if (ACPI_GET_DESCRIPTOR_TYPE (SourceDesc) == ACPI_DESC_TYPE_NAMED)
277     {
278         AcpiOsPrintf ("%s  (Node %p)\n",
279             AcpiUtGetTypeName (((ACPI_NAMESPACE_NODE *) SourceDesc)->Type),
280                 SourceDesc);
281         return_VOID;
282     }
283     else
284     {
285         return_VOID;
286     }
287 
288     /* SourceDesc is of type ACPI_DESC_TYPE_OPERAND */
289 
290     switch (SourceDesc->Common.Type)
291     {
292     case ACPI_TYPE_INTEGER:
293 
294         /* Output correct integer width */
295 
296         if (AcpiGbl_IntegerByteWidth == 4)
297         {
298             AcpiOsPrintf ("0x%8.8X\n",
299                 (UINT32) SourceDesc->Integer.Value);
300         }
301         else
302         {
303             AcpiOsPrintf ("0x%8.8X%8.8X\n",
304                 ACPI_FORMAT_UINT64 (SourceDesc->Integer.Value));
305         }
306         break;
307 
308     case ACPI_TYPE_BUFFER:
309 
310         AcpiOsPrintf ("[0x%.2X]\n", (UINT32) SourceDesc->Buffer.Length);
311         AcpiUtDumpBuffer (SourceDesc->Buffer.Pointer,
312             (SourceDesc->Buffer.Length < 256) ?
313                 SourceDesc->Buffer.Length : 256, DB_BYTE_DISPLAY, 0);
314         break;
315 
316     case ACPI_TYPE_STRING:
317 
318         AcpiOsPrintf ("\"%s\"\n", SourceDesc->String.Pointer);
319         break;
320 
321     case ACPI_TYPE_PACKAGE:
322 
323         AcpiOsPrintf ("(Contains 0x%.2X Elements):\n",
324             SourceDesc->Package.Count);
325 
326         /* Output the entire contents of the package */
327 
328         for (i = 0; i < SourceDesc->Package.Count; i++)
329         {
330             AcpiExDoDebugObject (SourceDesc->Package.Elements[i],
331                 Level + 4, i + 1);
332         }
333         break;
334 
335     case ACPI_TYPE_LOCAL_REFERENCE:
336 
337         AcpiOsPrintf ("[%s] ", AcpiUtGetReferenceName (SourceDesc));
338 
339         /* Decode the reference */
340 
341         switch (SourceDesc->Reference.Class)
342         {
343         case ACPI_REFCLASS_INDEX:
344 
345             AcpiOsPrintf ("0x%X\n", SourceDesc->Reference.Value);
346             break;
347 
348         case ACPI_REFCLASS_TABLE:
349 
350             /* Case for DdbHandle */
351 
352             AcpiOsPrintf ("Table Index 0x%X\n", SourceDesc->Reference.Value);
353             return_VOID;
354 
355         default:
356 
357             break;
358         }
359 
360         AcpiOsPrintf ("  ");
361 
362         /* Check for valid node first, then valid object */
363 
364         if (SourceDesc->Reference.Node)
365         {
366             if (ACPI_GET_DESCRIPTOR_TYPE (SourceDesc->Reference.Node) !=
367                 ACPI_DESC_TYPE_NAMED)
368             {
369                 AcpiOsPrintf (" %p - Not a valid namespace node\n",
370                     SourceDesc->Reference.Node);
371             }
372             else
373             {
374                 AcpiOsPrintf ("Node %p [%4.4s] ", SourceDesc->Reference.Node,
375                     (SourceDesc->Reference.Node)->Name.Ascii);
376 
377                 switch ((SourceDesc->Reference.Node)->Type)
378                 {
379                 /* These types have no attached object */
380 
381                 case ACPI_TYPE_DEVICE:
382                     AcpiOsPrintf ("Device\n");
383                     break;
384 
385                 case ACPI_TYPE_THERMAL:
386                     AcpiOsPrintf ("Thermal Zone\n");
387                     break;
388 
389                 default:
390 
391                     AcpiExDoDebugObject ((SourceDesc->Reference.Node)->Object,
392                         Level + 4, 0);
393                     break;
394                 }
395             }
396         }
397         else if (SourceDesc->Reference.Object)
398         {
399             if (ACPI_GET_DESCRIPTOR_TYPE (SourceDesc->Reference.Object) ==
400                 ACPI_DESC_TYPE_NAMED)
401             {
402                 /* Reference object is a namespace node */
403 
404                 AcpiExDoDebugObject (ACPI_CAST_PTR (ACPI_OPERAND_OBJECT,
405                     SourceDesc->Reference.Object),
406                     Level + 4, 0);
407             }
408             else
409             {
410                 ObjectDesc = SourceDesc->Reference.Object;
411                 Value = SourceDesc->Reference.Value;
412 
413                 switch (ObjectDesc->Common.Type)
414                 {
415                 case ACPI_TYPE_BUFFER:
416 
417                     AcpiOsPrintf ("Buffer[%u] = 0x%2.2X\n",
418                         Value, *SourceDesc->Reference.IndexPointer);
419                     break;
420 
421                 case ACPI_TYPE_STRING:
422 
423                     AcpiOsPrintf ("String[%u] = \"%c\" (0x%2.2X)\n",
424                         Value, *SourceDesc->Reference.IndexPointer,
425                         *SourceDesc->Reference.IndexPointer);
426                     break;
427 
428                 case ACPI_TYPE_PACKAGE:
429 
430                     AcpiOsPrintf ("Package[%u] = ", Value);
431                     if (!(*SourceDesc->Reference.Where))
432                     {
433                         AcpiOsPrintf ("[Uninitialized Package Element]\n");
434                     }
435                     else
436                     {
437                         AcpiExDoDebugObject (*SourceDesc->Reference.Where,
438                             Level+4, 0);
439                     }
440                     break;
441 
442                 default:
443 
444                     AcpiOsPrintf ("Unknown Reference object type %X\n",
445                         ObjectDesc->Common.Type);
446                     break;
447                 }
448             }
449         }
450         break;
451 
452     default:
453 
454         AcpiOsPrintf ("(Descriptor %p)\n", SourceDesc);
455         break;
456     }
457 
458     ACPI_DEBUG_PRINT_RAW ((ACPI_DB_EXEC, "\n"));
459     return_VOID;
460 }
461 #endif
462