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