xref: /netbsd-src/sys/dev/acpi/apei_hestvar.h (revision 4b159fe528de68c639f4f9cd4d8b3ef59df8a58d)
1 /*	$NetBSD: apei_hestvar.h,v 1.1 2024/03/20 17:11:43 riastradh Exp $	*/
2 
3 /*-
4  * Copyright (c) 2024 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
17  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
18  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
20  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  * POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 #ifndef	_SYS_DEV_ACPI_APEI_HESTVAR_H_
30 #define	_SYS_DEV_ACPI_APEI_HESTVAR_H_
31 
32 #include <sys/queue.h>
33 #include <sys/callout.h>
34 
35 #include <dev/acpi/acpivar.h>
36 
37 struct apei_mapreg;
38 struct apei_softc;
39 
40 #if defined(__i386__) || defined(__x86_64__)
41 struct nmi_handler;
42 #endif
43 
44 /*
45  * struct apei_source
46  *
47  *	Software state for a hardware error source from the HEST,
48  *	Hardware Error Source Table, to process error notifications.
49  */
50 struct apei_source {
51 	struct apei_softc		*as_sc;
52 	ACPI_HEST_HEADER		*as_header;
53 	union {
54 		struct {
55 			ACPI_HEST_GENERIC_STATUS	*gesb;
56 		}			as_ghes;
57 		struct {
58 			ACPI_HEST_GENERIC_STATUS	*gesb;
59 			struct apei_mapreg		*read_ack;
60 		}			as_ghes_v2;
61 	};
62 	union {
63 		struct callout			as_ch;
64 #if defined(__i386__) || defined(__x86_64__)
65 		struct nmi_handler		*as_nmi;
66 #endif
67 		SIMPLEQ_ENTRY(apei_source)	as_entry;
68 	};
69 };
70 
71 /*
72  * struct apei_hest_softc
73  *
74  *	Software state for processing hardware error reports during
75  *	operation, from the HEST, Hardware Error Source table.
76  */
77 struct apei_hest_softc {
78 	struct apei_source		*hsc_source;
79 	SIMPLEQ_HEAD(, apei_source)	hsc_hed_list;
80 };
81 
82 void apei_hest_attach(struct apei_softc *);
83 void apei_hest_detach(struct apei_softc *);
84 
85 #endif	/* _SYS_DEV_ACPI_APEI_HESTVAR_H_ */
86