1 /******************************************************************************
3 * Module Name: dsfield - Dispatcher field routines
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2005, 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 *****************************************************************************/
117 #define __DSFIELD_C__
119 #include <contrib/dev/acpica/acpi.h>
120 #include <contrib/dev/acpica/amlcode.h>
121 #include <contrib/dev/acpica/acdispat.h>
122 #include <contrib/dev/acpica/acinterp.h>
123 #include <contrib/dev/acpica/acnamesp.h>
124 #include <contrib/dev/acpica/acparser.h>
127 #define _COMPONENT ACPI_DISPATCHER
128 ACPI_MODULE_NAME ("dsfield")
130 /* Local prototypes */
133 AcpiDsGetFieldNames (
134 ACPI_CREATE_FIELD_INFO *Info,
135 ACPI_WALK_STATE *WalkState,
136 ACPI_PARSE_OBJECT *Arg);
139 /*******************************************************************************
141 * FUNCTION: AcpiDsCreateBufferField
143 * PARAMETERS: Op - Current parse op (CreateXXField)
144 * WalkState - Current state
148 * DESCRIPTION: Execute the CreateField operators:
152 * CreateDWordFieldOp,
153 * CreateQWordFieldOp,
154 * CreateFieldOp (all of which define a field in a buffer)
156 ******************************************************************************/
159 AcpiDsCreateBufferField (
160 ACPI_PARSE_OBJECT *Op,
161 ACPI_WALK_STATE *WalkState)
163 ACPI_PARSE_OBJECT *Arg;
164 ACPI_NAMESPACE_NODE *Node;
166 ACPI_OPERAND_OBJECT *ObjDesc;
167 ACPI_OPERAND_OBJECT *SecondDesc = NULL;
171 ACPI_FUNCTION_TRACE ("DsCreateBufferField");
174 /* Get the NameString argument */
176 if (Op->Common.AmlOpcode == AML_CREATE_FIELD_OP)
178 Arg = AcpiPsGetArg (Op, 3);
182 /* Create Bit/Byte/Word/Dword field */
184 Arg = AcpiPsGetArg (Op, 2);
189 return_ACPI_STATUS (AE_AML_NO_OPERAND);
192 if (WalkState->DeferredNode)
194 Node = WalkState->DeferredNode;
200 * During the load phase, we want to enter the name of the field into
201 * the namespace. During the execute phase (when we evaluate the size
202 * operand), we want to lookup the name
204 if (WalkState->ParseFlags & ACPI_PARSE_EXECUTE)
206 Flags = ACPI_NS_NO_UPSEARCH | ACPI_NS_DONT_OPEN_SCOPE;
210 Flags = ACPI_NS_NO_UPSEARCH | ACPI_NS_DONT_OPEN_SCOPE |
211 ACPI_NS_ERROR_IF_FOUND;
215 * Enter the NameString into the namespace
217 Status = AcpiNsLookup (WalkState->ScopeInfo, Arg->Common.Value.String,
218 ACPI_TYPE_ANY, ACPI_IMODE_LOAD_PASS1,
219 Flags, WalkState, &(Node));
220 if (ACPI_FAILURE (Status))
222 ACPI_REPORT_NSERROR (Arg->Common.Value.String, Status);
223 return_ACPI_STATUS (Status);
227 /* We could put the returned object (Node) on the object stack for later,
228 * but for now, we will put it in the "op" object that the parser uses,
229 * so we can get it again at the end of this scope
231 Op->Common.Node = Node;
234 * If there is no object attached to the node, this node was just created
235 * and we need to create the field object. Otherwise, this was a lookup
236 * of an existing node and we don't want to create the field object again.
238 ObjDesc = AcpiNsGetAttachedObject (Node);
241 return_ACPI_STATUS (AE_OK);
245 * The Field definition is not fully parsed at this time.
246 * (We must save the address of the AML for the buffer and index operands)
249 /* Create the buffer field object */
251 ObjDesc = AcpiUtCreateInternalObject (ACPI_TYPE_BUFFER_FIELD);
254 Status = AE_NO_MEMORY;
259 * Remember location in AML stream of the field unit
260 * opcode and operands -- since the buffer and index
261 * operands must be evaluated.
263 SecondDesc = ObjDesc->Common.NextObject;
264 SecondDesc->Extra.AmlStart = Op->Named.Data;
265 SecondDesc->Extra.AmlLength = Op->Named.Length;
266 ObjDesc->BufferField.Node = Node;
268 /* Attach constructed field descriptors to parent node */
270 Status = AcpiNsAttachObject (Node, ObjDesc, ACPI_TYPE_BUFFER_FIELD);
271 if (ACPI_FAILURE (Status))
279 /* Remove local reference to the object */
281 AcpiUtRemoveReference (ObjDesc);
282 return_ACPI_STATUS (Status);
286 /*******************************************************************************
288 * FUNCTION: AcpiDsGetFieldNames
290 * PARAMETERS: Info - CreateField info structure
291 * ` WalkState - Current method state
292 * Arg - First parser arg for the field name list
296 * DESCRIPTION: Process all named fields in a field declaration. Names are
297 * entered into the namespace.
299 ******************************************************************************/
302 AcpiDsGetFieldNames (
303 ACPI_CREATE_FIELD_INFO *Info,
304 ACPI_WALK_STATE *WalkState,
305 ACPI_PARSE_OBJECT *Arg)
308 ACPI_INTEGER Position;
311 ACPI_FUNCTION_TRACE_PTR ("DsGetFieldNames", Info);
314 /* First field starts at bit zero */
316 Info->FieldBitPosition = 0;
318 /* Process all elements in the field list (of parse nodes) */
323 * Three types of field elements are handled:
324 * 1) Offset - specifies a bit offset
325 * 2) AccessAs - changes the access mode
326 * 3) Name - Enters a new named field into the namespace
328 switch (Arg->Common.AmlOpcode)
330 case AML_INT_RESERVEDFIELD_OP:
332 Position = (ACPI_INTEGER) Info->FieldBitPosition
333 + (ACPI_INTEGER) Arg->Common.Value.Size;
335 if (Position > ACPI_UINT32_MAX)
338 "Bit offset within field too large (> 0xFFFFFFFF)\n"));
339 return_ACPI_STATUS (AE_SUPPORT);
342 Info->FieldBitPosition = (UINT32) Position;
346 case AML_INT_ACCESSFIELD_OP:
349 * Get a new AccessType and AccessAttribute -- to be used for all
350 * field units that follow, until field end or another AccessAs
353 * In FieldFlags, preserve the flag bits other than the
356 Info->FieldFlags = (UINT8)
357 ((Info->FieldFlags & ~(AML_FIELD_ACCESS_TYPE_MASK)) |
358 ((UINT8) ((UINT32) Arg->Common.Value.Integer >> 8)));
360 Info->Attribute = (UINT8) (Arg->Common.Value.Integer);
364 case AML_INT_NAMEDFIELD_OP:
366 /* Lookup the name */
368 Status = AcpiNsLookup (WalkState->ScopeInfo,
369 (char *) &Arg->Named.Name,
370 Info->FieldType, ACPI_IMODE_EXECUTE,
371 ACPI_NS_DONT_OPEN_SCOPE,
372 WalkState, &Info->FieldNode);
373 if (ACPI_FAILURE (Status))
375 ACPI_REPORT_NSERROR ((char *) &Arg->Named.Name, Status);
376 if (Status != AE_ALREADY_EXISTS)
378 return_ACPI_STATUS (Status);
381 /* Already exists, ignore error */
385 Arg->Common.Node = Info->FieldNode;
386 Info->FieldBitLength = Arg->Common.Value.Size;
388 /* Create and initialize an object for the new Field Node */
390 Status = AcpiExPrepFieldValue (Info);
391 if (ACPI_FAILURE (Status))
393 return_ACPI_STATUS (Status);
397 /* Keep track of bit position for the next field */
399 Position = (ACPI_INTEGER) Info->FieldBitPosition
400 + (ACPI_INTEGER) Arg->Common.Value.Size;
402 if (Position > ACPI_UINT32_MAX)
405 "Field [%4.4s] bit offset too large (> 0xFFFFFFFF)\n",
406 (char *) &Info->FieldNode->Name));
407 return_ACPI_STATUS (AE_SUPPORT);
410 Info->FieldBitPosition += Info->FieldBitLength;
416 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
417 "Invalid opcode in field list: %X\n",
418 Arg->Common.AmlOpcode));
419 return_ACPI_STATUS (AE_AML_BAD_OPCODE);
422 Arg = Arg->Common.Next;
425 return_ACPI_STATUS (AE_OK);
429 /*******************************************************************************
431 * FUNCTION: AcpiDsCreateField
433 * PARAMETERS: Op - Op containing the Field definition and args
434 * RegionNode - Object for the containing Operation Region
435 * ` WalkState - Current method state
439 * DESCRIPTION: Create a new field in the specified operation region
441 ******************************************************************************/
445 ACPI_PARSE_OBJECT *Op,
446 ACPI_NAMESPACE_NODE *RegionNode,
447 ACPI_WALK_STATE *WalkState)
450 ACPI_PARSE_OBJECT *Arg;
451 ACPI_CREATE_FIELD_INFO Info;
454 ACPI_FUNCTION_TRACE_PTR ("DsCreateField", Op);
457 /* First arg is the name of the parent OpRegion (must already exist) */
459 Arg = Op->Common.Value.Arg;
462 Status = AcpiNsLookup (WalkState->ScopeInfo, Arg->Common.Value.Name,
463 ACPI_TYPE_REGION, ACPI_IMODE_EXECUTE,
464 ACPI_NS_SEARCH_PARENT, WalkState, &RegionNode);
465 if (ACPI_FAILURE (Status))
467 ACPI_REPORT_NSERROR (Arg->Common.Value.Name, Status);
468 return_ACPI_STATUS (Status);
472 /* Second arg is the field flags */
474 Arg = Arg->Common.Next;
475 Info.FieldFlags = (UINT8) Arg->Common.Value.Integer;
478 /* Each remaining arg is a Named Field */
480 Info.FieldType = ACPI_TYPE_LOCAL_REGION_FIELD;
481 Info.RegionNode = RegionNode;
483 Status = AcpiDsGetFieldNames (&Info, WalkState, Arg->Common.Next);
485 return_ACPI_STATUS (Status);
489 /*******************************************************************************
491 * FUNCTION: AcpiDsInitFieldObjects
493 * PARAMETERS: Op - Op containing the Field definition and args
494 * ` WalkState - Current method state
498 * DESCRIPTION: For each "Field Unit" name in the argument list that is
499 * part of the field declaration, enter the name into the
502 ******************************************************************************/
505 AcpiDsInitFieldObjects (
506 ACPI_PARSE_OBJECT *Op,
507 ACPI_WALK_STATE *WalkState)
510 ACPI_PARSE_OBJECT *Arg = NULL;
511 ACPI_NAMESPACE_NODE *Node;
515 ACPI_FUNCTION_TRACE_PTR ("DsInitFieldObjects", Op);
518 switch (WalkState->Opcode)
521 Arg = AcpiPsGetArg (Op, 2);
522 Type = ACPI_TYPE_LOCAL_REGION_FIELD;
525 case AML_BANK_FIELD_OP:
526 Arg = AcpiPsGetArg (Op, 4);
527 Type = ACPI_TYPE_LOCAL_BANK_FIELD;
530 case AML_INDEX_FIELD_OP:
531 Arg = AcpiPsGetArg (Op, 3);
532 Type = ACPI_TYPE_LOCAL_INDEX_FIELD;
536 return_ACPI_STATUS (AE_BAD_PARAMETER);
540 * Walk the list of entries in the FieldList
544 /* Ignore OFFSET and ACCESSAS terms here */
546 if (Arg->Common.AmlOpcode == AML_INT_NAMEDFIELD_OP)
548 Status = AcpiNsLookup (WalkState->ScopeInfo,
549 (char *) &Arg->Named.Name,
550 Type, ACPI_IMODE_LOAD_PASS1,
551 ACPI_NS_NO_UPSEARCH | ACPI_NS_DONT_OPEN_SCOPE |
552 ACPI_NS_ERROR_IF_FOUND,
554 if (ACPI_FAILURE (Status))
556 ACPI_REPORT_NSERROR ((char *) &Arg->Named.Name, Status);
557 if (Status != AE_ALREADY_EXISTS)
559 return_ACPI_STATUS (Status);
562 /* Name already exists, just ignore this error */
567 Arg->Common.Node = Node;
570 /* Move to next field in the list */
572 Arg = Arg->Common.Next;
575 return_ACPI_STATUS (AE_OK);
579 /*******************************************************************************
581 * FUNCTION: AcpiDsCreateBankField
583 * PARAMETERS: Op - Op containing the Field definition and args
584 * RegionNode - Object for the containing Operation Region
585 * ` WalkState - Current method state
589 * DESCRIPTION: Create a new bank field in the specified operation region
591 ******************************************************************************/
594 AcpiDsCreateBankField (
595 ACPI_PARSE_OBJECT *Op,
596 ACPI_NAMESPACE_NODE *RegionNode,
597 ACPI_WALK_STATE *WalkState)
600 ACPI_PARSE_OBJECT *Arg;
601 ACPI_CREATE_FIELD_INFO Info;
604 ACPI_FUNCTION_TRACE_PTR ("DsCreateBankField", Op);
607 /* First arg is the name of the parent OpRegion (must already exist) */
609 Arg = Op->Common.Value.Arg;
612 Status = AcpiNsLookup (WalkState->ScopeInfo, Arg->Common.Value.Name,
613 ACPI_TYPE_REGION, ACPI_IMODE_EXECUTE,
614 ACPI_NS_SEARCH_PARENT, WalkState, &RegionNode);
615 if (ACPI_FAILURE (Status))
617 ACPI_REPORT_NSERROR (Arg->Common.Value.Name, Status);
618 return_ACPI_STATUS (Status);
622 /* Second arg is the Bank Register (Field) (must already exist) */
624 Arg = Arg->Common.Next;
625 Status = AcpiNsLookup (WalkState->ScopeInfo, Arg->Common.Value.String,
626 ACPI_TYPE_ANY, ACPI_IMODE_EXECUTE,
627 ACPI_NS_SEARCH_PARENT, WalkState, &Info.RegisterNode);
628 if (ACPI_FAILURE (Status))
630 ACPI_REPORT_NSERROR (Arg->Common.Value.String, Status);
631 return_ACPI_STATUS (Status);
634 /* Third arg is the BankValue */
636 Arg = Arg->Common.Next;
637 Info.BankValue = (UINT32) Arg->Common.Value.Integer;
639 /* Fourth arg is the field flags */
641 Arg = Arg->Common.Next;
642 Info.FieldFlags = (UINT8) Arg->Common.Value.Integer;
644 /* Each remaining arg is a Named Field */
646 Info.FieldType = ACPI_TYPE_LOCAL_BANK_FIELD;
647 Info.RegionNode = RegionNode;
649 Status = AcpiDsGetFieldNames (&Info, WalkState, Arg->Common.Next);
651 return_ACPI_STATUS (Status);
655 /*******************************************************************************
657 * FUNCTION: AcpiDsCreateIndexField
659 * PARAMETERS: Op - Op containing the Field definition and args
660 * RegionNode - Object for the containing Operation Region
661 * ` WalkState - Current method state
665 * DESCRIPTION: Create a new index field in the specified operation region
667 ******************************************************************************/
670 AcpiDsCreateIndexField (
671 ACPI_PARSE_OBJECT *Op,
672 ACPI_NAMESPACE_NODE *RegionNode,
673 ACPI_WALK_STATE *WalkState)
676 ACPI_PARSE_OBJECT *Arg;
677 ACPI_CREATE_FIELD_INFO Info;
680 ACPI_FUNCTION_TRACE_PTR ("DsCreateIndexField", Op);
683 /* First arg is the name of the Index register (must already exist) */
685 Arg = Op->Common.Value.Arg;
686 Status = AcpiNsLookup (WalkState->ScopeInfo, Arg->Common.Value.String,
687 ACPI_TYPE_ANY, ACPI_IMODE_EXECUTE,
688 ACPI_NS_SEARCH_PARENT, WalkState, &Info.RegisterNode);
689 if (ACPI_FAILURE (Status))
691 ACPI_REPORT_NSERROR (Arg->Common.Value.String, Status);
692 return_ACPI_STATUS (Status);
695 /* Second arg is the data register (must already exist) */
697 Arg = Arg->Common.Next;
698 Status = AcpiNsLookup (WalkState->ScopeInfo, Arg->Common.Value.String,
699 ACPI_TYPE_ANY, ACPI_IMODE_EXECUTE,
700 ACPI_NS_SEARCH_PARENT, WalkState, &Info.DataRegisterNode);
701 if (ACPI_FAILURE (Status))
703 ACPI_REPORT_NSERROR (Arg->Common.Value.String, Status);
704 return_ACPI_STATUS (Status);
707 /* Next arg is the field flags */
709 Arg = Arg->Common.Next;
710 Info.FieldFlags = (UINT8) Arg->Common.Value.Integer;
712 /* Each remaining arg is a Named Field */
714 Info.FieldType = ACPI_TYPE_LOCAL_INDEX_FIELD;
715 Info.RegionNode = RegionNode;
717 Status = AcpiDsGetFieldNames (&Info, WalkState, Arg->Common.Next);
719 return_ACPI_STATUS (Status);