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_NO_SUCH_INDICATOR -3 /* No such indicator implemented */
28 #define RTAS_EXTENDED_DELAY_MIN 9900
29 #define RTAS_EXTENDED_DELAY_MAX 9905
31 #define RTAS_UNKNOWN_OP -1099 /* Unknown RTAS Token */
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 u32 rtas_arg_t;
55 rtas_arg_t *rets; /* Pointer to return values in args[]. */
58 extern struct rtas_args rtas_stop_self_args;
61 unsigned long entry; /* physical address pointer */
62 unsigned long base; /* physical address pointer */
65 struct rtas_args args;
66 struct device_node *dev; /* virtual address pointer */
69 /* RTAS event classes */
70 #define RTAS_INTERNAL_ERROR 0x80000000 /* set bit 0 */
71 #define RTAS_EPOW_WARNING 0x40000000 /* set bit 1 */
72 #define RTAS_POWERMGM_EVENTS 0x20000000 /* set bit 2 */
73 #define RTAS_HOTPLUG_EVENTS 0x10000000 /* set bit 3 */
74 #define RTAS_EVENT_SCAN_ALL_EVENTS 0xf0000000
76 /* RTAS event severity */
77 #define RTAS_SEVERITY_FATAL 0x5
78 #define RTAS_SEVERITY_ERROR 0x4
79 #define RTAS_SEVERITY_ERROR_SYNC 0x3
80 #define RTAS_SEVERITY_WARNING 0x2
81 #define RTAS_SEVERITY_EVENT 0x1
82 #define RTAS_SEVERITY_NO_ERROR 0x0
84 /* RTAS event disposition */
85 #define RTAS_DISP_FULLY_RECOVERED 0x0
86 #define RTAS_DISP_LIMITED_RECOVERY 0x1
87 #define RTAS_DISP_NOT_RECOVERED 0x2
89 /* RTAS event initiator */
90 #define RTAS_INITIATOR_UNKNOWN 0x0
91 #define RTAS_INITIATOR_CPU 0x1
92 #define RTAS_INITIATOR_PCI 0x2
93 #define RTAS_INITIATOR_ISA 0x3
94 #define RTAS_INITIATOR_MEMORY 0x4
95 #define RTAS_INITIATOR_POWERMGM 0x5
97 /* RTAS event target */
98 #define RTAS_TARGET_UNKNOWN 0x0
99 #define RTAS_TARGET_CPU 0x1
100 #define RTAS_TARGET_PCI 0x2
101 #define RTAS_TARGET_ISA 0x3
102 #define RTAS_TARGET_MEMORY 0x4
103 #define RTAS_TARGET_POWERMGM 0x5
105 /* RTAS event type */
106 #define RTAS_TYPE_RETRY 0x01
107 #define RTAS_TYPE_TCE_ERR 0x02
108 #define RTAS_TYPE_INTERN_DEV_FAIL 0x03
109 #define RTAS_TYPE_TIMEOUT 0x04
110 #define RTAS_TYPE_DATA_PARITY 0x05
111 #define RTAS_TYPE_ADDR_PARITY 0x06
112 #define RTAS_TYPE_CACHE_PARITY 0x07
113 #define RTAS_TYPE_ADDR_INVALID 0x08
114 #define RTAS_TYPE_ECC_UNCORR 0x09
115 #define RTAS_TYPE_ECC_CORR 0x0a
116 #define RTAS_TYPE_EPOW 0x40
117 #define RTAS_TYPE_PLATFORM 0xE0
118 #define RTAS_TYPE_IO 0xE1
119 #define RTAS_TYPE_INFO 0xE2
120 #define RTAS_TYPE_DEALLOC 0xE3
121 #define RTAS_TYPE_DUMP 0xE4
122 /* I don't add PowerMGM events right now, this is a different topic */
123 #define RTAS_TYPE_PMGM_POWER_SW_ON 0x60
124 #define RTAS_TYPE_PMGM_POWER_SW_OFF 0x61
125 #define RTAS_TYPE_PMGM_LID_OPEN 0x62
126 #define RTAS_TYPE_PMGM_LID_CLOSE 0x63
127 #define RTAS_TYPE_PMGM_SLEEP_BTN 0x64
128 #define RTAS_TYPE_PMGM_WAKE_BTN 0x65
129 #define RTAS_TYPE_PMGM_BATTERY_WARN 0x66
130 #define RTAS_TYPE_PMGM_BATTERY_CRIT 0x67
131 #define RTAS_TYPE_PMGM_SWITCH_TO_BAT 0x68
132 #define RTAS_TYPE_PMGM_SWITCH_TO_AC 0x69
133 #define RTAS_TYPE_PMGM_KBD_OR_MOUSE 0x6a
134 #define RTAS_TYPE_PMGM_ENCLOS_OPEN 0x6b
135 #define RTAS_TYPE_PMGM_ENCLOS_CLOSED 0x6c
136 #define RTAS_TYPE_PMGM_RING_INDICATE 0x6d
137 #define RTAS_TYPE_PMGM_LAN_ATTENTION 0x6e
138 #define RTAS_TYPE_PMGM_TIME_ALARM 0x6f
139 #define RTAS_TYPE_PMGM_CONFIG_CHANGE 0x70
140 #define RTAS_TYPE_PMGM_SERVICE_PROC 0x71
142 struct rtas_error_log {
143 unsigned long version:8; /* Architectural version */
144 unsigned long severity:3; /* Severity level of error */
145 unsigned long disposition:2; /* Degree of recovery */
146 unsigned long extended:1; /* extended log present? */
147 unsigned long /* reserved */ :2; /* Reserved for future use */
148 unsigned long initiator:4; /* Initiator of event */
149 unsigned long target:4; /* Target of failed operation */
150 unsigned long type:8; /* General event or error*/
151 unsigned long extended_log_length:32; /* length in bytes */
152 unsigned char buffer[1];
157 unsigned long length;
160 /* This struct is very similar but not identical to
161 * that needed by the rtas flash update.
162 * All we need to do for rtas is rewrite num_blocks
163 * into a version/length and translate the pointers
166 #define FLASH_BLOCKS_PER_NODE ((PAGE_SIZE - 16) / sizeof(struct flash_block))
167 struct flash_block_list {
168 unsigned long num_blocks;
169 struct flash_block_list *next;
170 struct flash_block blocks[FLASH_BLOCKS_PER_NODE];
172 struct flash_block_list_header { /* just the header of flash_block_list */
173 unsigned long num_blocks;
174 struct flash_block_list *next;
176 extern struct flash_block_list_header rtas_firmware_flash_list;
178 extern struct rtas_t rtas;
180 extern void enter_rtas(unsigned long);
181 extern int rtas_token(const char *service);
182 extern int rtas_call(int token, int, int, int *, ...);
183 extern void call_rtas_display_status(unsigned char);
184 extern void rtas_restart(char *cmd);
185 extern void rtas_power_off(void);
186 extern void rtas_halt(void);
187 extern void rtas_os_term(char *str);
188 extern int rtas_get_sensor(int sensor, int index, int *state);
189 extern int rtas_get_power_level(int powerdomain, int *level);
190 extern int rtas_set_power_level(int powerdomain, int level, int *setlevel);
191 extern int rtas_set_indicator(int indicator, int index, int new_value);
192 extern void rtas_initialize(void);
194 /* Given an RTAS status code of 9900..9905 compute the hinted delay */
195 unsigned int rtas_extended_busy_delay_time(int status);
196 static inline int rtas_is_extended_busy(int status)
198 return status >= 9900 && status <= 9909;
201 extern void pSeries_log_error(char *buf, unsigned int err_type, int fatal);
203 /* Error types logged. */
204 #define ERR_FLAG_ALREADY_LOGGED 0x0
205 #define ERR_FLAG_BOOT 0x1 /* log was pulled from NVRAM on boot */
206 #define ERR_TYPE_RTAS_LOG 0x2 /* from rtas event-scan */
207 #define ERR_TYPE_KERNEL_PANIC 0x4 /* from panic() */
209 /* All the types and not flags */
210 #define ERR_TYPE_MASK (ERR_TYPE_RTAS_LOG | ERR_TYPE_KERNEL_PANIC)
212 #define RTAS_DEBUG KERN_DEBUG "RTAS: "
214 #define RTAS_ERROR_LOG_MAX 2048
217 * Return the firmware-specified size of the error log buffer
218 * for all rtas calls that require an error buffer argument.
219 * This includes 'check-exception' and 'rtas-last-error'.
221 extern int rtas_get_error_log_max(void);
223 /* Event Scan Parameters */
224 #define EVENT_SCAN_ALL_EVENTS 0xf0000000
225 #define SURVEILLANCE_TOKEN 9000
226 #define LOG_NUMBER 64 /* must be a power of two */
227 #define LOG_NUMBER_MASK (LOG_NUMBER-1)
229 /* Some RTAS ops require a data buffer and that buffer must be < 4G.
230 * Rather than having a memory allocator, just use this buffer
231 * (get the lock first), make the RTAS call. Copy the data instead
232 * of holding the buffer for long.
235 #define RTAS_DATA_BUF_SIZE 4096
236 extern spinlock_t rtas_data_buf_lock;
237 extern char rtas_data_buf[RTAS_DATA_BUF_SIZE];
239 extern void rtas_stop_self(void);
241 /* RMO buffer reserved for user-space RTAS use */
242 extern unsigned long rtas_rmo_buf;
244 #define GLOBAL_INTERRUPT_QUEUE 9005
246 #endif /* _PPC64_RTAS_H */