Merge tag 'iwlwifi-next-for-kalle-2014-12-30' of https://git.kernel.org/pub/scm/linux...
[cascardo/linux.git] / arch / powerpc / include / asm / opal.h
1 /*
2  * PowerNV OPAL definitions.
3  *
4  * Copyright 2011 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_H
13 #define __OPAL_H
14
15 #ifndef __ASSEMBLY__
16 /*
17  * SG entry
18  *
19  * WARNING: The current implementation requires each entry
20  * to represent a block that is 4k aligned *and* each block
21  * size except the last one in the list to be as well.
22  */
23 struct opal_sg_entry {
24         __be64 data;
25         __be64 length;
26 };
27
28 /* SG list */
29 struct opal_sg_list {
30         __be64 length;
31         __be64 next;
32         struct opal_sg_entry entry[];
33 };
34
35 /* We calculate number of sg entries based on PAGE_SIZE */
36 #define SG_ENTRIES_PER_NODE ((PAGE_SIZE - 16) / sizeof(struct opal_sg_entry))
37
38 #endif /* __ASSEMBLY__ */
39
40 /****** OPAL APIs ******/
41
42 /* Return codes */
43 #define OPAL_SUCCESS            0
44 #define OPAL_PARAMETER          -1
45 #define OPAL_BUSY               -2
46 #define OPAL_PARTIAL            -3
47 #define OPAL_CONSTRAINED        -4
48 #define OPAL_CLOSED             -5
49 #define OPAL_HARDWARE           -6
50 #define OPAL_UNSUPPORTED        -7
51 #define OPAL_PERMISSION         -8
52 #define OPAL_NO_MEM             -9
53 #define OPAL_RESOURCE           -10
54 #define OPAL_INTERNAL_ERROR     -11
55 #define OPAL_BUSY_EVENT         -12
56 #define OPAL_HARDWARE_FROZEN    -13
57 #define OPAL_WRONG_STATE        -14
58 #define OPAL_ASYNC_COMPLETION   -15
59 #define OPAL_I2C_TIMEOUT        -17
60 #define OPAL_I2C_INVALID_CMD    -18
61 #define OPAL_I2C_LBUS_PARITY    -19
62 #define OPAL_I2C_BKEND_OVERRUN  -20
63 #define OPAL_I2C_BKEND_ACCESS   -21
64 #define OPAL_I2C_ARBT_LOST      -22
65 #define OPAL_I2C_NACK_RCVD      -23
66 #define OPAL_I2C_STOP_ERR       -24
67
68 /* API Tokens (in r0) */
69 #define OPAL_INVALID_CALL                       -1
70 #define OPAL_CONSOLE_WRITE                      1
71 #define OPAL_CONSOLE_READ                       2
72 #define OPAL_RTC_READ                           3
73 #define OPAL_RTC_WRITE                          4
74 #define OPAL_CEC_POWER_DOWN                     5
75 #define OPAL_CEC_REBOOT                         6
76 #define OPAL_READ_NVRAM                         7
77 #define OPAL_WRITE_NVRAM                        8
78 #define OPAL_HANDLE_INTERRUPT                   9
79 #define OPAL_POLL_EVENTS                        10
80 #define OPAL_PCI_SET_HUB_TCE_MEMORY             11
81 #define OPAL_PCI_SET_PHB_TCE_MEMORY             12
82 #define OPAL_PCI_CONFIG_READ_BYTE               13
83 #define OPAL_PCI_CONFIG_READ_HALF_WORD          14
84 #define OPAL_PCI_CONFIG_READ_WORD               15
85 #define OPAL_PCI_CONFIG_WRITE_BYTE              16
86 #define OPAL_PCI_CONFIG_WRITE_HALF_WORD         17
87 #define OPAL_PCI_CONFIG_WRITE_WORD              18
88 #define OPAL_SET_XIVE                           19
89 #define OPAL_GET_XIVE                           20
90 #define OPAL_GET_COMPLETION_TOKEN_STATUS        21 /* obsolete */
91 #define OPAL_REGISTER_OPAL_EXCEPTION_HANDLER    22
92 #define OPAL_PCI_EEH_FREEZE_STATUS              23
93 #define OPAL_PCI_SHPC                           24
94 #define OPAL_CONSOLE_WRITE_BUFFER_SPACE         25
95 #define OPAL_PCI_EEH_FREEZE_CLEAR               26
96 #define OPAL_PCI_PHB_MMIO_ENABLE                27
97 #define OPAL_PCI_SET_PHB_MEM_WINDOW             28
98 #define OPAL_PCI_MAP_PE_MMIO_WINDOW             29
99 #define OPAL_PCI_SET_PHB_TABLE_MEMORY           30
100 #define OPAL_PCI_SET_PE                         31
101 #define OPAL_PCI_SET_PELTV                      32
102 #define OPAL_PCI_SET_MVE                        33
103 #define OPAL_PCI_SET_MVE_ENABLE                 34
104 #define OPAL_PCI_GET_XIVE_REISSUE               35
105 #define OPAL_PCI_SET_XIVE_REISSUE               36
106 #define OPAL_PCI_SET_XIVE_PE                    37
107 #define OPAL_GET_XIVE_SOURCE                    38
108 #define OPAL_GET_MSI_32                         39
109 #define OPAL_GET_MSI_64                         40
110 #define OPAL_START_CPU                          41
111 #define OPAL_QUERY_CPU_STATUS                   42
112 #define OPAL_WRITE_OPPANEL                      43
113 #define OPAL_PCI_MAP_PE_DMA_WINDOW              44
114 #define OPAL_PCI_MAP_PE_DMA_WINDOW_REAL         45
115 #define OPAL_PCI_RESET                          49
116 #define OPAL_PCI_GET_HUB_DIAG_DATA              50
117 #define OPAL_PCI_GET_PHB_DIAG_DATA              51
118 #define OPAL_PCI_FENCE_PHB                      52
119 #define OPAL_PCI_REINIT                         53
120 #define OPAL_PCI_MASK_PE_ERROR                  54
121 #define OPAL_SET_SLOT_LED_STATUS                55
122 #define OPAL_GET_EPOW_STATUS                    56
123 #define OPAL_SET_SYSTEM_ATTENTION_LED           57
124 #define OPAL_RESERVED1                          58
125 #define OPAL_RESERVED2                          59
126 #define OPAL_PCI_NEXT_ERROR                     60
127 #define OPAL_PCI_EEH_FREEZE_STATUS2             61
128 #define OPAL_PCI_POLL                           62
129 #define OPAL_PCI_MSI_EOI                        63
130 #define OPAL_PCI_GET_PHB_DIAG_DATA2             64
131 #define OPAL_XSCOM_READ                         65
132 #define OPAL_XSCOM_WRITE                        66
133 #define OPAL_LPC_READ                           67
134 #define OPAL_LPC_WRITE                          68
135 #define OPAL_RETURN_CPU                         69
136 #define OPAL_REINIT_CPUS                        70
137 #define OPAL_ELOG_READ                          71
138 #define OPAL_ELOG_WRITE                         72
139 #define OPAL_ELOG_ACK                           73
140 #define OPAL_ELOG_RESEND                        74
141 #define OPAL_ELOG_SIZE                          75
142 #define OPAL_FLASH_VALIDATE                     76
143 #define OPAL_FLASH_MANAGE                       77
144 #define OPAL_FLASH_UPDATE                       78
145 #define OPAL_RESYNC_TIMEBASE                    79
146 #define OPAL_CHECK_TOKEN                        80
147 #define OPAL_DUMP_INIT                          81
148 #define OPAL_DUMP_INFO                          82
149 #define OPAL_DUMP_READ                          83
150 #define OPAL_DUMP_ACK                           84
151 #define OPAL_GET_MSG                            85
152 #define OPAL_CHECK_ASYNC_COMPLETION             86
153 #define OPAL_SYNC_HOST_REBOOT                   87
154 #define OPAL_SENSOR_READ                        88
155 #define OPAL_GET_PARAM                          89
156 #define OPAL_SET_PARAM                          90
157 #define OPAL_DUMP_RESEND                        91
158 #define OPAL_PCI_SET_PHB_CXL_MODE               93
159 #define OPAL_DUMP_INFO2                         94
160 #define OPAL_PCI_ERR_INJECT                     96
161 #define OPAL_PCI_EEH_FREEZE_SET                 97
162 #define OPAL_HANDLE_HMI                         98
163 #define OPAL_CONFIG_CPU_IDLE_STATE              99
164 #define OPAL_SLW_SET_REG                        100
165 #define OPAL_REGISTER_DUMP_REGION               101
166 #define OPAL_UNREGISTER_DUMP_REGION             102
167 #define OPAL_WRITE_TPO                          103
168 #define OPAL_READ_TPO                           104
169 #define OPAL_IPMI_SEND                          107
170 #define OPAL_IPMI_RECV                          108
171 #define OPAL_I2C_REQUEST                        109
172
173 /* Device tree flags */
174
175 /* Flags set in power-mgmt nodes in device tree if
176  * respective idle states are supported in the platform.
177  */
178 #define OPAL_PM_NAP_ENABLED     0x00010000
179 #define OPAL_PM_SLEEP_ENABLED   0x00020000
180 #define OPAL_PM_WINKLE_ENABLED  0x00040000
181 #define OPAL_PM_SLEEP_ENABLED_ER1       0x00080000
182
183 #ifndef __ASSEMBLY__
184
185 #include <linux/notifier.h>
186
187 /* Other enums */
188 enum OpalVendorApiTokens {
189         OPAL_START_VENDOR_API_RANGE = 1000, OPAL_END_VENDOR_API_RANGE = 1999
190 };
191
192 enum OpalFreezeState {
193         OPAL_EEH_STOPPED_NOT_FROZEN = 0,
194         OPAL_EEH_STOPPED_MMIO_FREEZE = 1,
195         OPAL_EEH_STOPPED_DMA_FREEZE = 2,
196         OPAL_EEH_STOPPED_MMIO_DMA_FREEZE = 3,
197         OPAL_EEH_STOPPED_RESET = 4,
198         OPAL_EEH_STOPPED_TEMP_UNAVAIL = 5,
199         OPAL_EEH_STOPPED_PERM_UNAVAIL = 6
200 };
201
202 enum OpalEehFreezeActionToken {
203         OPAL_EEH_ACTION_CLEAR_FREEZE_MMIO = 1,
204         OPAL_EEH_ACTION_CLEAR_FREEZE_DMA = 2,
205         OPAL_EEH_ACTION_CLEAR_FREEZE_ALL = 3,
206
207         OPAL_EEH_ACTION_SET_FREEZE_MMIO = 1,
208         OPAL_EEH_ACTION_SET_FREEZE_DMA  = 2,
209         OPAL_EEH_ACTION_SET_FREEZE_ALL  = 3
210 };
211
212 enum OpalPciStatusToken {
213         OPAL_EEH_NO_ERROR       = 0,
214         OPAL_EEH_IOC_ERROR      = 1,
215         OPAL_EEH_PHB_ERROR      = 2,
216         OPAL_EEH_PE_ERROR       = 3,
217         OPAL_EEH_PE_MMIO_ERROR  = 4,
218         OPAL_EEH_PE_DMA_ERROR   = 5
219 };
220
221 enum OpalPciErrorSeverity {
222         OPAL_EEH_SEV_NO_ERROR   = 0,
223         OPAL_EEH_SEV_IOC_DEAD   = 1,
224         OPAL_EEH_SEV_PHB_DEAD   = 2,
225         OPAL_EEH_SEV_PHB_FENCED = 3,
226         OPAL_EEH_SEV_PE_ER      = 4,
227         OPAL_EEH_SEV_INF        = 5
228 };
229
230 enum OpalErrinjectType {
231         OPAL_ERR_INJECT_TYPE_IOA_BUS_ERR        = 0,
232         OPAL_ERR_INJECT_TYPE_IOA_BUS_ERR64      = 1,
233 };
234
235 enum OpalErrinjectFunc {
236         /* IOA bus specific errors */
237         OPAL_ERR_INJECT_FUNC_IOA_LD_MEM_ADDR    = 0,
238         OPAL_ERR_INJECT_FUNC_IOA_LD_MEM_DATA    = 1,
239         OPAL_ERR_INJECT_FUNC_IOA_LD_IO_ADDR     = 2,
240         OPAL_ERR_INJECT_FUNC_IOA_LD_IO_DATA     = 3,
241         OPAL_ERR_INJECT_FUNC_IOA_LD_CFG_ADDR    = 4,
242         OPAL_ERR_INJECT_FUNC_IOA_LD_CFG_DATA    = 5,
243         OPAL_ERR_INJECT_FUNC_IOA_ST_MEM_ADDR    = 6,
244         OPAL_ERR_INJECT_FUNC_IOA_ST_MEM_DATA    = 7,
245         OPAL_ERR_INJECT_FUNC_IOA_ST_IO_ADDR     = 8,
246         OPAL_ERR_INJECT_FUNC_IOA_ST_IO_DATA     = 9,
247         OPAL_ERR_INJECT_FUNC_IOA_ST_CFG_ADDR    = 10,
248         OPAL_ERR_INJECT_FUNC_IOA_ST_CFG_DATA    = 11,
249         OPAL_ERR_INJECT_FUNC_IOA_DMA_RD_ADDR    = 12,
250         OPAL_ERR_INJECT_FUNC_IOA_DMA_RD_DATA    = 13,
251         OPAL_ERR_INJECT_FUNC_IOA_DMA_RD_MASTER  = 14,
252         OPAL_ERR_INJECT_FUNC_IOA_DMA_RD_TARGET  = 15,
253         OPAL_ERR_INJECT_FUNC_IOA_DMA_WR_ADDR    = 16,
254         OPAL_ERR_INJECT_FUNC_IOA_DMA_WR_DATA    = 17,
255         OPAL_ERR_INJECT_FUNC_IOA_DMA_WR_MASTER  = 18,
256         OPAL_ERR_INJECT_FUNC_IOA_DMA_WR_TARGET  = 19,
257 };
258
259 enum OpalShpcAction {
260         OPAL_SHPC_GET_LINK_STATE = 0,
261         OPAL_SHPC_GET_SLOT_STATE = 1
262 };
263
264 enum OpalShpcLinkState {
265         OPAL_SHPC_LINK_DOWN = 0,
266         OPAL_SHPC_LINK_UP = 1
267 };
268
269 enum OpalMmioWindowType {
270         OPAL_M32_WINDOW_TYPE = 1,
271         OPAL_M64_WINDOW_TYPE = 2,
272         OPAL_IO_WINDOW_TYPE = 3
273 };
274
275 enum OpalShpcSlotState {
276         OPAL_SHPC_DEV_NOT_PRESENT = 0,
277         OPAL_SHPC_DEV_PRESENT = 1
278 };
279
280 enum OpalExceptionHandler {
281         OPAL_MACHINE_CHECK_HANDLER = 1,
282         OPAL_HYPERVISOR_MAINTENANCE_HANDLER = 2,
283         OPAL_SOFTPATCH_HANDLER = 3
284 };
285
286 enum OpalPendingState {
287         OPAL_EVENT_OPAL_INTERNAL        = 0x1,
288         OPAL_EVENT_NVRAM                = 0x2,
289         OPAL_EVENT_RTC                  = 0x4,
290         OPAL_EVENT_CONSOLE_OUTPUT       = 0x8,
291         OPAL_EVENT_CONSOLE_INPUT        = 0x10,
292         OPAL_EVENT_ERROR_LOG_AVAIL      = 0x20,
293         OPAL_EVENT_ERROR_LOG            = 0x40,
294         OPAL_EVENT_EPOW                 = 0x80,
295         OPAL_EVENT_LED_STATUS           = 0x100,
296         OPAL_EVENT_PCI_ERROR            = 0x200,
297         OPAL_EVENT_DUMP_AVAIL           = 0x400,
298         OPAL_EVENT_MSG_PENDING          = 0x800,
299 };
300
301 enum OpalMessageType {
302         OPAL_MSG_ASYNC_COMP = 0,        /* params[0] = token, params[1] = rc,
303                                          * additional params function-specific
304                                          */
305         OPAL_MSG_MEM_ERR,
306         OPAL_MSG_EPOW,
307         OPAL_MSG_SHUTDOWN,
308         OPAL_MSG_HMI_EVT,
309         OPAL_MSG_TYPE_MAX,
310 };
311
312 enum OpalThreadStatus {
313         OPAL_THREAD_INACTIVE = 0x0,
314         OPAL_THREAD_STARTED = 0x1,
315         OPAL_THREAD_UNAVAILABLE = 0x2 /* opal-v3 */
316 };
317
318 enum OpalPciBusCompare {
319         OpalPciBusAny   = 0,    /* Any bus number match */
320         OpalPciBus3Bits = 2,    /* Match top 3 bits of bus number */
321         OpalPciBus4Bits = 3,    /* Match top 4 bits of bus number */
322         OpalPciBus5Bits = 4,    /* Match top 5 bits of bus number */
323         OpalPciBus6Bits = 5,    /* Match top 6 bits of bus number */
324         OpalPciBus7Bits = 6,    /* Match top 7 bits of bus number */
325         OpalPciBusAll   = 7,    /* Match bus number exactly */
326 };
327
328 enum OpalDeviceCompare {
329         OPAL_IGNORE_RID_DEVICE_NUMBER = 0,
330         OPAL_COMPARE_RID_DEVICE_NUMBER = 1
331 };
332
333 enum OpalFuncCompare {
334         OPAL_IGNORE_RID_FUNCTION_NUMBER = 0,
335         OPAL_COMPARE_RID_FUNCTION_NUMBER = 1
336 };
337
338 enum OpalPeAction {
339         OPAL_UNMAP_PE = 0,
340         OPAL_MAP_PE = 1
341 };
342
343 enum OpalPeltvAction {
344         OPAL_REMOVE_PE_FROM_DOMAIN = 0,
345         OPAL_ADD_PE_TO_DOMAIN = 1
346 };
347
348 enum OpalMveEnableAction {
349         OPAL_DISABLE_MVE = 0,
350         OPAL_ENABLE_MVE = 1
351 };
352
353 enum OpalM64EnableAction {
354         OPAL_DISABLE_M64 = 0,
355         OPAL_ENABLE_M64_SPLIT = 1,
356         OPAL_ENABLE_M64_NON_SPLIT = 2
357 };
358
359 enum OpalPciResetScope {
360         OPAL_RESET_PHB_COMPLETE         = 1,
361         OPAL_RESET_PCI_LINK             = 2,
362         OPAL_RESET_PHB_ERROR            = 3,
363         OPAL_RESET_PCI_HOT              = 4,
364         OPAL_RESET_PCI_FUNDAMENTAL      = 5,
365         OPAL_RESET_PCI_IODA_TABLE       = 6
366 };
367
368 enum OpalPciReinitScope {
369         OPAL_REINIT_PCI_DEV = 1000
370 };
371
372 enum OpalPciResetState {
373         OPAL_DEASSERT_RESET = 0,
374         OPAL_ASSERT_RESET = 1
375 };
376
377 enum OpalPciMaskAction {
378         OPAL_UNMASK_ERROR_TYPE = 0,
379         OPAL_MASK_ERROR_TYPE = 1
380 };
381
382 enum OpalSlotLedType {
383         OPAL_SLOT_LED_ID_TYPE = 0,
384         OPAL_SLOT_LED_FAULT_TYPE = 1
385 };
386
387 enum OpalLedAction {
388         OPAL_TURN_OFF_LED = 0,
389         OPAL_TURN_ON_LED = 1,
390         OPAL_QUERY_LED_STATE_AFTER_BUSY = 2
391 };
392
393 enum OpalEpowStatus {
394         OPAL_EPOW_NONE = 0,
395         OPAL_EPOW_UPS = 1,
396         OPAL_EPOW_OVER_AMBIENT_TEMP = 2,
397         OPAL_EPOW_OVER_INTERNAL_TEMP = 3
398 };
399
400 /*
401  * Address cycle types for LPC accesses. These also correspond
402  * to the content of the first cell of the "reg" property for
403  * device nodes on the LPC bus
404  */
405 enum OpalLPCAddressType {
406         OPAL_LPC_MEM    = 0,
407         OPAL_LPC_IO     = 1,
408         OPAL_LPC_FW     = 2,
409 };
410
411 /* System parameter permission */
412 enum OpalSysparamPerm {
413         OPAL_SYSPARAM_READ      = 0x1,
414         OPAL_SYSPARAM_WRITE     = 0x2,
415         OPAL_SYSPARAM_RW        = (OPAL_SYSPARAM_READ | OPAL_SYSPARAM_WRITE),
416 };
417
418 struct opal_msg {
419         __be32 msg_type;
420         __be32 reserved;
421         __be64 params[8];
422 };
423
424 enum {
425         OPAL_IPMI_MSG_FORMAT_VERSION_1 = 1,
426 };
427
428 struct opal_ipmi_msg {
429         uint8_t         version;
430         uint8_t         netfn;
431         uint8_t         cmd;
432         uint8_t         data[];
433 };
434
435 /* FSP memory errors handling */
436 enum OpalMemErr_Version {
437         OpalMemErr_V1 = 1,
438 };
439
440 enum OpalMemErrType {
441         OPAL_MEM_ERR_TYPE_RESILIENCE    = 0,
442         OPAL_MEM_ERR_TYPE_DYN_DALLOC,
443         OPAL_MEM_ERR_TYPE_SCRUB,
444 };
445
446 /* Memory Reilience error type */
447 enum OpalMemErr_ResilErrType {
448         OPAL_MEM_RESILIENCE_CE          = 0,
449         OPAL_MEM_RESILIENCE_UE,
450         OPAL_MEM_RESILIENCE_UE_SCRUB,
451 };
452
453 /* Dynamic Memory Deallocation type */
454 enum OpalMemErr_DynErrType {
455         OPAL_MEM_DYNAMIC_DEALLOC        = 0,
456 };
457
458 /* OpalMemoryErrorData->flags */
459 #define OPAL_MEM_CORRECTED_ERROR        0x0001
460 #define OPAL_MEM_THRESHOLD_EXCEEDED     0x0002
461 #define OPAL_MEM_ACK_REQUIRED           0x8000
462
463 struct OpalMemoryErrorData {
464         enum OpalMemErr_Version version:8;      /* 0x00 */
465         enum OpalMemErrType     type:8;         /* 0x01 */
466         __be16                  flags;          /* 0x02 */
467         uint8_t                 reserved_1[4];  /* 0x04 */
468
469         union {
470                 /* Memory Resilience corrected/uncorrected error info */
471                 struct {
472                         enum OpalMemErr_ResilErrType resil_err_type:8;
473                         uint8_t         reserved_1[7];
474                         __be64          physical_address_start;
475                         __be64          physical_address_end;
476                 } resilience;
477                 /* Dynamic memory deallocation error info */
478                 struct {
479                         enum OpalMemErr_DynErrType dyn_err_type:8;
480                         uint8_t         reserved_1[7];
481                         __be64          physical_address_start;
482                         __be64          physical_address_end;
483                 } dyn_dealloc;
484         } u;
485 };
486
487 /* HMI interrupt event */
488 enum OpalHMI_Version {
489         OpalHMIEvt_V1 = 1,
490 };
491
492 enum OpalHMI_Severity {
493         OpalHMI_SEV_NO_ERROR = 0,
494         OpalHMI_SEV_WARNING = 1,
495         OpalHMI_SEV_ERROR_SYNC = 2,
496         OpalHMI_SEV_FATAL = 3,
497 };
498
499 enum OpalHMI_Disposition {
500         OpalHMI_DISPOSITION_RECOVERED = 0,
501         OpalHMI_DISPOSITION_NOT_RECOVERED = 1,
502 };
503
504 enum OpalHMI_ErrType {
505         OpalHMI_ERROR_MALFUNC_ALERT     = 0,
506         OpalHMI_ERROR_PROC_RECOV_DONE,
507         OpalHMI_ERROR_PROC_RECOV_DONE_AGAIN,
508         OpalHMI_ERROR_PROC_RECOV_MASKED,
509         OpalHMI_ERROR_TFAC,
510         OpalHMI_ERROR_TFMR_PARITY,
511         OpalHMI_ERROR_HA_OVERFLOW_WARN,
512         OpalHMI_ERROR_XSCOM_FAIL,
513         OpalHMI_ERROR_XSCOM_DONE,
514         OpalHMI_ERROR_SCOM_FIR,
515         OpalHMI_ERROR_DEBUG_TRIG_FIR,
516         OpalHMI_ERROR_HYP_RESOURCE,
517 };
518
519 struct OpalHMIEvent {
520         uint8_t         version;        /* 0x00 */
521         uint8_t         severity;       /* 0x01 */
522         uint8_t         type;           /* 0x02 */
523         uint8_t         disposition;    /* 0x03 */
524         uint8_t         reserved_1[4];  /* 0x04 */
525
526         __be64          hmer;
527         /* TFMR register. Valid only for TFAC and TFMR_PARITY error type. */
528         __be64          tfmr;
529 };
530
531 enum {
532         OPAL_P7IOC_DIAG_TYPE_NONE       = 0,
533         OPAL_P7IOC_DIAG_TYPE_RGC        = 1,
534         OPAL_P7IOC_DIAG_TYPE_BI         = 2,
535         OPAL_P7IOC_DIAG_TYPE_CI         = 3,
536         OPAL_P7IOC_DIAG_TYPE_MISC       = 4,
537         OPAL_P7IOC_DIAG_TYPE_I2C        = 5,
538         OPAL_P7IOC_DIAG_TYPE_LAST       = 6
539 };
540
541 struct OpalIoP7IOCErrorData {
542         __be16 type;
543
544         /* GEM */
545         __be64 gemXfir;
546         __be64 gemRfir;
547         __be64 gemRirqfir;
548         __be64 gemMask;
549         __be64 gemRwof;
550
551         /* LEM */
552         __be64 lemFir;
553         __be64 lemErrMask;
554         __be64 lemAction0;
555         __be64 lemAction1;
556         __be64 lemWof;
557
558         union {
559                 struct OpalIoP7IOCRgcErrorData {
560                         __be64 rgcStatus;       /* 3E1C10 */
561                         __be64 rgcLdcp;         /* 3E1C18 */
562                 }rgc;
563                 struct OpalIoP7IOCBiErrorData {
564                         __be64 biLdcp0;         /* 3C0100, 3C0118 */
565                         __be64 biLdcp1;         /* 3C0108, 3C0120 */
566                         __be64 biLdcp2;         /* 3C0110, 3C0128 */
567                         __be64 biFenceStatus;   /* 3C0130, 3C0130 */
568
569                             u8 biDownbound;     /* BI Downbound or Upbound */
570                 }bi;
571                 struct OpalIoP7IOCCiErrorData {
572                         __be64 ciPortStatus;    /* 3Dn008 */
573                         __be64 ciPortLdcp;      /* 3Dn010 */
574
575                             u8 ciPort;          /* Index of CI port: 0/1 */
576                 }ci;
577         };
578 };
579
580 /**
581  * This structure defines the overlay which will be used to store PHB error
582  * data upon request.
583  */
584 enum {
585         OPAL_PHB_ERROR_DATA_VERSION_1 = 1,
586 };
587
588 enum {
589         OPAL_PHB_ERROR_DATA_TYPE_P7IOC = 1,
590         OPAL_PHB_ERROR_DATA_TYPE_PHB3 = 2
591 };
592
593 enum {
594         OPAL_P7IOC_NUM_PEST_REGS = 128,
595         OPAL_PHB3_NUM_PEST_REGS = 256
596 };
597
598 struct OpalIoPhbErrorCommon {
599         __be32 version;
600         __be32 ioType;
601         __be32 len;
602 };
603
604 struct OpalIoP7IOCPhbErrorData {
605         struct OpalIoPhbErrorCommon common;
606
607         __be32 brdgCtl;
608
609         // P7IOC utl regs
610         __be32 portStatusReg;
611         __be32 rootCmplxStatus;
612         __be32 busAgentStatus;
613
614         // P7IOC cfg regs
615         __be32 deviceStatus;
616         __be32 slotStatus;
617         __be32 linkStatus;
618         __be32 devCmdStatus;
619         __be32 devSecStatus;
620
621         // cfg AER regs
622         __be32 rootErrorStatus;
623         __be32 uncorrErrorStatus;
624         __be32 corrErrorStatus;
625         __be32 tlpHdr1;
626         __be32 tlpHdr2;
627         __be32 tlpHdr3;
628         __be32 tlpHdr4;
629         __be32 sourceId;
630
631         __be32 rsv3;
632
633         // Record data about the call to allocate a buffer.
634         __be64 errorClass;
635         __be64 correlator;
636
637         //P7IOC MMIO Error Regs
638         __be64 p7iocPlssr;                // n120
639         __be64 p7iocCsr;                  // n110
640         __be64 lemFir;                    // nC00
641         __be64 lemErrorMask;              // nC18
642         __be64 lemWOF;                    // nC40
643         __be64 phbErrorStatus;            // nC80
644         __be64 phbFirstErrorStatus;       // nC88
645         __be64 phbErrorLog0;              // nCC0
646         __be64 phbErrorLog1;              // nCC8
647         __be64 mmioErrorStatus;           // nD00
648         __be64 mmioFirstErrorStatus;      // nD08
649         __be64 mmioErrorLog0;             // nD40
650         __be64 mmioErrorLog1;             // nD48
651         __be64 dma0ErrorStatus;           // nD80
652         __be64 dma0FirstErrorStatus;      // nD88
653         __be64 dma0ErrorLog0;             // nDC0
654         __be64 dma0ErrorLog1;             // nDC8
655         __be64 dma1ErrorStatus;           // nE00
656         __be64 dma1FirstErrorStatus;      // nE08
657         __be64 dma1ErrorLog0;             // nE40
658         __be64 dma1ErrorLog1;             // nE48
659         __be64 pestA[OPAL_P7IOC_NUM_PEST_REGS];
660         __be64 pestB[OPAL_P7IOC_NUM_PEST_REGS];
661 };
662
663 struct OpalIoPhb3ErrorData {
664         struct OpalIoPhbErrorCommon common;
665
666         __be32 brdgCtl;
667
668         /* PHB3 UTL regs */
669         __be32 portStatusReg;
670         __be32 rootCmplxStatus;
671         __be32 busAgentStatus;
672
673         /* PHB3 cfg regs */
674         __be32 deviceStatus;
675         __be32 slotStatus;
676         __be32 linkStatus;
677         __be32 devCmdStatus;
678         __be32 devSecStatus;
679
680         /* cfg AER regs */
681         __be32 rootErrorStatus;
682         __be32 uncorrErrorStatus;
683         __be32 corrErrorStatus;
684         __be32 tlpHdr1;
685         __be32 tlpHdr2;
686         __be32 tlpHdr3;
687         __be32 tlpHdr4;
688         __be32 sourceId;
689
690         __be32 rsv3;
691
692         /* Record data about the call to allocate a buffer */
693         __be64 errorClass;
694         __be64 correlator;
695
696         __be64 nFir;                    /* 000 */
697         __be64 nFirMask;                /* 003 */
698         __be64 nFirWOF;         /* 008 */
699
700         /* PHB3 MMIO Error Regs */
701         __be64 phbPlssr;                /* 120 */
702         __be64 phbCsr;          /* 110 */
703         __be64 lemFir;          /* C00 */
704         __be64 lemErrorMask;            /* C18 */
705         __be64 lemWOF;          /* C40 */
706         __be64 phbErrorStatus;  /* C80 */
707         __be64 phbFirstErrorStatus;     /* C88 */
708         __be64 phbErrorLog0;            /* CC0 */
709         __be64 phbErrorLog1;            /* CC8 */
710         __be64 mmioErrorStatus; /* D00 */
711         __be64 mmioFirstErrorStatus;    /* D08 */
712         __be64 mmioErrorLog0;           /* D40 */
713         __be64 mmioErrorLog1;           /* D48 */
714         __be64 dma0ErrorStatus; /* D80 */
715         __be64 dma0FirstErrorStatus;    /* D88 */
716         __be64 dma0ErrorLog0;           /* DC0 */
717         __be64 dma0ErrorLog1;           /* DC8 */
718         __be64 dma1ErrorStatus; /* E00 */
719         __be64 dma1FirstErrorStatus;    /* E08 */
720         __be64 dma1ErrorLog0;           /* E40 */
721         __be64 dma1ErrorLog1;           /* E48 */
722         __be64 pestA[OPAL_PHB3_NUM_PEST_REGS];
723         __be64 pestB[OPAL_PHB3_NUM_PEST_REGS];
724 };
725
726 enum {
727         OPAL_REINIT_CPUS_HILE_BE        = (1 << 0),
728         OPAL_REINIT_CPUS_HILE_LE        = (1 << 1),
729 };
730
731 typedef struct oppanel_line {
732         const char *    line;
733         uint64_t        line_len;
734 } oppanel_line_t;
735
736 /* OPAL I2C request */
737 struct opal_i2c_request {
738         uint8_t type;
739 #define OPAL_I2C_RAW_READ       0
740 #define OPAL_I2C_RAW_WRITE      1
741 #define OPAL_I2C_SM_READ        2
742 #define OPAL_I2C_SM_WRITE       3
743         uint8_t flags;
744 #define OPAL_I2C_ADDR_10        0x01    /* Not supported yet */
745         uint8_t subaddr_sz;             /* Max 4 */
746         uint8_t reserved;
747         __be16 addr;                    /* 7 or 10 bit address */
748         __be16 reserved2;
749         __be32 subaddr;         /* Sub-address if any */
750         __be32 size;                    /* Data size */
751         __be64 buffer_ra;               /* Buffer real address */
752 };
753
754 /* /sys/firmware/opal */
755 extern struct kobject *opal_kobj;
756
757 /* /ibm,opal */
758 extern struct device_node *opal_node;
759
760 /* API functions */
761 int64_t opal_invalid_call(void);
762 int64_t opal_console_write(int64_t term_number, __be64 *length,
763                            const uint8_t *buffer);
764 int64_t opal_console_read(int64_t term_number, __be64 *length,
765                           uint8_t *buffer);
766 int64_t opal_console_write_buffer_space(int64_t term_number,
767                                         __be64 *length);
768 int64_t opal_rtc_read(__be32 *year_month_day,
769                       __be64 *hour_minute_second_millisecond);
770 int64_t opal_rtc_write(uint32_t year_month_day,
771                        uint64_t hour_minute_second_millisecond);
772 int64_t opal_tpo_read(uint64_t token, __be32 *year_mon_day, __be32 *hour_min);
773 int64_t opal_tpo_write(uint64_t token, uint32_t year_mon_day,
774                        uint32_t hour_min);
775 int64_t opal_cec_power_down(uint64_t request);
776 int64_t opal_cec_reboot(void);
777 int64_t opal_read_nvram(uint64_t buffer, uint64_t size, uint64_t offset);
778 int64_t opal_write_nvram(uint64_t buffer, uint64_t size, uint64_t offset);
779 int64_t opal_handle_interrupt(uint64_t isn, __be64 *outstanding_event_mask);
780 int64_t opal_poll_events(__be64 *outstanding_event_mask);
781 int64_t opal_pci_set_hub_tce_memory(uint64_t hub_id, uint64_t tce_mem_addr,
782                                     uint64_t tce_mem_size);
783 int64_t opal_pci_set_phb_tce_memory(uint64_t phb_id, uint64_t tce_mem_addr,
784                                     uint64_t tce_mem_size);
785 int64_t opal_pci_config_read_byte(uint64_t phb_id, uint64_t bus_dev_func,
786                                   uint64_t offset, uint8_t *data);
787 int64_t opal_pci_config_read_half_word(uint64_t phb_id, uint64_t bus_dev_func,
788                                        uint64_t offset, __be16 *data);
789 int64_t opal_pci_config_read_word(uint64_t phb_id, uint64_t bus_dev_func,
790                                   uint64_t offset, __be32 *data);
791 int64_t opal_pci_config_write_byte(uint64_t phb_id, uint64_t bus_dev_func,
792                                    uint64_t offset, uint8_t data);
793 int64_t opal_pci_config_write_half_word(uint64_t phb_id, uint64_t bus_dev_func,
794                                         uint64_t offset, uint16_t data);
795 int64_t opal_pci_config_write_word(uint64_t phb_id, uint64_t bus_dev_func,
796                                    uint64_t offset, uint32_t data);
797 int64_t opal_set_xive(uint32_t isn, uint16_t server, uint8_t priority);
798 int64_t opal_get_xive(uint32_t isn, __be16 *server, uint8_t *priority);
799 int64_t opal_register_exception_handler(uint64_t opal_exception,
800                                         uint64_t handler_address,
801                                         uint64_t glue_cache_line);
802 int64_t opal_pci_eeh_freeze_status(uint64_t phb_id, uint64_t pe_number,
803                                    uint8_t *freeze_state,
804                                    __be16 *pci_error_type,
805                                    __be64 *phb_status);
806 int64_t opal_pci_eeh_freeze_clear(uint64_t phb_id, uint64_t pe_number,
807                                   uint64_t eeh_action_token);
808 int64_t opal_pci_eeh_freeze_set(uint64_t phb_id, uint64_t pe_number,
809                                 uint64_t eeh_action_token);
810 int64_t opal_pci_err_inject(uint64_t phb_id, uint32_t pe_no, uint32_t type,
811                             uint32_t func, uint64_t addr, uint64_t mask);
812 int64_t opal_pci_shpc(uint64_t phb_id, uint64_t shpc_action, uint8_t *state);
813
814
815
816 int64_t opal_pci_phb_mmio_enable(uint64_t phb_id, uint16_t window_type,
817                                  uint16_t window_num, uint16_t enable);
818 int64_t opal_pci_set_phb_mem_window(uint64_t phb_id, uint16_t window_type,
819                                     uint16_t window_num,
820                                     uint64_t starting_real_address,
821                                     uint64_t starting_pci_address,
822                                     uint64_t size);
823 int64_t opal_pci_map_pe_mmio_window(uint64_t phb_id, uint16_t pe_number,
824                                     uint16_t window_type, uint16_t window_num,
825                                     uint16_t segment_num);
826 int64_t opal_pci_set_phb_table_memory(uint64_t phb_id, uint64_t rtt_addr,
827                                       uint64_t ivt_addr, uint64_t ivt_len,
828                                       uint64_t reject_array_addr,
829                                       uint64_t peltv_addr);
830 int64_t opal_pci_set_pe(uint64_t phb_id, uint64_t pe_number, uint64_t bus_dev_func,
831                         uint8_t bus_compare, uint8_t dev_compare, uint8_t func_compare,
832                         uint8_t pe_action);
833 int64_t opal_pci_set_peltv(uint64_t phb_id, uint32_t parent_pe, uint32_t child_pe,
834                            uint8_t state);
835 int64_t opal_pci_set_mve(uint64_t phb_id, uint32_t mve_number, uint32_t pe_number);
836 int64_t opal_pci_set_mve_enable(uint64_t phb_id, uint32_t mve_number,
837                                 uint32_t state);
838 int64_t opal_pci_get_xive_reissue(uint64_t phb_id, uint32_t xive_number,
839                                   uint8_t *p_bit, uint8_t *q_bit);
840 int64_t opal_pci_set_xive_reissue(uint64_t phb_id, uint32_t xive_number,
841                                   uint8_t p_bit, uint8_t q_bit);
842 int64_t opal_pci_msi_eoi(uint64_t phb_id, uint32_t hw_irq);
843 int64_t opal_pci_set_xive_pe(uint64_t phb_id, uint32_t pe_number,
844                              uint32_t xive_num);
845 int64_t opal_get_xive_source(uint64_t phb_id, uint32_t xive_num,
846                              __be32 *interrupt_source_number);
847 int64_t opal_get_msi_32(uint64_t phb_id, uint32_t mve_number, uint32_t xive_num,
848                         uint8_t msi_range, __be32 *msi_address,
849                         __be32 *message_data);
850 int64_t opal_get_msi_64(uint64_t phb_id, uint32_t mve_number,
851                         uint32_t xive_num, uint8_t msi_range,
852                         __be64 *msi_address, __be32 *message_data);
853 int64_t opal_start_cpu(uint64_t thread_number, uint64_t start_address);
854 int64_t opal_query_cpu_status(uint64_t thread_number, uint8_t *thread_status);
855 int64_t opal_write_oppanel(oppanel_line_t *lines, uint64_t num_lines);
856 int64_t opal_pci_map_pe_dma_window(uint64_t phb_id, uint16_t pe_number, uint16_t window_id,
857                                    uint16_t tce_levels, uint64_t tce_table_addr,
858                                    uint64_t tce_table_size, uint64_t tce_page_size);
859 int64_t opal_pci_map_pe_dma_window_real(uint64_t phb_id, uint16_t pe_number,
860                                         uint16_t dma_window_number, uint64_t pci_start_addr,
861                                         uint64_t pci_mem_size);
862 int64_t opal_pci_reset(uint64_t phb_id, uint8_t reset_scope, uint8_t assert_state);
863
864 int64_t opal_pci_get_hub_diag_data(uint64_t hub_id, void *diag_buffer,
865                                    uint64_t diag_buffer_len);
866 int64_t opal_pci_get_phb_diag_data(uint64_t phb_id, void *diag_buffer,
867                                    uint64_t diag_buffer_len);
868 int64_t opal_pci_get_phb_diag_data2(uint64_t phb_id, void *diag_buffer,
869                                     uint64_t diag_buffer_len);
870 int64_t opal_pci_fence_phb(uint64_t phb_id);
871 int64_t opal_pci_reinit(uint64_t phb_id, uint64_t reinit_scope, uint64_t data);
872 int64_t opal_pci_mask_pe_error(uint64_t phb_id, uint16_t pe_number, uint8_t error_type, uint8_t mask_action);
873 int64_t opal_set_slot_led_status(uint64_t phb_id, uint64_t slot_id, uint8_t led_type, uint8_t led_action);
874 int64_t opal_get_epow_status(__be64 *status);
875 int64_t opal_set_system_attention_led(uint8_t led_action);
876 int64_t opal_pci_next_error(uint64_t phb_id, __be64 *first_frozen_pe,
877                             __be16 *pci_error_type, __be16 *severity);
878 int64_t opal_pci_poll(uint64_t phb_id);
879 int64_t opal_return_cpu(void);
880 int64_t opal_check_token(uint64_t token);
881 int64_t opal_reinit_cpus(uint64_t flags);
882
883 int64_t opal_xscom_read(uint32_t gcid, uint64_t pcb_addr, __be64 *val);
884 int64_t opal_xscom_write(uint32_t gcid, uint64_t pcb_addr, uint64_t val);
885
886 int64_t opal_lpc_write(uint32_t chip_id, enum OpalLPCAddressType addr_type,
887                        uint32_t addr, uint32_t data, uint32_t sz);
888 int64_t opal_lpc_read(uint32_t chip_id, enum OpalLPCAddressType addr_type,
889                       uint32_t addr, __be32 *data, uint32_t sz);
890
891 int64_t opal_read_elog(uint64_t buffer, uint64_t size, uint64_t log_id);
892 int64_t opal_get_elog_size(__be64 *log_id, __be64 *size, __be64 *elog_type);
893 int64_t opal_write_elog(uint64_t buffer, uint64_t size, uint64_t offset);
894 int64_t opal_send_ack_elog(uint64_t log_id);
895 void opal_resend_pending_logs(void);
896
897 int64_t opal_validate_flash(uint64_t buffer, uint32_t *size, uint32_t *result);
898 int64_t opal_manage_flash(uint8_t op);
899 int64_t opal_update_flash(uint64_t blk_list);
900 int64_t opal_dump_init(uint8_t dump_type);
901 int64_t opal_dump_info(__be32 *dump_id, __be32 *dump_size);
902 int64_t opal_dump_info2(__be32 *dump_id, __be32 *dump_size, __be32 *dump_type);
903 int64_t opal_dump_read(uint32_t dump_id, uint64_t buffer);
904 int64_t opal_dump_ack(uint32_t dump_id);
905 int64_t opal_dump_resend_notification(void);
906
907 int64_t opal_get_msg(uint64_t buffer, uint64_t size);
908 int64_t opal_check_completion(uint64_t buffer, uint64_t size, uint64_t token);
909 int64_t opal_sync_host_reboot(void);
910 int64_t opal_get_param(uint64_t token, uint32_t param_id, uint64_t buffer,
911                 uint64_t length);
912 int64_t opal_set_param(uint64_t token, uint32_t param_id, uint64_t buffer,
913                 uint64_t length);
914 int64_t opal_sensor_read(uint32_t sensor_hndl, int token, __be32 *sensor_data);
915 int64_t opal_handle_hmi(void);
916 int64_t opal_register_dump_region(uint32_t id, uint64_t start, uint64_t end);
917 int64_t opal_unregister_dump_region(uint32_t id);
918 int64_t opal_slw_set_reg(uint64_t cpu_pir, uint64_t sprn, uint64_t val);
919 int64_t opal_pci_set_phb_cxl_mode(uint64_t phb_id, uint64_t mode, uint64_t pe_number);
920 int64_t opal_ipmi_send(uint64_t interface, struct opal_ipmi_msg *msg,
921                 uint64_t msg_len);
922 int64_t opal_ipmi_recv(uint64_t interface, struct opal_ipmi_msg *msg,
923                 uint64_t *msg_len);
924 int64_t opal_i2c_request(uint64_t async_token, uint32_t bus_id,
925                          struct opal_i2c_request *oreq);
926
927 /* Internal functions */
928 extern int early_init_dt_scan_opal(unsigned long node, const char *uname,
929                                    int depth, void *data);
930 extern int early_init_dt_scan_recoverable_ranges(unsigned long node,
931                                  const char *uname, int depth, void *data);
932
933 extern int opal_get_chars(uint32_t vtermno, char *buf, int count);
934 extern int opal_put_chars(uint32_t vtermno, const char *buf, int total_len);
935
936 extern void hvc_opal_init_early(void);
937
938 extern int opal_notifier_register(struct notifier_block *nb);
939 extern int opal_notifier_unregister(struct notifier_block *nb);
940
941 extern int opal_message_notifier_register(enum OpalMessageType msg_type,
942                                                 struct notifier_block *nb);
943 extern void opal_notifier_enable(void);
944 extern void opal_notifier_disable(void);
945 extern void opal_notifier_update_evt(uint64_t evt_mask, uint64_t evt_val);
946
947 extern int __opal_async_get_token(void);
948 extern int opal_async_get_token_interruptible(void);
949 extern int __opal_async_release_token(int token);
950 extern int opal_async_release_token(int token);
951 extern int opal_async_wait_response(uint64_t token, struct opal_msg *msg);
952 extern int opal_get_sensor_data(u32 sensor_hndl, u32 *sensor_data);
953
954 struct rtc_time;
955 extern unsigned long opal_get_boot_time(void);
956 extern void opal_nvram_init(void);
957 extern void opal_flash_init(void);
958 extern void opal_flash_term_callback(void);
959 extern int opal_elog_init(void);
960 extern void opal_platform_dump_init(void);
961 extern void opal_sys_param_init(void);
962 extern void opal_msglog_init(void);
963
964 extern int opal_machine_check(struct pt_regs *regs);
965 extern bool opal_mce_check_early_recovery(struct pt_regs *regs);
966 extern int opal_hmi_exception_early(struct pt_regs *regs);
967 extern int opal_handle_hmi_exception(struct pt_regs *regs);
968
969 extern void opal_shutdown(void);
970 extern int opal_resync_timebase(void);
971
972 extern void opal_lpc_init(void);
973
974 struct opal_sg_list *opal_vmalloc_to_sg_list(void *vmalloc_addr,
975                                              unsigned long vmalloc_size);
976 void opal_free_sg_list(struct opal_sg_list *sg);
977
978 /*
979  * Dump region ID range usable by the OS
980  */
981 #define OPAL_DUMP_REGION_HOST_START             0x80
982 #define OPAL_DUMP_REGION_LOG_BUF                0x80
983 #define OPAL_DUMP_REGION_HOST_END               0xFF
984
985 #endif /* __ASSEMBLY__ */
986
987 #endif /* __OPAL_H */