sys/contrib/dev/acpica/source/components/disassembler/dmresrcs.c

   1 /*******************************************************************************
   2  *
   3  * Module Name: dmresrcs.c - "Small" Resource Descriptor disassembly
   4  *
   5  ******************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2021, 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 "acdisasm.h"
 155
 156
 157 #ifdef ACPI_DISASSEMBLER
 158
 159 #define _COMPONENT          ACPI_CA_DEBUGGER
 160         ACPI_MODULE_NAME    ("dbresrcs")
 161
 162
 163 /*******************************************************************************
 164  *
 165  * FUNCTION:    AcpiDmIrqDescriptor
 166  *
 167  * PARAMETERS:  Info                - Extra resource info
 168  *              Resource            - Pointer to the resource descriptor
 169  *              Length              - Length of the descriptor in bytes
 170  *              Level               - Current source code indentation level
 171  *
 172  * RETURN:      None
 173  *
 174  * DESCRIPTION: Decode a IRQ descriptor, either Irq() or IrqNoFlags()
 175  *
 176  ******************************************************************************/
 177
 178 void
 179 AcpiDmIrqDescriptor (
 180     ACPI_OP_WALK_INFO       *Info,
 181     AML_RESOURCE            *Resource,
 182     UINT32                  Length,
 183     UINT32                  Level)
 184 {
 185
 186     AcpiDmIndent (Level);
 187     AcpiOsPrintf ("%s (",
 188         AcpiGbl_IrqDecode [ACPI_GET_1BIT_FLAG (Length)]);
 189
 190     /* Decode flags byte if present */
 191
 192     if (Length & 1)
 193     {
 194         AcpiOsPrintf ("%s, %s, %s, ",
 195             AcpiGbl_HeDecode [ACPI_GET_1BIT_FLAG (Resource->Irq.Flags)],
 196             AcpiGbl_LlDecode [ACPI_EXTRACT_1BIT_FLAG (Resource->Irq.Flags, 3)],
 197             AcpiGbl_ShrDecode [ACPI_EXTRACT_2BIT_FLAG (Resource->Irq.Flags, 4)]);
 198     }
 199
 200     /* Insert a descriptor name */
 201
 202     AcpiDmDescriptorName ();
 203     AcpiOsPrintf (")\n");
 204
 205     AcpiDmIndent (Level + 1);
 206     AcpiDmBitList (Resource->Irq.IrqMask);
 207 }
 208
 209
 210 /*******************************************************************************
 211  *
 212  * FUNCTION:    AcpiDmDmaDescriptor
 213  *
 214  * PARAMETERS:  Info                - Extra resource info
 215  *              Resource            - Pointer to the resource descriptor
 216  *              Length              - Length of the descriptor in bytes
 217  *              Level               - Current source code indentation level
 218  *
 219  * RETURN:      None
 220  *
 221  * DESCRIPTION: Decode a DMA descriptor
 222  *
 223  ******************************************************************************/
 224
 225 void
 226 AcpiDmDmaDescriptor (
 227     ACPI_OP_WALK_INFO       *Info,
 228     AML_RESOURCE            *Resource,
 229     UINT32                  Length,
 230     UINT32                  Level)
 231 {
 232
 233     AcpiDmIndent (Level);
 234     AcpiOsPrintf ("DMA (%s, %s, %s, ",
 235         AcpiGbl_TypDecode [ACPI_EXTRACT_2BIT_FLAG (Resource->Dma.Flags, 5)],
 236         AcpiGbl_BmDecode  [ACPI_EXTRACT_1BIT_FLAG (Resource->Dma.Flags, 2)],
 237         AcpiGbl_SizDecode [ACPI_GET_2BIT_FLAG (Resource->Dma.Flags)]);
 238
 239     /* Insert a descriptor name */
 240
 241     AcpiDmDescriptorName ();
 242     AcpiOsPrintf (")\n");
 243
 244     AcpiDmIndent (Level + 1);
 245     AcpiDmBitList (Resource->Dma.DmaChannelMask);
 246 }
 247
 248
 249 /*******************************************************************************
 250  *
 251  * FUNCTION:    AcpiDmFixedDmaDescriptor
 252  *
 253  * PARAMETERS:  Info                - Extra resource info
 254  *              Resource            - Pointer to the resource descriptor
 255  *              Length              - Length of the descriptor in bytes
 256  *              Level               - Current source code indentation level
 257  *
 258  * RETURN:      None
 259  *
 260  * DESCRIPTION: Decode a FixedDMA descriptor
 261  *
 262  ******************************************************************************/
 263
 264 void
 265 AcpiDmFixedDmaDescriptor (
 266     ACPI_OP_WALK_INFO       *Info,
 267     AML_RESOURCE            *Resource,
 268     UINT32                  Length,
 269     UINT32                  Level)
 270 {
 271
 272     AcpiDmIndent (Level);
 273     AcpiOsPrintf ("FixedDMA (0x%4.4X, 0x%4.4X, ",
 274         Resource->FixedDma.RequestLines,
 275         Resource->FixedDma.Channels);
 276
 277     if (Resource->FixedDma.Width <= 5)
 278     {
 279         AcpiOsPrintf ("%s, ",
 280             AcpiGbl_DtsDecode [Resource->FixedDma.Width]);
 281     }
 282     else
 283     {
 284         AcpiOsPrintf ("%X /* INVALID DMA WIDTH */, ",
 285             Resource->FixedDma.Width);
 286     }
 287
 288     /* Insert a descriptor name */
 289
 290     AcpiDmDescriptorName ();
 291     AcpiOsPrintf (")\n");
 292 }
 293
 294
 295 /*******************************************************************************
 296  *
 297  * FUNCTION:    AcpiDmIoDescriptor
 298  *
 299  * PARAMETERS:  Info                - Extra resource info
 300  *              Resource            - Pointer to the resource descriptor
 301  *              Length              - Length of the descriptor in bytes
 302  *              Level               - Current source code indentation level
 303  *
 304  * RETURN:      None
 305  *
 306  * DESCRIPTION: Decode an IO descriptor
 307  *
 308  ******************************************************************************/
 309
 310 void
 311 AcpiDmIoDescriptor (
 312     ACPI_OP_WALK_INFO       *Info,
 313     AML_RESOURCE            *Resource,
 314     UINT32                  Length,
 315     UINT32                  Level)
 316 {
 317
 318     AcpiDmIndent (Level);
 319     AcpiOsPrintf ("IO (%s,\n",
 320         AcpiGbl_IoDecode [ACPI_GET_1BIT_FLAG (Resource->Io.Flags)]);
 321
 322     AcpiDmIndent (Level + 1);
 323     AcpiDmDumpInteger16 (Resource->Io.Minimum, "Range Minimum");
 324
 325     AcpiDmIndent (Level + 1);
 326     AcpiDmDumpInteger16 (Resource->Io.Maximum, "Range Maximum");
 327
 328     AcpiDmIndent (Level + 1);
 329     AcpiDmDumpInteger8 (Resource->Io.Alignment, "Alignment");
 330
 331     AcpiDmIndent (Level + 1);
 332     AcpiDmDumpInteger8 (Resource->Io.AddressLength, "Length");
 333
 334     /* Insert a descriptor name */
 335
 336     AcpiDmIndent (Level + 1);
 337     AcpiDmDescriptorName ();
 338     AcpiOsPrintf (")\n");
 339 }
 340
 341
 342 /*******************************************************************************
 343  *
 344  * FUNCTION:    AcpiDmFixedIoDescriptor
 345  *
 346  * PARAMETERS:  Info                - Extra resource info
 347  *              Resource            - Pointer to the resource descriptor
 348  *              Length              - Length of the descriptor in bytes
 349  *              Level               - Current source code indentation level
 350  *
 351  * RETURN:      None
 352  *
 353  * DESCRIPTION: Decode a Fixed IO descriptor
 354  *
 355  ******************************************************************************/
 356
 357 void
 358 AcpiDmFixedIoDescriptor (
 359     ACPI_OP_WALK_INFO       *Info,
 360     AML_RESOURCE            *Resource,
 361     UINT32                  Length,
 362     UINT32                  Level)
 363 {
 364
 365     AcpiDmIndent (Level);
 366     AcpiOsPrintf ("FixedIO (\n");
 367
 368     AcpiDmIndent (Level + 1);
 369     AcpiDmDumpInteger16 (Resource->FixedIo.Address, "Address");
 370
 371     AcpiDmIndent (Level + 1);
 372     AcpiDmDumpInteger8 (Resource->FixedIo.AddressLength, "Length");
 373
 374     /* Insert a descriptor name */
 375
 376     AcpiDmIndent (Level + 1);
 377     AcpiDmDescriptorName ();
 378     AcpiOsPrintf (")\n");
 379 }
 380
 381
 382 /*******************************************************************************
 383  *
 384  * FUNCTION:    AcpiDmStartDependentDescriptor
 385  *
 386  * PARAMETERS:  Info                - Extra resource info
 387  *              Resource            - Pointer to the resource descriptor
 388  *              Length              - Length of the descriptor in bytes
 389  *              Level               - Current source code indentation level
 390  *
 391  * RETURN:      None
 392  *
 393  * DESCRIPTION: Decode a Start Dependent functions descriptor
 394  *
 395  ******************************************************************************/
 396
 397 void
 398 AcpiDmStartDependentDescriptor (
 399     ACPI_OP_WALK_INFO       *Info,
 400     AML_RESOURCE            *Resource,
 401     UINT32                  Length,
 402     UINT32                  Level)
 403 {
 404
 405     AcpiDmIndent (Level);
 406
 407     if (Length & 1)
 408     {
 409         AcpiOsPrintf ("StartDependentFn (0x%2.2X, 0x%2.2X)\n",
 410             (UINT32) ACPI_GET_2BIT_FLAG (Resource->StartDpf.Flags),
 411             (UINT32) ACPI_EXTRACT_2BIT_FLAG (Resource->StartDpf.Flags, 2));
 412     }
 413     else
 414     {
 415         AcpiOsPrintf ("StartDependentFnNoPri ()\n");
 416     }
 417
 418     AcpiDmIndent (Level);
 419     AcpiOsPrintf ("{\n");
 420 }
 421
 422
 423 /*******************************************************************************
 424  *
 425  * FUNCTION:    AcpiDmEndDependentDescriptor
 426  *
 427  * PARAMETERS:  Info                - Extra resource info
 428  *              Resource            - Pointer to the resource descriptor
 429  *              Length              - Length of the descriptor in bytes
 430  *              Level               - Current source code indentation level
 431  *
 432  * RETURN:      None
 433  *
 434  * DESCRIPTION: Decode an End Dependent functions descriptor
 435  *
 436  ******************************************************************************/
 437
 438 void
 439 AcpiDmEndDependentDescriptor (
 440     ACPI_OP_WALK_INFO       *Info,
 441     AML_RESOURCE            *Resource,
 442     UINT32                  Length,
 443     UINT32                  Level)
 444 {
 445
 446     AcpiDmIndent (Level);
 447     AcpiOsPrintf ("}\n");
 448     AcpiDmIndent (Level);
 449     AcpiOsPrintf ("EndDependentFn ()\n");
 450 }
 451
 452
 453 /*******************************************************************************
 454  *
 455  * FUNCTION:    AcpiDmVendorSmallDescriptor
 456  *
 457  * PARAMETERS:  Info                - Extra resource info
 458  *              Resource            - Pointer to the resource descriptor
 459  *              Length              - Length of the descriptor in bytes
 460  *              Level               - Current source code indentation level
 461  *
 462  * RETURN:      None
 463  *
 464  * DESCRIPTION: Decode a Vendor Small Descriptor
 465  *
 466  ******************************************************************************/
 467
 468 void
 469 AcpiDmVendorSmallDescriptor (
 470     ACPI_OP_WALK_INFO       *Info,
 471     AML_RESOURCE            *Resource,
 472     UINT32                  Length,
 473     UINT32                  Level)
 474 {
 475
 476     AcpiDmVendorCommon ("Short",
 477         ACPI_ADD_PTR (UINT8, Resource, sizeof (AML_RESOURCE_SMALL_HEADER)),
 478         Length, Level);
 479 }
 480
 481 #endif