exfield.c revision 99679
1/****************************************************************************** 2 * 3 * Module Name: exfield - ACPI AML (p-code) execution - field manipulation 4 * $Revision: 112 $ 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 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 144ACPI_STATUS 145AcpiExReadDataFromField ( 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 UINT32 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 183 /* 184 * Allocate a buffer for the contents of the field. 185 * 186 * If the field is larger than the size of an ACPI_INTEGER, create 187 * a BUFFER to hold it. Otherwise, use an INTEGER. This allows 188 * the use of arithmetic operators on the returned value if the 189 * field size is equal or smaller than an Integer. 190 * 191 * Note: Field.length is in bits. 192 */ 193 Length = ACPI_ROUND_BITS_UP_TO_BYTES (ObjDesc->Field.BitLength); 194 if (Length > AcpiGbl_IntegerByteWidth) 195 { 196 /* Field is too large for an Integer, create a Buffer instead */ 197 198 BufferDesc = AcpiUtCreateInternalObject (ACPI_TYPE_BUFFER); 199 if (!BufferDesc) 200 { 201 return_ACPI_STATUS (AE_NO_MEMORY); 202 } 203 204 /* Create the actual read buffer */ 205 206 BufferDesc->Buffer.Pointer = ACPI_MEM_CALLOCATE (Length); 207 if (!BufferDesc->Buffer.Pointer) 208 { 209 AcpiUtRemoveReference (BufferDesc); 210 return_ACPI_STATUS (AE_NO_MEMORY); 211 } 212 213 /* Complete the buffer object initialization */ 214 215 BufferDesc->Common.Flags = AOPOBJ_DATA_VALID; 216 BufferDesc->Buffer.Length = Length; 217 Buffer = BufferDesc->Buffer.Pointer; 218 } 219 else 220 { 221 /* Field will fit within an Integer (normal case) */ 222 223 BufferDesc = AcpiUtCreateInternalObject (ACPI_TYPE_INTEGER); 224 if (!BufferDesc) 225 { 226 return_ACPI_STATUS (AE_NO_MEMORY); 227 } 228 229 Length = AcpiGbl_IntegerByteWidth; 230 BufferDesc->Integer.Value = 0; 231 Buffer = &BufferDesc->Integer.Value; 232 } 233 234 ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD, 235 "Obj=%p Type=%X Buf=%p Len=%X\n", 236 ObjDesc, ACPI_GET_OBJECT_TYPE (ObjDesc), Buffer, Length)); 237 ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD, 238 "FieldWrite: BitLen=%X BitOff=%X ByteOff=%X\n", 239 ObjDesc->CommonField.BitLength, 240 ObjDesc->CommonField.StartFieldBitOffset, 241 ObjDesc->CommonField.BaseByteOffset)); 242 243 Locked = AcpiExAcquireGlobalLock (ObjDesc->CommonField.FieldFlags); 244 245 /* Read from the field */ 246 247 Status = AcpiExExtractFromField (ObjDesc, Buffer, Length); 248 249 /* 250 * Release global lock if we acquired it earlier 251 */ 252 AcpiExReleaseGlobalLock (Locked); 253 254 if (ACPI_FAILURE (Status)) 255 { 256 AcpiUtRemoveReference (BufferDesc); 257 } 258 else if (RetBufferDesc) 259 { 260 *RetBufferDesc = BufferDesc; 261 } 262 263 return_ACPI_STATUS (Status); 264} 265 266 267/******************************************************************************* 268 * 269 * FUNCTION: AcpiExWriteDataToField 270 * 271 * PARAMETERS: SourceDesc - Contains data to write 272 * ObjDesc - The named field 273 * 274 * RETURN: Status 275 * 276 * DESCRIPTION: Write to a named field 277 * 278 ******************************************************************************/ 279 280ACPI_STATUS 281AcpiExWriteDataToField ( 282 ACPI_OPERAND_OBJECT *SourceDesc, 283 ACPI_OPERAND_OBJECT *ObjDesc) 284{ 285 ACPI_STATUS Status; 286 UINT32 Length; 287 UINT32 RequiredLength; 288 void *Buffer; 289 void *NewBuffer; 290 BOOLEAN Locked; 291 292 293 ACPI_FUNCTION_TRACE_PTR ("ExWriteDataToField", ObjDesc); 294 295 296 /* Parameter validation */ 297 298 if (!SourceDesc || !ObjDesc) 299 { 300 return_ACPI_STATUS (AE_AML_NO_OPERAND); 301 } 302 303 if (ACPI_GET_OBJECT_TYPE (ObjDesc) == ACPI_TYPE_BUFFER_FIELD) 304 { 305 /* 306 * If the BufferField arguments have not been previously evaluated, 307 * evaluate them now and save the results. 308 */ 309 if (!(ObjDesc->Common.Flags & AOPOBJ_DATA_VALID)) 310 { 311 Status = AcpiDsGetBufferFieldArguments (ObjDesc); 312 if (ACPI_FAILURE (Status)) 313 { 314 return_ACPI_STATUS (Status); 315 } 316 } 317 } 318 319 /* 320 * Get a pointer to the data to be written 321 */ 322 switch (ACPI_GET_OBJECT_TYPE (SourceDesc)) 323 { 324 case ACPI_TYPE_INTEGER: 325 Buffer = &SourceDesc->Integer.Value; 326 Length = sizeof (SourceDesc->Integer.Value); 327 break; 328 329 case ACPI_TYPE_BUFFER: 330 Buffer = SourceDesc->Buffer.Pointer; 331 Length = SourceDesc->Buffer.Length; 332 break; 333 334 case ACPI_TYPE_STRING: 335 Buffer = SourceDesc->String.Pointer; 336 Length = SourceDesc->String.Length; 337 break; 338 339 default: 340 return_ACPI_STATUS (AE_AML_OPERAND_TYPE); 341 } 342 343 /* 344 * We must have a buffer that is at least as long as the field 345 * we are writing to. This is because individual fields are 346 * indivisible and partial writes are not supported -- as per 347 * the ACPI specification. 348 */ 349 NewBuffer = NULL; 350 RequiredLength = ACPI_ROUND_BITS_UP_TO_BYTES (ObjDesc->CommonField.BitLength); 351 352 if (Length < RequiredLength) 353 { 354 /* We need to create a new buffer */ 355 356 NewBuffer = ACPI_MEM_CALLOCATE (RequiredLength); 357 if (!NewBuffer) 358 { 359 return_ACPI_STATUS (AE_NO_MEMORY); 360 } 361 362 /* 363 * Copy the original data to the new buffer, starting 364 * at Byte zero. All unused (upper) bytes of the 365 * buffer will be 0. 366 */ 367 ACPI_MEMCPY ((char *) NewBuffer, (char *) Buffer, Length); 368 Buffer = NewBuffer; 369 Length = RequiredLength; 370 } 371 372 ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD, 373 "Obj=%p Type=%X Buf=%p Len=%X\n", 374 ObjDesc, ACPI_GET_OBJECT_TYPE (ObjDesc), Buffer, Length)); 375 ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD, 376 "FieldRead: BitLen=%X BitOff=%X ByteOff=%X\n", 377 ObjDesc->CommonField.BitLength, 378 ObjDesc->CommonField.StartFieldBitOffset, 379 ObjDesc->CommonField.BaseByteOffset)); 380 381 Locked = AcpiExAcquireGlobalLock (ObjDesc->CommonField.FieldFlags); 382 383 /* 384 * Write to the field 385 */ 386 Status = AcpiExInsertIntoField (ObjDesc, Buffer, Length); 387 388 /* 389 * Release global lock if we acquired it earlier 390 */ 391 AcpiExReleaseGlobalLock (Locked); 392 393 /* Free temporary buffer if we used one */ 394 395 if (NewBuffer) 396 { 397 ACPI_MEM_FREE (NewBuffer); 398 } 399 400 return_ACPI_STATUS (Status); 401} 402 403 404