4 #include <linux/spinlock.h>
8 * Definitions for talking to the RTAS on CHRP machines.
10 * Copyright (C) 2001 Peter Bergner
11 * Copyright (C) 2001 PPC 64 Team, IBM Corp
13 * This program is free software; you can redistribute it and/or
14 * modify it under the terms of the GNU General Public License
15 * as published by the Free Software Foundation; either version
16 * 2 of the License, or (at your option) any later version.
19 #define RTAS_UNKNOWN_SERVICE (-1)
20 #define RTAS_INSTANTIATE_MAX (1UL<<30) /* Don't instantiate rtas at/above this value */
22 /* Buffer size for ppc_rtas system call. */
23 #define RTAS_RMOBUF_MAX (64 * 1024)
25 /* RTAS return status codes */
26 #define RTAS_BUSY -2 /* RTAS Busy */
27 #define RTAS_EXTENDED_DELAY_MIN 9900
28 #define RTAS_EXTENDED_DELAY_MAX 9905
31 * In general to call RTAS use rtas_token("string") to lookup
32 * an RTAS token for the given string (e.g. "event-scan").
33 * To actually perform the call use
34 * ret = rtas_call(token, n_in, n_out, ...)
35 * Where n_in is the number of input parameters and
36 * n_out is the number of output parameters
38 * If the "string" is invalid on this system, RTAS_UNKNOWN_SERVICE
39 * will be returned as a token. rtas_call() does look for this
40 * token and error out gracefully so rtas_call(rtas_token("str"), ...)
41 * may be safely used for one-shot calls to RTAS.
45 typedef u32 rtas_arg_t;
52 rtas_arg_t *rets; /* Pointer to return values in args[]. */
55 extern struct rtas_args rtas_stop_self_args;
58 unsigned long entry; /* physical address pointer */
59 unsigned long base; /* physical address pointer */
62 struct rtas_args args;
63 struct device_node *dev; /* virtual address pointer */
66 /* RTAS event classes */
67 #define RTAS_INTERNAL_ERROR 0x80000000 /* set bit 0 */
68 #define RTAS_EPOW_WARNING 0x40000000 /* set bit 1 */
69 #define RTAS_POWERMGM_EVENTS 0x20000000 /* set bit 2 */
70 #define RTAS_HOTPLUG_EVENTS 0x10000000 /* set bit 3 */
71 #define RTAS_EVENT_SCAN_ALL_EVENTS 0xf0000000
73 /* RTAS event severity */
74 #define RTAS_SEVERITY_FATAL 0x5
75 #define RTAS_SEVERITY_ERROR 0x4
76 #define RTAS_SEVERITY_ERROR_SYNC 0x3
77 #define RTAS_SEVERITY_WARNING 0x2
78 #define RTAS_SEVERITY_EVENT 0x1
79 #define RTAS_SEVERITY_NO_ERROR 0x0
81 /* RTAS event disposition */
82 #define RTAS_DISP_FULLY_RECOVERED 0x0
83 #define RTAS_DISP_LIMITED_RECOVERY 0x1
84 #define RTAS_DISP_NOT_RECOVERED 0x2
86 /* RTAS event initiator */
87 #define RTAS_INITIATOR_UNKNOWN 0x0
88 #define RTAS_INITIATOR_CPU 0x1
89 #define RTAS_INITIATOR_PCI 0x2
90 #define RTAS_INITIATOR_ISA 0x3
91 #define RTAS_INITIATOR_MEMORY 0x4
92 #define RTAS_INITIATOR_POWERMGM 0x5
94 /* RTAS event target */
95 #define RTAS_TARGET_UNKNOWN 0x0
96 #define RTAS_TARGET_CPU 0x1
97 #define RTAS_TARGET_PCI 0x2
98 #define RTAS_TARGET_ISA 0x3
99 #define RTAS_TARGET_MEMORY 0x4
100 #define RTAS_TARGET_POWERMGM 0x5
102 /* RTAS event type */
103 #define RTAS_TYPE_RETRY 0x01
104 #define RTAS_TYPE_TCE_ERR 0x02
105 #define RTAS_TYPE_INTERN_DEV_FAIL 0x03
106 #define RTAS_TYPE_TIMEOUT 0x04
107 #define RTAS_TYPE_DATA_PARITY 0x05
108 #define RTAS_TYPE_ADDR_PARITY 0x06
109 #define RTAS_TYPE_CACHE_PARITY 0x07
110 #define RTAS_TYPE_ADDR_INVALID 0x08
111 #define RTAS_TYPE_ECC_UNCORR 0x09
112 #define RTAS_TYPE_ECC_CORR 0x0a
113 #define RTAS_TYPE_EPOW 0x40
114 #define RTAS_TYPE_PLATFORM 0xE0
115 #define RTAS_TYPE_IO 0xE1
116 #define RTAS_TYPE_INFO 0xE2
117 #define RTAS_TYPE_DEALLOC 0xE3
118 #define RTAS_TYPE_DUMP 0xE4
119 /* I don't add PowerMGM events right now, this is a different topic */
120 #define RTAS_TYPE_PMGM_POWER_SW_ON 0x60
121 #define RTAS_TYPE_PMGM_POWER_SW_OFF 0x61
122 #define RTAS_TYPE_PMGM_LID_OPEN 0x62
123 #define RTAS_TYPE_PMGM_LID_CLOSE 0x63
124 #define RTAS_TYPE_PMGM_SLEEP_BTN 0x64
125 #define RTAS_TYPE_PMGM_WAKE_BTN 0x65
126 #define RTAS_TYPE_PMGM_BATTERY_WARN 0x66
127 #define RTAS_TYPE_PMGM_BATTERY_CRIT 0x67
128 #define RTAS_TYPE_PMGM_SWITCH_TO_BAT 0x68
129 #define RTAS_TYPE_PMGM_SWITCH_TO_AC 0x69
130 #define RTAS_TYPE_PMGM_KBD_OR_MOUSE 0x6a
131 #define RTAS_TYPE_PMGM_ENCLOS_OPEN 0x6b
132 #define RTAS_TYPE_PMGM_ENCLOS_CLOSED 0x6c
133 #define RTAS_TYPE_PMGM_RING_INDICATE 0x6d
134 #define RTAS_TYPE_PMGM_LAN_ATTENTION 0x6e
135 #define RTAS_TYPE_PMGM_TIME_ALARM 0x6f
136 #define RTAS_TYPE_PMGM_CONFIG_CHANGE 0x70
137 #define RTAS_TYPE_PMGM_SERVICE_PROC 0x71
139 struct rtas_error_log {
140 unsigned long version:8; /* Architectural version */
141 unsigned long severity:3; /* Severity level of error */
142 unsigned long disposition:2; /* Degree of recovery */
143 unsigned long extended:1; /* extended log present? */
144 unsigned long /* reserved */ :2; /* Reserved for future use */
145 unsigned long initiator:4; /* Initiator of event */
146 unsigned long target:4; /* Target of failed operation */
147 unsigned long type:8; /* General event or error*/
148 unsigned long extended_log_length:32; /* length in bytes */
149 unsigned char buffer[1];
154 unsigned long length;
157 /* This struct is very similar but not identical to
158 * that needed by the rtas flash update.
159 * All we need to do for rtas is rewrite num_blocks
160 * into a version/length and translate the pointers
163 #define FLASH_BLOCKS_PER_NODE ((PAGE_SIZE - 16) / sizeof(struct flash_block))
164 struct flash_block_list {
165 unsigned long num_blocks;
166 struct flash_block_list *next;
167 struct flash_block blocks[FLASH_BLOCKS_PER_NODE];
169 struct flash_block_list_header { /* just the header of flash_block_list */
170 unsigned long num_blocks;
171 struct flash_block_list *next;
173 extern struct flash_block_list_header rtas_firmware_flash_list;
175 extern struct rtas_t rtas;
177 extern void enter_rtas(unsigned long);
178 extern int rtas_token(const char *service);
179 extern int rtas_call(int token, int, int, int *, ...);
180 extern void call_rtas_display_status(unsigned char);
181 extern void rtas_restart(char *cmd);
182 extern void rtas_power_off(void);
183 extern void rtas_halt(void);
184 extern void rtas_os_term(char *str);
185 extern int rtas_get_sensor(int sensor, int index, int *state);
186 extern int rtas_get_power_level(int powerdomain, int *level);
187 extern int rtas_set_power_level(int powerdomain, int level, int *setlevel);
188 extern int rtas_set_indicator(int indicator, int index, int new_value);
189 extern void rtas_progress(char *s, unsigned short hex);
190 extern void rtas_initialize(void);
193 extern void rtas_get_boot_time(struct rtc_time *rtc_time);
194 extern void rtas_get_rtc_time(struct rtc_time *rtc_time);
195 extern int rtas_set_rtc_time(struct rtc_time *rtc_time);
197 /* Given an RTAS status code of 9900..9905 compute the hinted delay */
198 unsigned int rtas_extended_busy_delay_time(int status);
199 static inline int rtas_is_extended_busy(int status)
201 return status >= 9900 && status <= 9909;
204 extern void pSeries_log_error(char *buf, unsigned int err_type, int fatal);
206 /* Error types logged. */
207 #define ERR_FLAG_ALREADY_LOGGED 0x0
208 #define ERR_FLAG_BOOT 0x1 /* log was pulled from NVRAM on boot */
209 #define ERR_TYPE_RTAS_LOG 0x2 /* from rtas event-scan */
210 #define ERR_TYPE_KERNEL_PANIC 0x4 /* from panic() */
212 /* All the types and not flags */
213 #define ERR_TYPE_MASK (ERR_TYPE_RTAS_LOG | ERR_TYPE_KERNEL_PANIC)
215 #define RTAS_DEBUG KERN_DEBUG "RTAS: "
217 #define RTAS_ERROR_LOG_MAX 2048
220 * Return the firmware-specified size of the error log buffer
221 * for all rtas calls that require an error buffer argument.
222 * This includes 'check-exception' and 'rtas-last-error'.
224 extern int rtas_get_error_log_max(void);
226 /* Event Scan Parameters */
227 #define EVENT_SCAN_ALL_EVENTS 0xf0000000
228 #define SURVEILLANCE_TOKEN 9000
229 #define LOG_NUMBER 64 /* must be a power of two */
230 #define LOG_NUMBER_MASK (LOG_NUMBER-1)
232 /* Some RTAS ops require a data buffer and that buffer must be < 4G.
233 * Rather than having a memory allocator, just use this buffer
234 * (get the lock first), make the RTAS call. Copy the data instead
235 * of holding the buffer for long.
238 #define RTAS_DATA_BUF_SIZE 4096
239 extern spinlock_t rtas_data_buf_lock;
240 extern char rtas_data_buf[RTAS_DATA_BUF_SIZE];
242 extern void rtas_stop_self(void);
244 /* RMO buffer reserved for user-space RTAS use */
245 extern unsigned long rtas_rmo_buf;
247 #define GLOBAL_INTERRUPT_QUEUE 9005
249 #endif /* _PPC64_RTAS_H */