1 /******************************************************************************
3 * Module Name: aslbtypes - Support for bitfield types
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2017, Intel Corp.
12 * All rights reserved.
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
37 * The above copyright and patent license is granted only if the following
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
72 * 3.4. Intel retains all right, title, and interest in and to the Original
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
80 * 4. Disclaimer and Export Compliance
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
114 *****************************************************************************
116 * Alternatively, you may choose to be licensed under the terms of the
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
122 * 1. Redistributions of source code must retain the above copyright
123 * notice, this list of conditions, and the following disclaimer,
124 * without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 * substantially similar to the "NO WARRANTY" disclaimer below
127 * ("Disclaimer") and any redistribution must be conditioned upon
128 * including a substantially similar Disclaimer requirement for further
129 * binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 * of any contributors may be used to endorse or promote products derived
132 * from this software without specific prior written permission.
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
150 *****************************************************************************/
152 #include <contrib/dev/acpica/compiler/aslcompiler.h>
153 #include "aslcompiler.y.h"
154 #include <contrib/dev/acpica/include/amlcode.h>
157 #define _COMPONENT ACPI_COMPILER
158 ACPI_MODULE_NAME ("aslbtypes")
160 /* Local prototypes */
167 /*******************************************************************************
169 * FUNCTION: AnMapArgTypeToBtype
171 * PARAMETERS: ArgType - The ARGI required type(s) for this
172 * argument, from the opcode info table
174 * RETURN: The corresponding Bit-encoded types
176 * DESCRIPTION: Convert an encoded ARGI required argument type code into a
177 * bitfield type code. Implements the implicit source conversion
180 ******************************************************************************/
183 AnMapArgTypeToBtype (
193 return (ACPI_BTYPE_OBJECTS_AND_REFS);
197 return (ACPI_BTYPE_PACKAGE);
201 return (ACPI_BTYPE_EVENT);
205 return (ACPI_BTYPE_MUTEX);
209 * DDBHandleObject := SuperName
210 * ACPI_BTYPE_REFERENCE_OBJECT:
211 * Index reference as parameter of Load/Unload
213 return (ACPI_BTYPE_DDB_HANDLE | ACPI_BTYPE_REFERENCE_OBJECT);
215 /* Interchangeable types */
217 * Source conversion rules:
218 * Integer, String, and Buffer are all interchangeable
223 case ARGI_BUFFER_OR_STRING:
224 case ARGI_COMPUTEDATA:
226 return (ACPI_BTYPE_COMPUTE_DATA);
230 case ARGI_INTEGER_REF:
232 return (ACPI_BTYPE_INTEGER);
234 case ARGI_OBJECT_REF:
236 return (ACPI_BTYPE_ALL_OBJECTS);
238 case ARGI_DEVICE_REF:
240 return (ACPI_BTYPE_DEVICE_OBJECTS);
244 return (ACPI_BTYPE_NAMED_REFERENCE); /* Name or Namestring */
249 * Target operand for most math and logic operators.
250 * Package objects not allowed as target.
252 return (ACPI_BTYPE_COMPUTE_DATA | ACPI_BTYPE_DEBUG_OBJECT |
253 ACPI_BTYPE_REFERENCE_OBJECT);
255 case ARGI_STORE_TARGET:
257 /* Special target for Store(), includes packages */
259 return (ACPI_BTYPE_DATA | ACPI_BTYPE_DEBUG_OBJECT |
260 ACPI_BTYPE_REFERENCE_OBJECT);
262 case ARGI_SIMPLE_TARGET:
264 return (ACPI_BTYPE_OBJECTS_AND_REFS);
268 case ARGI_DATAOBJECT:
270 * Buffer, string, package or reference to a Op -
271 * Used only by SizeOf operator
273 return (ACPI_BTYPE_STRING | ACPI_BTYPE_BUFFER |
274 ACPI_BTYPE_PACKAGE | ACPI_BTYPE_REFERENCE_OBJECT);
276 case ARGI_COMPLEXOBJ:
278 /* Buffer, String, or package */
280 return (ACPI_BTYPE_STRING | ACPI_BTYPE_BUFFER |
283 case ARGI_REF_OR_STRING:
285 /* Used by DeRefOf operator only */
287 return (ACPI_BTYPE_STRING | ACPI_BTYPE_REFERENCE_OBJECT);
289 case ARGI_REGION_OR_BUFFER:
291 /* Used by Load() only. Allow buffers in addition to regions/fields */
293 return (ACPI_BTYPE_REGION | ACPI_BTYPE_BUFFER |
294 ACPI_BTYPE_FIELD_UNIT);
296 case ARGI_DATAREFOBJ:
298 /* Used by Store() only, as the source operand */
300 return (ACPI_BTYPE_DATA_REFERENCE | ACPI_BTYPE_REFERENCE_OBJECT);
307 return (ACPI_BTYPE_OBJECTS_AND_REFS);
311 /*******************************************************************************
313 * FUNCTION: AnMapEtypeToBtype
315 * PARAMETERS: Etype - Encoded ACPI Type
317 * RETURN: Btype corresponding to the Etype
319 * DESCRIPTION: Convert an encoded ACPI type to a bitfield type applying the
320 * operand conversion rules. In other words, returns the type(s)
321 * this Etype is implicitly converted to during interpretation.
323 ******************************************************************************/
330 if (Etype == ACPI_TYPE_ANY)
332 return (ACPI_BTYPE_OBJECTS_AND_REFS);
335 /* Try the standard ACPI data types */
337 if (Etype <= ACPI_TYPE_EXTERNAL_MAX)
340 * This switch statement implements the allowed operand conversion
341 * rules as per the "ASL Data Types" section of the ACPI
346 case ACPI_TYPE_INTEGER:
348 return (ACPI_BTYPE_COMPUTE_DATA | ACPI_BTYPE_DDB_HANDLE);
350 case ACPI_TYPE_STRING:
351 case ACPI_TYPE_BUFFER:
353 return (ACPI_BTYPE_COMPUTE_DATA);
355 case ACPI_TYPE_PACKAGE:
357 return (ACPI_BTYPE_PACKAGE);
359 case ACPI_TYPE_FIELD_UNIT:
361 return (ACPI_BTYPE_COMPUTE_DATA | ACPI_BTYPE_FIELD_UNIT);
363 case ACPI_TYPE_BUFFER_FIELD:
365 return (ACPI_BTYPE_COMPUTE_DATA | ACPI_BTYPE_BUFFER_FIELD);
367 case ACPI_TYPE_DDB_HANDLE:
369 return (ACPI_BTYPE_INTEGER | ACPI_BTYPE_DDB_HANDLE);
371 case ACPI_TYPE_DEBUG_OBJECT:
373 /* Cannot be used as a source operand */
379 return (1 << (Etype - 1));
383 /* Try the internal data types */
387 case ACPI_TYPE_LOCAL_REGION_FIELD:
388 case ACPI_TYPE_LOCAL_BANK_FIELD:
389 case ACPI_TYPE_LOCAL_INDEX_FIELD:
391 /* Named fields can be either Integer/Buffer/String */
393 return (ACPI_BTYPE_COMPUTE_DATA | ACPI_BTYPE_FIELD_UNIT);
395 case ACPI_TYPE_LOCAL_ALIAS:
397 return (ACPI_BTYPE_INTEGER);
400 case ACPI_TYPE_LOCAL_RESOURCE:
401 case ACPI_TYPE_LOCAL_RESOURCE_FIELD:
403 return (ACPI_BTYPE_REFERENCE_OBJECT);
407 printf ("Unhandled encoded type: %X\n", Etype);
413 /*******************************************************************************
415 * FUNCTION: AnFormatBtype
417 * PARAMETERS: Btype - Bitfield of ACPI types
418 * Buffer - Where to put the ascii string
422 * DESCRIPTION: Convert a Btype to a string of ACPI types
424 ******************************************************************************/
432 BOOLEAN First = TRUE;
438 strcat (Buffer, "NoReturnValue");
442 for (Type = 1; Type <= ACPI_TYPE_EXTERNAL_MAX; Type++)
444 if (Btype & 0x00000001)
448 strcat (Buffer, "|");
452 strcat (Buffer, AcpiUtGetTypeName (Type));
457 if (Btype & 0x00000001)
461 strcat (Buffer, "|");
465 strcat (Buffer, "Reference");
469 if (Btype & 0x00000001)
473 strcat (Buffer, "|");
477 strcat (Buffer, "Resource");
482 /*******************************************************************************
484 * FUNCTION: AnGetBtype
486 * PARAMETERS: Op - Parse node whose type will be returned.
488 * RETURN: The Btype associated with the Op.
490 * DESCRIPTION: Get the (bitfield) ACPI type associated with the parse node.
491 * Handles the case where the node is a name or method call and
492 * the actual type must be obtained from the namespace node.
494 ******************************************************************************/
498 ACPI_PARSE_OBJECT *Op)
500 ACPI_NAMESPACE_NODE *Node;
501 ACPI_PARSE_OBJECT *ReferencedNode;
502 UINT32 ThisNodeBtype = 0;
507 AcpiOsPrintf ("Null Op in AnGetBtype\n");
508 return (ACPI_UINT32_MAX);
511 if ((Op->Asl.ParseOpcode == PARSEOP_NAMESEG) ||
512 (Op->Asl.ParseOpcode == PARSEOP_NAMESTRING) ||
513 (Op->Asl.ParseOpcode == PARSEOP_METHODCALL))
518 /* These are not expected to have a node at this time */
520 if ((Op->Asl.Parent->Asl.ParseOpcode == PARSEOP_CREATEWORDFIELD) ||
521 (Op->Asl.Parent->Asl.ParseOpcode == PARSEOP_CREATEDWORDFIELD) ||
522 (Op->Asl.Parent->Asl.ParseOpcode == PARSEOP_CREATEQWORDFIELD) ||
523 (Op->Asl.Parent->Asl.ParseOpcode == PARSEOP_CREATEBYTEFIELD) ||
524 (Op->Asl.Parent->Asl.ParseOpcode == PARSEOP_CREATEBITFIELD) ||
525 (Op->Asl.Parent->Asl.ParseOpcode == PARSEOP_CREATEFIELD) ||
526 (Op->Asl.Parent->Asl.ParseOpcode == PARSEOP_CONDREFOF))
528 return (ACPI_UINT32_MAX - 1);
531 DbgPrint (ASL_DEBUG_OUTPUT,
532 "No attached Nsnode: [%s] at line %u name [%s], "
533 "ignoring typecheck. Parent [%s]\n",
534 Op->Asl.ParseOpName, Op->Asl.LineNumber,
535 Op->Asl.ExternalName, Op->Asl.Parent->Asl.ParseOpName);
536 return (ACPI_UINT32_MAX - 1);
539 ThisNodeBtype = AnMapEtypeToBtype (Node->Type);
542 AslError (ASL_ERROR, ASL_MSG_COMPILER_INTERNAL, Op,
543 "could not map type");
546 if (Op->Asl.ParseOpcode == PARSEOP_METHODCALL)
548 ReferencedNode = Node->Op;
551 /* Check for an internal method */
553 if (AnIsInternalMethod (Op))
555 return (AnGetInternalMethodReturnType (Op));
558 AslError (ASL_ERROR, ASL_MSG_COMPILER_INTERNAL, Op,
560 return (ACPI_UINT32_MAX);
563 if (ReferencedNode->Asl.CompileFlags & OP_METHOD_TYPED)
565 ThisNodeBtype = ReferencedNode->Asl.AcpiBtype;
569 return (ACPI_UINT32_MAX -1);
575 ThisNodeBtype = Op->Asl.AcpiBtype;
578 return (ThisNodeBtype);
582 /*******************************************************************************
584 * FUNCTION: AnMapObjTypeToBtype
586 * PARAMETERS: Op - A parse node
590 * DESCRIPTION: Map object to the associated "Btype"
592 ******************************************************************************/
595 AnMapObjTypeToBtype (
596 ACPI_PARSE_OBJECT *Op)
599 switch (Op->Asl.ParseOpcode)
601 case PARSEOP_OBJECTTYPE_BFF: /* "BuffFieldObj" */
603 return (ACPI_BTYPE_BUFFER_FIELD);
605 case PARSEOP_OBJECTTYPE_BUF: /* "BuffObj" */
607 return (ACPI_BTYPE_BUFFER);
609 case PARSEOP_OBJECTTYPE_DDB: /* "DDBHandleObj" */
611 return (ACPI_BTYPE_DDB_HANDLE);
613 case PARSEOP_OBJECTTYPE_DEV: /* "DeviceObj" */
615 return (ACPI_BTYPE_DEVICE);
617 case PARSEOP_OBJECTTYPE_EVT: /* "EventObj" */
619 return (ACPI_BTYPE_EVENT);
621 case PARSEOP_OBJECTTYPE_FLD: /* "FieldUnitObj" */
623 return (ACPI_BTYPE_FIELD_UNIT);
625 case PARSEOP_OBJECTTYPE_INT: /* "IntObj" */
627 return (ACPI_BTYPE_INTEGER);
629 case PARSEOP_OBJECTTYPE_MTH: /* "MethodObj" */
631 return (ACPI_BTYPE_METHOD);
633 case PARSEOP_OBJECTTYPE_MTX: /* "MutexObj" */
635 return (ACPI_BTYPE_MUTEX);
637 case PARSEOP_OBJECTTYPE_OPR: /* "OpRegionObj" */
639 return (ACPI_BTYPE_REGION);
641 case PARSEOP_OBJECTTYPE_PKG: /* "PkgObj" */
643 return (ACPI_BTYPE_PACKAGE);
645 case PARSEOP_OBJECTTYPE_POW: /* "PowerResObj" */
647 return (ACPI_BTYPE_POWER);
649 case PARSEOP_OBJECTTYPE_STR: /* "StrObj" */
651 return (ACPI_BTYPE_STRING);
653 case PARSEOP_OBJECTTYPE_THZ: /* "ThermalZoneObj" */
655 return (ACPI_BTYPE_THERMAL);
657 case PARSEOP_OBJECTTYPE_UNK: /* "UnknownObj" */
659 return (ACPI_BTYPE_OBJECTS_AND_REFS);
668 #ifdef ACPI_OBSOLETE_FUNCTIONS
669 /*******************************************************************************
671 * FUNCTION: AnMapBtypeToEtype
673 * PARAMETERS: Btype - Bitfield of ACPI types
675 * RETURN: The Etype corresponding the the Btype
677 * DESCRIPTION: Convert a bitfield type to an encoded type
679 ******************************************************************************/
695 for (i = 1; i < Btype; i *= 2)