acpica/executer/exdebug.c

0001 /******************************************************************************
0002  *
0003  * Module Name: exdebug - Support for stores to the AML Debug Object
0004  *
0005  *****************************************************************************/
0006
0007 /******************************************************************************
0008  *
0009  * 1. Copyright Notice
0010  *
0011  * Some or all of this work - Copyright (c) 1999 - 2024, Intel Corp.
0012  * All rights reserved.
0013  *
0014  * 2. License
0015  *
0016  * 2.1. This is your license from Intel Corp. under its intellectual property
0017  * rights. You may have additional license terms from the party that provided
0018  * you this software, covering your right to use that party's intellectual
0019  * property rights.
0020  *
0021  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
0022  * copy of the source code appearing in this file ("Covered Code") an
0023  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
0024  * base code distributed originally by Intel ("Original Intel Code") to copy,
0025  * make derivatives, distribute, use and display any portion of the Covered
0026  * Code in any form, with the right to sublicense such rights; and
0027  *
0028  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
0029  * license (with the right to sublicense), under only those claims of Intel
0030  * patents that are infringed by the Original Intel Code, to make, use, sell,
0031  * offer to sell, and import the Covered Code and derivative works thereof
0032  * solely to the minimum extent necessary to exercise the above copyright
0033  * license, and in no event shall the patent license extend to any additions
0034  * to or modifications of the Original Intel Code. No other license or right
0035  * is granted directly or by implication, estoppel or otherwise;
0036  *
0037  * The above copyright and patent license is granted only if the following
0038  * conditions are met:
0039  *
0040  * 3. Conditions
0041  *
0042  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
0043  * Redistribution of source code of any substantial portion of the Covered
0044  * Code or modification with rights to further distribute source must include
0045  * the above Copyright Notice, the above License, this list of Conditions,
0046  * and the following Disclaimer and Export Compliance provision. In addition,
0047  * Licensee must cause all Covered Code to which Licensee contributes to
0048  * contain a file documenting the changes Licensee made to create that Covered
0049  * Code and the date of any change. Licensee must include in that file the
0050  * documentation of any changes made by any predecessor Licensee. Licensee
0051  * must include a prominent statement that the modification is derived,
0052  * directly or indirectly, from Original Intel Code.
0053  *
0054  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
0055  * Redistribution of source code of any substantial portion of the Covered
0056  * Code or modification without rights to further distribute source must
0057  * include the following Disclaimer and Export Compliance provision in the
0058  * documentation and/or other materials provided with distribution. In
0059  * addition, Licensee may not authorize further sublicense of source of any
0060  * portion of the Covered Code, and must include terms to the effect that the
0061  * license from Licensee to its licensee is limited to the intellectual
0062  * property embodied in the software Licensee provides to its licensee, and
0063  * not to intellectual property embodied in modifications its licensee may
0064  * make.
0065  *
0066  * 3.3. Redistribution of Executable. Redistribution in executable form of any
0067  * substantial portion of the Covered Code or modification must reproduce the
0068  * above Copyright Notice, and the following Disclaimer and Export Compliance
0069  * provision in the documentation and/or other materials provided with the
0070  * distribution.
0071  *
0072  * 3.4. Intel retains all right, title, and interest in and to the Original
0073  * Intel Code.
0074  *
0075  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
0076  * Intel shall be used in advertising or otherwise to promote the sale, use or
0077  * other dealings in products derived from or relating to the Covered Code
0078  * without prior written authorization from Intel.
0079  *
0080  * 4. Disclaimer and Export Compliance
0081  *
0082  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
0083  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
0084  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
0085  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
0086  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
0087  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
0088  * PARTICULAR PURPOSE.
0089  *
0090  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
0091  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
0092  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
0093  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
0094  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
0095  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
0096  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
0097  * LIMITED REMEDY.
0098  *
0099  * 4.3. Licensee shall not export, either directly or indirectly, any of this
0100  * software or system incorporating such software without first obtaining any
0101  * required license or other approval from the U. S. Department of Commerce or
0102  * any other agency or department of the United States Government. In the
0103  * event Licensee exports any such software from the United States or
0104  * re-exports any such software from a foreign destination, Licensee shall
0105  * ensure that the distribution and export/re-export of the software is in
0106  * compliance with all laws, regulations, orders, or other restrictions of the
0107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
0108  * any of its subsidiaries will export/re-export any technical data, process,
0109  * software, or service, directly or indirectly, to any country for which the
0110  * United States government or any agency thereof requires an export license,
0111  * other governmental approval, or letter of assurance, without first obtaining
0112  * such license, approval or letter.
0113  *
0114  *****************************************************************************
0115  *
0116  * Alternatively, you may choose to be licensed under the terms of the
0117  * following license:
0118  *
0119  * Redistribution and use in source and binary forms, with or without
0120  * modification, are permitted provided that the following conditions
0121  * are met:
0122  * 1. Redistributions of source code must retain the above copyright
0123  *    notice, this list of conditions, and the following disclaimer,
0124  *    without modification.
0125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
0126  *    substantially similar to the "NO WARRANTY" disclaimer below
0127  *    ("Disclaimer") and any redistribution must be conditioned upon
0128  *    including a substantially similar Disclaimer requirement for further
0129  *    binary redistribution.
0130  * 3. Neither the names of the above-listed copyright holders nor the names
0131  *    of any contributors may be used to endorse or promote products derived
0132  *    from this software without specific prior written permission.
0133  *
0134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
0135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
0136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
0137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
0138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
0139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
0140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
0141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
0142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
0143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
0144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0145  *
0146  * Alternatively, you may choose to be licensed under the terms of the
0147  * GNU General Public License ("GPL") version 2 as published by the Free
0148  * Software Foundation.
0149  *
0150  *****************************************************************************/
0151
0152 #include "acpi.h"
0153 #include "accommon.h"
0154 #include "acinterp.h"
0155
0156
0157 #define _COMPONENT          ACPI_EXECUTER
0158         ACPI_MODULE_NAME    ("exdebug")
0159
0160
0161 #ifndef ACPI_NO_ERROR_MESSAGES
0162 /*******************************************************************************
0163  *
0164  * FUNCTION:    AcpiExDoDebugObject
0165  *
0166  * PARAMETERS:  SourceDesc          - Object to be output to "Debug Object"
0167  *              Level               - Indentation level (used for packages)
0168  *              Index               - Current package element, zero if not pkg
0169  *
0170  * RETURN:      None
0171  *
0172  * DESCRIPTION: Handles stores to the AML Debug Object. For example:
0173  *              Store(INT1, Debug)
0174  *
0175  * This function is not compiled if ACPI_NO_ERROR_MESSAGES is set.
0176  *
0177  * This function is only enabled if AcpiGbl_EnableAmlDebugObject is set, or
0178  * if ACPI_LV_DEBUG_OBJECT is set in the AcpiDbgLevel. Thus, in the normal
0179  * operational case, stores to the debug object are ignored but can be easily
0180  * enabled if necessary.
0181  *
0182  ******************************************************************************/
0183
0184 void
0185 AcpiExDoDebugObject (
0186     ACPI_OPERAND_OBJECT     *SourceDesc,
0187     UINT32                  Level,
0188     UINT32                  Index)
0189 {
0190     UINT32                  i;
0191     UINT32                  Timer;
0192     ACPI_OPERAND_OBJECT     *ObjectDesc;
0193     UINT32                  Value;
0194
0195
0196     ACPI_FUNCTION_TRACE_PTR (ExDoDebugObject, SourceDesc);
0197
0198
0199     /* Output must be enabled via the DebugObject global or the DbgLevel */
0200
0201     if (!AcpiGbl_EnableAmlDebugObject &&
0202         !(AcpiDbgLevel & ACPI_LV_DEBUG_OBJECT))
0203     {
0204         return_VOID;
0205     }
0206
0207     /* Newline -- don't emit the line header */
0208
0209     if (SourceDesc &&
0210         (ACPI_GET_DESCRIPTOR_TYPE (SourceDesc) == ACPI_DESC_TYPE_OPERAND) &&
0211         (SourceDesc->Common.Type == ACPI_TYPE_STRING))
0212     {
0213         if ((SourceDesc->String.Length == 1) &&
0214             (*SourceDesc->String.Pointer == '\n'))
0215         {
0216             AcpiOsPrintf ("\n");
0217             return_VOID;
0218         }
0219     }
0220
0221     /*
0222      * Print line header as long as we are not in the middle of an
0223      * object display
0224      */
0225     if (!((Level > 0) && Index == 0))
0226     {
0227         if (AcpiGbl_DisplayDebugTimer)
0228         {
0229             /*
0230              * We will emit the current timer value (in microseconds) with each
0231              * debug output. Only need the lower 26 bits. This allows for 67
0232              * million microseconds or 67 seconds before rollover.
0233              *
0234              * Convert 100 nanosecond units to microseconds
0235              */
0236             Timer = ((UINT32) AcpiOsGetTimer () / 10);
0237             Timer &= 0x03FFFFFF;
0238
0239             AcpiOsPrintf ("ACPI Debug: T=0x%8.8X %*s", Timer, Level, " ");
0240         }
0241         else
0242         {
0243             AcpiOsPrintf ("ACPI Debug: %*s", Level, " ");
0244         }
0245     }
0246
0247     /* Display the index for package output only */
0248
0249     if (Index > 0)
0250     {
0251        AcpiOsPrintf ("(%.2u) ", Index - 1);
0252     }
0253
0254     if (!SourceDesc)
0255     {
0256         AcpiOsPrintf ("[Null Object]\n");
0257         return_VOID;
0258     }
0259
0260     if (ACPI_GET_DESCRIPTOR_TYPE (SourceDesc) == ACPI_DESC_TYPE_OPERAND)
0261     {
0262         /* No object type prefix needed for integers and strings */
0263
0264         if ((SourceDesc->Common.Type != ACPI_TYPE_INTEGER) &&
0265             (SourceDesc->Common.Type != ACPI_TYPE_STRING))
0266         {
0267             AcpiOsPrintf ("%s  ", AcpiUtGetObjectTypeName (SourceDesc));
0268         }
0269
0270         if (!AcpiUtValidInternalObject (SourceDesc))
0271         {
0272            AcpiOsPrintf ("%p, Invalid Internal Object!\n", SourceDesc);
0273            return_VOID;
0274         }
0275     }
0276     else if (ACPI_GET_DESCRIPTOR_TYPE (SourceDesc) == ACPI_DESC_TYPE_NAMED)
0277     {
0278         AcpiOsPrintf ("%s  (Node %p)\n",
0279             AcpiUtGetTypeName (((ACPI_NAMESPACE_NODE *) SourceDesc)->Type),
0280                 SourceDesc);
0281         return_VOID;
0282     }
0283     else
0284     {
0285         return_VOID;
0286     }
0287
0288     /* SourceDesc is of type ACPI_DESC_TYPE_OPERAND */
0289
0290     switch (SourceDesc->Common.Type)
0291     {
0292     case ACPI_TYPE_INTEGER:
0293
0294         /* Output correct integer width */
0295
0296         if (AcpiGbl_IntegerByteWidth == 4)
0297         {
0298             AcpiOsPrintf ("0x%8.8X\n",
0299                 (UINT32) SourceDesc->Integer.Value);
0300         }
0301         else
0302         {
0303             AcpiOsPrintf ("0x%8.8X%8.8X\n",
0304                 ACPI_FORMAT_UINT64 (SourceDesc->Integer.Value));
0305         }
0306         break;
0307
0308     case ACPI_TYPE_BUFFER:
0309
0310         AcpiOsPrintf ("[0x%.2X]\n", (UINT32) SourceDesc->Buffer.Length);
0311         AcpiUtDumpBuffer (SourceDesc->Buffer.Pointer,
0312             (SourceDesc->Buffer.Length < 256) ?
0313                 SourceDesc->Buffer.Length : 256, DB_BYTE_DISPLAY, 0);
0314         break;
0315
0316     case ACPI_TYPE_STRING:
0317
0318         AcpiOsPrintf ("\"%s\"\n", SourceDesc->String.Pointer);
0319         break;
0320
0321     case ACPI_TYPE_PACKAGE:
0322
0323         AcpiOsPrintf ("(Contains 0x%.2X Elements):\n",
0324             SourceDesc->Package.Count);
0325
0326         /* Output the entire contents of the package */
0327
0328         for (i = 0; i < SourceDesc->Package.Count; i++)
0329         {
0330             AcpiExDoDebugObject (SourceDesc->Package.Elements[i],
0331                 Level + 4, i + 1);
0332         }
0333         break;
0334
0335     case ACPI_TYPE_LOCAL_REFERENCE:
0336
0337         AcpiOsPrintf ("[%s] ", AcpiUtGetReferenceName (SourceDesc));
0338
0339         /* Decode the reference */
0340
0341         switch (SourceDesc->Reference.Class)
0342         {
0343         case ACPI_REFCLASS_INDEX:
0344
0345             AcpiOsPrintf ("0x%X\n", SourceDesc->Reference.Value);
0346             break;
0347
0348         case ACPI_REFCLASS_TABLE:
0349
0350             /* Case for DdbHandle */
0351
0352             AcpiOsPrintf ("Table Index 0x%X\n", SourceDesc->Reference.Value);
0353             return_VOID;
0354
0355         default:
0356
0357             break;
0358         }
0359
0360         AcpiOsPrintf ("  ");
0361
0362         /* Check for valid node first, then valid object */
0363
0364         if (SourceDesc->Reference.Node)
0365         {
0366             if (ACPI_GET_DESCRIPTOR_TYPE (SourceDesc->Reference.Node) !=
0367                 ACPI_DESC_TYPE_NAMED)
0368             {
0369                 AcpiOsPrintf (" %p - Not a valid namespace node\n",
0370                     SourceDesc->Reference.Node);
0371             }
0372             else
0373             {
0374                 AcpiOsPrintf ("Node %p [%4.4s] ", SourceDesc->Reference.Node,
0375                     (SourceDesc->Reference.Node)->Name.Ascii);
0376
0377                 switch ((SourceDesc->Reference.Node)->Type)
0378                 {
0379                 /* These types have no attached object */
0380
0381                 case ACPI_TYPE_DEVICE:
0382                     AcpiOsPrintf ("Device\n");
0383                     break;
0384
0385                 case ACPI_TYPE_THERMAL:
0386                     AcpiOsPrintf ("Thermal Zone\n");
0387                     break;
0388
0389                 default:
0390
0391                     AcpiExDoDebugObject ((SourceDesc->Reference.Node)->Object,
0392                         Level + 4, 0);
0393                     break;
0394                 }
0395             }
0396         }
0397         else if (SourceDesc->Reference.Object)
0398         {
0399             if (ACPI_GET_DESCRIPTOR_TYPE (SourceDesc->Reference.Object) ==
0400                 ACPI_DESC_TYPE_NAMED)
0401             {
0402                 /* Reference object is a namespace node */
0403
0404                 AcpiExDoDebugObject (ACPI_CAST_PTR (ACPI_OPERAND_OBJECT,
0405                     SourceDesc->Reference.Object),
0406                     Level + 4, 0);
0407             }
0408             else
0409             {
0410                 ObjectDesc = SourceDesc->Reference.Object;
0411                 Value = SourceDesc->Reference.Value;
0412
0413                 switch (ObjectDesc->Common.Type)
0414                 {
0415                 case ACPI_TYPE_BUFFER:
0416
0417                     AcpiOsPrintf ("Buffer[%u] = 0x%2.2X\n",
0418                         Value, *SourceDesc->Reference.IndexPointer);
0419                     break;
0420
0421                 case ACPI_TYPE_STRING:
0422
0423                     AcpiOsPrintf ("String[%u] = \"%c\" (0x%2.2X)\n",
0424                         Value, *SourceDesc->Reference.IndexPointer,
0425                         *SourceDesc->Reference.IndexPointer);
0426                     break;
0427
0428                 case ACPI_TYPE_PACKAGE:
0429
0430                     AcpiOsPrintf ("Package[%u] = ", Value);
0431                     if (!(*SourceDesc->Reference.Where))
0432                     {
0433                         AcpiOsPrintf ("[Uninitialized Package Element]\n");
0434                     }
0435                     else
0436                     {
0437                         AcpiExDoDebugObject (*SourceDesc->Reference.Where,
0438                             Level+4, 0);
0439                     }
0440                     break;
0441
0442                 default:
0443
0444                     AcpiOsPrintf ("Unknown Reference object type %X\n",
0445                         ObjectDesc->Common.Type);
0446                     break;
0447                 }
0448             }
0449         }
0450         break;
0451
0452     default:
0453
0454         AcpiOsPrintf ("(Descriptor %p)\n", SourceDesc);
0455         break;
0456     }
0457
0458     ACPI_DEBUG_PRINT_RAW ((ACPI_DB_EXEC, "\n"));
0459     return_VOID;
0460 }
0461 #endif