14 * All rights reserved.
15 *
16 * 2. License
17 *
18 * 2.1. This is your license from Intel Corp. under its intellectual property
19 * rights. You may have additional license terms from the party that provided
20 * you this software, covering your right to use that party's intellectual
21 * property rights.
22 *
23 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
24 * copy of the source code appearing in this file ("Covered Code") an
25 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
26 * base code distributed originally by Intel ("Original Intel Code") to copy,
27 * make derivatives, distribute, use and display any portion of the Covered
28 * Code in any form, with the right to sublicense such rights; and
29 *
30 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
31 * license (with the right to sublicense), under only those claims of Intel
32 * patents that are infringed by the Original Intel Code, to make, use, sell,
33 * offer to sell, and import the Covered Code and derivative works thereof
34 * solely to the minimum extent necessary to exercise the above copyright
35 * license, and in no event shall the patent license extend to any additions
36 * to or modifications of the Original Intel Code. No other license or right
37 * is granted directly or by implication, estoppel or otherwise;
38 *
39 * The above copyright and patent license is granted only if the following
40 * conditions are met:
41 *
42 * 3. Conditions
43 *
44 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
45 * Redistribution of source code of any substantial portion of the Covered
46 * Code or modification with rights to further distribute source must include
47 * the above Copyright Notice, the above License, this list of Conditions,
48 * and the following Disclaimer and Export Compliance provision. In addition,
49 * Licensee must cause all Covered Code to which Licensee contributes to
50 * contain a file documenting the changes Licensee made to create that Covered
51 * Code and the date of any change. Licensee must include in that file the
52 * documentation of any changes made by any predecessor Licensee. Licensee
53 * must include a prominent statement that the modification is derived,
54 * directly or indirectly, from Original Intel Code.
55 *
56 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
57 * Redistribution of source code of any substantial portion of the Covered
58 * Code or modification without rights to further distribute source must
59 * include the following Disclaimer and Export Compliance provision in the
60 * documentation and/or other materials provided with distribution. In
61 * addition, Licensee may not authorize further sublicense of source of any
62 * portion of the Covered Code, and must include terms to the effect that the
63 * license from Licensee to its licensee is limited to the intellectual
64 * property embodied in the software Licensee provides to its licensee, and
65 * not to intellectual property embodied in modifications its licensee may
66 * make.
67 *
68 * 3.3. Redistribution of Executable. Redistribution in executable form of any
69 * substantial portion of the Covered Code or modification must reproduce the
70 * above Copyright Notice, and the following Disclaimer and Export Compliance
71 * provision in the documentation and/or other materials provided with the
72 * distribution.
73 *
74 * 3.4. Intel retains all right, title, and interest in and to the Original
75 * Intel Code.
76 *
77 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
78 * Intel shall be used in advertising or otherwise to promote the sale, use or
79 * other dealings in products derived from or relating to the Covered Code
80 * without prior written authorization from Intel.
81 *
82 * 4. Disclaimer and Export Compliance
83 *
84 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
85 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
86 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
87 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
88 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
89 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
90 * PARTICULAR PURPOSE.
91 *
92 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
93 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
94 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
95 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
96 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
97 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
98 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
99 * LIMITED REMEDY.
100 *
101 * 4.3. Licensee shall not export, either directly or indirectly, any of this
102 * software or system incorporating such software without first obtaining any
103 * required license or other approval from the U. S. Department of Commerce or
104 * any other agency or department of the United States Government. In the
105 * event Licensee exports any such software from the United States or
106 * re-exports any such software from a foreign destination, Licensee shall
107 * ensure that the distribution and export/re-export of the software is in
108 * compliance with all laws, regulations, orders, or other restrictions of the
109 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
110 * any of its subsidiaries will export/re-export any technical data, process,
111 * software, or service, directly or indirectly, to any country for which the
112 * United States government or any agency thereof requires an export license,
113 * other governmental approval, or letter of assurance, without first obtaining
114 * such license, approval or letter.
115 *
116 *****************************************************************************/
117
118
119#include "aslcompiler.h"
120#include "aslcompiler.y.h"
121#include "amlcode.h"
122
123#define _COMPONENT ACPI_COMPILER
124 ACPI_MODULE_NAME ("aslopcodes")
125
126
127/*******************************************************************************
128 *
129 * FUNCTION: OpcAmlOpcodeWalk
130 *
131 * PARAMETERS: ASL_WALK_CALLBACK
132 *
133 * RETURN: Status
134 *
135 * DESCRIPTION: Parse tree walk to generate both the AML opcodes and the AML
136 * operands.
137 *
138 ******************************************************************************/
139
140ACPI_STATUS
141OpcAmlOpcodeWalk (
142 ACPI_PARSE_OBJECT *Op,
143 UINT32 Level,
144 void *Context)
145{
146
147 TotalParseNodes++;
148
149 OpcGenerateAmlOpcode (Op);
150 OpnGenerateAmlOperands (Op);
151
152 return (AE_OK);
153}
154
155
156/*******************************************************************************
157 *
158 * FUNCTION: OpcGetIntegerWidth
159 *
160 * PARAMETERS: Op - DEFINITION BLOCK op
161 *
162 * RETURN: none
163 *
164 * DESCRIPTION: Extract integer width from the table revision
165 *
166 ******************************************************************************/
167
168void
169OpcGetIntegerWidth (
170 ACPI_PARSE_OBJECT *Op)
171{
172 ACPI_PARSE_OBJECT *Child;
173
174 if (!Op)
175 {
176 return;
177 }
178
179 Child = Op->Asl.Child;
180 Child = Child->Asl.Next;
181 Child = Child->Asl.Next;
182
183 /* Use the revision to set the integer width */
184
185 AcpiUtSetIntegerWidth ((UINT8) Child->Asl.Value.Integer);
186}
187
188
189/*******************************************************************************
190 *
191 * FUNCTION: OpcSetOptimalIntegerSize
192 *
193 * PARAMETERS: Op - A parse tree node
194 *
195 * RETURN: Integer width, in bytes. Also sets the node AML opcode to the
196 * optimal integer AML prefix opcode.
197 *
198 * DESCRIPTION: Determine the optimal AML encoding of an integer. All leading
199 * zeros can be truncated to squeeze the integer into the
200 * minimal number of AML bytes.
201 *
202 ******************************************************************************/
203
204UINT32
205OpcSetOptimalIntegerSize (
206 ACPI_PARSE_OBJECT *Op)
207{
208
209 /*
210 * Check for the special AML integers first - Zero, One, Ones.
211 * These are single-byte opcodes that are the smallest possible
212 * representation of an integer.
213 *
214 * This optimization is optional.
215 */
216 if (Gbl_IntegerOptimizationFlag)
217 {
218 switch (Op->Asl.Value.Integer)
219 {
220 case 0:
221
222 Op->Asl.AmlOpcode = AML_ZERO_OP;
223 AslError (ASL_OPTIMIZATION, ASL_MSG_INTEGER_OPTIMIZATION, Op, "Zero");
224 return 1;
225
226 case 1:
227
228 Op->Asl.AmlOpcode = AML_ONE_OP;
229 AslError (ASL_OPTIMIZATION, ASL_MSG_INTEGER_OPTIMIZATION, Op, "One");
230 return 1;
231
232 case ACPI_UINT32_MAX:
233
234 /* Check for table integer width (32 or 64) */
235
236 if (AcpiGbl_IntegerByteWidth == 4)
237 {
238 Op->Asl.AmlOpcode = AML_ONES_OP;
239 AslError (ASL_OPTIMIZATION, ASL_MSG_INTEGER_OPTIMIZATION, Op, "Ones");
240 return 1;
241 }
242 break;
243
244 case ACPI_INTEGER_MAX:
245
246 /* Check for table integer width (32 or 64) */
247
248 if (AcpiGbl_IntegerByteWidth == 8)
249 {
250 Op->Asl.AmlOpcode = AML_ONES_OP;
251 AslError (ASL_OPTIMIZATION, ASL_MSG_INTEGER_OPTIMIZATION, Op, "Ones");
252 return 1;
253 }
254 break;
255
256 default:
257 break;
258 }
259 }
260
261 /* Find the best fit using the various AML integer prefixes */
262
263 if (Op->Asl.Value.Integer <= ACPI_UINT8_MAX)
264 {
265 Op->Asl.AmlOpcode = AML_BYTE_OP;
266 return 1;
267 }
268 if (Op->Asl.Value.Integer <= ACPI_UINT16_MAX)
269 {
270 Op->Asl.AmlOpcode = AML_WORD_OP;
271 return 2;
272 }
273 if (Op->Asl.Value.Integer <= ACPI_UINT32_MAX)
274 {
275 Op->Asl.AmlOpcode = AML_DWORD_OP;
276 return 4;
277 }
278 else
279 {
280 Op->Asl.AmlOpcode = AML_QWORD_OP;
281 return 8;
282 }
283}
284
285
286/*******************************************************************************
287 *
288 * FUNCTION: OpcDoAccessAs
289 *
290 * PARAMETERS: Op - Parse node
291 *
292 * RETURN: None
293 *
294 * DESCRIPTION: Implement the ACCESS_AS ASL keyword.
295 *
296 ******************************************************************************/
297
298void
299OpcDoAccessAs (
300 ACPI_PARSE_OBJECT *Op)
301{
302 ACPI_PARSE_OBJECT *Next;
303
304
305 Op->Asl.AmlOpcodeLength = 1;
306 Next = Op->Asl.Child;
307
308 /* First child is the access type */
309
310 Next->Asl.AmlOpcode = AML_RAW_DATA_BYTE;
311 Next->Asl.ParseOpcode = PARSEOP_RAW_DATA;
312
313 /* Second child is the optional access attribute */
314
315 Next = Next->Asl.Next;
316 if (Next->Asl.ParseOpcode == PARSEOP_DEFAULT_ARG)
317 {
318 Next->Asl.Value.Integer = 0;
319 }
320 Next->Asl.AmlOpcode = AML_RAW_DATA_BYTE;
321 Next->Asl.ParseOpcode = PARSEOP_RAW_DATA;
322}
323
324
325/*******************************************************************************
326 *
327 * FUNCTION: OpcDoUnicode
328 *
329 * PARAMETERS: Op - Parse node
330 *
331 * RETURN: None
332 *
333 * DESCRIPTION: Implement the UNICODE ASL "macro". Convert the input string
334 * to a unicode buffer. There is no Unicode AML opcode.
335 *
336 * Note: The Unicode string is 16 bits per character, no leading signature,
337 * with a 16-bit terminating NULL.
338 *
339 ******************************************************************************/
340
341void
342OpcDoUnicode (
343 ACPI_PARSE_OBJECT *Op)
344{
345 ACPI_PARSE_OBJECT *InitializerOp;
346 UINT32 Length;
347 UINT32 Count;
348 UINT32 i;
349 UINT8 *AsciiString;
350 UINT16 *UnicodeString;
351 ACPI_PARSE_OBJECT *BufferLengthOp;
352
353
354 /* Change op into a buffer object */
355
356 Op->Asl.CompileFlags &= ~NODE_COMPILE_TIME_CONST;
357 Op->Asl.ParseOpcode = PARSEOP_BUFFER;
358 UtSetParseOpName (Op);
359
360 /* Buffer Length is first, followed by the string */
361
362 BufferLengthOp = Op->Asl.Child;
363 InitializerOp = BufferLengthOp->Asl.Next;
364
365 AsciiString = (UINT8 *) InitializerOp->Asl.Value.String;
366
367 /* Create a new buffer for the Unicode string */
368
369 Count = strlen (InitializerOp->Asl.Value.String) + 1;
370 Length = Count * sizeof (UINT16);
371 UnicodeString = UtLocalCalloc (Length);
372
373 /* Convert to Unicode string (including null terminator) */
374
375 for (i = 0; i < Count; i++)
376 {
377 UnicodeString[i] = (UINT16) AsciiString[i];
378 }
379
380 /*
381 * Just set the buffer size node to be the buffer length, regardless
382 * of whether it was previously an integer or a default_arg placeholder
383 */
384 BufferLengthOp->Asl.ParseOpcode = PARSEOP_INTEGER;
385 BufferLengthOp->Asl.AmlOpcode = AML_DWORD_OP;
386 BufferLengthOp->Asl.Value.Integer = Length;
387 UtSetParseOpName (BufferLengthOp);
388
389 (void) OpcSetOptimalIntegerSize (BufferLengthOp);
390
391 /* The Unicode string is a raw data buffer */
392
393 InitializerOp->Asl.Value.Buffer = (UINT8 *) UnicodeString;
394 InitializerOp->Asl.AmlOpcode = AML_RAW_DATA_BUFFER;
395 InitializerOp->Asl.AmlLength = Length;
396 InitializerOp->Asl.ParseOpcode = PARSEOP_RAW_DATA;
397 InitializerOp->Asl.Child = NULL;
398 UtSetParseOpName (InitializerOp);
399}
400
401
402/*******************************************************************************
403 *
404 * FUNCTION: OpcDoEisaId
405 *
406 * PARAMETERS: Op - Parse node
407 *
408 * RETURN: None
409 *
410 *
411 * DESCRIPTION: Convert a string EISA ID to numeric representation. See the
412 * Pnp BIOS Specification for details. Here is an excerpt:
413 *
414 * A seven character ASCII representation of the product
415 * identifier compressed into a 32-bit identifier. The seven
416 * character ID consists of a three character manufacturer code,
417 * a three character hexadecimal product identifier, and a one
418 * character hexadecimal revision number. The manufacturer code
419 * is a 3 uppercase character code that is compressed into 3 5-bit
420 * values as follows:
421 * 1) Find hex ASCII value for each letter
422 * 2) Subtract 40h from each ASCII value
423 * 3) Retain 5 least signficant bits for each letter by
424 * discarding upper 3 bits because they are always 0.
425 * 4) Compressed code = concatenate 0 and the 3 5-bit values
426 *
427 * The format of the compressed product identifier is as follows:
428 * Byte 0: Bit 7 - Reserved (0)
429 * Bits 6-2: - 1st character of compressed mfg code
430 * Bits 1-0 - Upper 2 bits of 2nd character of mfg code
431 * Byte 1: Bits 7-5 - Lower 3 bits of 2nd character of mfg code
432 * Bits 4-0 - 3rd character of mfg code
433 * Byte 2: Bits 7-4 - 1st hex digit of product number
434 * Bits 3-0 - 2nd hex digit of product number
435 * Byte 3: Bits 7-4 - 3st hex digit of product number
436 * Bits 3-0 - Hex digit of the revision number
437 *
438 ******************************************************************************/
439
440void
441OpcDoEisaId (
442 ACPI_PARSE_OBJECT *Op)
443{
444 UINT32 EisaId = 0;
445 UINT32 BigEndianId;
446 char *InString;
447 ACPI_STATUS Status = AE_OK;
448 ACPI_NATIVE_UINT i;
449
450
451 InString = (char *) Op->Asl.Value.String;
452
453 /*
454 * The EISAID string must be exactly 7 characters and of the form
455 * "LLLXXXX" -- 3 letters and 4 hex digits (e.g., "PNP0001")
456 */
457 if (ACPI_STRLEN (InString) != 7)
458 {
459 Status = AE_BAD_PARAMETER;
460 }
461 else
462 {
463 /* Check all 7 characters for correct format */
464
465 for (i = 0; i < 7; i++)
466 {
467 /* First 3 characters must be letters */
468
469 if (i < 3)
470 {
471 if (!isalpha (InString[i]))
472 {
473 Status = AE_BAD_PARAMETER;
474 }
475 }
476
477 /* Last 4 characters must be hex digits */
478
479 else if (!isxdigit (InString[i]))
480 {
481 Status = AE_BAD_PARAMETER;
482 }
483 }
484 }
485
486 if (ACPI_FAILURE (Status))
487 {
488 AslError (ASL_ERROR, ASL_MSG_INVALID_EISAID, Op, Op->Asl.Value.String);
489 }
490 else
491 {
492 /* Create ID big-endian first (bits are contiguous) */
493
494 BigEndianId = (UINT32) (InString[0] - 0x40) << 26 |
495 (UINT32) (InString[1] - 0x40) << 21 |
496 (UINT32) (InString[2] - 0x40) << 16 |
497
498 (UtHexCharToValue (InString[3])) << 12 |
499 (UtHexCharToValue (InString[4])) << 8 |
500 (UtHexCharToValue (InString[5])) << 4 |
501 UtHexCharToValue (InString[6]);
502
503 /* Swap to little-endian to get final ID (see function header) */
504
505 EisaId = AcpiUtDwordByteSwap (BigEndianId);
506 }
507
508 /*
509 * Morph the Op into an integer, regardless of whether there
510 * was an error in the EISAID string
511 */
512 Op->Asl.Value.Integer = EisaId;
513
514 Op->Asl.CompileFlags &= ~NODE_COMPILE_TIME_CONST;
515 Op->Asl.ParseOpcode = PARSEOP_INTEGER;
516 (void) OpcSetOptimalIntegerSize (Op);
517
518 /* Op is now an integer */
519
520 UtSetParseOpName (Op);
521}
522
523
524/*******************************************************************************
525 *
526 * FUNCTION: OpcGenerateAmlOpcode
527 *
528 * PARAMETERS: Op - Parse node
529 *
530 * RETURN: None
531 *
532 * DESCRIPTION: Generate the AML opcode associated with the node and its
533 * parse (lex/flex) keyword opcode. Essentially implements
534 * a mapping between the parse opcodes and the actual AML opcodes.
535 *
536 ******************************************************************************/
537
538void
539OpcGenerateAmlOpcode (
540 ACPI_PARSE_OBJECT *Op)
541{
542
543 UINT16 Index;
544
545
546 Index = (UINT16) (Op->Asl.ParseOpcode - ASL_PARSE_OPCODE_BASE);
547
548 Op->Asl.AmlOpcode = AslKeywordMapping[Index].AmlOpcode;
549 Op->Asl.AcpiBtype = AslKeywordMapping[Index].AcpiBtype;
550 Op->Asl.CompileFlags |= AslKeywordMapping[Index].Flags;
551
552 if (!Op->Asl.Value.Integer)
553 {
554 Op->Asl.Value.Integer = AslKeywordMapping[Index].Value;
555 }
556
557 /* Special handling for some opcodes */
558
559 switch (Op->Asl.ParseOpcode)
560 {
561 case PARSEOP_INTEGER:
562 /*
563 * Set the opcode based on the size of the integer
564 */
565 (void) OpcSetOptimalIntegerSize (Op);
566 break;
567
568 case PARSEOP_OFFSET:
569
570 Op->Asl.AmlOpcodeLength = 1;
571 break;
572
573 case PARSEOP_ACCESSAS:
574
575 OpcDoAccessAs (Op);
576 break;
577
578 case PARSEOP_EISAID:
579
580 OpcDoEisaId (Op);
581 break;
582
583 case PARSEOP_UNICODE:
584
585 OpcDoUnicode (Op);
586 break;
587
588 case PARSEOP_INCLUDE:
589
590 Op->Asl.Child->Asl.ParseOpcode = PARSEOP_DEFAULT_ARG;
591 Gbl_HasIncludeFiles = TRUE;
592 break;
593
594 case PARSEOP_EXTERNAL:
595
596 Op->Asl.Child->Asl.ParseOpcode = PARSEOP_DEFAULT_ARG;
597 Op->Asl.Child->Asl.Next->Asl.ParseOpcode = PARSEOP_DEFAULT_ARG;
598 break;
599
600 case PARSEOP_PACKAGE:
601 /*
602 * The variable-length package has a different opcode
603 */
604 if ((Op->Asl.Child->Asl.ParseOpcode != PARSEOP_DEFAULT_ARG) &&
605 (Op->Asl.Child->Asl.ParseOpcode != PARSEOP_INTEGER) &&
606 (Op->Asl.Child->Asl.ParseOpcode != PARSEOP_BYTECONST))
607 {
608 Op->Asl.AmlOpcode = AML_VAR_PACKAGE_OP;
609 }
610 break;
611
612 default:
613 /* Nothing to do for other opcodes */
614 break;
615 }
616
617 return;
618}
619
620
| 14 * All rights reserved.
15 *
16 * 2. License
17 *
18 * 2.1. This is your license from Intel Corp. under its intellectual property
19 * rights. You may have additional license terms from the party that provided
20 * you this software, covering your right to use that party's intellectual
21 * property rights.
22 *
23 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
24 * copy of the source code appearing in this file ("Covered Code") an
25 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
26 * base code distributed originally by Intel ("Original Intel Code") to copy,
27 * make derivatives, distribute, use and display any portion of the Covered
28 * Code in any form, with the right to sublicense such rights; and
29 *
30 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
31 * license (with the right to sublicense), under only those claims of Intel
32 * patents that are infringed by the Original Intel Code, to make, use, sell,
33 * offer to sell, and import the Covered Code and derivative works thereof
34 * solely to the minimum extent necessary to exercise the above copyright
35 * license, and in no event shall the patent license extend to any additions
36 * to or modifications of the Original Intel Code. No other license or right
37 * is granted directly or by implication, estoppel or otherwise;
38 *
39 * The above copyright and patent license is granted only if the following
40 * conditions are met:
41 *
42 * 3. Conditions
43 *
44 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
45 * Redistribution of source code of any substantial portion of the Covered
46 * Code or modification with rights to further distribute source must include
47 * the above Copyright Notice, the above License, this list of Conditions,
48 * and the following Disclaimer and Export Compliance provision. In addition,
49 * Licensee must cause all Covered Code to which Licensee contributes to
50 * contain a file documenting the changes Licensee made to create that Covered
51 * Code and the date of any change. Licensee must include in that file the
52 * documentation of any changes made by any predecessor Licensee. Licensee
53 * must include a prominent statement that the modification is derived,
54 * directly or indirectly, from Original Intel Code.
55 *
56 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
57 * Redistribution of source code of any substantial portion of the Covered
58 * Code or modification without rights to further distribute source must
59 * include the following Disclaimer and Export Compliance provision in the
60 * documentation and/or other materials provided with distribution. In
61 * addition, Licensee may not authorize further sublicense of source of any
62 * portion of the Covered Code, and must include terms to the effect that the
63 * license from Licensee to its licensee is limited to the intellectual
64 * property embodied in the software Licensee provides to its licensee, and
65 * not to intellectual property embodied in modifications its licensee may
66 * make.
67 *
68 * 3.3. Redistribution of Executable. Redistribution in executable form of any
69 * substantial portion of the Covered Code or modification must reproduce the
70 * above Copyright Notice, and the following Disclaimer and Export Compliance
71 * provision in the documentation and/or other materials provided with the
72 * distribution.
73 *
74 * 3.4. Intel retains all right, title, and interest in and to the Original
75 * Intel Code.
76 *
77 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
78 * Intel shall be used in advertising or otherwise to promote the sale, use or
79 * other dealings in products derived from or relating to the Covered Code
80 * without prior written authorization from Intel.
81 *
82 * 4. Disclaimer and Export Compliance
83 *
84 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
85 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
86 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
87 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
88 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
89 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
90 * PARTICULAR PURPOSE.
91 *
92 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
93 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
94 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
95 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
96 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
97 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
98 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
99 * LIMITED REMEDY.
100 *
101 * 4.3. Licensee shall not export, either directly or indirectly, any of this
102 * software or system incorporating such software without first obtaining any
103 * required license or other approval from the U. S. Department of Commerce or
104 * any other agency or department of the United States Government. In the
105 * event Licensee exports any such software from the United States or
106 * re-exports any such software from a foreign destination, Licensee shall
107 * ensure that the distribution and export/re-export of the software is in
108 * compliance with all laws, regulations, orders, or other restrictions of the
109 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
110 * any of its subsidiaries will export/re-export any technical data, process,
111 * software, or service, directly or indirectly, to any country for which the
112 * United States government or any agency thereof requires an export license,
113 * other governmental approval, or letter of assurance, without first obtaining
114 * such license, approval or letter.
115 *
116 *****************************************************************************/
117
118
119#include "aslcompiler.h"
120#include "aslcompiler.y.h"
121#include "amlcode.h"
122
123#define _COMPONENT ACPI_COMPILER
124 ACPI_MODULE_NAME ("aslopcodes")
125
126
127/*******************************************************************************
128 *
129 * FUNCTION: OpcAmlOpcodeWalk
130 *
131 * PARAMETERS: ASL_WALK_CALLBACK
132 *
133 * RETURN: Status
134 *
135 * DESCRIPTION: Parse tree walk to generate both the AML opcodes and the AML
136 * operands.
137 *
138 ******************************************************************************/
139
140ACPI_STATUS
141OpcAmlOpcodeWalk (
142 ACPI_PARSE_OBJECT *Op,
143 UINT32 Level,
144 void *Context)
145{
146
147 TotalParseNodes++;
148
149 OpcGenerateAmlOpcode (Op);
150 OpnGenerateAmlOperands (Op);
151
152 return (AE_OK);
153}
154
155
156/*******************************************************************************
157 *
158 * FUNCTION: OpcGetIntegerWidth
159 *
160 * PARAMETERS: Op - DEFINITION BLOCK op
161 *
162 * RETURN: none
163 *
164 * DESCRIPTION: Extract integer width from the table revision
165 *
166 ******************************************************************************/
167
168void
169OpcGetIntegerWidth (
170 ACPI_PARSE_OBJECT *Op)
171{
172 ACPI_PARSE_OBJECT *Child;
173
174 if (!Op)
175 {
176 return;
177 }
178
179 Child = Op->Asl.Child;
180 Child = Child->Asl.Next;
181 Child = Child->Asl.Next;
182
183 /* Use the revision to set the integer width */
184
185 AcpiUtSetIntegerWidth ((UINT8) Child->Asl.Value.Integer);
186}
187
188
189/*******************************************************************************
190 *
191 * FUNCTION: OpcSetOptimalIntegerSize
192 *
193 * PARAMETERS: Op - A parse tree node
194 *
195 * RETURN: Integer width, in bytes. Also sets the node AML opcode to the
196 * optimal integer AML prefix opcode.
197 *
198 * DESCRIPTION: Determine the optimal AML encoding of an integer. All leading
199 * zeros can be truncated to squeeze the integer into the
200 * minimal number of AML bytes.
201 *
202 ******************************************************************************/
203
204UINT32
205OpcSetOptimalIntegerSize (
206 ACPI_PARSE_OBJECT *Op)
207{
208
209 /*
210 * Check for the special AML integers first - Zero, One, Ones.
211 * These are single-byte opcodes that are the smallest possible
212 * representation of an integer.
213 *
214 * This optimization is optional.
215 */
216 if (Gbl_IntegerOptimizationFlag)
217 {
218 switch (Op->Asl.Value.Integer)
219 {
220 case 0:
221
222 Op->Asl.AmlOpcode = AML_ZERO_OP;
223 AslError (ASL_OPTIMIZATION, ASL_MSG_INTEGER_OPTIMIZATION, Op, "Zero");
224 return 1;
225
226 case 1:
227
228 Op->Asl.AmlOpcode = AML_ONE_OP;
229 AslError (ASL_OPTIMIZATION, ASL_MSG_INTEGER_OPTIMIZATION, Op, "One");
230 return 1;
231
232 case ACPI_UINT32_MAX:
233
234 /* Check for table integer width (32 or 64) */
235
236 if (AcpiGbl_IntegerByteWidth == 4)
237 {
238 Op->Asl.AmlOpcode = AML_ONES_OP;
239 AslError (ASL_OPTIMIZATION, ASL_MSG_INTEGER_OPTIMIZATION, Op, "Ones");
240 return 1;
241 }
242 break;
243
244 case ACPI_INTEGER_MAX:
245
246 /* Check for table integer width (32 or 64) */
247
248 if (AcpiGbl_IntegerByteWidth == 8)
249 {
250 Op->Asl.AmlOpcode = AML_ONES_OP;
251 AslError (ASL_OPTIMIZATION, ASL_MSG_INTEGER_OPTIMIZATION, Op, "Ones");
252 return 1;
253 }
254 break;
255
256 default:
257 break;
258 }
259 }
260
261 /* Find the best fit using the various AML integer prefixes */
262
263 if (Op->Asl.Value.Integer <= ACPI_UINT8_MAX)
264 {
265 Op->Asl.AmlOpcode = AML_BYTE_OP;
266 return 1;
267 }
268 if (Op->Asl.Value.Integer <= ACPI_UINT16_MAX)
269 {
270 Op->Asl.AmlOpcode = AML_WORD_OP;
271 return 2;
272 }
273 if (Op->Asl.Value.Integer <= ACPI_UINT32_MAX)
274 {
275 Op->Asl.AmlOpcode = AML_DWORD_OP;
276 return 4;
277 }
278 else
279 {
280 Op->Asl.AmlOpcode = AML_QWORD_OP;
281 return 8;
282 }
283}
284
285
286/*******************************************************************************
287 *
288 * FUNCTION: OpcDoAccessAs
289 *
290 * PARAMETERS: Op - Parse node
291 *
292 * RETURN: None
293 *
294 * DESCRIPTION: Implement the ACCESS_AS ASL keyword.
295 *
296 ******************************************************************************/
297
298void
299OpcDoAccessAs (
300 ACPI_PARSE_OBJECT *Op)
301{
302 ACPI_PARSE_OBJECT *Next;
303
304
305 Op->Asl.AmlOpcodeLength = 1;
306 Next = Op->Asl.Child;
307
308 /* First child is the access type */
309
310 Next->Asl.AmlOpcode = AML_RAW_DATA_BYTE;
311 Next->Asl.ParseOpcode = PARSEOP_RAW_DATA;
312
313 /* Second child is the optional access attribute */
314
315 Next = Next->Asl.Next;
316 if (Next->Asl.ParseOpcode == PARSEOP_DEFAULT_ARG)
317 {
318 Next->Asl.Value.Integer = 0;
319 }
320 Next->Asl.AmlOpcode = AML_RAW_DATA_BYTE;
321 Next->Asl.ParseOpcode = PARSEOP_RAW_DATA;
322}
323
324
325/*******************************************************************************
326 *
327 * FUNCTION: OpcDoUnicode
328 *
329 * PARAMETERS: Op - Parse node
330 *
331 * RETURN: None
332 *
333 * DESCRIPTION: Implement the UNICODE ASL "macro". Convert the input string
334 * to a unicode buffer. There is no Unicode AML opcode.
335 *
336 * Note: The Unicode string is 16 bits per character, no leading signature,
337 * with a 16-bit terminating NULL.
338 *
339 ******************************************************************************/
340
341void
342OpcDoUnicode (
343 ACPI_PARSE_OBJECT *Op)
344{
345 ACPI_PARSE_OBJECT *InitializerOp;
346 UINT32 Length;
347 UINT32 Count;
348 UINT32 i;
349 UINT8 *AsciiString;
350 UINT16 *UnicodeString;
351 ACPI_PARSE_OBJECT *BufferLengthOp;
352
353
354 /* Change op into a buffer object */
355
356 Op->Asl.CompileFlags &= ~NODE_COMPILE_TIME_CONST;
357 Op->Asl.ParseOpcode = PARSEOP_BUFFER;
358 UtSetParseOpName (Op);
359
360 /* Buffer Length is first, followed by the string */
361
362 BufferLengthOp = Op->Asl.Child;
363 InitializerOp = BufferLengthOp->Asl.Next;
364
365 AsciiString = (UINT8 *) InitializerOp->Asl.Value.String;
366
367 /* Create a new buffer for the Unicode string */
368
369 Count = strlen (InitializerOp->Asl.Value.String) + 1;
370 Length = Count * sizeof (UINT16);
371 UnicodeString = UtLocalCalloc (Length);
372
373 /* Convert to Unicode string (including null terminator) */
374
375 for (i = 0; i < Count; i++)
376 {
377 UnicodeString[i] = (UINT16) AsciiString[i];
378 }
379
380 /*
381 * Just set the buffer size node to be the buffer length, regardless
382 * of whether it was previously an integer or a default_arg placeholder
383 */
384 BufferLengthOp->Asl.ParseOpcode = PARSEOP_INTEGER;
385 BufferLengthOp->Asl.AmlOpcode = AML_DWORD_OP;
386 BufferLengthOp->Asl.Value.Integer = Length;
387 UtSetParseOpName (BufferLengthOp);
388
389 (void) OpcSetOptimalIntegerSize (BufferLengthOp);
390
391 /* The Unicode string is a raw data buffer */
392
393 InitializerOp->Asl.Value.Buffer = (UINT8 *) UnicodeString;
394 InitializerOp->Asl.AmlOpcode = AML_RAW_DATA_BUFFER;
395 InitializerOp->Asl.AmlLength = Length;
396 InitializerOp->Asl.ParseOpcode = PARSEOP_RAW_DATA;
397 InitializerOp->Asl.Child = NULL;
398 UtSetParseOpName (InitializerOp);
399}
400
401
402/*******************************************************************************
403 *
404 * FUNCTION: OpcDoEisaId
405 *
406 * PARAMETERS: Op - Parse node
407 *
408 * RETURN: None
409 *
410 *
411 * DESCRIPTION: Convert a string EISA ID to numeric representation. See the
412 * Pnp BIOS Specification for details. Here is an excerpt:
413 *
414 * A seven character ASCII representation of the product
415 * identifier compressed into a 32-bit identifier. The seven
416 * character ID consists of a three character manufacturer code,
417 * a three character hexadecimal product identifier, and a one
418 * character hexadecimal revision number. The manufacturer code
419 * is a 3 uppercase character code that is compressed into 3 5-bit
420 * values as follows:
421 * 1) Find hex ASCII value for each letter
422 * 2) Subtract 40h from each ASCII value
423 * 3) Retain 5 least signficant bits for each letter by
424 * discarding upper 3 bits because they are always 0.
425 * 4) Compressed code = concatenate 0 and the 3 5-bit values
426 *
427 * The format of the compressed product identifier is as follows:
428 * Byte 0: Bit 7 - Reserved (0)
429 * Bits 6-2: - 1st character of compressed mfg code
430 * Bits 1-0 - Upper 2 bits of 2nd character of mfg code
431 * Byte 1: Bits 7-5 - Lower 3 bits of 2nd character of mfg code
432 * Bits 4-0 - 3rd character of mfg code
433 * Byte 2: Bits 7-4 - 1st hex digit of product number
434 * Bits 3-0 - 2nd hex digit of product number
435 * Byte 3: Bits 7-4 - 3st hex digit of product number
436 * Bits 3-0 - Hex digit of the revision number
437 *
438 ******************************************************************************/
439
440void
441OpcDoEisaId (
442 ACPI_PARSE_OBJECT *Op)
443{
444 UINT32 EisaId = 0;
445 UINT32 BigEndianId;
446 char *InString;
447 ACPI_STATUS Status = AE_OK;
448 ACPI_NATIVE_UINT i;
449
450
451 InString = (char *) Op->Asl.Value.String;
452
453 /*
454 * The EISAID string must be exactly 7 characters and of the form
455 * "LLLXXXX" -- 3 letters and 4 hex digits (e.g., "PNP0001")
456 */
457 if (ACPI_STRLEN (InString) != 7)
458 {
459 Status = AE_BAD_PARAMETER;
460 }
461 else
462 {
463 /* Check all 7 characters for correct format */
464
465 for (i = 0; i < 7; i++)
466 {
467 /* First 3 characters must be letters */
468
469 if (i < 3)
470 {
471 if (!isalpha (InString[i]))
472 {
473 Status = AE_BAD_PARAMETER;
474 }
475 }
476
477 /* Last 4 characters must be hex digits */
478
479 else if (!isxdigit (InString[i]))
480 {
481 Status = AE_BAD_PARAMETER;
482 }
483 }
484 }
485
486 if (ACPI_FAILURE (Status))
487 {
488 AslError (ASL_ERROR, ASL_MSG_INVALID_EISAID, Op, Op->Asl.Value.String);
489 }
490 else
491 {
492 /* Create ID big-endian first (bits are contiguous) */
493
494 BigEndianId = (UINT32) (InString[0] - 0x40) << 26 |
495 (UINT32) (InString[1] - 0x40) << 21 |
496 (UINT32) (InString[2] - 0x40) << 16 |
497
498 (UtHexCharToValue (InString[3])) << 12 |
499 (UtHexCharToValue (InString[4])) << 8 |
500 (UtHexCharToValue (InString[5])) << 4 |
501 UtHexCharToValue (InString[6]);
502
503 /* Swap to little-endian to get final ID (see function header) */
504
505 EisaId = AcpiUtDwordByteSwap (BigEndianId);
506 }
507
508 /*
509 * Morph the Op into an integer, regardless of whether there
510 * was an error in the EISAID string
511 */
512 Op->Asl.Value.Integer = EisaId;
513
514 Op->Asl.CompileFlags &= ~NODE_COMPILE_TIME_CONST;
515 Op->Asl.ParseOpcode = PARSEOP_INTEGER;
516 (void) OpcSetOptimalIntegerSize (Op);
517
518 /* Op is now an integer */
519
520 UtSetParseOpName (Op);
521}
522
523
524/*******************************************************************************
525 *
526 * FUNCTION: OpcGenerateAmlOpcode
527 *
528 * PARAMETERS: Op - Parse node
529 *
530 * RETURN: None
531 *
532 * DESCRIPTION: Generate the AML opcode associated with the node and its
533 * parse (lex/flex) keyword opcode. Essentially implements
534 * a mapping between the parse opcodes and the actual AML opcodes.
535 *
536 ******************************************************************************/
537
538void
539OpcGenerateAmlOpcode (
540 ACPI_PARSE_OBJECT *Op)
541{
542
543 UINT16 Index;
544
545
546 Index = (UINT16) (Op->Asl.ParseOpcode - ASL_PARSE_OPCODE_BASE);
547
548 Op->Asl.AmlOpcode = AslKeywordMapping[Index].AmlOpcode;
549 Op->Asl.AcpiBtype = AslKeywordMapping[Index].AcpiBtype;
550 Op->Asl.CompileFlags |= AslKeywordMapping[Index].Flags;
551
552 if (!Op->Asl.Value.Integer)
553 {
554 Op->Asl.Value.Integer = AslKeywordMapping[Index].Value;
555 }
556
557 /* Special handling for some opcodes */
558
559 switch (Op->Asl.ParseOpcode)
560 {
561 case PARSEOP_INTEGER:
562 /*
563 * Set the opcode based on the size of the integer
564 */
565 (void) OpcSetOptimalIntegerSize (Op);
566 break;
567
568 case PARSEOP_OFFSET:
569
570 Op->Asl.AmlOpcodeLength = 1;
571 break;
572
573 case PARSEOP_ACCESSAS:
574
575 OpcDoAccessAs (Op);
576 break;
577
578 case PARSEOP_EISAID:
579
580 OpcDoEisaId (Op);
581 break;
582
583 case PARSEOP_UNICODE:
584
585 OpcDoUnicode (Op);
586 break;
587
588 case PARSEOP_INCLUDE:
589
590 Op->Asl.Child->Asl.ParseOpcode = PARSEOP_DEFAULT_ARG;
591 Gbl_HasIncludeFiles = TRUE;
592 break;
593
594 case PARSEOP_EXTERNAL:
595
596 Op->Asl.Child->Asl.ParseOpcode = PARSEOP_DEFAULT_ARG;
597 Op->Asl.Child->Asl.Next->Asl.ParseOpcode = PARSEOP_DEFAULT_ARG;
598 break;
599
600 case PARSEOP_PACKAGE:
601 /*
602 * The variable-length package has a different opcode
603 */
604 if ((Op->Asl.Child->Asl.ParseOpcode != PARSEOP_DEFAULT_ARG) &&
605 (Op->Asl.Child->Asl.ParseOpcode != PARSEOP_INTEGER) &&
606 (Op->Asl.Child->Asl.ParseOpcode != PARSEOP_BYTECONST))
607 {
608 Op->Asl.AmlOpcode = AML_VAR_PACKAGE_OP;
609 }
610 break;
611
612 default:
613 /* Nothing to do for other opcodes */
614 break;
615 }
616
617 return;
618}
619
620
|