1 /*******************************************************************************
3 * Module Name: dbconvert - debugger miscellaneous conversion routines
5 ******************************************************************************/
8 * Copyright (C) 2000 - 2016, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
44 #include <contrib/dev/acpica/include/acpi.h>
45 #include <contrib/dev/acpica/include/accommon.h>
46 #include <contrib/dev/acpica/include/acdebug.h>
49 #define _COMPONENT ACPI_CA_DEBUGGER
50 ACPI_MODULE_NAME ("dbconvert")
53 #define DB_DEFAULT_PKG_ELEMENTS 33
56 /*******************************************************************************
58 * FUNCTION: AcpiDbHexCharToValue
60 * PARAMETERS: HexChar - Ascii Hex digit, 0-9|a-f|A-F
61 * ReturnValue - Where the converted value is returned
65 * DESCRIPTION: Convert a single hex character to a 4-bit number (0-16).
67 ******************************************************************************/
70 AcpiDbHexCharToValue (
77 /* Digit must be ascii [0-9a-fA-F] */
79 if (!isxdigit (HexChar))
81 return (AE_BAD_HEX_CONSTANT);
86 Value = (UINT8) (HexChar - 0x30);
90 Value = (UINT8) (toupper (HexChar) - 0x37);
98 /*******************************************************************************
100 * FUNCTION: AcpiDbHexByteToBinary
102 * PARAMETERS: HexByte - Double hex digit (0x00 - 0xFF) in format:
103 * HiByte then LoByte.
104 * ReturnValue - Where the converted value is returned
108 * DESCRIPTION: Convert two hex characters to an 8 bit number (0 - 255).
110 ******************************************************************************/
113 AcpiDbHexByteToBinary (
124 Status = AcpiDbHexCharToValue (HexByte[0], &Local0);
125 if (ACPI_FAILURE (Status))
132 Status = AcpiDbHexCharToValue (HexByte[1], &Local1);
133 if (ACPI_FAILURE (Status))
138 *ReturnValue = (UINT8) ((Local0 << 4) | Local1);
143 /*******************************************************************************
145 * FUNCTION: AcpiDbConvertToBuffer
147 * PARAMETERS: String - Input string to be converted
148 * Object - Where the buffer object is returned
152 * DESCRIPTION: Convert a string to a buffer object. String is treated a list
153 * of buffer elements, each separated by a space or comma.
155 ******************************************************************************/
158 AcpiDbConvertToBuffer (
169 /* Generate the final buffer length */
171 for (i = 0, Length = 0; String[i];)
177 ((String[i] == ',') || (String[i] == ' ')))
183 Buffer = ACPI_ALLOCATE (Length);
186 return (AE_NO_MEMORY);
189 /* Convert the command line bytes to the buffer */
191 for (i = 0, j = 0; String[i];)
193 Status = AcpiDbHexByteToBinary (&String[i], &Buffer[j]);
194 if (ACPI_FAILURE (Status))
203 ((String[i] == ',') || (String[i] == ' ')))
209 Object->Type = ACPI_TYPE_BUFFER;
210 Object->Buffer.Pointer = Buffer;
211 Object->Buffer.Length = Length;
216 /*******************************************************************************
218 * FUNCTION: AcpiDbConvertToPackage
220 * PARAMETERS: String - Input string to be converted
221 * Object - Where the package object is returned
225 * DESCRIPTION: Convert a string to a package object. Handles nested packages
226 * via recursion with AcpiDbConvertToObject.
228 ******************************************************************************/
231 AcpiDbConvertToPackage (
238 ACPI_OBJECT_TYPE Type;
239 ACPI_OBJECT *Elements;
243 Elements = ACPI_ALLOCATE_ZEROED (
244 DB_DEFAULT_PKG_ELEMENTS * sizeof (ACPI_OBJECT));
247 for (i = 0; i < (DB_DEFAULT_PKG_ELEMENTS - 1); i++)
249 This = AcpiDbGetNextToken (This, &Next, &Type);
255 /* Recursive call to convert each package element */
257 Status = AcpiDbConvertToObject (Type, This, &Elements[i]);
258 if (ACPI_FAILURE (Status))
260 AcpiDbDeleteObjects (i + 1, Elements);
261 ACPI_FREE (Elements);
268 Object->Type = ACPI_TYPE_PACKAGE;
269 Object->Package.Count = i;
270 Object->Package.Elements = Elements;
275 /*******************************************************************************
277 * FUNCTION: AcpiDbConvertToObject
279 * PARAMETERS: Type - Object type as determined by parser
280 * String - Input string to be converted
281 * Object - Where the new object is returned
285 * DESCRIPTION: Convert a typed and tokenized string to an ACPI_OBJECT. Typing:
286 * 1) String objects were surrounded by quotes.
287 * 2) Buffer objects were surrounded by parentheses.
288 * 3) Package objects were surrounded by brackets "[]".
289 * 4) All standalone tokens are treated as integers.
291 ******************************************************************************/
294 AcpiDbConvertToObject (
295 ACPI_OBJECT_TYPE Type,
299 ACPI_STATUS Status = AE_OK;
304 case ACPI_TYPE_STRING:
306 Object->Type = ACPI_TYPE_STRING;
307 Object->String.Pointer = String;
308 Object->String.Length = (UINT32) strlen (String);
311 case ACPI_TYPE_BUFFER:
313 Status = AcpiDbConvertToBuffer (String, Object);
316 case ACPI_TYPE_PACKAGE:
318 Status = AcpiDbConvertToPackage (String, Object);
323 Object->Type = ACPI_TYPE_INTEGER;
324 Status = AcpiUtStrtoul64 (String,
325 (AcpiGbl_IntegerByteWidth | ACPI_STRTOUL_BASE16),
326 &Object->Integer.Value);
334 /*******************************************************************************
336 * FUNCTION: AcpiDbEncodePldBuffer
338 * PARAMETERS: PldInfo - _PLD buffer struct (Using local struct)
340 * RETURN: Encode _PLD buffer suitable for return value from _PLD
342 * DESCRIPTION: Bit-packs a _PLD buffer struct. Used to test the _PLD macros
344 ******************************************************************************/
347 AcpiDbEncodePldBuffer (
348 ACPI_PLD_INFO *PldInfo)
354 Buffer = ACPI_ALLOCATE_ZEROED (ACPI_PLD_BUFFER_SIZE);
363 ACPI_PLD_SET_REVISION (&Dword, PldInfo->Revision);
364 ACPI_PLD_SET_IGNORE_COLOR (&Dword, PldInfo->IgnoreColor);
365 ACPI_PLD_SET_RED (&Dword, PldInfo->Red);
366 ACPI_PLD_SET_GREEN (&Dword, PldInfo->Green);
367 ACPI_PLD_SET_BLUE (&Dword, PldInfo->Blue);
368 ACPI_MOVE_32_TO_32 (&Buffer[0], &Dword);
373 ACPI_PLD_SET_WIDTH (&Dword, PldInfo->Width);
374 ACPI_PLD_SET_HEIGHT (&Dword, PldInfo->Height);
375 ACPI_MOVE_32_TO_32 (&Buffer[1], &Dword);
380 ACPI_PLD_SET_USER_VISIBLE (&Dword, PldInfo->UserVisible);
381 ACPI_PLD_SET_DOCK (&Dword, PldInfo->Dock);
382 ACPI_PLD_SET_LID (&Dword, PldInfo->Lid);
383 ACPI_PLD_SET_PANEL (&Dword, PldInfo->Panel);
384 ACPI_PLD_SET_VERTICAL (&Dword, PldInfo->VerticalPosition);
385 ACPI_PLD_SET_HORIZONTAL (&Dword, PldInfo->HorizontalPosition);
386 ACPI_PLD_SET_SHAPE (&Dword, PldInfo->Shape);
387 ACPI_PLD_SET_ORIENTATION (&Dword, PldInfo->GroupOrientation);
388 ACPI_PLD_SET_TOKEN (&Dword, PldInfo->GroupToken);
389 ACPI_PLD_SET_POSITION (&Dword, PldInfo->GroupPosition);
390 ACPI_PLD_SET_BAY (&Dword, PldInfo->Bay);
391 ACPI_MOVE_32_TO_32 (&Buffer[2], &Dword);
396 ACPI_PLD_SET_EJECTABLE (&Dword, PldInfo->Ejectable);
397 ACPI_PLD_SET_OSPM_EJECT (&Dword, PldInfo->OspmEjectRequired);
398 ACPI_PLD_SET_CABINET (&Dword, PldInfo->CabinetNumber);
399 ACPI_PLD_SET_CARD_CAGE (&Dword, PldInfo->CardCageNumber);
400 ACPI_PLD_SET_REFERENCE (&Dword, PldInfo->Reference);
401 ACPI_PLD_SET_ROTATION (&Dword, PldInfo->Rotation);
402 ACPI_PLD_SET_ORDER (&Dword, PldInfo->Order);
403 ACPI_MOVE_32_TO_32 (&Buffer[3], &Dword);
405 if (PldInfo->Revision >= 2)
410 ACPI_PLD_SET_VERT_OFFSET (&Dword, PldInfo->VerticalOffset);
411 ACPI_PLD_SET_HORIZ_OFFSET (&Dword, PldInfo->HorizontalOffset);
412 ACPI_MOVE_32_TO_32 (&Buffer[4], &Dword);
415 return (ACPI_CAST_PTR (UINT8, Buffer));
419 /*******************************************************************************
421 * FUNCTION: AcpiDbDumpPldBuffer
423 * PARAMETERS: ObjDesc - Object returned from _PLD method
427 * DESCRIPTION: Dumps formatted contents of a _PLD return buffer.
429 ******************************************************************************/
431 #define ACPI_PLD_OUTPUT "%20s : %-6X\n"
434 AcpiDbDumpPldBuffer (
435 ACPI_OBJECT *ObjDesc)
437 ACPI_OBJECT *BufferDesc;
438 ACPI_PLD_INFO *PldInfo;
443 /* Object must be of type Package with at least one Buffer element */
445 if (ObjDesc->Type != ACPI_TYPE_PACKAGE)
450 BufferDesc = &ObjDesc->Package.Elements[0];
451 if (BufferDesc->Type != ACPI_TYPE_BUFFER)
456 /* Convert _PLD buffer to local _PLD struct */
458 Status = AcpiDecodePldBuffer (BufferDesc->Buffer.Pointer,
459 BufferDesc->Buffer.Length, &PldInfo);
460 if (ACPI_FAILURE (Status))
465 /* Encode local _PLD struct back to a _PLD buffer */
467 NewBuffer = AcpiDbEncodePldBuffer (PldInfo);
473 /* The two bit-packed buffers should match */
475 if (memcmp (NewBuffer, BufferDesc->Buffer.Pointer,
476 BufferDesc->Buffer.Length))
478 AcpiOsPrintf ("Converted _PLD buffer does not compare. New:\n");
480 AcpiUtDumpBuffer (NewBuffer,
481 BufferDesc->Buffer.Length, DB_BYTE_DISPLAY, 0);
484 /* First 32-bit dword */
486 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_Revision", PldInfo->Revision);
487 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_IgnoreColor", PldInfo->IgnoreColor);
488 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_Red", PldInfo->Red);
489 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_Green", PldInfo->Green);
490 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_Blue", PldInfo->Blue);
492 /* Second 32-bit dword */
494 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_Width", PldInfo->Width);
495 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_Height", PldInfo->Height);
497 /* Third 32-bit dword */
499 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_UserVisible", PldInfo->UserVisible);
500 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_Dock", PldInfo->Dock);
501 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_Lid", PldInfo->Lid);
502 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_Panel", PldInfo->Panel);
503 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_VerticalPosition", PldInfo->VerticalPosition);
504 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_HorizontalPosition", PldInfo->HorizontalPosition);
505 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_Shape", PldInfo->Shape);
506 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_GroupOrientation", PldInfo->GroupOrientation);
507 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_GroupToken", PldInfo->GroupToken);
508 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_GroupPosition", PldInfo->GroupPosition);
509 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_Bay", PldInfo->Bay);
511 /* Fourth 32-bit dword */
513 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_Ejectable", PldInfo->Ejectable);
514 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_EjectRequired", PldInfo->OspmEjectRequired);
515 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_CabinetNumber", PldInfo->CabinetNumber);
516 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_CardCageNumber", PldInfo->CardCageNumber);
517 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_Reference", PldInfo->Reference);
518 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_Rotation", PldInfo->Rotation);
519 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_Order", PldInfo->Order);
521 /* Fifth 32-bit dword */
523 if (BufferDesc->Buffer.Length > 16)
525 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_VerticalOffset", PldInfo->VerticalOffset);
526 AcpiOsPrintf (ACPI_PLD_OUTPUT, "PLD_HorizontalOffset", PldInfo->HorizontalOffset);
529 ACPI_FREE (NewBuffer);