[deliverable/linux.git] / drivers / acpi / apei / hest.c

/*
 * APEI Hardware Error Souce Table support
 *
 * HEST describes error sources in detail; communicates operational
 * parameters (i.e. severity levels, masking bits, and threshold
 * values) to Linux as necessary. It also allows the BIOS to report
 * non-standard error sources to Linux (for example, chipset-specific
 * error registers).
 *
 * For more information about HEST, please refer to ACPI Specification
 * version 4.0, section 17.3.2.
 *
 * Copyright 2009 Intel Corp.
 *   Author: Huang Ying <ying.huang@intel.com>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License version
 * 2 as published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 */

#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/init.h>
#include <linux/acpi.h>
#include <linux/kdebug.h>
#include <linux/highmem.h>
#include <linux/io.h>
#include <linux/platform_device.h>
#include <acpi/apei.h>

#include "apei-internal.h"

#define HEST_PFX "HEST: "

bool hest_disable;
EXPORT_SYMBOL_GPL(hest_disable);

/* HEST table parsing */

static struct acpi_table_hest *__read_mostly hest_tab;

static const int hest_esrc_len_tab[ACPI_HEST_TYPE_RESERVED] = {
	[ACPI_HEST_TYPE_IA32_CHECK] = -1,	/* need further calculation */
	[ACPI_HEST_TYPE_IA32_CORRECTED_CHECK] = -1,
	[ACPI_HEST_TYPE_IA32_NMI] = sizeof(struct acpi_hest_ia_nmi),
	[ACPI_HEST_TYPE_AER_ROOT_PORT] = sizeof(struct acpi_hest_aer_root),
	[ACPI_HEST_TYPE_AER_ENDPOINT] = sizeof(struct acpi_hest_aer),
	[ACPI_HEST_TYPE_AER_BRIDGE] = sizeof(struct acpi_hest_aer_bridge),
	[ACPI_HEST_TYPE_GENERIC_ERROR] = sizeof(struct acpi_hest_generic),
};

static int hest_esrc_len(struct acpi_hest_header *hest_hdr)
{
	u16 hest_type = hest_hdr->type;
	int len;

	if (hest_type >= ACPI_HEST_TYPE_RESERVED)
		return 0;

	len = hest_esrc_len_tab[hest_type];

	if (hest_type == ACPI_HEST_TYPE_IA32_CORRECTED_CHECK) {
		struct acpi_hest_ia_corrected *cmc;
		cmc = (struct acpi_hest_ia_corrected *)hest_hdr;
		len = sizeof(*cmc) + cmc->num_hardware_banks *
			sizeof(struct acpi_hest_ia_error_bank);
	} else if (hest_type == ACPI_HEST_TYPE_IA32_CHECK) {
		struct acpi_hest_ia_machine_check *mc;
		mc = (struct acpi_hest_ia_machine_check *)hest_hdr;
		len = sizeof(*mc) + mc->num_hardware_banks *
			sizeof(struct acpi_hest_ia_error_bank);
	}
	BUG_ON(len == -1);

	return len;
};

int apei_hest_parse(apei_hest_func_t func, void *data)
{
	struct acpi_hest_header *hest_hdr;
	int i, rc, len;

	if (hest_disable || !hest_tab)
		return -EINVAL;

	hest_hdr = (struct acpi_hest_header *)(hest_tab + 1);
	for (i = 0; i < hest_tab->error_source_count; i++) {
		len = hest_esrc_len(hest_hdr);
		if (!len) {
			pr_warning(FW_WARN HEST_PFX
				   "Unknown or unused hardware error source "
				   "type: %d for hardware error source: %d.\n",
				   hest_hdr->type, hest_hdr->source_id);
			return -EINVAL;
		}
		if ((void *)hest_hdr + len >
		    (void *)hest_tab + hest_tab->header.length) {
			pr_warning(FW_BUG HEST_PFX
		"Table contents overflow for hardware error source: %d.\n",
				hest_hdr->source_id);
			return -EINVAL;
		}

		rc = func(hest_hdr, data);
		if (rc)
			return rc;

		hest_hdr = (void *)hest_hdr + len;
	}

	return 0;
}
EXPORT_SYMBOL_GPL(apei_hest_parse);

