sys/contrib/dev/acpica/exfield.c

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