[mirror_ubuntu-artful-kernel.git] / drivers / acpi / acpica / utbuffer.c

/******************************************************************************
 *
 * Module Name: utbuffer - Buffer dump routines
 *
 *****************************************************************************/

/*
 * Copyright (C) 2000 - 2017, Intel Corp.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions, and the following disclaimer,
 *    without modification.
 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
 *    substantially similar to the "NO WARRANTY" disclaimer below
 *    ("Disclaimer") and any redistribution must be conditioned upon
 *    including a substantially similar Disclaimer requirement for further
 *    binary redistribution.
 * 3. Neither the names of the above-listed copyright holders nor the names
 *    of any contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * Alternatively, this software may be distributed under the terms of the
 * GNU General Public License ("GPL") version 2 as published by the Free
 * Software Foundation.
 *
 * NO WARRANTY
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGES.
 */

#include <acpi/acpi.h>
#include "accommon.h"

#define _COMPONENT          ACPI_UTILITIES
ACPI_MODULE_NAME("utbuffer")

/*******************************************************************************
 *
 * FUNCTION:    acpi_ut_dump_buffer
 *
 * PARAMETERS:  buffer              - Buffer to dump
 *              count               - Amount to dump, in bytes
 *              display             - BYTE, WORD, DWORD, or QWORD display:
 *                                      DB_BYTE_DISPLAY
 *                                      DB_WORD_DISPLAY
 *                                      DB_DWORD_DISPLAY
 *                                      DB_QWORD_DISPLAY
 *              base_offset         - Beginning buffer offset (display only)
 *
 * RETURN:      None
 *
 * DESCRIPTION: Generic dump buffer in both hex and ascii.
 *
 ******************************************************************************/
