sys/contrib/dev/acpica-unix-20050211/interpreter/executer/exfield.c

   1 /******************************************************************************
   2  *
   3  * Module Name: exfield - ACPI AML (p-code) execution - field manipulation
   4  *              $Revision: 121 $
   5  *
   6  *****************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2005, 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
 117
 118 #define __EXFIELD_C__
 119
 120 #include "acpi.h"
 121 #include "acdispat.h"
 122 #include "acinterp.h"
 123
 124
 125 #define _COMPONENT          ACPI_EXECUTER
 126         ACPI_MODULE_NAME    ("exfield")
 127
 128
 129 /*******************************************************************************
 130  *
 131  * FUNCTION:    AcpiExReadDataFromField
 132  *
 133  * PARAMETERS:  WalkState           - Current execution state
 134  *              ObjDesc             - The named field
 135  *              RetBufferDesc       - Where the return data object is stored
 136  *
 137  * RETURN:      Status
 138  *
 139  * DESCRIPTION: Read from a named field.  Returns either an Integer or a
 140  *              Buffer, depending on the size of the field.
 141  *
 142  ******************************************************************************/
 143
 144 ACPI_STATUS
 145 AcpiExReadDataFromField (
 146     ACPI_WALK_STATE         *WalkState,
 147     ACPI_OPERAND_OBJECT     *ObjDesc,
 148     ACPI_OPERAND_OBJECT     **RetBufferDesc)
 149 {
 150     ACPI_STATUS             Status;
 151     ACPI_OPERAND_OBJECT     *BufferDesc;
 152     ACPI_SIZE               Length;
 153     void                    *Buffer;
 154     BOOLEAN                 Locked;
 155
 156
 157     ACPI_FUNCTION_TRACE_PTR ("ExReadDataFromField", ObjDesc);
 158
 159
 160     /* Parameter validation */
 161
 162     if (!ObjDesc)
 163     {
 164         return_ACPI_STATUS (AE_AML_NO_OPERAND);
 165     }
 166
 167     if (ACPI_GET_OBJECT_TYPE (ObjDesc) == ACPI_TYPE_BUFFER_FIELD)
 168     {
 169         /*
 170          * If the BufferField arguments have not been previously evaluated,
 171          * evaluate them now and save the results.
 172          */
 173         if (!(ObjDesc->Common.Flags & AOPOBJ_DATA_VALID))
 174         {
 175             Status = AcpiDsGetBufferFieldArguments (ObjDesc);
 176             if (ACPI_FAILURE (Status))
 177             {
 178                 return_ACPI_STATUS (Status);
 179             }
 180         }
 181     }
 182     else if ((ACPI_GET_OBJECT_TYPE (ObjDesc) == ACPI_TYPE_LOCAL_REGION_FIELD) &&
 183              (ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_SMBUS))
 184     {
 185         /*
 186          * This is an SMBus read.  We must create a buffer to hold the data
 187          * and directly access the region handler.
 188          */
 189         BufferDesc = AcpiUtCreateBufferObject (ACPI_SMBUS_BUFFER_SIZE);
 190         if (!BufferDesc)
 191         {
 192             return_ACPI_STATUS (AE_NO_MEMORY);
 193         }
 194
 195         /* Lock entire transaction if requested */
 196
 197         Locked = AcpiExAcquireGlobalLock (ObjDesc->CommonField.FieldFlags);
 198
 199         /*
 200          * Perform the read.
 201          * Note: Smbus protocol value is passed in upper 16-bits of Function
 202          */
 203         Status = AcpiExAccessRegion (ObjDesc, 0,
 204                         ACPI_CAST_PTR (ACPI_INTEGER, BufferDesc->Buffer.Pointer),
 205                         ACPI_READ | (ObjDesc->Field.Attribute << 16));
 206         AcpiExReleaseGlobalLock (Locked);
 207         goto Exit;
 208     }
 209
 210     /*
 211      * Allocate a buffer for the contents of the field.
 212      *
 213      * If the field is larger than the size of an ACPI_INTEGER, create
 214      * a BUFFER to hold it.  Otherwise, use an INTEGER.  This allows
 215      * the use of arithmetic operators on the returned value if the
 216      * field size is equal or smaller than an Integer.
 217      *
 218      * Note: Field.length is in bits.
 219      */
 220     Length = (ACPI_SIZE) ACPI_ROUND_BITS_UP_TO_BYTES (ObjDesc->Field.BitLength);
 221     if (Length > AcpiGbl_IntegerByteWidth)
 222     {
 223         /* Field is too large for an Integer, create a Buffer instead */
 224
 225         BufferDesc = AcpiUtCreateBufferObject (Length);
 226         if (!BufferDesc)
 227         {
 228             return_ACPI_STATUS (AE_NO_MEMORY);
 229         }
 230         Buffer = BufferDesc->Buffer.Pointer;
 231     }
 232     else
 233     {
 234         /* Field will fit within an Integer (normal case) */
 235
 236         BufferDesc = AcpiUtCreateInternalObject (ACPI_TYPE_INTEGER);
 237         if (!BufferDesc)
 238         {
 239             return_ACPI_STATUS (AE_NO_MEMORY);
 240         }
 241
 242         Length = AcpiGbl_IntegerByteWidth;
 243         BufferDesc->Integer.Value = 0;
 244         Buffer = &BufferDesc->Integer.Value;
 245     }
 246
 247     ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
 248         "FieldRead [TO]:   Obj %p, Type %X, Buf %p, ByteLen %X\n",
 249         ObjDesc, ACPI_GET_OBJECT_TYPE (ObjDesc), Buffer, (UINT32) Length));
 250     ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
 251         "FieldRead [FROM]: BitLen %X, BitOff %X, ByteOff %X\n",
 252         ObjDesc->CommonField.BitLength,
 253         ObjDesc->CommonField.StartFieldBitOffset,
 254         ObjDesc->CommonField.BaseByteOffset));
 255
 256     /* Lock entire transaction if requested */
 257
 258     Locked = AcpiExAcquireGlobalLock (ObjDesc->CommonField.FieldFlags);
 259
 260     /* Read from the field */
 261
 262     Status = AcpiExExtractFromField (ObjDesc, Buffer, (UINT32) Length);
 263     AcpiExReleaseGlobalLock (Locked);
 264
 265
 266 Exit:
 267     if (ACPI_FAILURE (Status))
 268     {
 269         AcpiUtRemoveReference (BufferDesc);
 270     }
 271     else if (RetBufferDesc)
 272     {
 273         *RetBufferDesc = BufferDesc;
 274     }
 275
 276     return_ACPI_STATUS (Status);
 277 }
 278
 279
 280 /*******************************************************************************
 281  *
 282  * FUNCTION:    AcpiExWriteDataToField
 283  *
 284  * PARAMETERS:  SourceDesc          - Contains data to write
 285  *              ObjDesc             - The named field
 286  *
 287  * RETURN:      Status
 288  *
 289  * DESCRIPTION: Write to a named field
 290  *
 291  ******************************************************************************/
 292
 293 ACPI_STATUS
 294 AcpiExWriteDataToField (
 295     ACPI_OPERAND_OBJECT     *SourceDesc,
 296     ACPI_OPERAND_OBJECT     *ObjDesc,
 297     ACPI_OPERAND_OBJECT     **ResultDesc)
 298 {
 299     ACPI_STATUS             Status;
 300     UINT32                  Length;
 301     UINT32                  RequiredLength;
 302     void                    *Buffer;
 303     void                    *NewBuffer;
 304     BOOLEAN                 Locked;
 305     ACPI_OPERAND_OBJECT     *BufferDesc;
 306
 307
 308     ACPI_FUNCTION_TRACE_PTR ("ExWriteDataToField", ObjDesc);
 309
 310
 311     /* Parameter validation */
 312
 313     if (!SourceDesc || !ObjDesc)
 314     {
 315         return_ACPI_STATUS (AE_AML_NO_OPERAND);
 316     }
 317
 318     if (ACPI_GET_OBJECT_TYPE (ObjDesc) == ACPI_TYPE_BUFFER_FIELD)
 319     {
 320         /*
 321          * If the BufferField arguments have not been previously evaluated,
 322          * evaluate them now and save the results.
 323          */
 324         if (!(ObjDesc->Common.Flags & AOPOBJ_DATA_VALID))
 325         {
 326             Status = AcpiDsGetBufferFieldArguments (ObjDesc);
 327             if (ACPI_FAILURE (Status))
 328             {
 329                 return_ACPI_STATUS (Status);
 330             }
 331         }
 332     }
 333     else if ((ACPI_GET_OBJECT_TYPE (ObjDesc) == ACPI_TYPE_LOCAL_REGION_FIELD) &&
 334              (ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_SMBUS))
 335     {
 336         /*
 337          * This is an SMBus write.  We will bypass the entire field mechanism
 338          * and handoff the buffer directly to the handler.
 339          *
 340          * Source must be a buffer of sufficient size (ACPI_SMBUS_BUFFER_SIZE).
 341          */
 342         if (ACPI_GET_OBJECT_TYPE (SourceDesc) != ACPI_TYPE_BUFFER)
 343         {
 344             ACPI_REPORT_ERROR (("SMBus write requires Buffer, found type %s\n",
 345                 AcpiUtGetObjectTypeName (SourceDesc)));
 346             return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
 347         }
 348
 349         if (SourceDesc->Buffer.Length < ACPI_SMBUS_BUFFER_SIZE)
 350         {
 351             ACPI_REPORT_ERROR (("SMBus write requires Buffer of length %X, found length %X\n",
 352                 ACPI_SMBUS_BUFFER_SIZE, SourceDesc->Buffer.Length));
 353             return_ACPI_STATUS (AE_AML_BUFFER_LIMIT);
 354         }
 355
 356         BufferDesc = AcpiUtCreateBufferObject (ACPI_SMBUS_BUFFER_SIZE);
 357         if (!BufferDesc)
 358         {
 359             return_ACPI_STATUS (AE_NO_MEMORY);
 360         }
 361
 362         Buffer = BufferDesc->Buffer.Pointer;
 363         ACPI_MEMCPY (Buffer, SourceDesc->Buffer.Pointer, ACPI_SMBUS_BUFFER_SIZE);
 364
 365         /* Lock entire transaction if requested */
 366
 367         Locked = AcpiExAcquireGlobalLock (ObjDesc->CommonField.FieldFlags);
 368
 369         /*
 370          * Perform the write (returns status and perhaps data in the same buffer)
 371          * Note: SMBus protocol type is passed in upper 16-bits of Function.
 372          */
 373         Status = AcpiExAccessRegion (ObjDesc, 0,
 374                         (ACPI_INTEGER *) Buffer,
 375                         ACPI_WRITE | (ObjDesc->Field.Attribute << 16));
 376         AcpiExReleaseGlobalLock (Locked);
 377
 378         *ResultDesc = BufferDesc;
 379         return_ACPI_STATUS (Status);
 380     }
 381
 382     /*
 383      * Get a pointer to the data to be written
 384      */
 385     switch (ACPI_GET_OBJECT_TYPE (SourceDesc))
 386     {
 387     case ACPI_TYPE_INTEGER:
 388         Buffer = &SourceDesc->Integer.Value;
 389         Length = sizeof (SourceDesc->Integer.Value);
 390         break;
 391
 392     case ACPI_TYPE_BUFFER:
 393         Buffer = SourceDesc->Buffer.Pointer;
 394         Length = SourceDesc->Buffer.Length;
 395         break;
 396
 397     case ACPI_TYPE_STRING:
 398         Buffer = SourceDesc->String.Pointer;
 399         Length = SourceDesc->String.Length;
 400         break;
 401
 402     default:
 403         return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
 404     }
 405
 406     /*
 407      * We must have a buffer that is at least as long as the field
 408      * we are writing to.  This is because individual fields are
 409      * indivisible and partial writes are not supported -- as per
 410      * the ACPI specification.
 411      */
 412     NewBuffer = NULL;
 413     RequiredLength = ACPI_ROUND_BITS_UP_TO_BYTES (ObjDesc->CommonField.BitLength);
 414
 415     if (Length < RequiredLength)
 416     {
 417         /* We need to create a new buffer */
 418
 419         NewBuffer = ACPI_MEM_CALLOCATE (RequiredLength);
 420         if (!NewBuffer)
 421         {
 422             return_ACPI_STATUS (AE_NO_MEMORY);
 423         }
 424
 425         /*
 426          * Copy the original data to the new buffer, starting
 427          * at Byte zero.  All unused (upper) bytes of the
 428          * buffer will be 0.
 429          */
 430         ACPI_MEMCPY ((char *) NewBuffer, (char *) Buffer, Length);
 431         Buffer = NewBuffer;
 432         Length = RequiredLength;
 433     }
 434
 435     ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
 436         "FieldWrite [FROM]: Obj %p (%s:%X), Buf %p, ByteLen %X\n",
 437         SourceDesc, AcpiUtGetTypeName (ACPI_GET_OBJECT_TYPE (SourceDesc)),
 438         ACPI_GET_OBJECT_TYPE (SourceDesc), Buffer, Length));
 439     ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
 440         "FieldWrite [TO]:   Obj %p (%s:%X), BitLen %X, BitOff %X, ByteOff %X\n",
 441         ObjDesc, AcpiUtGetTypeName (ACPI_GET_OBJECT_TYPE (ObjDesc)),
 442         ACPI_GET_OBJECT_TYPE (ObjDesc),
 443         ObjDesc->CommonField.BitLength,
 444         ObjDesc->CommonField.StartFieldBitOffset,
 445         ObjDesc->CommonField.BaseByteOffset));
 446
 447     /* Lock entire transaction if requested */
 448
 449     Locked = AcpiExAcquireGlobalLock (ObjDesc->CommonField.FieldFlags);
 450
 451     /* Write to the field */
 452
 453     Status = AcpiExInsertIntoField (ObjDesc, Buffer, Length);
 454     AcpiExReleaseGlobalLock (Locked);
 455
 456     /* Free temporary buffer if we used one */
 457
 458     if (NewBuffer)
 459     {
 460         ACPI_MEM_FREE (NewBuffer);
 461     }
 462
 463     return_ACPI_STATUS (Status);
 464 }
 465
 466