/*
 * Check if firmware advertises firmware first mode. We need FF bit to be set
 * along with a set of MC banks which work in FF mode.
 */
static int __init hest_parse_cmc(struct acpi_hest_header *hest_hdr, void *data)
{
	return arch_apei_enable_cmcff(hest_hdr, data);
}

struct ghes_arr {
	struct platform_device **ghes_devs;
	unsigned int count;
};

static int __init hest_parse_ghes_count(struct acpi_hest_header *hest_hdr, void *data)
{
	int *count = data;

	if (hest_hdr->type == ACPI_HEST_TYPE_GENERIC_ERROR)
		(*count)++;
	return 0;
}

static int __init hest_parse_ghes(struct acpi_hest_header *hest_hdr, void *data)
{
	struct platform_device *ghes_dev;
	struct ghes_arr *ghes_arr = data;
	int rc, i;

	if (hest_hdr->type != ACPI_HEST_TYPE_GENERIC_ERROR)
		return 0;

	if (!((struct acpi_hest_generic *)hest_hdr)->enabled)
		return 0;
	for (i = 0; i < ghes_arr->count; i++) {
		struct acpi_hest_header *hdr;
		ghes_dev = ghes_arr->ghes_devs[i];
		hdr = *(struct acpi_hest_header **)ghes_dev->dev.platform_data;
		if (hdr->source_id == hest_hdr->source_id) {
			pr_warning(FW_WARN HEST_PFX "Duplicated hardware error source ID: %d.\n",
				   hdr->source_id);
			return -EIO;
		}
	}
	ghes_dev = platform_device_alloc("GHES", hest_hdr->source_id);
	if (!ghes_dev)
		return -ENOMEM;

	rc = platform_device_add_data(ghes_dev, &hest_hdr, sizeof(void *));
	if (rc)
		goto err;

	rc = platform_device_add(ghes_dev);
	if (rc)
		goto err;
	ghes_arr->ghes_devs[ghes_arr->count++] = ghes_dev;

	return 0;
err:
	platform_device_put(ghes_dev);
	return rc;
}

static int __init hest_ghes_dev_register(unsigned int ghes_count)
{
	int rc, i;
	struct ghes_arr ghes_arr;

	ghes_arr.count = 0;
	ghes_arr.ghes_devs = kmalloc(sizeof(void *) * ghes_count, GFP_KERNEL);
	if (!ghes_arr.ghes_devs)
		return -ENOMEM;

	rc = apei_hest_parse(hest_parse_ghes, &ghes_arr);
	if (rc)
		goto err;
out:
	kfree(ghes_arr.ghes_devs);
	return rc;
err:
	for (i = 0; i < ghes_arr.count; i++)
		platform_device_unregister(ghes_arr.ghes_devs[i]);
	goto out;
}

static int __init setup_hest_disable(char *str)
{
	hest_disable = 1;
	return 0;
}

__setup("hest_disable", setup_hest_disable);

