xref: /openbmc/linux/drivers/acpi/apei/einj.c (revision 9cfc5c90)
1 /*
2  * APEI Error INJection support
3  *
4  * EINJ provides a hardware error injection mechanism, this is useful
5  * for debugging and testing of other APEI and RAS features.
6  *
7  * For more information about EINJ, please refer to ACPI Specification
8  * version 4.0, section 17.5.
9  *
10  * Copyright 2009-2010 Intel Corp.
11  *   Author: Huang Ying <ying.huang@intel.com>
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License version
15  * 2 as published by the Free Software Foundation.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  */
22 
23 #include <linux/kernel.h>
24 #include <linux/module.h>
25 #include <linux/init.h>
26 #include <linux/io.h>
27 #include <linux/debugfs.h>
28 #include <linux/seq_file.h>
29 #include <linux/nmi.h>
30 #include <linux/delay.h>
31 #include <linux/mm.h>
32 #include <asm/unaligned.h>
33 
34 #include "apei-internal.h"
35 
36 #define EINJ_PFX "EINJ: "
37 
38 #define SPIN_UNIT		100			/* 100ns */
39 /* Firmware should respond within 1 milliseconds */
40 #define FIRMWARE_TIMEOUT	(1 * NSEC_PER_MSEC)
41 #define ACPI5_VENDOR_BIT	BIT(31)
42 #define MEM_ERROR_MASK		(ACPI_EINJ_MEMORY_CORRECTABLE | \
43 				ACPI_EINJ_MEMORY_UNCORRECTABLE | \
44 				ACPI_EINJ_MEMORY_FATAL)
45 
46 /*
47  * ACPI version 5 provides a SET_ERROR_TYPE_WITH_ADDRESS action.
48  */
49 static int acpi5;
50 
51 struct set_error_type_with_address {
52 	u32	type;
53 	u32	vendor_extension;
54 	u32	flags;
55 	u32	apicid;
56 	u64	memory_address;
57 	u64	memory_address_range;
58 	u32	pcie_sbdf;
59 };
60 enum {
61 	SETWA_FLAGS_APICID = 1,
62 	SETWA_FLAGS_MEM = 2,
63 	SETWA_FLAGS_PCIE_SBDF = 4,
64 };
65 
66 /*
67  * Vendor extensions for platform specific operations
68  */
69 struct vendor_error_type_extension {
70 	u32	length;
71 	u32	pcie_sbdf;
72 	u16	vendor_id;
73 	u16	device_id;
74 	u8	rev_id;
75 	u8	reserved[3];
76 };
77 
78 static u32 notrigger;
79 
80 static u32 vendor_flags;
81 static struct debugfs_blob_wrapper vendor_blob;
82 static char vendor_dev[64];
83 
84 /*
85  * Some BIOSes allow parameters to the SET_ERROR_TYPE entries in the
86  * EINJ table through an unpublished extension. Use with caution as
87  * most will ignore the parameter and make their own choice of address
88  * for error injection.  This extension is used only if
89  * param_extension module parameter is specified.
90  */
91 struct einj_parameter {
92 	u64 type;
93 	u64 reserved1;
94 	u64 reserved2;
95 	u64 param1;
96 	u64 param2;
97 };
98 
99 #define EINJ_OP_BUSY			0x1
100 #define EINJ_STATUS_SUCCESS		0x0
101 #define EINJ_STATUS_FAIL		0x1
102 #define EINJ_STATUS_INVAL		0x2
103 
104 #define EINJ_TAB_ENTRY(tab)						\
105 	((struct acpi_whea_header *)((char *)(tab) +			\
106 				    sizeof(struct acpi_table_einj)))
107 
108 static bool param_extension;
109 module_param(param_extension, bool, 0);
110 
111 static struct acpi_table_einj *einj_tab;
112 
113 static struct apei_resources einj_resources;
114 
115 static struct apei_exec_ins_type einj_ins_type[] = {
116 	[ACPI_EINJ_READ_REGISTER] = {
117 		.flags = APEI_EXEC_INS_ACCESS_REGISTER,
118 		.run   = apei_exec_read_register,
119 	},
120 	[ACPI_EINJ_READ_REGISTER_VALUE] = {
121 		.flags = APEI_EXEC_INS_ACCESS_REGISTER,
122 		.run   = apei_exec_read_register_value,
123 	},
124 	[ACPI_EINJ_WRITE_REGISTER] = {
125 		.flags = APEI_EXEC_INS_ACCESS_REGISTER,
126 		.run   = apei_exec_write_register,
127 	},
128 	[ACPI_EINJ_WRITE_REGISTER_VALUE] = {
129 		.flags = APEI_EXEC_INS_ACCESS_REGISTER,
130 		.run   = apei_exec_write_register_value,
131 	},
132 	[ACPI_EINJ_NOOP] = {
133 		.flags = 0,
134 		.run   = apei_exec_noop,
135 	},
136 };
137 
138 /*
139  * Prevent EINJ interpreter to run simultaneously, because the
140  * corresponding firmware implementation may not work properly when
141  * invoked simultaneously.
142  */
143 static DEFINE_MUTEX(einj_mutex);
144 
145 static void *einj_param;
146 
147 static void einj_exec_ctx_init(struct apei_exec_context *ctx)
148 {
149 	apei_exec_ctx_init(ctx, einj_ins_type, ARRAY_SIZE(einj_ins_type),
150 			   EINJ_TAB_ENTRY(einj_tab), einj_tab->entries);
151 }
152 
153 static int __einj_get_available_error_type(u32 *type)
154 {
155 	struct apei_exec_context ctx;
156 	int rc;
157 
158 	einj_exec_ctx_init(&ctx);
159 	rc = apei_exec_run(&ctx, ACPI_EINJ_GET_ERROR_TYPE);
160 	if (rc)
161 		return rc;
162 	*type = apei_exec_ctx_get_output(&ctx);
163 
164 	return 0;
165 }
166 
167 /* Get error injection capabilities of the platform */
168 static int einj_get_available_error_type(u32 *type)
169 {
170 	int rc;
171 
172 	mutex_lock(&einj_mutex);
173 	rc = __einj_get_available_error_type(type);
174 	mutex_unlock(&einj_mutex);
175 
176 	return rc;
177 }
178 
179 static int einj_timedout(u64 *t)
180 {
181 	if ((s64)*t < SPIN_UNIT) {
182 		pr_warning(FW_WARN EINJ_PFX
183 			   "Firmware does not respond in time\n");
184 		return 1;
185 	}
186 	*t -= SPIN_UNIT;
187 	ndelay(SPIN_UNIT);
188 	touch_nmi_watchdog();
189 	return 0;
190 }
191 
192 static void check_vendor_extension(u64 paddr,
193 				   struct set_error_type_with_address *v5param)
194 {
195 	int	offset = v5param->vendor_extension;
196 	struct	vendor_error_type_extension *v;
197 	u32	sbdf;
198 
199 	if (!offset)
200 		return;
201 	v = acpi_os_map_iomem(paddr + offset, sizeof(*v));
202 	if (!v)
203 		return;
204 	sbdf = v->pcie_sbdf;
205 	sprintf(vendor_dev, "%x:%x:%x.%x vendor_id=%x device_id=%x rev_id=%x\n",
206 		sbdf >> 24, (sbdf >> 16) & 0xff,
207 		(sbdf >> 11) & 0x1f, (sbdf >> 8) & 0x7,
208 		 v->vendor_id, v->device_id, v->rev_id);
209 	acpi_os_unmap_iomem(v, sizeof(*v));
210 }
211 
212 static void *einj_get_parameter_address(void)
213 {
214 	int i;
215 	u64 pa_v4 = 0, pa_v5 = 0;
216 	struct acpi_whea_header *entry;
217 
218 	entry = EINJ_TAB_ENTRY(einj_tab);
219 	for (i = 0; i < einj_tab->entries; i++) {
220 		if (entry->action == ACPI_EINJ_SET_ERROR_TYPE &&
221 		    entry->instruction == ACPI_EINJ_WRITE_REGISTER &&
222 		    entry->register_region.space_id ==
223 		    ACPI_ADR_SPACE_SYSTEM_MEMORY)
224 			pa_v4 = get_unaligned(&entry->register_region.address);
225 		if (entry->action == ACPI_EINJ_SET_ERROR_TYPE_WITH_ADDRESS &&
226 		    entry->instruction == ACPI_EINJ_WRITE_REGISTER &&
227 		    entry->register_region.space_id ==
228 		    ACPI_ADR_SPACE_SYSTEM_MEMORY)
229 			pa_v5 = get_unaligned(&entry->register_region.address);
230 		entry++;
231 	}
232 	if (pa_v5) {
233 		struct set_error_type_with_address *v5param;
234 
235 		v5param = acpi_os_map_iomem(pa_v5, sizeof(*v5param));
236 		if (v5param) {
237 			acpi5 = 1;
238 			check_vendor_extension(pa_v5, v5param);
239 			return v5param;
240 		}
241 	}
242 	if (param_extension && pa_v4) {
243 		struct einj_parameter *v4param;
244 
245 		v4param = acpi_os_map_iomem(pa_v4, sizeof(*v4param));
246 		if (!v4param)
247 			return NULL;
248 		if (v4param->reserved1 || v4param->reserved2) {
249 			acpi_os_unmap_iomem(v4param, sizeof(*v4param));
250 			return NULL;
251 		}
252 		return v4param;
253 	}
254 
255 	return NULL;
256 }
257 
258 /* do sanity check to trigger table */
259 static int einj_check_trigger_header(struct acpi_einj_trigger *trigger_tab)
260 {
261 	if (trigger_tab->header_size != sizeof(struct acpi_einj_trigger))
262 		return -EINVAL;
263 	if (trigger_tab->table_size > PAGE_SIZE ||
264 	    trigger_tab->table_size < trigger_tab->header_size)
265 		return -EINVAL;
266 	if (trigger_tab->entry_count !=
267 	    (trigger_tab->table_size - trigger_tab->header_size) /
268 	    sizeof(struct acpi_einj_entry))
269 		return -EINVAL;
270 
271 	return 0;
272 }
273 
274 static struct acpi_generic_address *einj_get_trigger_parameter_region(
275 	struct acpi_einj_trigger *trigger_tab, u64 param1, u64 param2)
276 {
277 	int i;
278 	struct acpi_whea_header *entry;
279 
280 	entry = (struct acpi_whea_header *)
281 		((char *)trigger_tab + sizeof(struct acpi_einj_trigger));
282 	for (i = 0; i < trigger_tab->entry_count; i++) {
283 		if (entry->action == ACPI_EINJ_TRIGGER_ERROR &&
284 		entry->instruction == ACPI_EINJ_WRITE_REGISTER_VALUE &&
285 		entry->register_region.space_id ==
286 			ACPI_ADR_SPACE_SYSTEM_MEMORY &&
287 		(entry->register_region.address & param2) == (param1 & param2))
288 			return &entry->register_region;
289 		entry++;
290 	}
291 
292 	return NULL;
293 }
294 /* Execute instructions in trigger error action table */
295 static int __einj_error_trigger(u64 trigger_paddr, u32 type,
296 				u64 param1, u64 param2)
297 {
298 	struct acpi_einj_trigger *trigger_tab = NULL;
299 	struct apei_exec_context trigger_ctx;
300 	struct apei_resources trigger_resources;
301 	struct acpi_whea_header *trigger_entry;
302 	struct resource *r;
303 	u32 table_size;
304 	int rc = -EIO;
305 	struct acpi_generic_address *trigger_param_region = NULL;
306 
307 	r = request_mem_region(trigger_paddr, sizeof(*trigger_tab),
308 			       "APEI EINJ Trigger Table");
309 	if (!r) {
310 		pr_err(EINJ_PFX
311 	"Can not request [mem %#010llx-%#010llx] for Trigger table\n",
312 		       (unsigned long long)trigger_paddr,
313 		       (unsigned long long)trigger_paddr +
314 			    sizeof(*trigger_tab) - 1);
315 		goto out;
316 	}
317 	trigger_tab = ioremap_cache(trigger_paddr, sizeof(*trigger_tab));
318 	if (!trigger_tab) {
319 		pr_err(EINJ_PFX "Failed to map trigger table!\n");
320 		goto out_rel_header;
321 	}
322 	rc = einj_check_trigger_header(trigger_tab);
323 	if (rc) {
324 		pr_warning(FW_BUG EINJ_PFX
325 			   "The trigger error action table is invalid\n");
326 		goto out_rel_header;
327 	}
328 
329 	/* No action structures in the TRIGGER_ERROR table, nothing to do */
330 	if (!trigger_tab->entry_count)
331 		goto out_rel_header;
332 
333 	rc = -EIO;
334 	table_size = trigger_tab->table_size;
335 	r = request_mem_region(trigger_paddr + sizeof(*trigger_tab),
336 			       table_size - sizeof(*trigger_tab),
337 			       "APEI EINJ Trigger Table");
338 	if (!r) {
339 		pr_err(EINJ_PFX
340 "Can not request [mem %#010llx-%#010llx] for Trigger Table Entry\n",
341 		       (unsigned long long)trigger_paddr + sizeof(*trigger_tab),
342 		       (unsigned long long)trigger_paddr + table_size - 1);
343 		goto out_rel_header;
344 	}
345 	iounmap(trigger_tab);
346 	trigger_tab = ioremap_cache(trigger_paddr, table_size);
347 	if (!trigger_tab) {
348 		pr_err(EINJ_PFX "Failed to map trigger table!\n");
349 		goto out_rel_entry;
350 	}
351 	trigger_entry = (struct acpi_whea_header *)
352 		((char *)trigger_tab + sizeof(struct acpi_einj_trigger));
353 	apei_resources_init(&trigger_resources);
354 	apei_exec_ctx_init(&trigger_ctx, einj_ins_type,
355 			   ARRAY_SIZE(einj_ins_type),
356 			   trigger_entry, trigger_tab->entry_count);
357 	rc = apei_exec_collect_resources(&trigger_ctx, &trigger_resources);
358 	if (rc)
359 		goto out_fini;
360 	rc = apei_resources_sub(&trigger_resources, &einj_resources);
361 	if (rc)
362 		goto out_fini;
363 	/*
364 	 * Some firmware will access target address specified in
365 	 * param1 to trigger the error when injecting memory error.
366 	 * This will cause resource conflict with regular memory.  So
367 	 * remove it from trigger table resources.
368 	 */
369 	if ((param_extension || acpi5) && (type & MEM_ERROR_MASK) && param2) {
370 		struct apei_resources addr_resources;
371 		apei_resources_init(&addr_resources);
372 		trigger_param_region = einj_get_trigger_parameter_region(
373 			trigger_tab, param1, param2);
374 		if (trigger_param_region) {
375 			rc = apei_resources_add(&addr_resources,
376 				trigger_param_region->address,
377 				trigger_param_region->bit_width/8, true);
378 			if (rc)
379 				goto out_fini;
380 			rc = apei_resources_sub(&trigger_resources,
381 					&addr_resources);
382 		}
383 		apei_resources_fini(&addr_resources);
384 		if (rc)
385 			goto out_fini;
386 	}
387 	rc = apei_resources_request(&trigger_resources, "APEI EINJ Trigger");
388 	if (rc)
389 		goto out_fini;
390 	rc = apei_exec_pre_map_gars(&trigger_ctx);
391 	if (rc)
392 		goto out_release;
393 
394 	rc = apei_exec_run(&trigger_ctx, ACPI_EINJ_TRIGGER_ERROR);
395 
396 	apei_exec_post_unmap_gars(&trigger_ctx);
397 out_release:
398 	apei_resources_release(&trigger_resources);
399 out_fini:
400 	apei_resources_fini(&trigger_resources);
401 out_rel_entry:
402 	release_mem_region(trigger_paddr + sizeof(*trigger_tab),
403 			   table_size - sizeof(*trigger_tab));
404 out_rel_header:
405 	release_mem_region(trigger_paddr, sizeof(*trigger_tab));
406 out:
407 	if (trigger_tab)
408 		iounmap(trigger_tab);
409 
410 	return rc;
411 }
412 
413 static int __einj_error_inject(u32 type, u32 flags, u64 param1, u64 param2,
414 			       u64 param3, u64 param4)
415 {
416 	struct apei_exec_context ctx;
417 	u64 val, trigger_paddr, timeout = FIRMWARE_TIMEOUT;
418 	int rc;
419 
420 	einj_exec_ctx_init(&ctx);
421 
422 	rc = apei_exec_run_optional(&ctx, ACPI_EINJ_BEGIN_OPERATION);
423 	if (rc)
424 		return rc;
425 	apei_exec_ctx_set_input(&ctx, type);
426 	if (acpi5) {
427 		struct set_error_type_with_address *v5param = einj_param;
428 
429 		v5param->type = type;
430 		if (type & ACPI5_VENDOR_BIT) {
431 			switch (vendor_flags) {
432 			case SETWA_FLAGS_APICID:
433 				v5param->apicid = param1;
434 				break;
435 			case SETWA_FLAGS_MEM:
436 				v5param->memory_address = param1;
437 				v5param->memory_address_range = param2;
438 				break;
439 			case SETWA_FLAGS_PCIE_SBDF:
440 				v5param->pcie_sbdf = param1;
441 				break;
442 			}
443 			v5param->flags = vendor_flags;
444 		} else if (flags) {
445 				v5param->flags = flags;
446 				v5param->memory_address = param1;
447 				v5param->memory_address_range = param2;
448 				v5param->apicid = param3;
449 				v5param->pcie_sbdf = param4;
450 		} else {
451 			switch (type) {
452 			case ACPI_EINJ_PROCESSOR_CORRECTABLE:
453 			case ACPI_EINJ_PROCESSOR_UNCORRECTABLE:
454 			case ACPI_EINJ_PROCESSOR_FATAL:
455 				v5param->apicid = param1;
456 				v5param->flags = SETWA_FLAGS_APICID;
457 				break;
458 			case ACPI_EINJ_MEMORY_CORRECTABLE:
459 			case ACPI_EINJ_MEMORY_UNCORRECTABLE:
460 			case ACPI_EINJ_MEMORY_FATAL:
461 				v5param->memory_address = param1;
462 				v5param->memory_address_range = param2;
463 				v5param->flags = SETWA_FLAGS_MEM;
464 				break;
465 			case ACPI_EINJ_PCIX_CORRECTABLE:
466 			case ACPI_EINJ_PCIX_UNCORRECTABLE:
467 			case ACPI_EINJ_PCIX_FATAL:
468 				v5param->pcie_sbdf = param1;
469 				v5param->flags = SETWA_FLAGS_PCIE_SBDF;
470 				break;
471 			}
472 		}
473 	} else {
474 		rc = apei_exec_run(&ctx, ACPI_EINJ_SET_ERROR_TYPE);
475 		if (rc)
476 			return rc;
477 		if (einj_param) {
478 			struct einj_parameter *v4param = einj_param;
479 			v4param->param1 = param1;
480 			v4param->param2 = param2;
481 		}
482 	}
483 	rc = apei_exec_run(&ctx, ACPI_EINJ_EXECUTE_OPERATION);
484 	if (rc)
485 		return rc;
486 	for (;;) {
487 		rc = apei_exec_run(&ctx, ACPI_EINJ_CHECK_BUSY_STATUS);
488 		if (rc)
489 			return rc;
490 		val = apei_exec_ctx_get_output(&ctx);
491 		if (!(val & EINJ_OP_BUSY))
492 			break;
493 		if (einj_timedout(&timeout))
494 			return -EIO;
495 	}
496 	rc = apei_exec_run(&ctx, ACPI_EINJ_GET_COMMAND_STATUS);
497 	if (rc)
498 		return rc;
499 	val = apei_exec_ctx_get_output(&ctx);
500 	if (val != EINJ_STATUS_SUCCESS)
501 		return -EBUSY;
502 
503 	rc = apei_exec_run(&ctx, ACPI_EINJ_GET_TRIGGER_TABLE);
504 	if (rc)
505 		return rc;
506 	trigger_paddr = apei_exec_ctx_get_output(&ctx);
507 	if (notrigger == 0) {
508 		rc = __einj_error_trigger(trigger_paddr, type, param1, param2);
509 		if (rc)
510 			return rc;
511 	}
512 	rc = apei_exec_run_optional(&ctx, ACPI_EINJ_END_OPERATION);
513 
514 	return rc;
515 }
516 
517 /* Inject the specified hardware error */
518 static int einj_error_inject(u32 type, u32 flags, u64 param1, u64 param2,
519 			     u64 param3, u64 param4)
520 {
521 	int rc;
522 	unsigned long pfn;
523 
524 	/* If user manually set "flags", make sure it is legal */
525 	if (flags && (flags &
526 		~(SETWA_FLAGS_APICID|SETWA_FLAGS_MEM|SETWA_FLAGS_PCIE_SBDF)))
527 		return -EINVAL;
528 
529 	/*
530 	 * We need extra sanity checks for memory errors.
531 	 * Other types leap directly to injection.
532 	 */
533 
534 	/* ensure param1/param2 existed */
535 	if (!(param_extension || acpi5))
536 		goto inject;
537 
538 	/* ensure injection is memory related */
539 	if (type & ACPI5_VENDOR_BIT) {
540 		if (vendor_flags != SETWA_FLAGS_MEM)
541 			goto inject;
542 	} else if (!(type & MEM_ERROR_MASK) && !(flags & SETWA_FLAGS_MEM))
543 		goto inject;
544 
545 	/*
546 	 * Disallow crazy address masks that give BIOS leeway to pick
547 	 * injection address almost anywhere. Insist on page or
548 	 * better granularity and that target address is normal RAM.
549 	 */
550 	pfn = PFN_DOWN(param1 & param2);
551 	if (!page_is_ram(pfn) || ((param2 & PAGE_MASK) != PAGE_MASK))
552 		return -EINVAL;
553 
554 inject:
555 	mutex_lock(&einj_mutex);
556 	rc = __einj_error_inject(type, flags, param1, param2, param3, param4);
557 	mutex_unlock(&einj_mutex);
558 
559 	return rc;
560 }
561 
562 static u32 error_type;
563 static u32 error_flags;
564 static u64 error_param1;
565 static u64 error_param2;
566 static u64 error_param3;
567 static u64 error_param4;
568 static struct dentry *einj_debug_dir;
569 
570 static int available_error_type_show(struct seq_file *m, void *v)
571 {
572 	int rc;
573 	u32 available_error_type = 0;
574 
575 	rc = einj_get_available_error_type(&available_error_type);
576 	if (rc)
577 		return rc;
578 	if (available_error_type & 0x0001)
579 		seq_printf(m, "0x00000001\tProcessor Correctable\n");
580 	if (available_error_type & 0x0002)
581 		seq_printf(m, "0x00000002\tProcessor Uncorrectable non-fatal\n");
582 	if (available_error_type & 0x0004)
583 		seq_printf(m, "0x00000004\tProcessor Uncorrectable fatal\n");
584 	if (available_error_type & 0x0008)
585 		seq_printf(m, "0x00000008\tMemory Correctable\n");
586 	if (available_error_type & 0x0010)
587 		seq_printf(m, "0x00000010\tMemory Uncorrectable non-fatal\n");
588 	if (available_error_type & 0x0020)
589 		seq_printf(m, "0x00000020\tMemory Uncorrectable fatal\n");
590 	if (available_error_type & 0x0040)
591 		seq_printf(m, "0x00000040\tPCI Express Correctable\n");
592 	if (available_error_type & 0x0080)
593 		seq_printf(m, "0x00000080\tPCI Express Uncorrectable non-fatal\n");
594 	if (available_error_type & 0x0100)
595 		seq_printf(m, "0x00000100\tPCI Express Uncorrectable fatal\n");
596 	if (available_error_type & 0x0200)
597 		seq_printf(m, "0x00000200\tPlatform Correctable\n");
598 	if (available_error_type & 0x0400)
599 		seq_printf(m, "0x00000400\tPlatform Uncorrectable non-fatal\n");
600 	if (available_error_type & 0x0800)
601 		seq_printf(m, "0x00000800\tPlatform Uncorrectable fatal\n");
602 
603 	return 0;
604 }
605 
606 static int available_error_type_open(struct inode *inode, struct file *file)
607 {
608 	return single_open(file, available_error_type_show, NULL);
609 }
610 
611 static const struct file_operations available_error_type_fops = {
612 	.open		= available_error_type_open,
613 	.read		= seq_read,
614 	.llseek		= seq_lseek,
615 	.release	= single_release,
616 };
617 
618 static int error_type_get(void *data, u64 *val)
619 {
620 	*val = error_type;
621 
622 	return 0;
623 }
624 
625 static int error_type_set(void *data, u64 val)
626 {
627 	int rc;
628 	u32 available_error_type = 0;
629 	u32 tval, vendor;
630 
631 	/*
632 	 * Vendor defined types have 0x80000000 bit set, and
633 	 * are not enumerated by ACPI_EINJ_GET_ERROR_TYPE
634 	 */
635 	vendor = val & ACPI5_VENDOR_BIT;
636 	tval = val & 0x7fffffff;
637 
638 	/* Only one error type can be specified */
639 	if (tval & (tval - 1))
640 		return -EINVAL;
641 	if (!vendor) {
642 		rc = einj_get_available_error_type(&available_error_type);
643 		if (rc)
644 			return rc;
645 		if (!(val & available_error_type))
646 			return -EINVAL;
647 	}
648 	error_type = val;
649 
650 	return 0;
651 }
652 
653 DEFINE_SIMPLE_ATTRIBUTE(error_type_fops, error_type_get,
654 			error_type_set, "0x%llx\n");
655 
656 static int error_inject_set(void *data, u64 val)
657 {
658 	if (!error_type)
659 		return -EINVAL;
660 
661 	return einj_error_inject(error_type, error_flags, error_param1, error_param2,
662 		error_param3, error_param4);
663 }
664 
665 DEFINE_SIMPLE_ATTRIBUTE(error_inject_fops, NULL,
666 			error_inject_set, "%llu\n");
667 
668 static int einj_check_table(struct acpi_table_einj *einj_tab)
669 {
670 	if ((einj_tab->header_length !=
671 	     (sizeof(struct acpi_table_einj) - sizeof(einj_tab->header)))
672 	    && (einj_tab->header_length != sizeof(struct acpi_table_einj)))
673 		return -EINVAL;
674 	if (einj_tab->header.length < sizeof(struct acpi_table_einj))
675 		return -EINVAL;
676 	if (einj_tab->entries !=
677 	    (einj_tab->header.length - sizeof(struct acpi_table_einj)) /
678 	    sizeof(struct acpi_einj_entry))
679 		return -EINVAL;
680 
681 	return 0;
682 }
683 
684 static int __init einj_init(void)
685 {
686 	int rc;
687 	acpi_status status;
688 	struct dentry *fentry;
689 	struct apei_exec_context ctx;
690 
691 	if (acpi_disabled)
692 		return -ENODEV;
693 
694 	status = acpi_get_table(ACPI_SIG_EINJ, 0,
695 				(struct acpi_table_header **)&einj_tab);
696 	if (status == AE_NOT_FOUND)
697 		return -ENODEV;
698 	else if (ACPI_FAILURE(status)) {
699 		const char *msg = acpi_format_exception(status);
700 		pr_err(EINJ_PFX "Failed to get table, %s\n", msg);
701 		return -EINVAL;
702 	}
703 
704 	rc = einj_check_table(einj_tab);
705 	if (rc) {
706 		pr_warning(FW_BUG EINJ_PFX "EINJ table is invalid\n");
707 		return -EINVAL;
708 	}
709 
710 	rc = -ENOMEM;
711 	einj_debug_dir = debugfs_create_dir("einj", apei_get_debugfs_dir());
712 	if (!einj_debug_dir)
713 		goto err_cleanup;
714 	fentry = debugfs_create_file("available_error_type", S_IRUSR,
715 				     einj_debug_dir, NULL,
716 				     &available_error_type_fops);
717 	if (!fentry)
718 		goto err_cleanup;
719 	fentry = debugfs_create_file("error_type", S_IRUSR | S_IWUSR,
720 				     einj_debug_dir, NULL, &error_type_fops);
721 	if (!fentry)
722 		goto err_cleanup;
723 	fentry = debugfs_create_file("error_inject", S_IWUSR,
724 				     einj_debug_dir, NULL, &error_inject_fops);
725 	if (!fentry)
726 		goto err_cleanup;
727 
728 	apei_resources_init(&einj_resources);
729 	einj_exec_ctx_init(&ctx);
730 	rc = apei_exec_collect_resources(&ctx, &einj_resources);
731 	if (rc)
732 		goto err_fini;
733 	rc = apei_resources_request(&einj_resources, "APEI EINJ");
734 	if (rc)
735 		goto err_fini;
736 	rc = apei_exec_pre_map_gars(&ctx);
737 	if (rc)
738 		goto err_release;
739 
740 	rc = -ENOMEM;
741 	einj_param = einj_get_parameter_address();
742 	if ((param_extension || acpi5) && einj_param) {
743 		fentry = debugfs_create_x32("flags", S_IRUSR | S_IWUSR,
744 					    einj_debug_dir, &error_flags);
745 		if (!fentry)
746 			goto err_unmap;
747 		fentry = debugfs_create_x64("param1", S_IRUSR | S_IWUSR,
748 					    einj_debug_dir, &error_param1);
749 		if (!fentry)
750 			goto err_unmap;
751 		fentry = debugfs_create_x64("param2", S_IRUSR | S_IWUSR,
752 					    einj_debug_dir, &error_param2);
753 		if (!fentry)
754 			goto err_unmap;
755 		fentry = debugfs_create_x64("param3", S_IRUSR | S_IWUSR,
756 					    einj_debug_dir, &error_param3);
757 		if (!fentry)
758 			goto err_unmap;
759 		fentry = debugfs_create_x64("param4", S_IRUSR | S_IWUSR,
760 					    einj_debug_dir, &error_param4);
761 		if (!fentry)
762 			goto err_unmap;
763 
764 		fentry = debugfs_create_x32("notrigger", S_IRUSR | S_IWUSR,
765 					    einj_debug_dir, &notrigger);
766 		if (!fentry)
767 			goto err_unmap;
768 	}
769 
770 	if (vendor_dev[0]) {
771 		vendor_blob.data = vendor_dev;
772 		vendor_blob.size = strlen(vendor_dev);
773 		fentry = debugfs_create_blob("vendor", S_IRUSR,
774 					     einj_debug_dir, &vendor_blob);
775 		if (!fentry)
776 			goto err_unmap;
777 		fentry = debugfs_create_x32("vendor_flags", S_IRUSR | S_IWUSR,
778 					    einj_debug_dir, &vendor_flags);
779 		if (!fentry)
780 			goto err_unmap;
781 	}
782 
783 	pr_info(EINJ_PFX "Error INJection is initialized.\n");
784 
785 	return 0;
786 
787 err_unmap:
788 	if (einj_param) {
789 		acpi_size size = (acpi5) ?
790 			sizeof(struct set_error_type_with_address) :
791 			sizeof(struct einj_parameter);
792 
793 		acpi_os_unmap_iomem(einj_param, size);
794 	}
795 	apei_exec_post_unmap_gars(&ctx);
796 err_release:
797 	apei_resources_release(&einj_resources);
798 err_fini:
799 	apei_resources_fini(&einj_resources);
800 err_cleanup:
801 	debugfs_remove_recursive(einj_debug_dir);
802 
803 	return rc;
804 }
805 
806 static void __exit einj_exit(void)
807 {
808 	struct apei_exec_context ctx;
809 
810 	if (einj_param) {
811 		acpi_size size = (acpi5) ?
812 			sizeof(struct set_error_type_with_address) :
813 			sizeof(struct einj_parameter);
814 
815 		acpi_os_unmap_iomem(einj_param, size);
816 	}
817 	einj_exec_ctx_init(&ctx);
818 	apei_exec_post_unmap_gars(&ctx);
819 	apei_resources_release(&einj_resources);
820 	apei_resources_fini(&einj_resources);
821 	debugfs_remove_recursive(einj_debug_dir);
822 }
823 
824 module_init(einj_init);
825 module_exit(einj_exit);
826 
827 MODULE_AUTHOR("Huang Ying");
828 MODULE_DESCRIPTION("APEI Error INJection support");
829 MODULE_LICENSE("GPL");
830