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