xref: /haiku/src/add-ons/kernel/bus_managers/acpi/acpica/components/executer/exprep.c (revision a085e81e62d7a860f809b4fb7c7bf5654c396985)
1 /******************************************************************************
2  *
3  * Module Name: exprep - ACPI AML (p-code) execution - field prep utilities
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2012, Intel Corp.
12  * All rights reserved.
13  *
14  * 2. License
15  *
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
19  * property rights.
20  *
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
27  *
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;
36  *
37  * The above copyright and patent license is granted only if the following
38  * conditions are met:
39  *
40  * 3. Conditions
41  *
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.
53  *
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
64  * make.
65  *
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
70  * distribution.
71  *
72  * 3.4. Intel retains all right, title, and interest in and to the Original
73  * Intel Code.
74  *
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.
79  *
80  * 4. Disclaimer and Export Compliance
81  *
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
88  * PARTICULAR PURPOSE.
89  *
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
97  * LIMITED REMEDY.
98  *
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.
113  *
114  *****************************************************************************/
115 
116 #define __EXPREP_C__
117 
118 #include "acpi.h"
119 #include "accommon.h"
120 #include "acinterp.h"
121 #include "amlcode.h"
122 #include "acnamesp.h"
123 #include "acdispat.h"
124 
125 
126 #define _COMPONENT          ACPI_EXECUTER
127         ACPI_MODULE_NAME    ("exprep")
128 
129 /* Local prototypes */
130 
131 static UINT32
132 AcpiExDecodeFieldAccess (
133     ACPI_OPERAND_OBJECT     *ObjDesc,
134     UINT8                   FieldFlags,
135     UINT32                  *ReturnByteAlignment);
136 
137 
138 #ifdef ACPI_UNDER_DEVELOPMENT
139 
140 static UINT32
141 AcpiExGenerateAccess (
142     UINT32                  FieldBitOffset,
143     UINT32                  FieldBitLength,
144     UINT32                  RegionLength);
145 
146 /*******************************************************************************
147  *
148  * FUNCTION:    AcpiExGenerateAccess
149  *
150  * PARAMETERS:  FieldBitOffset      - Start of field within parent region/buffer
151  *              FieldBitLength      - Length of field in bits
152  *              RegionLength        - Length of parent in bytes
153  *
154  * RETURN:      Field granularity (8, 16, 32 or 64) and
155  *              ByteAlignment (1, 2, 3, or 4)
156  *
157  * DESCRIPTION: Generate an optimal access width for fields defined with the
158  *              AnyAcc keyword.
159  *
160  * NOTE: Need to have the RegionLength in order to check for boundary
161  *       conditions (end-of-region). However, the RegionLength is a deferred
162  *       operation. Therefore, to complete this implementation, the generation
163  *       of this access width must be deferred until the region length has
164  *       been evaluated.
165  *
166  ******************************************************************************/
167 
168 static UINT32
169 AcpiExGenerateAccess (
170     UINT32                  FieldBitOffset,
171     UINT32                  FieldBitLength,
172     UINT32                  RegionLength)
173 {
174     UINT32                  FieldByteLength;
175     UINT32                  FieldByteOffset;
176     UINT32                  FieldByteEndOffset;
177     UINT32                  AccessByteWidth;
178     UINT32                  FieldStartOffset;
179     UINT32                  FieldEndOffset;
180     UINT32                  MinimumAccessWidth = 0xFFFFFFFF;
181     UINT32                  MinimumAccesses = 0xFFFFFFFF;
182     UINT32                  Accesses;
183 
184 
185     ACPI_FUNCTION_TRACE (ExGenerateAccess);
186 
187 
188     /* Round Field start offset and length to "minimal" byte boundaries */
189 
190     FieldByteOffset    = ACPI_DIV_8 (ACPI_ROUND_DOWN (FieldBitOffset, 8));
191     FieldByteEndOffset = ACPI_DIV_8 (ACPI_ROUND_UP   (FieldBitLength +
192                                                       FieldBitOffset, 8));
193     FieldByteLength    = FieldByteEndOffset - FieldByteOffset;
194 
195     ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
196         "Bit length %u, Bit offset %u\n",
197         FieldBitLength, FieldBitOffset));
198 
199     ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
200         "Byte Length %u, Byte Offset %u, End Offset %u\n",
201         FieldByteLength, FieldByteOffset, FieldByteEndOffset));
202 
203     /*
204      * Iterative search for the maximum access width that is both aligned
205      * and does not go beyond the end of the region
206      *
207      * Start at ByteAcc and work upwards to QwordAcc max. (1,2,4,8 bytes)
208      */
209     for (AccessByteWidth = 1; AccessByteWidth <= 8; AccessByteWidth <<= 1)
210     {
211         /*
212          * 1) Round end offset up to next access boundary and make sure that
213          *    this does not go beyond the end of the parent region.
214          * 2) When the Access width is greater than the FieldByteLength, we
215          *    are done. (This does not optimize for the perfectly aligned
216          *    case yet).
217          */
218         if (ACPI_ROUND_UP (FieldByteEndOffset, AccessByteWidth) <= RegionLength)
219         {
220             FieldStartOffset =
221                 ACPI_ROUND_DOWN (FieldByteOffset, AccessByteWidth) /
222                 AccessByteWidth;
223 
224             FieldEndOffset =
225                 ACPI_ROUND_UP ((FieldByteLength + FieldByteOffset),
226                     AccessByteWidth) / AccessByteWidth;
227 
228             Accesses = FieldEndOffset - FieldStartOffset;
229 
230             ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
231                 "AccessWidth %u end is within region\n", AccessByteWidth));
232 
233             ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
234                 "Field Start %u, Field End %u -- requires %u accesses\n",
235                 FieldStartOffset, FieldEndOffset, Accesses));
236 
237             /* Single access is optimal */
238 
239             if (Accesses <= 1)
240             {
241                 ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
242                     "Entire field can be accessed with one operation of size %u\n",
243                     AccessByteWidth));
244                 return_VALUE (AccessByteWidth);
245             }
246 
247             /*
248              * Fits in the region, but requires more than one read/write.
249              * try the next wider access on next iteration
250              */
251             if (Accesses < MinimumAccesses)
252             {
253                 MinimumAccesses    = Accesses;
254                 MinimumAccessWidth = AccessByteWidth;
255             }
256         }
257         else
258         {
259             ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
260                 "AccessWidth %u end is NOT within region\n", AccessByteWidth));
261             if (AccessByteWidth == 1)
262             {
263                 ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
264                     "Field goes beyond end-of-region!\n"));
265 
266                 /* Field does not fit in the region at all */
267 
268                 return_VALUE (0);
269             }
270 
271             /*
272              * This width goes beyond the end-of-region, back off to
273              * previous access
274              */
275             ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
276                 "Backing off to previous optimal access width of %u\n",
277                 MinimumAccessWidth));
278             return_VALUE (MinimumAccessWidth);
279         }
280     }
281 
282     /*
283      * Could not read/write field with one operation,
284      * just use max access width
285      */
286     ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
287         "Cannot access field in one operation, using width 8\n"));
288     return_VALUE (8);
289 }
290 #endif /* ACPI_UNDER_DEVELOPMENT */
291 
292 
293 /*******************************************************************************
294  *
295  * FUNCTION:    AcpiExDecodeFieldAccess
296  *
297  * PARAMETERS:  ObjDesc             - Field object
298  *              FieldFlags          - Encoded fieldflags (contains access bits)
299  *              ReturnByteAlignment - Where the byte alignment is returned
300  *
301  * RETURN:      Field granularity (8, 16, 32 or 64) and
302  *              ByteAlignment (1, 2, 3, or 4)
303  *
304  * DESCRIPTION: Decode the AccessType bits of a field definition.
305  *
306  ******************************************************************************/
307 
308 static UINT32
309 AcpiExDecodeFieldAccess (
310     ACPI_OPERAND_OBJECT     *ObjDesc,
311     UINT8                   FieldFlags,
312     UINT32                  *ReturnByteAlignment)
313 {
314     UINT32                  Access;
315     UINT32                  ByteAlignment;
316     UINT32                  BitLength;
317 
318 
319     ACPI_FUNCTION_TRACE (ExDecodeFieldAccess);
320 
321 
322     Access = (FieldFlags & AML_FIELD_ACCESS_TYPE_MASK);
323 
324     switch (Access)
325     {
326     case AML_FIELD_ACCESS_ANY:
327 
328 #ifdef ACPI_UNDER_DEVELOPMENT
329         ByteAlignment =
330             AcpiExGenerateAccess (ObjDesc->CommonField.StartFieldBitOffset,
331                 ObjDesc->CommonField.BitLength,
332                 0xFFFFFFFF /* Temp until we pass RegionLength as parameter */);
333         BitLength = ByteAlignment * 8;
334 #endif
335 
336         ByteAlignment = 1;
337         BitLength = 8;
338         break;
339 
340     case AML_FIELD_ACCESS_BYTE:
341     case AML_FIELD_ACCESS_BUFFER:   /* ACPI 2.0 (SMBus Buffer) */
342         ByteAlignment = 1;
343         BitLength     = 8;
344         break;
345 
346     case AML_FIELD_ACCESS_WORD:
347         ByteAlignment = 2;
348         BitLength     = 16;
349         break;
350 
351     case AML_FIELD_ACCESS_DWORD:
352         ByteAlignment = 4;
353         BitLength     = 32;
354         break;
355 
356     case AML_FIELD_ACCESS_QWORD:    /* ACPI 2.0 */
357         ByteAlignment = 8;
358         BitLength     = 64;
359         break;
360 
361     default:
362         /* Invalid field access type */
363 
364         ACPI_ERROR ((AE_INFO,
365             "Unknown field access type 0x%X",
366             Access));
367         return_UINT32 (0);
368     }
369 
370     if (ObjDesc->Common.Type == ACPI_TYPE_BUFFER_FIELD)
371     {
372         /*
373          * BufferField access can be on any byte boundary, so the
374          * ByteAlignment is always 1 byte -- regardless of any ByteAlignment
375          * implied by the field access type.
376          */
377         ByteAlignment = 1;
378     }
379 
380     *ReturnByteAlignment = ByteAlignment;
381     return_UINT32 (BitLength);
382 }
383 
384 
385 /*******************************************************************************
386  *
387  * FUNCTION:    AcpiExPrepCommonFieldObject
388  *
389  * PARAMETERS:  ObjDesc             - The field object
390  *              FieldFlags          - Access, LockRule, and UpdateRule.
391  *                                    The format of a FieldFlag is described
392  *                                    in the ACPI specification
393  *              FieldAttribute      - Special attributes (not used)
394  *              FieldBitPosition    - Field start position
395  *              FieldBitLength      - Field length in number of bits
396  *
397  * RETURN:      Status
398  *
399  * DESCRIPTION: Initialize the areas of the field object that are common
400  *              to the various types of fields. Note: This is very "sensitive"
401  *              code because we are solving the general case for field
402  *              alignment.
403  *
404  ******************************************************************************/
405 
406 ACPI_STATUS
407 AcpiExPrepCommonFieldObject (
408     ACPI_OPERAND_OBJECT     *ObjDesc,
409     UINT8                   FieldFlags,
410     UINT8                   FieldAttribute,
411     UINT32                  FieldBitPosition,
412     UINT32                  FieldBitLength)
413 {
414     UINT32                  AccessBitWidth;
415     UINT32                  ByteAlignment;
416     UINT32                  NearestByteAddress;
417 
418 
419     ACPI_FUNCTION_TRACE (ExPrepCommonFieldObject);
420 
421 
422     /*
423      * Note: the structure being initialized is the
424      * ACPI_COMMON_FIELD_INFO;  No structure fields outside of the common
425      * area are initialized by this procedure.
426      */
427     ObjDesc->CommonField.FieldFlags = FieldFlags;
428     ObjDesc->CommonField.Attribute  = FieldAttribute;
429     ObjDesc->CommonField.BitLength  = FieldBitLength;
430 
431     /*
432      * Decode the access type so we can compute offsets. The access type gives
433      * two pieces of information - the width of each field access and the
434      * necessary ByteAlignment (address granularity) of the access.
435      *
436      * For AnyAcc, the AccessBitWidth is the largest width that is both
437      * necessary and possible in an attempt to access the whole field in one
438      * I/O operation. However, for AnyAcc, the ByteAlignment is always one
439      * byte.
440      *
441      * For all Buffer Fields, the ByteAlignment is always one byte.
442      *
443      * For all other access types (Byte, Word, Dword, Qword), the Bitwidth is
444      * the same (equivalent) as the ByteAlignment.
445      */
446     AccessBitWidth = AcpiExDecodeFieldAccess (ObjDesc, FieldFlags,
447                         &ByteAlignment);
448     if (!AccessBitWidth)
449     {
450         return_ACPI_STATUS (AE_AML_OPERAND_VALUE);
451     }
452 
453     /* Setup width (access granularity) fields (values are: 1, 2, 4, 8) */
454 
455     ObjDesc->CommonField.AccessByteWidth = (UINT8)
456         ACPI_DIV_8 (AccessBitWidth);
457 
458     /*
459      * BaseByteOffset is the address of the start of the field within the
460      * region. It is the byte address of the first *datum* (field-width data
461      * unit) of the field. (i.e., the first datum that contains at least the
462      * first *bit* of the field.)
463      *
464      * Note: ByteAlignment is always either equal to the AccessBitWidth or 8
465      * (Byte access), and it defines the addressing granularity of the parent
466      * region or buffer.
467      */
468     NearestByteAddress =
469         ACPI_ROUND_BITS_DOWN_TO_BYTES (FieldBitPosition);
470     ObjDesc->CommonField.BaseByteOffset = (UINT32)
471         ACPI_ROUND_DOWN (NearestByteAddress, ByteAlignment);
472 
473     /*
474      * StartFieldBitOffset is the offset of the first bit of the field within
475      * a field datum.
476      */
477     ObjDesc->CommonField.StartFieldBitOffset = (UINT8)
478         (FieldBitPosition - ACPI_MUL_8 (ObjDesc->CommonField.BaseByteOffset));
479 
480     return_ACPI_STATUS (AE_OK);
481 }
482 
483 
484 /*******************************************************************************
485  *
486  * FUNCTION:    AcpiExPrepFieldValue
487  *
488  * PARAMETERS:  Info    - Contains all field creation info
489  *
490  * RETURN:      Status
491  *
492  * DESCRIPTION: Construct an object of type ACPI_OPERAND_OBJECT with a
493  *              subtype of DefField and connect it to the parent Node.
494  *
495  ******************************************************************************/
496 
497 ACPI_STATUS
498 AcpiExPrepFieldValue (
499     ACPI_CREATE_FIELD_INFO  *Info)
500 {
501     ACPI_OPERAND_OBJECT     *ObjDesc;
502     ACPI_OPERAND_OBJECT     *SecondDesc = NULL;
503     ACPI_STATUS             Status;
504     UINT32                  AccessByteWidth;
505     UINT32                  Type;
506 
507 
508     ACPI_FUNCTION_TRACE (ExPrepFieldValue);
509 
510 
511     /* Parameter validation */
512 
513     if (Info->FieldType != ACPI_TYPE_LOCAL_INDEX_FIELD)
514     {
515         if (!Info->RegionNode)
516         {
517             ACPI_ERROR ((AE_INFO, "Null RegionNode"));
518             return_ACPI_STATUS (AE_AML_NO_OPERAND);
519         }
520 
521         Type = AcpiNsGetType (Info->RegionNode);
522         if (Type != ACPI_TYPE_REGION)
523         {
524             ACPI_ERROR ((AE_INFO, "Needed Region, found type 0x%X (%s)",
525                 Type, AcpiUtGetTypeName (Type)));
526 
527             return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
528         }
529     }
530 
531     /* Allocate a new field object */
532 
533     ObjDesc = AcpiUtCreateInternalObject (Info->FieldType);
534     if (!ObjDesc)
535     {
536         return_ACPI_STATUS (AE_NO_MEMORY);
537     }
538 
539     /* Initialize areas of the object that are common to all fields */
540 
541     ObjDesc->CommonField.Node = Info->FieldNode;
542     Status = AcpiExPrepCommonFieldObject (ObjDesc,
543                 Info->FieldFlags, Info->Attribute,
544                 Info->FieldBitPosition, Info->FieldBitLength);
545     if (ACPI_FAILURE (Status))
546     {
547         AcpiUtDeleteObjectDesc (ObjDesc);
548         return_ACPI_STATUS (Status);
549     }
550 
551     /* Initialize areas of the object that are specific to the field type */
552 
553     switch (Info->FieldType)
554     {
555     case ACPI_TYPE_LOCAL_REGION_FIELD:
556 
557         ObjDesc->Field.RegionObj = AcpiNsGetAttachedObject (Info->RegionNode);
558 
559         /* Fields specific to GenericSerialBus fields */
560 
561         ObjDesc->Field.AccessLength = Info->AccessLength;
562 
563         if (Info->ConnectionNode)
564         {
565             SecondDesc = Info->ConnectionNode->Object;
566             if (!(SecondDesc->Common.Flags & AOPOBJ_DATA_VALID))
567             {
568                 Status = AcpiDsGetBufferArguments (SecondDesc);
569                 if (ACPI_FAILURE (Status))
570                 {
571                     AcpiUtDeleteObjectDesc (ObjDesc);
572                     return_ACPI_STATUS (Status);
573                 }
574             }
575 
576             ObjDesc->Field.ResourceBuffer = SecondDesc->Buffer.Pointer;
577             ObjDesc->Field.ResourceLength = (UINT16) SecondDesc->Buffer.Length;
578         }
579         else if (Info->ResourceBuffer)
580         {
581             ObjDesc->Field.ResourceBuffer = Info->ResourceBuffer;
582             ObjDesc->Field.ResourceLength = Info->ResourceLength;
583         }
584 
585         /* Allow full data read from EC address space */
586 
587         if ((ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_EC) &&
588             (ObjDesc->CommonField.BitLength > 8))
589         {
590             AccessByteWidth = ACPI_ROUND_BITS_UP_TO_BYTES (
591                 ObjDesc->CommonField.BitLength);
592 
593             /* Maximum byte width supported is 255 */
594 
595             if (AccessByteWidth < 256)
596             {
597                 ObjDesc->CommonField.AccessByteWidth = (UINT8) AccessByteWidth;
598             }
599         }
600 
601         /* An additional reference for the container */
602 
603         AcpiUtAddReference (ObjDesc->Field.RegionObj);
604 
605         ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
606             "RegionField: BitOff %X, Off %X, Gran %X, Region %p\n",
607             ObjDesc->Field.StartFieldBitOffset, ObjDesc->Field.BaseByteOffset,
608             ObjDesc->Field.AccessByteWidth, ObjDesc->Field.RegionObj));
609         break;
610 
611 
612     case ACPI_TYPE_LOCAL_BANK_FIELD:
613 
614         ObjDesc->BankField.Value = Info->BankValue;
615         ObjDesc->BankField.RegionObj =
616             AcpiNsGetAttachedObject (Info->RegionNode);
617         ObjDesc->BankField.BankObj =
618             AcpiNsGetAttachedObject (Info->RegisterNode);
619 
620         /* An additional reference for the attached objects */
621 
622         AcpiUtAddReference (ObjDesc->BankField.RegionObj);
623         AcpiUtAddReference (ObjDesc->BankField.BankObj);
624 
625         ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
626             "Bank Field: BitOff %X, Off %X, Gran %X, Region %p, BankReg %p\n",
627             ObjDesc->BankField.StartFieldBitOffset,
628             ObjDesc->BankField.BaseByteOffset,
629             ObjDesc->Field.AccessByteWidth,
630             ObjDesc->BankField.RegionObj,
631             ObjDesc->BankField.BankObj));
632 
633         /*
634          * Remember location in AML stream of the field unit
635          * opcode and operands -- since the BankValue
636          * operands must be evaluated.
637          */
638         SecondDesc = ObjDesc->Common.NextObject;
639         SecondDesc->Extra.AmlStart = ACPI_CAST_PTR (ACPI_PARSE_OBJECT,
640             Info->DataRegisterNode)->Named.Data;
641         SecondDesc->Extra.AmlLength = ACPI_CAST_PTR (ACPI_PARSE_OBJECT,
642             Info->DataRegisterNode)->Named.Length;
643 
644         break;
645 
646 
647     case ACPI_TYPE_LOCAL_INDEX_FIELD:
648 
649         /* Get the Index and Data registers */
650 
651         ObjDesc->IndexField.IndexObj =
652             AcpiNsGetAttachedObject (Info->RegisterNode);
653         ObjDesc->IndexField.DataObj =
654             AcpiNsGetAttachedObject (Info->DataRegisterNode);
655 
656         if (!ObjDesc->IndexField.DataObj || !ObjDesc->IndexField.IndexObj)
657         {
658             ACPI_ERROR ((AE_INFO, "Null Index Object during field prep"));
659             AcpiUtDeleteObjectDesc (ObjDesc);
660             return_ACPI_STATUS (AE_AML_INTERNAL);
661         }
662 
663         /* An additional reference for the attached objects */
664 
665         AcpiUtAddReference (ObjDesc->IndexField.DataObj);
666         AcpiUtAddReference (ObjDesc->IndexField.IndexObj);
667 
668         /*
669          * April 2006: Changed to match MS behavior
670          *
671          * The value written to the Index register is the byte offset of the
672          * target field in units of the granularity of the IndexField
673          *
674          * Previously, the value was calculated as an index in terms of the
675          * width of the Data register, as below:
676          *
677          *      ObjDesc->IndexField.Value = (UINT32)
678          *          (Info->FieldBitPosition / ACPI_MUL_8 (
679          *              ObjDesc->Field.AccessByteWidth));
680          *
681          * February 2006: Tried value as a byte offset:
682          *      ObjDesc->IndexField.Value = (UINT32)
683          *          ACPI_DIV_8 (Info->FieldBitPosition);
684          */
685         ObjDesc->IndexField.Value = (UINT32) ACPI_ROUND_DOWN (
686             ACPI_DIV_8 (Info->FieldBitPosition),
687             ObjDesc->IndexField.AccessByteWidth);
688 
689         ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
690             "IndexField: BitOff %X, Off %X, Value %X, Gran %X, Index %p, Data %p\n",
691             ObjDesc->IndexField.StartFieldBitOffset,
692             ObjDesc->IndexField.BaseByteOffset,
693             ObjDesc->IndexField.Value,
694             ObjDesc->Field.AccessByteWidth,
695             ObjDesc->IndexField.IndexObj,
696             ObjDesc->IndexField.DataObj));
697         break;
698 
699     default:
700         /* No other types should get here */
701         break;
702     }
703 
704     /*
705      * Store the constructed descriptor (ObjDesc) into the parent Node,
706      * preserving the current type of that NamedObj.
707      */
708     Status = AcpiNsAttachObject (Info->FieldNode, ObjDesc,
709                 AcpiNsGetType (Info->FieldNode));
710 
711     ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD, "Set NamedObj %p [%4.4s], ObjDesc %p\n",
712         Info->FieldNode, AcpiUtGetNodeName (Info->FieldNode), ObjDesc));
713 
714     /* Remove local reference to the object */
715 
716     AcpiUtRemoveReference (ObjDesc);
717     return_ACPI_STATUS (Status);
718 }
719