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 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) 21 #define RTAS_INSTANTIATE_MAX (1ULL<<30) /* Don't instantiate rtas at/above this value */ 22 23 /* Buffer size for ppc_rtas system call. */ 24 #define RTAS_RMOBUF_MAX (64 * 1024) 25 26 /* RTAS return status codes */ 27 #define RTAS_NOT_SUSPENDABLE -9004 28 #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 47 typedef __be32 rtas_arg_t; 48 49 struct rtas_args { 50 __be32 token; 51 __be32 nargs; 52 __be32 nret; 53 rtas_arg_t args[16]; 54 rtas_arg_t *rets; /* Pointer to return values in args[]. */ 55 }; 56 57 struct rtas_t { 58 unsigned long entry; /* physical address pointer */ 59 unsigned long base; /* physical address pointer */ 60 unsigned long size; 61 arch_spinlock_t lock; 62 struct rtas_args args; 63 struct device_node *dev; /* virtual address pointer */ 64 }; 65 66 struct 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 74 /* RTAS event classes */ 75 #define RTAS_INTERNAL_ERROR 0x80000000 /* set bit 0 */ 76 #define RTAS_EPOW_WARNING 0x40000000 /* set bit 1 */ 77 #define RTAS_HOTPLUG_EVENTS 0x10000000 /* set bit 3 */ 78 #define RTAS_IO_EVENTS 0x08000000 /* set bit 4 */ 79 #define RTAS_EVENT_SCAN_ALL_EVENTS 0xffffffff 80 81 /* RTAS event severity */ 82 #define RTAS_SEVERITY_FATAL 0x5 83 #define RTAS_SEVERITY_ERROR 0x4 84 #define RTAS_SEVERITY_ERROR_SYNC 0x3 85 #define RTAS_SEVERITY_WARNING 0x2 86 #define RTAS_SEVERITY_EVENT 0x1 87 #define RTAS_SEVERITY_NO_ERROR 0x0 88 89 /* RTAS event disposition */ 90 #define RTAS_DISP_FULLY_RECOVERED 0x0 91 #define RTAS_DISP_LIMITED_RECOVERY 0x1 92 #define RTAS_DISP_NOT_RECOVERED 0x2 93 94 /* RTAS event initiator */ 95 #define RTAS_INITIATOR_UNKNOWN 0x0 96 #define RTAS_INITIATOR_CPU 0x1 97 #define RTAS_INITIATOR_PCI 0x2 98 #define RTAS_INITIATOR_ISA 0x3 99 #define RTAS_INITIATOR_MEMORY 0x4 100 #define RTAS_INITIATOR_POWERMGM 0x5 101 102 /* RTAS event target */ 103 #define RTAS_TARGET_UNKNOWN 0x0 104 #define RTAS_TARGET_CPU 0x1 105 #define RTAS_TARGET_PCI 0x2 106 #define RTAS_TARGET_ISA 0x3 107 #define RTAS_TARGET_MEMORY 0x4 108 #define RTAS_TARGET_POWERMGM 0x5 109 110 /* RTAS event type */ 111 #define RTAS_TYPE_RETRY 0x01 112 #define RTAS_TYPE_TCE_ERR 0x02 113 #define RTAS_TYPE_INTERN_DEV_FAIL 0x03 114 #define RTAS_TYPE_TIMEOUT 0x04 115 #define RTAS_TYPE_DATA_PARITY 0x05 116 #define RTAS_TYPE_ADDR_PARITY 0x06 117 #define RTAS_TYPE_CACHE_PARITY 0x07 118 #define RTAS_TYPE_ADDR_INVALID 0x08 119 #define RTAS_TYPE_ECC_UNCORR 0x09 120 #define RTAS_TYPE_ECC_CORR 0x0a 121 #define RTAS_TYPE_EPOW 0x40 122 #define RTAS_TYPE_PLATFORM 0xE0 123 #define RTAS_TYPE_IO 0xE1 124 #define RTAS_TYPE_INFO 0xE2 125 #define RTAS_TYPE_DEALLOC 0xE3 126 #define RTAS_TYPE_DUMP 0xE4 127 /* I don't add PowerMGM events right now, this is a different topic */ 128 #define RTAS_TYPE_PMGM_POWER_SW_ON 0x60 129 #define RTAS_TYPE_PMGM_POWER_SW_OFF 0x61 130 #define RTAS_TYPE_PMGM_LID_OPEN 0x62 131 #define RTAS_TYPE_PMGM_LID_CLOSE 0x63 132 #define RTAS_TYPE_PMGM_SLEEP_BTN 0x64 133 #define RTAS_TYPE_PMGM_WAKE_BTN 0x65 134 #define RTAS_TYPE_PMGM_BATTERY_WARN 0x66 135 #define RTAS_TYPE_PMGM_BATTERY_CRIT 0x67 136 #define RTAS_TYPE_PMGM_SWITCH_TO_BAT 0x68 137 #define RTAS_TYPE_PMGM_SWITCH_TO_AC 0x69 138 #define RTAS_TYPE_PMGM_KBD_OR_MOUSE 0x6a 139 #define RTAS_TYPE_PMGM_ENCLOS_OPEN 0x6b 140 #define RTAS_TYPE_PMGM_ENCLOS_CLOSED 0x6c 141 #define RTAS_TYPE_PMGM_RING_INDICATE 0x6d 142 #define RTAS_TYPE_PMGM_LAN_ATTENTION 0x6e 143 #define RTAS_TYPE_PMGM_TIME_ALARM 0x6f 144 #define RTAS_TYPE_PMGM_CONFIG_CHANGE 0x70 145 #define RTAS_TYPE_PMGM_SERVICE_PROC 0x71 146 /* Platform Resource Reassignment Notification */ 147 #define RTAS_TYPE_PRRN 0xA0 148 149 /* RTAS check-exception vector offset */ 150 #define RTAS_VECTOR_EXTERNAL_INTERRUPT 0x500 151 152 struct rtas_error_log { 153 /* Byte 0 */ 154 uint8_t byte0; /* Architectural version */ 155 156 /* Byte 1 */ 157 uint8_t byte1; 158 /* XXXXXXXX 159 * XXX 3: Severity level of error 160 * XX 2: Degree of recovery 161 * X 1: Extended log present? 162 * XX 2: Reserved 163 */ 164 165 /* Byte 2 */ 166 uint8_t byte2; 167 /* XXXXXXXX 168 * XXXX 4: Initiator of event 169 * XXXX 4: Target of failed operation 170 */ 171 uint8_t byte3; /* General event or error*/ 172 __be32 extended_log_length; /* length in bytes */ 173 unsigned char buffer[1]; /* Start of extended log */ 174 /* Variable length. */ 175 }; 176 177 static inline uint8_t rtas_error_severity(const struct rtas_error_log *elog) 178 { 179 return (elog->byte1 & 0xE0) >> 5; 180 } 181 182 static inline uint8_t rtas_error_disposition(const struct rtas_error_log *elog) 183 { 184 return (elog->byte1 & 0x18) >> 3; 185 } 186 187 static inline uint8_t rtas_error_extended(const struct rtas_error_log *elog) 188 { 189 return (elog->byte1 & 0x04) >> 2; 190 } 191 192 #define rtas_error_type(x) ((x)->byte3) 193 194 static inline 195 uint32_t rtas_error_extended_log_length(const struct rtas_error_log *elog) 196 { 197 return be32_to_cpu(elog->extended_log_length); 198 } 199 200 #define RTAS_V6EXT_LOG_FORMAT_EVENT_LOG 14 201 202 #define RTAS_V6EXT_COMPANY_ID_IBM (('I' << 24) | ('B' << 16) | ('M' << 8)) 203 204 /* RTAS general extended event log, Version 6. The extended log starts 205 * from "buffer" field of struct rtas_error_log defined above. 206 */ 207 struct rtas_ext_event_log_v6 { 208 /* Byte 0 */ 209 uint8_t byte0; 210 /* XXXXXXXX 211 * X 1: Log valid 212 * X 1: Unrecoverable error 213 * X 1: Recoverable (correctable or successfully retried) 214 * X 1: Bypassed unrecoverable error (degraded operation) 215 * X 1: Predictive error 216 * X 1: "New" log (always 1 for data returned from RTAS) 217 * X 1: Big Endian 218 * X 1: Reserved 219 */ 220 221 /* Byte 1 */ 222 uint8_t byte1; /* reserved */ 223 224 /* Byte 2 */ 225 uint8_t byte2; 226 /* XXXXXXXX 227 * X 1: Set to 1 (indicating log is in PowerPC format) 228 * XXX 3: Reserved 229 * XXXX 4: Log format used for bytes 12-2047 230 */ 231 232 /* Byte 3 */ 233 uint8_t byte3; /* reserved */ 234 /* Byte 4-11 */ 235 uint8_t reserved[8]; /* reserved */ 236 /* Byte 12-15 */ 237 __be32 company_id; /* Company ID of the company */ 238 /* that defines the format for */ 239 /* the vendor specific log type */ 240 /* Byte 16-end of log */ 241 uint8_t vendor_log[1]; /* Start of vendor specific log */ 242 /* Variable length. */ 243 }; 244 245 static 246 inline uint8_t rtas_ext_event_log_format(struct rtas_ext_event_log_v6 *ext_log) 247 { 248 return ext_log->byte2 & 0x0F; 249 } 250 251 static 252 inline uint32_t rtas_ext_event_company_id(struct rtas_ext_event_log_v6 *ext_log) 253 { 254 return be32_to_cpu(ext_log->company_id); 255 } 256 257 /* pSeries event log format */ 258 259 /* Two bytes ASCII section IDs */ 260 #define PSERIES_ELOG_SECT_ID_PRIV_HDR (('P' << 8) | 'H') 261 #define PSERIES_ELOG_SECT_ID_USER_HDR (('U' << 8) | 'H') 262 #define PSERIES_ELOG_SECT_ID_PRIMARY_SRC (('P' << 8) | 'S') 263 #define PSERIES_ELOG_SECT_ID_EXTENDED_UH (('E' << 8) | 'H') 264 #define PSERIES_ELOG_SECT_ID_FAILING_MTMS (('M' << 8) | 'T') 265 #define PSERIES_ELOG_SECT_ID_SECONDARY_SRC (('S' << 8) | 'S') 266 #define PSERIES_ELOG_SECT_ID_DUMP_LOCATOR (('D' << 8) | 'H') 267 #define PSERIES_ELOG_SECT_ID_FW_ERROR (('S' << 8) | 'W') 268 #define PSERIES_ELOG_SECT_ID_IMPACT_PART_ID (('L' << 8) | 'P') 269 #define PSERIES_ELOG_SECT_ID_LOGIC_RESOURCE_ID (('L' << 8) | 'R') 270 #define PSERIES_ELOG_SECT_ID_HMC_ID (('H' << 8) | 'M') 271 #define PSERIES_ELOG_SECT_ID_EPOW (('E' << 8) | 'P') 272 #define PSERIES_ELOG_SECT_ID_IO_EVENT (('I' << 8) | 'E') 273 #define PSERIES_ELOG_SECT_ID_MANUFACT_INFO (('M' << 8) | 'I') 274 #define PSERIES_ELOG_SECT_ID_CALL_HOME (('C' << 8) | 'H') 275 #define PSERIES_ELOG_SECT_ID_USER_DEF (('U' << 8) | 'D') 276 277 /* Vendor specific Platform Event Log Format, Version 6, section header */ 278 struct pseries_errorlog { 279 __be16 id; /* 0x00 2-byte ASCII section ID */ 280 __be16 length; /* 0x02 Section length in bytes */ 281 uint8_t version; /* 0x04 Section version */ 282 uint8_t subtype; /* 0x05 Section subtype */ 283 __be16 creator_component; /* 0x06 Creator component ID */ 284 uint8_t data[]; /* 0x08 Start of section data */ 285 }; 286 287 static 288 inline uint16_t pseries_errorlog_id(struct pseries_errorlog *sect) 289 { 290 return be16_to_cpu(sect->id); 291 } 292 293 static 294 inline uint16_t pseries_errorlog_length(struct pseries_errorlog *sect) 295 { 296 return be16_to_cpu(sect->length); 297 } 298 299 struct pseries_errorlog *get_pseries_errorlog(struct rtas_error_log *log, 300 uint16_t section_id); 301 302 /* 303 * This can be set by the rtas_flash module so that it can get called 304 * as the absolutely last thing before the kernel terminates. 305 */ 306 extern void (*rtas_flash_term_hook)(int); 307 308 extern struct rtas_t rtas; 309 310 extern void enter_rtas(unsigned long); 311 extern int rtas_token(const char *service); 312 extern int rtas_service_present(const char *service); 313 extern int rtas_call(int token, int, int, int *, ...); 314 extern void rtas_restart(char *cmd); 315 extern void rtas_power_off(void); 316 extern void rtas_halt(void); 317 extern void rtas_os_term(char *str); 318 extern int rtas_get_sensor(int sensor, int index, int *state); 319 extern int rtas_get_power_level(int powerdomain, int *level); 320 extern int rtas_set_power_level(int powerdomain, int level, int *setlevel); 321 extern bool rtas_indicator_present(int token, int *maxindex); 322 extern int rtas_set_indicator(int indicator, int index, int new_value); 323 extern int rtas_set_indicator_fast(int indicator, int index, int new_value); 324 extern void rtas_progress(char *s, unsigned short hex); 325 extern void rtas_initialize(void); 326 extern int rtas_suspend_cpu(struct rtas_suspend_me_data *data); 327 extern int rtas_suspend_last_cpu(struct rtas_suspend_me_data *data); 328 extern int rtas_online_cpus_mask(cpumask_var_t cpus); 329 extern int rtas_offline_cpus_mask(cpumask_var_t cpus); 330 extern int rtas_ibm_suspend_me(u64 handle, int *vasi_return); 331 332 struct rtc_time; 333 extern unsigned long rtas_get_boot_time(void); 334 extern void rtas_get_rtc_time(struct rtc_time *rtc_time); 335 extern int rtas_set_rtc_time(struct rtc_time *rtc_time); 336 337 extern unsigned int rtas_busy_delay_time(int status); 338 extern unsigned int rtas_busy_delay(int status); 339 340 extern int early_init_dt_scan_rtas(unsigned long node, 341 const char *uname, int depth, void *data); 342 343 extern void pSeries_log_error(char *buf, unsigned int err_type, int fatal); 344 345 #ifdef CONFIG_PPC_PSERIES 346 extern int pseries_devicetree_update(s32 scope); 347 extern void post_mobility_fixup(void); 348 #endif 349 350 #ifdef CONFIG_PPC_RTAS_DAEMON 351 extern void rtas_cancel_event_scan(void); 352 #else 353 static inline void rtas_cancel_event_scan(void) { } 354 #endif 355 356 /* Error types logged. */ 357 #define ERR_FLAG_ALREADY_LOGGED 0x0 358 #define ERR_FLAG_BOOT 0x1 /* log was pulled from NVRAM on boot */ 359 #define ERR_TYPE_RTAS_LOG 0x2 /* from rtas event-scan */ 360 #define ERR_TYPE_KERNEL_PANIC 0x4 /* from die()/panic() */ 361 #define ERR_TYPE_KERNEL_PANIC_GZ 0x8 /* ditto, compressed */ 362 363 /* All the types and not flags */ 364 #define ERR_TYPE_MASK \ 365 (ERR_TYPE_RTAS_LOG | ERR_TYPE_KERNEL_PANIC | ERR_TYPE_KERNEL_PANIC_GZ) 366 367 #define RTAS_DEBUG KERN_DEBUG "RTAS: " 368 369 #define RTAS_ERROR_LOG_MAX 2048 370 371 /* 372 * Return the firmware-specified size of the error log buffer 373 * for all rtas calls that require an error buffer argument. 374 * This includes 'check-exception' and 'rtas-last-error'. 375 */ 376 extern int rtas_get_error_log_max(void); 377 378 /* Event Scan Parameters */ 379 #define EVENT_SCAN_ALL_EVENTS 0xf0000000 380 #define SURVEILLANCE_TOKEN 9000 381 #define LOG_NUMBER 64 /* must be a power of two */ 382 #define LOG_NUMBER_MASK (LOG_NUMBER-1) 383 384 /* Some RTAS ops require a data buffer and that buffer must be < 4G. 385 * Rather than having a memory allocator, just use this buffer 386 * (get the lock first), make the RTAS call. Copy the data instead 387 * of holding the buffer for long. 388 */ 389 390 #define RTAS_DATA_BUF_SIZE 4096 391 extern spinlock_t rtas_data_buf_lock; 392 extern char rtas_data_buf[RTAS_DATA_BUF_SIZE]; 393 394 /* RMO buffer reserved for user-space RTAS use */ 395 extern unsigned long rtas_rmo_buf; 396 397 #define GLOBAL_INTERRUPT_QUEUE 9005 398 399 /** 400 * rtas_config_addr - Format a busno, devfn and reg for RTAS. 401 * @busno: The bus number. 402 * @devfn: The device and function number as encoded by PCI_DEVFN(). 403 * @reg: The register number. 404 * 405 * This function encodes the given busno, devfn and register number as 406 * required for RTAS calls that take a "config_addr" parameter. 407 * See PAPR requirement 7.3.4-1 for more info. 408 */ 409 static inline u32 rtas_config_addr(int busno, int devfn, int reg) 410 { 411 return ((reg & 0xf00) << 20) | ((busno & 0xff) << 16) | 412 (devfn << 8) | (reg & 0xff); 413 } 414 415 extern void rtas_give_timebase(void); 416 extern void rtas_take_timebase(void); 417 418 #ifdef CONFIG_PPC_RTAS 419 static inline int page_is_rtas_user_buf(unsigned long pfn) 420 { 421 unsigned long paddr = (pfn << PAGE_SHIFT); 422 if (paddr >= rtas_rmo_buf && paddr < (rtas_rmo_buf + RTAS_RMOBUF_MAX)) 423 return 1; 424 return 0; 425 } 426 427 /* Not the best place to put pSeries_coalesce_init, will be fixed when we 428 * move some of the rtas suspend-me stuff to pseries */ 429 extern void pSeries_coalesce_init(void); 430 #else 431 static inline int page_is_rtas_user_buf(unsigned long pfn) { return 0;} 432 static inline void pSeries_coalesce_init(void) { } 433 #endif 434 435 extern int call_rtas(const char *, int, int, unsigned long *, ...); 436 437 #endif /* __KERNEL__ */ 438 #endif /* _POWERPC_RTAS_H */ 439