1 #ifndef _POWERPC_RTAS_H
2 #define _POWERPC_RTAS_H
5 #include <linux/spinlock.h>
7 #include <linux/time.h>
10 * Definitions for talking to the RTAS on CHRP machines.
12 * Copyright (C) 2001 Peter Bergner
13 * Copyright (C) 2001 PPC 64 Team, IBM Corp
15 * This program is free software; you can redistribute it and/or
16 * modify it under the terms of the GNU General Public License
17 * as published by the Free Software Foundation; either version
18 * 2 of the License, or (at your option) any later version.
21 #define RTAS_UNKNOWN_SERVICE (-1)
22 #define RTAS_INSTANTIATE_MAX (1ULL<<30) /* Don't instantiate rtas at/above this value */
24 /* Buffer size for ppc_rtas system call. */
25 #define RTAS_RMOBUF_MAX (64 * 1024)
27 /* RTAS return status codes */
28 #define RTAS_NOT_SUSPENDABLE -9004
29 #define RTAS_BUSY -2 /* RTAS Busy */
30 #define RTAS_EXTENDED_DELAY_MIN 9900
31 #define RTAS_EXTENDED_DELAY_MAX 9905
34 * In general to call RTAS use rtas_token("string") to lookup
35 * an RTAS token for the given string (e.g. "event-scan").
36 * To actually perform the call use
37 * ret = rtas_call(token, n_in, n_out, ...)
38 * Where n_in is the number of input parameters and
39 * n_out is the number of output parameters
41 * If the "string" is invalid on this system, RTAS_UNKNOWN_SERVICE
42 * will be returned as a token. rtas_call() does look for this
43 * token and error out gracefully so rtas_call(rtas_token("str"), ...)
44 * may be safely used for one-shot calls to RTAS.
48 typedef __be32 rtas_arg_t;
55 rtas_arg_t *rets; /* Pointer to return values in args[]. */
59 unsigned long entry; /* physical address pointer */
60 unsigned long base; /* physical address pointer */
63 struct rtas_args args;
64 struct device_node *dev; /* virtual address pointer */
67 struct rtas_suspend_me_data {
68 atomic_t working; /* number of cpus accessing this struct */
70 int token; /* ibm,suspend-me */
72 struct completion *complete; /* wait on this until working == 0 */
75 /* RTAS event classes */
76 #define RTAS_INTERNAL_ERROR 0x80000000 /* set bit 0 */
77 #define RTAS_EPOW_WARNING 0x40000000 /* set bit 1 */
78 #define RTAS_HOTPLUG_EVENTS 0x10000000 /* set bit 3 */
79 #define RTAS_IO_EVENTS 0x08000000 /* set bit 4 */
80 #define RTAS_EVENT_SCAN_ALL_EVENTS 0xffffffff
82 /* RTAS event severity */
83 #define RTAS_SEVERITY_FATAL 0x5
84 #define RTAS_SEVERITY_ERROR 0x4
85 #define RTAS_SEVERITY_ERROR_SYNC 0x3
86 #define RTAS_SEVERITY_WARNING 0x2
87 #define RTAS_SEVERITY_EVENT 0x1
88 #define RTAS_SEVERITY_NO_ERROR 0x0
90 /* RTAS event disposition */
91 #define RTAS_DISP_FULLY_RECOVERED 0x0
92 #define RTAS_DISP_LIMITED_RECOVERY 0x1
93 #define RTAS_DISP_NOT_RECOVERED 0x2
95 /* RTAS event initiator */
96 #define RTAS_INITIATOR_UNKNOWN 0x0
97 #define RTAS_INITIATOR_CPU 0x1
98 #define RTAS_INITIATOR_PCI 0x2
99 #define RTAS_INITIATOR_ISA 0x3
100 #define RTAS_INITIATOR_MEMORY 0x4
101 #define RTAS_INITIATOR_POWERMGM 0x5
103 /* RTAS event target */
104 #define RTAS_TARGET_UNKNOWN 0x0
105 #define RTAS_TARGET_CPU 0x1
106 #define RTAS_TARGET_PCI 0x2
107 #define RTAS_TARGET_ISA 0x3
108 #define RTAS_TARGET_MEMORY 0x4
109 #define RTAS_TARGET_POWERMGM 0x5
111 /* RTAS event type */
112 #define RTAS_TYPE_RETRY 0x01
113 #define RTAS_TYPE_TCE_ERR 0x02
114 #define RTAS_TYPE_INTERN_DEV_FAIL 0x03
115 #define RTAS_TYPE_TIMEOUT 0x04
116 #define RTAS_TYPE_DATA_PARITY 0x05
117 #define RTAS_TYPE_ADDR_PARITY 0x06
118 #define RTAS_TYPE_CACHE_PARITY 0x07
119 #define RTAS_TYPE_ADDR_INVALID 0x08
120 #define RTAS_TYPE_ECC_UNCORR 0x09
121 #define RTAS_TYPE_ECC_CORR 0x0a
122 #define RTAS_TYPE_EPOW 0x40
123 #define RTAS_TYPE_PLATFORM 0xE0
124 #define RTAS_TYPE_IO 0xE1
125 #define RTAS_TYPE_INFO 0xE2
126 #define RTAS_TYPE_DEALLOC 0xE3
127 #define RTAS_TYPE_DUMP 0xE4
128 #define RTAS_TYPE_HOTPLUG 0xE5
129 /* I don't add PowerMGM events right now, this is a different topic */
130 #define RTAS_TYPE_PMGM_POWER_SW_ON 0x60
131 #define RTAS_TYPE_PMGM_POWER_SW_OFF 0x61
132 #define RTAS_TYPE_PMGM_LID_OPEN 0x62
133 #define RTAS_TYPE_PMGM_LID_CLOSE 0x63
134 #define RTAS_TYPE_PMGM_SLEEP_BTN 0x64
135 #define RTAS_TYPE_PMGM_WAKE_BTN 0x65
136 #define RTAS_TYPE_PMGM_BATTERY_WARN 0x66
137 #define RTAS_TYPE_PMGM_BATTERY_CRIT 0x67
138 #define RTAS_TYPE_PMGM_SWITCH_TO_BAT 0x68
139 #define RTAS_TYPE_PMGM_SWITCH_TO_AC 0x69
140 #define RTAS_TYPE_PMGM_KBD_OR_MOUSE 0x6a
141 #define RTAS_TYPE_PMGM_ENCLOS_OPEN 0x6b
142 #define RTAS_TYPE_PMGM_ENCLOS_CLOSED 0x6c
143 #define RTAS_TYPE_PMGM_RING_INDICATE 0x6d
144 #define RTAS_TYPE_PMGM_LAN_ATTENTION 0x6e
145 #define RTAS_TYPE_PMGM_TIME_ALARM 0x6f
146 #define RTAS_TYPE_PMGM_CONFIG_CHANGE 0x70
147 #define RTAS_TYPE_PMGM_SERVICE_PROC 0x71
148 /* Platform Resource Reassignment Notification */
149 #define RTAS_TYPE_PRRN 0xA0
151 /* RTAS check-exception vector offset */
152 #define RTAS_VECTOR_EXTERNAL_INTERRUPT 0x500
154 struct rtas_error_log {
156 uint8_t byte0; /* Architectural version */
161 * XXX 3: Severity level of error
162 * XX 2: Degree of recovery
163 * X 1: Extended log present?
170 * XXXX 4: Initiator of event
171 * XXXX 4: Target of failed operation
173 uint8_t byte3; /* General event or error*/
174 __be32 extended_log_length; /* length in bytes */
175 unsigned char buffer[1]; /* Start of extended log */
176 /* Variable length. */
179 static inline uint8_t rtas_error_severity(const struct rtas_error_log *elog)
181 return (elog->byte1 & 0xE0) >> 5;
184 static inline uint8_t rtas_error_disposition(const struct rtas_error_log *elog)
186 return (elog->byte1 & 0x18) >> 3;
190 void rtas_set_disposition_recovered(struct rtas_error_log *elog)
192 elog->byte1 &= ~0x18;
193 elog->byte1 |= (RTAS_DISP_FULLY_RECOVERED << 3);
196 static inline uint8_t rtas_error_extended(const struct rtas_error_log *elog)
198 return (elog->byte1 & 0x04) >> 2;
201 static inline uint8_t rtas_error_initiator(const struct rtas_error_log *elog)
203 return (elog->byte2 & 0xf0) >> 4;
206 #define rtas_error_type(x) ((x)->byte3)
209 uint32_t rtas_error_extended_log_length(const struct rtas_error_log *elog)
211 return be32_to_cpu(elog->extended_log_length);
214 #define RTAS_V6EXT_LOG_FORMAT_EVENT_LOG 14
216 #define RTAS_V6EXT_COMPANY_ID_IBM (('I' << 24) | ('B' << 16) | ('M' << 8))
218 /* RTAS general extended event log, Version 6. The extended log starts
219 * from "buffer" field of struct rtas_error_log defined above.
221 struct rtas_ext_event_log_v6 {
226 * X 1: Unrecoverable error
227 * X 1: Recoverable (correctable or successfully retried)
228 * X 1: Bypassed unrecoverable error (degraded operation)
229 * X 1: Predictive error
230 * X 1: "New" log (always 1 for data returned from RTAS)
236 uint8_t byte1; /* reserved */
241 * X 1: Set to 1 (indicating log is in PowerPC format)
243 * XXXX 4: Log format used for bytes 12-2047
247 uint8_t byte3; /* reserved */
249 uint8_t reserved[8]; /* reserved */
251 __be32 company_id; /* Company ID of the company */
252 /* that defines the format for */
253 /* the vendor specific log type */
254 /* Byte 16-end of log */
255 uint8_t vendor_log[1]; /* Start of vendor specific log */
256 /* Variable length. */
260 inline uint8_t rtas_ext_event_log_format(struct rtas_ext_event_log_v6 *ext_log)
262 return ext_log->byte2 & 0x0F;
266 inline uint32_t rtas_ext_event_company_id(struct rtas_ext_event_log_v6 *ext_log)
268 return be32_to_cpu(ext_log->company_id);
271 /* pSeries event log format */
273 /* Two bytes ASCII section IDs */
274 #define PSERIES_ELOG_SECT_ID_PRIV_HDR (('P' << 8) | 'H')
275 #define PSERIES_ELOG_SECT_ID_USER_HDR (('U' << 8) | 'H')
276 #define PSERIES_ELOG_SECT_ID_PRIMARY_SRC (('P' << 8) | 'S')
277 #define PSERIES_ELOG_SECT_ID_EXTENDED_UH (('E' << 8) | 'H')
278 #define PSERIES_ELOG_SECT_ID_FAILING_MTMS (('M' << 8) | 'T')
279 #define PSERIES_ELOG_SECT_ID_SECONDARY_SRC (('S' << 8) | 'S')
280 #define PSERIES_ELOG_SECT_ID_DUMP_LOCATOR (('D' << 8) | 'H')
281 #define PSERIES_ELOG_SECT_ID_FW_ERROR (('S' << 8) | 'W')
282 #define PSERIES_ELOG_SECT_ID_IMPACT_PART_ID (('L' << 8) | 'P')
283 #define PSERIES_ELOG_SECT_ID_LOGIC_RESOURCE_ID (('L' << 8) | 'R')
284 #define PSERIES_ELOG_SECT_ID_HMC_ID (('H' << 8) | 'M')
285 #define PSERIES_ELOG_SECT_ID_EPOW (('E' << 8) | 'P')
286 #define PSERIES_ELOG_SECT_ID_IO_EVENT (('I' << 8) | 'E')
287 #define PSERIES_ELOG_SECT_ID_MANUFACT_INFO (('M' << 8) | 'I')
288 #define PSERIES_ELOG_SECT_ID_CALL_HOME (('C' << 8) | 'H')
289 #define PSERIES_ELOG_SECT_ID_USER_DEF (('U' << 8) | 'D')
290 #define PSERIES_ELOG_SECT_ID_HOTPLUG (('H' << 8) | 'P')
291 #define PSERIES_ELOG_SECT_ID_MCE (('M' << 8) | 'C')
293 /* Vendor specific Platform Event Log Format, Version 6, section header */
294 struct pseries_errorlog {
295 __be16 id; /* 0x00 2-byte ASCII section ID */
296 __be16 length; /* 0x02 Section length in bytes */
297 uint8_t version; /* 0x04 Section version */
298 uint8_t subtype; /* 0x05 Section subtype */
299 __be16 creator_component; /* 0x06 Creator component ID */
300 uint8_t data[]; /* 0x08 Start of section data */
304 inline uint16_t pseries_errorlog_id(struct pseries_errorlog *sect)
306 return be16_to_cpu(sect->id);
310 inline uint16_t pseries_errorlog_length(struct pseries_errorlog *sect)
312 return be16_to_cpu(sect->length);
315 /* RTAS pseries hotplug errorlog section */
316 struct pseries_hp_errorlog {
324 struct { __be32 count, index; } ic;
329 #define PSERIES_HP_ELOG_RESOURCE_CPU 1
330 #define PSERIES_HP_ELOG_RESOURCE_MEM 2
331 #define PSERIES_HP_ELOG_RESOURCE_SLOT 3
332 #define PSERIES_HP_ELOG_RESOURCE_PHB 4
333 #define PSERIES_HP_ELOG_RESOURCE_PMEM 6
335 #define PSERIES_HP_ELOG_ACTION_ADD 1
336 #define PSERIES_HP_ELOG_ACTION_REMOVE 2
337 #define PSERIES_HP_ELOG_ACTION_READD 3
339 #define PSERIES_HP_ELOG_ID_DRC_NAME 1
340 #define PSERIES_HP_ELOG_ID_DRC_INDEX 2
341 #define PSERIES_HP_ELOG_ID_DRC_COUNT 3
342 #define PSERIES_HP_ELOG_ID_DRC_IC 4
344 struct pseries_errorlog *get_pseries_errorlog(struct rtas_error_log *log,
345 uint16_t section_id);
348 * This can be set by the rtas_flash module so that it can get called
349 * as the absolutely last thing before the kernel terminates.
351 extern void (*rtas_flash_term_hook)(int);
353 extern struct rtas_t rtas;
355 extern int rtas_token(const char *service);
356 extern int rtas_service_present(const char *service);
357 extern int rtas_call(int token, int, int, int *, ...);
358 void rtas_call_unlocked(struct rtas_args *args, int token, int nargs,
360 extern void __noreturn rtas_restart(char *cmd);
361 extern void rtas_power_off(void);
362 extern void __noreturn rtas_halt(void);
363 extern void rtas_os_term(char *str);
364 extern int rtas_get_sensor(int sensor, int index, int *state);
365 extern int rtas_get_sensor_fast(int sensor, int index, int *state);
366 extern int rtas_get_power_level(int powerdomain, int *level);
367 extern int rtas_set_power_level(int powerdomain, int level, int *setlevel);
368 extern bool rtas_indicator_present(int token, int *maxindex);
369 extern int rtas_set_indicator(int indicator, int index, int new_value);
370 extern int rtas_set_indicator_fast(int indicator, int index, int new_value);
371 extern void rtas_progress(char *s, unsigned short hex);
372 extern int rtas_suspend_cpu(struct rtas_suspend_me_data *data);
373 extern int rtas_suspend_last_cpu(struct rtas_suspend_me_data *data);
374 extern int rtas_online_cpus_mask(cpumask_var_t cpus);
375 extern int rtas_offline_cpus_mask(cpumask_var_t cpus);
376 extern int rtas_ibm_suspend_me(u64 handle);
379 extern time64_t rtas_get_boot_time(void);
380 extern void rtas_get_rtc_time(struct rtc_time *rtc_time);
381 extern int rtas_set_rtc_time(struct rtc_time *rtc_time);
383 extern unsigned int rtas_busy_delay_time(int status);
384 extern unsigned int rtas_busy_delay(int status);
386 extern int early_init_dt_scan_rtas(unsigned long node,
387 const char *uname, int depth, void *data);
389 extern void pSeries_log_error(char *buf, unsigned int err_type, int fatal);
391 #ifdef CONFIG_PPC_PSERIES
392 extern time64_t last_rtas_event;
393 extern int clobbering_unread_rtas_event(void);
394 extern int pseries_devicetree_update(s32 scope);
395 extern void post_mobility_fixup(void);
397 static inline int clobbering_unread_rtas_event(void) { return 0; }
400 #ifdef CONFIG_PPC_RTAS_DAEMON
401 extern void rtas_cancel_event_scan(void);
403 static inline void rtas_cancel_event_scan(void) { }
406 /* Error types logged. */
407 #define ERR_FLAG_ALREADY_LOGGED 0x0
408 #define ERR_FLAG_BOOT 0x1 /* log was pulled from NVRAM on boot */
409 #define ERR_TYPE_RTAS_LOG 0x2 /* from rtas event-scan */
410 #define ERR_TYPE_KERNEL_PANIC 0x4 /* from die()/panic() */
411 #define ERR_TYPE_KERNEL_PANIC_GZ 0x8 /* ditto, compressed */
413 /* All the types and not flags */
414 #define ERR_TYPE_MASK \
415 (ERR_TYPE_RTAS_LOG | ERR_TYPE_KERNEL_PANIC | ERR_TYPE_KERNEL_PANIC_GZ)
417 #define RTAS_DEBUG KERN_DEBUG "RTAS: "
419 #define RTAS_ERROR_LOG_MAX 2048
422 * Return the firmware-specified size of the error log buffer
423 * for all rtas calls that require an error buffer argument.
424 * This includes 'check-exception' and 'rtas-last-error'.
426 extern int rtas_get_error_log_max(void);
428 /* Event Scan Parameters */
429 #define EVENT_SCAN_ALL_EVENTS 0xf0000000
430 #define SURVEILLANCE_TOKEN 9000
431 #define LOG_NUMBER 64 /* must be a power of two */
432 #define LOG_NUMBER_MASK (LOG_NUMBER-1)
434 /* Some RTAS ops require a data buffer and that buffer must be < 4G.
435 * Rather than having a memory allocator, just use this buffer
436 * (get the lock first), make the RTAS call. Copy the data instead
437 * of holding the buffer for long.
440 #define RTAS_DATA_BUF_SIZE 4096
441 extern spinlock_t rtas_data_buf_lock;
442 extern char rtas_data_buf[RTAS_DATA_BUF_SIZE];
444 /* RMO buffer reserved for user-space RTAS use */
445 extern unsigned long rtas_rmo_buf;
447 #define GLOBAL_INTERRUPT_QUEUE 9005
450 * rtas_config_addr - Format a busno, devfn and reg for RTAS.
451 * @busno: The bus number.
452 * @devfn: The device and function number as encoded by PCI_DEVFN().
453 * @reg: The register number.
455 * This function encodes the given busno, devfn and register number as
456 * required for RTAS calls that take a "config_addr" parameter.
457 * See PAPR requirement 7.3.4-1 for more info.
459 static inline u32 rtas_config_addr(int busno, int devfn, int reg)
461 return ((reg & 0xf00) << 20) | ((busno & 0xff) << 16) |
462 (devfn << 8) | (reg & 0xff);
465 extern void rtas_give_timebase(void);
466 extern void rtas_take_timebase(void);
468 #ifdef CONFIG_PPC_RTAS
469 static inline int page_is_rtas_user_buf(unsigned long pfn)
471 unsigned long paddr = (pfn << PAGE_SHIFT);
472 if (paddr >= rtas_rmo_buf && paddr < (rtas_rmo_buf + RTAS_RMOBUF_MAX))
477 /* Not the best place to put pSeries_coalesce_init, will be fixed when we
478 * move some of the rtas suspend-me stuff to pseries */
479 extern void pSeries_coalesce_init(void);
480 void rtas_initialize(void);
482 static inline int page_is_rtas_user_buf(unsigned long pfn) { return 0;}
483 static inline void pSeries_coalesce_init(void) { }
484 static inline void rtas_initialize(void) { };
487 extern int call_rtas(const char *, int, int, unsigned long *, ...);
489 #endif /* __KERNEL__ */
490 #endif /* _POWERPC_RTAS_H */