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