xref: /freebsd/sys/contrib/dev/acpica/compiler/aslhelpers.y (revision aa24f48b361effe51163877d84f1b70d32b77e04)
1 NoEcho('
2 /******************************************************************************
3  *
4  * Module Name: aslhelpers.y - helper and option terms
5  *
6  *****************************************************************************/
7 
8 /******************************************************************************
9  *
10  * 1. Copyright Notice
11  *
12  * Some or all of this work - Copyright (c) 1999 - 2017, Intel Corp.
13  * All rights reserved.
14  *
15  * 2. License
16  *
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
20  * property rights.
21  *
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
28  *
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;
37  *
38  * The above copyright and patent license is granted only if the following
39  * conditions are met:
40  *
41  * 3. Conditions
42  *
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.
54  *
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
65  * make.
66  *
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
71  * distribution.
72  *
73  * 3.4. Intel retains all right, title, and interest in and to the Original
74  * Intel Code.
75  *
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.
80  *
81  * 4. Disclaimer and Export Compliance
82  *
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
89  * PARTICULAR PURPOSE.
90  *
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
98  * LIMITED REMEDY.
99  *
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.
114  *
115  *****************************************************************************
116  *
117  * Alternatively, you may choose to be licensed under the terms of the
118  * following license:
119  *
120  * Redistribution and use in source and binary forms, with or without
121  * modification, are permitted provided that the following conditions
122  * are met:
123  * 1. Redistributions of source code must retain the above copyright
124  *    notice, this list of conditions, and the following disclaimer,
125  *    without modification.
126  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
127  *    substantially similar to the "NO WARRANTY" disclaimer below
128  *    ("Disclaimer") and any redistribution must be conditioned upon
129  *    including a substantially similar Disclaimer requirement for further
130  *    binary redistribution.
131  * 3. Neither the names of the above-listed copyright holders nor the names
132  *    of any contributors may be used to endorse or promote products derived
133  *    from this software without specific prior written permission.
134  *
135  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
136  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
137  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
138  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
139  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
140  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
141  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
142  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
143  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
144  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
145  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
146  *
147  * Alternatively, you may choose to be licensed under the terms of the
148  * GNU General Public License ("GPL") version 2 as published by the Free
149  * Software Foundation.
150  *
151  *****************************************************************************/
152 
153 ')
154 
155 
156 /*******************************************************************************
157  *
158  * ASL Helper Terms
159  *
160  ******************************************************************************/
161 
162 OptionalBusMasterKeyword
163     : ','                                   {$$ = TrCreateLeafNode (
164                                                 PARSEOP_BUSMASTERTYPE_MASTER);}
165     | ',' PARSEOP_BUSMASTERTYPE_MASTER      {$$ = TrCreateLeafNode (
166                                                 PARSEOP_BUSMASTERTYPE_MASTER);}
167     | ',' PARSEOP_BUSMASTERTYPE_NOTMASTER   {$$ = TrCreateLeafNode (
168                                                 PARSEOP_BUSMASTERTYPE_NOTMASTER);}
169     ;
170 
171 OptionalAccessAttribTerm
172     :                               {$$ = NULL;}
173     | ','                           {$$ = NULL;}
174     | ',' ByteConstExpr             {$$ = $2;}
175     | ',' AccessAttribKeyword       {$$ = $2;}
176     ;
177 
178 OptionalAccessSize
179     :                               {$$ = TrCreateValuedLeafNode (
180                                         PARSEOP_BYTECONST, 0);}
181     | ','                           {$$ = TrCreateValuedLeafNode (
182                                         PARSEOP_BYTECONST, 0);}
183     | ',' ByteConstExpr             {$$ = $2;}
184     ;
185 
186 OptionalAddressingMode
187     : ','                           {$$ = NULL;}
188     | ',' AddressingModeKeyword     {$$ = $2;}
189     ;
190 
191 OptionalAddressRange
192     :                               {$$ = NULL;}
193     | ','                           {$$ = NULL;}
194     | ',' AddressKeyword            {$$ = $2;}
195     ;
196 
197 OptionalBitsPerByte
198     : ','                           {$$ = NULL;}
199     | ',' BitsPerByteKeyword        {$$ = $2;}
200     ;
201 
202 OptionalBuffer_Last
203     :                               {$$ = NULL;}
204     | ','                           {$$ = NULL;}
205     | ',' RawDataBufferTerm         {$$ = $2;}
206     ;
207 
208 OptionalByteConstExpr
209     :                               {$$ = NULL;}
210     | ','                           {$$ = NULL;}
211     | ',' ByteConstExpr             {$$ = $2;}
212     ;
213 
214 OptionalDecodeType
215     : ','                           {$$ = NULL;}
216     | ',' DecodeKeyword             {$$ = $2;}
217     ;
218 
219 OptionalDevicePolarity
220     : ','                           {$$ = NULL;}
221     | ',' DevicePolarityKeyword     {$$ = $2;}
222     ;
223 
224 OptionalDWordConstExpr
225     :                               {$$ = NULL;}
226     | ','                           {$$ = NULL;}
227     | ',' DWordConstExpr            {$$ = $2;}
228     ;
229 
230 OptionalEndian
231     : ','                           {$$ = NULL;}
232     | ',' EndianKeyword             {$$ = $2;}
233     ;
234 
235 OptionalFlowControl
236     : ','                           {$$ = NULL;}
237     | ',' FlowControlKeyword        {$$ = $2;}
238     ;
239 
240 OptionalIoRestriction
241     : ','                           {$$ = NULL;}
242     | ',' IoRestrictionKeyword      {$$ = $2;}
243     ;
244 
245 OptionalListString
246     :                               {$$ = TrCreateValuedLeafNode (
247                                         PARSEOP_STRING_LITERAL,
248                                         ACPI_TO_INTEGER (""));}   /* Placeholder is a NULL string */
249     | ','                           {$$ = TrCreateValuedLeafNode (
250                                         PARSEOP_STRING_LITERAL,
251                                         ACPI_TO_INTEGER (""));}   /* Placeholder is a NULL string */
252     | ',' TermArg                   {$$ = $2;}
253     ;
254 
255 OptionalMaxType
256     : ','                           {$$ = NULL;}
257     | ',' MaxKeyword                {$$ = $2;}
258     ;
259 
260 OptionalMemType
261     : ','                           {$$ = NULL;}
262     | ',' MemTypeKeyword            {$$ = $2;}
263     ;
264 
265 OptionalMinType
266     : ','                           {$$ = NULL;}
267     | ',' MinKeyword                {$$ = $2;}
268     ;
269 
270 OptionalNameString
271     :                               {$$ = NULL;}
272     | ','                           {$$ = NULL;}
273     | ',' NameString                {$$ = $2;}
274     ;
275 
276 OptionalNameString_Last
277     :                               {$$ = NULL;}
278     | ','                           {$$ = NULL;}
279     | ',' NameString                {$$ = $2;}
280     ;
281 
282 OptionalNameString_First
283     :                               {$$ = TrCreateLeafNode (
284                                         PARSEOP_ZERO);}
285     | NameString                    {$$ = $1;}
286     ;
287 
288 OptionalObjectTypeKeyword
289     :                               {$$ = TrCreateLeafNode (
290                                         PARSEOP_OBJECTTYPE_UNK);}
291     | ',' ObjectTypeKeyword         {$$ = $2;}
292     ;
293 
294 OptionalParityType
295     : ','                           {$$ = NULL;}
296     | ',' ParityTypeKeyword         {$$ = $2;}
297     ;
298 
299 OptionalQWordConstExpr
300     :                               {$$ = NULL;}
301     | ','                           {$$ = NULL;}
302     | ',' QWordConstExpr            {$$ = $2;}
303     ;
304 
305 OptionalRangeType
306     : ','                           {$$ = NULL;}
307     | ',' RangeTypeKeyword          {$$ = $2;}
308     ;
309 
310 OptionalReadWriteKeyword
311     :                                   {$$ = TrCreateLeafNode (
312                                             PARSEOP_READWRITETYPE_BOTH);}
313     | PARSEOP_READWRITETYPE_BOTH        {$$ = TrCreateLeafNode (
314                                             PARSEOP_READWRITETYPE_BOTH);}
315     | PARSEOP_READWRITETYPE_READONLY    {$$ = TrCreateLeafNode (
316                                             PARSEOP_READWRITETYPE_READONLY);}
317     ;
318 
319 OptionalResourceType_First
320     :                               {$$ = TrCreateLeafNode (
321                                         PARSEOP_RESOURCETYPE_CONSUMER);}
322     | ResourceTypeKeyword           {$$ = $1;}
323     ;
324 
325 OptionalResourceType
326     :                               {$$ = TrCreateLeafNode (
327                                         PARSEOP_RESOURCETYPE_CONSUMER);}
328     | ','                           {$$ = TrCreateLeafNode (
329                                         PARSEOP_RESOURCETYPE_CONSUMER);}
330     | ',' ResourceTypeKeyword       {$$ = $2;}
331     ;
332 
333 /* Same as above except default is producer */
334 OptionalProducerResourceType
335     :                               {$$ = TrCreateLeafNode (
336                                         PARSEOP_RESOURCETYPE_PRODUCER);}
337     | ','                           {$$ = TrCreateLeafNode (
338                                         PARSEOP_RESOURCETYPE_PRODUCER);}
339     | ',' ResourceTypeKeyword       {$$ = $2;}
340     ;
341 
342 OptionalSlaveMode
343     : ','                           {$$ = NULL;}
344     | ',' SlaveModeKeyword          {$$ = $2;}
345     ;
346 
347 OptionalShareType
348     :                               {$$ = NULL;}
349     | ','                           {$$ = NULL;}
350     | ',' ShareTypeKeyword          {$$ = $2;}
351     ;
352 
353 OptionalShareType_First
354     :                               {$$ = NULL;}
355     | ShareTypeKeyword              {$$ = $1;}
356     ;
357 
358 OptionalStopBits
359     : ','                           {$$ = NULL;}
360     | ',' StopBitsKeyword           {$$ = $2;}
361     ;
362 
363 OptionalStringData
364     :                               {$$ = NULL;}
365     | ','                           {$$ = NULL;}
366     | ',' StringData                {$$ = $2;}
367     ;
368 
369 OptionalTranslationType_Last
370     :                               {$$ = NULL;}
371     | ','                           {$$ = NULL;}
372     | ',' TranslationKeyword        {$$ = $2;}
373     ;
374 
375 OptionalType
376     :                               {$$ = NULL;}
377     | ','                           {$$ = NULL;}
378     | ',' TypeKeyword               {$$ = $2;}
379     ;
380 
381 OptionalType_Last
382     :                               {$$ = NULL;}
383     | ','                           {$$ = NULL;}
384     | ',' TypeKeyword               {$$ = $2;}
385     ;
386 
387 OptionalWireMode
388     : ','                           {$$ = NULL;}
389     | ',' WireModeKeyword           {$$ = $2;}
390     ;
391 
392 OptionalWordConstExpr
393     : ','                           {$$ = NULL;}
394     | ',' WordConstExpr             {$$ = $2;}
395     ;
396 
397 OptionalXferSize
398     :                               {$$ = TrCreateValuedLeafNode (
399                                         PARSEOP_XFERSIZE_32, 2);}
400     | ','                           {$$ = TrCreateValuedLeafNode (
401                                         PARSEOP_XFERSIZE_32, 2);}
402     | ',' XferSizeKeyword           {$$ = $2;}
403     ;
404