• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 #ifndef _POWERPC_RTAS_H
2 #define _POWERPC_RTAS_H
3 #ifdef __KERNEL__
4 
5 #include <linux/spinlock.h>
6 #include <asm/page.h>
7 #include <linux/time.h>
8 
9 /*
10  * Definitions for talking to the RTAS on CHRP machines.
11  *
12  * Copyright (C) 2001 Peter Bergner
13  * Copyright (C) 2001 PPC 64 Team, IBM Corp
14  *
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.
19  */
20 
21 #define RTAS_UNKNOWN_SERVICE (-1)
22 #define RTAS_INSTANTIATE_MAX (1ULL<<30) /* Don't instantiate rtas at/above this value */
23 
24 /* Buffer size for ppc_rtas system call. */
25 #define RTAS_RMOBUF_MAX (64 * 1024)
26 
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
32 
33 /*
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
40  *
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.
45  *
46  */
47 
48 typedef __be32 rtas_arg_t;
49 
50 struct rtas_args {
51 	__be32 token;
52 	__be32 nargs;
53 	__be32 nret;
54 	rtas_arg_t args[16];
55 	rtas_arg_t *rets;     /* Pointer to return values in args[]. */
56 };
57 
58 struct rtas_t {
59 	unsigned long entry;		/* physical address pointer */
60 	unsigned long base;		/* physical address pointer */
61 	unsigned long size;
62 	arch_spinlock_t lock;
63 	struct rtas_args args;
64 	struct device_node *dev;	/* virtual address pointer */
65 };
66 
67 struct rtas_suspend_me_data {
68 	atomic_t working; /* number of cpus accessing this struct */
69 	atomic_t done;
70 	int token; /* ibm,suspend-me */
71 	atomic_t error;
72 	struct completion *complete; /* wait on this until working == 0 */
73 };
74 
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
81 
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 /* Platform Resource Reassignment Notification */
148 #define RTAS_TYPE_PRRN			0xA0
149 
150 /* RTAS check-exception vector offset */
151 #define RTAS_VECTOR_EXTERNAL_INTERRUPT	0x500
152 
153 struct rtas_error_log {
154 	/* Byte 0 */
155 	uint8_t		byte0;			/* Architectural version */
156 
157 	/* Byte 1 */
158 	uint8_t		byte1;
159 	/* XXXXXXXX
160 	 * XXX		3: Severity level of error
161 	 *    XX	2: Degree of recovery
162 	 *      X	1: Extended log present?
163 	 *       XX	2: Reserved
164 	 */
165 
166 	/* Byte 2 */
167 	uint8_t		byte2;
168 	/* XXXXXXXX
169 	 * XXXX		4: Initiator of event
170 	 *     XXXX	4: Target of failed operation
171 	 */
172 	uint8_t		byte3;			/* General event or error*/
173 	__be32		extended_log_length;	/* length in bytes */
174 	unsigned char	buffer[1];		/* Start of extended log */
175 						/* Variable length.      */
176 };
177 
rtas_error_severity(const struct rtas_error_log * elog)178 static inline uint8_t rtas_error_severity(const struct rtas_error_log *elog)
179 {
180 	return (elog->byte1 & 0xE0) >> 5;
181 }
182 
rtas_error_disposition(const struct rtas_error_log * elog)183 static inline uint8_t rtas_error_disposition(const struct rtas_error_log *elog)
184 {
185 	return (elog->byte1 & 0x18) >> 3;
186 }
187 
rtas_error_extended(const struct rtas_error_log * elog)188 static inline uint8_t rtas_error_extended(const struct rtas_error_log *elog)
189 {
190 	return (elog->byte1 & 0x04) >> 2;
191 }
192 
193 #define rtas_error_type(x)	((x)->byte3)
194 
195 static inline
rtas_error_extended_log_length(const struct rtas_error_log * elog)196 uint32_t rtas_error_extended_log_length(const struct rtas_error_log *elog)
197 {
198 	return be32_to_cpu(elog->extended_log_length);
199 }
200 
201 #define RTAS_V6EXT_LOG_FORMAT_EVENT_LOG	14
202 
203 #define RTAS_V6EXT_COMPANY_ID_IBM	(('I' << 24) | ('B' << 16) | ('M' << 8))
204 
205 /* RTAS general extended event log, Version 6. The extended log starts
206  * from "buffer" field of struct rtas_error_log defined above.
207  */
208 struct rtas_ext_event_log_v6 {
209 	/* Byte 0 */
210 	uint8_t byte0;
211 	/* XXXXXXXX
212 	 * X		1: Log valid
213 	 *  X		1: Unrecoverable error
214 	 *   X		1: Recoverable (correctable or successfully retried)
215 	 *    X		1: Bypassed unrecoverable error (degraded operation)
216 	 *     X	1: Predictive error
217 	 *      X	1: "New" log (always 1 for data returned from RTAS)
218 	 *       X	1: Big Endian
219 	 *        X	1: Reserved
220 	 */
221 
222 	/* Byte 1 */
223 	uint8_t byte1;			/* reserved */
224 
225 	/* Byte 2 */
226 	uint8_t byte2;
227 	/* XXXXXXXX
228 	 * X		1: Set to 1 (indicating log is in PowerPC format)
229 	 *  XXX		3: Reserved
230 	 *     XXXX	4: Log format used for bytes 12-2047
231 	 */
232 
233 	/* Byte 3 */
234 	uint8_t byte3;			/* reserved */
235 	/* Byte 4-11 */
236 	uint8_t reserved[8];		/* reserved */
237 	/* Byte 12-15 */
238 	__be32  company_id;		/* Company ID of the company	*/
239 					/* that defines the format for	*/
240 					/* the vendor specific log type	*/
241 	/* Byte 16-end of log */
242 	uint8_t vendor_log[1];		/* Start of vendor specific log	*/
243 					/* Variable length.		*/
244 };
245 
246 static
rtas_ext_event_log_format(struct rtas_ext_event_log_v6 * ext_log)247 inline uint8_t rtas_ext_event_log_format(struct rtas_ext_event_log_v6 *ext_log)
248 {
249 	return ext_log->byte2 & 0x0F;
250 }
251 
252 static
rtas_ext_event_company_id(struct rtas_ext_event_log_v6 * ext_log)253 inline uint32_t rtas_ext_event_company_id(struct rtas_ext_event_log_v6 *ext_log)
254 {
255 	return be32_to_cpu(ext_log->company_id);
256 }
257 
258 /* pSeries event log format */
259 
260 /* Two bytes ASCII section IDs */
261 #define PSERIES_ELOG_SECT_ID_PRIV_HDR		(('P' << 8) | 'H')
262 #define PSERIES_ELOG_SECT_ID_USER_HDR		(('U' << 8) | 'H')
263 #define PSERIES_ELOG_SECT_ID_PRIMARY_SRC	(('P' << 8) | 'S')
264 #define PSERIES_ELOG_SECT_ID_EXTENDED_UH	(('E' << 8) | 'H')
265 #define PSERIES_ELOG_SECT_ID_FAILING_MTMS	(('M' << 8) | 'T')
266 #define PSERIES_ELOG_SECT_ID_SECONDARY_SRC	(('S' << 8) | 'S')
267 #define PSERIES_ELOG_SECT_ID_DUMP_LOCATOR	(('D' << 8) | 'H')
268 #define PSERIES_ELOG_SECT_ID_FW_ERROR		(('S' << 8) | 'W')
269 #define PSERIES_ELOG_SECT_ID_IMPACT_PART_ID	(('L' << 8) | 'P')
270 #define PSERIES_ELOG_SECT_ID_LOGIC_RESOURCE_ID	(('L' << 8) | 'R')
271 #define PSERIES_ELOG_SECT_ID_HMC_ID		(('H' << 8) | 'M')
272 #define PSERIES_ELOG_SECT_ID_EPOW		(('E' << 8) | 'P')
273 #define PSERIES_ELOG_SECT_ID_IO_EVENT		(('I' << 8) | 'E')
274 #define PSERIES_ELOG_SECT_ID_MANUFACT_INFO	(('M' << 8) | 'I')
275 #define PSERIES_ELOG_SECT_ID_CALL_HOME		(('C' << 8) | 'H')
276 #define PSERIES_ELOG_SECT_ID_USER_DEF		(('U' << 8) | 'D')
277 #define PSERIES_ELOG_SECT_ID_HOTPLUG		(('H' << 8) | 'P')
278 
279 /* Vendor specific Platform Event Log Format, Version 6, section header */
280 struct pseries_errorlog {
281 	__be16 id;			/* 0x00 2-byte ASCII section ID	*/
282 	__be16 length;			/* 0x02 Section length in bytes	*/
283 	uint8_t version;		/* 0x04 Section version		*/
284 	uint8_t subtype;		/* 0x05 Section subtype		*/
285 	__be16 creator_component;	/* 0x06 Creator component ID	*/
286 	uint8_t data[];			/* 0x08 Start of section data	*/
287 };
288 
289 static
pseries_errorlog_id(struct pseries_errorlog * sect)290 inline uint16_t pseries_errorlog_id(struct pseries_errorlog *sect)
291 {
292 	return be16_to_cpu(sect->id);
293 }
294 
295 static
pseries_errorlog_length(struct pseries_errorlog * sect)296 inline uint16_t pseries_errorlog_length(struct pseries_errorlog *sect)
297 {
298 	return be16_to_cpu(sect->length);
299 }
300 
301 /* RTAS pseries hotplug errorlog section */
302 struct pseries_hp_errorlog {
303 	u8	resource;
304 	u8	action;
305 	u8	id_type;
306 	u8	reserved;
307 	union {
308 		__be32	drc_index;
309 		__be32	drc_count;
310 		char	drc_name[1];
311 	} _drc_u;
312 };
313 
314 #define PSERIES_HP_ELOG_RESOURCE_CPU	1
315 #define PSERIES_HP_ELOG_RESOURCE_MEM	2
316 #define PSERIES_HP_ELOG_RESOURCE_SLOT	3
317 #define PSERIES_HP_ELOG_RESOURCE_PHB	4
318 
319 #define PSERIES_HP_ELOG_ACTION_ADD	1
320 #define PSERIES_HP_ELOG_ACTION_REMOVE	2
321 
322 #define PSERIES_HP_ELOG_ID_DRC_NAME	1
323 #define PSERIES_HP_ELOG_ID_DRC_INDEX	2
324 #define PSERIES_HP_ELOG_ID_DRC_COUNT	3
325 
326 struct pseries_errorlog *get_pseries_errorlog(struct rtas_error_log *log,
327 					      uint16_t section_id);
328 
329 /*
330  * This can be set by the rtas_flash module so that it can get called
331  * as the absolutely last thing before the kernel terminates.
332  */
333 extern void (*rtas_flash_term_hook)(int);
334 
335 extern struct rtas_t rtas;
336 
337 extern void enter_rtas(unsigned long);
338 extern int rtas_token(const char *service);
339 extern int rtas_service_present(const char *service);
340 extern int rtas_call(int token, int, int, int *, ...);
341 extern void rtas_restart(char *cmd);
342 extern void rtas_power_off(void);
343 extern void rtas_halt(void);
344 extern void rtas_os_term(char *str);
345 extern int rtas_get_sensor(int sensor, int index, int *state);
346 extern int rtas_get_sensor_fast(int sensor, int index, int *state);
347 extern int rtas_get_power_level(int powerdomain, int *level);
348 extern int rtas_set_power_level(int powerdomain, int level, int *setlevel);
349 extern bool rtas_indicator_present(int token, int *maxindex);
350 extern int rtas_set_indicator(int indicator, int index, int new_value);
351 extern int rtas_set_indicator_fast(int indicator, int index, int new_value);
352 extern void rtas_progress(char *s, unsigned short hex);
353 extern void rtas_initialize(void);
354 extern int rtas_suspend_cpu(struct rtas_suspend_me_data *data);
355 extern int rtas_suspend_last_cpu(struct rtas_suspend_me_data *data);
356 extern int rtas_online_cpus_mask(cpumask_var_t cpus);
357 extern int rtas_offline_cpus_mask(cpumask_var_t cpus);
358 extern int rtas_ibm_suspend_me(u64 handle);
359 
360 struct rtc_time;
361 extern unsigned long rtas_get_boot_time(void);
362 extern void rtas_get_rtc_time(struct rtc_time *rtc_time);
363 extern int rtas_set_rtc_time(struct rtc_time *rtc_time);
364 
365 extern unsigned int rtas_busy_delay_time(int status);
366 extern unsigned int rtas_busy_delay(int status);
367 
368 extern int early_init_dt_scan_rtas(unsigned long node,
369 		const char *uname, int depth, void *data);
370 
371 extern void pSeries_log_error(char *buf, unsigned int err_type, int fatal);
372 
373 #ifdef CONFIG_PPC_PSERIES
374 extern time64_t last_rtas_event;
375 extern int clobbering_unread_rtas_event(void);
376 extern int pseries_devicetree_update(s32 scope);
377 extern void post_mobility_fixup(void);
378 #else
clobbering_unread_rtas_event(void)379 static inline int clobbering_unread_rtas_event(void) { return 0; }
380 #endif
381 
382 #ifdef CONFIG_PPC_RTAS_DAEMON
383 extern void rtas_cancel_event_scan(void);
384 #else
rtas_cancel_event_scan(void)385 static inline void rtas_cancel_event_scan(void) { }
386 #endif
387 
388 /* Error types logged.  */
389 #define ERR_FLAG_ALREADY_LOGGED	0x0
390 #define ERR_FLAG_BOOT		0x1 	/* log was pulled from NVRAM on boot */
391 #define ERR_TYPE_RTAS_LOG	0x2	/* from rtas event-scan */
392 #define ERR_TYPE_KERNEL_PANIC	0x4	/* from die()/panic() */
393 #define ERR_TYPE_KERNEL_PANIC_GZ 0x8	/* ditto, compressed */
394 
395 /* All the types and not flags */
396 #define ERR_TYPE_MASK \
397 	(ERR_TYPE_RTAS_LOG | ERR_TYPE_KERNEL_PANIC | ERR_TYPE_KERNEL_PANIC_GZ)
398 
399 #define RTAS_DEBUG KERN_DEBUG "RTAS: "
400 
401 #define RTAS_ERROR_LOG_MAX 2048
402 
403 /*
404  * Return the firmware-specified size of the error log buffer
405  *  for all rtas calls that require an error buffer argument.
406  *  This includes 'check-exception' and 'rtas-last-error'.
407  */
408 extern int rtas_get_error_log_max(void);
409 
410 /* Event Scan Parameters */
411 #define EVENT_SCAN_ALL_EVENTS	0xf0000000
412 #define SURVEILLANCE_TOKEN	9000
413 #define LOG_NUMBER		64		/* must be a power of two */
414 #define LOG_NUMBER_MASK		(LOG_NUMBER-1)
415 
416 /* Some RTAS ops require a data buffer and that buffer must be < 4G.
417  * Rather than having a memory allocator, just use this buffer
418  * (get the lock first), make the RTAS call.  Copy the data instead
419  * of holding the buffer for long.
420  */
421 
422 #define RTAS_DATA_BUF_SIZE 4096
423 extern spinlock_t rtas_data_buf_lock;
424 extern char rtas_data_buf[RTAS_DATA_BUF_SIZE];
425 
426 /* RMO buffer reserved for user-space RTAS use */
427 extern unsigned long rtas_rmo_buf;
428 
429 #define GLOBAL_INTERRUPT_QUEUE 9005
430 
431 /**
432  * rtas_config_addr - Format a busno, devfn and reg for RTAS.
433  * @busno: The bus number.
434  * @devfn: The device and function number as encoded by PCI_DEVFN().
435  * @reg: The register number.
436  *
437  * This function encodes the given busno, devfn and register number as
438  * required for RTAS calls that take a "config_addr" parameter.
439  * See PAPR requirement 7.3.4-1 for more info.
440  */
rtas_config_addr(int busno,int devfn,int reg)441 static inline u32 rtas_config_addr(int busno, int devfn, int reg)
442 {
443 	return ((reg & 0xf00) << 20) | ((busno & 0xff) << 16) |
444 			(devfn << 8) | (reg & 0xff);
445 }
446 
447 extern void rtas_give_timebase(void);
448 extern void rtas_take_timebase(void);
449 
450 #ifdef CONFIG_PPC_RTAS
page_is_rtas_user_buf(unsigned long pfn)451 static inline int page_is_rtas_user_buf(unsigned long pfn)
452 {
453 	unsigned long paddr = (pfn << PAGE_SHIFT);
454 	if (paddr >= rtas_rmo_buf && paddr < (rtas_rmo_buf + RTAS_RMOBUF_MAX))
455 		return 1;
456 	return 0;
457 }
458 
459 /* Not the best place to put pSeries_coalesce_init, will be fixed when we
460  * move some of the rtas suspend-me stuff to pseries */
461 extern void pSeries_coalesce_init(void);
462 #else
page_is_rtas_user_buf(unsigned long pfn)463 static inline int page_is_rtas_user_buf(unsigned long pfn) { return 0;}
pSeries_coalesce_init(void)464 static inline void pSeries_coalesce_init(void) { }
465 #endif
466 
467 extern int call_rtas(const char *, int, int, unsigned long *, ...);
468 
469 #endif /* __KERNEL__ */
470 #endif /* _POWERPC_RTAS_H */
471