sys/contrib/dev/acpica-unix-20040527/INTERPRETER/EXECUTER/exoparg3.c

   1
   2 /******************************************************************************
   3  *
   4  * Module Name: exoparg3 - AML execution - opcodes with 3 arguments
   5  *              $Revision: 19 $
   6  *
   7  *****************************************************************************/
   8
   9 /******************************************************************************
  10  *
  11  * 1. Copyright Notice
  12  *
  13  * Some or all of this work - Copyright (c) 1999 - 2004, Intel Corp.
  14  * All rights reserved.
  15  *
  16  * 2. License
  17  *
  18  * 2.1. This is your license from Intel Corp. under its intellectual property
  19  * rights.  You may have additional license terms from the party that provided
  20  * you this software, covering your right to use that party's intellectual
  21  * property rights.
  22  *
  23  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  24  * copy of the source code appearing in this file ("Covered Code") an
  25  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  26  * base code distributed originally by Intel ("Original Intel Code") to copy,
  27  * make derivatives, distribute, use and display any portion of the Covered
  28  * Code in any form, with the right to sublicense such rights; and
  29  *
  30  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  31  * license (with the right to sublicense), under only those claims of Intel
  32  * patents that are infringed by the Original Intel Code, to make, use, sell,
  33  * offer to sell, and import the Covered Code and derivative works thereof
  34  * solely to the minimum extent necessary to exercise the above copyright
  35  * license, and in no event shall the patent license extend to any additions
  36  * to or modifications of the Original Intel Code.  No other license or right
  37  * is granted directly or by implication, estoppel or otherwise;
  38  *
  39  * The above copyright and patent license is granted only if the following
  40  * conditions are met:
  41  *
  42  * 3. Conditions
  43  *
  44  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  45  * Redistribution of source code of any substantial portion of the Covered
  46  * Code or modification with rights to further distribute source must include
  47  * the above Copyright Notice, the above License, this list of Conditions,
  48  * and the following Disclaimer and Export Compliance provision.  In addition,
  49  * Licensee must cause all Covered Code to which Licensee contributes to
  50  * contain a file documenting the changes Licensee made to create that Covered
  51  * Code and the date of any change.  Licensee must include in that file the
  52  * documentation of any changes made by any predecessor Licensee.  Licensee
  53  * must include a prominent statement that the modification is derived,
  54  * directly or indirectly, from Original Intel Code.
  55  *
  56  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  57  * Redistribution of source code of any substantial portion of the Covered
  58  * Code or modification without rights to further distribute source must
  59  * include the following Disclaimer and Export Compliance provision in the
  60  * documentation and/or other materials provided with distribution.  In
  61  * addition, Licensee may not authorize further sublicense of source of any
  62  * portion of the Covered Code, and must include terms to the effect that the
  63  * license from Licensee to its licensee is limited to the intellectual
  64  * property embodied in the software Licensee provides to its licensee, and
  65  * not to intellectual property embodied in modifications its licensee may
  66  * make.
  67  *
  68  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  69  * substantial portion of the Covered Code or modification must reproduce the
  70  * above Copyright Notice, and the following Disclaimer and Export Compliance
  71  * provision in the documentation and/or other materials provided with the
  72  * distribution.
  73  *
  74  * 3.4. Intel retains all right, title, and interest in and to the Original
  75  * Intel Code.
  76  *
  77  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  78  * Intel shall be used in advertising or otherwise to promote the sale, use or
  79  * other dealings in products derived from or relating to the Covered Code
  80  * without prior written authorization from Intel.
  81  *
  82  * 4. Disclaimer and Export Compliance
  83  *
  84  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  85  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  86  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  87  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  88
  89  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  90  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  91  * PARTICULAR PURPOSE.
  92  *
  93  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  94  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  95  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  96  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  97  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  98  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  99  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
 100  * LIMITED REMEDY.
 101  *
 102  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 103  * software or system incorporating such software without first obtaining any
 104  * required license or other approval from the U. S. Department of Commerce or
 105  * any other agency or department of the United States Government.  In the
 106  * event Licensee exports any such software from the United States or
 107  * re-exports any such software from a foreign destination, Licensee shall
 108  * ensure that the distribution and export/re-export of the software is in
 109  * compliance with all laws, regulations, orders, or other restrictions of the
 110  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 111  * any of its subsidiaries will export/re-export any technical data, process,
 112  * software, or service, directly or indirectly, to any country for which the
 113  * United States government or any agency thereof requires an export license,
 114  * other governmental approval, or letter of assurance, without first obtaining
 115  * such license, approval or letter.
 116  *
 117  *****************************************************************************/
 118
 119 #define __EXOPARG3_C__
 120
 121 #include "acpi.h"
 122 #include "acinterp.h"
 123 #include "acparser.h"
 124 #include "amlcode.h"
 125
 126
 127 #define _COMPONENT          ACPI_EXECUTER
 128         ACPI_MODULE_NAME    ("exoparg3")
 129
 130
 131 /*!
 132  * Naming convention for AML interpreter execution routines.
 133  *
 134  * The routines that begin execution of AML opcodes are named with a common
 135  * convention based upon the number of arguments, the number of target operands,
 136  * and whether or not a value is returned:
 137  *
 138  *      AcpiExOpcode_xA_yT_zR
 139  *
 140  * Where:
 141  *
 142  * xA - ARGUMENTS:    The number of arguments (input operands) that are
 143  *                    required for this opcode type (1 through 6 args).
 144  * yT - TARGETS:      The number of targets (output operands) that are required
 145  *                    for this opcode type (0, 1, or 2 targets).
 146  * zR - RETURN VALUE: Indicates whether this opcode type returns a value
 147  *                    as the function return (0 or 1).
 148  *
 149  * The AcpiExOpcode* functions are called via the Dispatcher component with
 150  * fully resolved operands.
 151 !*/
 152
 153
 154 /*******************************************************************************
 155  *
 156  * FUNCTION:    AcpiExOpcode_3A_0T_0R
 157  *
 158  * PARAMETERS:  WalkState           - Current walk state
 159  *
 160  * RETURN:      Status
 161  *
 162  * DESCRIPTION: Execute Triadic operator (3 operands)
 163  *
 164  ******************************************************************************/
 165
 166 ACPI_STATUS
 167 AcpiExOpcode_3A_0T_0R (
 168     ACPI_WALK_STATE         *WalkState)
 169 {
 170     ACPI_OPERAND_OBJECT     **Operand = &WalkState->Operands[0];
 171     ACPI_SIGNAL_FATAL_INFO  *Fatal;
 172     ACPI_STATUS             Status = AE_OK;
 173
 174
 175     ACPI_FUNCTION_TRACE_STR ("ExOpcode_3A_0T_0R", AcpiPsGetOpcodeName (WalkState->Opcode));
 176
 177
 178     switch (WalkState->Opcode)
 179     {
 180     case AML_FATAL_OP:          /* Fatal (FatalType  FatalCode  FatalArg)    */
 181
 182         ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
 183             "FatalOp: Type %X Code %X Arg %X <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<\n",
 184             (UINT32) Operand[0]->Integer.Value,
 185             (UINT32) Operand[1]->Integer.Value,
 186             (UINT32) Operand[2]->Integer.Value));
 187
 188         Fatal = ACPI_MEM_ALLOCATE (sizeof (ACPI_SIGNAL_FATAL_INFO));
 189         if (Fatal)
 190         {
 191             Fatal->Type     = (UINT32) Operand[0]->Integer.Value;
 192             Fatal->Code     = (UINT32) Operand[1]->Integer.Value;
 193             Fatal->Argument = (UINT32) Operand[2]->Integer.Value;
 194         }
 195
 196         /*
 197          * Always signal the OS!
 198          */
 199         Status = AcpiOsSignal (ACPI_SIGNAL_FATAL, Fatal);
 200
 201         /* Might return while OS is shutting down, just continue */
 202
 203         ACPI_MEM_FREE (Fatal);
 204         break;
 205
 206
 207     default:
 208
 209         ACPI_REPORT_ERROR (("AcpiExOpcode_3A_0T_0R: Unknown opcode %X\n",
 210                 WalkState->Opcode));
 211         Status = AE_AML_BAD_OPCODE;
 212         goto Cleanup;
 213     }
 214
 215
 216 Cleanup:
 217
 218     return_ACPI_STATUS (Status);
 219 }
 220
 221
 222 /*******************************************************************************
 223  *
 224  * FUNCTION:    AcpiExOpcode_3A_1T_1R
 225  *
 226  * PARAMETERS:  WalkState           - Current walk state
 227  *
 228  * RETURN:      Status
 229  *
 230  * DESCRIPTION: Execute Triadic operator (3 operands)
 231  *
 232  ******************************************************************************/
 233
 234 ACPI_STATUS
 235 AcpiExOpcode_3A_1T_1R (
 236     ACPI_WALK_STATE         *WalkState)
 237 {
 238     ACPI_OPERAND_OBJECT     **Operand = &WalkState->Operands[0];
 239     ACPI_OPERAND_OBJECT     *ReturnDesc = NULL;
 240     char                    *Buffer;
 241     ACPI_STATUS             Status = AE_OK;
 242     ACPI_NATIVE_UINT        Index;
 243     ACPI_SIZE               Length;
 244
 245
 246     ACPI_FUNCTION_TRACE_STR ("ExOpcode_3A_1T_1R", AcpiPsGetOpcodeName (WalkState->Opcode));
 247
 248
 249     switch (WalkState->Opcode)
 250     {
 251     case AML_MID_OP:        /* Mid  (Source[0], Index[1], Length[2], Result[3]) */
 252
 253         /*
 254          * Create the return object.  The Source operand is guaranteed to be
 255          * either a String or a Buffer, so just use its type.
 256          */
 257         ReturnDesc = AcpiUtCreateInternalObject (ACPI_GET_OBJECT_TYPE (Operand[0]));
 258         if (!ReturnDesc)
 259         {
 260             Status = AE_NO_MEMORY;
 261             goto Cleanup;
 262         }
 263
 264         /* Get the Integer values from the objects */
 265
 266         Index = (ACPI_NATIVE_UINT) Operand[1]->Integer.Value;
 267         Length = (ACPI_SIZE) Operand[2]->Integer.Value;
 268
 269         /*
 270          * If the index is beyond the length of the String/Buffer, or if the
 271          * requested length is zero, return a zero-length String/Buffer
 272          */
 273         if ((Index < Operand[0]->String.Length) &&
 274             (Length > 0))
 275         {
 276             /* Truncate request if larger than the actual String/Buffer */
 277
 278             if ((Index + Length) >
 279                 Operand[0]->String.Length)
 280             {
 281                 Length = (ACPI_SIZE) Operand[0]->String.Length - Index;
 282             }
 283
 284             /* Allocate a new buffer for the String/Buffer */
 285
 286             Buffer = ACPI_MEM_CALLOCATE ((ACPI_SIZE) Length + 1);
 287             if (!Buffer)
 288             {
 289                 Status = AE_NO_MEMORY;
 290                 goto Cleanup;
 291             }
 292
 293             /* Copy the portion requested */
 294
 295             ACPI_MEMCPY (Buffer, Operand[0]->String.Pointer + Index,
 296                          Length);
 297
 298             /* Set the length of the new String/Buffer */
 299
 300             ReturnDesc->String.Pointer = Buffer;
 301             ReturnDesc->String.Length = (UINT32) Length;
 302         }
 303         break;
 304
 305
 306     default:
 307
 308         ACPI_REPORT_ERROR (("AcpiExOpcode_3A_0T_0R: Unknown opcode %X\n",
 309                 WalkState->Opcode));
 310         Status = AE_AML_BAD_OPCODE;
 311         goto Cleanup;
 312     }
 313
 314     /* Store the result in the target */
 315
 316     Status = AcpiExStore (ReturnDesc, Operand[3], WalkState);
 317
 318 Cleanup:
 319
 320     /* Delete return object on error */
 321
 322     if (ACPI_FAILURE (Status))
 323     {
 324         AcpiUtRemoveReference (ReturnDesc);
 325     }
 326
 327     /* Set the return object and exit */
 328
 329     if (!WalkState->ResultObj)
 330     {
 331         WalkState->ResultObj = ReturnDesc;
 332     }
 333     return_ACPI_STATUS (Status);
 334 }
 335
 336