[mirror_ubuntu-eoan-kernel.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.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#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 <asm/mce.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)
{
	int i;
	struct acpi_hest_ia_corrected *cmc;
	struct acpi_hest_ia_error_bank *mc_bank;

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

	cmc = (struct acpi_hest_ia_corrected *)hest_hdr;
	if (!cmc->enabled)
		return 0;

	/*
	 * We expect HEST to provide a list of MC banks that report errors
	 * in firmware first mode. Otherwise, return non-zero value to
	 * indicate that we are done parsing HEST.
	 */
	if (!(cmc->flags & ACPI_HEST_FIRMWARE_FIRST) || !cmc->num_hardware_banks)
		return 1;

	pr_info(HEST_PFX "Enabling Firmware First mode for corrected errors.\n");

	mc_bank = (struct acpi_hest_ia_error_bank *)(cmc + 1);
	for (i = 0; i < cmc->num_hardware_banks; i++, mc_bank++)
		mce_disable_bank(mc_bank->bank_number);

	return 1;
}

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;
	}

	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.
	24	*
	25	* You should have received a copy of the GNU General Public License
	26	* along with this program; if not, write to the Free Software
	27	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	28	*/
	29
	30	#include <linux/kernel.h>
	31	#include <linux/module.h>
	32	#include <linux/init.h>
	33	#include <linux/acpi.h>
	34	#include <linux/kdebug.h>
	35	#include <linux/highmem.h>
	36	#include <linux/io.h>
7ad6e943	37	#include <linux/platform_device.h>
9dc96664	38	#include <acpi/apei.h>
c3d1fb56	39	#include <asm/mce.h>
9dc96664 HY	40
	41	#include "apei-internal.h"
	42
	43	#define HEST_PFX "HEST: "
	44
90ab5ee9	45	bool hest_disable;
9dc96664 HY	46	EXPORT_SYMBOL_GPL(hest_disable);
	47
	48	/* HEST table parsing */
	49
bec4f22a	50	static struct acpi_table_hest *__read_mostly hest_tab;
9dc96664	51
bec4f22a	52	static const int hest_esrc_len_tab[ACPI_HEST_TYPE_RESERVED] = {
9dc96664 HY	53	[ACPI_HEST_TYPE_IA32_CHECK] = -1, /* need further calculation */
	54	[ACPI_HEST_TYPE_IA32_CORRECTED_CHECK] = -1,
	55	[ACPI_HEST_TYPE_IA32_NMI] = sizeof(struct acpi_hest_ia_nmi),
	56	[ACPI_HEST_TYPE_AER_ROOT_PORT] = sizeof(struct acpi_hest_aer_root),
	57	[ACPI_HEST_TYPE_AER_ENDPOINT] = sizeof(struct acpi_hest_aer),
	58	[ACPI_HEST_TYPE_AER_BRIDGE] = sizeof(struct acpi_hest_aer_bridge),
	59	[ACPI_HEST_TYPE_GENERIC_ERROR] = sizeof(struct acpi_hest_generic),
	60	};
	61
	62	static int hest_esrc_len(struct acpi_hest_header *hest_hdr)
	63	{
	64	u16 hest_type = hest_hdr->type;
	65	int len;
	66
	67	if (hest_type >= ACPI_HEST_TYPE_RESERVED)
	68	return 0;
	69
	70	len = hest_esrc_len_tab[hest_type];
	71
	72	if (hest_type == ACPI_HEST_TYPE_IA32_CORRECTED_CHECK) {
	73	struct acpi_hest_ia_corrected *cmc;
	74	cmc = (struct acpi_hest_ia_corrected *)hest_hdr;
	75	len = sizeof(cmc) + cmc->num_hardware_banks
	76	sizeof(struct acpi_hest_ia_error_bank);
	77	} else if (hest_type == ACPI_HEST_TYPE_IA32_CHECK) {
	78	struct acpi_hest_ia_machine_check *mc;
	79	mc = (struct acpi_hest_ia_machine_check *)hest_hdr;
	80	len = sizeof(mc) + mc->num_hardware_banks
	81	sizeof(struct acpi_hest_ia_error_bank);
	82	}
	83	BUG_ON(len == -1);
	84
	85	return len;
	86	};
	87
	88	int apei_hest_parse(apei_hest_func_t func, void *data)
	89	{
	90	struct acpi_hest_header *hest_hdr;
	91	int i, rc, len;
	92
a84363d6	93	if (hest_disable \|\| !hest_tab)
9dc96664 HY	94	return -EINVAL;
	95
	96	hest_hdr = (struct acpi_hest_header *)(hest_tab + 1);
	97	for (i = 0; i < hest_tab->error_source_count; i++) {
	98	len = hest_esrc_len(hest_hdr);
	99	if (!len) {
	100	pr_warning(FW_WARN HEST_PFX
	101	"Unknown or unused hardware error source "
	102	"type: %d for hardware error source: %d.\n",
	103	hest_hdr->type, hest_hdr->source_id);
	104	return -EINVAL;
	105	}
	106	if ((void *)hest_hdr + len >
	107	(void *)hest_tab + hest_tab->header.length) {
	108	pr_warning(FW_BUG HEST_PFX
	109	"Table contents overflow for hardware error source: %d.\n",
	110	hest_hdr->source_id);
	111	return -EINVAL;
	112	}
	113
	114	rc = func(hest_hdr, data);
	115	if (rc)
	116	return rc;
	117
	118	hest_hdr = (void *)hest_hdr + len;
	119	}
	120
	121	return 0;
	122	}
	123	EXPORT_SYMBOL_GPL(apei_hest_parse);
	124
