blob: 58625d1e78023e2037a2442513f3103e84658b9b [file] [log] [blame]
Paul Mackerras9b6b5632005-10-06 12:06:20 +10001#ifndef _POWERPC_RTAS_H
2#define _POWERPC_RTAS_H
Arnd Bergmann88ced032005-12-16 22:43:46 +01003#ifdef __KERNEL__
Paul Mackerras9b6b5632005-10-06 12:06:20 +10004
5#include <linux/spinlock.h>
6#include <asm/page.h>
7
8/*
9 * Definitions for talking to the RTAS on CHRP machines.
10 *
11 * Copyright (C) 2001 Peter Bergner
12 * Copyright (C) 2001 PPC 64 Team, IBM Corp
13 *
14 * This program is free software; you can redistribute it and/or
15 * modify it under the terms of the GNU General Public License
16 * as published by the Free Software Foundation; either version
17 * 2 of the License, or (at your option) any later version.
18 */
19
20#define RTAS_UNKNOWN_SERVICE (-1)
Ingo Molnarfe333322009-01-06 14:26:03 +000021#define RTAS_INSTANTIATE_MAX (1ULL<<30) /* Don't instantiate rtas at/above this value */
Paul Mackerras9b6b5632005-10-06 12:06:20 +100022
23/* Buffer size for ppc_rtas system call. */
24#define RTAS_RMOBUF_MAX (64 * 1024)
25
26/* RTAS return status codes */
Dave C Boutcher368a6ba2006-06-12 19:49:20 -050027#define RTAS_NOT_SUSPENDABLE -9004
Paul Mackerras9b6b5632005-10-06 12:06:20 +100028#define RTAS_BUSY -2 /* RTAS Busy */
29#define RTAS_EXTENDED_DELAY_MIN 9900
30#define RTAS_EXTENDED_DELAY_MAX 9905
31
32/*
33 * In general to call RTAS use rtas_token("string") to lookup
34 * an RTAS token for the given string (e.g. "event-scan").
35 * To actually perform the call use
36 * ret = rtas_call(token, n_in, n_out, ...)
37 * Where n_in is the number of input parameters and
38 * n_out is the number of output parameters
39 *
40 * If the "string" is invalid on this system, RTAS_UNKNOWN_SERVICE
41 * will be returned as a token. rtas_call() does look for this
42 * token and error out gracefully so rtas_call(rtas_token("str"), ...)
43 * may be safely used for one-shot calls to RTAS.
44 *
45 */
46
47typedef u32 rtas_arg_t;
48
49struct rtas_args {
50 u32 token;
51 u32 nargs;
52 u32 nret;
53 rtas_arg_t args[16];
54 rtas_arg_t *rets; /* Pointer to return values in args[]. */
55};
56
Paul Mackerras9b6b5632005-10-06 12:06:20 +100057struct rtas_t {
58 unsigned long entry; /* physical address pointer */
59 unsigned long base; /* physical address pointer */
60 unsigned long size;
Thomas Gleixner445c8952009-12-02 19:49:50 +010061 arch_spinlock_t lock;
Paul Mackerras9b6b5632005-10-06 12:06:20 +100062 struct rtas_args args;
63 struct device_node *dev; /* virtual address pointer */
64};
65
Brian King8fe93f82010-07-07 12:31:01 +000066struct rtas_suspend_me_data {
67 atomic_t working; /* number of cpus accessing this struct */
68 atomic_t done;
69 int token; /* ibm,suspend-me */
70 atomic_t error;
71 struct completion *complete; /* wait on this until working == 0 */
72};
73
Paul Mackerras9b6b5632005-10-06 12:06:20 +100074/* RTAS event classes */
75#define RTAS_INTERNAL_ERROR 0x80000000 /* set bit 0 */
76#define RTAS_EPOW_WARNING 0x40000000 /* set bit 1 */
77#define RTAS_POWERMGM_EVENTS 0x20000000 /* set bit 2 */
78#define RTAS_HOTPLUG_EVENTS 0x10000000 /* set bit 3 */
Anton Blanchard4a9f95062009-03-31 20:13:27 +000079#define RTAS_IO_EVENTS 0x08000000 /* set bit 4 */
80#define RTAS_EVENT_SCAN_ALL_EVENTS 0xffffffff
Paul Mackerras9b6b5632005-10-06 12:06:20 +100081
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
89
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
94
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
102
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
110
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/* I don't add PowerMGM events right now, this is a different topic */
129#define RTAS_TYPE_PMGM_POWER_SW_ON 0x60
130#define RTAS_TYPE_PMGM_POWER_SW_OFF 0x61
131#define RTAS_TYPE_PMGM_LID_OPEN 0x62
132#define RTAS_TYPE_PMGM_LID_CLOSE 0x63
133#define RTAS_TYPE_PMGM_SLEEP_BTN 0x64
134#define RTAS_TYPE_PMGM_WAKE_BTN 0x65
135#define RTAS_TYPE_PMGM_BATTERY_WARN 0x66
136#define RTAS_TYPE_PMGM_BATTERY_CRIT 0x67
137#define RTAS_TYPE_PMGM_SWITCH_TO_BAT 0x68
138#define RTAS_TYPE_PMGM_SWITCH_TO_AC 0x69
139#define RTAS_TYPE_PMGM_KBD_OR_MOUSE 0x6a
140#define RTAS_TYPE_PMGM_ENCLOS_OPEN 0x6b
141#define RTAS_TYPE_PMGM_ENCLOS_CLOSED 0x6c
142#define RTAS_TYPE_PMGM_RING_INDICATE 0x6d
143#define RTAS_TYPE_PMGM_LAN_ATTENTION 0x6e
144#define RTAS_TYPE_PMGM_TIME_ALARM 0x6f
145#define RTAS_TYPE_PMGM_CONFIG_CHANGE 0x70
146#define RTAS_TYPE_PMGM_SERVICE_PROC 0x71
147
Mark Nelsonb08e2812010-05-26 21:40:39 +0000148/* RTAS check-exception vector offset */
149#define RTAS_VECTOR_EXTERNAL_INTERRUPT 0x500
150
Paul Mackerras9b6b5632005-10-06 12:06:20 +1000151struct rtas_error_log {
152 unsigned long version:8; /* Architectural version */
153 unsigned long severity:3; /* Severity level of error */
154 unsigned long disposition:2; /* Degree of recovery */
155 unsigned long extended:1; /* extended log present? */
156 unsigned long /* reserved */ :2; /* Reserved for future use */
157 unsigned long initiator:4; /* Initiator of event */
158 unsigned long target:4; /* Target of failed operation */
159 unsigned long type:8; /* General event or error*/
160 unsigned long extended_log_length:32; /* length in bytes */
Tseng-Hui (Frank) Lin4cb46382011-05-03 18:28:43 +0000161 unsigned char buffer[1]; /* Start of extended log */
162 /* Variable length. */
163};
164
165#define RTAS_V6EXT_LOG_FORMAT_EVENT_LOG 14
166
167#define RTAS_V6EXT_COMPANY_ID_IBM (('I' << 24) | ('B' << 16) | ('M' << 8))
168
169/* RTAS general extended event log, Version 6. The extended log starts
170 * from "buffer" field of struct rtas_error_log defined above.
171 */
172struct rtas_ext_event_log_v6 {
173 /* Byte 0 */
174 uint32_t log_valid:1; /* 1:Log valid */
175 uint32_t unrecoverable_error:1; /* 1:Unrecoverable error */
176 uint32_t recoverable_error:1; /* 1:recoverable (correctable */
177 /* or successfully retried) */
178 uint32_t degraded_operation:1; /* 1:Unrecoverable err, bypassed*/
179 /* - degraded operation (e.g. */
180 /* CPU or mem taken off-line) */
181 uint32_t predictive_error:1;
182 uint32_t new_log:1; /* 1:"New" log (Always 1 for */
183 /* data returned from RTAS */
184 uint32_t big_endian:1; /* 1: Big endian */
185 uint32_t :1; /* reserved */
186 /* Byte 1 */
187 uint32_t :8; /* reserved */
188 /* Byte 2 */
189 uint32_t powerpc_format:1; /* Set to 1 (indicating log is */
190 /* in PowerPC format */
191 uint32_t :3; /* reserved */
192 uint32_t log_format:4; /* Log format indicator. Define */
193 /* format used for byte 12-2047 */
194 /* Byte 3 */
195 uint32_t :8; /* reserved */
196 /* Byte 4-11 */
197 uint8_t reserved[8]; /* reserved */
198 /* Byte 12-15 */
199 uint32_t company_id; /* Company ID of the company */
200 /* that defines the format for */
201 /* the vendor specific log type */
202 /* Byte 16-end of log */
203 uint8_t vendor_log[1]; /* Start of vendor specific log */
204 /* Variable length. */
Paul Mackerras9b6b5632005-10-06 12:06:20 +1000205};
206
Paul Mackerrasf4fcbbe2005-11-03 14:41:19 +1100207/*
208 * This can be set by the rtas_flash module so that it can get called
209 * as the absolutely last thing before the kernel terminates.
Paul Mackerras9b6b5632005-10-06 12:06:20 +1000210 */
Paul Mackerrasf4fcbbe2005-11-03 14:41:19 +1100211extern void (*rtas_flash_term_hook)(int);
Paul Mackerras9b6b5632005-10-06 12:06:20 +1000212
213extern struct rtas_t rtas;
214
215extern void enter_rtas(unsigned long);
216extern int rtas_token(const char *service);
Nathan Lynchf2d6d2d2006-12-06 18:50:45 -0600217extern int rtas_service_present(const char *service);
Paul Mackerras9b6b5632005-10-06 12:06:20 +1000218extern int rtas_call(int token, int, int, int *, ...);
Paul Mackerras9b6b5632005-10-06 12:06:20 +1000219extern void rtas_restart(char *cmd);
220extern void rtas_power_off(void);
221extern void rtas_halt(void);
Paul Mackerras8f515062007-12-03 09:30:04 +1100222extern void rtas_os_term(char *str);
Paul Mackerras9b6b5632005-10-06 12:06:20 +1000223extern int rtas_get_sensor(int sensor, int index, int *state);
224extern int rtas_get_power_level(int powerdomain, int *level);
225extern int rtas_set_power_level(int powerdomain, int level, int *setlevel);
Nathan Lynchedc72ac2008-12-11 09:14:25 +0000226extern bool rtas_indicator_present(int token, int *maxindex);
Paul Mackerras9b6b5632005-10-06 12:06:20 +1000227extern int rtas_set_indicator(int indicator, int index, int new_value);
Haren Myneni81b73dd2006-07-27 14:29:00 -0700228extern int rtas_set_indicator_fast(int indicator, int index, int new_value);
Paul Mackerras9b6b5632005-10-06 12:06:20 +1000229extern void rtas_progress(char *s, unsigned short hex);
230extern void rtas_initialize(void);
Brian King8fe93f82010-07-07 12:31:01 +0000231extern int rtas_suspend_cpu(struct rtas_suspend_me_data *data);
232extern int rtas_suspend_last_cpu(struct rtas_suspend_me_data *data);
Nathan Fontenotd8862be2010-09-10 09:41:35 +0000233extern int rtas_ibm_suspend_me(struct rtas_args *);
Paul Mackerras9b6b5632005-10-06 12:06:20 +1000234
235struct rtc_time;
Paul Mackerras143a1de2005-10-19 23:11:21 +1000236extern unsigned long rtas_get_boot_time(void);
Paul Mackerras9b6b5632005-10-06 12:06:20 +1000237extern void rtas_get_rtc_time(struct rtc_time *rtc_time);
238extern int rtas_set_rtc_time(struct rtc_time *rtc_time);
239
John Rose507279d2006-06-05 16:31:48 -0500240extern unsigned int rtas_busy_delay_time(int status);
241extern unsigned int rtas_busy_delay(int status);
Paul Mackerras9b6b5632005-10-06 12:06:20 +1000242
Michael Ellerman458148c2006-06-23 18:20:13 +1000243extern int early_init_dt_scan_rtas(unsigned long node,
244 const char *uname, int depth, void *data);
245
Paul Mackerras9b6b5632005-10-06 12:06:20 +1000246extern void pSeries_log_error(char *buf, unsigned int err_type, int fatal);
247
248/* Error types logged. */
249#define ERR_FLAG_ALREADY_LOGGED 0x0
250#define ERR_FLAG_BOOT 0x1 /* log was pulled from NVRAM on boot */
251#define ERR_TYPE_RTAS_LOG 0x2 /* from rtas event-scan */
252#define ERR_TYPE_KERNEL_PANIC 0x4 /* from panic() */
253
254/* All the types and not flags */
255#define ERR_TYPE_MASK (ERR_TYPE_RTAS_LOG | ERR_TYPE_KERNEL_PANIC)
256
257#define RTAS_DEBUG KERN_DEBUG "RTAS: "
258
259#define RTAS_ERROR_LOG_MAX 2048
260
261/*
262 * Return the firmware-specified size of the error log buffer
263 * for all rtas calls that require an error buffer argument.
264 * This includes 'check-exception' and 'rtas-last-error'.
265 */
266extern int rtas_get_error_log_max(void);
267
268/* Event Scan Parameters */
269#define EVENT_SCAN_ALL_EVENTS 0xf0000000
270#define SURVEILLANCE_TOKEN 9000
271#define LOG_NUMBER 64 /* must be a power of two */
272#define LOG_NUMBER_MASK (LOG_NUMBER-1)
273
274/* Some RTAS ops require a data buffer and that buffer must be < 4G.
275 * Rather than having a memory allocator, just use this buffer
276 * (get the lock first), make the RTAS call. Copy the data instead
277 * of holding the buffer for long.
278 */
279
280#define RTAS_DATA_BUF_SIZE 4096
281extern spinlock_t rtas_data_buf_lock;
282extern char rtas_data_buf[RTAS_DATA_BUF_SIZE];
283
Paul Mackerras9b6b5632005-10-06 12:06:20 +1000284/* RMO buffer reserved for user-space RTAS use */
285extern unsigned long rtas_rmo_buf;
286
287#define GLOBAL_INTERRUPT_QUEUE 9005
288
Michael Ellerman6f3d5d32006-08-16 22:04:14 +1000289/**
290 * rtas_config_addr - Format a busno, devfn and reg for RTAS.
291 * @busno: The bus number.
292 * @devfn: The device and function number as encoded by PCI_DEVFN().
293 * @reg: The register number.
294 *
295 * This function encodes the given busno, devfn and register number as
296 * required for RTAS calls that take a "config_addr" parameter.
297 * See PAPR requirement 7.3.4-1 for more info.
298 */
299static inline u32 rtas_config_addr(int busno, int devfn, int reg)
300{
301 return ((reg & 0xf00) << 20) | ((busno & 0xff) << 16) |
302 (devfn << 8) | (reg & 0xff);
303}
304
Benjamin Herrenschmidtc4007a22009-06-16 16:42:50 +0000305extern void __cpuinit rtas_give_timebase(void);
306extern void __cpuinit rtas_take_timebase(void);
307
Arnd Bergmann88ced032005-12-16 22:43:46 +0100308#endif /* __KERNEL__ */
Paul Mackerras9b6b5632005-10-06 12:06:20 +1000309#endif /* _POWERPC_RTAS_H */