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