1 // SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0
2 /*******************************************************************************
4 * Module Name: dbconvert - debugger miscellaneous conversion routines
6 ******************************************************************************/
12 #define _COMPONENT ACPI_CA_DEBUGGER
13 ACPI_MODULE_NAME("dbconvert")
15 #define DB_DEFAULT_PKG_ELEMENTS 33
16 /*******************************************************************************
18 * FUNCTION: acpi_db_hex_char_to_value
20 * PARAMETERS: hex_char - Ascii Hex digit, 0-9|a-f|A-F
21 * return_value - Where the converted value is returned
25 * DESCRIPTION: Convert a single hex character to a 4-bit number (0-16).
27 ******************************************************************************/
28 acpi_status acpi_db_hex_char_to_value(int hex_char, u8 *return_value)
32 /* Digit must be ascii [0-9a-fA-F] */
34 if (!isxdigit(hex_char)) {
35 return (AE_BAD_HEX_CONSTANT);
38 if (hex_char <= 0x39) {
39 value = (u8)(hex_char - 0x30);
41 value = (u8)(toupper(hex_char) - 0x37);
44 *return_value = value;
48 /*******************************************************************************
50 * FUNCTION: acpi_db_hex_byte_to_binary
52 * PARAMETERS: hex_byte - Double hex digit (0x00 - 0xFF) in format:
53 * hi_byte then lo_byte.
54 * return_value - Where the converted value is returned
58 * DESCRIPTION: Convert two hex characters to an 8 bit number (0 - 255).
60 ******************************************************************************/
62 static acpi_status acpi_db_hex_byte_to_binary(char *hex_byte, u8 *return_value)
70 status = acpi_db_hex_char_to_value(hex_byte[0], &local0);
71 if (ACPI_FAILURE(status)) {
77 status = acpi_db_hex_char_to_value(hex_byte[1], &local1);
78 if (ACPI_FAILURE(status)) {
82 *return_value = (u8)((local0 << 4) | local1);
86 /*******************************************************************************
88 * FUNCTION: acpi_db_convert_to_buffer
90 * PARAMETERS: string - Input string to be converted
91 * object - Where the buffer object is returned
95 * DESCRIPTION: Convert a string to a buffer object. String is treated a list
96 * of buffer elements, each separated by a space or comma.
98 ******************************************************************************/
101 acpi_db_convert_to_buffer(char *string, union acpi_object *object)
109 /* Skip all preceding white space */
111 acpi_ut_remove_whitespace(&string);
113 /* Generate the final buffer length */
115 for (i = 0, length = 0; string[i];) {
119 while (string[i] && ((string[i] == ',') || (string[i] == ' '))) {
124 buffer = ACPI_ALLOCATE(length);
126 return (AE_NO_MEMORY);
129 /* Convert the command line bytes to the buffer */
131 for (i = 0, j = 0; string[i];) {
132 status = acpi_db_hex_byte_to_binary(&string[i], &buffer[j]);
133 if (ACPI_FAILURE(status)) {
140 while (string[i] && ((string[i] == ',') || (string[i] == ' '))) {
145 object->type = ACPI_TYPE_BUFFER;
146 object->buffer.pointer = buffer;
147 object->buffer.length = length;
151 /*******************************************************************************
153 * FUNCTION: acpi_db_convert_to_package
155 * PARAMETERS: string - Input string to be converted
156 * object - Where the package object is returned
160 * DESCRIPTION: Convert a string to a package object. Handles nested packages
161 * via recursion with acpi_db_convert_to_object.
163 ******************************************************************************/
165 acpi_status acpi_db_convert_to_package(char *string, union acpi_object *object)
170 acpi_object_type type;
171 union acpi_object *elements;
175 ACPI_ALLOCATE_ZEROED(DB_DEFAULT_PKG_ELEMENTS *
176 sizeof(union acpi_object));
179 for (i = 0; i < (DB_DEFAULT_PKG_ELEMENTS - 1); i++) {
180 this = acpi_db_get_next_token(this, &next, &type);
185 /* Recursive call to convert each package element */
187 status = acpi_db_convert_to_object(type, this, &elements[i]);
188 if (ACPI_FAILURE(status)) {
189 acpi_db_delete_objects(i + 1, elements);
197 object->type = ACPI_TYPE_PACKAGE;
198 object->package.count = i;
199 object->package.elements = elements;
203 /*******************************************************************************
205 * FUNCTION: acpi_db_convert_to_object
207 * PARAMETERS: type - Object type as determined by parser
208 * string - Input string to be converted
209 * object - Where the new object is returned
213 * DESCRIPTION: Convert a typed and tokenized string to a union acpi_object. Typing:
214 * 1) String objects were surrounded by quotes.
215 * 2) Buffer objects were surrounded by parentheses.
216 * 3) Package objects were surrounded by brackets "[]".
217 * 4) All standalone tokens are treated as integers.
219 ******************************************************************************/
222 acpi_db_convert_to_object(acpi_object_type type,
223 char *string, union acpi_object *object)
225 acpi_status status = AE_OK;
228 case ACPI_TYPE_STRING:
230 object->type = ACPI_TYPE_STRING;
231 object->string.pointer = string;
232 object->string.length = (u32)strlen(string);
235 case ACPI_TYPE_BUFFER:
237 status = acpi_db_convert_to_buffer(string, object);
240 case ACPI_TYPE_PACKAGE:
242 status = acpi_db_convert_to_package(string, object);
247 object->type = ACPI_TYPE_INTEGER;
248 status = acpi_ut_strtoul64(string, &object->integer.value);
255 /*******************************************************************************
257 * FUNCTION: acpi_db_encode_pld_buffer
259 * PARAMETERS: pld_info - _PLD buffer struct (Using local struct)
261 * RETURN: Encode _PLD buffer suitable for return value from _PLD
263 * DESCRIPTION: Bit-packs a _PLD buffer struct. Used to test the _PLD macros
265 ******************************************************************************/
267 u8 *acpi_db_encode_pld_buffer(struct acpi_pld_info *pld_info)
272 buffer = ACPI_ALLOCATE_ZEROED(ACPI_PLD_BUFFER_SIZE);
280 ACPI_PLD_SET_REVISION(&dword, pld_info->revision);
281 ACPI_PLD_SET_IGNORE_COLOR(&dword, pld_info->ignore_color);
282 ACPI_PLD_SET_RED(&dword, pld_info->red);
283 ACPI_PLD_SET_GREEN(&dword, pld_info->green);
284 ACPI_PLD_SET_BLUE(&dword, pld_info->blue);
285 ACPI_MOVE_32_TO_32(&buffer[0], &dword);
290 ACPI_PLD_SET_WIDTH(&dword, pld_info->width);
291 ACPI_PLD_SET_HEIGHT(&dword, pld_info->height);
292 ACPI_MOVE_32_TO_32(&buffer[1], &dword);
297 ACPI_PLD_SET_USER_VISIBLE(&dword, pld_info->user_visible);
298 ACPI_PLD_SET_DOCK(&dword, pld_info->dock);
299 ACPI_PLD_SET_LID(&dword, pld_info->lid);
300 ACPI_PLD_SET_PANEL(&dword, pld_info->panel);
301 ACPI_PLD_SET_VERTICAL(&dword, pld_info->vertical_position);
302 ACPI_PLD_SET_HORIZONTAL(&dword, pld_info->horizontal_position);
303 ACPI_PLD_SET_SHAPE(&dword, pld_info->shape);
304 ACPI_PLD_SET_ORIENTATION(&dword, pld_info->group_orientation);
305 ACPI_PLD_SET_TOKEN(&dword, pld_info->group_token);
306 ACPI_PLD_SET_POSITION(&dword, pld_info->group_position);
307 ACPI_PLD_SET_BAY(&dword, pld_info->bay);
308 ACPI_MOVE_32_TO_32(&buffer[2], &dword);
313 ACPI_PLD_SET_EJECTABLE(&dword, pld_info->ejectable);
314 ACPI_PLD_SET_OSPM_EJECT(&dword, pld_info->ospm_eject_required);
315 ACPI_PLD_SET_CABINET(&dword, pld_info->cabinet_number);
316 ACPI_PLD_SET_CARD_CAGE(&dword, pld_info->card_cage_number);
317 ACPI_PLD_SET_REFERENCE(&dword, pld_info->reference);
318 ACPI_PLD_SET_ROTATION(&dword, pld_info->rotation);
319 ACPI_PLD_SET_ORDER(&dword, pld_info->order);
320 ACPI_MOVE_32_TO_32(&buffer[3], &dword);
322 if (pld_info->revision >= 2) {
327 ACPI_PLD_SET_VERT_OFFSET(&dword, pld_info->vertical_offset);
328 ACPI_PLD_SET_HORIZ_OFFSET(&dword, pld_info->horizontal_offset);
329 ACPI_MOVE_32_TO_32(&buffer[4], &dword);
332 return (ACPI_CAST_PTR(u8, buffer));
335 /*******************************************************************************
337 * FUNCTION: acpi_db_dump_pld_buffer
339 * PARAMETERS: obj_desc - Object returned from _PLD method
343 * DESCRIPTION: Dumps formatted contents of a _PLD return buffer.
345 ******************************************************************************/
347 #define ACPI_PLD_OUTPUT "%20s : %-6X\n"
349 void acpi_db_dump_pld_buffer(union acpi_object *obj_desc)
351 union acpi_object *buffer_desc;
352 struct acpi_pld_info *pld_info;
356 /* Object must be of type Package with at least one Buffer element */
358 if (obj_desc->type != ACPI_TYPE_PACKAGE) {
362 buffer_desc = &obj_desc->package.elements[0];
363 if (buffer_desc->type != ACPI_TYPE_BUFFER) {
367 /* Convert _PLD buffer to local _PLD struct */
369 status = acpi_decode_pld_buffer(buffer_desc->buffer.pointer,
370 buffer_desc->buffer.length, &pld_info);
371 if (ACPI_FAILURE(status)) {
375 /* Encode local _PLD struct back to a _PLD buffer */
377 new_buffer = acpi_db_encode_pld_buffer(pld_info);
382 /* The two bit-packed buffers should match */
384 if (memcmp(new_buffer, buffer_desc->buffer.pointer,
385 buffer_desc->buffer.length)) {
387 ("Converted _PLD buffer does not compare. New:\n");
389 acpi_ut_dump_buffer(new_buffer,
390 buffer_desc->buffer.length, DB_BYTE_DISPLAY,
394 /* First 32-bit dword */
396 acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_Revision", pld_info->revision);
397 acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_IgnoreColor",
398 pld_info->ignore_color);
399 acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_Red", pld_info->red);
400 acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_Green", pld_info->green);
401 acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_Blue", pld_info->blue);
403 /* Second 32-bit dword */
405 acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_Width", pld_info->width);
406 acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_Height", pld_info->height);
408 /* Third 32-bit dword */
410 acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_UserVisible",
411 pld_info->user_visible);
412 acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_Dock", pld_info->dock);
413 acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_Lid", pld_info->lid);
414 acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_Panel", pld_info->panel);
415 acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_VerticalPosition",
416 pld_info->vertical_position);
417 acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_HorizontalPosition",
418 pld_info->horizontal_position);
419 acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_Shape", pld_info->shape);
420 acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_GroupOrientation",
421 pld_info->group_orientation);
422 acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_GroupToken",
423 pld_info->group_token);
424 acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_GroupPosition",
425 pld_info->group_position);
426 acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_Bay", pld_info->bay);
428 /* Fourth 32-bit dword */
430 acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_Ejectable", pld_info->ejectable);
431 acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_EjectRequired",
432 pld_info->ospm_eject_required);
433 acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_CabinetNumber",
434 pld_info->cabinet_number);
435 acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_CardCageNumber",
436 pld_info->card_cage_number);
437 acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_Reference", pld_info->reference);
438 acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_Rotation", pld_info->rotation);
439 acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_Order", pld_info->order);
441 /* Fifth 32-bit dword */
443 if (buffer_desc->buffer.length > 16) {
444 acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_VerticalOffset",
445 pld_info->vertical_offset);
446 acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_HorizontalOffset",
447 pld_info->horizontal_offset);
450 ACPI_FREE(new_buffer);