void __init acpi_hest_init(void)
{
	acpi_status status;
	int rc = -ENODEV;
	unsigned int ghes_count = 0;

	if (hest_disable) {
		pr_info(HEST_PFX "Table parsing disabled.\n");
		return;
	}

	status = acpi_get_table(ACPI_SIG_HEST, 0,
				(struct acpi_table_header **)&hest_tab);
	if (status == AE_NOT_FOUND)
		goto err;
	else if (ACPI_FAILURE(status)) {
		const char *msg = acpi_format_exception(status);
		pr_err(HEST_PFX "Failed to get table, %s\n", msg);
		rc = -EINVAL;
		goto err;
	}

	if (!acpi_disable_cmcff)
		apei_hest_parse(hest_parse_cmc, NULL);

	if (!ghes_disable) {
		rc = apei_hest_parse(hest_parse_ghes_count, &ghes_count);
		if (rc)
			goto err;
		rc = hest_ghes_dev_register(ghes_count);
		if (rc)
			goto err;
	}

	pr_info(HEST_PFX "Table parsing has been initialized.\n");
	return;
err:
	hest_disable = 1;
}
Commit	Line	Data
9dc96664 HY	1	/*
	2	* APEI Hardware Error Souce Table support
	3	*
	4	* HEST describes error sources in detail; communicates operational
	5	* parameters (i.e. severity levels, masking bits, and threshold
	6	* values) to Linux as necessary. It also allows the BIOS to report
	7	* non-standard error sources to Linux (for example, chipset-specific
	8	* error registers).
	9	*
	10	* For more information about HEST, please refer to ACPI Specification
	11	* version 4.0, section 17.3.2.
	12	*
	13	* Copyright 2009 Intel Corp.
	14	* Author: Huang Ying <ying.huang@intel.com>
	15	*
	16	* This program is free software; you can redistribute it and/or
	17	* modify it under the terms of the GNU General Public License version
	18	* 2 as published by the Free Software Foundation;
	19	*
	20	* This program is distributed in the hope that it will be useful,
	21	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	22	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	23	* GNU General Public License for more details.
9dc96664 HY	24	*/
	25
	26	#include <linux/kernel.h>
	27	#include <linux/module.h>
	28	#include <linux/init.h>
	29	#include <linux/acpi.h>
	30	#include <linux/kdebug.h>
	31	#include <linux/highmem.h>
	32	#include <linux/io.h>
7ad6e943	33	#include <linux/platform_device.h>
9dc96664 HY	34	#include <acpi/apei.h>
	35
	36	#include "apei-internal.h"
	37
	38	#define HEST_PFX "HEST: "
	39
90ab5ee9	40	bool hest_disable;
9dc96664 HY	41	EXPORT_SYMBOL_GPL(hest_disable);
	42
	43	/* HEST table parsing */
	44
