1 /*******************************************************************************
3 * Module Name: dbconvert - debugger miscellaneous conversion routines
5 ******************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2019, Intel Corp.
12 * All rights reserved.
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
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
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;
37 * The above copyright and patent license is granted only if the following
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.
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
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
72 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
80 * 4. Disclaimer and Export Compliance
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
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
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.
114 *****************************************************************************
116 * Alternatively, you may choose to be licensed under the terms of the
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
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.
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.
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.
150 *****************************************************************************/
152 #include <contrib/dev/acpica/include/acpi.h>
153 #include <contrib/dev/acpica/include/accommon.h>
154 #include <contrib/dev/acpica/include/acdebug.h>
157 #define _COMPONENT ACPI_CA_DEBUGGER
158 ACPI_MODULE_NAME ("dbconvert")
161 #define DB_DEFAULT_PKG_ELEMENTS 33
164 /*******************************************************************************
166 * FUNCTION: AcpiDbHexCharToValue
168 * PARAMETERS: HexChar - Ascii Hex digit, 0-9|a-f|A-F
169 * ReturnValue - Where the converted value is returned
173 * DESCRIPTION: Convert a single hex character to a 4-bit number (0-16).
175 ******************************************************************************/
178 AcpiDbHexCharToValue (
185 /* Digit must be ascii [0-9a-fA-F] */
187 if (!isxdigit (HexChar))
189 return (AE_BAD_HEX_CONSTANT);
194 Value = (UINT8) (HexChar - 0x30);
198 Value = (UINT8) (toupper (HexChar) - 0x37);
201 *ReturnValue = Value;
206 /*******************************************************************************
208 * FUNCTION: AcpiDbHexByteToBinary
210 * PARAMETERS: HexByte - Double hex digit (0x00 - 0xFF) in format:
211 * HiByte then LoByte.
212 * ReturnValue - Where the converted value is returned
216 * DESCRIPTION: Convert two hex characters to an 8 bit number (0 - 255).
218 ******************************************************************************/
221 AcpiDbHexByteToBinary (
232 Status = AcpiDbHexCharToValue (HexByte[0], &Local0);
233 if (ACPI_FAILURE (Status))
240 Status = AcpiDbHexCharToValue (HexByte[1], &Local1);
241 if (ACPI_FAILURE (Status))
246 *ReturnValue = (UINT8) ((Local0 << 4) | Local1);
251 /*******************************************************************************
253 * FUNCTION: AcpiDbConvertToBuffer
255 * PARAMETERS: String - Input string to be converted
256 * Object - Where the buffer object is returned
260 * DESCRIPTION: Convert a string to a buffer object. String is treated a list
261 * of buffer elements, each separated by a space or comma.
263 ******************************************************************************/
266 AcpiDbConvertToBuffer (
277 /* Skip all preceding white space*/
279 AcpiUtRemoveWhitespace (&String);
281 /* Generate the final buffer length */
283 for (i = 0, Length = 0; String[i];)
289 ((String[i] == ',') || (String[i] == ' ')))
295 Buffer = ACPI_ALLOCATE (Length);
298 return (AE_NO_MEMORY);
301 /* Convert the command line bytes to the buffer */
303 for (i = 0, j = 0; String[i];)
305 Status = AcpiDbHexByteToBinary (&String[i], &Buffer[j]);
306 if (ACPI_FAILURE (Status))
315 ((String[i] == ',') || (String[i] == ' ')))
321 Object->Type = ACPI_TYPE_BUFFER;
322 Object->Buffer.Pointer = Buffer;
323 Object->Buffer.Length = Length;
328 /*******************************************************************************
330 * FUNCTION: AcpiDbConvertToPackage
332 * PARAMETERS: String - Input string to be converted
333 * Object - Where the package object is returned
337 * DESCRIPTION: Convert a string to a package object. Handles nested packages
338 * via recursion with AcpiDbConvertToObject.
340 ******************************************************************************/
343 AcpiDbConvertToPackage (
350 ACPI_OBJECT_TYPE Type;
351 ACPI_OBJECT *Elements;
355 Elements = ACPI_ALLOCATE_ZEROED (
356 DB_DEFAULT_PKG_ELEMENTS * sizeof (ACPI_OBJECT));
359 for (i = 0; i < (DB_DEFAULT_PKG_ELEMENTS - 1); i++)
361 This = AcpiDbGetNextToken (This, &Next, &Type);
367 /* Recursive call to convert each package element */
369 Status = AcpiDbConvertToObject (Type, This, &Elements[i]);
370 if (ACPI_FAILURE (Status))
372 AcpiDbDeleteObjects (i + 1, Elements);
373 ACPI_FREE (Elements);
380 Object->Type = ACPI_TYPE_PACKAGE;
381 Object->Package.Count = i;
382 Object->Package.Elements = Elements;
387 /*******************************************************************************
389 * FUNCTION: AcpiDbConvertToObject
391 * PARAMETERS: Type - Object type as determined by parser
392 * String - Input string to be converted
393 * Object - Where the new object is returned
397 * DESCRIPTION: Convert a typed and tokenized string to an ACPI_OBJECT. Typing:
398 * 1) String objects were surrounded by quotes.
399 * 2) Buffer objects were surrounded by parentheses.
400 * 3) Package objects were surrounded by brackets "[]".
401 * 4) All standalone tokens are treated as integers.
403 ******************************************************************************/
406 AcpiDbConvertToObject (
407 ACPI_OBJECT_TYPE Type,
411 ACPI_STATUS Status = AE_OK;
416 case ACPI_TYPE_STRING:
418 Object->Type = ACPI_TYPE_STRING;
419 Object->String.Pointer = String;
420 Object->String.Length = (UINT32) strlen (String);
423 case ACPI_TYPE_BUFFER:
425 Status = AcpiDbConvertToBuffer (String, Object);
428 case ACPI_TYPE_PACKAGE:
430 Status = AcpiDbConvertToPackage (String, Object);
435 Object->Type = ACPI_TYPE_INTEGER;
436 Status = AcpiUtStrtoul64 (String, &Object->Integer.Value);
444 /*******************************************************************************
446 * FUNCTION: AcpiDbEncodePldBuffer
448 * PARAMETERS: PldInfo - _PLD buffer struct (Using local struct)
450 * RETURN: Encode _PLD buffer suitable for return value from _PLD
452 * DESCRIPTION: Bit-packs a _PLD buffer struct. Used to test the _PLD macros
454 ******************************************************************************/
457 AcpiDbEncodePldBuffer (
458 ACPI_PLD_INFO *PldInfo)
464 Buffer = ACPI_ALLOCATE_ZEROED (ACPI_PLD_BUFFER_SIZE);
473 ACPI_PLD_SET_REVISION (&Dword, PldInfo->Revision);
474 ACPI_PLD_SET_IGNORE_COLOR (&Dword, PldInfo->IgnoreColor);
475 ACPI_PLD_SET_RED (&Dword, PldInfo->Red);
476 ACPI_PLD_SET_GREEN (&Dword, PldInfo->Green);
477 ACPI_PLD_SET_BLUE (&Dword, PldInfo->Blue);
478 ACPI_MOVE_32_TO_32 (&Buffer[0], &Dword);
483 ACPI_PLD_SET_WIDTH (&Dword, PldInfo->Width);
484 ACPI_PLD_SET_HEIGHT (&Dword, PldInfo->Height);
485 ACPI_MOVE_32_TO_32 (&Buffer[1], &Dword);
490 ACPI_PLD_SET_USER_VISIBLE (&Dword, PldInfo->UserVisible);
491 ACPI_PLD_SET_DOCK (&Dword, PldInfo->Dock);
492 ACPI_PLD_SET_LID (&Dword, PldInfo->Lid);
493 ACPI_PLD_SET_PANEL (&Dword, PldInfo->Panel);
494 ACPI_PLD_SET_VERTICAL (&Dword, PldInfo->VerticalPosition);
495 ACPI_PLD_SET_HORIZONTAL (&Dword, PldInfo->HorizontalPosition);
496 ACPI_PLD_SET_SHAPE (&Dword, PldInfo->Shape);
497 ACPI_PLD_SET_ORIENTATION (&Dword, PldInfo->GroupOrientation);
498 ACPI_PLD_SET_TOKEN (&Dword, PldInfo->GroupToken);
499 ACPI_PLD_SET_POSITION (&Dword, PldInfo->GroupPosition);
500 ACPI_PLD_SET_BAY (&Dword, PldInfo->Bay);
501 ACPI_MOVE_32_TO_32 (&Buffer[2], &Dword);
506 ACPI_PLD_SET_EJECTABLE (&Dword, PldInfo->Ejectable);
507 ACPI_PLD_SET_OSPM_EJECT (&Dword, PldInfo->OspmEjectRequired);
508 ACPI_PLD_SET_CABINET (&Dword, PldInfo->CabinetNumber);
509 ACPI_PLD_SET_CARD_CAGE (&Dword, PldInfo->CardCageNumber);
510 ACPI_PLD_SET_REFERENCE (&Dword, PldInfo->Reference);
511 ACPI_PLD_SET_ROTATION (&Dword, PldInfo->Rotation);
512 ACPI_PLD_SET_ORDER (&Dword, PldInfo->Order);
513 ACPI_MOVE_32_TO_32 (&Buffer[3], &Dword);
515 if (PldInfo->Revision >= 2)
520 ACPI_PLD_SET_VERT_OFFSET (&Dword, PldInfo->VerticalOffset);
521 ACPI_PLD_SET_HORIZ_OFFSET (&Dword, PldInfo->HorizontalOffset);
522 ACPI_MOVE_32_TO_32 (&Buffer[4], &Dword);
525 return (ACPI_CAST_PTR (UINT8, Buffer));
529 /*******************************************************************************
531 * FUNCTION: AcpiDbDumpPldBuffer
533 * PARAMETERS: ObjDesc - Object returned from _PLD method
537 * DESCRIPTION: Dumps formatted contents of a _PLD return buffer.
539 ******************************************************************************/
541 #define ACPI_PLD_OUTPUT "%20s : %-6X\n"
544 AcpiDbDumpPldBuffer (
545 ACPI_OBJECT *ObjDesc)
547 ACPI_OBJECT *BufferDesc;
548 ACPI_PLD_INFO *PldInfo;
553 /* Object must be of type Package with at least one Buffer element */
555 if (ObjDesc->Type != ACPI_TYPE_PACKAGE)
560 BufferDesc = &ObjDesc->Package.Elements[0];
561 if (BufferDesc->Type != ACPI_TYPE_BUFFER)
566 /* Convert _PLD buffer to local _PLD struct */
568 Status = AcpiDecodePldBuffer (BufferDesc->Buffer.Pointer,
569 BufferDesc->Buffer.Length, &PldInfo);
570 if (ACPI_FAILURE (Status))
575 /* Encode local _PLD struct back to a _PLD buffer */
577 NewBuffer = AcpiDbEncodePldBuffer (PldInfo);
583 /* The two bit-packed buffers should match */
585 if (memcmp (NewBuffer, BufferDesc->Buffer.Pointer,
586 BufferDesc->Buffer.Length))
588 AcpiOsPrintf ("Converted _PLD buffer does not compare. New:\n");
590 AcpiUtDumpBuffer (NewBuffer,
591 BufferDesc->Buffer.Length, DB_BYTE_DISPLAY, 0);
594 /* First 32-bit dword */
596 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_Revision", PldInfo->Revision);
597 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_IgnoreColor", PldInfo->IgnoreColor);
598 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_Red", PldInfo->Red);
599 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_Green", PldInfo->Green);
600 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_Blue", PldInfo->Blue);
602 /* Second 32-bit dword */
604 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_Width", PldInfo->Width);
605 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_Height", PldInfo->Height);
607 /* Third 32-bit dword */
609 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_UserVisible", PldInfo->UserVisible);
610 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_Dock", PldInfo->Dock);
611 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_Lid", PldInfo->Lid);
612 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_Panel", PldInfo->Panel);
613 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_VerticalPosition", PldInfo->VerticalPosition);
614 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_HorizontalPosition", PldInfo->HorizontalPosition);
615 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_Shape", PldInfo->Shape);
616 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_GroupOrientation", PldInfo->GroupOrientation);
617 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_GroupToken", PldInfo->GroupToken);
618 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_GroupPosition", PldInfo->GroupPosition);
619 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_Bay", PldInfo->Bay);
621 /* Fourth 32-bit dword */
623 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_Ejectable", PldInfo->Ejectable);
624 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_EjectRequired", PldInfo->OspmEjectRequired);
625 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_CabinetNumber", PldInfo->CabinetNumber);
626 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_CardCageNumber", PldInfo->CardCageNumber);
627 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_Reference", PldInfo->Reference);
628 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_Rotation", PldInfo->Rotation);
629 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_Order", PldInfo->Order);
631 /* Fifth 32-bit dword */
633 if (BufferDesc->Buffer.Length > 16)
635 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_VerticalOffset", PldInfo->VerticalOffset);
636 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_HorizontalOffset", PldInfo->HorizontalOffset);
639 ACPI_FREE (NewBuffer);