xref: /freebsd/sys/powerpc/powernv/opal_hmi.c (revision 22cf89c938886d14f5796fc49f9f020c23ea8eaf)
1 /*-
2  * Copyright (c) 2019 Justin Hibbits
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
18  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25 
26 #include <sys/cdefs.h>
27 #include <sys/param.h>
28 #include <sys/types.h>
29 #include <sys/eventhandler.h>
30 #include <sys/kernel.h>
31 #include <sys/systm.h>
32 #include <sys/endian.h>
33 
34 #include <vm/vm.h>
35 #include <vm/pmap.h>
36 
37 #include <machine/spr.h>
38 #include <machine/trap.h>
39 #include "opal.h"
40 
41 struct opal_hmi_event {
42 	uint8_t 	version;
43 	uint8_t 	severity;
44 	uint8_t 	type;
45 	uint8_t 	disposition;
46 	uint8_t 	rsvd_1[4];
47 	uint64_t	hmer;
48 	uint64_t	tfmr;
49 	union {
50 		struct {
51 			uint8_t 	xstop_type;
52 			uint8_t 	rsvd_2[3];
53 			uint32_t	xstop_reason;
54 			union {
55 				uint32_t	pir;
56 				uint32_t	chip_id;
57 			};
58 		};
59 	};
60 };
61 
62 #define	HMI_DISP_RECOVERED	0
63 #define	HMI_DISP_NOT_RECOVERED	1
64 
65 static void
66 opal_hmi_event_handler(void *unused, struct opal_msg *msg)
67 {
68 	struct opal_hmi_event	evt;
69 
70 	memcpy(&evt, &msg->params, sizeof(evt));
71 	printf("Hypervisor Maintenance Event received"
72 	    "(Severity %d, type %d, HMER: %016lx).\n",
73 	    evt.severity, evt.type, evt.hmer);
74 
75 	if (evt.disposition == HMI_DISP_NOT_RECOVERED)
76 		panic("Unrecoverable hypervisor maintenance exception on CPU %d",
77 		    evt.pir);
78 
79 	return;
80 }
81 
82 static int
83 opal_hmi_handler2(struct trapframe *frame)
84 {
85 	/*
86 	 * Use DMAP preallocated pcpu memory to handle
87 	 * the phys flags pointer.
88 	 */
89 	uint64_t *flags = PCPU_PTR(aim.opal_hmi_flags);
90 	int err;
91 
92 	*flags = 0;
93 	err = opal_call(OPAL_HANDLE_HMI2, DMAP_TO_PHYS((vm_offset_t)flags));
94 
95 	if (be64toh(*flags) & OPAL_HMI_FLAGS_TOD_TB_FAIL)
96 		panic("TOD/TB recovery failure");
97 
98 	if (err == OPAL_SUCCESS)
99 		return (0);
100 
101 	printf("HMI handler failed!  OPAL error code: %d\n", err);
102 
103 	return (-1);
104 }
105 
106 static int
107 opal_hmi_handler(struct trapframe *frame)
108 {
109 	int err;
110 
111 	err = opal_call(OPAL_HANDLE_HMI);
112 
113 	if (err == OPAL_SUCCESS)
114 		return (0);
115 
116 	printf("HMI handler failed!  OPAL error code: %d\n", err);
117 
118 	return (-1);
119 }
120 
121 static void
122 opal_setup_hmi(void *data)
123 {
124 	/* This only works for OPAL, so first make sure we have it. */
125 	if (opal_check() != 0)
126 		return;
127 
128 	if (opal_call(OPAL_CHECK_TOKEN, OPAL_HANDLE_HMI2) == OPAL_TOKEN_PRESENT)
129 		hmi_handler = opal_hmi_handler2;
130 	else if (opal_call(OPAL_CHECK_TOKEN, OPAL_HANDLE_HMI) == OPAL_TOKEN_PRESENT)
131 		hmi_handler = opal_hmi_handler;
132 	else {
133 		printf("Warning: No OPAL HMI handler found.\n");
134 		return;
135 	}
136 
137 	EVENTHANDLER_REGISTER(OPAL_HMI_EVT, opal_hmi_event_handler, NULL,
138 	    EVENTHANDLER_PRI_ANY);
139 
140 	if (bootverbose)
141 		printf("Installed OPAL HMI handler.\n");
142 }
143 
144 SYSINIT(opal_setup_hmi, SI_SUB_CPU, SI_ORDER_ANY, opal_setup_hmi, NULL);
145