1 /******************************************************************************
3 * Module Name: dsfield - Dispatcher field routines
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 *****************************************************************************/
117 #define __DSFIELD_C__
121 #include "acdispat.h"
122 #include "acinterp.h"
123 #include "acnamesp.h"
124 #include "acparser.h"
127 #define _COMPONENT ACPI_DISPATCHER
128 ACPI_MODULE_NAME ("dsfield")
131 /*******************************************************************************
133 * FUNCTION: AcpiDsCreateBufferField
135 * PARAMETERS: Opcode - The opcode to be executed
136 * Operands - List of operands for the opcode
137 * WalkState - Current state
141 * DESCRIPTION: Execute the CreateField operators:
145 * CreateDWordFieldOp,
146 * CreateQWordFieldOp,
147 * CreateFieldOp (all of which define fields in buffers)
149 ******************************************************************************/
152 AcpiDsCreateBufferField (
153 ACPI_PARSE_OBJECT *Op,
154 ACPI_WALK_STATE *WalkState)
156 ACPI_PARSE_OBJECT *Arg;
157 ACPI_NAMESPACE_NODE *Node;
159 ACPI_OPERAND_OBJECT *ObjDesc;
160 ACPI_OPERAND_OBJECT *SecondDesc = NULL;
164 ACPI_FUNCTION_TRACE ("DsCreateBufferField");
167 /* Get the NameString argument */
169 if (Op->Common.AmlOpcode == AML_CREATE_FIELD_OP)
171 Arg = AcpiPsGetArg (Op, 3);
175 /* Create Bit/Byte/Word/Dword field */
177 Arg = AcpiPsGetArg (Op, 2);
182 return_ACPI_STATUS (AE_AML_NO_OPERAND);
185 if (WalkState->DeferredNode)
187 Node = WalkState->DeferredNode;
193 * During the load phase, we want to enter the name of the field into
194 * the namespace. During the execute phase (when we evaluate the size
195 * operand), we want to lookup the name
197 if (WalkState->ParseFlags & ACPI_PARSE_EXECUTE)
199 Flags = ACPI_NS_NO_UPSEARCH | ACPI_NS_DONT_OPEN_SCOPE;
203 Flags = ACPI_NS_NO_UPSEARCH | ACPI_NS_DONT_OPEN_SCOPE | ACPI_NS_ERROR_IF_FOUND;
207 * Enter the NameString into the namespace
209 Status = AcpiNsLookup (WalkState->ScopeInfo, Arg->Common.Value.String,
210 ACPI_TYPE_ANY, ACPI_IMODE_LOAD_PASS1,
211 Flags, WalkState, &(Node));
212 if (ACPI_FAILURE (Status))
214 ACPI_REPORT_NSERROR (Arg->Common.Value.String, Status);
215 return_ACPI_STATUS (Status);
219 /* We could put the returned object (Node) on the object stack for later, but
220 * for now, we will put it in the "op" object that the parser uses, so we
221 * can get it again at the end of this scope
223 Op->Common.Node = Node;
226 * If there is no object attached to the node, this node was just created and
227 * we need to create the field object. Otherwise, this was a lookup of an
228 * existing node and we don't want to create the field object again.
230 ObjDesc = AcpiNsGetAttachedObject (Node);
233 return_ACPI_STATUS (AE_OK);
237 * The Field definition is not fully parsed at this time.
238 * (We must save the address of the AML for the buffer and index operands)
241 /* Create the buffer field object */
243 ObjDesc = AcpiUtCreateInternalObject (ACPI_TYPE_BUFFER_FIELD);
246 Status = AE_NO_MEMORY;
251 * Remember location in AML stream of the field unit
252 * opcode and operands -- since the buffer and index
253 * operands must be evaluated.
255 SecondDesc = ObjDesc->Common.NextObject;
256 SecondDesc->Extra.AmlStart = Op->Named.Data;
257 SecondDesc->Extra.AmlLength = Op->Named.Length;
258 ObjDesc->BufferField.Node = Node;
260 /* Attach constructed field descriptors to parent node */
262 Status = AcpiNsAttachObject (Node, ObjDesc, ACPI_TYPE_BUFFER_FIELD);
263 if (ACPI_FAILURE (Status))
271 /* Remove local reference to the object */
273 AcpiUtRemoveReference (ObjDesc);
274 return_ACPI_STATUS (Status);
278 /*******************************************************************************
280 * FUNCTION: AcpiDsGetFieldNames
282 * PARAMETERS: Info - CreateField info structure
283 * ` WalkState - Current method state
284 * Arg - First parser arg for the field name list
288 * DESCRIPTION: Process all named fields in a field declaration. Names are
289 * entered into the namespace.
291 ******************************************************************************/
294 AcpiDsGetFieldNames (
295 ACPI_CREATE_FIELD_INFO *Info,
296 ACPI_WALK_STATE *WalkState,
297 ACPI_PARSE_OBJECT *Arg)
300 ACPI_INTEGER Position;
303 ACPI_FUNCTION_TRACE_PTR ("DsGetFieldNames", Info);
306 /* First field starts at bit zero */
308 Info->FieldBitPosition = 0;
310 /* Process all elements in the field list (of parse nodes) */
315 * Three types of field elements are handled:
316 * 1) Offset - specifies a bit offset
317 * 2) AccessAs - changes the access mode
318 * 3) Name - Enters a new named field into the namespace
320 switch (Arg->Common.AmlOpcode)
322 case AML_INT_RESERVEDFIELD_OP:
324 Position = (ACPI_INTEGER) Info->FieldBitPosition
325 + (ACPI_INTEGER) Arg->Common.Value.Size;
327 if (Position > ACPI_UINT32_MAX)
329 ACPI_REPORT_ERROR (("Bit offset within field too large (> 0xFFFFFFFF)\n"));
330 return_ACPI_STATUS (AE_SUPPORT);
333 Info->FieldBitPosition = (UINT32) Position;
337 case AML_INT_ACCESSFIELD_OP:
340 * Get a new AccessType and AccessAttribute -- to be used for all
341 * field units that follow, until field end or another AccessAs keyword.
343 * In FieldFlags, preserve the flag bits other than the ACCESS_TYPE bits
345 Info->FieldFlags = (UINT8) ((Info->FieldFlags & ~(AML_FIELD_ACCESS_TYPE_MASK)) |
346 ((UINT8) ((UINT32) Arg->Common.Value.Integer >> 8)));
348 Info->Attribute = (UINT8) (Arg->Common.Value.Integer);
352 case AML_INT_NAMEDFIELD_OP:
354 /* Lookup the name */
356 Status = AcpiNsLookup (WalkState->ScopeInfo,
357 (char *) &Arg->Named.Name,
358 Info->FieldType, ACPI_IMODE_EXECUTE, ACPI_NS_DONT_OPEN_SCOPE,
359 WalkState, &Info->FieldNode);
360 if (ACPI_FAILURE (Status))
362 ACPI_REPORT_NSERROR ((char *) &Arg->Named.Name, Status);
363 if (Status != AE_ALREADY_EXISTS)
365 return_ACPI_STATUS (Status);
368 /* Already exists, ignore error */
372 Arg->Common.Node = Info->FieldNode;
373 Info->FieldBitLength = Arg->Common.Value.Size;
375 /* Create and initialize an object for the new Field Node */
377 Status = AcpiExPrepFieldValue (Info);
378 if (ACPI_FAILURE (Status))
380 return_ACPI_STATUS (Status);
384 /* Keep track of bit position for the next field */
386 Position = (ACPI_INTEGER) Info->FieldBitPosition
387 + (ACPI_INTEGER) Arg->Common.Value.Size;
389 if (Position > ACPI_UINT32_MAX)
391 ACPI_REPORT_ERROR (("Field [%4.4s] bit offset too large (> 0xFFFFFFFF)\n",
392 (char *) &Info->FieldNode->Name));
393 return_ACPI_STATUS (AE_SUPPORT);
396 Info->FieldBitPosition += Info->FieldBitLength;
402 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Invalid opcode in field list: %X\n",
403 Arg->Common.AmlOpcode));
404 return_ACPI_STATUS (AE_AML_BAD_OPCODE);
407 Arg = Arg->Common.Next;
410 return_ACPI_STATUS (AE_OK);
414 /*******************************************************************************
416 * FUNCTION: AcpiDsCreateField
418 * PARAMETERS: Op - Op containing the Field definition and args
419 * RegionNode - Object for the containing Operation Region
420 * ` WalkState - Current method state
424 * DESCRIPTION: Create a new field in the specified operation region
426 ******************************************************************************/
430 ACPI_PARSE_OBJECT *Op,
431 ACPI_NAMESPACE_NODE *RegionNode,
432 ACPI_WALK_STATE *WalkState)
435 ACPI_PARSE_OBJECT *Arg;
436 ACPI_CREATE_FIELD_INFO Info;
439 ACPI_FUNCTION_TRACE_PTR ("DsCreateField", Op);
442 /* First arg is the name of the parent OpRegion (must already exist) */
444 Arg = Op->Common.Value.Arg;
447 Status = AcpiNsLookup (WalkState->ScopeInfo, Arg->Common.Value.Name,
448 ACPI_TYPE_REGION, ACPI_IMODE_EXECUTE,
449 ACPI_NS_SEARCH_PARENT, WalkState, &RegionNode);
450 if (ACPI_FAILURE (Status))
452 ACPI_REPORT_NSERROR (Arg->Common.Value.Name, Status);
453 return_ACPI_STATUS (Status);
457 /* Second arg is the field flags */
459 Arg = Arg->Common.Next;
460 Info.FieldFlags = (UINT8) Arg->Common.Value.Integer;
463 /* Each remaining arg is a Named Field */
465 Info.FieldType = ACPI_TYPE_LOCAL_REGION_FIELD;
466 Info.RegionNode = RegionNode;
468 Status = AcpiDsGetFieldNames (&Info, WalkState, Arg->Common.Next);
470 return_ACPI_STATUS (Status);
474 /*******************************************************************************
476 * FUNCTION: AcpiDsInitFieldObjects
478 * PARAMETERS: Op - Op containing the Field definition and args
479 * ` WalkState - Current method state
483 * DESCRIPTION: For each "Field Unit" name in the argument list that is
484 * part of the field declaration, enter the name into the
487 ******************************************************************************/
490 AcpiDsInitFieldObjects (
491 ACPI_PARSE_OBJECT *Op,
492 ACPI_WALK_STATE *WalkState)
495 ACPI_PARSE_OBJECT *Arg = NULL;
496 ACPI_NAMESPACE_NODE *Node;
500 ACPI_FUNCTION_TRACE_PTR ("DsInitFieldObjects", Op);
503 switch (WalkState->Opcode)
506 Arg = AcpiPsGetArg (Op, 2);
507 Type = ACPI_TYPE_LOCAL_REGION_FIELD;
510 case AML_BANK_FIELD_OP:
511 Arg = AcpiPsGetArg (Op, 4);
512 Type = ACPI_TYPE_LOCAL_BANK_FIELD;
515 case AML_INDEX_FIELD_OP:
516 Arg = AcpiPsGetArg (Op, 3);
517 Type = ACPI_TYPE_LOCAL_INDEX_FIELD;
521 return_ACPI_STATUS (AE_BAD_PARAMETER);
525 * Walk the list of entries in the FieldList
529 /* Ignore OFFSET and ACCESSAS terms here */
531 if (Arg->Common.AmlOpcode == AML_INT_NAMEDFIELD_OP)
533 Status = AcpiNsLookup (WalkState->ScopeInfo,
534 (char *) &Arg->Named.Name,
535 Type, ACPI_IMODE_LOAD_PASS1,
536 ACPI_NS_NO_UPSEARCH | ACPI_NS_DONT_OPEN_SCOPE | ACPI_NS_ERROR_IF_FOUND,
538 if (ACPI_FAILURE (Status))
540 ACPI_REPORT_NSERROR ((char *) &Arg->Named.Name, Status);
541 if (Status != AE_ALREADY_EXISTS)
543 return_ACPI_STATUS (Status);
546 /* Name already exists, just ignore this error */
551 Arg->Common.Node = Node;
554 /* Move to next field in the list */
556 Arg = Arg->Common.Next;
559 return_ACPI_STATUS (AE_OK);
563 /*******************************************************************************
565 * FUNCTION: AcpiDsCreateBankField
567 * PARAMETERS: Op - Op containing the Field definition and args
568 * RegionNode - Object for the containing Operation Region
569 * ` WalkState - Current method state
573 * DESCRIPTION: Create a new bank field in the specified operation region
575 ******************************************************************************/
578 AcpiDsCreateBankField (
579 ACPI_PARSE_OBJECT *Op,
580 ACPI_NAMESPACE_NODE *RegionNode,
581 ACPI_WALK_STATE *WalkState)
584 ACPI_PARSE_OBJECT *Arg;
585 ACPI_CREATE_FIELD_INFO Info;
588 ACPI_FUNCTION_TRACE_PTR ("DsCreateBankField", Op);
591 /* First arg is the name of the parent OpRegion (must already exist) */
593 Arg = Op->Common.Value.Arg;
596 Status = AcpiNsLookup (WalkState->ScopeInfo, Arg->Common.Value.Name,
597 ACPI_TYPE_REGION, ACPI_IMODE_EXECUTE,
598 ACPI_NS_SEARCH_PARENT, WalkState, &RegionNode);
599 if (ACPI_FAILURE (Status))
601 ACPI_REPORT_NSERROR (Arg->Common.Value.Name, Status);
602 return_ACPI_STATUS (Status);
606 /* Second arg is the Bank Register (Field) (must already exist) */
608 Arg = Arg->Common.Next;
609 Status = AcpiNsLookup (WalkState->ScopeInfo, Arg->Common.Value.String,
610 ACPI_TYPE_ANY, ACPI_IMODE_EXECUTE,
611 ACPI_NS_SEARCH_PARENT, WalkState, &Info.RegisterNode);
612 if (ACPI_FAILURE (Status))
614 ACPI_REPORT_NSERROR (Arg->Common.Value.String, Status);
615 return_ACPI_STATUS (Status);
618 /* Third arg is the BankValue */
620 Arg = Arg->Common.Next;
621 Info.BankValue = (UINT32) Arg->Common.Value.Integer;
623 /* Fourth arg is the field flags */
625 Arg = Arg->Common.Next;
626 Info.FieldFlags = (UINT8) Arg->Common.Value.Integer;
628 /* Each remaining arg is a Named Field */
630 Info.FieldType = ACPI_TYPE_LOCAL_BANK_FIELD;
631 Info.RegionNode = RegionNode;
633 Status = AcpiDsGetFieldNames (&Info, WalkState, Arg->Common.Next);
635 return_ACPI_STATUS (Status);
639 /*******************************************************************************
641 * FUNCTION: AcpiDsCreateIndexField
643 * PARAMETERS: Op - Op containing the Field definition and args
644 * RegionNode - Object for the containing Operation Region
645 * ` WalkState - Current method state
649 * DESCRIPTION: Create a new index field in the specified operation region
651 ******************************************************************************/
654 AcpiDsCreateIndexField (
655 ACPI_PARSE_OBJECT *Op,
656 ACPI_NAMESPACE_NODE *RegionNode,
657 ACPI_WALK_STATE *WalkState)
660 ACPI_PARSE_OBJECT *Arg;
661 ACPI_CREATE_FIELD_INFO Info;
664 ACPI_FUNCTION_TRACE_PTR ("DsCreateIndexField", Op);
667 /* First arg is the name of the Index register (must already exist) */
669 Arg = Op->Common.Value.Arg;
670 Status = AcpiNsLookup (WalkState->ScopeInfo, Arg->Common.Value.String,
671 ACPI_TYPE_ANY, ACPI_IMODE_EXECUTE,
672 ACPI_NS_SEARCH_PARENT, WalkState, &Info.RegisterNode);
673 if (ACPI_FAILURE (Status))
675 ACPI_REPORT_NSERROR (Arg->Common.Value.String, Status);
676 return_ACPI_STATUS (Status);
679 /* Second arg is the data register (must already exist) */
681 Arg = Arg->Common.Next;
682 Status = AcpiNsLookup (WalkState->ScopeInfo, Arg->Common.Value.String,
683 ACPI_TYPE_ANY, ACPI_IMODE_EXECUTE,
684 ACPI_NS_SEARCH_PARENT, WalkState, &Info.DataRegisterNode);
685 if (ACPI_FAILURE (Status))
687 ACPI_REPORT_NSERROR (Arg->Common.Value.String, Status);
688 return_ACPI_STATUS (Status);
691 /* Next arg is the field flags */
693 Arg = Arg->Common.Next;
694 Info.FieldFlags = (UINT8) Arg->Common.Value.Integer;
696 /* Each remaining arg is a Named Field */
698 Info.FieldType = ACPI_TYPE_LOCAL_INDEX_FIELD;
699 Info.RegionNode = RegionNode;
701 Status = AcpiDsGetFieldNames (&Info, WalkState, Arg->Common.Next);
703 return_ACPI_STATUS (Status);