projects/linux·blob master · refs

579 lines · 24.1 KiB

1/* SPDX-License-Identifier: GPL-2.0-or-later */
2#ifndef _POWERPC_RTAS_H
3#define _POWERPC_RTAS_H
4#ifdef __KERNEL__
5
6#include <linux/mutex.h>
7#include <linux/spinlock.h>
8#include <asm/page.h>
9#include <asm/rtas-types.h>
10#include <linux/time.h>
11#include <linux/cpumask.h>
12
13/*
14 * Definitions for talking to the RTAS on CHRP machines.
15 *
16 * Copyright (C) 2001 Peter Bergner
17 * Copyright (C) 2001 PPC 64 Team, IBM Corp
18 */
19
20enum rtas_function_index {
21 RTAS_FNIDX__CHECK_EXCEPTION,
22 RTAS_FNIDX__DISPLAY_CHARACTER,
23 RTAS_FNIDX__EVENT_SCAN,
24 RTAS_FNIDX__FREEZE_TIME_BASE,
25 RTAS_FNIDX__GET_POWER_LEVEL,
26 RTAS_FNIDX__GET_SENSOR_STATE,
27 RTAS_FNIDX__GET_TERM_CHAR,
28 RTAS_FNIDX__GET_TIME_OF_DAY,
29 RTAS_FNIDX__IBM_ACTIVATE_FIRMWARE,
30 RTAS_FNIDX__IBM_CBE_START_PTCAL,
31 RTAS_FNIDX__IBM_CBE_STOP_PTCAL,
32 RTAS_FNIDX__IBM_CHANGE_MSI,
33 RTAS_FNIDX__IBM_CLOSE_ERRINJCT,
34 RTAS_FNIDX__IBM_CONFIGURE_BRIDGE,
35 RTAS_FNIDX__IBM_CONFIGURE_CONNECTOR,
36 RTAS_FNIDX__IBM_CONFIGURE_KERNEL_DUMP,
37 RTAS_FNIDX__IBM_CONFIGURE_PE,
38 RTAS_FNIDX__IBM_CREATE_PE_DMA_WINDOW,
39 RTAS_FNIDX__IBM_DISPLAY_MESSAGE,
40 RTAS_FNIDX__IBM_ERRINJCT,
41 RTAS_FNIDX__IBM_EXTI2C,
42 RTAS_FNIDX__IBM_GET_CONFIG_ADDR_INFO,
43 RTAS_FNIDX__IBM_GET_CONFIG_ADDR_INFO2,
44 RTAS_FNIDX__IBM_GET_DYNAMIC_SENSOR_STATE,
45 RTAS_FNIDX__IBM_GET_INDICES,
46 RTAS_FNIDX__IBM_GET_RIO_TOPOLOGY,
47 RTAS_FNIDX__IBM_GET_SYSTEM_PARAMETER,
48 RTAS_FNIDX__IBM_GET_VPD,
49 RTAS_FNIDX__IBM_GET_XIVE,
50 RTAS_FNIDX__IBM_INT_OFF,
51 RTAS_FNIDX__IBM_INT_ON,
52 RTAS_FNIDX__IBM_IO_QUIESCE_ACK,
53 RTAS_FNIDX__IBM_LPAR_PERFTOOLS,
54 RTAS_FNIDX__IBM_MANAGE_FLASH_IMAGE,
55 RTAS_FNIDX__IBM_MANAGE_STORAGE_PRESERVATION,
56 RTAS_FNIDX__IBM_NMI_INTERLOCK,
57 RTAS_FNIDX__IBM_NMI_REGISTER,
58 RTAS_FNIDX__IBM_OPEN_ERRINJCT,
59 RTAS_FNIDX__IBM_OPEN_SRIOV_ALLOW_UNFREEZE,
60 RTAS_FNIDX__IBM_OPEN_SRIOV_MAP_PE_NUMBER,
61 RTAS_FNIDX__IBM_OS_TERM,
62 RTAS_FNIDX__IBM_PARTNER_CONTROL,
63 RTAS_FNIDX__IBM_PHYSICAL_ATTESTATION,
64 RTAS_FNIDX__IBM_PLATFORM_DUMP,
65 RTAS_FNIDX__IBM_POWER_OFF_UPS,
66 RTAS_FNIDX__IBM_QUERY_INTERRUPT_SOURCE_NUMBER,
67 RTAS_FNIDX__IBM_QUERY_PE_DMA_WINDOW,
68 RTAS_FNIDX__IBM_READ_PCI_CONFIG,
69 RTAS_FNIDX__IBM_READ_SLOT_RESET_STATE,
70 RTAS_FNIDX__IBM_READ_SLOT_RESET_STATE2,
71 RTAS_FNIDX__IBM_RECEIVE_HVPIPE_MSG,
72 RTAS_FNIDX__IBM_REMOVE_PE_DMA_WINDOW,
73 RTAS_FNIDX__IBM_RESET_PE_DMA_WINDOW,
74 RTAS_FNIDX__IBM_SCAN_LOG_DUMP,
75 RTAS_FNIDX__IBM_SEND_HVPIPE_MSG,
76 RTAS_FNIDX__IBM_SET_DYNAMIC_INDICATOR,
77 RTAS_FNIDX__IBM_SET_EEH_OPTION,
78 RTAS_FNIDX__IBM_SET_SLOT_RESET,
79 RTAS_FNIDX__IBM_SET_SYSTEM_PARAMETER,
80 RTAS_FNIDX__IBM_SET_XIVE,
81 RTAS_FNIDX__IBM_SLOT_ERROR_DETAIL,
82 RTAS_FNIDX__IBM_SUSPEND_ME,
83 RTAS_FNIDX__IBM_TUNE_DMA_PARMS,
84 RTAS_FNIDX__IBM_UPDATE_FLASH_64_AND_REBOOT,
85 RTAS_FNIDX__IBM_UPDATE_NODES,
86 RTAS_FNIDX__IBM_UPDATE_PROPERTIES,
87 RTAS_FNIDX__IBM_VALIDATE_FLASH_IMAGE,
88 RTAS_FNIDX__IBM_WRITE_PCI_CONFIG,
89 RTAS_FNIDX__NVRAM_FETCH,
90 RTAS_FNIDX__NVRAM_STORE,
91 RTAS_FNIDX__POWER_OFF,
92 RTAS_FNIDX__PUT_TERM_CHAR,
93 RTAS_FNIDX__QUERY_CPU_STOPPED_STATE,
94 RTAS_FNIDX__READ_PCI_CONFIG,
95 RTAS_FNIDX__RTAS_LAST_ERROR,
96 RTAS_FNIDX__SET_INDICATOR,
97 RTAS_FNIDX__SET_POWER_LEVEL,
98 RTAS_FNIDX__SET_TIME_FOR_POWER_ON,
99 RTAS_FNIDX__SET_TIME_OF_DAY,
100 RTAS_FNIDX__START_CPU,
101 RTAS_FNIDX__STOP_SELF,
102 RTAS_FNIDX__SYSTEM_REBOOT,
103 RTAS_FNIDX__THAW_TIME_BASE,
104 RTAS_FNIDX__WRITE_PCI_CONFIG,
105};
106
107/*
108 * Opaque handle for client code to refer to RTAS functions. All valid
109 * function handles are build-time constants prefixed with RTAS_FN_.
110 */
111typedef struct {
112 const enum rtas_function_index index;
113} rtas_fn_handle_t;
114
115
116#define rtas_fn_handle(x_) ((const rtas_fn_handle_t) { .index = x_, })
117
118#define RTAS_FN_CHECK_EXCEPTION rtas_fn_handle(RTAS_FNIDX__CHECK_EXCEPTION)
119#define RTAS_FN_DISPLAY_CHARACTER rtas_fn_handle(RTAS_FNIDX__DISPLAY_CHARACTER)
120#define RTAS_FN_EVENT_SCAN rtas_fn_handle(RTAS_FNIDX__EVENT_SCAN)
121#define RTAS_FN_FREEZE_TIME_BASE rtas_fn_handle(RTAS_FNIDX__FREEZE_TIME_BASE)
122#define RTAS_FN_GET_POWER_LEVEL rtas_fn_handle(RTAS_FNIDX__GET_POWER_LEVEL)
123#define RTAS_FN_GET_SENSOR_STATE rtas_fn_handle(RTAS_FNIDX__GET_SENSOR_STATE)
124#define RTAS_FN_GET_TERM_CHAR rtas_fn_handle(RTAS_FNIDX__GET_TERM_CHAR)
125#define RTAS_FN_GET_TIME_OF_DAY rtas_fn_handle(RTAS_FNIDX__GET_TIME_OF_DAY)
126#define RTAS_FN_IBM_ACTIVATE_FIRMWARE rtas_fn_handle(RTAS_FNIDX__IBM_ACTIVATE_FIRMWARE)
127#define RTAS_FN_IBM_CBE_START_PTCAL rtas_fn_handle(RTAS_FNIDX__IBM_CBE_START_PTCAL)
128#define RTAS_FN_IBM_CBE_STOP_PTCAL rtas_fn_handle(RTAS_FNIDX__IBM_CBE_STOP_PTCAL)
129#define RTAS_FN_IBM_CHANGE_MSI rtas_fn_handle(RTAS_FNIDX__IBM_CHANGE_MSI)
130#define RTAS_FN_IBM_CLOSE_ERRINJCT rtas_fn_handle(RTAS_FNIDX__IBM_CLOSE_ERRINJCT)
131#define RTAS_FN_IBM_CONFIGURE_BRIDGE rtas_fn_handle(RTAS_FNIDX__IBM_CONFIGURE_BRIDGE)
132#define RTAS_FN_IBM_CONFIGURE_CONNECTOR rtas_fn_handle(RTAS_FNIDX__IBM_CONFIGURE_CONNECTOR)
133#define RTAS_FN_IBM_CONFIGURE_KERNEL_DUMP rtas_fn_handle(RTAS_FNIDX__IBM_CONFIGURE_KERNEL_DUMP)
134#define RTAS_FN_IBM_CONFIGURE_PE rtas_fn_handle(RTAS_FNIDX__IBM_CONFIGURE_PE)
135#define RTAS_FN_IBM_CREATE_PE_DMA_WINDOW rtas_fn_handle(RTAS_FNIDX__IBM_CREATE_PE_DMA_WINDOW)
136#define RTAS_FN_IBM_DISPLAY_MESSAGE rtas_fn_handle(RTAS_FNIDX__IBM_DISPLAY_MESSAGE)
137#define RTAS_FN_IBM_ERRINJCT rtas_fn_handle(RTAS_FNIDX__IBM_ERRINJCT)
138#define RTAS_FN_IBM_EXTI2C rtas_fn_handle(RTAS_FNIDX__IBM_EXTI2C)
139#define RTAS_FN_IBM_GET_CONFIG_ADDR_INFO rtas_fn_handle(RTAS_FNIDX__IBM_GET_CONFIG_ADDR_INFO)
140#define RTAS_FN_IBM_GET_CONFIG_ADDR_INFO2 rtas_fn_handle(RTAS_FNIDX__IBM_GET_CONFIG_ADDR_INFO2)
141#define RTAS_FN_IBM_GET_DYNAMIC_SENSOR_STATE rtas_fn_handle(RTAS_FNIDX__IBM_GET_DYNAMIC_SENSOR_STATE)
142#define RTAS_FN_IBM_GET_INDICES rtas_fn_handle(RTAS_FNIDX__IBM_GET_INDICES)
143#define RTAS_FN_IBM_GET_RIO_TOPOLOGY rtas_fn_handle(RTAS_FNIDX__IBM_GET_RIO_TOPOLOGY)
144#define RTAS_FN_IBM_GET_SYSTEM_PARAMETER rtas_fn_handle(RTAS_FNIDX__IBM_GET_SYSTEM_PARAMETER)
145#define RTAS_FN_IBM_GET_VPD rtas_fn_handle(RTAS_FNIDX__IBM_GET_VPD)
146#define RTAS_FN_IBM_GET_XIVE rtas_fn_handle(RTAS_FNIDX__IBM_GET_XIVE)
147#define RTAS_FN_IBM_INT_OFF rtas_fn_handle(RTAS_FNIDX__IBM_INT_OFF)
148#define RTAS_FN_IBM_INT_ON rtas_fn_handle(RTAS_FNIDX__IBM_INT_ON)
149#define RTAS_FN_IBM_IO_QUIESCE_ACK rtas_fn_handle(RTAS_FNIDX__IBM_IO_QUIESCE_ACK)
150#define RTAS_FN_IBM_LPAR_PERFTOOLS rtas_fn_handle(RTAS_FNIDX__IBM_LPAR_PERFTOOLS)
151#define RTAS_FN_IBM_MANAGE_FLASH_IMAGE rtas_fn_handle(RTAS_FNIDX__IBM_MANAGE_FLASH_IMAGE)
152#define RTAS_FN_IBM_MANAGE_STORAGE_PRESERVATION rtas_fn_handle(RTAS_FNIDX__IBM_MANAGE_STORAGE_PRESERVATION)
153#define RTAS_FN_IBM_NMI_INTERLOCK rtas_fn_handle(RTAS_FNIDX__IBM_NMI_INTERLOCK)
154#define RTAS_FN_IBM_NMI_REGISTER rtas_fn_handle(RTAS_FNIDX__IBM_NMI_REGISTER)
155#define RTAS_FN_IBM_OPEN_ERRINJCT rtas_fn_handle(RTAS_FNIDX__IBM_OPEN_ERRINJCT)
156#define RTAS_FN_IBM_OPEN_SRIOV_ALLOW_UNFREEZE rtas_fn_handle(RTAS_FNIDX__IBM_OPEN_SRIOV_ALLOW_UNFREEZE)
157#define RTAS_FN_IBM_OPEN_SRIOV_MAP_PE_NUMBER rtas_fn_handle(RTAS_FNIDX__IBM_OPEN_SRIOV_MAP_PE_NUMBER)
158#define RTAS_FN_IBM_OS_TERM rtas_fn_handle(RTAS_FNIDX__IBM_OS_TERM)
159#define RTAS_FN_IBM_PARTNER_CONTROL rtas_fn_handle(RTAS_FNIDX__IBM_PARTNER_CONTROL)
160#define RTAS_FN_IBM_PHYSICAL_ATTESTATION rtas_fn_handle(RTAS_FNIDX__IBM_PHYSICAL_ATTESTATION)
161#define RTAS_FN_IBM_PLATFORM_DUMP rtas_fn_handle(RTAS_FNIDX__IBM_PLATFORM_DUMP)
162#define RTAS_FN_IBM_POWER_OFF_UPS rtas_fn_handle(RTAS_FNIDX__IBM_POWER_OFF_UPS)
163#define RTAS_FN_IBM_QUERY_INTERRUPT_SOURCE_NUMBER rtas_fn_handle(RTAS_FNIDX__IBM_QUERY_INTERRUPT_SOURCE_NUMBER)
164#define RTAS_FN_IBM_QUERY_PE_DMA_WINDOW rtas_fn_handle(RTAS_FNIDX__IBM_QUERY_PE_DMA_WINDOW)
165#define RTAS_FN_IBM_READ_PCI_CONFIG rtas_fn_handle(RTAS_FNIDX__IBM_READ_PCI_CONFIG)
166#define RTAS_FN_IBM_READ_SLOT_RESET_STATE rtas_fn_handle(RTAS_FNIDX__IBM_READ_SLOT_RESET_STATE)
167#define RTAS_FN_IBM_READ_SLOT_RESET_STATE2 rtas_fn_handle(RTAS_FNIDX__IBM_READ_SLOT_RESET_STATE2)
168#define RTAS_FN_IBM_RECEIVE_HVPIPE_MSG rtas_fn_handle(RTAS_FNIDX__IBM_RECEIVE_HVPIPE_MSG)
169#define RTAS_FN_IBM_REMOVE_PE_DMA_WINDOW rtas_fn_handle(RTAS_FNIDX__IBM_REMOVE_PE_DMA_WINDOW)
170#define RTAS_FN_IBM_RESET_PE_DMA_WINDOW rtas_fn_handle(RTAS_FNIDX__IBM_RESET_PE_DMA_WINDOW)
171#define RTAS_FN_IBM_SCAN_LOG_DUMP rtas_fn_handle(RTAS_FNIDX__IBM_SCAN_LOG_DUMP)
172#define RTAS_FN_IBM_SEND_HVPIPE_MSG rtas_fn_handle(RTAS_FNIDX__IBM_SEND_HVPIPE_MSG)
173#define RTAS_FN_IBM_SET_DYNAMIC_INDICATOR rtas_fn_handle(RTAS_FNIDX__IBM_SET_DYNAMIC_INDICATOR)
174#define RTAS_FN_IBM_SET_EEH_OPTION rtas_fn_handle(RTAS_FNIDX__IBM_SET_EEH_OPTION)
175#define RTAS_FN_IBM_SET_SLOT_RESET rtas_fn_handle(RTAS_FNIDX__IBM_SET_SLOT_RESET)
176#define RTAS_FN_IBM_SET_SYSTEM_PARAMETER rtas_fn_handle(RTAS_FNIDX__IBM_SET_SYSTEM_PARAMETER)
177#define RTAS_FN_IBM_SET_XIVE rtas_fn_handle(RTAS_FNIDX__IBM_SET_XIVE)
178#define RTAS_FN_IBM_SLOT_ERROR_DETAIL rtas_fn_handle(RTAS_FNIDX__IBM_SLOT_ERROR_DETAIL)
179#define RTAS_FN_IBM_SUSPEND_ME rtas_fn_handle(RTAS_FNIDX__IBM_SUSPEND_ME)
180#define RTAS_FN_IBM_TUNE_DMA_PARMS rtas_fn_handle(RTAS_FNIDX__IBM_TUNE_DMA_PARMS)
181#define RTAS_FN_IBM_UPDATE_FLASH_64_AND_REBOOT rtas_fn_handle(RTAS_FNIDX__IBM_UPDATE_FLASH_64_AND_REBOOT)
182#define RTAS_FN_IBM_UPDATE_NODES rtas_fn_handle(RTAS_FNIDX__IBM_UPDATE_NODES)
183#define RTAS_FN_IBM_UPDATE_PROPERTIES rtas_fn_handle(RTAS_FNIDX__IBM_UPDATE_PROPERTIES)
184#define RTAS_FN_IBM_VALIDATE_FLASH_IMAGE rtas_fn_handle(RTAS_FNIDX__IBM_VALIDATE_FLASH_IMAGE)
185#define RTAS_FN_IBM_WRITE_PCI_CONFIG rtas_fn_handle(RTAS_FNIDX__IBM_WRITE_PCI_CONFIG)
186#define RTAS_FN_NVRAM_FETCH rtas_fn_handle(RTAS_FNIDX__NVRAM_FETCH)
187#define RTAS_FN_NVRAM_STORE rtas_fn_handle(RTAS_FNIDX__NVRAM_STORE)
188#define RTAS_FN_POWER_OFF rtas_fn_handle(RTAS_FNIDX__POWER_OFF)
189#define RTAS_FN_PUT_TERM_CHAR rtas_fn_handle(RTAS_FNIDX__PUT_TERM_CHAR)
190#define RTAS_FN_QUERY_CPU_STOPPED_STATE rtas_fn_handle(RTAS_FNIDX__QUERY_CPU_STOPPED_STATE)
191#define RTAS_FN_READ_PCI_CONFIG rtas_fn_handle(RTAS_FNIDX__READ_PCI_CONFIG)
192#define RTAS_FN_RTAS_LAST_ERROR rtas_fn_handle(RTAS_FNIDX__RTAS_LAST_ERROR)
193#define RTAS_FN_SET_INDICATOR rtas_fn_handle(RTAS_FNIDX__SET_INDICATOR)
194#define RTAS_FN_SET_POWER_LEVEL rtas_fn_handle(RTAS_FNIDX__SET_POWER_LEVEL)
195#define RTAS_FN_SET_TIME_FOR_POWER_ON rtas_fn_handle(RTAS_FNIDX__SET_TIME_FOR_POWER_ON)
196#define RTAS_FN_SET_TIME_OF_DAY rtas_fn_handle(RTAS_FNIDX__SET_TIME_OF_DAY)
197#define RTAS_FN_START_CPU rtas_fn_handle(RTAS_FNIDX__START_CPU)
198#define RTAS_FN_STOP_SELF rtas_fn_handle(RTAS_FNIDX__STOP_SELF)
199#define RTAS_FN_SYSTEM_REBOOT rtas_fn_handle(RTAS_FNIDX__SYSTEM_REBOOT)
200#define RTAS_FN_THAW_TIME_BASE rtas_fn_handle(RTAS_FNIDX__THAW_TIME_BASE)
201#define RTAS_FN_WRITE_PCI_CONFIG rtas_fn_handle(RTAS_FNIDX__WRITE_PCI_CONFIG)
202
203#define RTAS_UNKNOWN_SERVICE (-1)
204#define RTAS_INSTANTIATE_MAX (1ULL<<30) /* Don't instantiate rtas at/above this value */
205
206/* Memory set aside for sys_rtas to use with calls that need a work area. */
207#define RTAS_USER_REGION_SIZE (64 * 1024)
208
209/*
210 * Common RTAS function return values, derived from the table "RTAS
211 * Status Word Values" in PAPR+ v2.13 7.2.8: "Return Codes". If a
212 * function can return a value in this table then generally it has the
213 * meaning listed here. More extended commentary in the documentation
214 * for rtas_call().
215 *
216 * RTAS functions may use negative and positive numbers not in this
217 * set for function-specific error and success conditions,
218 * respectively.
219 */
220#define RTAS_SUCCESS 0 /* Success. */
221#define RTAS_HARDWARE_ERROR -1 /* Hardware or other unspecified error. */
222#define RTAS_BUSY -2 /* Retry immediately. */
223#define RTAS_INVALID_PARAMETER -3 /* Invalid indicator/domain/sensor etc. */
224#define RTAS_FUNC_NOT_SUPPORTED -5 /* Function not supported */
225#define RTAS_UNEXPECTED_STATE_CHANGE -7 /* Seems limited to EEH and slot reset. */
226#define RTAS_EXTENDED_DELAY_MIN 9900 /* Retry after delaying for ~1ms. */
227#define RTAS_EXTENDED_DELAY_MAX 9905 /* Retry after delaying for ~100s. */
228#define RTAS_ML_ISOLATION_ERROR -9000 /* Multi-level isolation error. */
229
230/* statuses specific to ibm,suspend-me */
231#define RTAS_SUSPEND_ABORTED 9000 /* Suspension aborted */
232#define RTAS_NOT_SUSPENDABLE -9004 /* Partition not suspendable */
233#define RTAS_THREADS_ACTIVE -9005 /* Multiple processor threads active */
234#define RTAS_OUTSTANDING_COPROC -9006 /* Outstanding coprocessor operations */
235
236/* RTAS event classes */
237#define RTAS_INTERNAL_ERROR 0x80000000 /* set bit 0 */
238#define RTAS_EPOW_WARNING 0x40000000 /* set bit 1 */
239#define RTAS_HOTPLUG_EVENTS 0x10000000 /* set bit 3 */
240#define RTAS_IO_EVENTS 0x08000000 /* set bit 4 */
241#define RTAS_HVPIPE_MSG_EVENTS 0x04000000 /* set bit 5 */
242#define RTAS_EVENT_SCAN_ALL_EVENTS 0xffffffff
243
244/* RTAS event severity */
245#define RTAS_SEVERITY_FATAL 0x5
246#define RTAS_SEVERITY_ERROR 0x4
247#define RTAS_SEVERITY_ERROR_SYNC 0x3
248#define RTAS_SEVERITY_WARNING 0x2
249#define RTAS_SEVERITY_EVENT 0x1
250#define RTAS_SEVERITY_NO_ERROR 0x0
251
252/* RTAS event disposition */
253#define RTAS_DISP_FULLY_RECOVERED 0x0
254#define RTAS_DISP_LIMITED_RECOVERY 0x1
255#define RTAS_DISP_NOT_RECOVERED 0x2
256
257/* RTAS event initiator */
258#define RTAS_INITIATOR_UNKNOWN 0x0
259#define RTAS_INITIATOR_CPU 0x1
260#define RTAS_INITIATOR_PCI 0x2
261#define RTAS_INITIATOR_ISA 0x3
262#define RTAS_INITIATOR_MEMORY 0x4
263#define RTAS_INITIATOR_POWERMGM 0x5
264
265/* RTAS event target */
266#define RTAS_TARGET_UNKNOWN 0x0
267#define RTAS_TARGET_CPU 0x1
268#define RTAS_TARGET_PCI 0x2
269#define RTAS_TARGET_ISA 0x3
270#define RTAS_TARGET_MEMORY 0x4
271#define RTAS_TARGET_POWERMGM 0x5
272
273/* RTAS event type */
274#define RTAS_TYPE_RETRY 0x01
275#define RTAS_TYPE_TCE_ERR 0x02
276#define RTAS_TYPE_INTERN_DEV_FAIL 0x03
277#define RTAS_TYPE_TIMEOUT 0x04
278#define RTAS_TYPE_DATA_PARITY 0x05
279#define RTAS_TYPE_ADDR_PARITY 0x06
280#define RTAS_TYPE_CACHE_PARITY 0x07
281#define RTAS_TYPE_ADDR_INVALID 0x08
282#define RTAS_TYPE_ECC_UNCORR 0x09
283#define RTAS_TYPE_ECC_CORR 0x0a
284#define RTAS_TYPE_EPOW 0x40
285#define RTAS_TYPE_PLATFORM 0xE0
286#define RTAS_TYPE_IO 0xE1
287#define RTAS_TYPE_INFO 0xE2
288#define RTAS_TYPE_DEALLOC 0xE3
289#define RTAS_TYPE_DUMP 0xE4
290#define RTAS_TYPE_HOTPLUG 0xE5
291#define RTAS_TYPE_HVPIPE 0xE6
292/* I don't add PowerMGM events right now, this is a different topic */
293#define RTAS_TYPE_PMGM_POWER_SW_ON 0x60
294#define RTAS_TYPE_PMGM_POWER_SW_OFF 0x61
295#define RTAS_TYPE_PMGM_LID_OPEN 0x62
296#define RTAS_TYPE_PMGM_LID_CLOSE 0x63
297#define RTAS_TYPE_PMGM_SLEEP_BTN 0x64
298#define RTAS_TYPE_PMGM_WAKE_BTN 0x65
299#define RTAS_TYPE_PMGM_BATTERY_WARN 0x66
300#define RTAS_TYPE_PMGM_BATTERY_CRIT 0x67
301#define RTAS_TYPE_PMGM_SWITCH_TO_BAT 0x68
302#define RTAS_TYPE_PMGM_SWITCH_TO_AC 0x69
303#define RTAS_TYPE_PMGM_KBD_OR_MOUSE 0x6a
304#define RTAS_TYPE_PMGM_ENCLOS_OPEN 0x6b
305#define RTAS_TYPE_PMGM_ENCLOS_CLOSED 0x6c
306#define RTAS_TYPE_PMGM_RING_INDICATE 0x6d
307#define RTAS_TYPE_PMGM_LAN_ATTENTION 0x6e
308#define RTAS_TYPE_PMGM_TIME_ALARM 0x6f
309#define RTAS_TYPE_PMGM_CONFIG_CHANGE 0x70
310#define RTAS_TYPE_PMGM_SERVICE_PROC 0x71
311/* Platform Resource Reassignment Notification */
312#define RTAS_TYPE_PRRN 0xA0
313
314/* RTAS check-exception vector offset */
315#define RTAS_VECTOR_EXTERNAL_INTERRUPT 0x500
316
317static inline uint8_t rtas_error_severity(const struct rtas_error_log *elog)
318{
319 return (elog->byte1 & 0xE0) >> 5;
320}
321
322static inline uint8_t rtas_error_disposition(const struct rtas_error_log *elog)
323{
324 return (elog->byte1 & 0x18) >> 3;
325}
326
327static inline
328void rtas_set_disposition_recovered(struct rtas_error_log *elog)
329{
330 elog->byte1 &= ~0x18;
331 elog->byte1 |= (RTAS_DISP_FULLY_RECOVERED << 3);
332}
333
334static inline uint8_t rtas_error_extended(const struct rtas_error_log *elog)
335{
336 return (elog->byte1 & 0x04) >> 2;
337}
338
339static inline uint8_t rtas_error_initiator(const struct rtas_error_log *elog)
340{
341 return (elog->byte2 & 0xf0) >> 4;
342}
343
344#define rtas_error_type(x) ((x)->byte3)
345
346static inline
347uint32_t rtas_error_extended_log_length(const struct rtas_error_log *elog)
348{
349 return be32_to_cpu(elog->extended_log_length);
350}
351
352#define RTAS_V6EXT_LOG_FORMAT_EVENT_LOG 14
353
354#define RTAS_V6EXT_COMPANY_ID_IBM (('I' << 24) | ('B' << 16) | ('M' << 8))
355
356static
357inline uint8_t rtas_ext_event_log_format(struct rtas_ext_event_log_v6 *ext_log)
358{
359 return ext_log->byte2 & 0x0F;
360}
361
362static
363inline uint32_t rtas_ext_event_company_id(struct rtas_ext_event_log_v6 *ext_log)
364{
365 return be32_to_cpu(ext_log->company_id);
366}
367
368/* pSeries event log format */
369
370/* Two bytes ASCII section IDs */
371#define PSERIES_ELOG_SECT_ID_PRIV_HDR (('P' << 8) | 'H')
372#define PSERIES_ELOG_SECT_ID_USER_HDR (('U' << 8) | 'H')
373#define PSERIES_ELOG_SECT_ID_PRIMARY_SRC (('P' << 8) | 'S')
374#define PSERIES_ELOG_SECT_ID_EXTENDED_UH (('E' << 8) | 'H')
375#define PSERIES_ELOG_SECT_ID_FAILING_MTMS (('M' << 8) | 'T')
376#define PSERIES_ELOG_SECT_ID_SECONDARY_SRC (('S' << 8) | 'S')
377#define PSERIES_ELOG_SECT_ID_DUMP_LOCATOR (('D' << 8) | 'H')
378#define PSERIES_ELOG_SECT_ID_FW_ERROR (('S' << 8) | 'W')
379#define PSERIES_ELOG_SECT_ID_IMPACT_PART_ID (('L' << 8) | 'P')
380#define PSERIES_ELOG_SECT_ID_LOGIC_RESOURCE_ID (('L' << 8) | 'R')
381#define PSERIES_ELOG_SECT_ID_HMC_ID (('H' << 8) | 'M')
382#define PSERIES_ELOG_SECT_ID_EPOW (('E' << 8) | 'P')
383#define PSERIES_ELOG_SECT_ID_IO_EVENT (('I' << 8) | 'E')
384#define PSERIES_ELOG_SECT_ID_HVPIPE_EVENT (('P' << 8) | 'E')
385#define PSERIES_ELOG_SECT_ID_MANUFACT_INFO (('M' << 8) | 'I')
386#define PSERIES_ELOG_SECT_ID_CALL_HOME (('C' << 8) | 'H')
387#define PSERIES_ELOG_SECT_ID_USER_DEF (('U' << 8) | 'D')
388#define PSERIES_ELOG_SECT_ID_HOTPLUG (('H' << 8) | 'P')
389#define PSERIES_ELOG_SECT_ID_MCE (('M' << 8) | 'C')
390
391static
392inline uint16_t pseries_errorlog_id(struct pseries_errorlog *sect)
393{
394 return be16_to_cpu(sect->id);
395}
396
397static
398inline uint16_t pseries_errorlog_length(struct pseries_errorlog *sect)
399{
400 return be16_to_cpu(sect->length);
401}
402
403#define PSERIES_HP_ELOG_RESOURCE_CPU 1
404#define PSERIES_HP_ELOG_RESOURCE_MEM 2
405#define PSERIES_HP_ELOG_RESOURCE_SLOT 3
406#define PSERIES_HP_ELOG_RESOURCE_PHB 4
407#define PSERIES_HP_ELOG_RESOURCE_PMEM 6
408#define PSERIES_HP_ELOG_RESOURCE_DT 7
409
410#define PSERIES_HP_ELOG_ACTION_ADD 1
411#define PSERIES_HP_ELOG_ACTION_REMOVE 2
412
413#define PSERIES_HP_ELOG_ID_DRC_NAME 1
414#define PSERIES_HP_ELOG_ID_DRC_INDEX 2
415#define PSERIES_HP_ELOG_ID_DRC_COUNT 3
416#define PSERIES_HP_ELOG_ID_DRC_IC 4
417
418struct pseries_errorlog *get_pseries_errorlog(struct rtas_error_log *log,
419 uint16_t section_id);
420
421/*
422 * This can be set by the rtas_flash module so that it can get called
423 * as the absolutely last thing before the kernel terminates.
424 */
425extern void (*rtas_flash_term_hook)(int);
426
427extern struct rtas_t rtas;
428
429s32 rtas_function_token(const rtas_fn_handle_t handle);
430static inline bool rtas_function_implemented(const rtas_fn_handle_t handle)
431{
432 return rtas_function_token(handle) != RTAS_UNKNOWN_SERVICE;
433}
434int rtas_token(const char *service);
435int rtas_call(int token, int nargs, int nret, int *outputs, ...);
436void rtas_call_unlocked(struct rtas_args *args, int token, int nargs,
437 int nret, ...);
438void __noreturn rtas_restart(char *cmd);
439void rtas_power_off(void);
440void __noreturn rtas_halt(void);
441void rtas_os_term(char *str);
442void rtas_activate_firmware(void);
443int rtas_get_sensor(int sensor, int index, int *state);
444int rtas_get_sensor_fast(int sensor, int index, int *state);
445int rtas_get_power_level(int powerdomain, int *level);
446int rtas_set_power_level(int powerdomain, int level, int *setlevel);
447bool rtas_indicator_present(int token, int *maxindex);
448int rtas_set_indicator(int indicator, int index, int new_value);
449int rtas_set_indicator_fast(int indicator, int index, int new_value);
450void rtas_progress(char *s, unsigned short hex);
451int rtas_ibm_suspend_me(int *fw_status);
452int rtas_error_rc(int rtas_rc);
453
454struct rtc_time;
455time64_t rtas_get_boot_time(void);
456void rtas_get_rtc_time(struct rtc_time *rtc_time);
457int rtas_set_rtc_time(struct rtc_time *rtc_time);
458
459unsigned int rtas_busy_delay_time(int status);
460bool rtas_busy_delay(int status);
461
462int early_init_dt_scan_rtas(unsigned long node, const char *uname, int depth, void *data);
463
464void pSeries_log_error(char *buf, unsigned int err_type, int fatal);
465
466#ifdef CONFIG_PPC_PSERIES
467extern time64_t last_rtas_event;
468int clobbering_unread_rtas_event(void);
469int rtas_syscall_dispatch_ibm_suspend_me(u64 handle);
470#else
471static inline int clobbering_unread_rtas_event(void) { return 0; }
472static inline int rtas_syscall_dispatch_ibm_suspend_me(u64 handle)
473{
474 return -EINVAL;
475}
476#endif
477
478#ifdef CONFIG_PPC_RTAS_DAEMON
479void rtas_cancel_event_scan(void);
480#else
481static inline void rtas_cancel_event_scan(void) { }
482#endif
483
484/* Error types logged. */
485#define ERR_FLAG_ALREADY_LOGGED 0x0
486#define ERR_FLAG_BOOT 0x1 /* log was pulled from NVRAM on boot */
487#define ERR_TYPE_RTAS_LOG 0x2 /* from rtas event-scan */
488#define ERR_TYPE_KERNEL_PANIC 0x4 /* from die()/panic() */
489#define ERR_TYPE_KERNEL_PANIC_GZ 0x8 /* ditto, compressed */
490
491/* All the types and not flags */
492#define ERR_TYPE_MASK \
493 (ERR_TYPE_RTAS_LOG | ERR_TYPE_KERNEL_PANIC | ERR_TYPE_KERNEL_PANIC_GZ)
494
495#define RTAS_DEBUG KERN_DEBUG "RTAS: "
496
497#define RTAS_ERROR_LOG_MAX 2048
498
499/*
500 * Return the firmware-specified size of the error log buffer
501 * for all rtas calls that require an error buffer argument.
502 * This includes 'check-exception' and 'rtas-last-error'.
503 */
504int rtas_get_error_log_max(void);
505
506/* Event Scan Parameters */
507#define EVENT_SCAN_ALL_EVENTS 0xf0000000
508#define SURVEILLANCE_TOKEN 9000
509#define LOG_NUMBER 64 /* must be a power of two */
510#define LOG_NUMBER_MASK (LOG_NUMBER-1)
511
512/* Some RTAS ops require a data buffer and that buffer must be < 4G.
513 * Rather than having a memory allocator, just use this buffer
514 * (get the lock first), make the RTAS call. Copy the data instead
515 * of holding the buffer for long.
516 */
517
518#define RTAS_DATA_BUF_SIZE 4096
519extern spinlock_t rtas_data_buf_lock;
520extern char rtas_data_buf[RTAS_DATA_BUF_SIZE];
521
522/* RMO buffer reserved for user-space RTAS use */
523extern unsigned long rtas_rmo_buf;
524
525extern struct mutex rtas_ibm_get_vpd_lock;
526extern struct mutex rtas_ibm_get_indices_lock;
527extern struct mutex rtas_ibm_set_dynamic_indicator_lock;
528extern struct mutex rtas_ibm_get_dynamic_sensor_state_lock;
529extern struct mutex rtas_ibm_physical_attestation_lock;
530extern struct mutex rtas_ibm_send_hvpipe_msg_lock;
531
532#define GLOBAL_INTERRUPT_QUEUE 9005
533
534/**
535 * rtas_config_addr - Format a busno, devfn and reg for RTAS.
536 * @busno: The bus number.
537 * @devfn: The device and function number as encoded by PCI_DEVFN().
538 * @reg: The register number.
539 *
540 * This function encodes the given busno, devfn and register number as
541 * required for RTAS calls that take a "config_addr" parameter.
542 * See PAPR requirement 7.3.4-1 for more info.
543 */
544static inline u32 rtas_config_addr(int busno, int devfn, int reg)
545{
546 return ((reg & 0xf00) << 20) | ((busno & 0xff) << 16) |
547 (devfn << 8) | (reg & 0xff);
548}
549
550void rtas_give_timebase(void);
551void rtas_take_timebase(void);
552
553#ifdef CONFIG_PPC_RTAS
554static inline int page_is_rtas_user_buf(unsigned long pfn)
555{
556 unsigned long paddr = (pfn << PAGE_SHIFT);
557 if (paddr >= rtas_rmo_buf && paddr < (rtas_rmo_buf + RTAS_USER_REGION_SIZE))
558 return 1;
559 return 0;
560}
561
562/* Not the best place to put pSeries_coalesce_init, will be fixed when we
563 * move some of the rtas suspend-me stuff to pseries */
564void pSeries_coalesce_init(void);
565void rtas_initialize(void);
566#else
567static inline int page_is_rtas_user_buf(unsigned long pfn) { return 0;}
568static inline void pSeries_coalesce_init(void) { }
569static inline void rtas_initialize(void) { }
570#endif
571
572#ifdef CONFIG_HV_PERF_CTRS
573void read_24x7_sys_info(void);
574#else
575static inline void read_24x7_sys_info(void) { }
576#endif
577
578#endif /* __KERNEL__ */
579#endif /* _POWERPC_RTAS_H */