dbconvert.c

  1// SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0
  2/*******************************************************************************
  3 *
  4 * Module Name: dbconvert - debugger miscellaneous conversion routines
  5 *
  6 ******************************************************************************/
  7
  8#include <acpi/acpi.h>
  9#include "accommon.h"
 10#include "acdebug.h"
 11
 12#define _COMPONENT          ACPI_CA_DEBUGGER
 13ACPI_MODULE_NAME("dbconvert")
 14
 15#define DB_DEFAULT_PKG_ELEMENTS     33
 16/*******************************************************************************
 17 *
 18 * FUNCTION:    acpi_db_hex_char_to_value
 19 *
 20 * PARAMETERS:  hex_char            - Ascii Hex digit, 0-9|a-f|A-F
 21 *              return_value        - Where the converted value is returned
 22 *
 23 * RETURN:      Status
 24 *
 25 * DESCRIPTION: Convert a single hex character to a 4-bit number (0-16).
 26 *
 27 ******************************************************************************/
 28acpi_status acpi_db_hex_char_to_value(int hex_char, u8 *return_value)
 29{
 30	u8 value;
 31
 32	/* Digit must be ascii [0-9a-fA-F] */
 33
 34	if (!isxdigit(hex_char)) {
 35		return (AE_BAD_HEX_CONSTANT);
 36	}
 37
 38	if (hex_char <= 0x39) {
 39		value = (u8)(hex_char - 0x30);
 40	} else {
 41		value = (u8)(toupper(hex_char) - 0x37);
 42	}
 43
 44	*return_value = value;
 45	return (AE_OK);
 46}
 47
 48/*******************************************************************************
 49 *
 50 * FUNCTION:    acpi_db_hex_byte_to_binary
 51 *
 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
 55 *
 56 * RETURN:      Status
 57 *
 58 * DESCRIPTION: Convert two hex characters to an 8 bit number (0 - 255).
 59 *
 60 ******************************************************************************/
 61
 62static acpi_status acpi_db_hex_byte_to_binary(char *hex_byte, u8 *return_value)
 63{
 64	u8 local0;
 65	u8 local1;
 66	acpi_status status;
 67
 68	/* High byte */
 69
 70	status = acpi_db_hex_char_to_value(hex_byte[0], &local0);
 71	if (ACPI_FAILURE(status)) {
 72		return (status);
 73	}
 74
 75	/* Low byte */
 76
 77	status = acpi_db_hex_char_to_value(hex_byte[1], &local1);
 78	if (ACPI_FAILURE(status)) {
 79		return (status);
 80	}
 81
 82	*return_value = (u8)((local0 << 4) | local1);
 83	return (AE_OK);
 84}
 85
 86/*******************************************************************************
 87 *
 88 * FUNCTION:    acpi_db_convert_to_buffer
 89 *
 90 * PARAMETERS:  string              - Input string to be converted
 91 *              object              - Where the buffer object is returned
 92 *
 93 * RETURN:      Status
 94 *
 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.
 97 *
 98 ******************************************************************************/
 99