c3d1fb56 NR	125	/*
	126	* Check if firmware advertises firmware first mode. We need FF bit to be set
	127	* along with a set of MC banks which work in FF mode.
	128	*/
	129	static int __init hest_parse_cmc(struct acpi_hest_header hest_hdr, void data)
	130	{
	131	int i;
	132	struct acpi_hest_ia_corrected *cmc;
	133	struct acpi_hest_ia_error_bank *mc_bank;
	134
	135	if (hest_hdr->type != ACPI_HEST_TYPE_IA32_CORRECTED_CHECK)
	136	return 0;
	137
	138	cmc = (struct acpi_hest_ia_corrected *)hest_hdr;
	139	if (!cmc->enabled)
	140	return 0;
	141
	142	/*
	143	* We expect HEST to provide a list of MC banks that report errors
	144	* in firmware first mode. Otherwise, return non-zero value to
	145	* indicate that we are done parsing HEST.
	146	*/
	147	if (!(cmc->flags & ACPI_HEST_FIRMWARE_FIRST) \|\| !cmc->num_hardware_banks)
	148	return 1;
	149
	150	pr_info(HEST_PFX "Enabling Firmware First mode for corrected errors.\n");
	151
	152	mc_bank = (struct acpi_hest_ia_error_bank *)(cmc + 1);
	153	for (i = 0; i < cmc->num_hardware_banks; i++, mc_bank++)
	154	mce_disable_bank(mc_bank->bank_number);
	155
	156	return 1;
	157	}
	158
7ad6e943 HY	159	struct ghes_arr {
	160	struct platform_device **ghes_devs;
	161	unsigned int count;
	162	};
	163
bec4f22a	164	static int __init hest_parse_ghes_count(struct acpi_hest_header hest_hdr, void data)
7ad6e943 HY	165	{
	166	int *count = data;
	167
	168	if (hest_hdr->type == ACPI_HEST_TYPE_GENERIC_ERROR)
	169	(*count)++;
	170	return 0;
	171	}
	172