bec4f22a	45	static struct acpi_table_hest *__read_mostly hest_tab;
9dc96664	46
bec4f22a	47	static const int hest_esrc_len_tab[ACPI_HEST_TYPE_RESERVED] = {
9dc96664 HY	48	[ACPI_HEST_TYPE_IA32_CHECK] = -1, /* need further calculation */
	49	[ACPI_HEST_TYPE_IA32_CORRECTED_CHECK] = -1,
	50	[ACPI_HEST_TYPE_IA32_NMI] = sizeof(struct acpi_hest_ia_nmi),
	51	[ACPI_HEST_TYPE_AER_ROOT_PORT] = sizeof(struct acpi_hest_aer_root),
	52	[ACPI_HEST_TYPE_AER_ENDPOINT] = sizeof(struct acpi_hest_aer),
	53	[ACPI_HEST_TYPE_AER_BRIDGE] = sizeof(struct acpi_hest_aer_bridge),
	54	[ACPI_HEST_TYPE_GENERIC_ERROR] = sizeof(struct acpi_hest_generic),
	55	};
	56
	57	static int hest_esrc_len(struct acpi_hest_header *hest_hdr)
	58	{
	59	u16 hest_type = hest_hdr->type;
	60	int len;
	61
	62	if (hest_type >= ACPI_HEST_TYPE_RESERVED)
	63	return 0;
	64
	65	len = hest_esrc_len_tab[hest_type];
	66
	67	if (hest_type == ACPI_HEST_TYPE_IA32_CORRECTED_CHECK) {
	68	struct acpi_hest_ia_corrected *cmc;
	69	cmc = (struct acpi_hest_ia_corrected *)hest_hdr;
	70	len = sizeof(cmc) + cmc->num_hardware_banks
	71	sizeof(struct acpi_hest_ia_error_bank);
	72	} else if (hest_type == ACPI_HEST_TYPE_IA32_CHECK) {
	73	struct acpi_hest_ia_machine_check *mc;
	74	mc = (struct acpi_hest_ia_machine_check *)hest_hdr;
	75	len = sizeof(mc) + mc->num_hardware_banks
	76	sizeof(struct acpi_hest_ia_error_bank);
	77	}
	78	BUG_ON(len == -1);
	79
	80	return len;
	81	};
	82
	83	int apei_hest_parse(apei_hest_func_t func, void *data)
	84	{
	85	struct acpi_hest_header *hest_hdr;
	86	int i, rc, len;
	87
a84363d6	88	if (hest_disable \|\| !hest_tab)
9dc96664 HY	89	return -EINVAL;
	90
	91	hest_hdr = (struct acpi_hest_header *)(hest_tab + 1);
	92	for (i = 0; i < hest_tab->error_source_count; i++) {
	93	len = hest_esrc_len(hest_hdr);
	94	if (!len) {
	95	pr_warning(FW_WARN HEST_PFX
	96	"Unknown or unused hardware error source "
	97	"type: %d for hardware error source: %d.\n",
	98	hest_hdr->type, hest_hdr->source_id);
	99	return -EINVAL;
	100	}
	101	if ((void *)hest_hdr + len >
	102	(void *)hest_tab + hest_tab->header.length) {
	103	pr_warning(FW_BUG HEST_PFX
	104	"Table contents overflow for hardware error source: %d.\n",
	105	hest_hdr->source_id);
	106	return -EINVAL;
	107	}
	108
	109	rc = func(hest_hdr, data);
	110	if (rc)
	111	return rc;
	112
	113	hest_hdr = (void *)hest_hdr + len;
	114	}
	115
	116	return 0;
	117	}
	118	EXPORT_SYMBOL_GPL(apei_hest_parse);
	119
c3d1fb56 NR	120	/*
	121	* Check if firmware advertises firmware first mode. We need FF bit to be set
	122	* along with a set of MC banks which work in FF mode.
	123	*/
	124	static int __init hest_parse_cmc(struct acpi_hest_header hest_hdr, void data)
	125	{
9dae3d0d	126	return arch_apei_enable_cmcff(hest_hdr, data);
c3d1fb56 NR	127	}
c3d1fb56 NR	128
7ad6e943 HY	129	struct ghes_arr {
	130	struct platform_device **ghes_devs;
	131	unsigned int count;
	132	};
	133
bec4f22a	134	static int __init hest_parse_ghes_count(struct acpi_hest_header hest_hdr, void data)
7ad6e943 HY	135	{
	136	int *count = data;
	137
	138	if (hest_hdr->type == ACPI_HEST_TYPE_GENERIC_ERROR)
	139	(*count)++;
	140	return 0;
	141	}
	142
