2 * Copyright (c) 2015 Nathan Whitehorn
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
29 #ifndef _POWERNV_OPAL_H
30 #define _POWERNV_OPAL_H
32 #include <sys/cdefs.h>
33 #include <sys/types.h>
34 #include <sys/eventhandler.h>
36 /* Check if OPAL is correctly instantiated. Will try to instantiate it. */
39 /* Call an OPAL method. Any pointers passed must be real-mode accessible! */
40 int opal_call(uint64_t token, ...);
42 #define OPAL_CONSOLE_WRITE 1
43 #define OPAL_CONSOLE_READ 2
44 #define OPAL_RTC_READ 3
45 #define OPAL_RTC_WRITE 4
46 #define OPAL_CEC_POWER_DOWN 5
47 #define OPAL_CEC_REBOOT 6
48 #define OPAL_HANDLE_INTERRUPT 9
49 #define OPAL_POLL_EVENTS 10
50 #define OPAL_PCI_CONFIG_READ_BYTE 13
51 #define OPAL_PCI_CONFIG_READ_HALF_WORD 14
52 #define OPAL_PCI_CONFIG_READ_WORD 15
53 #define OPAL_PCI_CONFIG_WRITE_BYTE 16
54 #define OPAL_PCI_CONFIG_WRITE_HALF_WORD 17
55 #define OPAL_PCI_CONFIG_WRITE_WORD 18
56 #define OPAL_PCI_EEH_FREEZE_CLEAR 26
57 #define OPAL_PCI_PHB_MMIO_ENABLE 27
58 #define OPAL_PCI_SET_PHB_MEM_WINDOW 28
59 #define OPAL_PCI_MAP_PE_MMIO_WINDOW 29
60 #define OPAL_PCI_SET_XIVE_PE 37
61 #define OPAL_PCI_RESET 49
62 #define OPAL_PCI_POLL 62
63 #define OPAL_SET_XIVE 19
64 #define OPAL_GET_XIVE 20
65 #define OPAL_PCI_SET_PE 31
66 #define OPAL_GET_MSI_32 39
67 #define OPAL_GET_MSI_64 40
68 #define OPAL_PCI_MSI_EOI 63
69 #define OPAL_PCI_GET_PHB_DIAG_DATA2 64
70 #define OPAL_START_CPU 41
71 #define OPAL_PCI_MAP_PE_DMA_WINDOW 44
72 #define OPAL_PCI_MAP_PE_DMA_WINDOW_REAL 45
73 #define OPAL_RETURN_CPU 69
74 #define OPAL_REINIT_CPUS 70
75 #define OPAL_CHECK_TOKEN 80
76 #define OPAL_GET_MSG 85
77 #define OPAL_CHECK_ASYNC_COMPLETION 86
78 #define OPAL_SENSOR_READ 88
79 #define OPAL_HANDLE_HMI 98
80 #define OPAL_IPMI_SEND 107
81 #define OPAL_IPMI_RECV 108
82 #define OPAL_I2C_REQUEST 109
83 #define OPAL_FLASH_READ 110
84 #define OPAL_FLASH_WRITE 111
85 #define OPAL_FLASH_ERASE 112
86 #define OPAL_INT_GET_XIRR 122
87 #define OPAL_INT_SET_CPPR 123
88 #define OPAL_INT_EOI 124
89 #define OPAL_INT_SET_MFRR 125
90 #define OPAL_PCI_TCE_KILL 126
91 #define OPAL_XIVE_RESET 128
92 #define OPAL_XIVE_GET_IRQ_INFO 129
93 #define OPAL_XIVE_GET_IRQ_CONFIG 130
94 #define OPAL_XIVE_SET_IRQ_CONFIG 131
95 #define OPAL_XIVE_GET_QUEUE_INFO 132
96 #define OPAL_XIVE_SET_QUEUE_INFO 133
97 #define OPAL_XIVE_DONATE_PAGE 134
98 #define OPAL_XIVE_ALLOCATE_VP_BLOCK 135
99 #define OPAL_XIVE_FREE_VP_BLOCK 136
100 #define OPAL_XIVE_GET_VP_INFO 137
101 #define OPAL_XIVE_SET_VP_INFO 138
102 #define OPAL_XIVE_ALLOCATE_IRQ 139
103 #define OPAL_XIVE_FREE_IRQ 140
104 #define OPAL_XIVE_SYNC 141
105 #define OPAL_XIVE_DUMP 142
106 #define OPAL_SENSOR_GROUP_CLEAR 156
107 #define OPAL_SENSOR_READ_U64 162
108 #define OPAL_SENSOR_GROUP_ENABLE 163
109 #define OPAL_HANDLE_HMI2 166
111 /* For OPAL_PCI_SET_PE */
112 #define OPAL_UNMAP_PE 0
113 #define OPAL_MAP_PE 1
115 #define OPAL_PCI_BUS_ANY 0
116 #define OPAL_PCI_BUS_3BITS 2
117 #define OPAL_PCI_BUS_4BITS 3
118 #define OPAL_PCI_BUS_5BITS 4
119 #define OPAL_PCI_BUS_6BITS 5
120 #define OPAL_PCI_BUS_7BITS 6
121 #define OPAL_PCI_BUS_ALL 7 /* Match bus number exactly */
123 #define OPAL_IGNORE_RID_DEVICE_NUMBER 0
124 #define OPAL_COMPARE_RID_DEVICE_NUMBER 1
126 #define OPAL_IGNORE_RID_FUNC_NUMBER 0
127 #define OPAL_COMPARE_RID_FUNC_NUMBER 1
129 #define OPAL_SUCCESS 0
130 #define OPAL_PARAMETER -1
132 #define OPAL_CLOSED -5
133 #define OPAL_HARDWARE -6
134 #define OPAL_UNSUPPORTED -7
135 #define OPAL_RESOURCE -10
136 #define OPAL_BUSY_EVENT -12
137 #define OPAL_ASYNC_COMPLETION -15
138 #define OPAL_EMPTY -16
139 #define OPAL_XIVE_PROVISIONING -31
140 #define OPAL_XIVE_FREE_ACTIVE -32
142 #define OPAL_TOKEN_ABSENT 0
143 #define OPAL_TOKEN_PRESENT 1
145 #define OPAL_EVENT_OPAL_INTERNAL 0x1
146 #define OPAL_EVENT_NVRAM 0x2
147 #define OPAL_EVENT_RTC 0x4
148 #define OPAL_EVENT_CONSOLE_INPUT 0x8
149 #define OPAL_EVENT_CONSOLE_OUTPUT 0x10
150 #define OPAL_EVENT_ERROR_LOG_AVAIL 0x20
151 #define OPAL_EVENT_ERROR_LOG 0x40
152 #define OPAL_EVENT_EPOW 0x80
153 #define OPAL_EVENT_LED_STATUS 0x100
154 #define OPAL_EVENT_PCI_ERROR 0x200
155 #define OPAL_EVENT_DUMP_AVAIL 0x400
156 #define OPAL_EVENT_MSG_PENDING 0x800
158 #define OPAL_HMI_FLAGS_TB_RESYNC (1ull << 0)
159 #define OPAL_HMI_FLAGS_DEC_LOST (1ull << 1)
160 #define OPAL_HMI_FLAGS_HDEC_LOST (1ull << 2)
161 #define OPAL_HMI_FLAGS_TOD_TB_FAIL (1ull << 3)
162 #define OPAL_HMI_FLAGS_NEW_EVENT (1ull << 63)
164 #define OPAL_XIVE_XICS_MODE_EMU 0
165 #define OPAL_XIVE_XICS_MODE_EXP 1
167 #define OPAL_XIVE_VP_ENABLED 0x00000001
168 #define OPAL_XIVE_VP_SINGLE_ESCALATION 0x00000002
170 #define OPAL_XIVE_EQ_ENABLED 0x00000001
171 #define OPAL_XIVE_EQ_ALWAYS_NOTIFY 0x00000002
172 #define OPAL_XIVE_EQ_ESCALATE 0x00000004
181 OPAL_MSG_ASYNC_COMP = 0,
182 OPAL_MSG_MEM_ERR = 1,
184 OPAL_MSG_SHUTDOWN = 3,
185 OPAL_MSG_HMI_EVT = 4,
192 #define OPAL_IPMI_MSG_FORMAT_VERSION_1 1
194 struct opal_ipmi_msg {
201 int opal_init_async_tokens(int);
202 int opal_alloc_async_token(void);
203 void opal_free_async_token(int);
204 int opal_wait_completion(void *, uint64_t, int);
206 typedef void (*opal_msg_handler_fn)(void *, struct opal_msg *);
207 EVENTHANDLER_DECLARE(OPAL_ASYNC_COMP, opal_msg_handler_fn);
208 EVENTHANDLER_DECLARE(OPAL_EPOW, opal_msg_handler_fn);
209 EVENTHANDLER_DECLARE(OPAL_SHUTDOWN, opal_msg_handler_fn);
210 EVENTHANDLER_DECLARE(OPAL_HMI_EVT, opal_msg_handler_fn);
211 EVENTHANDLER_DECLARE(OPAL_DPO, opal_msg_handler_fn);
212 EVENTHANDLER_DECLARE(OPAL_OCC, opal_msg_handler_fn);
213 EVENTHANDLER_LIST_DECLARE(OPAL_ASYNC_COMP);
214 EVENTHANDLER_LIST_DECLARE(OPAL_EPOW);
215 EVENTHANDLER_LIST_DECLARE(OPAL_SHUTDOWN);
216 EVENTHANDLER_LIST_DECLARE(OPAL_HMI_EVT);
217 EVENTHANDLER_LIST_DECLARE(OPAL_DPO);
218 EVENTHANDLER_LIST_DECLARE(OPAL_OCC);