100static acpi_status
101acpi_db_convert_to_buffer(char *string, union acpi_object *object)
102{
103	u32 i;
104	u32 j;
105	u32 length;
106	u8 *buffer;
107	acpi_status status;
108
109	/* Skip all preceding white space */
110
111	acpi_ut_remove_whitespace(&string);
112
113	/* Generate the final buffer length */
114
115	for (i = 0, length = 0; string[i];) {
116		i += 2;
117		length++;
118
119		while (string[i] && ((string[i] == ',') || (string[i] == ' '))) {
120			i++;
121		}
122	}
123
124	buffer = ACPI_ALLOCATE(length);
125	if (!buffer) {
126		return (AE_NO_MEMORY);
127	}
128
129	/* Convert the command line bytes to the buffer */
130
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)) {
134			ACPI_FREE(buffer);
135			return (status);
136		}
137
138		j++;
139		i += 2;
140		while (string[i] && ((string[i] == ',') || (string[i] == ' '))) {
141			i++;
142		}
143	}
144
145	object->type = ACPI_TYPE_BUFFER;
146	object->buffer.pointer = buffer;
147	object->buffer.length = length;
148	return (AE_OK);
149}
150
151/*******************************************************************************
152 *
153 * FUNCTION:    acpi_db_convert_to_package
154 *
155 * PARAMETERS:  string              - Input string to be converted
156 *              object              - Where the package object is returned
157 *
158 * RETURN:      Status
159 *
160 * DESCRIPTION: Convert a string to a package object. Handles nested packages
161 *              via recursion with acpi_db_convert_to_object.
162 *
163 ******************************************************************************/
164
165acpi_status acpi_db_convert_to_package(char *string, union acpi_object *object)
166{
167	char *this;
168	char *next;
169	u32 i;
170	acpi_object_type type;
171	union acpi_object *elements;
172	acpi_status status;
173
174	elements =
175	    ACPI_ALLOCATE_ZEROED(DB_DEFAULT_PKG_ELEMENTS *
176				 sizeof(union acpi_object));
177	if (!elements)
178		return (AE_NO_MEMORY);
179
180	this = string;
181	for (i = 0; i < (DB_DEFAULT_PKG_ELEMENTS - 1); i++) {
182		this = acpi_db_get_next_token(this, &next, &type);
183		if (!this) {
184			break;
185		}
186
187		/* Recursive call to convert each package element */
188
189		status = acpi_db_convert_to_object(type, this, &elements[i]);
190		if (ACPI_FAILURE(status)) {
191			acpi_db_delete_objects(i + 1, elements);
192			ACPI_FREE(elements);
193			return (status);
194		}
195
196		this = next;
197	}
198
199	object->type = ACPI_TYPE_PACKAGE;
200	object->package.count = i;
201	object->package.elements = elements;
202	return (AE_OK);
203}
204
205/*******************************************************************************
206 *
207 * FUNCTION:    acpi_db_convert_to_object
208 *
209 * PARAMETERS:  type                - Object type as determined by parser
210 *              string              - Input string to be converted
211 *              object              - Where the new object is returned
212 *
213 * RETURN:      Status
214 *
215 * DESCRIPTION: Convert a typed and tokenized string to a union acpi_object. Typing:
216 *              1) String objects were surrounded by quotes.
217 *              2) Buffer objects were surrounded by parentheses.
218 *              3) Package objects were surrounded by brackets "[]".
219 *              4) All standalone tokens are treated as integers.
220 *
221 ******************************************************************************/
222
223acpi_status
224acpi_db_convert_to_object(acpi_object_type type,
225			  char *string, union acpi_object *object)
226{
227	acpi_status status = AE_OK;
228
229	switch (type) {
230	case ACPI_TYPE_STRING:
231
232		object->type = ACPI_TYPE_STRING;
233		object->string.pointer = string;
234		object->string.length = (u32)strlen(string);
235		break;
236
237	case ACPI_TYPE_BUFFER:
238
239		status = acpi_db_convert_to_buffer(string, object);
240		break;
241
242	case ACPI_TYPE_PACKAGE:
243
244		status = acpi_db_convert_to_package(string, object);
245		break;
246
247	default:
248
249		object->type = ACPI_TYPE_INTEGER;
250		status = acpi_ut_strtoul64(string, &object->integer.value);
251		break;
252	}
253
254	return (status);
255}
256
257/*******************************************************************************
258 *
259 * FUNCTION:    acpi_db_encode_pld_buffer
260 *
261 * PARAMETERS:  pld_info            - _PLD buffer struct (Using local struct)
262 *
263 * RETURN:      Encode _PLD buffer suitable for return value from _PLD
264 *
265 * DESCRIPTION: Bit-packs a _PLD buffer struct. Used to test the _PLD macros
266 *
267 ******************************************************************************/
268
269u8 *acpi_db_encode_pld_buffer(struct acpi_pld_info *pld_info)
270{
271	u32 *buffer;
272	u32 dword;
273
274	buffer = ACPI_ALLOCATE_ZEROED(ACPI_PLD_BUFFER_SIZE);
275	if (!buffer) {
276		return (NULL);
277	}
278
279	/* First 32 bits */
280
281	dword = 0;
282	ACPI_PLD_SET_REVISION(&dword, pld_info->revision);
283	ACPI_PLD_SET_IGNORE_COLOR(&dword, pld_info->ignore_color);
284	ACPI_PLD_SET_RED(&dword, pld_info->red);
285	ACPI_PLD_SET_GREEN(&dword, pld_info->green);
286	ACPI_PLD_SET_BLUE(&dword, pld_info->blue);
287	ACPI_MOVE_32_TO_32(&buffer[0], &dword);
288
289	/* Second 32 bits */
290
291	dword = 0;
292	ACPI_PLD_SET_WIDTH(&dword, pld_info->width);
293	ACPI_PLD_SET_HEIGHT(&dword, pld_info->height);
294	ACPI_MOVE_32_TO_32(&buffer[1], &dword);
295
296	/* Third 32 bits */
297
298	dword = 0;
299	ACPI_PLD_SET_USER_VISIBLE(&dword, pld_info->user_visible);
300	ACPI_PLD_SET_DOCK(&dword, pld_info->dock);
301	ACPI_PLD_SET_LID(&dword, pld_info->lid);
302	ACPI_PLD_SET_PANEL(&dword, pld_info->panel);
303	ACPI_PLD_SET_VERTICAL(&dword, pld_info->vertical_position);
304	ACPI_PLD_SET_HORIZONTAL(&dword, pld_info->horizontal_position);
305	ACPI_PLD_SET_SHAPE(&dword, pld_info->shape);
306	ACPI_PLD_SET_ORIENTATION(&dword, pld_info->group_orientation);
307	ACPI_PLD_SET_TOKEN(&dword, pld_info->group_token);
308	ACPI_PLD_SET_POSITION(&dword, pld_info->group_position);
309	ACPI_PLD_SET_BAY(&dword, pld_info->bay);
310	ACPI_MOVE_32_TO_32(&buffer[2], &dword);
311
312	/* Fourth 32 bits */
313
314	dword = 0;
315	ACPI_PLD_SET_EJECTABLE(&dword, pld_info->ejectable);
316	ACPI_PLD_SET_OSPM_EJECT(&dword, pld_info->ospm_eject_required);
317	ACPI_PLD_SET_CABINET(&dword, pld_info->cabinet_number);
318	ACPI_PLD_SET_CARD_CAGE(&dword, pld_info->card_cage_number);
319	ACPI_PLD_SET_REFERENCE(&dword, pld_info->reference);
320	ACPI_PLD_SET_ROTATION(&dword, pld_info->rotation);
321	ACPI_PLD_SET_ORDER(&dword, pld_info->order);
322	ACPI_MOVE_32_TO_32(&buffer[3], &dword);
323
324	if (pld_info->revision >= 2) {
325
326		/* Fifth 32 bits */
327
328		dword = 0;
329		ACPI_PLD_SET_VERT_OFFSET(&dword, pld_info->vertical_offset);
330		ACPI_PLD_SET_HORIZ_OFFSET(&dword, pld_info->horizontal_offset);
331		ACPI_MOVE_32_TO_32(&buffer[4], &dword);
332	}
333
334	return (ACPI_CAST_PTR(u8, buffer));
335}
336
337/*******************************************************************************
338 *
339 * FUNCTION:    acpi_db_dump_pld_buffer
340 *
341 * PARAMETERS:  obj_desc            - Object returned from _PLD method
342 *
343 * RETURN:      None.
344 *
345 * DESCRIPTION: Dumps formatted contents of a _PLD return buffer.
346 *
347 ******************************************************************************/
348
349#define ACPI_PLD_OUTPUT     "%20s : %-6X\n"
350
351void acpi_db_dump_pld_buffer(union acpi_object *obj_desc)
352{
353	union acpi_object *buffer_desc;
354	struct acpi_pld_info *pld_info;
355	u8 *new_buffer;
356	acpi_status status;
357
358	/* Object must be of type Package with at least one Buffer element */
359
360	if (obj_desc->type != ACPI_TYPE_PACKAGE) {
361		return;
362	}
363
364	buffer_desc = &obj_desc->package.elements[0];
365	if (buffer_desc->type != ACPI_TYPE_BUFFER) {
366		return;
367	}
368
369	/* Convert _PLD buffer to local _PLD struct */
370
371	status = acpi_decode_pld_buffer(buffer_desc->buffer.pointer,
372					buffer_desc->buffer.length, &pld_info);
373	if (ACPI_FAILURE(status)) {
374		return;
375	}
376
377	/* Encode local _PLD struct back to a _PLD buffer */
378
379	new_buffer = acpi_db_encode_pld_buffer(pld_info);
380	if (!new_buffer) {
381		goto exit;
382	}
383
384	/* The two bit-packed buffers should match */
385
386	if (memcmp(new_buffer, buffer_desc->buffer.pointer,
387		   buffer_desc->buffer.length)) {
388		acpi_os_printf
389		    ("Converted _PLD buffer does not compare. New:\n");
390
391		acpi_ut_dump_buffer(new_buffer,
392				    buffer_desc->buffer.length, DB_BYTE_DISPLAY,
393				    0);
394	}
395
396	/* First 32-bit dword */
397
398	acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_Revision", pld_info->revision);
399	acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_IgnoreColor",
400		       pld_info->ignore_color);
401	acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_Red", pld_info->red);
402	acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_Green", pld_info->green);
403	acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_Blue", pld_info->blue);
404
405	/* Second 32-bit dword */
406
407	acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_Width", pld_info->width);
408	acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_Height", pld_info->height);
409
410	/* Third 32-bit dword */
411
412	acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_UserVisible",
413		       pld_info->user_visible);
414	acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_Dock", pld_info->dock);
415	acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_Lid", pld_info->lid);
416	acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_Panel", pld_info->panel);
417	acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_VerticalPosition",
418		       pld_info->vertical_position);
419	acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_HorizontalPosition",
420		       pld_info->horizontal_position);
421	acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_Shape", pld_info->shape);
422	acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_GroupOrientation",
423		       pld_info->group_orientation);
424	acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_GroupToken",
425		       pld_info->group_token);
426	acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_GroupPosition",
427		       pld_info->group_position);
428	acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_Bay", pld_info->bay);
429
430	/* Fourth 32-bit dword */
431
432	acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_Ejectable", pld_info->ejectable);
433	acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_EjectRequired",
434		       pld_info->ospm_eject_required);
435	acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_CabinetNumber",
436		       pld_info->cabinet_number);
437	acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_CardCageNumber",
438		       pld_info->card_cage_number);
439	acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_Reference", pld_info->reference);
440	acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_Rotation", pld_info->rotation);
441	acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_Order", pld_info->order);
442
443	/* Fifth 32-bit dword */
444
445	if (buffer_desc->buffer.length > 16) {
446		acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_VerticalOffset",
447			       pld_info->vertical_offset);
448		acpi_os_printf(ACPI_PLD_OUTPUT, "PLD_HorizontalOffset",
449			       pld_info->horizontal_offset);
450	}
451
452	ACPI_FREE(new_buffer);
453exit:
454	ACPI_FREE(pld_info);
455}