1 /******************************************************************************
3 * Module Name: exfield - ACPI AML (p-code) execution - field manipulation
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2009, Intel Corp.
12 * All rights reserved.
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
37 * The above copyright and patent license is granted only if the following
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
72 * 3.4. Intel retains all right, title, and interest in and to the Original
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
80 * 4. Disclaimer and Export Compliance
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
114 *****************************************************************************/
117 #define __EXFIELD_C__
119 #include <contrib/dev/acpica/include/acpi.h>
120 #include <contrib/dev/acpica/include/accommon.h>
121 #include <contrib/dev/acpica/include/acdispat.h>
122 #include <contrib/dev/acpica/include/acinterp.h>
125 #define _COMPONENT ACPI_EXECUTER
126 ACPI_MODULE_NAME ("exfield")
129 /*******************************************************************************
131 * FUNCTION: AcpiExReadDataFromField
133 * PARAMETERS: WalkState - Current execution state
134 * ObjDesc - The named field
135 * RetBufferDesc - Where the return data object is stored
139 * DESCRIPTION: Read from a named field. Returns either an Integer or a
140 * Buffer, depending on the size of the field.
142 ******************************************************************************/
145 AcpiExReadDataFromField (
146 ACPI_WALK_STATE *WalkState,
147 ACPI_OPERAND_OBJECT *ObjDesc,
148 ACPI_OPERAND_OBJECT **RetBufferDesc)
151 ACPI_OPERAND_OBJECT *BufferDesc;
156 ACPI_FUNCTION_TRACE_PTR (ExReadDataFromField, ObjDesc);
159 /* Parameter validation */
163 return_ACPI_STATUS (AE_AML_NO_OPERAND);
167 return_ACPI_STATUS (AE_BAD_PARAMETER);
170 if (ObjDesc->Common.Type == ACPI_TYPE_BUFFER_FIELD)
173 * If the BufferField arguments have not been previously evaluated,
174 * evaluate them now and save the results.
176 if (!(ObjDesc->Common.Flags & AOPOBJ_DATA_VALID))
178 Status = AcpiDsGetBufferFieldArguments (ObjDesc);
179 if (ACPI_FAILURE (Status))
181 return_ACPI_STATUS (Status);
185 else if ((ObjDesc->Common.Type == ACPI_TYPE_LOCAL_REGION_FIELD) &&
186 (ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_SMBUS))
189 * This is an SMBus read. We must create a buffer to hold the data
190 * and directly access the region handler.
192 BufferDesc = AcpiUtCreateBufferObject (ACPI_SMBUS_BUFFER_SIZE);
195 return_ACPI_STATUS (AE_NO_MEMORY);
198 /* Lock entire transaction if requested */
200 AcpiExAcquireGlobalLock (ObjDesc->CommonField.FieldFlags);
204 * Note: Smbus protocol value is passed in upper 16-bits of Function
206 Status = AcpiExAccessRegion (ObjDesc, 0,
207 ACPI_CAST_PTR (ACPI_INTEGER, BufferDesc->Buffer.Pointer),
208 ACPI_READ | (ObjDesc->Field.Attribute << 16));
209 AcpiExReleaseGlobalLock (ObjDesc->CommonField.FieldFlags);
214 * Allocate a buffer for the contents of the field.
216 * If the field is larger than the size of an ACPI_INTEGER, create
217 * a BUFFER to hold it. Otherwise, use an INTEGER. This allows
218 * the use of arithmetic operators on the returned value if the
219 * field size is equal or smaller than an Integer.
221 * Note: Field.length is in bits.
223 Length = (ACPI_SIZE) ACPI_ROUND_BITS_UP_TO_BYTES (ObjDesc->Field.BitLength);
224 if (Length > AcpiGbl_IntegerByteWidth)
226 /* Field is too large for an Integer, create a Buffer instead */
228 BufferDesc = AcpiUtCreateBufferObject (Length);
231 return_ACPI_STATUS (AE_NO_MEMORY);
233 Buffer = BufferDesc->Buffer.Pointer;
237 /* Field will fit within an Integer (normal case) */
239 BufferDesc = AcpiUtCreateInternalObject (ACPI_TYPE_INTEGER);
242 return_ACPI_STATUS (AE_NO_MEMORY);
245 Length = AcpiGbl_IntegerByteWidth;
246 BufferDesc->Integer.Value = 0;
247 Buffer = &BufferDesc->Integer.Value;
250 ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
251 "FieldRead [TO]: Obj %p, Type %X, Buf %p, ByteLen %X\n",
252 ObjDesc, ObjDesc->Common.Type, Buffer, (UINT32) Length));
253 ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
254 "FieldRead [FROM]: BitLen %X, BitOff %X, ByteOff %X\n",
255 ObjDesc->CommonField.BitLength,
256 ObjDesc->CommonField.StartFieldBitOffset,
257 ObjDesc->CommonField.BaseByteOffset));
259 /* Lock entire transaction if requested */
261 AcpiExAcquireGlobalLock (ObjDesc->CommonField.FieldFlags);
263 /* Read from the field */
265 Status = AcpiExExtractFromField (ObjDesc, Buffer, (UINT32) Length);
266 AcpiExReleaseGlobalLock (ObjDesc->CommonField.FieldFlags);
270 if (ACPI_FAILURE (Status))
272 AcpiUtRemoveReference (BufferDesc);
276 *RetBufferDesc = BufferDesc;
279 return_ACPI_STATUS (Status);
283 /*******************************************************************************
285 * FUNCTION: AcpiExWriteDataToField
287 * PARAMETERS: SourceDesc - Contains data to write
288 * ObjDesc - The named field
289 * ResultDesc - Where the return value is returned, if any
293 * DESCRIPTION: Write to a named field
295 ******************************************************************************/
298 AcpiExWriteDataToField (
299 ACPI_OPERAND_OBJECT *SourceDesc,
300 ACPI_OPERAND_OBJECT *ObjDesc,
301 ACPI_OPERAND_OBJECT **ResultDesc)
306 ACPI_OPERAND_OBJECT *BufferDesc;
309 ACPI_FUNCTION_TRACE_PTR (ExWriteDataToField, ObjDesc);
312 /* Parameter validation */
314 if (!SourceDesc || !ObjDesc)
316 return_ACPI_STATUS (AE_AML_NO_OPERAND);
319 if (ObjDesc->Common.Type == ACPI_TYPE_BUFFER_FIELD)
322 * If the BufferField arguments have not been previously evaluated,
323 * evaluate them now and save the results.
325 if (!(ObjDesc->Common.Flags & AOPOBJ_DATA_VALID))
327 Status = AcpiDsGetBufferFieldArguments (ObjDesc);
328 if (ACPI_FAILURE (Status))
330 return_ACPI_STATUS (Status);
334 else if ((ObjDesc->Common.Type == ACPI_TYPE_LOCAL_REGION_FIELD) &&
335 (ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_SMBUS))
338 * This is an SMBus write. We will bypass the entire field mechanism
339 * and handoff the buffer directly to the handler.
341 * Source must be a buffer of sufficient size (ACPI_SMBUS_BUFFER_SIZE).
343 if (SourceDesc->Common.Type != ACPI_TYPE_BUFFER)
345 ACPI_ERROR ((AE_INFO, "SMBus write requires Buffer, found type %s",
346 AcpiUtGetObjectTypeName (SourceDesc)));
348 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
351 if (SourceDesc->Buffer.Length < ACPI_SMBUS_BUFFER_SIZE)
353 ACPI_ERROR ((AE_INFO,
354 "SMBus write requires Buffer of length %X, found length %X",
355 ACPI_SMBUS_BUFFER_SIZE, SourceDesc->Buffer.Length));
357 return_ACPI_STATUS (AE_AML_BUFFER_LIMIT);
360 BufferDesc = AcpiUtCreateBufferObject (ACPI_SMBUS_BUFFER_SIZE);
363 return_ACPI_STATUS (AE_NO_MEMORY);
366 Buffer = BufferDesc->Buffer.Pointer;
367 ACPI_MEMCPY (Buffer, SourceDesc->Buffer.Pointer,
368 ACPI_SMBUS_BUFFER_SIZE);
370 /* Lock entire transaction if requested */
372 AcpiExAcquireGlobalLock (ObjDesc->CommonField.FieldFlags);
375 * Perform the write (returns status and perhaps data in the
377 * Note: SMBus protocol type is passed in upper 16-bits of Function.
379 Status = AcpiExAccessRegion (ObjDesc, 0,
380 (ACPI_INTEGER *) Buffer,
381 ACPI_WRITE | (ObjDesc->Field.Attribute << 16));
382 AcpiExReleaseGlobalLock (ObjDesc->CommonField.FieldFlags);
384 *ResultDesc = BufferDesc;
385 return_ACPI_STATUS (Status);
388 /* Get a pointer to the data to be written */
390 switch (SourceDesc->Common.Type)
392 case ACPI_TYPE_INTEGER:
393 Buffer = &SourceDesc->Integer.Value;
394 Length = sizeof (SourceDesc->Integer.Value);
397 case ACPI_TYPE_BUFFER:
398 Buffer = SourceDesc->Buffer.Pointer;
399 Length = SourceDesc->Buffer.Length;
402 case ACPI_TYPE_STRING:
403 Buffer = SourceDesc->String.Pointer;
404 Length = SourceDesc->String.Length;
408 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
411 ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
412 "FieldWrite [FROM]: Obj %p (%s:%X), Buf %p, ByteLen %X\n",
413 SourceDesc, AcpiUtGetTypeName (SourceDesc->Common.Type),
414 SourceDesc->Common.Type, Buffer, Length));
416 ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
417 "FieldWrite [TO]: Obj %p (%s:%X), BitLen %X, BitOff %X, ByteOff %X\n",
418 ObjDesc, AcpiUtGetTypeName (ObjDesc->Common.Type),
419 ObjDesc->Common.Type,
420 ObjDesc->CommonField.BitLength,
421 ObjDesc->CommonField.StartFieldBitOffset,
422 ObjDesc->CommonField.BaseByteOffset));
424 /* Lock entire transaction if requested */
426 AcpiExAcquireGlobalLock (ObjDesc->CommonField.FieldFlags);
428 /* Write to the field */
430 Status = AcpiExInsertIntoField (ObjDesc, Buffer, Length);
431 AcpiExReleaseGlobalLock (ObjDesc->CommonField.FieldFlags);
433 return_ACPI_STATUS (Status);