[deliverable/linux.git] / drivers / acpi / acpica / tbprint.c

/******************************************************************************
 *
 * Module Name: tbprint - Table output utilities
 *
 *****************************************************************************/

/*
 * Copyright (C) 2000 - 2016, 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"
#include "actables.h"

#define _COMPONENT          ACPI_TABLES
ACPI_MODULE_NAME("tbprint")

/* Local prototypes */
static void acpi_tb_fix_string(char *string, acpi_size length);

static void
acpi_tb_cleanup_table_header(struct acpi_table_header *out_header,
			     struct acpi_table_header *header);

/*******************************************************************************
 *
 * FUNCTION:    acpi_tb_fix_string
 *
 * PARAMETERS:  string              - String to be repaired
 *              length              - Maximum length
 *
 * RETURN:      None
 *
 * DESCRIPTION: Replace every non-printable or non-ascii byte in the string
 *              with a question mark '?'.
 *
 ******************************************************************************/

static void acpi_tb_fix_string(char *string, acpi_size length)
{

	while (length && *string) {
		if (!isprint((int)*string)) {
			*string = '?';
		}

		string++;
		length--;
	}
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_tb_cleanup_table_header
 *
 * PARAMETERS:  out_header          - Where the cleaned header is returned
 *              header              - Input ACPI table header
 *
 * RETURN:      Returns the cleaned header in out_header
 *
 * DESCRIPTION: Copy the table header and ensure that all "string" fields in
 *              the header consist of printable characters.
 *
 ******************************************************************************/

static void
acpi_tb_cleanup_table_header(struct acpi_table_header *out_header,
			     struct acpi_table_header *header)
{

	memcpy(out_header, header, sizeof(struct acpi_table_header));

	acpi_tb_fix_string(out_header->signature, ACPI_NAME_SIZE);
	acpi_tb_fix_string(out_header->oem_id, ACPI_OEM_ID_SIZE);
	acpi_tb_fix_string(out_header->oem_table_id, ACPI_OEM_TABLE_ID_SIZE);
	acpi_tb_fix_string(out_header->asl_compiler_id, ACPI_NAME_SIZE);
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_tb_print_table_header
 *
 * PARAMETERS:  address             - Table physical address
 *              header              - Table header
 *
 * RETURN:      None
 *
 * DESCRIPTION: Print an ACPI table header. Special cases for FACS and RSDP.
 *
 ******************************************************************************/

void
acpi_tb_print_table_header(acpi_physical_address address,
			   struct acpi_table_header *header)
{
	struct acpi_table_header local_header;

	if (ACPI_COMPARE_NAME(header->signature, ACPI_SIG_FACS)) {

		/* FACS only has signature and length fields */

		ACPI_INFO((AE_INFO, "%-4.4s 0x%8.8X%8.8X %06X",
			   header->signature, ACPI_FORMAT_UINT64(address),
			   header->length));
	} else if (ACPI_VALIDATE_RSDP_SIG(header->signature)) {

		/* RSDP has no common fields */

		memcpy(local_header.oem_id,
		       ACPI_CAST_PTR(struct acpi_table_rsdp, header)->oem_id,
		       ACPI_OEM_ID_SIZE);
		acpi_tb_fix_string(local_header.oem_id, ACPI_OEM_ID_SIZE);

		ACPI_INFO((AE_INFO, "RSDP 0x%8.8X%8.8X %06X (v%.2d %-6.6s)",
			   ACPI_FORMAT_UINT64(address),
			   (ACPI_CAST_PTR(struct acpi_table_rsdp, header)->
			    revision >
			    0) ? ACPI_CAST_PTR(struct acpi_table_rsdp,
					       header)->length : 20,
			   ACPI_CAST_PTR(struct acpi_table_rsdp,
					 header)->revision,
			   local_header.oem_id));
	} else {
		/* Standard ACPI table with full common header */

		acpi_tb_cleanup_table_header(&local_header, header);

		ACPI_INFO((AE_INFO,
			   "%-4.4s 0x%8.8X%8.8X"
			   " %06X (v%.2d %-6.6s %-8.8s %08X %-4.4s %08X)",
			   local_header.signature, ACPI_FORMAT_UINT64(address),
			   local_header.length, local_header.revision,
			   local_header.oem_id, local_header.oem_table_id,
			   local_header.oem_revision,
			   local_header.asl_compiler_id,
			   local_header.asl_compiler_revision));
	}
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_tb_validate_checksum
 *
 * PARAMETERS:  table               - ACPI table to verify
 *              length              - Length of entire table
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Verifies that the table checksums to zero. Optionally returns
 *              exception on bad checksum.
 *
 ******************************************************************************/

acpi_status acpi_tb_verify_checksum(struct acpi_table_header *table, u32 length)
{
	u8 checksum;

	/*
	 * FACS/S3PT:
	 * They are the odd tables, have no standard ACPI header and no checksum
	 */

	if (ACPI_COMPARE_NAME(table->signature, ACPI_SIG_S3PT) ||
	    ACPI_COMPARE_NAME(table->signature, ACPI_SIG_FACS)) {
		return (AE_OK);
	}

	/* Compute the checksum on the table */

	checksum = acpi_tb_checksum(ACPI_CAST_PTR(u8, table), length);

	/* Checksum ok? (should be zero) */

	if (checksum) {
		ACPI_BIOS_WARNING((AE_INFO,
				   "Incorrect checksum in table [%4.4s] - 0x%2.2X, "
				   "should be 0x%2.2X",
				   table->signature, table->checksum,
				   (u8)(table->checksum - checksum)));

#if (ACPI_CHECKSUM_ABORT)
		return (AE_BAD_CHECKSUM);
#endif
	}

	return (AE_OK);
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_tb_checksum
 *
 * PARAMETERS:  buffer          - Pointer to memory region to be checked
 *              length          - Length of this memory region
 *
 * RETURN:      Checksum (u8)
 *
 * DESCRIPTION: Calculates circular checksum of memory region.
 *
 ******************************************************************************/

u8 acpi_tb_checksum(u8 *buffer, u32 length)
{
	u8 sum = 0;
	u8 *end = buffer + length;

	while (buffer < end) {
		sum = (u8)(sum + *(buffer++));
	}

	return (sum);
}
Commit	Line	Data
42f47869 BM	1	/******************************************************************************
	2	*
	3	* Module Name: tbprint - Table output utilities
	4	*
	5	*****************************************************************************/
	6
	7	/*
c8100dc4	8	* Copyright (C) 2000 - 2016, Intel Corp.
42f47869 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	#include "actables.h"
	47
	48	#define _COMPONENT ACPI_TABLES
	49	ACPI_MODULE_NAME("tbprint")
	50
	51	/* Local prototypes */
	52	static void acpi_tb_fix_string(char *string, acpi_size length);
	53
	54	static void
	55	acpi_tb_cleanup_table_header(struct acpi_table_header *out_header,
	56	struct acpi_table_header *header);
	57
	58	/*******************************************************************************
	59	*
	60	* FUNCTION: acpi_tb_fix_string
	61	*
	62	* PARAMETERS: string - String to be repaired
	63	* length - Maximum length
	64	*
	65	* RETURN: None
	66	*
	67	* DESCRIPTION: Replace every non-printable or non-ascii byte in the string
	68	* with a question mark '?'.
	69	*
	70	******************************************************************************/
	71
	72	static void acpi_tb_fix_string(char *string, acpi_size length)
73	{
74
75	while (length && *string) {
4fa4616e	76	if (!isprint((int)*string)) {
42f47869 BM	77	*string = '?';
42f47869 BM	78	}
1fad8738	79
42f47869 BM	80	string++;
	81	length--;
	82	}
	83	}
	84
	85	/*******************************************************************************
	86	*
	87	* FUNCTION: acpi_tb_cleanup_table_header
	88	*
	89	* PARAMETERS: out_header - Where the cleaned header is returned
	90	* header - Input ACPI table header
	91	*
	92	* RETURN: Returns the cleaned header in out_header
	93	*
	94	* DESCRIPTION: Copy the table header and ensure that all "string" fields in
	95	* the header consist of printable characters.
	96	*
	97	******************************************************************************/
	98
	99	static void
	100	acpi_tb_cleanup_table_header(struct acpi_table_header *out_header,
	101	struct acpi_table_header *header)
	102	{
	103
4fa4616e	104	memcpy(out_header, header, sizeof(struct acpi_table_header));
42f47869 BM	105
	106	acpi_tb_fix_string(out_header->signature, ACPI_NAME_SIZE);
	107	acpi_tb_fix_string(out_header->oem_id, ACPI_OEM_ID_SIZE);
	108	acpi_tb_fix_string(out_header->oem_table_id, ACPI_OEM_TABLE_ID_SIZE);
	109	acpi_tb_fix_string(out_header->asl_compiler_id, ACPI_NAME_SIZE);
	110	}
	111
	112	/*******************************************************************************
	113	*
	114	* FUNCTION: acpi_tb_print_table_header
	115	*
	116	* PARAMETERS: address - Table physical address
	117	* header - Table header
	118	*
	119	* RETURN: None
	120	*
	121	* DESCRIPTION: Print an ACPI table header. Special cases for FACS and RSDP.
	122	*
	123	******************************************************************************/
	124
	125	void
	126	acpi_tb_print_table_header(acpi_physical_address address,
	127	struct acpi_table_header *header)
	128	{
	129	struct acpi_table_header local_header;
	130
42f47869 BM	131	if (ACPI_COMPARE_NAME(header->signature, ACPI_SIG_FACS)) {
	132
	133	/* FACS only has signature and length fields */
	134
1d0a0b2f LZ	135	ACPI_INFO((AE_INFO, "%-4.4s 0x%8.8X%8.8X %06X",
1d0a0b2f LZ	136	header->signature, ACPI_FORMAT_UINT64(address),
42f47869	137	header->length));
cacba865	138	} else if (ACPI_VALIDATE_RSDP_SIG(header->signature)) {
42f47869 BM	139
	140	/* RSDP has no common fields */
	141
4fa4616e BM	142	memcpy(local_header.oem_id,
	143	ACPI_CAST_PTR(struct acpi_table_rsdp, header)->oem_id,
	144	ACPI_OEM_ID_SIZE);
42f47869 BM	145	acpi_tb_fix_string(local_header.oem_id, ACPI_OEM_ID_SIZE);
42f47869 BM	146
1d0a0b2f LZ	147	ACPI_INFO((AE_INFO, "RSDP 0x%8.8X%8.8X %06X (v%.2d %-6.6s)",
1d0a0b2f LZ	148	ACPI_FORMAT_UINT64(address),
42f47869 BM	149	(ACPI_CAST_PTR(struct acpi_table_rsdp, header)->
	150	revision >
	151	0) ? ACPI_CAST_PTR(struct acpi_table_rsdp,
	152	header)->length : 20,
	153	ACPI_CAST_PTR(struct acpi_table_rsdp,
	154	header)->revision,
	155	local_header.oem_id));
	156	} else {
	157	/* Standard ACPI table with full common header */
	158
	159	acpi_tb_cleanup_table_header(&local_header, header);
	160
	161	ACPI_INFO((AE_INFO,
1d0a0b2f	162	"%-4.4s 0x%8.8X%8.8X"
c03775c0	163	" %06X (v%.2d %-6.6s %-8.8s %08X %-4.4s %08X)",
1d0a0b2f	164	local_header.signature, ACPI_FORMAT_UINT64(address),
42f47869 BM	165	local_header.length, local_header.revision,
	166	local_header.oem_id, local_header.oem_table_id,
	167	local_header.oem_revision,
	168	local_header.asl_compiler_id,
	169	local_header.asl_compiler_revision));
	170	}
	171	}
	172
	173	/*******************************************************************************
	174	*
	175	* FUNCTION: acpi_tb_validate_checksum
	176	*
	177	* PARAMETERS: table - ACPI table to verify
	178	* length - Length of entire table
	179	*
	180	* RETURN: Status
	181	*
	182	* DESCRIPTION: Verifies that the table checksums to zero. Optionally returns
	183	* exception on bad checksum.
	184	*
	185	******************************************************************************/
	186
	187	acpi_status acpi_tb_verify_checksum(struct acpi_table_header *table, u32 length)
	188	{
	189	u8 checksum;
	190
94d4be67 LZ	191	/*
	192	* FACS/S3PT:
	193	* They are the odd tables, have no standard ACPI header and no checksum
	194	*/
	195
	196	if (ACPI_COMPARE_NAME(table->signature, ACPI_SIG_S3PT) \|\|
	197	ACPI_COMPARE_NAME(table->signature, ACPI_SIG_FACS)) {
	198	return (AE_OK);
	199	}
	200
42f47869 BM	201	/* Compute the checksum on the table */
	202
	203	checksum = acpi_tb_checksum(ACPI_CAST_PTR(u8, table), length);
	204
	205	/* Checksum ok? (should be zero) */
	206
	207	if (checksum) {
	208	ACPI_BIOS_WARNING((AE_INFO,
	209	"Incorrect checksum in table [%4.4s] - 0x%2.2X, "
	210	"should be 0x%2.2X",
	211	table->signature, table->checksum,
	212	(u8)(table->checksum - checksum)));
	213
	214	#if (ACPI_CHECKSUM_ABORT)
	215	return (AE_BAD_CHECKSUM);
	216	#endif
	217	}
	218
	219	return (AE_OK);
	220	}
	221
	222	/*******************************************************************************
	223	*
	224	* FUNCTION: acpi_tb_checksum
	225	*
	226	* PARAMETERS: buffer - Pointer to memory region to be checked
	227	* length - Length of this memory region
	228	*
	229	* RETURN: Checksum (u8)
	230	*
	231	* DESCRIPTION: Calculates circular checksum of memory region.
	232	*
	233	******************************************************************************/
	234
	235	u8 acpi_tb_checksum(u8 *buffer, u32 length)
	236	{
	237	u8 sum = 0;
	238	u8 *end = buffer + length;
	239
	240	while (buffer < end) {
	241	sum = (u8)(sum + *(buffer++));
	242	}
	243
	244	return (sum);
	245	}