1 /*******************************************************************************
2  *
3  * Module Name: dmbuffer - AML disassembler, buffer and string support
4  *
5  ******************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
12  * All rights reserved.
13  *
14  * 2. License
15  *
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
19  * property rights.
20  *
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
27  *
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;
36  *
37  * The above copyright and patent license is granted only if the following
38  * conditions are met:
39  *
40  * 3. Conditions
41  *
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.
53  *
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
64  * make.
65  *
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
70  * distribution.
71  *
72  * 3.4. Intel retains all right, title, and interest in and to the Original
73  * Intel Code.
74  *
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.
79  *
80  * 4. Disclaimer and Export Compliance
81  *
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
88  * PARTICULAR PURPOSE.
89  *
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
97  * LIMITED REMEDY.
98  *
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.
113  *
114  *****************************************************************************
115  *
116  * Alternatively, you may choose to be licensed under the terms of the
117  * following license:
118  *
119  * Redistribution and use in source and binary forms, with or without
120  * modification, are permitted provided that the following conditions
121  * are met:
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.
133  *
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.
145  *
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.
149  *
150  *****************************************************************************/
151 
152 #include "acpi.h"
153 #include "accommon.h"
154 #include "acutils.h"
155 #include "acdisasm.h"
156 #include "acparser.h"
157 #include "amlcode.h"
158 #include "acinterp.h"
159 
160 
161 #define _COMPONENT          ACPI_CA_DEBUGGER
162         ACPI_MODULE_NAME    ("dmbuffer")
163 
164 /* Local prototypes */
165 
166 static void
167 AcpiDmUuid (
168     ACPI_PARSE_OBJECT       *Op);
169 
170 static void
171 AcpiDmUnicode (
172     ACPI_PARSE_OBJECT       *Op);
173 
174 static void
175 AcpiDmGetHardwareIdType (
176     ACPI_PARSE_OBJECT       *Op);
177 
178 static void
179 AcpiDmPldBuffer (
180     UINT32                  Level,
181     UINT8                   *ByteData,
182     UINT32                  ByteCount);
183 
184 static const char *
185 AcpiDmFindNameByIndex (
186     UINT64                  Index,
187     const char              **List);
188 
189 
190 #define ACPI_BUFFER_BYTES_PER_LINE      8
191 
192 
193 /*******************************************************************************
194  *
195  * FUNCTION:    AcpiDmDisasmByteList
196  *
197  * PARAMETERS:  Level               - Current source code indentation level
198  *              ByteData            - Pointer to the byte list
199  *              ByteCount           - Length of the byte list
200  *
201  * RETURN:      None
202  *
203  * DESCRIPTION: Dump an AML "ByteList" in Hex format. 8 bytes per line, prefixed
204  *              with the hex buffer offset.
205  *
206  ******************************************************************************/
207 
208 void
AcpiDmDisasmByteList(UINT32 Level,UINT8 * ByteData,UINT32 ByteCount)209 AcpiDmDisasmByteList (
210     UINT32                  Level,
211     UINT8                   *ByteData,
212     UINT32                  ByteCount)
213 {
214     UINT32                  i;
215     UINT32                  j;
216     UINT32                  CurrentIndex;
217     UINT8                   BufChar;
218 
219 
220     if (!ByteCount)
221     {
222         return;
223     }
224 
225     for (i = 0; i < ByteCount; i += ACPI_BUFFER_BYTES_PER_LINE)
226     {
227         /* Line indent and offset prefix for each new line */
228 
229         AcpiDmIndent (Level);
230         if (ByteCount > ACPI_BUFFER_BYTES_PER_LINE)
231         {
232             AcpiOsPrintf ("/* %04X */ ", i);
233         }
234 
235         /* Dump the actual hex values */
236 
237         for (j = 0; j < ACPI_BUFFER_BYTES_PER_LINE; j++)
238         {
239             CurrentIndex = i + j;
240             if (CurrentIndex >= ByteCount)
241             {
242                 /* Dump fill spaces */
243 
244                 AcpiOsPrintf ("      ");
245                 continue;
246             }
247 
248             AcpiOsPrintf (" 0x%2.2X", ByteData[CurrentIndex]);
249 
250             /* Add comma if there are more bytes to display */
251 
252             if (CurrentIndex < (ByteCount - 1))
253             {
254                 AcpiOsPrintf (",");
255             }
256             else
257             {
258                 AcpiOsPrintf (" ");
259             }
260         }
261 
262         /* Dump the ASCII equivalents within a comment */
263 
264         AcpiOsPrintf ("  // ");
265         for (j = 0; j < ACPI_BUFFER_BYTES_PER_LINE; j++)
266         {
267             CurrentIndex = i + j;
268             if (CurrentIndex >= ByteCount)
269             {
270                 break;
271             }
272 
273             BufChar = ByteData[CurrentIndex];
274             if (isprint (BufChar))
275             {
276                 AcpiOsPrintf ("%c", BufChar);
277             }
278             else
279             {
280                 AcpiOsPrintf (".");
281             }
282         }
283 
284         /* Finished with this line */
285 
286         AcpiOsPrintf ("\n");
287     }
288 }
289 
290 
291 /*******************************************************************************
292  *
293  * FUNCTION:    AcpiDmByteList
294  *
295  * PARAMETERS:  Info            - Parse tree walk info
296  *              Op              - Byte list op
297  *
298  * RETURN:      None
299  *
300  * DESCRIPTION: Dump a buffer byte list, handling the various types of buffers.
301  *              Buffer type must be already set in the Op DisasmOpcode.
302  *
303  ******************************************************************************/
304 
305 void
AcpiDmByteList(ACPI_OP_WALK_INFO * Info,ACPI_PARSE_OBJECT * Op)306 AcpiDmByteList (
307     ACPI_OP_WALK_INFO       *Info,
308     ACPI_PARSE_OBJECT       *Op)
309 {
310     UINT8                   *ByteData;
311     UINT32                  ByteCount;
312 
313 
314     ByteData = Op->Named.Data;
315     ByteCount = (UINT32) Op->Common.Value.Integer;
316 
317     /*
318      * The byte list belongs to a buffer, and can be produced by either
319      * a ResourceTemplate, Unicode, quoted string, or a plain byte list.
320      */
321     switch (Op->Common.Parent->Common.DisasmOpcode)
322     {
323     case ACPI_DASM_RESOURCE:
324 
325         AcpiDmResourceTemplate (
326             Info, Op->Common.Parent, ByteData, ByteCount);
327         break;
328 
329     case ACPI_DASM_STRING:
330 
331         AcpiDmIndent (Info->Level);
332         AcpiUtPrintString ((char *) ByteData, ACPI_UINT16_MAX);
333         AcpiOsPrintf ("\n");
334         break;
335 
336     case ACPI_DASM_UUID:
337 
338         AcpiDmUuid (Op);
339         break;
340 
341     case ACPI_DASM_UNICODE:
342 
343         AcpiDmUnicode (Op);
344         break;
345 
346     case ACPI_DASM_PLD_METHOD:
347 #if 0
348         AcpiDmDisasmByteList (Info->Level, ByteData, ByteCount);
349 #endif
350         AcpiDmPldBuffer (Info->Level, ByteData, ByteCount);
351         break;
352 
353     case ACPI_DASM_BUFFER:
354     default:
355         /*
356          * Not a resource, string, or unicode string.
357          * Just dump the buffer
358          */
359         AcpiDmDisasmByteList (Info->Level, ByteData, ByteCount);
360         break;
361     }
362 }
363 
364 
365 /*******************************************************************************
366  *
367  * FUNCTION:    AcpiDmIsUuidBuffer
368  *
369  * PARAMETERS:  Op              - Buffer Object to be examined
370  *
371  * RETURN:      TRUE if buffer contains a UUID
372  *
373  * DESCRIPTION: Determine if a buffer Op contains a UUID
374  *
375  * To help determine whether the buffer is a UUID versus a raw data buffer,
376  * there a are a couple bytes we can look at:
377  *
378  *    xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx
379  *
380  * The variant covered by the UUID specification is indicated by the two most
381  * significant bits of N being 1 0 (i.e., the hexadecimal N will always be
382  * 8, 9, A, or B).
383  *
384  * The variant covered by the UUID specification has five versions. For this
385  * variant, the four bits of M indicates the UUID version (i.e., the
386  * hexadecimal M will be either 1, 2, 3, 4, or 5).
387  *
388  ******************************************************************************/
389 
390 BOOLEAN
AcpiDmIsUuidBuffer(ACPI_PARSE_OBJECT * Op)391 AcpiDmIsUuidBuffer (
392     ACPI_PARSE_OBJECT       *Op)
393 {
394     UINT8                   *ByteData;
395     UINT32                  ByteCount;
396     ACPI_PARSE_OBJECT       *SizeOp;
397     ACPI_PARSE_OBJECT       *NextOp;
398 
399 
400     /* Buffer size is the buffer argument */
401 
402     SizeOp = Op->Common.Value.Arg;
403 
404     /* Next, the initializer byte list to examine */
405 
406     NextOp = SizeOp->Common.Next;
407     if (!NextOp)
408     {
409         return (FALSE);
410     }
411 
412     /* Extract the byte list info */
413 
414     ByteData = NextOp->Named.Data;
415     ByteCount = (UINT32) NextOp->Common.Value.Integer;
416 
417     /* Byte count must be exactly 16 */
418 
419     if (ByteCount != UUID_BUFFER_LENGTH)
420     {
421         return (FALSE);
422     }
423 
424     /* Check for valid "M" and "N" values (see function header above) */
425 
426     if (((ByteData[7] & 0xF0) == 0x00) || /* M={1,2,3,4,5} */
427         ((ByteData[7] & 0xF0) > 0x50)  ||
428         ((ByteData[8] & 0xF0) < 0x80)  || /* N={8,9,A,B} */
429         ((ByteData[8] & 0xF0) > 0xB0))
430     {
431         return (FALSE);
432     }
433 
434     /* Ignore the Size argument in the disassembly of this buffer op */
435 
436     SizeOp->Common.DisasmFlags |= ACPI_PARSEOP_IGNORE;
437     return (TRUE);
438 }
439 
440 
441 /*******************************************************************************
442  *
443  * FUNCTION:    AcpiDmUuid
444  *
445  * PARAMETERS:  Op              - Byte List op containing a UUID
446  *
447  * RETURN:      None
448  *
449  * DESCRIPTION: Dump a buffer containing a UUID as a standard ASCII string.
450  *
451  * Output Format:
452  * In its canonical form, the UUID is represented by a string containing 32
453  * lowercase hexadecimal digits, displayed in 5 groups separated by hyphens.
454  * The complete form is 8-4-4-4-12 for a total of 36 characters (32
455  * alphanumeric characters representing hex digits and 4 hyphens). In bytes,
456  * 4-2-2-2-6. Example:
457  *
458  *    ToUUID ("107ededd-d381-4fd7-8da9-08e9a6c79644")
459  *
460  ******************************************************************************/
461 
462 static void
AcpiDmUuid(ACPI_PARSE_OBJECT * Op)463 AcpiDmUuid (
464     ACPI_PARSE_OBJECT       *Op)
465 {
466     UINT8                   *Data;
467     const char              *Description;
468 
469 
470     Data = ACPI_CAST_PTR (UINT8, Op->Named.Data);
471 
472     /* Emit the 36-byte UUID string in the proper format/order */
473 
474     AcpiOsPrintf (
475         "\"%2.2x%2.2x%2.2x%2.2x-"
476         "%2.2x%2.2x-"
477         "%2.2x%2.2x-"
478         "%2.2x%2.2x-"
479         "%2.2x%2.2x%2.2x%2.2x%2.2x%2.2x\")",
480         Data[3], Data[2], Data[1], Data[0],
481         Data[5], Data[4],
482         Data[7], Data[6],
483         Data[8], Data[9],
484         Data[10], Data[11], Data[12], Data[13], Data[14], Data[15]);
485 
486 #ifdef ACPI_APPLICATION
487     /* Dump the UUID description string if available */
488 
489     Description = AcpiAhMatchUuid (Data);
490     if (Description)
491     {
492         AcpiOsPrintf (" /* %s */", Description);
493     }
494 #endif
495 }
496 
497 
498 /*******************************************************************************
499  *
500  * FUNCTION:    AcpiDmIsUnicodeBuffer
501  *
502  * PARAMETERS:  Op              - Buffer Object to be examined
503  *
504  * RETURN:      TRUE if buffer contains a UNICODE string
505  *
506  * DESCRIPTION: Determine if a buffer Op contains a Unicode string
507  *
508  ******************************************************************************/
509 
510 BOOLEAN
AcpiDmIsUnicodeBuffer(ACPI_PARSE_OBJECT * Op)511 AcpiDmIsUnicodeBuffer (
512     ACPI_PARSE_OBJECT       *Op)
513 {
514     UINT8                   *ByteData;
515     UINT32                  ByteCount;
516     UINT32                  WordCount;
517     ACPI_PARSE_OBJECT       *SizeOp;
518     ACPI_PARSE_OBJECT       *NextOp;
519     UINT32                  i;
520 
521 
522     /* Buffer size is the buffer argument */
523 
524     SizeOp = Op->Common.Value.Arg;
525 
526     /* Next, the initializer byte list to examine */
527 
528     NextOp = SizeOp->Common.Next;
529     if (!NextOp)
530     {
531         return (FALSE);
532     }
533 
534     /* Extract the byte list info */
535 
536     ByteData = NextOp->Named.Data;
537     ByteCount = (UINT32) NextOp->Common.Value.Integer;
538     WordCount = ACPI_DIV_2 (ByteCount);
539 
540     /*
541      * Unicode string must have an even number of bytes and last
542      * word must be zero
543      */
544     if ((!ByteCount)     ||
545          (ByteCount < 4) ||
546          (ByteCount & 1) ||
547         ((UINT16 *) (void *) ByteData)[WordCount - 1] != 0)
548     {
549         return (FALSE);
550     }
551 
552     /*
553      * For each word, 1st byte must be printable ascii, and the
554      * 2nd byte must be zero. This does not allow for escape
555      * sequences, but it is the most secure way to detect a
556      * unicode string.
557      */
558     for (i = 0; i < (ByteCount - 2); i += 2)
559     {
560         if ((ByteData[i] == 0) ||
561             !(isprint (ByteData[i])) ||
562             (ByteData[(ACPI_SIZE) i + 1] != 0))
563         {
564             return (FALSE);
565         }
566     }
567 
568     /* Ignore the Size argument in the disassembly of this buffer op */
569 
570     SizeOp->Common.DisasmFlags |= ACPI_PARSEOP_IGNORE;
571     return (TRUE);
572 }
573 
574 
575 /*******************************************************************************
576  *
577  * FUNCTION:    AcpiDmIsStringBuffer
578  *
579  * PARAMETERS:  Op              - Buffer Object to be examined
580  *
581  * RETURN:      TRUE if buffer contains a ASCII string, FALSE otherwise
582  *
583  * DESCRIPTION: Determine if a buffer Op contains a ASCII string
584  *
585  ******************************************************************************/
586 
587 BOOLEAN
AcpiDmIsStringBuffer(ACPI_PARSE_OBJECT * Op)588 AcpiDmIsStringBuffer (
589     ACPI_PARSE_OBJECT       *Op)
590 {
591     UINT8                   *ByteData;
592     UINT32                  ByteCount;
593     ACPI_PARSE_OBJECT       *SizeOp;
594     ACPI_PARSE_OBJECT       *NextOp;
595     UINT32                  i;
596 
597 
598     /* Buffer size is the buffer argument */
599 
600     SizeOp = Op->Common.Value.Arg;
601 
602     /* Next, the initializer byte list to examine */
603 
604     NextOp = SizeOp->Common.Next;
605     if (!NextOp)
606     {
607         return (FALSE);
608     }
609 
610     /* Extract the byte list info */
611 
612     ByteData = NextOp->Named.Data;
613     ByteCount = (UINT32) NextOp->Common.Value.Integer;
614 
615     /* Last byte must be the null terminator */
616 
617     if ((!ByteCount)     ||
618          (ByteCount < 2) ||
619          (ByteData[ByteCount-1] != 0))
620     {
621         return (FALSE);
622     }
623 
624     /*
625      * Check for a possible standalone resource EndTag, ignore it
626      * here. However, this sequence is also the string "Y", but
627      * this seems rare enough to be acceptable.
628      */
629     if ((ByteCount == 2) && (ByteData[0] == 0x79))
630     {
631         return (FALSE);
632     }
633 
634     /* Check all bytes for ASCII */
635 
636     for (i = 0; i < (ByteCount - 1); i++)
637     {
638         /*
639          * TBD: allow some escapes (non-ascii chars).
640          * they will be handled in the string output routine
641          */
642 
643         /* Not a string if not printable ascii */
644 
645         if (!isprint (ByteData[i]))
646         {
647             return (FALSE);
648         }
649     }
650 
651     return (TRUE);
652 }
653 
654 
655 /*******************************************************************************
656  *
657  * FUNCTION:    AcpiDmIsPldBuffer
658  *
659  * PARAMETERS:  Op                  - Buffer Object to be examined
660  *
661  * RETURN:      TRUE if buffer appears to contain data produced via the
662  *              ToPLD macro, FALSE otherwise
663  *
664  * DESCRIPTION: Determine if a buffer Op contains a _PLD structure
665  *
666  ******************************************************************************/
667 
668 BOOLEAN
AcpiDmIsPldBuffer(ACPI_PARSE_OBJECT * Op)669 AcpiDmIsPldBuffer (
670     ACPI_PARSE_OBJECT       *Op)
671 {
672     ACPI_NAMESPACE_NODE     *Node;
673     ACPI_PARSE_OBJECT       *SizeOp;
674     ACPI_PARSE_OBJECT       *ByteListOp;
675     ACPI_PARSE_OBJECT       *ParentOp;
676     UINT64                  BufferSize;
677     UINT64                  InitializerSize;
678 
679 
680     /*
681      * Get the BufferSize argument - Buffer(BufferSize)
682      * If the buffer was generated by the ToPld macro, it must
683      * be a BYTE constant.
684      */
685     SizeOp = Op->Common.Value.Arg;
686     if (SizeOp->Common.AmlOpcode != AML_BYTE_OP)
687     {
688         return (FALSE);
689     }
690 
691     /* Check the declared BufferSize, two possibilities */
692 
693     BufferSize = SizeOp->Common.Value.Integer;
694     if ((BufferSize != ACPI_PLD_REV1_BUFFER_SIZE) &&
695         (BufferSize != ACPI_PLD_REV2_BUFFER_SIZE))
696     {
697         return (FALSE);
698     }
699 
700     /*
701      * Check the initializer list length. This is the actual
702      * number of bytes in the buffer as counted by the AML parser.
703      * The declared BufferSize can be larger than the actual length.
704      * However, for the ToPLD macro, the BufferSize will be the same
705      * as the initializer list length.
706      */
707     ByteListOp = SizeOp->Common.Next;
708     if (!ByteListOp)
709     {
710         return (FALSE); /* Zero-length buffer case */
711     }
712 
713     InitializerSize = ByteListOp->Common.Value.Integer;
714     if ((InitializerSize != ACPI_PLD_REV1_BUFFER_SIZE) &&
715         (InitializerSize != ACPI_PLD_REV2_BUFFER_SIZE))
716     {
717         return (FALSE);
718     }
719 
720     /* Final size check */
721 
722     if (BufferSize != InitializerSize)
723     {
724         return (FALSE);
725     }
726 
727     /* Now examine the buffer parent */
728 
729     ParentOp = Op->Common.Parent;
730     if (!ParentOp)
731     {
732         return (FALSE);
733     }
734 
735     /* Check for form: Name(_PLD, Buffer() {}). Not legal, however */
736 
737     if (ParentOp->Common.AmlOpcode == AML_NAME_OP)
738     {
739         Node = ParentOp->Common.Node;
740 
741         if (ACPI_COMPARE_NAME (Node->Name.Ascii, METHOD_NAME__PLD))
742         {
743             /* Ignore the Size argument in the disassembly of this buffer op */
744 
745             SizeOp->Common.DisasmFlags |= ACPI_PARSEOP_IGNORE;
746             return (TRUE);
747         }
748 
749         return (FALSE);
750     }
751 
752     /*
753      * Check for proper form: Name(_PLD, Package() {ToPLD()})
754      *
755      * Note: All other forms such as
756      *      Return (Package() {ToPLD()})
757      *      Local0 = ToPLD()
758      * etc. are not converted back to the ToPLD macro, because
759      * there is really no deterministic way to disassemble the buffer
760      * back to the ToPLD macro, other than trying to find the "_PLD"
761      * name
762      */
763     if (ParentOp->Common.AmlOpcode == AML_PACKAGE_OP)
764     {
765         ParentOp = ParentOp->Common.Parent;
766         if (!ParentOp)
767         {
768             return (FALSE);
769         }
770 
771         if (ParentOp->Common.AmlOpcode == AML_NAME_OP)
772         {
773             Node = ParentOp->Common.Node;
774 
775             if (ACPI_COMPARE_NAME (Node->Name.Ascii, METHOD_NAME__PLD))
776             {
777                 /* Ignore the Size argument in the disassembly of this buffer op */
778 
779                 SizeOp->Common.DisasmFlags |= ACPI_PARSEOP_IGNORE;
780                 return (TRUE);
781             }
782         }
783     }
784 
785     return (FALSE);
786 }
787 
788 
789 /*******************************************************************************
790  *
791  * FUNCTION:    AcpiDmFindNameByIndex
792  *
793  * PARAMETERS:  Index               - Index of array to check
794  *              List                - Array to reference
795  *
796  * RETURN:      String from List or empty string
797  *
798  * DESCRIPTION: Finds and returns the char string located at the given index
799  *              position in List.
800  *
801  ******************************************************************************/
802 
803 static const char *
AcpiDmFindNameByIndex(UINT64 Index,const char ** List)804 AcpiDmFindNameByIndex (
805     UINT64                  Index,
806     const char              **List)
807 {
808     const char              *NameString;
809     UINT32                  i;
810 
811 
812     /* Bounds check */
813 
814     NameString = List[0];
815     i = 0;
816 
817     while (NameString)
818     {
819         i++;
820         NameString = List[i];
821     }
822 
823     if (Index >= i)
824     {
825         /* TBD: Add error msg */
826 
827         return ("");
828     }
829 
830     return (List[Index]);
831 }
832 
833 
834 /*******************************************************************************
835  *
836  * FUNCTION:    AcpiDmPldBuffer
837  *
838  * PARAMETERS:  Level               - Current source code indentation level
839  *              ByteData            - Pointer to the byte list
840  *              ByteCount           - Length of the byte list
841  *
842  * RETURN:      None
843  *
844  * DESCRIPTION: Dump and format the contents of a _PLD buffer object
845  *
846  ******************************************************************************/
847 
848 #define ACPI_PLD_OUTPUT08   "%*.s%-22s = 0x%X,\n", ACPI_MUL_4 (Level), " "
849 #define ACPI_PLD_OUTPUT08P  "%*.s%-22s = 0x%X)\n", ACPI_MUL_4 (Level), " "
850 #define ACPI_PLD_OUTPUT16   "%*.s%-22s = 0x%X,\n", ACPI_MUL_4 (Level), " "
851 #define ACPI_PLD_OUTPUT16P  "%*.s%-22s = 0x%X)\n", ACPI_MUL_4 (Level), " "
852 #define ACPI_PLD_OUTPUT24   "%*.s%-22s = 0x%X,\n", ACPI_MUL_4 (Level), " "
853 #define ACPI_PLD_OUTPUTSTR  "%*.s%-22s = \"%s\",\n", ACPI_MUL_4 (Level), " "
854 
855 static void
AcpiDmPldBuffer(UINT32 Level,UINT8 * ByteData,UINT32 ByteCount)856 AcpiDmPldBuffer (
857     UINT32                  Level,
858     UINT8                   *ByteData,
859     UINT32                  ByteCount)
860 {
861     ACPI_PLD_INFO           *PldInfo;
862     ACPI_STATUS             Status;
863 
864 
865     /* Check for valid byte count */
866 
867     if (ByteCount < ACPI_PLD_REV1_BUFFER_SIZE)
868     {
869         return;
870     }
871 
872     /* Convert _PLD buffer to local _PLD struct */
873 
874     Status = AcpiDecodePldBuffer (ByteData, ByteCount, &PldInfo);
875     if (ACPI_FAILURE (Status))
876     {
877         return;
878     }
879 
880     AcpiOsPrintf ("\n");
881 
882     /* First 32-bit dword */
883 
884     AcpiOsPrintf (ACPI_PLD_OUTPUT08,  "PLD_Revision", PldInfo->Revision);
885     AcpiOsPrintf (ACPI_PLD_OUTPUT08,  "PLD_IgnoreColor", PldInfo->IgnoreColor);
886     AcpiOsPrintf (ACPI_PLD_OUTPUT08,  "PLD_Red", PldInfo->Red);
887     AcpiOsPrintf (ACPI_PLD_OUTPUT08,  "PLD_Green", PldInfo->Green);
888     AcpiOsPrintf (ACPI_PLD_OUTPUT08,  "PLD_Blue", PldInfo->Blue);
889 
890     /* Second 32-bit dword */
891 
892     AcpiOsPrintf (ACPI_PLD_OUTPUT16,  "PLD_Width", PldInfo->Width);
893     AcpiOsPrintf (ACPI_PLD_OUTPUT16,  "PLD_Height", PldInfo->Height);
894 
895     /* Third 32-bit dword */
896 
897     AcpiOsPrintf (ACPI_PLD_OUTPUT08,  "PLD_UserVisible", PldInfo->UserVisible);
898     AcpiOsPrintf (ACPI_PLD_OUTPUT08,  "PLD_Dock", PldInfo->Dock);
899     AcpiOsPrintf (ACPI_PLD_OUTPUT08,  "PLD_Lid", PldInfo->Lid);
900     AcpiOsPrintf (ACPI_PLD_OUTPUTSTR, "PLD_Panel",
901         AcpiDmFindNameByIndex(PldInfo->Panel, AcpiGbl_PldPanelList));
902 
903     AcpiOsPrintf (ACPI_PLD_OUTPUTSTR, "PLD_VerticalPosition",
904         AcpiDmFindNameByIndex(PldInfo->VerticalPosition, AcpiGbl_PldVerticalPositionList));
905 
906     AcpiOsPrintf (ACPI_PLD_OUTPUTSTR, "PLD_HorizontalPosition",
907         AcpiDmFindNameByIndex(PldInfo->HorizontalPosition, AcpiGbl_PldHorizontalPositionList));
908 
909     AcpiOsPrintf (ACPI_PLD_OUTPUTSTR, "PLD_Shape",
910         AcpiDmFindNameByIndex(PldInfo->Shape, AcpiGbl_PldShapeList));
911     AcpiOsPrintf (ACPI_PLD_OUTPUT08,  "PLD_GroupOrientation", PldInfo->GroupOrientation);
912 
913     AcpiOsPrintf (ACPI_PLD_OUTPUT08,  "PLD_GroupToken", PldInfo->GroupToken);
914     AcpiOsPrintf (ACPI_PLD_OUTPUT08,  "PLD_GroupPosition", PldInfo->GroupPosition);
915     AcpiOsPrintf (ACPI_PLD_OUTPUT08,  "PLD_Bay", PldInfo->Bay);
916 
917     /* Fourth 32-bit dword */
918 
919     AcpiOsPrintf (ACPI_PLD_OUTPUT08,  "PLD_Ejectable", PldInfo->Ejectable);
920     AcpiOsPrintf (ACPI_PLD_OUTPUT08,  "PLD_EjectRequired", PldInfo->OspmEjectRequired);
921     AcpiOsPrintf (ACPI_PLD_OUTPUT08,  "PLD_CabinetNumber", PldInfo->CabinetNumber);
922     AcpiOsPrintf (ACPI_PLD_OUTPUT08,  "PLD_CardCageNumber", PldInfo->CardCageNumber);
923     AcpiOsPrintf (ACPI_PLD_OUTPUT08,  "PLD_Reference", PldInfo->Reference);
924     AcpiOsPrintf (ACPI_PLD_OUTPUT08,  "PLD_Rotation", PldInfo->Rotation);
925 
926     if (ByteCount >= ACPI_PLD_REV2_BUFFER_SIZE)
927     {
928         AcpiOsPrintf (ACPI_PLD_OUTPUT08, "PLD_Order", PldInfo->Order);
929 
930         /* Fifth 32-bit dword */
931 
932         AcpiOsPrintf (ACPI_PLD_OUTPUT16,  "PLD_VerticalOffset", PldInfo->VerticalOffset);
933         AcpiOsPrintf (ACPI_PLD_OUTPUT16P, "PLD_HorizontalOffset", PldInfo->HorizontalOffset);
934     }
935     else /* Rev 1 buffer */
936     {
937         AcpiOsPrintf (ACPI_PLD_OUTPUT08P, "PLD_Order", PldInfo->Order);
938     }
939 
940     ACPI_FREE (PldInfo);
941 }
942 
943 
944 /*******************************************************************************
945  *
946  * FUNCTION:    AcpiDmUnicode
947  *
948  * PARAMETERS:  Op              - Byte List op containing Unicode string
949  *
950  * RETURN:      None
951  *
952  * DESCRIPTION: Dump Unicode string as a standard ASCII string. (Remove
953  *              the extra zero bytes).
954  *
955  ******************************************************************************/
956 
957 static void
AcpiDmUnicode(ACPI_PARSE_OBJECT * Op)958 AcpiDmUnicode (
959     ACPI_PARSE_OBJECT       *Op)
960 {
961     UINT16                  *WordData;
962     UINT32                  WordCount;
963     UINT32                  i;
964     int                     OutputValue;
965 
966 
967     /* Extract the buffer info as a WORD buffer */
968 
969     WordData = ACPI_CAST_PTR (UINT16, Op->Named.Data);
970     WordCount = ACPI_DIV_2 (((UINT32) Op->Common.Value.Integer));
971 
972     /* Write every other byte as an ASCII character */
973 
974     AcpiOsPrintf ("\"");
975     for (i = 0; i < (WordCount - 1); i++)
976     {
977         OutputValue = (int) WordData[i];
978 
979         /* Handle values that must be escaped */
980 
981         if ((OutputValue == '\"') ||
982             (OutputValue == '\\'))
983         {
984             AcpiOsPrintf ("\\%c", OutputValue);
985         }
986         else if (!isprint (OutputValue))
987         {
988             AcpiOsPrintf ("\\x%2.2X", OutputValue);
989         }
990         else
991         {
992             AcpiOsPrintf ("%c", OutputValue);
993         }
994     }
995 
996     AcpiOsPrintf ("\")");
997 }
998 
999 
1000 /*******************************************************************************
1001  *
1002  * FUNCTION:    AcpiDmGetHardwareIdType
1003  *
1004  * PARAMETERS:  Op              - Op to be examined
1005  *
1006  * RETURN:      None
1007  *
1008  * DESCRIPTION: Determine the type of the argument to a _HID or _CID
1009  *              1) Strings are allowed
1010  *              2) If Integer, determine if it is a valid EISAID
1011  *
1012  ******************************************************************************/
1013 
1014 static void
AcpiDmGetHardwareIdType(ACPI_PARSE_OBJECT * Op)1015 AcpiDmGetHardwareIdType (
1016     ACPI_PARSE_OBJECT       *Op)
1017 {
1018     UINT32                  BigEndianId;
1019     UINT32                  Prefix[3];
1020     UINT32                  i;
1021 
1022 
1023     switch (Op->Common.AmlOpcode)
1024     {
1025     case AML_STRING_OP:
1026 
1027         /* Mark this string as an _HID/_CID string */
1028 
1029         Op->Common.DisasmOpcode = ACPI_DASM_HID_STRING;
1030         break;
1031 
1032     case AML_WORD_OP:
1033     case AML_DWORD_OP:
1034 
1035         /* Determine if a Word/Dword is a valid encoded EISAID */
1036 
1037         /* Swap from little-endian to big-endian to simplify conversion */
1038 
1039         BigEndianId = AcpiUtDwordByteSwap ((UINT32) Op->Common.Value.Integer);
1040 
1041         /* Create the 3 leading ASCII letters */
1042 
1043         Prefix[0] = ((BigEndianId >> 26) & 0x1F) + 0x40;
1044         Prefix[1] = ((BigEndianId >> 21) & 0x1F) + 0x40;
1045         Prefix[2] = ((BigEndianId >> 16) & 0x1F) + 0x40;
1046 
1047         /* Verify that all 3 are ascii and alpha */
1048 
1049         for (i = 0; i < 3; i++)
1050         {
1051             if (!ACPI_IS_ASCII (Prefix[i]) ||
1052                 !isalpha (Prefix[i]))
1053             {
1054                 return;
1055             }
1056         }
1057 
1058         /* Mark this node as convertable to an EISA ID string */
1059 
1060         Op->Common.DisasmOpcode = ACPI_DASM_EISAID;
1061         break;
1062 
1063     default:
1064         break;
1065     }
1066 }
1067 
1068 
1069 /*******************************************************************************
1070  *
1071  * FUNCTION:    AcpiDmCheckForHardwareId
1072  *
1073  * PARAMETERS:  Op              - Op to be examined
1074  *
1075  * RETURN:      None
1076  *
1077  * DESCRIPTION: Determine if a Name() Op is a _HID/_CID.
1078  *
1079  ******************************************************************************/
1080 
1081 void
AcpiDmCheckForHardwareId(ACPI_PARSE_OBJECT * Op)1082 AcpiDmCheckForHardwareId (
1083     ACPI_PARSE_OBJECT       *Op)
1084 {
1085     UINT32                  Name;
1086     ACPI_PARSE_OBJECT       *NextOp;
1087 
1088 
1089     /* Get the NameSegment */
1090 
1091     Name = AcpiPsGetName (Op);
1092     if (!Name)
1093     {
1094         return;
1095     }
1096 
1097     NextOp = AcpiPsGetDepthNext (NULL, Op);
1098     if (!NextOp)
1099     {
1100         return;
1101     }
1102 
1103     /* Check for _HID - has one argument */
1104 
1105     if (ACPI_COMPARE_NAME (&Name, METHOD_NAME__HID))
1106     {
1107         AcpiDmGetHardwareIdType (NextOp);
1108         return;
1109     }
1110 
1111     /* Exit if not _CID */
1112 
1113     if (!ACPI_COMPARE_NAME (&Name, METHOD_NAME__CID))
1114     {
1115         return;
1116     }
1117 
1118     /* _CID can contain a single argument or a package */
1119 
1120     if (NextOp->Common.AmlOpcode != AML_PACKAGE_OP)
1121     {
1122         AcpiDmGetHardwareIdType (NextOp);
1123         return;
1124     }
1125 
1126     /* _CID with Package: get the package length, check all elements */
1127 
1128     NextOp = AcpiPsGetDepthNext (NULL, NextOp);
1129     if (!NextOp)
1130     {
1131         return;
1132     }
1133 
1134     /* Don't need to use the length, just walk the peer list */
1135 
1136     NextOp = NextOp->Common.Next;
1137     while (NextOp)
1138     {
1139         AcpiDmGetHardwareIdType (NextOp);
1140         NextOp = NextOp->Common.Next;
1141     }
1142 }
1143 
1144 
1145 /*******************************************************************************
1146  *
1147  * FUNCTION:    AcpiDmDecompressEisaId
1148  *
1149  * PARAMETERS:  EncodedId       - Raw encoded EISA ID.
1150  *
1151  * RETURN:      None
1152  *
1153  * DESCRIPTION: Convert an encoded EISAID back to the original ASCII String
1154  *              and emit the correct ASL statement. If the ID is known, emit
1155  *              a description of the ID as a comment.
1156  *
1157  ******************************************************************************/
1158 
1159 void
AcpiDmDecompressEisaId(UINT32 EncodedId)1160 AcpiDmDecompressEisaId (
1161     UINT32                  EncodedId)
1162 {
1163     char                    IdBuffer[ACPI_EISAID_STRING_SIZE];
1164     const AH_DEVICE_ID      *Info;
1165 
1166 
1167     /* Convert EISAID to a string an emit the statement */
1168 
1169     AcpiExEisaIdToString (IdBuffer, EncodedId);
1170     AcpiOsPrintf ("EisaId (\"%s\")", IdBuffer);
1171 
1172     /* If we know about the ID, emit the description */
1173 
1174     Info = AcpiAhMatchHardwareId (IdBuffer);
1175     if (Info)
1176     {
1177         AcpiOsPrintf (" /* %s */", Info->Description);
1178     }
1179 }
1180