void acpi_ut_dump_buffer(u8 *buffer, u32 count, u32 display, u32 base_offset)
{
	u32 i = 0;
	u32 j;
	u32 temp32;
	u8 buf_char;

	if (!buffer) {
		acpi_os_printf("Null Buffer Pointer in DumpBuffer!\n");
		return;
	}

	if ((count < 4) || (count & 0x01)) {
		display = DB_BYTE_DISPLAY;
	}

	/* Nasty little dump buffer routine! */

	while (i < count) {

		/* Print current offset */

		acpi_os_printf("%6.4X: ", (base_offset + i));

		/* Print 16 hex chars */

		for (j = 0; j < 16;) {
			if (i + j >= count) {

				/* Dump fill spaces */

				acpi_os_printf("%*s", ((display * 2) + 1), " ");
				j += display;
				continue;
			}

			switch (display) {
			case DB_BYTE_DISPLAY:
			default:	/* Default is BYTE display */

				acpi_os_printf("%02X ",
					       buffer[(acpi_size)i + j]);
				break;

			case DB_WORD_DISPLAY:

				ACPI_MOVE_16_TO_32(&temp32,
						   &buffer[(acpi_size)i + j]);
				acpi_os_printf("%04X ", temp32);
				break;

			case DB_DWORD_DISPLAY:

				ACPI_MOVE_32_TO_32(&temp32,
						   &buffer[(acpi_size)i + j]);
				acpi_os_printf("%08X ", temp32);
				break;

			case DB_QWORD_DISPLAY:

				ACPI_MOVE_32_TO_32(&temp32,
						   &buffer[(acpi_size)i + j]);
				acpi_os_printf("%08X", temp32);

				ACPI_MOVE_32_TO_32(&temp32,
						   &buffer[(acpi_size)i + j +
							   4]);
				acpi_os_printf("%08X ", temp32);
				break;
			}

			j += display;
		}

		/*
		 * Print the ASCII equivalent characters but watch out for the bad
		 * unprintable ones (printable chars are 0x20 through 0x7E)
		 */
		acpi_os_printf(" ");
		for (j = 0; j < 16; j++) {
			if (i + j >= count) {
				acpi_os_printf("\n");
				return;
			}

			/*
			 * Add comment characters so rest of line is ignored when
			 * compiled
			 */
			if (j == 0) {
				acpi_os_printf("// ");
			}

			buf_char = buffer[(acpi_size)i + j];
			if (isprint(buf_char)) {
				acpi_os_printf("%c", buf_char);
			} else {
				acpi_os_printf(".");
			}
		}

		/* Done with that line. */

		acpi_os_printf("\n");
		i += 16;
	}

	return;
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ut_debug_dump_buffer
 *
 * PARAMETERS:  buffer              - Buffer to dump
 *              count               - Amount to dump, in bytes
 *              display             - BYTE, WORD, DWORD, or QWORD display:
 *                                      DB_BYTE_DISPLAY
 *                                      DB_WORD_DISPLAY
 *                                      DB_DWORD_DISPLAY
 *                                      DB_QWORD_DISPLAY
 *              component_ID        - Caller's component ID
 *
 * RETURN:      None
 *
 * DESCRIPTION: Generic dump buffer in both hex and ascii.
 *
 ******************************************************************************/

void
acpi_ut_debug_dump_buffer(u8 *buffer, u32 count, u32 display, u32 component_id)
{

	/* Only dump the buffer if tracing is enabled */

	if (!((ACPI_LV_TABLES & acpi_dbg_level) &&
	      (component_id & acpi_dbg_layer))) {
		return;
	}

	acpi_ut_dump_buffer(buffer, count, display, 0);
}

#ifdef ACPI_APPLICATION
/*******************************************************************************
 *
 * FUNCTION:    acpi_ut_dump_buffer_to_file
 *
 * PARAMETERS:  file                - File descriptor
 *              buffer              - Buffer to dump
 *              count               - Amount to dump, in bytes
 *              display             - BYTE, WORD, DWORD, or QWORD display:
 *                                      DB_BYTE_DISPLAY
 *                                      DB_WORD_DISPLAY
 *                                      DB_DWORD_DISPLAY
 *                                      DB_QWORD_DISPLAY
 *              base_offset         - Beginning buffer offset (display only)
 *
 * RETURN:      None
 *
 * DESCRIPTION: Generic dump buffer in both hex and ascii to a file.
 *
 ******************************************************************************/

void
acpi_ut_dump_buffer_to_file(ACPI_FILE file,
			    u8 *buffer, u32 count, u32 display, u32 base_offset)
{
	u32 i = 0;
	u32 j;
	u32 temp32;
	u8 buf_char;

	if (!buffer) {
		fprintf(file, "Null Buffer Pointer in DumpBuffer!\n");
		return;
	}

	if ((count < 4) || (count & 0x01)) {
		display = DB_BYTE_DISPLAY;
	}

	/* Nasty little dump buffer routine! */

	while (i < count) {

		/* Print current offset */

		fprintf(file, "%6.4X: ", (base_offset + i));

		/* Print 16 hex chars */

		for (j = 0; j < 16;) {
			if (i + j >= count) {

				/* Dump fill spaces */

				fprintf(file, "%*s", ((display * 2) + 1), " ");
				j += display;
				continue;
			}

			switch (display) {
			case DB_BYTE_DISPLAY:
			default:	/* Default is BYTE display */

				fprintf(file, "%02X ",
					buffer[(acpi_size)i + j]);
				break;

			case DB_WORD_DISPLAY:

				ACPI_MOVE_16_TO_32(&temp32,
						   &buffer[(acpi_size)i + j]);
				fprintf(file, "%04X ", temp32);
				break;

			case DB_DWORD_DISPLAY:

				ACPI_MOVE_32_TO_32(&temp32,
						   &buffer[(acpi_size)i + j]);
				fprintf(file, "%08X ", temp32);
				break;

			case DB_QWORD_DISPLAY:

				ACPI_MOVE_32_TO_32(&temp32,
						   &buffer[(acpi_size)i + j]);
				fprintf(file, "%08X", temp32);

				ACPI_MOVE_32_TO_32(&temp32,
						   &buffer[(acpi_size)i + j +
							   4]);
				fprintf(file, "%08X ", temp32);
				break;
			}

			j += display;
		}

		/*
		 * Print the ASCII equivalent characters but watch out for the bad
		 * unprintable ones (printable chars are 0x20 through 0x7E)
		 */
		fprintf(file, " ");
		for (j = 0; j < 16; j++) {
			if (i + j >= count) {
				fprintf(file, "\n");
				return;
			}

			buf_char = buffer[(acpi_size)i + j];
			if (isprint(buf_char)) {
				fprintf(file, "%c", buf_char);
			} else {
				fprintf(file, ".");
			}
		}

		/* Done with that line. */

		fprintf(file, "\n");
		i += 16;
	}

	return;
}
#endif
Commit	Line	Data
88ec2860 BM	1	/******************************************************************************
	2	*
	3	* Module Name: utbuffer - Buffer dump routines
	4	*
	5	*****************************************************************************/
	6
	7	/*
7735ca0e	8	* Copyright (C) 2000 - 2017, Intel Corp.
88ec2860 BM	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 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.
	42	*/
	43
	44	#include <acpi/acpi.h>
	45	#include "accommon.h"
	46
	47	#define _COMPONENT ACPI_UTILITIES
	48	ACPI_MODULE_NAME("utbuffer")
	49
	50	/*******************************************************************************
	51	*
	52	* FUNCTION: acpi_ut_dump_buffer
	53	*
	54	* PARAMETERS: buffer - Buffer to dump
	55	* count - Amount to dump, in bytes
	56	* display - BYTE, WORD, DWORD, or QWORD display:
	57	* DB_BYTE_DISPLAY
	58	* DB_WORD_DISPLAY
	59	* DB_DWORD_DISPLAY
	60	* DB_QWORD_DISPLAY
	61	* base_offset - Beginning buffer offset (display only)
	62	*
	63	* RETURN: None
	64	*
	65	* DESCRIPTION: Generic dump buffer in both hex and ascii.
	66	*
	67	******************************************************************************/
	68	void acpi_ut_dump_buffer(u8 *buffer, u32 count, u32 display, u32 base_offset)
	69	{
	70	u32 i = 0;
	71	u32 j;
	72	u32 temp32;
73	u8 buf_char;
74
75	if (!buffer) {
76	acpi_os_printf("Null Buffer Pointer in DumpBuffer!\n");
77	return;
78	}
79
80	if ((count < 4) \|\| (count & 0x01)) {
81	display = DB_BYTE_DISPLAY;
82	}
83
84	/* Nasty little dump buffer routine! */
85
86	while (i < count) {
87
88	/* Print current offset */
89
90	acpi_os_printf("%6.4X: ", (base_offset + i));
91
92	/* Print 16 hex chars */
93
94	for (j = 0; j < 16;) {
95	if (i + j >= count) {
96
97	/* Dump fill spaces */
98
99	acpi_os_printf("%s", ((display 2) + 1), " ");
100	j += display;
101	continue;
102	}
103
104	switch (display) {
105	case DB_BYTE_DISPLAY:
106	default: /* Default is BYTE display */
107
108	acpi_os_printf("%02X ",
f5c1e1c5	109	buffer[(acpi_size)i + j]);
88ec2860 BM	110	break;
	111
	112	case DB_WORD_DISPLAY:
	113
	114	ACPI_MOVE_16_TO_32(&temp32,
f5c1e1c5	115	&buffer[(acpi_size)i + j]);
88ec2860 BM	116	acpi_os_printf("%04X ", temp32);
	117	break;
	118
	119	case DB_DWORD_DISPLAY:
	120
	121	ACPI_MOVE_32_TO_32(&temp32,
f5c1e1c5	122	&buffer[(acpi_size)i + j]);
88ec2860 BM	123	acpi_os_printf("%08X ", temp32);
	124	break;
	125
	126	case DB_QWORD_DISPLAY:
	127
	128	ACPI_MOVE_32_TO_32(&temp32,
f5c1e1c5	129	&buffer[(acpi_size)i + j]);
88ec2860 BM	130	acpi_os_printf("%08X", temp32);
	131
	132	ACPI_MOVE_32_TO_32(&temp32,
f5c1e1c5	133	&buffer[(acpi_size)i + j +
88ec2860 BM	134	4]);
	135	acpi_os_printf("%08X ", temp32);
	136	break;
	137	}
	138
	139	j += display;
	140	}
	141
	142	/*
	143	* Print the ASCII equivalent characters but watch out for the bad
	144	* unprintable ones (printable chars are 0x20 through 0x7E)
	145	*/
	146	acpi_os_printf(" ");
	147	for (j = 0; j < 16; j++) {
	148	if (i + j >= count) {
	149	acpi_os_printf("\n");
	150	return;
	151	}
	152
d5a6f6b4 BM	153	/*
	154	* Add comment characters so rest of line is ignored when
	155	* compiled
	156	*/
	157	if (j == 0) {
	158	acpi_os_printf("// ");
	159	}
	160
f5c1e1c5	161	buf_char = buffer[(acpi_size)i + j];
4fa4616e	162	if (isprint(buf_char)) {
88ec2860 BM	163	acpi_os_printf("%c", buf_char);
	164	} else {
	165	acpi_os_printf(".");
	166	}
	167	}
	168
	169	/* Done with that line. */
	170
	171	acpi_os_printf("\n");
	172	i += 16;
	173	}
	174
	175	return;
	176	}
	177
	178	/*******************************************************************************
	179	*
	180	* FUNCTION: acpi_ut_debug_dump_buffer
	181	*
	182	* PARAMETERS: buffer - Buffer to dump
	183	* count - Amount to dump, in bytes
	184	* display - BYTE, WORD, DWORD, or QWORD display:
	185	* DB_BYTE_DISPLAY
	186	* DB_WORD_DISPLAY
	187	* DB_DWORD_DISPLAY
	188	* DB_QWORD_DISPLAY
	189	* component_ID - Caller's component ID
	190	*
	191	* RETURN: None
	192	*
	193	* DESCRIPTION: Generic dump buffer in both hex and ascii.
	194	*
	195	******************************************************************************/
	196
	197	void
	198	acpi_ut_debug_dump_buffer(u8 *buffer, u32 count, u32 display, u32 component_id)
	199	{
	200
	201	/* Only dump the buffer if tracing is enabled */
	202
	203	if (!((ACPI_LV_TABLES & acpi_dbg_level) &&
	204	(component_id & acpi_dbg_layer))) {
	205	return;
	206	}
	207
	208	acpi_ut_dump_buffer(buffer, count, display, 0);
	209	}
846d6ef4 LZ	210
	211	#ifdef ACPI_APPLICATION
	212	/*******************************************************************************
	213	*
	214	* FUNCTION: acpi_ut_dump_buffer_to_file
	215	*
	216	* PARAMETERS: file - File descriptor
	217	* buffer - Buffer to dump
	218	* count - Amount to dump, in bytes
	219	* display - BYTE, WORD, DWORD, or QWORD display:
	220	* DB_BYTE_DISPLAY
	221	* DB_WORD_DISPLAY
	222	* DB_DWORD_DISPLAY
	223	* DB_QWORD_DISPLAY
	224	* base_offset - Beginning buffer offset (display only)
	225	*
	226	* RETURN: None
	227	*
	228	* DESCRIPTION: Generic dump buffer in both hex and ascii to a file.
	229	*
	230	******************************************************************************/
	231
	232	void
	233	acpi_ut_dump_buffer_to_file(ACPI_FILE file,
	234	u8 *buffer, u32 count, u32 display, u32 base_offset)
	235	{
	236	u32 i = 0;
	237	u32 j;
	238	u32 temp32;
	239	u8 buf_char;
	240
	241	if (!buffer) {
f173a775	242	fprintf(file, "Null Buffer Pointer in DumpBuffer!\n");
846d6ef4 LZ	243	return;
	244	}
	245
	246	if ((count < 4) \|\| (count & 0x01)) {
	247	display = DB_BYTE_DISPLAY;
	248	}
	249
	250	/* Nasty little dump buffer routine! */
	251
	252	while (i < count) {
	253
	254	/* Print current offset */
	255
f173a775	256	fprintf(file, "%6.4X: ", (base_offset + i));
846d6ef4 LZ	257
	258	/* Print 16 hex chars */
	259
	260	for (j = 0; j < 16;) {
	261	if (i + j >= count) {
	262
	263	/* Dump fill spaces */
	264
f173a775	265	fprintf(file, "%s", ((display 2) + 1), " ");
846d6ef4 LZ	266	j += display;
	267	continue;
	268	}
	269
	270	switch (display) {
	271	case DB_BYTE_DISPLAY:
	272	default: /* Default is BYTE display */
	273
f173a775 LZ	274	fprintf(file, "%02X ",
f173a775 LZ	275	buffer[(acpi_size)i + j]);
846d6ef4 LZ	276	break;
	277
	278	case DB_WORD_DISPLAY:
	279
	280	ACPI_MOVE_16_TO_32(&temp32,
f5c1e1c5	281	&buffer[(acpi_size)i + j]);
f173a775	282	fprintf(file, "%04X ", temp32);
846d6ef4 LZ	283	break;
	284
	285	case DB_DWORD_DISPLAY:
	286
	287	ACPI_MOVE_32_TO_32(&temp32,
f5c1e1c5	288	&buffer[(acpi_size)i + j]);
f173a775	289	fprintf(file, "%08X ", temp32);
846d6ef4 LZ	290	break;
	291
	292	case DB_QWORD_DISPLAY:
	293
	294	ACPI_MOVE_32_TO_32(&temp32,
f5c1e1c5	295	&buffer[(acpi_size)i + j]);
f173a775	296	fprintf(file, "%08X", temp32);
846d6ef4 LZ	297
846d6ef4 LZ	298	ACPI_MOVE_32_TO_32(&temp32,
f5c1e1c5	299	&buffer[(acpi_size)i + j +
846d6ef4	300	4]);
f173a775	301	fprintf(file, "%08X ", temp32);
846d6ef4 LZ	302	break;
	303	}
	304
	305	j += display;
	306	}
	307
	308	/*
	309	* Print the ASCII equivalent characters but watch out for the bad
	310	* unprintable ones (printable chars are 0x20 through 0x7E)
	311	*/
f173a775	312	fprintf(file, " ");
846d6ef4 LZ	313	for (j = 0; j < 16; j++) {
846d6ef4 LZ	314	if (i + j >= count) {
f173a775	315	fprintf(file, "\n");
846d6ef4 LZ	316	return;
	317	}
	318
f5c1e1c5	319	buf_char = buffer[(acpi_size)i + j];
4fa4616e	320	if (isprint(buf_char)) {
f173a775	321	fprintf(file, "%c", buf_char);
846d6ef4	322	} else {
f173a775	323	fprintf(file, ".");
846d6ef4 LZ	324	}
	325	}
	326
	327	/* Done with that line. */
	328
f173a775	329	fprintf(file, "\n");
846d6ef4 LZ	330	i += 16;
	331	}
	332
	333	return;
	334	}
	335	#endif