1 /******************************************************************************
3 * Module Name: exfldio - Aml Field I/O
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2004, Intel Corp.
13 * All rights reserved.
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
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
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;
38 * The above copyright and patent license is granted only if the following
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.
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
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
73 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
81 * 4. Disclaimer and Export Compliance
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
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
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.
115 *****************************************************************************/
118 #define __EXFLDIO_C__
121 #include "acinterp.h"
123 #include "acevents.h"
124 #include "acdispat.h"
127 #define _COMPONENT ACPI_EXECUTER
128 ACPI_MODULE_NAME ("exfldio")
131 /*******************************************************************************
133 * FUNCTION: AcpiExSetupRegion
135 * PARAMETERS: *ObjDesc - Field to be read or written
136 * FieldDatumByteOffset - Byte offset of this datum within the
141 * DESCRIPTION: Common processing for AcpiExExtractFromField and
142 * AcpiExInsertIntoField. Initialize the Region if necessary and
143 * validate the request.
145 ******************************************************************************/
149 ACPI_OPERAND_OBJECT *ObjDesc,
150 UINT32 FieldDatumByteOffset)
152 ACPI_STATUS Status = AE_OK;
153 ACPI_OPERAND_OBJECT *RgnDesc;
156 ACPI_FUNCTION_TRACE_U32 ("ExSetupRegion", FieldDatumByteOffset);
159 RgnDesc = ObjDesc->CommonField.RegionObj;
161 /* We must have a valid region */
163 if (ACPI_GET_OBJECT_TYPE (RgnDesc) != ACPI_TYPE_REGION)
165 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Needed Region, found type %X (%s)\n",
166 ACPI_GET_OBJECT_TYPE (RgnDesc),
167 AcpiUtGetObjectTypeName (RgnDesc)));
169 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
173 * If the Region Address and Length have not been previously evaluated,
174 * evaluate them now and save the results.
176 if (!(RgnDesc->Common.Flags & AOPOBJ_DATA_VALID))
178 Status = AcpiDsGetRegionArguments (RgnDesc);
179 if (ACPI_FAILURE (Status))
181 return_ACPI_STATUS (Status);
185 if (RgnDesc->Region.SpaceId == ACPI_ADR_SPACE_SMBUS)
187 /* SMBus has a non-linear address space */
189 return_ACPI_STATUS (AE_OK);
192 #ifdef ACPI_UNDER_DEVELOPMENT
194 * If the Field access is AnyAcc, we can now compute the optimal
195 * access (because we know know the length of the parent region)
197 if (!(ObjDesc->Common.Flags & AOPOBJ_DATA_VALID))
199 if (ACPI_FAILURE (Status))
201 return_ACPI_STATUS (Status);
207 * Validate the request. The entire request from the byte offset for a
208 * length of one field datum (access width) must fit within the region.
209 * (Region length is specified in bytes)
211 if (RgnDesc->Region.Length < (ObjDesc->CommonField.BaseByteOffset
212 + FieldDatumByteOffset
213 + ObjDesc->CommonField.AccessByteWidth))
215 if (AcpiGbl_EnableInterpreterSlack)
218 * Slack mode only: We will go ahead and allow access to this
219 * field if it is within the region length rounded up to the next
220 * access width boundary.
222 if (ACPI_ROUND_UP (RgnDesc->Region.Length,
223 ObjDesc->CommonField.AccessByteWidth) >=
224 (ObjDesc->CommonField.BaseByteOffset +
225 (ACPI_NATIVE_UINT) ObjDesc->CommonField.AccessByteWidth +
226 FieldDatumByteOffset))
228 return_ACPI_STATUS (AE_OK);
232 if (RgnDesc->Region.Length < ObjDesc->CommonField.AccessByteWidth)
235 * This is the case where the AccessType (AccWord, etc.) is wider
236 * than the region itself. For example, a region of length one
237 * byte, and a field with Dword access specified.
239 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
240 "Field [%4.4s] access width (%d bytes) too large for region [%4.4s] (length %X)\n",
241 AcpiUtGetNodeName (ObjDesc->CommonField.Node),
242 ObjDesc->CommonField.AccessByteWidth,
243 AcpiUtGetNodeName (RgnDesc->Region.Node), RgnDesc->Region.Length));
247 * Offset rounded up to next multiple of field width
248 * exceeds region length, indicate an error
250 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
251 "Field [%4.4s] Base+Offset+Width %X+%X+%X is beyond end of region [%4.4s] (length %X)\n",
252 AcpiUtGetNodeName (ObjDesc->CommonField.Node),
253 ObjDesc->CommonField.BaseByteOffset,
254 FieldDatumByteOffset, ObjDesc->CommonField.AccessByteWidth,
255 AcpiUtGetNodeName (RgnDesc->Region.Node), RgnDesc->Region.Length));
257 return_ACPI_STATUS (AE_AML_REGION_LIMIT);
260 return_ACPI_STATUS (AE_OK);
264 /*******************************************************************************
266 * FUNCTION: AcpiExAccessRegion
268 * PARAMETERS: *ObjDesc - Field to be read
269 * FieldDatumByteOffset - Byte offset of this datum within the
271 * *Value - Where to store value (must at least
272 * the size of ACPI_INTEGER)
273 * Function - Read or Write flag plus other region-
278 * DESCRIPTION: Read or Write a single field datum to an Operation Region.
280 ******************************************************************************/
284 ACPI_OPERAND_OBJECT *ObjDesc,
285 UINT32 FieldDatumByteOffset,
290 ACPI_OPERAND_OBJECT *RgnDesc;
291 ACPI_PHYSICAL_ADDRESS Address;
294 ACPI_FUNCTION_TRACE ("ExAccessRegion");
298 * Ensure that the region operands are fully evaluated and verify
299 * the validity of the request
301 Status = AcpiExSetupRegion (ObjDesc, FieldDatumByteOffset);
302 if (ACPI_FAILURE (Status))
304 return_ACPI_STATUS (Status);
308 * The physical address of this field datum is:
310 * 1) The base of the region, plus
311 * 2) The base offset of the field, plus
312 * 3) The current offset into the field
314 RgnDesc = ObjDesc->CommonField.RegionObj;
315 Address = RgnDesc->Region.Address
316 + ObjDesc->CommonField.BaseByteOffset
317 + FieldDatumByteOffset;
319 if ((Function & ACPI_IO_MASK) == ACPI_READ)
321 ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD, "[READ]"));
325 ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD, "[WRITE]"));
328 ACPI_DEBUG_PRINT_RAW ((ACPI_DB_BFIELD,
329 " Region [%s:%X], Width %X, ByteBase %X, Offset %X at %8.8X%8.8X\n",
330 AcpiUtGetRegionName (RgnDesc->Region.SpaceId),
331 RgnDesc->Region.SpaceId,
332 ObjDesc->CommonField.AccessByteWidth,
333 ObjDesc->CommonField.BaseByteOffset,
334 FieldDatumByteOffset,
335 ACPI_FORMAT_UINT64 (Address)));
337 /* Invoke the appropriate AddressSpace/OpRegion handler */
339 Status = AcpiEvAddressSpaceDispatch (RgnDesc, Function,
340 Address, ACPI_MUL_8 (ObjDesc->CommonField.AccessByteWidth), Value);
342 if (ACPI_FAILURE (Status))
344 if (Status == AE_NOT_IMPLEMENTED)
346 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
347 "Region %s(%X) not implemented\n",
348 AcpiUtGetRegionName (RgnDesc->Region.SpaceId),
349 RgnDesc->Region.SpaceId));
351 else if (Status == AE_NOT_EXIST)
354 "Region %s(%X) has no handler\n",
355 AcpiUtGetRegionName (RgnDesc->Region.SpaceId),
356 RgnDesc->Region.SpaceId));
360 return_ACPI_STATUS (Status);
364 /*******************************************************************************
366 * FUNCTION: AcpiExRegisterOverflow
368 * PARAMETERS: *ObjDesc - Register(Field) to be written
369 * Value - Value to be stored
371 * RETURN: TRUE if value overflows the field, FALSE otherwise
373 * DESCRIPTION: Check if a value is out of range of the field being written.
374 * Used to check if the values written to Index and Bank registers
375 * are out of range. Normally, the value is simply truncated
376 * to fit the field, but this case is most likely a serious
377 * coding error in the ASL.
379 ******************************************************************************/
382 AcpiExRegisterOverflow (
383 ACPI_OPERAND_OBJECT *ObjDesc,
387 if (ObjDesc->CommonField.BitLength >= ACPI_INTEGER_BIT_SIZE)
390 * The field is large enough to hold the maximum integer, so we can
396 if (Value >= ((ACPI_INTEGER) 1 << ObjDesc->CommonField.BitLength))
399 * The Value is larger than the maximum value that can fit into
405 /* The Value will fit into the field with no truncation */
411 /*******************************************************************************
413 * FUNCTION: AcpiExFieldDatumIo
415 * PARAMETERS: *ObjDesc - Field to be read
416 * FieldDatumByteOffset - Byte offset of this datum within the
418 * *Value - Where to store value (must be 64 bits)
419 * ReadWrite - Read or Write flag
423 * DESCRIPTION: Read or Write a single datum of a field. The FieldType is
424 * demultiplexed here to handle the different types of fields
425 * (BufferField, RegionField, IndexField, BankField)
427 ******************************************************************************/
431 ACPI_OPERAND_OBJECT *ObjDesc,
432 UINT32 FieldDatumByteOffset,
437 ACPI_INTEGER LocalValue;
440 ACPI_FUNCTION_TRACE_U32 ("ExFieldDatumIo", FieldDatumByteOffset);
443 if (ReadWrite == ACPI_READ)
448 Value = &LocalValue; /* To support reads without saving return value */
451 /* Clear the entire return buffer first, [Very Important!] */
457 * The four types of fields are:
459 * BufferField - Read/write from/to a Buffer
460 * RegionField - Read/write from/to a Operation Region.
461 * BankField - Write to a Bank Register, then read/write from/to an OpRegion
462 * IndexField - Write to an Index Register, then read/write from/to a Data Register
464 switch (ACPI_GET_OBJECT_TYPE (ObjDesc))
466 case ACPI_TYPE_BUFFER_FIELD:
468 * If the BufferField arguments have not been previously evaluated,
469 * evaluate them now and save the results.
471 if (!(ObjDesc->Common.Flags & AOPOBJ_DATA_VALID))
473 Status = AcpiDsGetBufferFieldArguments (ObjDesc);
474 if (ACPI_FAILURE (Status))
476 return_ACPI_STATUS (Status);
480 if (ReadWrite == ACPI_READ)
483 * Copy the data from the source buffer.
484 * Length is the field width in bytes.
486 ACPI_MEMCPY (Value, (ObjDesc->BufferField.BufferObj)->Buffer.Pointer
487 + ObjDesc->BufferField.BaseByteOffset
488 + FieldDatumByteOffset,
489 ObjDesc->CommonField.AccessByteWidth);
494 * Copy the data to the target buffer.
495 * Length is the field width in bytes.
497 ACPI_MEMCPY ((ObjDesc->BufferField.BufferObj)->Buffer.Pointer
498 + ObjDesc->BufferField.BaseByteOffset
499 + FieldDatumByteOffset,
500 Value, ObjDesc->CommonField.AccessByteWidth);
507 case ACPI_TYPE_LOCAL_BANK_FIELD:
509 /* Ensure that the BankValue is not beyond the capacity of the register */
511 if (AcpiExRegisterOverflow (ObjDesc->BankField.BankObj,
512 (ACPI_INTEGER) ObjDesc->BankField.Value))
514 return_ACPI_STATUS (AE_AML_REGISTER_LIMIT);
518 * For BankFields, we must write the BankValue to the BankRegister
519 * (itself a RegionField) before we can access the data.
521 Status = AcpiExInsertIntoField (ObjDesc->BankField.BankObj,
522 &ObjDesc->BankField.Value,
523 sizeof (ObjDesc->BankField.Value));
524 if (ACPI_FAILURE (Status))
526 return_ACPI_STATUS (Status);
530 * Now that the Bank has been selected, fall through to the
531 * RegionField case and write the datum to the Operation Region
534 /*lint -fallthrough */
537 case ACPI_TYPE_LOCAL_REGION_FIELD:
539 * For simple RegionFields, we just directly access the owning
542 Status = AcpiExAccessRegion (ObjDesc, FieldDatumByteOffset, Value,
547 case ACPI_TYPE_LOCAL_INDEX_FIELD:
550 /* Ensure that the IndexValue is not beyond the capacity of the register */
552 if (AcpiExRegisterOverflow (ObjDesc->IndexField.IndexObj,
553 (ACPI_INTEGER) ObjDesc->IndexField.Value))
555 return_ACPI_STATUS (AE_AML_REGISTER_LIMIT);
558 /* Write the index value to the IndexRegister (itself a RegionField) */
560 FieldDatumByteOffset += ObjDesc->IndexField.Value;
562 ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
563 "Write to Index Register: Value %8.8X\n",
564 FieldDatumByteOffset));
566 Status = AcpiExInsertIntoField (ObjDesc->IndexField.IndexObj,
567 &FieldDatumByteOffset,
568 sizeof (FieldDatumByteOffset));
569 if (ACPI_FAILURE (Status))
571 return_ACPI_STATUS (Status);
574 ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
575 "I/O to Data Register: ValuePtr %p\n",
578 if (ReadWrite == ACPI_READ)
580 /* Read the datum from the DataRegister */
582 Status = AcpiExExtractFromField (ObjDesc->IndexField.DataObj,
583 Value, sizeof (ACPI_INTEGER));
587 /* Write the datum to the DataRegister */
589 Status = AcpiExInsertIntoField (ObjDesc->IndexField.DataObj,
590 Value, sizeof (ACPI_INTEGER));
597 ACPI_REPORT_ERROR (("Wrong object type in field I/O %X\n",
598 ACPI_GET_OBJECT_TYPE (ObjDesc)));
599 Status = AE_AML_INTERNAL;
603 if (ACPI_SUCCESS (Status))
605 if (ReadWrite == ACPI_READ)
607 ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD, "Value Read %8.8X%8.8X, Width %d\n",
608 ACPI_FORMAT_UINT64 (*Value),
609 ObjDesc->CommonField.AccessByteWidth));
613 ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD, "Value Written %8.8X%8.8X, Width %d\n",
614 ACPI_FORMAT_UINT64 (*Value),
615 ObjDesc->CommonField.AccessByteWidth));
619 return_ACPI_STATUS (Status);
623 /*******************************************************************************
625 * FUNCTION: AcpiExWriteWithUpdateRule
627 * PARAMETERS: *ObjDesc - Field to be set
628 * Value - Value to store
632 * DESCRIPTION: Apply the field update rule to a field write
634 ******************************************************************************/
637 AcpiExWriteWithUpdateRule (
638 ACPI_OPERAND_OBJECT *ObjDesc,
640 ACPI_INTEGER FieldValue,
641 UINT32 FieldDatumByteOffset)
643 ACPI_STATUS Status = AE_OK;
644 ACPI_INTEGER MergedValue;
645 ACPI_INTEGER CurrentValue;
648 ACPI_FUNCTION_TRACE_U32 ("ExWriteWithUpdateRule", Mask);
651 /* Start with the new bits */
653 MergedValue = FieldValue;
655 /* If the mask is all ones, we don't need to worry about the update rule */
657 if (Mask != ACPI_INTEGER_MAX)
659 /* Decode the update rule */
661 switch (ObjDesc->CommonField.FieldFlags & AML_FIELD_UPDATE_RULE_MASK)
663 case AML_FIELD_UPDATE_PRESERVE:
665 * Check if update rule needs to be applied (not if mask is all
666 * ones) The left shift drops the bits we want to ignore.
668 if ((~Mask << (ACPI_MUL_8 (sizeof (Mask)) -
669 ACPI_MUL_8 (ObjDesc->CommonField.AccessByteWidth))) != 0)
672 * Read the current contents of the byte/word/dword containing
673 * the field, and merge with the new field value.
675 Status = AcpiExFieldDatumIo (ObjDesc, FieldDatumByteOffset,
676 &CurrentValue, ACPI_READ);
677 if (ACPI_FAILURE (Status))
679 return_ACPI_STATUS (Status);
682 MergedValue |= (CurrentValue & ~Mask);
686 case AML_FIELD_UPDATE_WRITE_AS_ONES:
688 /* Set positions outside the field to all ones */
690 MergedValue |= ~Mask;
693 case AML_FIELD_UPDATE_WRITE_AS_ZEROS:
695 /* Set positions outside the field to all zeros */
702 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
703 "WriteWithUpdateRule: Unknown UpdateRule setting: %X\n",
704 (ObjDesc->CommonField.FieldFlags & AML_FIELD_UPDATE_RULE_MASK)));
705 return_ACPI_STATUS (AE_AML_OPERAND_VALUE);
709 ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
710 "Mask %8.8X%8.8X, DatumOffset %X, Width %X, Value %8.8X%8.8X, MergedValue %8.8X%8.8X\n",
711 ACPI_FORMAT_UINT64 (Mask),
712 FieldDatumByteOffset,
713 ObjDesc->CommonField.AccessByteWidth,
714 ACPI_FORMAT_UINT64 (FieldValue),
715 ACPI_FORMAT_UINT64 (MergedValue)));
717 /* Write the merged value */
719 Status = AcpiExFieldDatumIo (ObjDesc, FieldDatumByteOffset,
720 &MergedValue, ACPI_WRITE);
722 return_ACPI_STATUS (Status);
726 /*******************************************************************************
728 * FUNCTION: AcpiExGetBufferDatum
730 * PARAMETERS: Datum - Where the Datum is returned
731 * Buffer - Raw field buffer
732 * BufferLength - Entire length (used for big-endian only)
733 * ByteGranularity - 1/2/4/8 Granularity of the field
735 * BufferOffset - Datum offset into the buffer
739 * DESCRIPTION: Get a datum from the buffer according to the buffer field
742 ******************************************************************************/
745 AcpiExGetBufferDatum (
749 UINT32 ByteGranularity,
755 ACPI_FUNCTION_TRACE_U32 ("ExGetBufferDatum", ByteGranularity);
758 /* Get proper index into buffer (handles big/little endian) */
760 Index = ACPI_BUFFER_INDEX (BufferLength, BufferOffset, ByteGranularity);
762 /* Move the requested number of bytes */
764 switch (ByteGranularity)
766 case ACPI_FIELD_BYTE_GRANULARITY:
768 *Datum = ((UINT8 *) Buffer) [Index];
771 case ACPI_FIELD_WORD_GRANULARITY:
773 ACPI_MOVE_16_TO_64 (Datum, &(((UINT16 *) Buffer) [Index]));
776 case ACPI_FIELD_DWORD_GRANULARITY:
778 ACPI_MOVE_32_TO_64 (Datum, &(((UINT32 *) Buffer) [Index]));
781 case ACPI_FIELD_QWORD_GRANULARITY:
783 ACPI_MOVE_64_TO_64 (Datum, &(((UINT64 *) Buffer) [Index]));
787 /* Should not get here */
795 /*******************************************************************************
797 * FUNCTION: AcpiExSetBufferDatum
799 * PARAMETERS: MergedDatum - Value to store
800 * Buffer - Receiving buffer
801 * BufferLength - Entire length (used for big-endian only)
802 * ByteGranularity - 1/2/4/8 Granularity of the field
804 * BufferOffset - Datum offset into the buffer
808 * DESCRIPTION: Store the merged datum to the buffer according to the
811 ******************************************************************************/
814 AcpiExSetBufferDatum (
815 ACPI_INTEGER MergedDatum,
818 UINT32 ByteGranularity,
824 ACPI_FUNCTION_TRACE_U32 ("ExSetBufferDatum", ByteGranularity);
827 /* Get proper index into buffer (handles big/little endian) */
829 Index = ACPI_BUFFER_INDEX (BufferLength, BufferOffset, ByteGranularity);
831 /* Move the requested number of bytes */
833 switch (ByteGranularity)
835 case ACPI_FIELD_BYTE_GRANULARITY:
837 ((UINT8 *) Buffer) [Index] = (UINT8) MergedDatum;
840 case ACPI_FIELD_WORD_GRANULARITY:
842 ACPI_MOVE_64_TO_16 (&(((UINT16 *) Buffer)[Index]), &MergedDatum);
845 case ACPI_FIELD_DWORD_GRANULARITY:
847 ACPI_MOVE_64_TO_32 (&(((UINT32 *) Buffer)[Index]), &MergedDatum);
850 case ACPI_FIELD_QWORD_GRANULARITY:
852 ACPI_MOVE_64_TO_64 (&(((UINT64 *) Buffer)[Index]), &MergedDatum);
856 /* Should not get here */
864 /*******************************************************************************
866 * FUNCTION: AcpiExCommonBufferSetup
868 * PARAMETERS: ObjDesc - Field object
869 * BufferLength - Length of caller's buffer
870 * DatumCount - Where the DatumCount is returned
872 * RETURN: Status, DatumCount
874 * DESCRIPTION: Common code to validate the incoming buffer size and compute
875 * the number of field "datums" that must be read or written.
876 * A "datum" is the smallest unit that can be read or written
877 * to the field, it is either 1,2,4, or 8 bytes.
879 ******************************************************************************/
882 AcpiExCommonBufferSetup (
883 ACPI_OPERAND_OBJECT *ObjDesc,
887 UINT32 ByteFieldLength;
888 UINT32 ActualByteFieldLength;
891 ACPI_FUNCTION_TRACE ("ExCommonBufferSetup");
895 * Incoming buffer must be at least as long as the field, we do not
896 * allow "partial" field reads/writes. We do not care if the buffer is
897 * larger than the field, this typically happens when an integer is
898 * read/written to a field that is actually smaller than an integer.
900 ByteFieldLength = ACPI_ROUND_BITS_UP_TO_BYTES (
901 ObjDesc->CommonField.BitLength);
902 if (ByteFieldLength > BufferLength)
904 ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
905 "Field size %X (bytes) is too large for buffer (%X)\n",
906 ByteFieldLength, BufferLength));
908 return_ACPI_STATUS (AE_BUFFER_OVERFLOW);
912 * Create "actual" field byte count (minimum number of bytes that
913 * must be read), then convert to datum count (minimum number
914 * of datum-sized units that must be read)
916 ActualByteFieldLength = ACPI_ROUND_BITS_UP_TO_BYTES (
917 ObjDesc->CommonField.StartFieldBitOffset +
918 ObjDesc->CommonField.BitLength);
921 *DatumCount = ACPI_ROUND_UP_TO (ActualByteFieldLength,
922 ObjDesc->CommonField.AccessByteWidth);
924 ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
925 "BufferBytes %X, ActualBytes %X, Datums %X, ByteGran %X\n",
926 ByteFieldLength, ActualByteFieldLength,
927 *DatumCount, ObjDesc->CommonField.AccessByteWidth));
929 return_ACPI_STATUS (AE_OK);
933 /*******************************************************************************
935 * FUNCTION: AcpiExExtractFromField
937 * PARAMETERS: ObjDesc - Field to be read
938 * Buffer - Where to store the field data
939 * BufferLength - Length of Buffer
943 * DESCRIPTION: Retrieve the current value of the given field
945 ******************************************************************************/
948 AcpiExExtractFromField (
949 ACPI_OPERAND_OBJECT *ObjDesc,
954 UINT32 FieldDatumByteOffset;
955 UINT32 BufferDatumOffset;
956 ACPI_INTEGER PreviousRawDatum = 0;
957 ACPI_INTEGER ThisRawDatum = 0;
958 ACPI_INTEGER MergedDatum = 0;
963 ACPI_FUNCTION_TRACE ("ExExtractFromField");
966 /* Validate buffer, compute number of datums */
968 Status = AcpiExCommonBufferSetup (ObjDesc, BufferLength, &DatumCount);
969 if (ACPI_FAILURE (Status))
971 return_ACPI_STATUS (Status);
975 * Clear the caller's buffer (the whole buffer length as given)
976 * This is very important, especially in the cases where the buffer
977 * is longer than the size of the field.
979 ACPI_MEMSET (Buffer, 0, BufferLength);
981 FieldDatumByteOffset = 0;
982 BufferDatumOffset= 0;
984 /* Read the entire field */
986 for (i = 0; i < DatumCount; i++)
988 Status = AcpiExFieldDatumIo (ObjDesc, FieldDatumByteOffset,
989 &ThisRawDatum, ACPI_READ);
990 if (ACPI_FAILURE (Status))
992 return_ACPI_STATUS (Status);
995 /* We might actually be done if the request fits in one datum */
997 if ((DatumCount == 1) &&
998 (ObjDesc->CommonField.Flags & AOPOBJ_SINGLE_DATUM))
1000 /* 1) Shift the valid data bits down to start at bit 0 */
1002 MergedDatum = (ThisRawDatum >> ObjDesc->CommonField.StartFieldBitOffset);
1004 /* 2) Mask off any upper unused bits (bits not part of the field) */
1006 if (ObjDesc->CommonField.EndBufferValidBits)
1008 MergedDatum &= ACPI_MASK_BITS_ABOVE (ObjDesc->CommonField.EndBufferValidBits);
1011 /* Store the datum to the caller buffer */
1013 AcpiExSetBufferDatum (MergedDatum, Buffer, BufferLength,
1014 ObjDesc->CommonField.AccessByteWidth, BufferDatumOffset);
1016 return_ACPI_STATUS (AE_OK);
1019 /* Special handling for the last datum to ignore extra bits */
1021 if ((i >= (DatumCount -1)) &&
1022 (ObjDesc->CommonField.EndFieldValidBits))
1025 * This is the last iteration of the loop. We need to clear
1026 * any unused bits (bits that are not part of this field) before
1027 * we store the final merged datum into the caller buffer.
1030 ACPI_MASK_BITS_ABOVE (ObjDesc->CommonField.EndFieldValidBits);
1034 * Create the (possibly) merged datum to be stored to the caller buffer
1036 if (ObjDesc->CommonField.StartFieldBitOffset == 0)
1038 /* Field is not skewed and we can just copy the datum */
1040 AcpiExSetBufferDatum (ThisRawDatum, Buffer, BufferLength,
1041 ObjDesc->CommonField.AccessByteWidth, BufferDatumOffset);
1042 BufferDatumOffset++;
1046 /* Not aligned -- on the first iteration, just save the datum */
1051 * Put together the appropriate bits of the two raw data to make a
1052 * single complete field datum
1054 * 1) Normalize the first datum down to bit 0
1056 MergedDatum = (PreviousRawDatum >> ObjDesc->CommonField.StartFieldBitOffset);
1058 /* 2) Insert the second datum "above" the first datum */
1060 MergedDatum |= (ThisRawDatum << ObjDesc->CommonField.DatumValidBits);
1062 AcpiExSetBufferDatum (MergedDatum, Buffer, BufferLength,
1063 ObjDesc->CommonField.AccessByteWidth, BufferDatumOffset);
1064 BufferDatumOffset++;
1068 * Save the raw datum that was just acquired since it may contain bits
1069 * of the *next* field datum
1071 PreviousRawDatum = ThisRawDatum;
1074 FieldDatumByteOffset += ObjDesc->CommonField.AccessByteWidth;
1077 /* For non-aligned case, there is one last datum to insert */
1079 if (ObjDesc->CommonField.StartFieldBitOffset != 0)
1081 MergedDatum = (ThisRawDatum >> ObjDesc->CommonField.StartFieldBitOffset);
1083 AcpiExSetBufferDatum (MergedDatum, Buffer, BufferLength,
1084 ObjDesc->CommonField.AccessByteWidth, BufferDatumOffset);
1087 return_ACPI_STATUS (AE_OK);
1091 /*******************************************************************************
1093 * FUNCTION: AcpiExInsertIntoField
1095 * PARAMETERS: ObjDesc - Field to be written
1096 * Buffer - Data to be written
1097 * BufferLength - Length of Buffer
1101 * DESCRIPTION: Store the Buffer contents into the given field
1103 ******************************************************************************/
1106 AcpiExInsertIntoField (
1107 ACPI_OPERAND_OBJECT *ObjDesc,
1109 UINT32 BufferLength)
1112 UINT32 FieldDatumByteOffset;
1115 ACPI_INTEGER MergedDatum;
1116 ACPI_INTEGER PreviousRawDatum;
1117 ACPI_INTEGER ThisRawDatum;
1121 ACPI_FUNCTION_TRACE ("ExInsertIntoField");
1124 /* Validate buffer, compute number of datums */
1126 Status = AcpiExCommonBufferSetup (ObjDesc, BufferLength, &DatumCount);
1127 if (ACPI_FAILURE (Status))
1129 return_ACPI_STATUS (Status);
1133 * Break the request into up to three parts (similar to an I/O request):
1134 * 1) non-aligned part at start
1135 * 2) aligned part in middle
1136 * 3) non-aligned part at the end
1138 FieldDatumByteOffset = 0;
1141 /* Get a single datum from the caller's buffer */
1143 AcpiExGetBufferDatum (&PreviousRawDatum, Buffer, BufferLength,
1144 ObjDesc->CommonField.AccessByteWidth, DatumOffset);
1148 * Write a partial field datum if field does not begin on a datum boundary
1149 * Note: The code in this section also handles the aligned case
1151 * Construct Mask with 1 bits where the field is, 0 bits elsewhere
1152 * (Only the bottom 5 bits of BitLength are valid for a shift operation)
1154 * Mask off bits that are "below" the field (if any)
1156 Mask = ACPI_MASK_BITS_BELOW (ObjDesc->CommonField.StartFieldBitOffset);
1158 /* If the field fits in one datum, may need to mask upper bits */
1160 if ((ObjDesc->CommonField.Flags & AOPOBJ_SINGLE_DATUM) &&
1161 ObjDesc->CommonField.EndFieldValidBits)
1163 /* There are bits above the field, mask them off also */
1165 Mask &= ACPI_MASK_BITS_ABOVE (ObjDesc->CommonField.EndFieldValidBits);
1168 /* Shift and mask the value into the field position */
1170 MergedDatum = (PreviousRawDatum << ObjDesc->CommonField.StartFieldBitOffset);
1171 MergedDatum &= Mask;
1173 /* Apply the update rule (if necessary) and write the datum to the field */
1175 Status = AcpiExWriteWithUpdateRule (ObjDesc, Mask, MergedDatum,
1176 FieldDatumByteOffset);
1177 if (ACPI_FAILURE (Status))
1179 return_ACPI_STATUS (Status);
1182 /* We just wrote the first datum */
1186 /* If the entire field fits within one datum, we are done. */
1188 if ((DatumCount == 1) &&
1189 (ObjDesc->CommonField.Flags & AOPOBJ_SINGLE_DATUM))
1191 return_ACPI_STATUS (AE_OK);
1196 * Write the aligned data.
1198 * We don't need to worry about the update rule for these data, because
1199 * all of the bits in each datum are part of the field.
1201 * The last datum must be special cased because it might contain bits
1202 * that are not part of the field -- therefore the "update rule" must be
1203 * applied in Part3 below.
1205 while (DatumOffset < DatumCount)
1207 FieldDatumByteOffset += ObjDesc->CommonField.AccessByteWidth;
1210 * Get the next raw buffer datum. It may contain bits of the previous
1213 AcpiExGetBufferDatum (&ThisRawDatum, Buffer, BufferLength,
1214 ObjDesc->CommonField.AccessByteWidth, DatumOffset);
1216 /* Create the field datum based on the field alignment */
1218 if (ObjDesc->CommonField.StartFieldBitOffset != 0)
1221 * Put together appropriate bits of the two raw buffer data to make
1222 * a single complete field datum
1225 (PreviousRawDatum >> ObjDesc->CommonField.DatumValidBits) |
1226 (ThisRawDatum << ObjDesc->CommonField.StartFieldBitOffset);
1230 /* Field began aligned on datum boundary */
1232 MergedDatum = ThisRawDatum;
1236 * Special handling for the last datum if the field does NOT end on
1237 * a datum boundary. Update Rule must be applied to the bits outside
1241 if ((DatumOffset == DatumCount) &&
1242 (ObjDesc->CommonField.EndFieldValidBits))
1245 * If there are dangling non-aligned bits, perform one more merged write
1246 * Else - field is aligned at the end, no need for any more writes
1251 * This is the last datum and the field does not end on a datum boundary.
1252 * Build the partial datum and write with the update rule.
1254 * Mask off the unused bits above (after) the end-of-field
1256 Mask = ACPI_MASK_BITS_ABOVE (ObjDesc->CommonField.EndFieldValidBits);
1257 MergedDatum &= Mask;
1259 /* Write the last datum with the update rule */
1261 Status = AcpiExWriteWithUpdateRule (ObjDesc, Mask, MergedDatum,
1262 FieldDatumByteOffset);
1263 if (ACPI_FAILURE (Status))
1265 return_ACPI_STATUS (Status);
1270 /* Normal (aligned) case -- write the completed datum */
1272 Status = AcpiExFieldDatumIo (ObjDesc, FieldDatumByteOffset,
1273 &MergedDatum, ACPI_WRITE);
1274 if (ACPI_FAILURE (Status))
1276 return_ACPI_STATUS (Status);
1281 * Save the most recent datum since it may contain bits of the *next*
1282 * field datum. Update current byte offset.
1284 PreviousRawDatum = ThisRawDatum;
1287 return_ACPI_STATUS (Status);