1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 * OPAL API definitions.
5 * Copyright 2011-2015 IBM Corp.
11 /****** OPAL APIs ******/
14 #define OPAL_SUCCESS 0
15 #define OPAL_PARAMETER -1
17 #define OPAL_PARTIAL -3
18 #define OPAL_CONSTRAINED -4
19 #define OPAL_CLOSED -5
20 #define OPAL_HARDWARE -6
21 #define OPAL_UNSUPPORTED -7
22 #define OPAL_PERMISSION -8
23 #define OPAL_NO_MEM -9
24 #define OPAL_RESOURCE -10
25 #define OPAL_INTERNAL_ERROR -11
26 #define OPAL_BUSY_EVENT -12
27 #define OPAL_HARDWARE_FROZEN -13
28 #define OPAL_WRONG_STATE -14
29 #define OPAL_ASYNC_COMPLETION -15
30 #define OPAL_EMPTY -16
31 #define OPAL_I2C_TIMEOUT -17
32 #define OPAL_I2C_INVALID_CMD -18
33 #define OPAL_I2C_LBUS_PARITY -19
34 #define OPAL_I2C_BKEND_OVERRUN -20
35 #define OPAL_I2C_BKEND_ACCESS -21
36 #define OPAL_I2C_ARBT_LOST -22
37 #define OPAL_I2C_NACK_RCVD -23
38 #define OPAL_I2C_STOP_ERR -24
39 #define OPAL_XIVE_PROVISIONING -31
40 #define OPAL_XIVE_FREE_ACTIVE -32
41 #define OPAL_TIMEOUT -33
43 /* API Tokens (in r0) */
44 #define OPAL_INVALID_CALL -1
46 #define OPAL_CONSOLE_WRITE 1
47 #define OPAL_CONSOLE_READ 2
48 #define OPAL_RTC_READ 3
49 #define OPAL_RTC_WRITE 4
50 #define OPAL_CEC_POWER_DOWN 5
51 #define OPAL_CEC_REBOOT 6
52 #define OPAL_READ_NVRAM 7
53 #define OPAL_WRITE_NVRAM 8
54 #define OPAL_HANDLE_INTERRUPT 9
55 #define OPAL_POLL_EVENTS 10
56 #define OPAL_PCI_SET_HUB_TCE_MEMORY 11
57 #define OPAL_PCI_SET_PHB_TCE_MEMORY 12
58 #define OPAL_PCI_CONFIG_READ_BYTE 13
59 #define OPAL_PCI_CONFIG_READ_HALF_WORD 14
60 #define OPAL_PCI_CONFIG_READ_WORD 15
61 #define OPAL_PCI_CONFIG_WRITE_BYTE 16
62 #define OPAL_PCI_CONFIG_WRITE_HALF_WORD 17
63 #define OPAL_PCI_CONFIG_WRITE_WORD 18
64 #define OPAL_SET_XIVE 19
65 #define OPAL_GET_XIVE 20
66 #define OPAL_GET_COMPLETION_TOKEN_STATUS 21 /* obsolete */
67 #define OPAL_REGISTER_OPAL_EXCEPTION_HANDLER 22
68 #define OPAL_PCI_EEH_FREEZE_STATUS 23
69 #define OPAL_PCI_SHPC 24
70 #define OPAL_CONSOLE_WRITE_BUFFER_SPACE 25
71 #define OPAL_PCI_EEH_FREEZE_CLEAR 26
72 #define OPAL_PCI_PHB_MMIO_ENABLE 27
73 #define OPAL_PCI_SET_PHB_MEM_WINDOW 28
74 #define OPAL_PCI_MAP_PE_MMIO_WINDOW 29
75 #define OPAL_PCI_SET_PHB_TABLE_MEMORY 30
76 #define OPAL_PCI_SET_PE 31
77 #define OPAL_PCI_SET_PELTV 32
78 #define OPAL_PCI_SET_MVE 33
79 #define OPAL_PCI_SET_MVE_ENABLE 34
80 #define OPAL_PCI_GET_XIVE_REISSUE 35
81 #define OPAL_PCI_SET_XIVE_REISSUE 36
82 #define OPAL_PCI_SET_XIVE_PE 37
83 #define OPAL_GET_XIVE_SOURCE 38
84 #define OPAL_GET_MSI_32 39
85 #define OPAL_GET_MSI_64 40
86 #define OPAL_START_CPU 41
87 #define OPAL_QUERY_CPU_STATUS 42
88 #define OPAL_WRITE_OPPANEL 43 /* unimplemented */
89 #define OPAL_PCI_MAP_PE_DMA_WINDOW 44
90 #define OPAL_PCI_MAP_PE_DMA_WINDOW_REAL 45
91 #define OPAL_PCI_RESET 49
92 #define OPAL_PCI_GET_HUB_DIAG_DATA 50
93 #define OPAL_PCI_GET_PHB_DIAG_DATA 51
94 #define OPAL_PCI_FENCE_PHB 52
95 #define OPAL_PCI_REINIT 53
96 #define OPAL_PCI_MASK_PE_ERROR 54
97 #define OPAL_SET_SLOT_LED_STATUS 55
98 #define OPAL_GET_EPOW_STATUS 56
99 #define OPAL_SET_SYSTEM_ATTENTION_LED 57
100 #define OPAL_RESERVED1 58
101 #define OPAL_RESERVED2 59
102 #define OPAL_PCI_NEXT_ERROR 60
103 #define OPAL_PCI_EEH_FREEZE_STATUS2 61
104 #define OPAL_PCI_POLL 62
105 #define OPAL_PCI_MSI_EOI 63
106 #define OPAL_PCI_GET_PHB_DIAG_DATA2 64
107 #define OPAL_XSCOM_READ 65
108 #define OPAL_XSCOM_WRITE 66
109 #define OPAL_LPC_READ 67
110 #define OPAL_LPC_WRITE 68
111 #define OPAL_RETURN_CPU 69
112 #define OPAL_REINIT_CPUS 70
113 #define OPAL_ELOG_READ 71
114 #define OPAL_ELOG_WRITE 72
115 #define OPAL_ELOG_ACK 73
116 #define OPAL_ELOG_RESEND 74
117 #define OPAL_ELOG_SIZE 75
118 #define OPAL_FLASH_VALIDATE 76
119 #define OPAL_FLASH_MANAGE 77
120 #define OPAL_FLASH_UPDATE 78
121 #define OPAL_RESYNC_TIMEBASE 79
122 #define OPAL_CHECK_TOKEN 80
123 #define OPAL_DUMP_INIT 81
124 #define OPAL_DUMP_INFO 82
125 #define OPAL_DUMP_READ 83
126 #define OPAL_DUMP_ACK 84
127 #define OPAL_GET_MSG 85
128 #define OPAL_CHECK_ASYNC_COMPLETION 86
129 #define OPAL_SYNC_HOST_REBOOT 87
130 #define OPAL_SENSOR_READ 88
131 #define OPAL_GET_PARAM 89
132 #define OPAL_SET_PARAM 90
133 #define OPAL_DUMP_RESEND 91
134 #define OPAL_ELOG_SEND 92 /* Deprecated */
135 #define OPAL_PCI_SET_PHB_CAPI_MODE 93
136 #define OPAL_DUMP_INFO2 94
137 #define OPAL_WRITE_OPPANEL_ASYNC 95
138 #define OPAL_PCI_ERR_INJECT 96
139 #define OPAL_PCI_EEH_FREEZE_SET 97
140 #define OPAL_HANDLE_HMI 98
141 #define OPAL_CONFIG_CPU_IDLE_STATE 99
142 #define OPAL_SLW_SET_REG 100
143 #define OPAL_REGISTER_DUMP_REGION 101
144 #define OPAL_UNREGISTER_DUMP_REGION 102
145 #define OPAL_WRITE_TPO 103
146 #define OPAL_READ_TPO 104
147 #define OPAL_GET_DPO_STATUS 105
148 #define OPAL_OLD_I2C_REQUEST 106 /* Deprecated */
149 #define OPAL_IPMI_SEND 107
150 #define OPAL_IPMI_RECV 108
151 #define OPAL_I2C_REQUEST 109
152 #define OPAL_FLASH_READ 110
153 #define OPAL_FLASH_WRITE 111
154 #define OPAL_FLASH_ERASE 112
155 #define OPAL_PRD_MSG 113
156 #define OPAL_LEDS_GET_INDICATOR 114
157 #define OPAL_LEDS_SET_INDICATOR 115
158 #define OPAL_CEC_REBOOT2 116
159 #define OPAL_CONSOLE_FLUSH 117
160 #define OPAL_GET_DEVICE_TREE 118
161 #define OPAL_PCI_GET_PRESENCE_STATE 119
162 #define OPAL_PCI_GET_POWER_STATE 120
163 #define OPAL_PCI_SET_POWER_STATE 121
164 #define OPAL_INT_GET_XIRR 122
165 #define OPAL_INT_SET_CPPR 123
166 #define OPAL_INT_EOI 124
167 #define OPAL_INT_SET_MFRR 125
168 #define OPAL_PCI_TCE_KILL 126
169 #define OPAL_NMMU_SET_PTCR 127
170 #define OPAL_XIVE_RESET 128
171 #define OPAL_XIVE_GET_IRQ_INFO 129
172 #define OPAL_XIVE_GET_IRQ_CONFIG 130
173 #define OPAL_XIVE_SET_IRQ_CONFIG 131
174 #define OPAL_XIVE_GET_QUEUE_INFO 132
175 #define OPAL_XIVE_SET_QUEUE_INFO 133
176 #define OPAL_XIVE_DONATE_PAGE 134
177 #define OPAL_XIVE_ALLOCATE_VP_BLOCK 135
178 #define OPAL_XIVE_FREE_VP_BLOCK 136
179 #define OPAL_XIVE_GET_VP_INFO 137
180 #define OPAL_XIVE_SET_VP_INFO 138
181 #define OPAL_XIVE_ALLOCATE_IRQ 139
182 #define OPAL_XIVE_FREE_IRQ 140
183 #define OPAL_XIVE_SYNC 141
184 #define OPAL_XIVE_DUMP 142
185 #define OPAL_XIVE_GET_QUEUE_STATE 143
186 #define OPAL_XIVE_SET_QUEUE_STATE 144
187 #define OPAL_SIGNAL_SYSTEM_RESET 145
188 #define OPAL_NPU_INIT_CONTEXT 146
189 #define OPAL_NPU_DESTROY_CONTEXT 147
190 #define OPAL_NPU_MAP_LPAR 148
191 #define OPAL_IMC_COUNTERS_INIT 149
192 #define OPAL_IMC_COUNTERS_START 150
193 #define OPAL_IMC_COUNTERS_STOP 151
194 #define OPAL_GET_POWERCAP 152
195 #define OPAL_SET_POWERCAP 153
196 #define OPAL_GET_POWER_SHIFT_RATIO 154
197 #define OPAL_SET_POWER_SHIFT_RATIO 155
198 #define OPAL_SENSOR_GROUP_CLEAR 156
199 #define OPAL_PCI_SET_P2P 157
200 #define OPAL_QUIESCE 158
201 #define OPAL_NPU_SPA_SETUP 159
202 #define OPAL_NPU_SPA_CLEAR_CACHE 160
203 #define OPAL_NPU_TL_SET 161
204 #define OPAL_SENSOR_READ_U64 162
205 #define OPAL_SENSOR_GROUP_ENABLE 163
206 #define OPAL_PCI_GET_PBCQ_TUNNEL_BAR 164
207 #define OPAL_PCI_SET_PBCQ_TUNNEL_BAR 165
208 #define OPAL_HANDLE_HMI2 166
209 #define OPAL_NX_COPROC_INIT 167
210 #define OPAL_XIVE_GET_VP_STATE 170
211 #define OPAL_LAST 170
213 #define QUIESCE_HOLD 1 /* Spin all calls at entry */
214 #define QUIESCE_REJECT 2 /* Fail all calls with OPAL_BUSY */
215 #define QUIESCE_LOCK_BREAK 3 /* Set to ignore locks. */
216 #define QUIESCE_RESUME 4 /* Un-quiesce */
217 #define QUIESCE_RESUME_FAST_REBOOT 5 /* Un-quiesce, fast reboot */
219 /* Device tree flags */
222 * Flags set in power-mgmt nodes in device tree describing
223 * idle states that are supported in the platform.
226 #define OPAL_PM_TIMEBASE_STOP 0x00000002
227 #define OPAL_PM_LOSE_HYP_CONTEXT 0x00002000
228 #define OPAL_PM_LOSE_FULL_CONTEXT 0x00004000
229 #define OPAL_PM_NAP_ENABLED 0x00010000
230 #define OPAL_PM_SLEEP_ENABLED 0x00020000
231 #define OPAL_PM_WINKLE_ENABLED 0x00040000
232 #define OPAL_PM_SLEEP_ENABLED_ER1 0x00080000 /* with workaround */
233 #define OPAL_PM_STOP_INST_FAST 0x00100000
234 #define OPAL_PM_STOP_INST_DEEP 0x00200000
237 * OPAL_CONFIG_CPU_IDLE_STATE parameters
239 #define OPAL_CONFIG_IDLE_FASTSLEEP 1
240 #define OPAL_CONFIG_IDLE_UNDO 0
241 #define OPAL_CONFIG_IDLE_APPLY 1
246 enum OpalFreezeState {
247 OPAL_EEH_STOPPED_NOT_FROZEN = 0,
248 OPAL_EEH_STOPPED_MMIO_FREEZE = 1,
249 OPAL_EEH_STOPPED_DMA_FREEZE = 2,
250 OPAL_EEH_STOPPED_MMIO_DMA_FREEZE = 3,
251 OPAL_EEH_STOPPED_RESET = 4,
252 OPAL_EEH_STOPPED_TEMP_UNAVAIL = 5,
253 OPAL_EEH_STOPPED_PERM_UNAVAIL = 6
256 enum OpalEehFreezeActionToken {
257 OPAL_EEH_ACTION_CLEAR_FREEZE_MMIO = 1,
258 OPAL_EEH_ACTION_CLEAR_FREEZE_DMA = 2,
259 OPAL_EEH_ACTION_CLEAR_FREEZE_ALL = 3,
261 OPAL_EEH_ACTION_SET_FREEZE_MMIO = 1,
262 OPAL_EEH_ACTION_SET_FREEZE_DMA = 2,
263 OPAL_EEH_ACTION_SET_FREEZE_ALL = 3
266 enum OpalPciStatusToken {
267 OPAL_EEH_NO_ERROR = 0,
268 OPAL_EEH_IOC_ERROR = 1,
269 OPAL_EEH_PHB_ERROR = 2,
270 OPAL_EEH_PE_ERROR = 3,
271 OPAL_EEH_PE_MMIO_ERROR = 4,
272 OPAL_EEH_PE_DMA_ERROR = 5
275 enum OpalPciErrorSeverity {
276 OPAL_EEH_SEV_NO_ERROR = 0,
277 OPAL_EEH_SEV_IOC_DEAD = 1,
278 OPAL_EEH_SEV_PHB_DEAD = 2,
279 OPAL_EEH_SEV_PHB_FENCED = 3,
280 OPAL_EEH_SEV_PE_ER = 4,
284 enum OpalErrinjectType {
285 OPAL_ERR_INJECT_TYPE_IOA_BUS_ERR = 0,
286 OPAL_ERR_INJECT_TYPE_IOA_BUS_ERR64 = 1,
289 enum OpalErrinjectFunc {
290 /* IOA bus specific errors */
291 OPAL_ERR_INJECT_FUNC_IOA_LD_MEM_ADDR = 0,
292 OPAL_ERR_INJECT_FUNC_IOA_LD_MEM_DATA = 1,
293 OPAL_ERR_INJECT_FUNC_IOA_LD_IO_ADDR = 2,
294 OPAL_ERR_INJECT_FUNC_IOA_LD_IO_DATA = 3,
295 OPAL_ERR_INJECT_FUNC_IOA_LD_CFG_ADDR = 4,
296 OPAL_ERR_INJECT_FUNC_IOA_LD_CFG_DATA = 5,
297 OPAL_ERR_INJECT_FUNC_IOA_ST_MEM_ADDR = 6,
298 OPAL_ERR_INJECT_FUNC_IOA_ST_MEM_DATA = 7,
299 OPAL_ERR_INJECT_FUNC_IOA_ST_IO_ADDR = 8,
300 OPAL_ERR_INJECT_FUNC_IOA_ST_IO_DATA = 9,
301 OPAL_ERR_INJECT_FUNC_IOA_ST_CFG_ADDR = 10,
302 OPAL_ERR_INJECT_FUNC_IOA_ST_CFG_DATA = 11,
303 OPAL_ERR_INJECT_FUNC_IOA_DMA_RD_ADDR = 12,
304 OPAL_ERR_INJECT_FUNC_IOA_DMA_RD_DATA = 13,
305 OPAL_ERR_INJECT_FUNC_IOA_DMA_RD_MASTER = 14,
306 OPAL_ERR_INJECT_FUNC_IOA_DMA_RD_TARGET = 15,
307 OPAL_ERR_INJECT_FUNC_IOA_DMA_WR_ADDR = 16,
308 OPAL_ERR_INJECT_FUNC_IOA_DMA_WR_DATA = 17,
309 OPAL_ERR_INJECT_FUNC_IOA_DMA_WR_MASTER = 18,
310 OPAL_ERR_INJECT_FUNC_IOA_DMA_WR_TARGET = 19,
313 enum OpalMmioWindowType {
314 OPAL_M32_WINDOW_TYPE = 1,
315 OPAL_M64_WINDOW_TYPE = 2,
316 OPAL_IO_WINDOW_TYPE = 3
319 enum OpalExceptionHandler {
320 OPAL_MACHINE_CHECK_HANDLER = 1,
321 OPAL_HYPERVISOR_MAINTENANCE_HANDLER = 2,
322 OPAL_SOFTPATCH_HANDLER = 3
325 enum OpalPendingState {
326 OPAL_EVENT_OPAL_INTERNAL = 0x1,
327 OPAL_EVENT_NVRAM = 0x2,
328 OPAL_EVENT_RTC = 0x4,
329 OPAL_EVENT_CONSOLE_OUTPUT = 0x8,
330 OPAL_EVENT_CONSOLE_INPUT = 0x10,
331 OPAL_EVENT_ERROR_LOG_AVAIL = 0x20,
332 OPAL_EVENT_ERROR_LOG = 0x40,
333 OPAL_EVENT_EPOW = 0x80,
334 OPAL_EVENT_LED_STATUS = 0x100,
335 OPAL_EVENT_PCI_ERROR = 0x200,
336 OPAL_EVENT_DUMP_AVAIL = 0x400,
337 OPAL_EVENT_MSG_PENDING = 0x800,
340 enum OpalThreadStatus {
341 OPAL_THREAD_INACTIVE = 0x0,
342 OPAL_THREAD_STARTED = 0x1,
343 OPAL_THREAD_UNAVAILABLE = 0x2 /* opal-v3 */
346 enum OpalPciBusCompare {
347 OpalPciBusAny = 0, /* Any bus number match */
348 OpalPciBus3Bits = 2, /* Match top 3 bits of bus number */
349 OpalPciBus4Bits = 3, /* Match top 4 bits of bus number */
350 OpalPciBus5Bits = 4, /* Match top 5 bits of bus number */
351 OpalPciBus6Bits = 5, /* Match top 6 bits of bus number */
352 OpalPciBus7Bits = 6, /* Match top 7 bits of bus number */
353 OpalPciBusAll = 7, /* Match bus number exactly */
356 enum OpalDeviceCompare {
357 OPAL_IGNORE_RID_DEVICE_NUMBER = 0,
358 OPAL_COMPARE_RID_DEVICE_NUMBER = 1
361 enum OpalFuncCompare {
362 OPAL_IGNORE_RID_FUNCTION_NUMBER = 0,
363 OPAL_COMPARE_RID_FUNCTION_NUMBER = 1
371 enum OpalPeltvAction {
372 OPAL_REMOVE_PE_FROM_DOMAIN = 0,
373 OPAL_ADD_PE_TO_DOMAIN = 1
376 enum OpalMveEnableAction {
377 OPAL_DISABLE_MVE = 0,
382 OPAL_DISABLE_M64 = 0,
383 OPAL_ENABLE_M64_SPLIT = 1,
384 OPAL_ENABLE_M64_NON_SPLIT = 2
387 enum OpalPciResetScope {
388 OPAL_RESET_PHB_COMPLETE = 1,
389 OPAL_RESET_PCI_LINK = 2,
390 OPAL_RESET_PHB_ERROR = 3,
391 OPAL_RESET_PCI_HOT = 4,
392 OPAL_RESET_PCI_FUNDAMENTAL = 5,
393 OPAL_RESET_PCI_IODA_TABLE = 6
396 enum OpalPciReinitScope {
398 * Note: we chose values that do not overlap
399 * OpalPciResetScope as OPAL v2 used the same
402 OPAL_REINIT_PCI_DEV = 1000
405 enum OpalPciResetState {
406 OPAL_DEASSERT_RESET = 0,
407 OPAL_ASSERT_RESET = 1
410 enum OpalPciSlotPresence {
411 OPAL_PCI_SLOT_EMPTY = 0,
412 OPAL_PCI_SLOT_PRESENT = 1
415 enum OpalPciSlotPower {
416 OPAL_PCI_SLOT_POWER_OFF = 0,
417 OPAL_PCI_SLOT_POWER_ON = 1,
418 OPAL_PCI_SLOT_OFFLINE = 2,
419 OPAL_PCI_SLOT_ONLINE = 3
422 enum OpalSlotLedType {
423 OPAL_SLOT_LED_TYPE_ID = 0, /* IDENTIFY LED */
424 OPAL_SLOT_LED_TYPE_FAULT = 1, /* FAULT LED */
425 OPAL_SLOT_LED_TYPE_ATTN = 2, /* System Attention LED */
426 OPAL_SLOT_LED_TYPE_MAX = 3
429 enum OpalSlotLedState {
430 OPAL_SLOT_LED_STATE_OFF = 0, /* LED is OFF */
431 OPAL_SLOT_LED_STATE_ON = 1 /* LED is ON */
435 * Address cycle types for LPC accesses. These also correspond
436 * to the content of the first cell of the "reg" property for
437 * device nodes on the LPC bus
439 enum OpalLPCAddressType {
446 OPAL_MSG_ASYNC_COMP = 0, /* params[0] = token, params[1] = rc,
447 * additional params function-specific
449 OPAL_MSG_MEM_ERR = 1,
451 OPAL_MSG_SHUTDOWN = 3, /* params[0] = 1 reboot, 0 shutdown */
452 OPAL_MSG_HMI_EVT = 4,
465 /* System parameter permission */
466 enum OpalSysparamPerm {
467 OPAL_SYSPARAM_READ = 0x1,
468 OPAL_SYSPARAM_WRITE = 0x2,
469 OPAL_SYSPARAM_RW = (OPAL_SYSPARAM_READ | OPAL_SYSPARAM_WRITE),
473 OPAL_IPMI_MSG_FORMAT_VERSION_1 = 1,
476 struct opal_ipmi_msg {
483 /* FSP memory errors handling */
484 enum OpalMemErr_Version {
488 enum OpalMemErrType {
489 OPAL_MEM_ERR_TYPE_RESILIENCE = 0,
490 OPAL_MEM_ERR_TYPE_DYN_DALLOC,
493 /* Memory Reilience error type */
494 enum OpalMemErr_ResilErrType {
495 OPAL_MEM_RESILIENCE_CE = 0,
496 OPAL_MEM_RESILIENCE_UE,
497 OPAL_MEM_RESILIENCE_UE_SCRUB,
500 /* Dynamic Memory Deallocation type */
501 enum OpalMemErr_DynErrType {
502 OPAL_MEM_DYNAMIC_DEALLOC = 0,
505 struct OpalMemoryErrorData {
506 enum OpalMemErr_Version version:8; /* 0x00 */
507 enum OpalMemErrType type:8; /* 0x01 */
508 __be16 flags; /* 0x02 */
509 uint8_t reserved_1[4]; /* 0x04 */
512 /* Memory Resilience corrected/uncorrected error info */
514 enum OpalMemErr_ResilErrType resil_err_type:8;
515 uint8_t reserved_1[7];
516 __be64 physical_address_start;
517 __be64 physical_address_end;
519 /* Dynamic memory deallocation error info */
521 enum OpalMemErr_DynErrType dyn_err_type:8;
522 uint8_t reserved_1[7];
523 __be64 physical_address_start;
524 __be64 physical_address_end;
529 /* HMI interrupt event */
530 enum OpalHMI_Version {
535 enum OpalHMI_Severity {
536 OpalHMI_SEV_NO_ERROR = 0,
537 OpalHMI_SEV_WARNING = 1,
538 OpalHMI_SEV_ERROR_SYNC = 2,
539 OpalHMI_SEV_FATAL = 3,
542 enum OpalHMI_Disposition {
543 OpalHMI_DISPOSITION_RECOVERED = 0,
544 OpalHMI_DISPOSITION_NOT_RECOVERED = 1,
547 enum OpalHMI_ErrType {
548 OpalHMI_ERROR_MALFUNC_ALERT = 0,
549 OpalHMI_ERROR_PROC_RECOV_DONE,
550 OpalHMI_ERROR_PROC_RECOV_DONE_AGAIN,
551 OpalHMI_ERROR_PROC_RECOV_MASKED,
553 OpalHMI_ERROR_TFMR_PARITY,
554 OpalHMI_ERROR_HA_OVERFLOW_WARN,
555 OpalHMI_ERROR_XSCOM_FAIL,
556 OpalHMI_ERROR_XSCOM_DONE,
557 OpalHMI_ERROR_SCOM_FIR,
558 OpalHMI_ERROR_DEBUG_TRIG_FIR,
559 OpalHMI_ERROR_HYP_RESOURCE,
560 OpalHMI_ERROR_CAPP_RECOVERY,
563 enum OpalHMI_XstopType {
564 CHECKSTOP_TYPE_UNKNOWN = 0,
565 CHECKSTOP_TYPE_CORE = 1,
566 CHECKSTOP_TYPE_NX = 2,
569 enum OpalHMI_CoreXstopReason {
570 CORE_CHECKSTOP_IFU_REGFILE = 0x00000001,
571 CORE_CHECKSTOP_IFU_LOGIC = 0x00000002,
572 CORE_CHECKSTOP_PC_DURING_RECOV = 0x00000004,
573 CORE_CHECKSTOP_ISU_REGFILE = 0x00000008,
574 CORE_CHECKSTOP_ISU_LOGIC = 0x00000010,
575 CORE_CHECKSTOP_FXU_LOGIC = 0x00000020,
576 CORE_CHECKSTOP_VSU_LOGIC = 0x00000040,
577 CORE_CHECKSTOP_PC_RECOV_IN_MAINT_MODE = 0x00000080,
578 CORE_CHECKSTOP_LSU_REGFILE = 0x00000100,
579 CORE_CHECKSTOP_PC_FWD_PROGRESS = 0x00000200,
580 CORE_CHECKSTOP_LSU_LOGIC = 0x00000400,
581 CORE_CHECKSTOP_PC_LOGIC = 0x00000800,
582 CORE_CHECKSTOP_PC_HYP_RESOURCE = 0x00001000,
583 CORE_CHECKSTOP_PC_HANG_RECOV_FAILED = 0x00002000,
584 CORE_CHECKSTOP_PC_AMBI_HANG_DETECTED = 0x00004000,
585 CORE_CHECKSTOP_PC_DEBUG_TRIG_ERR_INJ = 0x00008000,
586 CORE_CHECKSTOP_PC_SPRD_HYP_ERR_INJ = 0x00010000,
589 enum OpalHMI_NestAccelXstopReason {
590 NX_CHECKSTOP_SHM_INVAL_STATE_ERR = 0x00000001,
591 NX_CHECKSTOP_DMA_INVAL_STATE_ERR_1 = 0x00000002,
592 NX_CHECKSTOP_DMA_INVAL_STATE_ERR_2 = 0x00000004,
593 NX_CHECKSTOP_DMA_CH0_INVAL_STATE_ERR = 0x00000008,
594 NX_CHECKSTOP_DMA_CH1_INVAL_STATE_ERR = 0x00000010,
595 NX_CHECKSTOP_DMA_CH2_INVAL_STATE_ERR = 0x00000020,
596 NX_CHECKSTOP_DMA_CH3_INVAL_STATE_ERR = 0x00000040,
597 NX_CHECKSTOP_DMA_CH4_INVAL_STATE_ERR = 0x00000080,
598 NX_CHECKSTOP_DMA_CH5_INVAL_STATE_ERR = 0x00000100,
599 NX_CHECKSTOP_DMA_CH6_INVAL_STATE_ERR = 0x00000200,
600 NX_CHECKSTOP_DMA_CH7_INVAL_STATE_ERR = 0x00000400,
601 NX_CHECKSTOP_DMA_CRB_UE = 0x00000800,
602 NX_CHECKSTOP_DMA_CRB_SUE = 0x00001000,
603 NX_CHECKSTOP_PBI_ISN_UE = 0x00002000,
606 struct OpalHMIEvent {
607 uint8_t version; /* 0x00 */
608 uint8_t severity; /* 0x01 */
609 uint8_t type; /* 0x02 */
610 uint8_t disposition; /* 0x03 */
611 uint8_t reserved_1[4]; /* 0x04 */
614 /* TFMR register. Valid only for TFAC and TFMR_PARITY error type. */
617 /* version 2 and later */
620 * checkstop info (Core/NX).
621 * Valid for OpalHMI_ERROR_MALFUNC_ALERT.
624 uint8_t xstop_type; /* enum OpalHMI_XstopType */
625 uint8_t reserved_1[3];
628 __be32 pir; /* for CHECKSTOP_TYPE_CORE */
629 __be32 chip_id; /* for CHECKSTOP_TYPE_NX */
635 /* OPAL_HANDLE_HMI2 out_flags */
637 OPAL_HMI_FLAGS_TB_RESYNC = (1ull << 0), /* Timebase has been resynced */
638 OPAL_HMI_FLAGS_DEC_LOST = (1ull << 1), /* DEC lost, needs to be reprogrammed */
639 OPAL_HMI_FLAGS_HDEC_LOST = (1ull << 2), /* HDEC lost, needs to be reprogrammed */
640 OPAL_HMI_FLAGS_TOD_TB_FAIL = (1ull << 3), /* TOD/TB recovery failed. */
641 OPAL_HMI_FLAGS_NEW_EVENT = (1ull << 63), /* An event has been created */
645 OPAL_P7IOC_DIAG_TYPE_NONE = 0,
646 OPAL_P7IOC_DIAG_TYPE_RGC = 1,
647 OPAL_P7IOC_DIAG_TYPE_BI = 2,
648 OPAL_P7IOC_DIAG_TYPE_CI = 3,
649 OPAL_P7IOC_DIAG_TYPE_MISC = 4,
650 OPAL_P7IOC_DIAG_TYPE_I2C = 5,
651 OPAL_P7IOC_DIAG_TYPE_LAST = 6
654 struct OpalIoP7IOCErrorData {
672 struct OpalIoP7IOCRgcErrorData {
673 __be64 rgcStatus; /* 3E1C10 */
674 __be64 rgcLdcp; /* 3E1C18 */
676 struct OpalIoP7IOCBiErrorData {
677 __be64 biLdcp0; /* 3C0100, 3C0118 */
678 __be64 biLdcp1; /* 3C0108, 3C0120 */
679 __be64 biLdcp2; /* 3C0110, 3C0128 */
680 __be64 biFenceStatus; /* 3C0130, 3C0130 */
682 uint8_t biDownbound; /* BI Downbound or Upbound */
684 struct OpalIoP7IOCCiErrorData {
685 __be64 ciPortStatus; /* 3Dn008 */
686 __be64 ciPortLdcp; /* 3Dn010 */
688 uint8_t ciPort; /* Index of CI port: 0/1 */
694 * This structure defines the overlay which will be used to store PHB error
698 OPAL_PHB_ERROR_DATA_VERSION_1 = 1,
702 OPAL_PHB_ERROR_DATA_TYPE_P7IOC = 1,
703 OPAL_PHB_ERROR_DATA_TYPE_PHB3 = 2,
704 OPAL_PHB_ERROR_DATA_TYPE_PHB4 = 3
708 OPAL_P7IOC_NUM_PEST_REGS = 128,
709 OPAL_PHB3_NUM_PEST_REGS = 256,
710 OPAL_PHB4_NUM_PEST_REGS = 512
713 struct OpalIoPhbErrorCommon {
719 struct OpalIoP7IOCPhbErrorData {
720 struct OpalIoPhbErrorCommon common;
725 __be32 portStatusReg;
726 __be32 rootCmplxStatus;
727 __be32 busAgentStatus;
737 __be32 rootErrorStatus;
738 __be32 uncorrErrorStatus;
739 __be32 corrErrorStatus;
748 // Record data about the call to allocate a buffer.
752 //P7IOC MMIO Error Regs
753 __be64 p7iocPlssr; // n120
754 __be64 p7iocCsr; // n110
755 __be64 lemFir; // nC00
756 __be64 lemErrorMask; // nC18
757 __be64 lemWOF; // nC40
758 __be64 phbErrorStatus; // nC80
759 __be64 phbFirstErrorStatus; // nC88
760 __be64 phbErrorLog0; // nCC0
761 __be64 phbErrorLog1; // nCC8
762 __be64 mmioErrorStatus; // nD00
763 __be64 mmioFirstErrorStatus; // nD08
764 __be64 mmioErrorLog0; // nD40
765 __be64 mmioErrorLog1; // nD48
766 __be64 dma0ErrorStatus; // nD80
767 __be64 dma0FirstErrorStatus; // nD88
768 __be64 dma0ErrorLog0; // nDC0
769 __be64 dma0ErrorLog1; // nDC8
770 __be64 dma1ErrorStatus; // nE00
771 __be64 dma1FirstErrorStatus; // nE08
772 __be64 dma1ErrorLog0; // nE40
773 __be64 dma1ErrorLog1; // nE48
774 __be64 pestA[OPAL_P7IOC_NUM_PEST_REGS];
775 __be64 pestB[OPAL_P7IOC_NUM_PEST_REGS];
778 struct OpalIoPhb3ErrorData {
779 struct OpalIoPhbErrorCommon common;
784 __be32 portStatusReg;
785 __be32 rootCmplxStatus;
786 __be32 busAgentStatus;
796 __be32 rootErrorStatus;
797 __be32 uncorrErrorStatus;
798 __be32 corrErrorStatus;
807 /* Record data about the call to allocate a buffer */
811 /* PHB3 MMIO Error Regs */
812 __be64 nFir; /* 000 */
813 __be64 nFirMask; /* 003 */
814 __be64 nFirWOF; /* 008 */
815 __be64 phbPlssr; /* 120 */
816 __be64 phbCsr; /* 110 */
817 __be64 lemFir; /* C00 */
818 __be64 lemErrorMask; /* C18 */
819 __be64 lemWOF; /* C40 */
820 __be64 phbErrorStatus; /* C80 */
821 __be64 phbFirstErrorStatus; /* C88 */
822 __be64 phbErrorLog0; /* CC0 */
823 __be64 phbErrorLog1; /* CC8 */
824 __be64 mmioErrorStatus; /* D00 */
825 __be64 mmioFirstErrorStatus; /* D08 */
826 __be64 mmioErrorLog0; /* D40 */
827 __be64 mmioErrorLog1; /* D48 */
828 __be64 dma0ErrorStatus; /* D80 */
829 __be64 dma0FirstErrorStatus; /* D88 */
830 __be64 dma0ErrorLog0; /* DC0 */
831 __be64 dma0ErrorLog1; /* DC8 */
832 __be64 dma1ErrorStatus; /* E00 */
833 __be64 dma1FirstErrorStatus; /* E08 */
834 __be64 dma1ErrorLog0; /* E40 */
835 __be64 dma1ErrorLog1; /* E48 */
836 __be64 pestA[OPAL_PHB3_NUM_PEST_REGS];
837 __be64 pestB[OPAL_PHB3_NUM_PEST_REGS];
840 struct OpalIoPhb4ErrorData {
841 struct OpalIoPhbErrorCommon common;
853 __be32 rootErrorStatus;
854 __be32 uncorrErrorStatus;
855 __be32 corrErrorStatus;
862 /* PHB4 ETU Error Regs */
863 __be64 nFir; /* 000 */
864 __be64 nFirMask; /* 003 */
865 __be64 nFirWOF; /* 008 */
866 __be64 phbPlssr; /* 120 */
867 __be64 phbCsr; /* 110 */
868 __be64 lemFir; /* C00 */
869 __be64 lemErrorMask; /* C18 */
870 __be64 lemWOF; /* C40 */
871 __be64 phbErrorStatus; /* C80 */
872 __be64 phbFirstErrorStatus; /* C88 */
873 __be64 phbErrorLog0; /* CC0 */
874 __be64 phbErrorLog1; /* CC8 */
875 __be64 phbTxeErrorStatus; /* D00 */
876 __be64 phbTxeFirstErrorStatus; /* D08 */
877 __be64 phbTxeErrorLog0; /* D40 */
878 __be64 phbTxeErrorLog1; /* D48 */
879 __be64 phbRxeArbErrorStatus; /* D80 */
880 __be64 phbRxeArbFirstErrorStatus; /* D88 */
881 __be64 phbRxeArbErrorLog0; /* DC0 */
882 __be64 phbRxeArbErrorLog1; /* DC8 */
883 __be64 phbRxeMrgErrorStatus; /* E00 */
884 __be64 phbRxeMrgFirstErrorStatus; /* E08 */
885 __be64 phbRxeMrgErrorLog0; /* E40 */
886 __be64 phbRxeMrgErrorLog1; /* E48 */
887 __be64 phbRxeTceErrorStatus; /* E80 */
888 __be64 phbRxeTceFirstErrorStatus; /* E88 */
889 __be64 phbRxeTceErrorLog0; /* EC0 */
890 __be64 phbRxeTceErrorLog1; /* EC8 */
892 /* PHB4 REGB Error Regs */
893 __be64 phbPblErrorStatus; /* 1900 */
894 __be64 phbPblFirstErrorStatus; /* 1908 */
895 __be64 phbPblErrorLog0; /* 1940 */
896 __be64 phbPblErrorLog1; /* 1948 */
897 __be64 phbPcieDlpErrorLog1; /* 1AA0 */
898 __be64 phbPcieDlpErrorLog2; /* 1AA8 */
899 __be64 phbPcieDlpErrorStatus; /* 1AB0 */
900 __be64 phbRegbErrorStatus; /* 1C00 */
901 __be64 phbRegbFirstErrorStatus; /* 1C08 */
902 __be64 phbRegbErrorLog0; /* 1C40 */
903 __be64 phbRegbErrorLog1; /* 1C48 */
905 __be64 pestA[OPAL_PHB4_NUM_PEST_REGS];
906 __be64 pestB[OPAL_PHB4_NUM_PEST_REGS];
910 OPAL_REINIT_CPUS_HILE_BE = (1 << 0),
911 OPAL_REINIT_CPUS_HILE_LE = (1 << 1),
913 /* These two define the base MMU mode of the host on P9
915 * On P9 Nimbus DD2.0 and Cumlus (and later), KVM can still
916 * create hash guests in "radix" mode with care (full core
919 OPAL_REINIT_CPUS_MMU_HASH = (1 << 2),
920 OPAL_REINIT_CPUS_MMU_RADIX = (1 << 3),
922 OPAL_REINIT_CPUS_TM_SUSPEND_DISABLED = (1 << 4),
925 typedef struct oppanel_line {
930 enum opal_prd_msg_type {
931 OPAL_PRD_MSG_TYPE_INIT = 0, /* HBRT --> OPAL */
932 OPAL_PRD_MSG_TYPE_FINI, /* HBRT/kernel --> OPAL */
933 OPAL_PRD_MSG_TYPE_ATTN, /* HBRT <-- OPAL */
934 OPAL_PRD_MSG_TYPE_ATTN_ACK, /* HBRT --> OPAL */
935 OPAL_PRD_MSG_TYPE_OCC_ERROR, /* HBRT <-- OPAL */
936 OPAL_PRD_MSG_TYPE_OCC_RESET, /* HBRT <-- OPAL */
939 struct opal_prd_msg_header {
949 #define OCC_THROTTLE 2
950 #define OCC_MAX_THROTTLE_STATUS 5
952 struct opal_occ_msg {
955 __be64 throttle_status;
961 * WARNING: The current implementation requires each entry
962 * to represent a block that is 4k aligned *and* each block
963 * size except the last one in the list to be as well.
965 struct opal_sg_entry {
971 * Candidate image SG list.
973 * length = VER | length
975 struct opal_sg_list {
978 struct opal_sg_entry entry[];
982 * Dump region ID range usable by the OS
984 #define OPAL_DUMP_REGION_HOST_START 0x80
985 #define OPAL_DUMP_REGION_LOG_BUF 0x80
986 #define OPAL_DUMP_REGION_HOST_END 0xFF
988 /* CAPI modes for PHB */
990 OPAL_PHB_CAPI_MODE_PCIE = 0,
991 OPAL_PHB_CAPI_MODE_CAPI = 1,
992 OPAL_PHB_CAPI_MODE_SNOOP_OFF = 2,
993 OPAL_PHB_CAPI_MODE_SNOOP_ON = 3,
994 OPAL_PHB_CAPI_MODE_DMA = 4,
995 OPAL_PHB_CAPI_MODE_DMA_TVT1 = 5,
998 /* OPAL I2C request */
999 struct opal_i2c_request {
1001 #define OPAL_I2C_RAW_READ 0
1002 #define OPAL_I2C_RAW_WRITE 1
1003 #define OPAL_I2C_SM_READ 2
1004 #define OPAL_I2C_SM_WRITE 3
1006 #define OPAL_I2C_ADDR_10 0x01 /* Not supported yet */
1007 uint8_t subaddr_sz; /* Max 4 */
1009 __be16 addr; /* 7 or 10 bit address */
1011 __be32 subaddr; /* Sub-address if any */
1012 __be32 size; /* Data size */
1013 __be64 buffer_ra; /* Buffer real address */
1017 * EPOW status sharing (OPAL and the host)
1019 * The host will pass on OPAL, a buffer of length OPAL_SYSEPOW_MAX
1020 * with individual elements being 16 bits wide to fetch the system
1021 * wide EPOW status. Each element in the buffer will contain the
1022 * EPOW status in it's bit representation for a particular EPOW sub
1023 * class as defined here. So multiple detailed EPOW status bits
1024 * specific for any sub class can be represented in a single buffer
1025 * element as it's bit representation.
1028 /* System EPOW type */
1030 OPAL_SYSEPOW_POWER = 0, /* Power EPOW */
1031 OPAL_SYSEPOW_TEMP = 1, /* Temperature EPOW */
1032 OPAL_SYSEPOW_COOLING = 2, /* Cooling EPOW */
1033 OPAL_SYSEPOW_MAX = 3, /* Max EPOW categories */
1038 OPAL_SYSPOWER_UPS = 0x0001, /* System on UPS power */
1039 OPAL_SYSPOWER_CHNG = 0x0002, /* System power config change */
1040 OPAL_SYSPOWER_FAIL = 0x0004, /* System impending power failure */
1041 OPAL_SYSPOWER_INCL = 0x0008, /* System incomplete power */
1044 /* Temperature EPOW */
1046 OPAL_SYSTEMP_AMB = 0x0001, /* System over ambient temperature */
1047 OPAL_SYSTEMP_INT = 0x0002, /* System over internal temperature */
1048 OPAL_SYSTEMP_HMD = 0x0004, /* System over ambient humidity */
1052 enum OpalSysCooling {
1053 OPAL_SYSCOOL_INSF = 0x0001, /* System insufficient cooling */
1056 /* Argument to OPAL_CEC_REBOOT2() */
1058 OPAL_REBOOT_NORMAL = 0,
1059 OPAL_REBOOT_PLATFORM_ERROR = 1,
1060 OPAL_REBOOT_FULL_IPL = 2,
1063 /* Argument to OPAL_PCI_TCE_KILL */
1065 OPAL_PCI_TCE_KILL_PAGES,
1066 OPAL_PCI_TCE_KILL_PE,
1067 OPAL_PCI_TCE_KILL_ALL,
1070 /* The xive operation mode indicates the active "API" and
1071 * corresponds to the "mode" parameter of the opal_xive_reset()
1075 OPAL_XIVE_MODE_EMU = 0,
1076 OPAL_XIVE_MODE_EXPL = 1,
1079 /* Flags for OPAL_XIVE_GET_IRQ_INFO */
1081 OPAL_XIVE_IRQ_TRIGGER_PAGE = 0x00000001,
1082 OPAL_XIVE_IRQ_STORE_EOI = 0x00000002,
1083 OPAL_XIVE_IRQ_LSI = 0x00000004,
1084 OPAL_XIVE_IRQ_SHIFT_BUG = 0x00000008,
1085 OPAL_XIVE_IRQ_MASK_VIA_FW = 0x00000010,
1086 OPAL_XIVE_IRQ_EOI_VIA_FW = 0x00000020,
1089 /* Flags for OPAL_XIVE_GET/SET_QUEUE_INFO */
1091 OPAL_XIVE_EQ_ENABLED = 0x00000001,
1092 OPAL_XIVE_EQ_ALWAYS_NOTIFY = 0x00000002,
1093 OPAL_XIVE_EQ_ESCALATE = 0x00000004,
1096 /* Flags for OPAL_XIVE_GET/SET_VP_INFO */
1098 OPAL_XIVE_VP_ENABLED = 0x00000001,
1099 OPAL_XIVE_VP_SINGLE_ESCALATION = 0x00000002,
1102 /* "Any chip" replacement for chip ID for allocation functions */
1104 OPAL_XIVE_ANY_CHIP = 0xffffffff,
1107 /* Xive sync options */
1109 /* This bits are cumulative, arg is a girq */
1110 XIVE_SYNC_EAS = 0x00000001, /* Sync irq source */
1111 XIVE_SYNC_QUEUE = 0x00000002, /* Sync irq target */
1116 XIVE_DUMP_TM_HYP = 0,
1117 XIVE_DUMP_TM_POOL = 1,
1118 XIVE_DUMP_TM_OS = 2,
1119 XIVE_DUMP_TM_USER = 3,
1121 XIVE_DUMP_EMU_STATE = 5,
1124 /* "type" argument options for OPAL_IMC_COUNTERS_* calls */
1126 OPAL_IMC_COUNTERS_NEST = 1,
1127 OPAL_IMC_COUNTERS_CORE = 2,
1128 OPAL_IMC_COUNTERS_TRACE = 3,
1132 /* PCI p2p descriptor */
1133 #define OPAL_PCI_P2P_ENABLE 0x1
1134 #define OPAL_PCI_P2P_LOAD 0x2
1135 #define OPAL_PCI_P2P_STORE 0x4
1137 #endif /* __ASSEMBLY__ */
1139 #endif /* __OPAL_API_H */