1 #ifndef _PPC64_RTAS_H
2 #define _PPC64_RTAS_H
3
4 #include <linux/spinlock.h>
5 #include <asm/page.h>
6
7 /*
8 * Definitions for talking to the RTAS on CHRP machines.
9 *
10 * Copyright (C) 2001 Peter Bergner
11 * Copyright (C) 2001 PPC 64 Team, IBM Corp
12 *
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.
17 */
18
19 #define RTAS_UNKNOWN_SERVICE (-1)
20 #define RTAS_INSTANTIATE_MAX (1UL<<30) /* Don't instantiate rtas at/above this value */
21
22 /* Error inject defines */
23 #define ERRINJCT_TOKEN_LEN 24 /* Max length of an error inject token */
24 #define MAX_ERRINJCT_TOKENS 8 /* Max # tokens. */
25 #define WORKSPACE_SIZE 1024
26
27 /*
28 * In general to call RTAS use rtas_token("string") to lookup
29 * an RTAS token for the given string (e.g. "event-scan").
30 * To actually perform the call use
31 * ret = rtas_call(token, n_in, n_out, ...)
32 * Where n_in is the number of input parameters and
33 * n_out is the number of output parameters
34 *
35 * If the "string" is invalid on this system, RTAS_UNKOWN_SERVICE
36 * will be returned as a token. rtas_call() does look for this
37 * token and error out gracefully so rtas_call(rtas_token("str"), ...)
38 * may be safely used for one-shot calls to RTAS.
39 *
40 */
41
42 typedef u32 rtas_arg_t;
43
44 struct rtas_args {
45 u32 token;
46 u32 nargs;
47 u32 nret;
48 rtas_arg_t args[16];
49 #if 0
50 spinlock_t lock;
51 #endif
52 rtas_arg_t *rets; /* Pointer to return values in args[]. */
53 };
54
55 struct rtas_t {
56 unsigned long entry; /* physical address pointer */
57 unsigned long base; /* physical address pointer */
58 unsigned long size;
59 spinlock_t lock;
60
61 struct device_node *dev; /* virtual address pointer */
62 };
63
64 /* Event classes */
65 #define RTAS_INTERNAL_ERROR 0x80000000 /* set bit 0 */
66 #define RTAS_EPOW_WARNING 0x40000000 /* set bit 1 */
67 #define RTAS_POWERMGM_EVENTS 0x20000000 /* set bit 2 */
68 #define RTAS_HOTPLUG_EVENTS 0x10000000 /* set bit 3 */
69 #define RTAS_EVENT_SCAN_ALL_EVENTS 0xf0000000
70
71 /* event-scan returns */
72 #define SEVERITY_FATAL 0x5
73 #define SEVERITY_ERROR 0x4
74 #define SEVERITY_ERROR_SYNC 0x3
75 #define SEVERITY_WARNING 0x2
76 #define SEVERITY_EVENT 0x1
77 #define SEVERITY_NO_ERROR 0x0
78 #define DISP_FULLY_RECOVERED 0x0
79 #define DISP_LIMITED_RECOVERY 0x1
80 #define DISP_NOT_RECOVERED 0x2
81 #define PART_PRESENT 0x0
82 #define PART_NOT_PRESENT 0x1
83 #define INITIATOR_UNKNOWN 0x0
84 #define INITIATOR_CPU 0x1
85 #define INITIATOR_PCI 0x2
86 #define INITIATOR_ISA 0x3
87 #define INITIATOR_MEMORY 0x4
88 #define INITIATOR_POWERMGM 0x5
89 #define TARGET_UNKNOWN 0x0
90 #define TARGET_CPU 0x1
91 #define TARGET_PCI 0x2
92 #define TARGET_ISA 0x3
93 #define TARGET_MEMORY 0x4
94 #define TARGET_POWERMGM 0x5
95 #define TYPE_RETRY 0x01
96 #define TYPE_TCE_ERR 0x02
97 #define TYPE_INTERN_DEV_FAIL 0x03
98 #define TYPE_TIMEOUT 0x04
99 #define TYPE_DATA_PARITY 0x05
100 #define TYPE_ADDR_PARITY 0x06
101 #define TYPE_CACHE_PARITY 0x07
102 #define TYPE_ADDR_INVALID 0x08
103 #define TYPE_ECC_UNCORR 0x09
104 #define TYPE_ECC_CORR 0x0a
105 #define TYPE_EPOW 0x40
106 /* I don't add PowerMGM events right now, this is a different topic */
107 #define TYPE_PMGM_POWER_SW_ON 0x60
108 #define TYPE_PMGM_POWER_SW_OFF 0x61
109 #define TYPE_PMGM_LID_OPEN 0x62
110 #define TYPE_PMGM_LID_CLOSE 0x63
111 #define TYPE_PMGM_SLEEP_BTN 0x64
112 #define TYPE_PMGM_WAKE_BTN 0x65
113 #define TYPE_PMGM_BATTERY_WARN 0x66
114 #define TYPE_PMGM_BATTERY_CRIT 0x67
115 #define TYPE_PMGM_SWITCH_TO_BAT 0x68
116 #define TYPE_PMGM_SWITCH_TO_AC 0x69
117 #define TYPE_PMGM_KBD_OR_MOUSE 0x6a
118 #define TYPE_PMGM_ENCLOS_OPEN 0x6b
119 #define TYPE_PMGM_ENCLOS_CLOSED 0x6c
120 #define TYPE_PMGM_RING_INDICATE 0x6d
121 #define TYPE_PMGM_LAN_ATTENTION 0x6e
122 #define TYPE_PMGM_TIME_ALARM 0x6f
123 #define TYPE_PMGM_CONFIG_CHANGE 0x70
124 #define TYPE_PMGM_SERVICE_PROC 0x71
125
126 struct rtas_error_log {
127 unsigned long version:8; /* Architectural version */
128 unsigned long severity:3; /* Severity level of error */
129 unsigned long disposition:2; /* Degree of recovery */
130 unsigned long extended:1; /* extended log present? */
131 unsigned long /* reserved */ :2; /* Reserved for future use */
132 unsigned long initiator:4; /* Initiator of event */
133 unsigned long target:4; /* Target of failed operation */
134 unsigned long type:8; /* General event or error*/
135 unsigned long extended_log_length:32; /* length in bytes */
136 unsigned char buffer[1]; /* allocated by klimit bump */
137 };
138
139 struct errinjct_token {
140 char * name;
141 int value;
142 };
143
144 struct flash_block {
145 char *data;
146 unsigned long length;
147 };
148
149 /* This struct is very similar but not identical to
150 * that needed by the rtas flash update.
151 * All we need to do for rtas is rewrite num_blocks
152 * into a version/length and translate the pointers
153 * to absolute.
154 */
155 #define FLASH_BLOCKS_PER_NODE ((PAGE_SIZE - 16) / sizeof(struct flash_block))
156 struct flash_block_list {
157 unsigned long num_blocks;
158 struct flash_block_list *next;
159 struct flash_block blocks[FLASH_BLOCKS_PER_NODE];
160 };
161 struct flash_block_list_header { /* just the header of flash_block_list */
162 unsigned long num_blocks;
163 struct flash_block_list *next;
164 };
165 extern struct flash_block_list_header rtas_firmware_flash_list;
166
167 extern struct rtas_t rtas;
168
169 extern void enter_rtas(struct rtas_args *);
170 extern int rtas_token(const char *service);
171 extern long rtas_call(int token, int, int, unsigned long *, ...);
172 extern void phys_call_rtas(int, int, int, ...);
173 extern void phys_call_rtas_display_status(char);
174 extern void call_rtas_display_status(char);
175 extern void rtas_restart(char *cmd);
176 extern void rtas_power_off(void);
177 extern void rtas_halt(void);
178 extern int rtas_errinjct_open(void);
179 extern int rtas_errinjct(unsigned int, char *, char *);
180 extern int rtas_errinjct_close(unsigned int);
181
182 extern struct proc_dir_entry *rtas_proc_dir;
183 extern struct errinjct_token ei_token_list[MAX_ERRINJCT_TOKENS];
184
185 extern void pSeries_log_error(char *buf, unsigned int err_type, int fatal);
186
187 /* Error types logged. */
188 #define ERR_FLAG_ALREADY_LOGGED 0x0
189 #define ERR_FLAG_BOOT 0x1 /* log was pulled from NVRAM on boot */
190 #define ERR_TYPE_RTAS_LOG 0x2 /* from rtas event-scan */
191 #define ERR_TYPE_KERNEL_PANIC 0x4 /* from panic() */
192
193 /* All the types and not flags */
194 #define ERR_TYPE_MASK (ERR_TYPE_RTAS_LOG | ERR_TYPE_KERNEL_PANIC)
195
196 #define RTAS_ERR KERN_ERR "RTAS: "
197
198 #define RTAS_ERROR_LOG_MAX 1024
199
200
201 /* Event Scan Parameters */
202 #define EVENT_SCAN_ALL_EVENTS 0xf0000000
203 #define SURVEILLANCE_TOKEN 9000
204 #define LOG_NUMBER 64 /* must be a power of two */
205 #define LOG_NUMBER_MASK (LOG_NUMBER-1)
206
207 /* Given an RTAS status code of 9900..9905 compute the hinted delay */
208 unsigned int rtas_extended_busy_delay_time(int status);
rtas_is_extended_busy(int status)209 static inline int rtas_is_extended_busy(int status)
210 {
211 return status >= 9900 && status <= 9909;
212 }
213
214 /* Some RTAS ops require a data buffer and that buffer must be < 4G.
215 * Rather than having a memory allocator, just use this buffer
216 * (get the lock first), make the RTAS call. Copy the data instead
217 * of holding the buffer for long.
218 */
219 #define RTAS_DATA_BUF_SIZE 4096
220 extern spinlock_t rtas_data_buf_lock;
221 extern char rtas_data_buf[RTAS_DATA_BUF_SIZE];
222
223 #endif /* _PPC64_RTAS_H */
224