sys/contrib/dev/acpica/dmresrc.c

   1 /*******************************************************************************
   2  *
   3  * Module Name: dmresrc.c - Resource Descriptor disassembly
   4  *              $Revision: 7 $
   5  *
   6  ******************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2003, Intel Corp.
  13  * All rights reserved.
  14  *
  15  * 2. License
  16  *
  17  * 2.1. This is your license from Intel Corp. under its intellectual property
  18  * rights.  You may have additional license terms from the party that provided
  19  * you this software, covering your right to use that party's intellectual
  20  * property rights.
  21  *
  22  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  23  * copy of the source code appearing in this file ("Covered Code") an
  24  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  25  * base code distributed originally by Intel ("Original Intel Code") to copy,
  26  * make derivatives, distribute, use and display any portion of the Covered
  27  * Code in any form, with the right to sublicense such rights; and
  28  *
  29  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  30  * license (with the right to sublicense), under only those claims of Intel
  31  * patents that are infringed by the Original Intel Code, to make, use, sell,
  32  * offer to sell, and import the Covered Code and derivative works thereof
  33  * solely to the minimum extent necessary to exercise the above copyright
  34  * license, and in no event shall the patent license extend to any additions
  35  * to or modifications of the Original Intel Code.  No other license or right
  36  * is granted directly or by implication, estoppel or otherwise;
  37  *
  38  * The above copyright and patent license is granted only if the following
  39  * conditions are met:
  40  *
  41  * 3. Conditions
  42  *
  43  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  44  * Redistribution of source code of any substantial portion of the Covered
  45  * Code or modification with rights to further distribute source must include
  46  * the above Copyright Notice, the above License, this list of Conditions,
  47  * and the following Disclaimer and Export Compliance provision.  In addition,
  48  * Licensee must cause all Covered Code to which Licensee contributes to
  49  * contain a file documenting the changes Licensee made to create that Covered
  50  * Code and the date of any change.  Licensee must include in that file the
  51  * documentation of any changes made by any predecessor Licensee.  Licensee
  52  * must include a prominent statement that the modification is derived,
  53  * directly or indirectly, from Original Intel Code.
  54  *
  55  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  56  * Redistribution of source code of any substantial portion of the Covered
  57  * Code or modification without rights to further distribute source must
  58  * include the following Disclaimer and Export Compliance provision in the
  59  * documentation and/or other materials provided with distribution.  In
  60  * addition, Licensee may not authorize further sublicense of source of any
  61  * portion of the Covered Code, and must include terms to the effect that the
  62  * license from Licensee to its licensee is limited to the intellectual
  63  * property embodied in the software Licensee provides to its licensee, and
  64  * not to intellectual property embodied in modifications its licensee may
  65  * make.
  66  *
  67  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  68  * substantial portion of the Covered Code or modification must reproduce the
  69  * above Copyright Notice, and the following Disclaimer and Export Compliance
  70  * provision in the documentation and/or other materials provided with the
  71  * distribution.
  72  *
  73  * 3.4. Intel retains all right, title, and interest in and to the Original
  74  * Intel Code.
  75  *
  76  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  77  * Intel shall be used in advertising or otherwise to promote the sale, use or
  78  * other dealings in products derived from or relating to the Covered Code
  79  * without prior written authorization from Intel.
  80  *
  81  * 4. Disclaimer and Export Compliance
  82  *
  83  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  84  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  85  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  86  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  87  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  88  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  89  * PARTICULAR PURPOSE.
  90  *
  91  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  92  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  93  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  94  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  95  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  96  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  97  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  98  * LIMITED REMEDY.
  99  *
 100  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 101  * software or system incorporating such software without first obtaining any
 102  * required license or other approval from the U. S. Department of Commerce or
 103  * any other agency or department of the United States Government.  In the
 104  * event Licensee exports any such software from the United States or
 105  * re-exports any such software from a foreign destination, Licensee shall
 106  * ensure that the distribution and export/re-export of the software is in
 107  * compliance with all laws, regulations, orders, or other restrictions of the
 108  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 109  * any of its subsidiaries will export/re-export any technical data, process,
 110  * software, or service, directly or indirectly, to any country for which the
 111  * United States government or any agency thereof requires an export license,
 112  * other governmental approval, or letter of assurance, without first obtaining
 113  * such license, approval or letter.
 114  *
 115  *****************************************************************************/
 116 /* $DragonFly: src/sys/contrib/dev/acpica/Attic/dmresrc.c,v 1.1 2003/09/24 03:32:15 drhodus Exp $                                                               */
 117
 118 #include "acpi.h"
 119 #include "amlcode.h"
 120 #include "acdisasm.h"
 121
 122 #ifdef ACPI_DISASSEMBLER
 123
 124 #define _COMPONENT          ACPI_CA_DEBUGGER
 125         ACPI_MODULE_NAME    ("dbresrc")
 126
 127
 128 /*******************************************************************************
 129  *
 130  * FUNCTION:    AcpiDmBitList
 131  *
 132  * PARAMETERS:  Mask            - 16-bit value corresponding to 16 interrupt
 133  *                                or DMA values
 134  *
 135  * RETURN:      None
 136  *
 137  * DESCRIPTION: Dump a bit mask as a list of individual interrupt/dma levels.
 138  *
 139  ******************************************************************************/
 140
 141 void
 142 AcpiDmBitList (
 143     UINT16                  Mask)
 144 {
 145     UINT32                  i;
 146     BOOLEAN                 Previous = FALSE;
 147
 148
 149     /* Open the initializer list */
 150
 151     AcpiOsPrintf (") {");
 152
 153     /* Examine each bit */
 154
 155     for (i = 0; i < 16; i++)
 156     {
 157         /* Only interested in bits that are set to 1 */
 158
 159         if (Mask & 1)
 160         {
 161             if (Previous)
 162             {
 163                 AcpiOsPrintf (",");
 164             }
 165             Previous = TRUE;
 166             AcpiOsPrintf ("%d", i);
 167         }
 168
 169         Mask >>= 1;
 170     }
 171
 172     /* Close list */
 173
 174     AcpiOsPrintf ("}\n");
 175 }
 176
 177
 178 /*******************************************************************************
 179  *
 180  * FUNCTION:    AcpiDmResourceDescriptor
 181  *
 182  * PARAMETERS:  Info            - Curent parse tree walk info
 183  *              ByteData        - Pointer to the byte list data
 184  *              ByteCount       - Length of the byte list
 185  *
 186  * RETURN:      None
 187  *
 188  * DESCRIPTION: Dump the contents of one ResourceTemplate descriptor.
 189  *
 190  ******************************************************************************/
 191
 192 void
 193 AcpiDmResourceDescriptor (
 194     ACPI_OP_WALK_INFO       *Info,
 195     UINT8                   *ByteData,
 196     UINT32                  ByteCount)
 197 {
 198     ACPI_NATIVE_UINT        CurrentByteOffset;
 199     UINT8                   CurrentByte;
 200     UINT8                   DescriptorId;
 201     UINT32                  Length;
 202     void                    *DescriptorBody;
 203     UINT32                  Level;
 204     BOOLEAN                 DependentFns = FALSE;
 205
 206
 207     Level = Info->Level;
 208
 209     for (CurrentByteOffset = 0; CurrentByteOffset < ByteCount; )
 210     {
 211         CurrentByte = ByteData[CurrentByteOffset];
 212         DescriptorBody = &ByteData[CurrentByteOffset];
 213
 214         if (CurrentByte & ACPI_RDESC_TYPE_LARGE)
 215         {
 216             DescriptorId = CurrentByte;
 217             Length = (* (ACPI_CAST_PTR (UINT16, &ByteData[CurrentByteOffset + 1])));
 218             CurrentByteOffset += 3;
 219         }
 220         else
 221         {
 222             DescriptorId = (UINT8) (CurrentByte & 0xF8);
 223             Length = (ByteData[CurrentByteOffset] & 0x7);
 224             CurrentByteOffset += 1;
 225         }
 226
 227         CurrentByteOffset += (ACPI_NATIVE_UINT) Length;
 228
 229         /* Determine type of resource */
 230
 231         switch (DescriptorId)
 232         {
 233         /*
 234          * "Small" type descriptors
 235          */
 236         case ACPI_RDESC_TYPE_IRQ_FORMAT:
 237
 238             AcpiDmIrqDescriptor (DescriptorBody, Length, Level);
 239             break;
 240
 241
 242         case ACPI_RDESC_TYPE_DMA_FORMAT:
 243
 244             AcpiDmDmaDescriptor (DescriptorBody, Length, Level);
 245             break;
 246
 247
 248         case ACPI_RDESC_TYPE_START_DEPENDENT:
 249
 250             /* Finish a previous StartDependentFns */
 251
 252             if (DependentFns)
 253             {
 254                 Level--;
 255                 AcpiDmIndent (Level);
 256                 AcpiOsPrintf ("}\n");
 257             }
 258
 259             AcpiDmStartDependentDescriptor (DescriptorBody, Length, Level);
 260             DependentFns = TRUE;
 261             Level++;
 262             break;
 263
 264
 265         case ACPI_RDESC_TYPE_END_DEPENDENT:
 266
 267             Level--;
 268             DependentFns = FALSE;
 269             AcpiDmEndDependentDescriptor (DescriptorBody, Length, Level);
 270             break;
 271
 272
 273         case ACPI_RDESC_TYPE_IO_PORT:
 274
 275             AcpiDmIoDescriptor (DescriptorBody, Length, Level);
 276             break;
 277
 278
 279         case ACPI_RDESC_TYPE_FIXED_IO_PORT:
 280
 281             AcpiDmFixedIoDescriptor (DescriptorBody, Length, Level);
 282             break;
 283
 284
 285         case ACPI_RDESC_TYPE_SMALL_VENDOR:
 286
 287             AcpiDmVendorSmallDescriptor (DescriptorBody, Length, Level);
 288             break;
 289
 290
 291         case ACPI_RDESC_TYPE_END_TAG:
 292
 293             if (DependentFns)
 294             {
 295                 /*
 296                  * Close an open StartDependentDescriptor.  This indicates a missing
 297                  * EndDependentDescriptor.
 298                  */
 299                 Level--;
 300                 DependentFns = FALSE;
 301                 AcpiDmIndent (Level);
 302                 AcpiOsPrintf ("}\n");
 303                 AcpiDmIndent (Level);
 304
 305                 AcpiOsPrintf ("/*** Missing EndDependentFunctions descriptor */");
 306
 307                 /*
 308                  * We could fix the problem, but then the ASL would not match the AML
 309                  * So, we don't do this:
 310                  * AcpiDmEndDependentDescriptor (DescriptorBody, Length, Level);
 311                  */
 312             }
 313             return;
 314
 315
 316         /*
 317          * "Large" type descriptors
 318          */
 319         case ACPI_RDESC_TYPE_MEMORY_24:
 320
 321             AcpiDmMemory24Descriptor (DescriptorBody, Length, Level);
 322             break;
 323
 324
 325         case ACPI_RDESC_TYPE_GENERAL_REGISTER:
 326
 327             AcpiDmGenericRegisterDescriptor (DescriptorBody, Length, Level);
 328             break;
 329
 330
 331         case ACPI_RDESC_TYPE_LARGE_VENDOR:
 332
 333             AcpiDmVendorLargeDescriptor (DescriptorBody, Length, Level);
 334             break;
 335
 336
 337         case ACPI_RDESC_TYPE_MEMORY_32:
 338
 339             AcpiDmMemory32Descriptor (DescriptorBody, Length, Level);
 340             break;
 341
 342
 343         case ACPI_RDESC_TYPE_FIXED_MEMORY_32:
 344
 345             AcpiDmFixedMem32Descriptor (DescriptorBody, Length, Level);
 346             break;
 347
 348
 349         case ACPI_RDESC_TYPE_DWORD_ADDRESS_SPACE:
 350
 351             AcpiDmDwordDescriptor (DescriptorBody, Length, Level);
 352             break;
 353
 354
 355         case ACPI_RDESC_TYPE_WORD_ADDRESS_SPACE:
 356
 357             AcpiDmWordDescriptor (DescriptorBody, Length, Level);
 358             break;
 359
 360
 361         case ACPI_RDESC_TYPE_EXTENDED_XRUPT:
 362
 363             AcpiDmInterruptDescriptor (DescriptorBody, Length, Level);
 364             break;
 365
 366
 367         case ACPI_RDESC_TYPE_QWORD_ADDRESS_SPACE:
 368
 369             AcpiDmQwordDescriptor (DescriptorBody, Length, Level);
 370             break;
 371
 372
 373         default:
 374             /*
 375              * Anything else is unrecognized.
 376              *
 377              * Since the entire resource buffer has been already walked and
 378              * validated, this is a very serious error indicating that someone
 379              * overwrote the buffer.
 380              */
 381             AcpiOsPrintf ("/* Unknown Resource type (%X) */\n", DescriptorId);
 382             return;
 383         }
 384     }
 385 }
 386
 387
 388 /*******************************************************************************
 389  *
 390  * FUNCTION:    AcpiDmIsResourceDescriptor
 391  *
 392  * PARAMETERS:  Op          - Buffer Op to be examined
 393  *
 394  * RETURN:      TRUE if this Buffer Op contains a valid resource
 395  *              descriptor.
 396  *
 397  * DESCRIPTION: Walk a byte list to determine if it consists of a valid set
 398  *              of resource descriptors.  Nothing is output.
 399  *
 400  ******************************************************************************/
 401
 402 BOOLEAN
 403 AcpiDmIsResourceDescriptor (
 404     ACPI_PARSE_OBJECT       *Op)
 405 {
 406     UINT8                   *ByteData;
 407     UINT32                  ByteCount;
 408     ACPI_PARSE_OBJECT       *NextOp;
 409     ACPI_NATIVE_UINT        CurrentByteOffset;
 410     UINT8                   CurrentByte;
 411     UINT8                   DescriptorId;
 412     UINT32                  Length;
 413
 414
 415     /* This op must be a buffer */
 416
 417     if (Op->Common.AmlOpcode != AML_BUFFER_OP)
 418     {
 419         return FALSE;
 420     }
 421
 422     /* Get to the ByteData list */
 423
 424     NextOp = Op->Common.Value.Arg;
 425     NextOp = NextOp->Common.Next;
 426     if (!NextOp)
 427     {
 428         return (FALSE);
 429     }
 430
 431     /* Extract the data pointer and data length */
 432
 433     ByteCount = NextOp->Common.Value.Integer32;
 434     ByteData = NextOp->Named.Data;
 435
 436     /* The list must have a valid END_TAG */
 437
 438     if (ByteData[ByteCount-2] != (ACPI_RDESC_TYPE_END_TAG | 1))
 439     {
 440         return FALSE;
 441     }
 442
 443     /*
 444      * Walk the byte list.  Abort on any invalid descriptor ID or
 445      * or length
 446      */
 447     for (CurrentByteOffset = 0; CurrentByteOffset < ByteCount; )
 448     {
 449         CurrentByte = ByteData[CurrentByteOffset];
 450
 451         /* Large or small resource? */
 452
 453         if (CurrentByte & ACPI_RDESC_TYPE_LARGE)
 454         {
 455             DescriptorId = CurrentByte;
 456             Length = (* (ACPI_CAST_PTR (UINT16, (&ByteData[CurrentByteOffset + 1]))));
 457             CurrentByteOffset += 3;
 458         }
 459         else
 460         {
 461             DescriptorId = (UINT8) (CurrentByte & 0xF8);
 462             Length = (ByteData[CurrentByteOffset] & 0x7);
 463             CurrentByteOffset += 1;
 464         }
 465
 466         CurrentByteOffset += (ACPI_NATIVE_UINT) Length;
 467
 468         /* Determine type of resource */
 469
 470         switch (DescriptorId)
 471         {
 472         /*
 473          * "Small" type descriptors
 474          */
 475         case ACPI_RDESC_TYPE_IRQ_FORMAT:
 476         case ACPI_RDESC_TYPE_DMA_FORMAT:
 477         case ACPI_RDESC_TYPE_START_DEPENDENT:
 478         case ACPI_RDESC_TYPE_END_DEPENDENT:
 479         case ACPI_RDESC_TYPE_IO_PORT:
 480         case ACPI_RDESC_TYPE_FIXED_IO_PORT:
 481         case ACPI_RDESC_TYPE_SMALL_VENDOR:
 482         /*
 483          * "Large" type descriptors
 484          */
 485         case ACPI_RDESC_TYPE_MEMORY_24:
 486         case ACPI_RDESC_TYPE_GENERAL_REGISTER:
 487         case ACPI_RDESC_TYPE_LARGE_VENDOR:
 488         case ACPI_RDESC_TYPE_MEMORY_32:
 489         case ACPI_RDESC_TYPE_FIXED_MEMORY_32:
 490         case ACPI_RDESC_TYPE_DWORD_ADDRESS_SPACE:
 491         case ACPI_RDESC_TYPE_WORD_ADDRESS_SPACE:
 492         case ACPI_RDESC_TYPE_EXTENDED_XRUPT:
 493         case ACPI_RDESC_TYPE_QWORD_ADDRESS_SPACE:
 494
 495             /* Valid descriptor ID, keep going */
 496
 497             break;
 498
 499
 500         case ACPI_RDESC_TYPE_END_TAG:
 501
 502             /* We must be at the end of the ByteList */
 503
 504             if (CurrentByteOffset != ByteCount)
 505             {
 506                 return (FALSE);
 507             }
 508
 509             /* All descriptors/lengths valid, this is a valid descriptor */
 510
 511             return (TRUE);
 512
 513
 514         default:
 515
 516             /* Bad descriptor, abort */
 517
 518             return (FALSE);
 519         }
 520     }
 521
 522     /* Did not find an END_TAG, something seriously wrong */
 523
 524     return (FALSE);
 525 }
 526
 527
 528 #endif