exfield.c revision 99146
1/****************************************************************************** 2 * 3 * Module Name: exfield - ACPI AML (p-code) execution - field manipulation 4 * $Revision: 108 $ 5 * 6 *****************************************************************************/ 7 8/****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999 - 2002, 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#include "amlcode.h" 124#include "acnamesp.h" 125#include "achware.h" 126#include "acevents.h" 127 128 129#define _COMPONENT ACPI_EXECUTER 130 ACPI_MODULE_NAME ("exfield") 131 132 133/******************************************************************************* 134 * 135 * FUNCTION: AcpiExReadDataFromField 136 * 137 * PARAMETERS: WalkState - Current execution state 138 * ObjDesc - The named field 139 * RetBufferDesc - Where the return data object is stored 140 * 141 * RETURN: Status 142 * 143 * DESCRIPTION: Read from a named field. Returns either an Integer or a 144 * Buffer, depending on the size of the field. 145 * 146 ******************************************************************************/ 147 148ACPI_STATUS 149AcpiExReadDataFromField ( 150 ACPI_WALK_STATE *WalkState, 151 ACPI_OPERAND_OBJECT *ObjDesc, 152 ACPI_OPERAND_OBJECT **RetBufferDesc) 153{ 154 ACPI_STATUS Status; 155 ACPI_OPERAND_OBJECT *BufferDesc; 156 UINT32 Length; 157 UINT32 IntegerSize; 158 void *Buffer; 159 BOOLEAN Locked; 160 161 162 ACPI_FUNCTION_TRACE_PTR ("ExReadDataFromField", ObjDesc); 163 164 165 /* Parameter validation */ 166 167 if (!ObjDesc) 168 { 169 return_ACPI_STATUS (AE_AML_NO_OPERAND); 170 } 171 172 if (ObjDesc->Common.Type == ACPI_TYPE_BUFFER_FIELD) 173 { 174 /* 175 * If the BufferField arguments have not been previously evaluated, 176 * evaluate them now and save the results. 177 */ 178 if (!(ObjDesc->Common.Flags & AOPOBJ_DATA_VALID)) 179 { 180 Status = AcpiDsGetBufferFieldArguments (ObjDesc); 181 if (ACPI_FAILURE (Status)) 182 { 183 return_ACPI_STATUS (Status); 184 } 185 } 186 } 187 188 /* 189 * Allocate a buffer for the contents of the field. 190 * 191 * If the field is larger than the size of an ACPI_INTEGER, create 192 * a BUFFER to hold it. Otherwise, use an INTEGER. This allows 193 * the use of arithmetic operators on the returned value if the 194 * field size is equal or smaller than an Integer. 195 * 196 * Note: Field.length is in bits. 197 */ 198 Length = ACPI_ROUND_BITS_UP_TO_BYTES (ObjDesc->Field.BitLength); 199 200 /* Handle both ACPI 1.0 and ACPI 2.0 Integer widths */ 201 202 IntegerSize = sizeof (ACPI_INTEGER); 203 if (WalkState->MethodNode->Flags & ANOBJ_DATA_WIDTH_32) 204 { 205 /* 206 * We are running a method that exists in a 32-bit ACPI table. 207 * Integer size is 4. 208 */ 209 IntegerSize = sizeof (UINT32); 210 } 211 212 if (Length > IntegerSize) 213 { 214 /* Field is too large for an Integer, create a Buffer instead */ 215 216 BufferDesc = AcpiUtCreateInternalObject (ACPI_TYPE_BUFFER); 217 if (!BufferDesc) 218 { 219 return_ACPI_STATUS (AE_NO_MEMORY); 220 } 221 222 /* Create the actual read buffer */ 223 224 BufferDesc->Buffer.Pointer = ACPI_MEM_CALLOCATE (Length); 225 if (!BufferDesc->Buffer.Pointer) 226 { 227 AcpiUtRemoveReference (BufferDesc); 228 return_ACPI_STATUS (AE_NO_MEMORY); 229 } 230 231 BufferDesc->Common.Flags = AOPOBJ_DATA_VALID; 232 BufferDesc->Buffer.Length = Length; 233 Buffer = BufferDesc->Buffer.Pointer; 234 } 235 else 236 { 237 /* Field will fit within an Integer (normal case) */ 238 239 BufferDesc = AcpiUtCreateInternalObject (ACPI_TYPE_INTEGER); 240 if (!BufferDesc) 241 { 242 return_ACPI_STATUS (AE_NO_MEMORY); 243 } 244 245 Length = IntegerSize; 246 BufferDesc->Integer.Value = 0; 247 Buffer = &BufferDesc->Integer.Value; 248 } 249 250 ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD, 251 "Obj=%p Type=%X Buf=%p Len=%X\n", 252 ObjDesc, ObjDesc->Common.Type, Buffer, Length)); 253 ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD, 254 "FieldWrite: BitLen=%X BitOff=%X ByteOff=%X\n", 255 ObjDesc->CommonField.BitLength, 256 ObjDesc->CommonField.StartFieldBitOffset, 257 ObjDesc->CommonField.BaseByteOffset)); 258 259 Locked = AcpiExAcquireGlobalLock (ObjDesc->CommonField.FieldFlags); 260 261 /* Read from the field */ 262 263 Status = AcpiExExtractFromField (ObjDesc, Buffer, Length); 264 265 /* 266 * Release global lock if we acquired it earlier 267 */ 268 AcpiExReleaseGlobalLock (Locked); 269 270 if (ACPI_FAILURE (Status)) 271 { 272 AcpiUtRemoveReference (BufferDesc); 273 } 274 else if (RetBufferDesc) 275 { 276 *RetBufferDesc = BufferDesc; 277 } 278 279 return_ACPI_STATUS (Status); 280} 281 282 283/******************************************************************************* 284 * 285 * FUNCTION: AcpiExWriteDataToField 286 * 287 * PARAMETERS: SourceDesc - Contains data to write 288 * ObjDesc - The named field 289 * 290 * RETURN: Status 291 * 292 * DESCRIPTION: Write to a named field 293 * 294 ******************************************************************************/ 295 296ACPI_STATUS 297AcpiExWriteDataToField ( 298 ACPI_OPERAND_OBJECT *SourceDesc, 299 ACPI_OPERAND_OBJECT *ObjDesc) 300{ 301 ACPI_STATUS Status; 302 UINT32 Length; 303 UINT32 RequiredLength; 304 void *Buffer; 305 void *NewBuffer; 306 BOOLEAN Locked; 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 (ObjDesc->Common.Type == 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 335 /* 336 * Get a pointer to the data to be written 337 */ 338 switch (SourceDesc->Common.Type) 339 { 340 case ACPI_TYPE_INTEGER: 341 Buffer = &SourceDesc->Integer.Value; 342 Length = sizeof (SourceDesc->Integer.Value); 343 break; 344 345 case ACPI_TYPE_BUFFER: 346 Buffer = SourceDesc->Buffer.Pointer; 347 Length = SourceDesc->Buffer.Length; 348 break; 349 350 case ACPI_TYPE_STRING: 351 Buffer = SourceDesc->String.Pointer; 352 Length = SourceDesc->String.Length; 353 break; 354 355 default: 356 return_ACPI_STATUS (AE_AML_OPERAND_TYPE); 357 } 358 359 /* 360 * We must have a buffer that is at least as long as the field 361 * we are writing to. This is because individual fields are 362 * indivisible and partial writes are not supported -- as per 363 * the ACPI specification. 364 */ 365 NewBuffer = NULL; 366 RequiredLength = ACPI_ROUND_BITS_UP_TO_BYTES (ObjDesc->CommonField.BitLength); 367 368 if (Length < RequiredLength) 369 { 370 /* We need to create a new buffer */ 371 372 NewBuffer = ACPI_MEM_CALLOCATE (RequiredLength); 373 if (!NewBuffer) 374 { 375 return_ACPI_STATUS (AE_NO_MEMORY); 376 } 377 378 /* 379 * Copy the original data to the new buffer, starting 380 * at Byte zero. All unused (upper) bytes of the 381 * buffer will be 0. 382 */ 383 ACPI_MEMCPY ((char *) NewBuffer, (char *) Buffer, Length); 384 Buffer = NewBuffer; 385 Length = RequiredLength; 386 } 387 388 ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD, 389 "Obj=%p Type=%X Buf=%p Len=%X\n", 390 ObjDesc, ObjDesc->Common.Type, Buffer, Length)); 391 ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD, 392 "FieldRead: BitLen=%X BitOff=%X ByteOff=%X\n", 393 ObjDesc->CommonField.BitLength, 394 ObjDesc->CommonField.StartFieldBitOffset, 395 ObjDesc->CommonField.BaseByteOffset)); 396 397 Locked = AcpiExAcquireGlobalLock (ObjDesc->CommonField.FieldFlags); 398 399 /* 400 * Write to the field 401 */ 402 Status = AcpiExInsertIntoField (ObjDesc, Buffer, Length); 403 404 /* 405 * Release global lock if we acquired it earlier 406 */ 407 AcpiExReleaseGlobalLock (Locked); 408 409 /* Free temporary buffer if we used one */ 410 411 if (NewBuffer) 412 { 413 ACPI_MEM_FREE (NewBuffer); 414 } 415 416 return_ACPI_STATUS (Status); 417} 418 419 420