bec4f22a	173	static int __init hest_parse_ghes(struct acpi_hest_header hest_hdr, void data)
7ad6e943	174	{
7ad6e943 HY	175	struct platform_device *ghes_dev;
7ad6e943 HY	176	struct ghes_arr *ghes_arr = data;
4d2b2956	177	int rc, i;
7ad6e943 HY	178
	179	if (hest_hdr->type != ACPI_HEST_TYPE_GENERIC_ERROR)
	180	return 0;
1dd6b20e JD	181
1dd6b20e JD	182	if (!((struct acpi_hest_generic *)hest_hdr)->enabled)
7ad6e943	183	return 0;
4d2b2956 HY	184	for (i = 0; i < ghes_arr->count; i++) {
	185	struct acpi_hest_header *hdr;
	186	ghes_dev = ghes_arr->ghes_devs[i];
	187	hdr = (struct acpi_hest_header *)ghes_dev->dev.platform_data;
	188	if (hdr->source_id == hest_hdr->source_id) {
	189	pr_warning(FW_WARN HEST_PFX "Duplicated hardware error source ID: %d.\n",
	190	hdr->source_id);
	191	return -EIO;
	192	}
	193	}
7ad6e943 HY	194	ghes_dev = platform_device_alloc("GHES", hest_hdr->source_id);
	195	if (!ghes_dev)
	196	return -ENOMEM;
1dd6b20e JD	197
	198	rc = platform_device_add_data(ghes_dev, &hest_hdr, sizeof(void *));
	199	if (rc)
	200	goto err;
	201
7ad6e943 HY	202	rc = platform_device_add(ghes_dev);
	203	if (rc)
	204	goto err;
	205	ghes_arr->ghes_devs[ghes_arr->count++] = ghes_dev;
	206
	207	return 0;
	208	err:
	209	platform_device_put(ghes_dev);
	210	return rc;
	211	}
	212
bec4f22a	213	static int __init hest_ghes_dev_register(unsigned int ghes_count)
7ad6e943 HY	214	{
	215	int rc, i;
	216	struct ghes_arr ghes_arr;
	217
	218	ghes_arr.count = 0;
	219	ghes_arr.ghes_devs = kmalloc(sizeof(void ) ghes_count, GFP_KERNEL);
	220	if (!ghes_arr.ghes_devs)
	221	return -ENOMEM;
	222
	223	rc = apei_hest_parse(hest_parse_ghes, &ghes_arr);
	224	if (rc)
	225	goto err;
	226	out:
	227	kfree(ghes_arr.ghes_devs);
	228	return rc;
	229	err:
	230	for (i = 0; i < ghes_arr.count; i++)
	231	platform_device_unregister(ghes_arr.ghes_devs[i]);
	232	goto out;
	233	}
	234
9dc96664 HY	235	static int __init setup_hest_disable(char *str)
	236	{
	237	hest_disable = 1;
	238	return 0;
	239	}
	240
	241	__setup("hest_disable", setup_hest_disable);
	242
415e12b2	243	void __init acpi_hest_init(void)
9dc96664 HY	244	{
	245	acpi_status status;
	246	int rc = -ENODEV;
7ad6e943	247	unsigned int ghes_count = 0;
9dc96664	248
9dc96664	249	if (hest_disable) {
415e12b2 RW	250	pr_info(HEST_PFX "Table parsing disabled.\n");
415e12b2 RW	251	return;
9dc96664 HY	252	}
	253
	254	status = acpi_get_table(ACPI_SIG_HEST, 0,
	255	(struct acpi_table_header **)&hest_tab);
ad686154	256	if (status == AE_NOT_FOUND)
9dc96664	257	goto err;
ad686154	258	else if (ACPI_FAILURE(status)) {
9dc96664 HY	259	const char *msg = acpi_format_exception(status);
	260	pr_err(HEST_PFX "Failed to get table, %s\n", msg);
	261	rc = -EINVAL;
	262	goto err;
	263	}
	264
c3d1fb56 NR	265	apei_hest_parse(hest_parse_cmc, NULL);
c3d1fb56 NR	266
b6a95016 HY	267	if (!ghes_disable) {
	268	rc = apei_hest_parse(hest_parse_ghes_count, &ghes_count);
	269	if (rc)
	270	goto err;
	271	rc = hest_ghes_dev_register(ghes_count);
	272	if (rc)
	273	goto err;
415e12b2	274	}
9dc96664	275
b6a95016 HY	276	pr_info(HEST_PFX "Table parsing has been initialized.\n");
b6a95016 HY	277	return;
9dc96664 HY	278	err:
9dc96664 HY	279	hest_disable = 1;
9dc96664	280	}