xref: /freebsd/sys/powerpc/powernv/opal.h (revision f39bffc62c1395bde25d152c7f68fdf7cbaab414)
1 /*-
2  * Copyright (c) 2015 Nathan Whitehorn
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
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 AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28 
29 #ifndef _POWERNV_OPAL_H
30 #define _POWERNV_OPAL_H
31 
32 #include <sys/cdefs.h>
33 #include <sys/types.h>
34 
35 /* Check if OPAL is correctly instantiated. Will try to instantiate it. */
36 int opal_check(void);
37 
38 /* Call an OPAL method. Any pointers passed must be real-mode accessible! */
39 int opal_call(uint64_t token, ...);
40 
41 #define OPAL_CONSOLE_WRITE		1
42 #define OPAL_CONSOLE_READ		2
43 #define OPAL_RTC_READ			3
44 #define OPAL_RTC_WRITE			4
45 #define	OPAL_CEC_POWER_DOWN		5
46 #define	OPAL_CEC_REBOOT			6
47 #define	OPAL_HANDLE_INTERRUPT		9
48 #define	OPAL_POLL_EVENTS		10
49 #define	OPAL_PCI_CONFIG_READ_BYTE	13
50 #define	OPAL_PCI_CONFIG_READ_HALF_WORD	14
51 #define	OPAL_PCI_CONFIG_READ_WORD	15
52 #define	OPAL_PCI_CONFIG_WRITE_BYTE	16
53 #define	OPAL_PCI_CONFIG_WRITE_HALF_WORD	17
54 #define	OPAL_PCI_CONFIG_WRITE_WORD	18
55 #define	OPAL_PCI_EEH_FREEZE_CLEAR	26
56 #define	OPAL_PCI_PHB_MMIO_ENABLE	27
57 #define	OPAL_PCI_SET_PHB_MEM_WINDOW	28
58 #define	OPAL_PCI_MAP_PE_MMIO_WINDOW	29
59 #define	OPAL_PCI_SET_XIVE_PE		37
60 #define	OPAL_PCI_RESET			49
61 #define	OPAL_PCI_POLL			62
62 #define	OPAL_SET_XIVE           	19
63 #define	OPAL_GET_XIVE           	20
64 #define	OPAL_PCI_SET_PE			31
65 #define	OPAL_GET_MSI_32			39
66 #define	OPAL_GET_MSI_64			40
67 #define	OPAL_PCI_MSI_EOI		63
68 #define	OPAL_PCI_GET_PHB_DIAG_DATA2	64
69 #define	OPAL_START_CPU			41
70 #define	OPAL_PCI_MAP_PE_DMA_WINDOW	44
71 #define	OPAL_PCI_MAP_PE_DMA_WINDOW_REAL	45
72 #define	OPAL_RETURN_CPU			69
73 #define	OPAL_REINIT_CPUS		70
74 #define	OPAL_CHECK_ASYNC_COMPLETION	86
75 #define	OPAL_SENSOR_READ		88
76 #define	OPAL_IPMI_SEND			107
77 #define	OPAL_IPMI_RECV			108
78 #define	OPAL_I2C_REQUEST		109
79 #define	OPAL_INT_GET_XIRR		122
80 #define	OPAL_INT_SET_CPPR		123
81 #define	OPAL_INT_EOI			124
82 #define	OPAL_INT_SET_MFRR		125
83 #define	OPAL_PCI_TCE_KILL		126
84 #define	OPAL_XIVE_RESET			128
85 #define	OPAL_SENSOR_GROUP_CLEAR		156
86 #define	OPAL_SENSOR_READ_U64		162
87 #define	OPAL_SENSOR_GROUP_ENABLE	163
88 
89 /* For OPAL_PCI_SET_PE */
90 #define	OPAL_UNMAP_PE			0
91 #define OPAL_MAP_PE			1
92 
93 #define	OPAL_PCI_BUS_ANY		0
94 #define	OPAL_PCI_BUS_3BITS		2
95 #define	OPAL_PCI_BUS_4BITS		3
96 #define	OPAL_PCI_BUS_5BITS		4
97 #define	OPAL_PCI_BUS_6BITS		5
98 #define	OPAL_PCI_BUS_7BITS		6
99 #define	OPAL_PCI_BUS_ALL		7 /* Match bus number exactly */
100 
101 #define	OPAL_IGNORE_RID_DEVICE_NUMBER	0
102 #define	OPAL_COMPARE_RID_DEVICE_NUMBER	1
103 
104 #define	OPAL_IGNORE_RID_FUNC_NUMBER	0
105 #define	OPAL_COMPARE_RID_FUNC_NUMBER	1
106 
107 #define	OPAL_SUCCESS			0
108 #define	OPAL_PARAMETER			-1
109 #define	OPAL_BUSY			-2
110 #define	OPAL_CLOSED			-5
111 #define	OPAL_HARDWARE			-6
112 #define	OPAL_UNSUPPORTED		-7
113 #define	OPAL_RESOURCE			-10
114 #define	OPAL_BUSY_EVENT			-12
115 #define	OPAL_ASYNC_COMPLETION		-15
116 #define	OPAL_EMPTY			-16
117 
118 struct opal_msg {
119 	uint32_t msg_type;
120 	uint32_t reserved;
121 	uint64_t params[8];
122 };
123 
124 enum opal_msg_type {
125 	OPAL_MSG_ASYNC_COMP	= 0,
126 	OPAL_MSG_MEM_ERR	= 1,
127 	OPAL_MSG_EPOW		= 2,
128 	OPAL_MSG_SHUTDOWN	= 3,
129 	OPAL_MSG_HMI_EVT	= 4,
130 	OPAL_MSG_DPO		= 5,
131 	OPAL_MSG_PRD		= 6,
132 	OPAL_MSG_OCC		= 7,
133 	OPAL_MSG_TYPE_MAX,
134 };
135 
136 #define	OPAL_IPMI_MSG_FORMAT_VERSION_1	1
137 
138 struct opal_ipmi_msg {
139 	uint8_t version;
140 	uint8_t netfn;
141 	uint8_t cmd;
142 	uint8_t data[];
143 };
144 
145 #endif
146