xref: /linux/arch/powerpc/include/asm/opal-api.h (revision 989898b707f74716ec27a4ae2b57e404ca54cbd2)
1 /*
2  * OPAL API definitions.
3  *
4  * Copyright 2011-2015 IBM Corp.
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version
9  * 2 of the License, or (at your option) any later version.
10  */
11 
12 #ifndef __OPAL_API_H
13 #define __OPAL_API_H
14 
15 /****** OPAL APIs ******/
16 
17 /* Return codes */
18 #define OPAL_SUCCESS		0
19 #define OPAL_PARAMETER		-1
20 #define OPAL_BUSY		-2
21 #define OPAL_PARTIAL		-3
22 #define OPAL_CONSTRAINED	-4
23 #define OPAL_CLOSED		-5
24 #define OPAL_HARDWARE		-6
25 #define OPAL_UNSUPPORTED	-7
26 #define OPAL_PERMISSION		-8
27 #define OPAL_NO_MEM		-9
28 #define OPAL_RESOURCE		-10
29 #define OPAL_INTERNAL_ERROR	-11
30 #define OPAL_BUSY_EVENT		-12
31 #define OPAL_HARDWARE_FROZEN	-13
32 #define OPAL_WRONG_STATE	-14
33 #define OPAL_ASYNC_COMPLETION	-15
34 #define OPAL_EMPTY		-16
35 #define OPAL_I2C_TIMEOUT	-17
36 #define OPAL_I2C_INVALID_CMD	-18
37 #define OPAL_I2C_LBUS_PARITY	-19
38 #define OPAL_I2C_BKEND_OVERRUN	-20
39 #define OPAL_I2C_BKEND_ACCESS	-21
40 #define OPAL_I2C_ARBT_LOST	-22
41 #define OPAL_I2C_NACK_RCVD	-23
42 #define OPAL_I2C_STOP_ERR	-24
43 
44 /* API Tokens (in r0) */
45 #define OPAL_INVALID_CALL		       -1
46 #define OPAL_TEST				0
47 #define OPAL_CONSOLE_WRITE			1
48 #define OPAL_CONSOLE_READ			2
49 #define OPAL_RTC_READ				3
50 #define OPAL_RTC_WRITE				4
51 #define OPAL_CEC_POWER_DOWN			5
52 #define OPAL_CEC_REBOOT				6
53 #define OPAL_READ_NVRAM				7
54 #define OPAL_WRITE_NVRAM			8
55 #define OPAL_HANDLE_INTERRUPT			9
56 #define OPAL_POLL_EVENTS			10
57 #define OPAL_PCI_SET_HUB_TCE_MEMORY		11
58 #define OPAL_PCI_SET_PHB_TCE_MEMORY		12
59 #define OPAL_PCI_CONFIG_READ_BYTE		13
60 #define OPAL_PCI_CONFIG_READ_HALF_WORD  	14
61 #define OPAL_PCI_CONFIG_READ_WORD		15
62 #define OPAL_PCI_CONFIG_WRITE_BYTE		16
63 #define OPAL_PCI_CONFIG_WRITE_HALF_WORD		17
64 #define OPAL_PCI_CONFIG_WRITE_WORD		18
65 #define OPAL_SET_XIVE				19
66 #define OPAL_GET_XIVE				20
67 #define OPAL_GET_COMPLETION_TOKEN_STATUS	21 /* obsolete */
68 #define OPAL_REGISTER_OPAL_EXCEPTION_HANDLER	22
69 #define OPAL_PCI_EEH_FREEZE_STATUS		23
70 #define OPAL_PCI_SHPC				24
71 #define OPAL_CONSOLE_WRITE_BUFFER_SPACE		25
72 #define OPAL_PCI_EEH_FREEZE_CLEAR		26
73 #define OPAL_PCI_PHB_MMIO_ENABLE		27
74 #define OPAL_PCI_SET_PHB_MEM_WINDOW		28
75 #define OPAL_PCI_MAP_PE_MMIO_WINDOW		29
76 #define OPAL_PCI_SET_PHB_TABLE_MEMORY		30
77 #define OPAL_PCI_SET_PE				31
78 #define OPAL_PCI_SET_PELTV			32
79 #define OPAL_PCI_SET_MVE			33
80 #define OPAL_PCI_SET_MVE_ENABLE			34
81 #define OPAL_PCI_GET_XIVE_REISSUE		35
82 #define OPAL_PCI_SET_XIVE_REISSUE		36
83 #define OPAL_PCI_SET_XIVE_PE			37
84 #define OPAL_GET_XIVE_SOURCE			38
85 #define OPAL_GET_MSI_32				39
86 #define OPAL_GET_MSI_64				40
87 #define OPAL_START_CPU				41
88 #define OPAL_QUERY_CPU_STATUS			42
89 #define OPAL_WRITE_OPPANEL			43 /* unimplemented */
90 #define OPAL_PCI_MAP_PE_DMA_WINDOW		44
91 #define OPAL_PCI_MAP_PE_DMA_WINDOW_REAL		45
92 #define OPAL_PCI_RESET				49
93 #define OPAL_PCI_GET_HUB_DIAG_DATA		50
94 #define OPAL_PCI_GET_PHB_DIAG_DATA		51
95 #define OPAL_PCI_FENCE_PHB			52
96 #define OPAL_PCI_REINIT				53
97 #define OPAL_PCI_MASK_PE_ERROR			54
98 #define OPAL_SET_SLOT_LED_STATUS		55
99 #define OPAL_GET_EPOW_STATUS			56
100 #define OPAL_SET_SYSTEM_ATTENTION_LED		57
101 #define OPAL_RESERVED1				58
102 #define OPAL_RESERVED2				59
103 #define OPAL_PCI_NEXT_ERROR			60
104 #define OPAL_PCI_EEH_FREEZE_STATUS2		61
105 #define OPAL_PCI_POLL				62
106 #define OPAL_PCI_MSI_EOI			63
107 #define OPAL_PCI_GET_PHB_DIAG_DATA2		64
108 #define OPAL_XSCOM_READ				65
109 #define OPAL_XSCOM_WRITE			66
110 #define OPAL_LPC_READ				67
111 #define OPAL_LPC_WRITE				68
112 #define OPAL_RETURN_CPU				69
113 #define OPAL_REINIT_CPUS			70
114 #define OPAL_ELOG_READ				71
115 #define OPAL_ELOG_WRITE				72
116 #define OPAL_ELOG_ACK				73
117 #define OPAL_ELOG_RESEND			74
118 #define OPAL_ELOG_SIZE				75
119 #define OPAL_FLASH_VALIDATE			76
120 #define OPAL_FLASH_MANAGE			77
121 #define OPAL_FLASH_UPDATE			78
122 #define OPAL_RESYNC_TIMEBASE			79
123 #define OPAL_CHECK_TOKEN			80
124 #define OPAL_DUMP_INIT				81
125 #define OPAL_DUMP_INFO				82
126 #define OPAL_DUMP_READ				83
127 #define OPAL_DUMP_ACK				84
128 #define OPAL_GET_MSG				85
129 #define OPAL_CHECK_ASYNC_COMPLETION		86
130 #define OPAL_SYNC_HOST_REBOOT			87
131 #define OPAL_SENSOR_READ			88
132 #define OPAL_GET_PARAM				89
133 #define OPAL_SET_PARAM				90
134 #define OPAL_DUMP_RESEND			91
135 #define OPAL_ELOG_SEND				92	/* Deprecated */
136 #define OPAL_PCI_SET_PHB_CAPI_MODE		93
137 #define OPAL_DUMP_INFO2				94
138 #define OPAL_WRITE_OPPANEL_ASYNC		95
139 #define OPAL_PCI_ERR_INJECT			96
140 #define OPAL_PCI_EEH_FREEZE_SET			97
141 #define OPAL_HANDLE_HMI				98
142 #define OPAL_CONFIG_CPU_IDLE_STATE		99
143 #define OPAL_SLW_SET_REG			100
144 #define OPAL_REGISTER_DUMP_REGION		101
145 #define OPAL_UNREGISTER_DUMP_REGION		102
146 #define OPAL_WRITE_TPO				103
147 #define OPAL_READ_TPO				104
148 #define OPAL_GET_DPO_STATUS			105
149 #define OPAL_OLD_I2C_REQUEST			106	/* Deprecated */
150 #define OPAL_IPMI_SEND				107
151 #define OPAL_IPMI_RECV				108
152 #define OPAL_I2C_REQUEST			109
153 #define OPAL_FLASH_READ				110
154 #define OPAL_FLASH_WRITE			111
155 #define OPAL_FLASH_ERASE			112
156 #define OPAL_LAST				112
157 
158 /* Device tree flags */
159 
160 /* Flags set in power-mgmt nodes in device tree if
161  * respective idle states are supported in the platform.
162  */
163 #define OPAL_PM_NAP_ENABLED		0x00010000
164 #define OPAL_PM_SLEEP_ENABLED		0x00020000
165 #define OPAL_PM_WINKLE_ENABLED		0x00040000
166 #define OPAL_PM_SLEEP_ENABLED_ER1	0x00080000 /* with workaround */
167 
168 /*
169  * OPAL_CONFIG_CPU_IDLE_STATE parameters
170  */
171 #define OPAL_CONFIG_IDLE_FASTSLEEP	1
172 #define OPAL_CONFIG_IDLE_UNDO		0
173 #define OPAL_CONFIG_IDLE_APPLY		1
174 
175 #ifndef __ASSEMBLY__
176 
177 /* Other enums */
178 enum OpalFreezeState {
179 	OPAL_EEH_STOPPED_NOT_FROZEN = 0,
180 	OPAL_EEH_STOPPED_MMIO_FREEZE = 1,
181 	OPAL_EEH_STOPPED_DMA_FREEZE = 2,
182 	OPAL_EEH_STOPPED_MMIO_DMA_FREEZE = 3,
183 	OPAL_EEH_STOPPED_RESET = 4,
184 	OPAL_EEH_STOPPED_TEMP_UNAVAIL = 5,
185 	OPAL_EEH_STOPPED_PERM_UNAVAIL = 6
186 };
187 
188 enum OpalEehFreezeActionToken {
189 	OPAL_EEH_ACTION_CLEAR_FREEZE_MMIO = 1,
190 	OPAL_EEH_ACTION_CLEAR_FREEZE_DMA = 2,
191 	OPAL_EEH_ACTION_CLEAR_FREEZE_ALL = 3,
192 
193 	OPAL_EEH_ACTION_SET_FREEZE_MMIO = 1,
194 	OPAL_EEH_ACTION_SET_FREEZE_DMA  = 2,
195 	OPAL_EEH_ACTION_SET_FREEZE_ALL  = 3
196 };
197 
198 enum OpalPciStatusToken {
199 	OPAL_EEH_NO_ERROR	= 0,
200 	OPAL_EEH_IOC_ERROR	= 1,
201 	OPAL_EEH_PHB_ERROR	= 2,
202 	OPAL_EEH_PE_ERROR	= 3,
203 	OPAL_EEH_PE_MMIO_ERROR	= 4,
204 	OPAL_EEH_PE_DMA_ERROR	= 5
205 };
206 
207 enum OpalPciErrorSeverity {
208 	OPAL_EEH_SEV_NO_ERROR	= 0,
209 	OPAL_EEH_SEV_IOC_DEAD	= 1,
210 	OPAL_EEH_SEV_PHB_DEAD	= 2,
211 	OPAL_EEH_SEV_PHB_FENCED	= 3,
212 	OPAL_EEH_SEV_PE_ER	= 4,
213 	OPAL_EEH_SEV_INF	= 5
214 };
215 
216 enum OpalErrinjectType {
217 	OPAL_ERR_INJECT_TYPE_IOA_BUS_ERR	= 0,
218 	OPAL_ERR_INJECT_TYPE_IOA_BUS_ERR64	= 1,
219 };
220 
221 enum OpalErrinjectFunc {
222 	/* IOA bus specific errors */
223 	OPAL_ERR_INJECT_FUNC_IOA_LD_MEM_ADDR	= 0,
224 	OPAL_ERR_INJECT_FUNC_IOA_LD_MEM_DATA	= 1,
225 	OPAL_ERR_INJECT_FUNC_IOA_LD_IO_ADDR	= 2,
226 	OPAL_ERR_INJECT_FUNC_IOA_LD_IO_DATA	= 3,
227 	OPAL_ERR_INJECT_FUNC_IOA_LD_CFG_ADDR	= 4,
228 	OPAL_ERR_INJECT_FUNC_IOA_LD_CFG_DATA	= 5,
229 	OPAL_ERR_INJECT_FUNC_IOA_ST_MEM_ADDR	= 6,
230 	OPAL_ERR_INJECT_FUNC_IOA_ST_MEM_DATA	= 7,
231 	OPAL_ERR_INJECT_FUNC_IOA_ST_IO_ADDR	= 8,
232 	OPAL_ERR_INJECT_FUNC_IOA_ST_IO_DATA	= 9,
233 	OPAL_ERR_INJECT_FUNC_IOA_ST_CFG_ADDR	= 10,
234 	OPAL_ERR_INJECT_FUNC_IOA_ST_CFG_DATA	= 11,
235 	OPAL_ERR_INJECT_FUNC_IOA_DMA_RD_ADDR	= 12,
236 	OPAL_ERR_INJECT_FUNC_IOA_DMA_RD_DATA	= 13,
237 	OPAL_ERR_INJECT_FUNC_IOA_DMA_RD_MASTER	= 14,
238 	OPAL_ERR_INJECT_FUNC_IOA_DMA_RD_TARGET	= 15,
239 	OPAL_ERR_INJECT_FUNC_IOA_DMA_WR_ADDR	= 16,
240 	OPAL_ERR_INJECT_FUNC_IOA_DMA_WR_DATA	= 17,
241 	OPAL_ERR_INJECT_FUNC_IOA_DMA_WR_MASTER	= 18,
242 	OPAL_ERR_INJECT_FUNC_IOA_DMA_WR_TARGET	= 19,
243 };
244 
245 enum OpalMmioWindowType {
246 	OPAL_M32_WINDOW_TYPE = 1,
247 	OPAL_M64_WINDOW_TYPE = 2,
248 	OPAL_IO_WINDOW_TYPE  = 3
249 };
250 
251 enum OpalExceptionHandler {
252 	OPAL_MACHINE_CHECK_HANDLER	    = 1,
253 	OPAL_HYPERVISOR_MAINTENANCE_HANDLER = 2,
254 	OPAL_SOFTPATCH_HANDLER		    = 3
255 };
256 
257 enum OpalPendingState {
258 	OPAL_EVENT_OPAL_INTERNAL   = 0x1,
259 	OPAL_EVENT_NVRAM	   = 0x2,
260 	OPAL_EVENT_RTC		   = 0x4,
261 	OPAL_EVENT_CONSOLE_OUTPUT  = 0x8,
262 	OPAL_EVENT_CONSOLE_INPUT   = 0x10,
263 	OPAL_EVENT_ERROR_LOG_AVAIL = 0x20,
264 	OPAL_EVENT_ERROR_LOG	   = 0x40,
265 	OPAL_EVENT_EPOW		   = 0x80,
266 	OPAL_EVENT_LED_STATUS	   = 0x100,
267 	OPAL_EVENT_PCI_ERROR	   = 0x200,
268 	OPAL_EVENT_DUMP_AVAIL	   = 0x400,
269 	OPAL_EVENT_MSG_PENDING	   = 0x800,
270 };
271 
272 enum OpalThreadStatus {
273 	OPAL_THREAD_INACTIVE = 0x0,
274 	OPAL_THREAD_STARTED = 0x1,
275 	OPAL_THREAD_UNAVAILABLE = 0x2 /* opal-v3 */
276 };
277 
278 enum OpalPciBusCompare {
279 	OpalPciBusAny	= 0,	/* Any bus number match */
280 	OpalPciBus3Bits	= 2,	/* Match top 3 bits of bus number */
281 	OpalPciBus4Bits	= 3,	/* Match top 4 bits of bus number */
282 	OpalPciBus5Bits	= 4,	/* Match top 5 bits of bus number */
283 	OpalPciBus6Bits	= 5,	/* Match top 6 bits of bus number */
284 	OpalPciBus7Bits	= 6,	/* Match top 7 bits of bus number */
285 	OpalPciBusAll	= 7,	/* Match bus number exactly */
286 };
287 
288 enum OpalDeviceCompare {
289 	OPAL_IGNORE_RID_DEVICE_NUMBER = 0,
290 	OPAL_COMPARE_RID_DEVICE_NUMBER = 1
291 };
292 
293 enum OpalFuncCompare {
294 	OPAL_IGNORE_RID_FUNCTION_NUMBER = 0,
295 	OPAL_COMPARE_RID_FUNCTION_NUMBER = 1
296 };
297 
298 enum OpalPeAction {
299 	OPAL_UNMAP_PE = 0,
300 	OPAL_MAP_PE = 1
301 };
302 
303 enum OpalPeltvAction {
304 	OPAL_REMOVE_PE_FROM_DOMAIN = 0,
305 	OPAL_ADD_PE_TO_DOMAIN = 1
306 };
307 
308 enum OpalMveEnableAction {
309 	OPAL_DISABLE_MVE = 0,
310 	OPAL_ENABLE_MVE = 1
311 };
312 
313 enum OpalM64Action {
314 	OPAL_DISABLE_M64 = 0,
315 	OPAL_ENABLE_M64_SPLIT = 1,
316 	OPAL_ENABLE_M64_NON_SPLIT = 2
317 };
318 
319 enum OpalPciResetScope {
320 	OPAL_RESET_PHB_COMPLETE		= 1,
321 	OPAL_RESET_PCI_LINK		= 2,
322 	OPAL_RESET_PHB_ERROR		= 3,
323 	OPAL_RESET_PCI_HOT		= 4,
324 	OPAL_RESET_PCI_FUNDAMENTAL	= 5,
325 	OPAL_RESET_PCI_IODA_TABLE	= 6
326 };
327 
328 enum OpalPciReinitScope {
329 	/*
330 	 * Note: we chose values that do not overlap
331 	 * OpalPciResetScope as OPAL v2 used the same
332 	 * enum for both
333 	 */
334 	OPAL_REINIT_PCI_DEV = 1000
335 };
336 
337 enum OpalPciResetState {
338 	OPAL_DEASSERT_RESET = 0,
339 	OPAL_ASSERT_RESET   = 1
340 };
341 
342 /*
343  * Address cycle types for LPC accesses. These also correspond
344  * to the content of the first cell of the "reg" property for
345  * device nodes on the LPC bus
346  */
347 enum OpalLPCAddressType {
348 	OPAL_LPC_MEM	= 0,
349 	OPAL_LPC_IO	= 1,
350 	OPAL_LPC_FW	= 2,
351 };
352 
353 enum opal_msg_type {
354 	OPAL_MSG_ASYNC_COMP = 0,	/* params[0] = token, params[1] = rc,
355 					 * additional params function-specific
356 					 */
357 	OPAL_MSG_MEM_ERR,
358 	OPAL_MSG_EPOW,
359 	OPAL_MSG_SHUTDOWN,		/* params[0] = 1 reboot, 0 shutdown */
360 	OPAL_MSG_HMI_EVT,
361 	OPAL_MSG_DPO,
362 	OPAL_MSG_TYPE_MAX,
363 };
364 
365 struct opal_msg {
366 	__be32 msg_type;
367 	__be32 reserved;
368 	__be64 params[8];
369 };
370 
371 /* System parameter permission */
372 enum OpalSysparamPerm {
373 	OPAL_SYSPARAM_READ  = 0x1,
374 	OPAL_SYSPARAM_WRITE = 0x2,
375 	OPAL_SYSPARAM_RW    = (OPAL_SYSPARAM_READ | OPAL_SYSPARAM_WRITE),
376 };
377 
378 enum {
379 	OPAL_IPMI_MSG_FORMAT_VERSION_1 = 1,
380 };
381 
382 struct opal_ipmi_msg {
383 	uint8_t version;
384 	uint8_t netfn;
385 	uint8_t cmd;
386 	uint8_t data[];
387 };
388 
389 /* FSP memory errors handling */
390 enum OpalMemErr_Version {
391 	OpalMemErr_V1 = 1,
392 };
393 
394 enum OpalMemErrType {
395 	OPAL_MEM_ERR_TYPE_RESILIENCE	= 0,
396 	OPAL_MEM_ERR_TYPE_DYN_DALLOC,
397 };
398 
399 /* Memory Reilience error type */
400 enum OpalMemErr_ResilErrType {
401 	OPAL_MEM_RESILIENCE_CE		= 0,
402 	OPAL_MEM_RESILIENCE_UE,
403 	OPAL_MEM_RESILIENCE_UE_SCRUB,
404 };
405 
406 /* Dynamic Memory Deallocation type */
407 enum OpalMemErr_DynErrType {
408 	OPAL_MEM_DYNAMIC_DEALLOC	= 0,
409 };
410 
411 struct OpalMemoryErrorData {
412 	enum OpalMemErr_Version	version:8;	/* 0x00 */
413 	enum OpalMemErrType	type:8;		/* 0x01 */
414 	__be16			flags;		/* 0x02 */
415 	uint8_t			reserved_1[4];	/* 0x04 */
416 
417 	union {
418 		/* Memory Resilience corrected/uncorrected error info */
419 		struct {
420 			enum OpalMemErr_ResilErrType	resil_err_type:8;
421 			uint8_t				reserved_1[7];
422 			__be64				physical_address_start;
423 			__be64				physical_address_end;
424 		} resilience;
425 		/* Dynamic memory deallocation error info */
426 		struct {
427 			enum OpalMemErr_DynErrType	dyn_err_type:8;
428 			uint8_t				reserved_1[7];
429 			__be64				physical_address_start;
430 			__be64				physical_address_end;
431 		} dyn_dealloc;
432 	} u;
433 };
434 
435 /* HMI interrupt event */
436 enum OpalHMI_Version {
437 	OpalHMIEvt_V1 = 1,
438 };
439 
440 enum OpalHMI_Severity {
441 	OpalHMI_SEV_NO_ERROR = 0,
442 	OpalHMI_SEV_WARNING = 1,
443 	OpalHMI_SEV_ERROR_SYNC = 2,
444 	OpalHMI_SEV_FATAL = 3,
445 };
446 
447 enum OpalHMI_Disposition {
448 	OpalHMI_DISPOSITION_RECOVERED = 0,
449 	OpalHMI_DISPOSITION_NOT_RECOVERED = 1,
450 };
451 
452 enum OpalHMI_ErrType {
453 	OpalHMI_ERROR_MALFUNC_ALERT	= 0,
454 	OpalHMI_ERROR_PROC_RECOV_DONE,
455 	OpalHMI_ERROR_PROC_RECOV_DONE_AGAIN,
456 	OpalHMI_ERROR_PROC_RECOV_MASKED,
457 	OpalHMI_ERROR_TFAC,
458 	OpalHMI_ERROR_TFMR_PARITY,
459 	OpalHMI_ERROR_HA_OVERFLOW_WARN,
460 	OpalHMI_ERROR_XSCOM_FAIL,
461 	OpalHMI_ERROR_XSCOM_DONE,
462 	OpalHMI_ERROR_SCOM_FIR,
463 	OpalHMI_ERROR_DEBUG_TRIG_FIR,
464 	OpalHMI_ERROR_HYP_RESOURCE,
465 	OpalHMI_ERROR_CAPP_RECOVERY,
466 };
467 
468 struct OpalHMIEvent {
469 	uint8_t		version;	/* 0x00 */
470 	uint8_t		severity;	/* 0x01 */
471 	uint8_t		type;		/* 0x02 */
472 	uint8_t		disposition;	/* 0x03 */
473 	uint8_t		reserved_1[4];	/* 0x04 */
474 
475 	__be64		hmer;
476 	/* TFMR register. Valid only for TFAC and TFMR_PARITY error type. */
477 	__be64		tfmr;
478 };
479 
480 enum {
481 	OPAL_P7IOC_DIAG_TYPE_NONE	= 0,
482 	OPAL_P7IOC_DIAG_TYPE_RGC	= 1,
483 	OPAL_P7IOC_DIAG_TYPE_BI		= 2,
484 	OPAL_P7IOC_DIAG_TYPE_CI		= 3,
485 	OPAL_P7IOC_DIAG_TYPE_MISC	= 4,
486 	OPAL_P7IOC_DIAG_TYPE_I2C	= 5,
487 	OPAL_P7IOC_DIAG_TYPE_LAST	= 6
488 };
489 
490 struct OpalIoP7IOCErrorData {
491 	__be16 type;
492 
493 	/* GEM */
494 	__be64 gemXfir;
495 	__be64 gemRfir;
496 	__be64 gemRirqfir;
497 	__be64 gemMask;
498 	__be64 gemRwof;
499 
500 	/* LEM */
501 	__be64 lemFir;
502 	__be64 lemErrMask;
503 	__be64 lemAction0;
504 	__be64 lemAction1;
505 	__be64 lemWof;
506 
507 	union {
508 		struct OpalIoP7IOCRgcErrorData {
509 			__be64 rgcStatus;	/* 3E1C10 */
510 			__be64 rgcLdcp;		/* 3E1C18 */
511 		}rgc;
512 		struct OpalIoP7IOCBiErrorData {
513 			__be64 biLdcp0;		/* 3C0100, 3C0118 */
514 			__be64 biLdcp1;		/* 3C0108, 3C0120 */
515 			__be64 biLdcp2;		/* 3C0110, 3C0128 */
516 			__be64 biFenceStatus;	/* 3C0130, 3C0130 */
517 
518 			uint8_t biDownbound;	/* BI Downbound or Upbound */
519 		}bi;
520 		struct OpalIoP7IOCCiErrorData {
521 			__be64 ciPortStatus;	/* 3Dn008 */
522 			__be64 ciPortLdcp;	/* 3Dn010 */
523 
524 			uint8_t ciPort;		/* Index of CI port: 0/1 */
525 		}ci;
526 	};
527 };
528 
529 /**
530  * This structure defines the overlay which will be used to store PHB error
531  * data upon request.
532  */
533 enum {
534 	OPAL_PHB_ERROR_DATA_VERSION_1 = 1,
535 };
536 
537 enum {
538 	OPAL_PHB_ERROR_DATA_TYPE_P7IOC = 1,
539 	OPAL_PHB_ERROR_DATA_TYPE_PHB3 = 2
540 };
541 
542 enum {
543 	OPAL_P7IOC_NUM_PEST_REGS = 128,
544 	OPAL_PHB3_NUM_PEST_REGS = 256
545 };
546 
547 struct OpalIoPhbErrorCommon {
548 	__be32 version;
549 	__be32 ioType;
550 	__be32 len;
551 };
552 
553 struct OpalIoP7IOCPhbErrorData {
554 	struct OpalIoPhbErrorCommon common;
555 
556 	__be32 brdgCtl;
557 
558 	// P7IOC utl regs
559 	__be32 portStatusReg;
560 	__be32 rootCmplxStatus;
561 	__be32 busAgentStatus;
562 
563 	// P7IOC cfg regs
564 	__be32 deviceStatus;
565 	__be32 slotStatus;
566 	__be32 linkStatus;
567 	__be32 devCmdStatus;
568 	__be32 devSecStatus;
569 
570 	// cfg AER regs
571 	__be32 rootErrorStatus;
572 	__be32 uncorrErrorStatus;
573 	__be32 corrErrorStatus;
574 	__be32 tlpHdr1;
575 	__be32 tlpHdr2;
576 	__be32 tlpHdr3;
577 	__be32 tlpHdr4;
578 	__be32 sourceId;
579 
580 	__be32 rsv3;
581 
582 	// Record data about the call to allocate a buffer.
583 	__be64 errorClass;
584 	__be64 correlator;
585 
586 	//P7IOC MMIO Error Regs
587 	__be64 p7iocPlssr;                // n120
588 	__be64 p7iocCsr;                  // n110
589 	__be64 lemFir;                    // nC00
590 	__be64 lemErrorMask;              // nC18
591 	__be64 lemWOF;                    // nC40
592 	__be64 phbErrorStatus;            // nC80
593 	__be64 phbFirstErrorStatus;       // nC88
594 	__be64 phbErrorLog0;              // nCC0
595 	__be64 phbErrorLog1;              // nCC8
596 	__be64 mmioErrorStatus;           // nD00
597 	__be64 mmioFirstErrorStatus;      // nD08
598 	__be64 mmioErrorLog0;             // nD40
599 	__be64 mmioErrorLog1;             // nD48
600 	__be64 dma0ErrorStatus;           // nD80
601 	__be64 dma0FirstErrorStatus;      // nD88
602 	__be64 dma0ErrorLog0;             // nDC0
603 	__be64 dma0ErrorLog1;             // nDC8
604 	__be64 dma1ErrorStatus;           // nE00
605 	__be64 dma1FirstErrorStatus;      // nE08
606 	__be64 dma1ErrorLog0;             // nE40
607 	__be64 dma1ErrorLog1;             // nE48
608 	__be64 pestA[OPAL_P7IOC_NUM_PEST_REGS];
609 	__be64 pestB[OPAL_P7IOC_NUM_PEST_REGS];
610 };
611 
612 struct OpalIoPhb3ErrorData {
613 	struct OpalIoPhbErrorCommon common;
614 
615 	__be32 brdgCtl;
616 
617 	/* PHB3 UTL regs */
618 	__be32 portStatusReg;
619 	__be32 rootCmplxStatus;
620 	__be32 busAgentStatus;
621 
622 	/* PHB3 cfg regs */
623 	__be32 deviceStatus;
624 	__be32 slotStatus;
625 	__be32 linkStatus;
626 	__be32 devCmdStatus;
627 	__be32 devSecStatus;
628 
629 	/* cfg AER regs */
630 	__be32 rootErrorStatus;
631 	__be32 uncorrErrorStatus;
632 	__be32 corrErrorStatus;
633 	__be32 tlpHdr1;
634 	__be32 tlpHdr2;
635 	__be32 tlpHdr3;
636 	__be32 tlpHdr4;
637 	__be32 sourceId;
638 
639 	__be32 rsv3;
640 
641 	/* Record data about the call to allocate a buffer */
642 	__be64 errorClass;
643 	__be64 correlator;
644 
645 	/* PHB3 MMIO Error Regs */
646 	__be64 nFir;			/* 000 */
647 	__be64 nFirMask;		/* 003 */
648 	__be64 nFirWOF;		/* 008 */
649 	__be64 phbPlssr;		/* 120 */
650 	__be64 phbCsr;		/* 110 */
651 	__be64 lemFir;		/* C00 */
652 	__be64 lemErrorMask;		/* C18 */
653 	__be64 lemWOF;		/* C40 */
654 	__be64 phbErrorStatus;	/* C80 */
655 	__be64 phbFirstErrorStatus;	/* C88 */
656 	__be64 phbErrorLog0;		/* CC0 */
657 	__be64 phbErrorLog1;		/* CC8 */
658 	__be64 mmioErrorStatus;	/* D00 */
659 	__be64 mmioFirstErrorStatus;	/* D08 */
660 	__be64 mmioErrorLog0;		/* D40 */
661 	__be64 mmioErrorLog1;		/* D48 */
662 	__be64 dma0ErrorStatus;	/* D80 */
663 	__be64 dma0FirstErrorStatus;	/* D88 */
664 	__be64 dma0ErrorLog0;		/* DC0 */
665 	__be64 dma0ErrorLog1;		/* DC8 */
666 	__be64 dma1ErrorStatus;	/* E00 */
667 	__be64 dma1FirstErrorStatus;	/* E08 */
668 	__be64 dma1ErrorLog0;		/* E40 */
669 	__be64 dma1ErrorLog1;		/* E48 */
670 	__be64 pestA[OPAL_PHB3_NUM_PEST_REGS];
671 	__be64 pestB[OPAL_PHB3_NUM_PEST_REGS];
672 };
673 
674 enum {
675 	OPAL_REINIT_CPUS_HILE_BE	= (1 << 0),
676 	OPAL_REINIT_CPUS_HILE_LE	= (1 << 1),
677 };
678 
679 typedef struct oppanel_line {
680 	__be64 line;
681 	__be64 line_len;
682 } oppanel_line_t;
683 
684 /*
685  * SG entries
686  *
687  * WARNING: The current implementation requires each entry
688  * to represent a block that is 4k aligned *and* each block
689  * size except the last one in the list to be as well.
690  */
691 struct opal_sg_entry {
692 	__be64 data;
693 	__be64 length;
694 };
695 
696 /*
697  * Candiate image SG list.
698  *
699  * length = VER | length
700  */
701 struct opal_sg_list {
702 	__be64 length;
703 	__be64 next;
704 	struct opal_sg_entry entry[];
705 };
706 
707 /*
708  * Dump region ID range usable by the OS
709  */
710 #define OPAL_DUMP_REGION_HOST_START		0x80
711 #define OPAL_DUMP_REGION_LOG_BUF		0x80
712 #define OPAL_DUMP_REGION_HOST_END		0xFF
713 
714 /* CAPI modes for PHB */
715 enum {
716 	OPAL_PHB_CAPI_MODE_PCIE		= 0,
717 	OPAL_PHB_CAPI_MODE_CAPI		= 1,
718 	OPAL_PHB_CAPI_MODE_SNOOP_OFF    = 2,
719 	OPAL_PHB_CAPI_MODE_SNOOP_ON	= 3,
720 };
721 
722 /* OPAL I2C request */
723 struct opal_i2c_request {
724 	uint8_t	type;
725 #define OPAL_I2C_RAW_READ	0
726 #define OPAL_I2C_RAW_WRITE	1
727 #define OPAL_I2C_SM_READ	2
728 #define OPAL_I2C_SM_WRITE	3
729 	uint8_t flags;
730 #define OPAL_I2C_ADDR_10	0x01	/* Not supported yet */
731 	uint8_t	subaddr_sz;		/* Max 4 */
732 	uint8_t reserved;
733 	__be16 addr;			/* 7 or 10 bit address */
734 	__be16 reserved2;
735 	__be32 subaddr;		/* Sub-address if any */
736 	__be32 size;			/* Data size */
737 	__be64 buffer_ra;		/* Buffer real address */
738 };
739 
740 #endif /* __ASSEMBLY__ */
741 
742 #endif /* __OPAL_API_H */
743