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__FBSDID("$FreeBSD$");
28
29#include <sys/param.h>
30#include <sys/types.h>
31#include <sys/eventhandler.h>
32#include <sys/kernel.h>
33#include <sys/systm.h>
34#include <sys/endian.h>
35
36#include <vm/vm.h>
37#include <vm/pmap.h>
38
39#include <machine/spr.h>
40#include <machine/trap.h>
41#include "opal.h"
42
43struct opal_hmi_event {
44	uint8_t 	version;
45	uint8_t 	severity;
46	uint8_t 	type;
47	uint8_t 	disposition;
48	uint8_t 	rsvd_1[4];
49	uint64_t	hmer;
50	uint64_t	tfmr;
51	union {
52		struct {
53			uint8_t 	xstop_type;
54			uint8_t 	rsvd_2[3];
55			uint32_t	xstop_reason;
56			union {
57				uint32_t	pir;
58				uint32_t	chip_id;
59			};
60		};
61	};
62};
63
64#define	HMI_DISP_RECOVERED	0
65#define	HMI_DISP_NOT_RECOVERED	1
66
67static void
68opal_hmi_event_handler(void *unused, struct opal_msg *msg)
69{
70	struct opal_hmi_event	evt;
71
72	memcpy(&evt, &msg->params, sizeof(evt));
73	printf("Hypervisor Maintenance Event received"
74	    "(Severity %d, type %d, HMER: %016lx).\n",
75	    evt.severity, evt.type, evt.hmer);
76
77	if (evt.disposition == HMI_DISP_NOT_RECOVERED)
78		panic("Unrecoverable hypervisor maintenance exception on CPU %d",
79		    evt.pir);
80
81	return;
82}
83
84static int
85opal_hmi_handler2(struct trapframe *frame)
86{
87	/*
88	 * Use DMAP preallocated pcpu memory to handle
89	 * the phys flags pointer.
90	 */
91	uint64_t *flags = PCPU_PTR(aim.opal_hmi_flags);
92	int err;
93
94	*flags = 0;
95	err = opal_call(OPAL_HANDLE_HMI2, DMAP_TO_PHYS((vm_offset_t)flags));
96
97	if (be64toh(*flags) & OPAL_HMI_FLAGS_TOD_TB_FAIL)
98		panic("TOD/TB recovery failure");
99
100	if (err == OPAL_SUCCESS)
101		return (0);
102
103	printf("HMI handler failed!  OPAL error code: %d\n", err);
104
105	return (-1);
106}
107
108static int
109opal_hmi_handler(struct trapframe *frame)
110{
111	int err;
112
113	err = opal_call(OPAL_HANDLE_HMI);
114
115	if (err == OPAL_SUCCESS)
116		return (0);
117
118	printf("HMI handler failed!  OPAL error code: %d\n", err);
119
120	return (-1);
121}
122
123static void
124opal_setup_hmi(void *data)
125{
126	/* This only works for OPAL, so first make sure we have it. */
127	if (opal_check() != 0)
128		return;
129
130	if (opal_call(OPAL_CHECK_TOKEN, OPAL_HANDLE_HMI2) == OPAL_TOKEN_PRESENT)
131		hmi_handler = opal_hmi_handler2;
132	else if (opal_call(OPAL_CHECK_TOKEN, OPAL_HANDLE_HMI) == OPAL_TOKEN_PRESENT)
133		hmi_handler = opal_hmi_handler;
134	else {
135		printf("Warning: No OPAL HMI handler found.\n");
136		return;
137	}
138
139	EVENTHANDLER_REGISTER(OPAL_HMI_EVT, opal_hmi_event_handler, NULL,
140	    EVENTHANDLER_PRI_ANY);
141
142	if (bootverbose)
143		printf("Installed OPAL HMI handler.\n");
144}
145
146SYSINIT(opal_setup_hmi, SI_SUB_CPU, SI_ORDER_ANY, opal_setup_hmi, NULL);
147