bec4f22a	143	static int __init hest_parse_ghes(struct acpi_hest_header hest_hdr, void data)
7ad6e943	144	{
7ad6e943 HY	145	struct platform_device *ghes_dev;
7ad6e943 HY	146	struct ghes_arr *ghes_arr = data;
4d2b2956	147	int rc, i;
7ad6e943 HY	148
	149	if (hest_hdr->type != ACPI_HEST_TYPE_GENERIC_ERROR)
	150	return 0;
1dd6b20e JD	151
1dd6b20e JD	152	if (!((struct acpi_hest_generic *)hest_hdr)->enabled)
7ad6e943	153	return 0;
4d2b2956 HY	154	for (i = 0; i < ghes_arr->count; i++) {
	155	struct acpi_hest_header *hdr;
	156	ghes_dev = ghes_arr->ghes_devs[i];
	157	hdr = (struct acpi_hest_header *)ghes_dev->dev.platform_data;
	158	if (hdr->source_id == hest_hdr->source_id) {
	159	pr_warning(FW_WARN HEST_PFX "Duplicated hardware error source ID: %d.\n",
	160	hdr->source_id);
	161	return -EIO;
	162	}
	163	}
7ad6e943 HY	164	ghes_dev = platform_device_alloc("GHES", hest_hdr->source_id);
	165	if (!ghes_dev)
	166	return -ENOMEM;
1dd6b20e JD	167
	168	rc = platform_device_add_data(ghes_dev, &hest_hdr, sizeof(void *));
	169	if (rc)
	170	goto err;
	171
7ad6e943 HY	172	rc = platform_device_add(ghes_dev);
	173	if (rc)
	174	goto err;
	175	ghes_arr->ghes_devs[ghes_arr->count++] = ghes_dev;
	176
	177	return 0;
	178	err:
	179	platform_device_put(ghes_dev);
	180	return rc;
	181	}
	182
bec4f22a	183	static int __init hest_ghes_dev_register(unsigned int ghes_count)
7ad6e943 HY	184	{
	185	int rc, i;
	186	struct ghes_arr ghes_arr;
	187
	188	ghes_arr.count = 0;
	189	ghes_arr.ghes_devs = kmalloc(sizeof(void ) ghes_count, GFP_KERNEL);
	190	if (!ghes_arr.ghes_devs)
	191	return -ENOMEM;
	192
	193	rc = apei_hest_parse(hest_parse_ghes, &ghes_arr);
	194	if (rc)
	195	goto err;
	196	out:
	197	kfree(ghes_arr.ghes_devs);
	198	return rc;
	199	err:
	200	for (i = 0; i < ghes_arr.count; i++)
	201	platform_device_unregister(ghes_arr.ghes_devs[i]);
	202	goto out;
	203	}
	204
9dc96664 HY	205	static int __init setup_hest_disable(char *str)
	206	{
	207	hest_disable = 1;
	208	return 0;
	209	}
	210
	211	__setup("hest_disable", setup_hest_disable);
	212
415e12b2	213	void __init acpi_hest_init(void)
9dc96664 HY	214	{
	215	acpi_status status;
	216	int rc = -ENODEV;
7ad6e943	217	unsigned int ghes_count = 0;
9dc96664	218
9dc96664	219	if (hest_disable) {
415e12b2 RW	220	pr_info(HEST_PFX "Table parsing disabled.\n");
415e12b2 RW	221	return;
9dc96664 HY	222	}
	223
	224	status = acpi_get_table(ACPI_SIG_HEST, 0,
	225	(struct acpi_table_header **)&hest_tab);
ad686154	226	if (status == AE_NOT_FOUND)
9dc96664	227	goto err;
ad686154	228	else if (ACPI_FAILURE(status)) {
9dc96664 HY	229	const char *msg = acpi_format_exception(status);
	230	pr_err(HEST_PFX "Failed to get table, %s\n", msg);
	231	rc = -EINVAL;
	232	goto err;
	233	}
	234
9ad95879 NR	235	if (!acpi_disable_cmcff)
9ad95879 NR	236	apei_hest_parse(hest_parse_cmc, NULL);
c3d1fb56	237
b6a95016 HY	238	if (!ghes_disable) {
	239	rc = apei_hest_parse(hest_parse_ghes_count, &ghes_count);
	240	if (rc)
	241	goto err;
	242	rc = hest_ghes_dev_register(ghes_count);
	243	if (rc)
	244	goto err;
415e12b2	245	}
9dc96664	246
b6a95016 HY	247	pr_info(HEST_PFX "Table parsing has been initialized.\n");
b6a95016 HY	248	return;
9dc96664 HY	249	err:
9dc96664 HY	250	hest_disable = 1;
9dc96664	251	}