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