src/add-ons/kernel/bus_managers/acpi/acpica/components/executer/exdebug.c

   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 - 2014, 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 #define __EXDEBUG_C__
 117
 118 #include "acpi.h"
 119 #include "accommon.h"
 120 #include "acinterp.h"
 121
 122
 123 #define _COMPONENT          ACPI_EXECUTER
 124         ACPI_MODULE_NAME    ("exdebug")
 125
 126
 127 #ifndef ACPI_NO_ERROR_MESSAGES
 128 /*******************************************************************************
 129  *
 130  * FUNCTION:    AcpiExDoDebugObject
 131  *
 132  * PARAMETERS:  SourceDesc          - Object to be output to "Debug Object"
 133  *              Level               - Indentation level (used for packages)
 134  *              Index               - Current package element, zero if not pkg
 135  *
 136  * RETURN:      None
 137  *
 138  * DESCRIPTION: Handles stores to the AML Debug Object. For example:
 139  *              Store(INT1, Debug)
 140  *
 141  * This function is not compiled if ACPI_NO_ERROR_MESSAGES is set.
 142  *
 143  * This function is only enabled if AcpiGbl_EnableAmlDebugObject is set, or
 144  * if ACPI_LV_DEBUG_OBJECT is set in the AcpiDbgLevel. Thus, in the normal
 145  * operational case, stores to the debug object are ignored but can be easily
 146  * enabled if necessary.
 147  *
 148  ******************************************************************************/
 149
 150 void
 151 AcpiExDoDebugObject (
 152     ACPI_OPERAND_OBJECT     *SourceDesc,
 153     UINT32                  Level,
 154     UINT32                  Index)
 155 {
 156     UINT32                  i;
 157     UINT32                  Timer;
 158
 159
 160     ACPI_FUNCTION_TRACE_PTR (ExDoDebugObject, SourceDesc);
 161
 162
 163     /* Output must be enabled via the DebugObject global or the DbgLevel */
 164
 165     if (!AcpiGbl_EnableAmlDebugObject &&
 166         !(AcpiDbgLevel & ACPI_LV_DEBUG_OBJECT))
 167     {
 168         return_VOID;
 169     }
 170
 171     /*
 172      * We will emit the current timer value (in microseconds) with each
 173      * debug output. Only need the lower 26 bits. This allows for 67
 174      * million microseconds or 67 seconds before rollover.
 175      */
 176     Timer = (UINT32) (AcpiOsGetTimer () / 10); /* (100 nanoseconds to microseconds) */
 177     Timer &= 0x03FFFFFF;
 178
 179     /*
 180      * Print line header as long as we are not in the middle of an
 181      * object display
 182      */
 183     if (!((Level > 0) && Index == 0))
 184     {
 185         AcpiOsPrintf ("[ACPI Debug %.8u] %*s", Timer, Level, " ");
 186     }
 187
 188     /* Display the index for package output only */
 189
 190     if (Index > 0)
 191     {
 192        AcpiOsPrintf ("(%.2u) ", Index-1);
 193     }
 194
 195     if (!SourceDesc)
 196     {
 197         AcpiOsPrintf ("[Null Object]\n");
 198         return_VOID;
 199     }
 200
 201     if (ACPI_GET_DESCRIPTOR_TYPE (SourceDesc) == ACPI_DESC_TYPE_OPERAND)
 202     {
 203         AcpiOsPrintf ("%s ", AcpiUtGetObjectTypeName (SourceDesc));
 204
 205         if (!AcpiUtValidInternalObject (SourceDesc))
 206         {
 207            AcpiOsPrintf ("%p, Invalid Internal Object!\n", SourceDesc);
 208            return_VOID;
 209         }
 210     }
 211     else if (ACPI_GET_DESCRIPTOR_TYPE (SourceDesc) == ACPI_DESC_TYPE_NAMED)
 212     {
 213         AcpiOsPrintf ("%s: %p\n",
 214             AcpiUtGetTypeName (((ACPI_NAMESPACE_NODE *) SourceDesc)->Type),
 215             SourceDesc);
 216         return_VOID;
 217     }
 218     else
 219     {
 220         return_VOID;
 221     }
 222
 223     /* SourceDesc is of type ACPI_DESC_TYPE_OPERAND */
 224
 225     switch (SourceDesc->Common.Type)
 226     {
 227     case ACPI_TYPE_INTEGER:
 228
 229         /* Output correct integer width */
 230
 231         if (AcpiGbl_IntegerByteWidth == 4)
 232         {
 233             AcpiOsPrintf ("0x%8.8X\n",
 234                 (UINT32) SourceDesc->Integer.Value);
 235         }
 236         else
 237         {
 238             AcpiOsPrintf ("0x%8.8X%8.8X\n",
 239                 ACPI_FORMAT_UINT64 (SourceDesc->Integer.Value));
 240         }
 241         break;
 242
 243     case ACPI_TYPE_BUFFER:
 244
 245         AcpiOsPrintf ("[0x%.2X]\n", (UINT32) SourceDesc->Buffer.Length);
 246         AcpiUtDumpBuffer (SourceDesc->Buffer.Pointer,
 247             (SourceDesc->Buffer.Length < 256) ?
 248                 SourceDesc->Buffer.Length : 256, DB_BYTE_DISPLAY, 0);
 249         break;
 250
 251     case ACPI_TYPE_STRING:
 252
 253         AcpiOsPrintf ("[0x%.2X] \"%s\"\n",
 254             SourceDesc->String.Length, SourceDesc->String.Pointer);
 255         break;
 256
 257     case ACPI_TYPE_PACKAGE:
 258
 259         AcpiOsPrintf ("[Contains 0x%.2X Elements]\n",
 260             SourceDesc->Package.Count);
 261
 262         /* Output the entire contents of the package */
 263
 264         for (i = 0; i < SourceDesc->Package.Count; i++)
 265         {
 266             AcpiExDoDebugObject (SourceDesc->Package.Elements[i],
 267                 Level+4, i+1);
 268         }
 269         break;
 270
 271     case ACPI_TYPE_LOCAL_REFERENCE:
 272
 273         AcpiOsPrintf ("[%s] ", AcpiUtGetReferenceName (SourceDesc));
 274
 275         /* Decode the reference */
 276
 277         switch (SourceDesc->Reference.Class)
 278         {
 279         case ACPI_REFCLASS_INDEX:
 280
 281             AcpiOsPrintf ("0x%X\n", SourceDesc->Reference.Value);
 282             break;
 283
 284         case ACPI_REFCLASS_TABLE:
 285
 286             /* Case for DdbHandle */
 287
 288             AcpiOsPrintf ("Table Index 0x%X\n", SourceDesc->Reference.Value);
 289             return_VOID;
 290
 291         default:
 292
 293             break;
 294         }
 295
 296         AcpiOsPrintf ("  ");
 297
 298         /* Check for valid node first, then valid object */
 299
 300         if (SourceDesc->Reference.Node)
 301         {
 302             if (ACPI_GET_DESCRIPTOR_TYPE (SourceDesc->Reference.Node) !=
 303                     ACPI_DESC_TYPE_NAMED)
 304             {
 305                 AcpiOsPrintf (" %p - Not a valid namespace node\n",
 306                     SourceDesc->Reference.Node);
 307             }
 308             else
 309             {
 310                 AcpiOsPrintf ("Node %p [%4.4s] ", SourceDesc->Reference.Node,
 311                     (SourceDesc->Reference.Node)->Name.Ascii);
 312
 313                 switch ((SourceDesc->Reference.Node)->Type)
 314                 {
 315                 /* These types have no attached object */
 316
 317                 case ACPI_TYPE_DEVICE:
 318                     AcpiOsPrintf ("Device\n");
 319                     break;
 320
 321                 case ACPI_TYPE_THERMAL:
 322                     AcpiOsPrintf ("Thermal Zone\n");
 323                     break;
 324
 325                 default:
 326
 327                     AcpiExDoDebugObject ((SourceDesc->Reference.Node)->Object,
 328                         Level+4, 0);
 329                     break;
 330                 }
 331             }
 332         }
 333         else if (SourceDesc->Reference.Object)
 334         {
 335             if (ACPI_GET_DESCRIPTOR_TYPE (SourceDesc->Reference.Object) ==
 336                     ACPI_DESC_TYPE_NAMED)
 337             {
 338                 AcpiExDoDebugObject (((ACPI_NAMESPACE_NODE *)
 339                     SourceDesc->Reference.Object)->Object,
 340                     Level+4, 0);
 341             }
 342             else
 343             {
 344                 AcpiExDoDebugObject (SourceDesc->Reference.Object,
 345                     Level+4, 0);
 346             }
 347         }
 348         break;
 349
 350     default:
 351
 352         AcpiOsPrintf ("%p\n", SourceDesc);
 353         break;
 354     }
 355
 356     ACPI_DEBUG_PRINT_RAW ((ACPI_DB_EXEC, "\n"));
 357     return_VOID;
 358 }
 359 #endif