1b8b572e1SStephen Rothwell #ifndef _POWERPC_RTAS_H 2b8b572e1SStephen Rothwell #define _POWERPC_RTAS_H 3b8b572e1SStephen Rothwell #ifdef __KERNEL__ 4b8b572e1SStephen Rothwell 5b8b572e1SStephen Rothwell #include <linux/spinlock.h> 6b8b572e1SStephen Rothwell #include <asm/page.h> 7b8b572e1SStephen Rothwell 8b8b572e1SStephen Rothwell /* 9b8b572e1SStephen Rothwell * Definitions for talking to the RTAS on CHRP machines. 10b8b572e1SStephen Rothwell * 11b8b572e1SStephen Rothwell * Copyright (C) 2001 Peter Bergner 12b8b572e1SStephen Rothwell * Copyright (C) 2001 PPC 64 Team, IBM Corp 13b8b572e1SStephen Rothwell * 14b8b572e1SStephen Rothwell * This program is free software; you can redistribute it and/or 15b8b572e1SStephen Rothwell * modify it under the terms of the GNU General Public License 16b8b572e1SStephen Rothwell * as published by the Free Software Foundation; either version 17b8b572e1SStephen Rothwell * 2 of the License, or (at your option) any later version. 18b8b572e1SStephen Rothwell */ 19b8b572e1SStephen Rothwell 20b8b572e1SStephen Rothwell #define RTAS_UNKNOWN_SERVICE (-1) 21fe333321SIngo Molnar #define RTAS_INSTANTIATE_MAX (1ULL<<30) /* Don't instantiate rtas at/above this value */ 22b8b572e1SStephen Rothwell 23b8b572e1SStephen Rothwell /* Buffer size for ppc_rtas system call. */ 24b8b572e1SStephen Rothwell #define RTAS_RMOBUF_MAX (64 * 1024) 25b8b572e1SStephen Rothwell 26b8b572e1SStephen Rothwell /* RTAS return status codes */ 27b8b572e1SStephen Rothwell #define RTAS_NOT_SUSPENDABLE -9004 28b8b572e1SStephen Rothwell #define RTAS_BUSY -2 /* RTAS Busy */ 29b8b572e1SStephen Rothwell #define RTAS_EXTENDED_DELAY_MIN 9900 30b8b572e1SStephen Rothwell #define RTAS_EXTENDED_DELAY_MAX 9905 31b8b572e1SStephen Rothwell 32b8b572e1SStephen Rothwell /* 33b8b572e1SStephen Rothwell * In general to call RTAS use rtas_token("string") to lookup 34b8b572e1SStephen Rothwell * an RTAS token for the given string (e.g. "event-scan"). 35b8b572e1SStephen Rothwell * To actually perform the call use 36b8b572e1SStephen Rothwell * ret = rtas_call(token, n_in, n_out, ...) 37b8b572e1SStephen Rothwell * Where n_in is the number of input parameters and 38b8b572e1SStephen Rothwell * n_out is the number of output parameters 39b8b572e1SStephen Rothwell * 40b8b572e1SStephen Rothwell * If the "string" is invalid on this system, RTAS_UNKNOWN_SERVICE 41b8b572e1SStephen Rothwell * will be returned as a token. rtas_call() does look for this 42b8b572e1SStephen Rothwell * token and error out gracefully so rtas_call(rtas_token("str"), ...) 43b8b572e1SStephen Rothwell * may be safely used for one-shot calls to RTAS. 44b8b572e1SStephen Rothwell * 45b8b572e1SStephen Rothwell */ 46b8b572e1SStephen Rothwell 47b8b572e1SStephen Rothwell typedef u32 rtas_arg_t; 48b8b572e1SStephen Rothwell 49b8b572e1SStephen Rothwell struct rtas_args { 50b8b572e1SStephen Rothwell u32 token; 51b8b572e1SStephen Rothwell u32 nargs; 52b8b572e1SStephen Rothwell u32 nret; 53b8b572e1SStephen Rothwell rtas_arg_t args[16]; 54b8b572e1SStephen Rothwell rtas_arg_t *rets; /* Pointer to return values in args[]. */ 55b8b572e1SStephen Rothwell }; 56b8b572e1SStephen Rothwell 57b8b572e1SStephen Rothwell struct rtas_t { 58b8b572e1SStephen Rothwell unsigned long entry; /* physical address pointer */ 59b8b572e1SStephen Rothwell unsigned long base; /* physical address pointer */ 60b8b572e1SStephen Rothwell unsigned long size; 61445c8951SThomas Gleixner arch_spinlock_t lock; 62b8b572e1SStephen Rothwell struct rtas_args args; 63b8b572e1SStephen Rothwell struct device_node *dev; /* virtual address pointer */ 64b8b572e1SStephen Rothwell }; 65b8b572e1SStephen Rothwell 668fe93f8dSBrian King struct rtas_suspend_me_data { 678fe93f8dSBrian King atomic_t working; /* number of cpus accessing this struct */ 688fe93f8dSBrian King atomic_t done; 698fe93f8dSBrian King int token; /* ibm,suspend-me */ 708fe93f8dSBrian King atomic_t error; 718fe93f8dSBrian King struct completion *complete; /* wait on this until working == 0 */ 728fe93f8dSBrian King }; 738fe93f8dSBrian King 74b8b572e1SStephen Rothwell /* RTAS event classes */ 75b8b572e1SStephen Rothwell #define RTAS_INTERNAL_ERROR 0x80000000 /* set bit 0 */ 76b8b572e1SStephen Rothwell #define RTAS_EPOW_WARNING 0x40000000 /* set bit 1 */ 77b8b572e1SStephen Rothwell #define RTAS_POWERMGM_EVENTS 0x20000000 /* set bit 2 */ 78b8b572e1SStephen Rothwell #define RTAS_HOTPLUG_EVENTS 0x10000000 /* set bit 3 */ 794a9f9506SAnton Blanchard #define RTAS_IO_EVENTS 0x08000000 /* set bit 4 */ 804a9f9506SAnton Blanchard #define RTAS_EVENT_SCAN_ALL_EVENTS 0xffffffff 81b8b572e1SStephen Rothwell 82b8b572e1SStephen Rothwell /* RTAS event severity */ 83b8b572e1SStephen Rothwell #define RTAS_SEVERITY_FATAL 0x5 84b8b572e1SStephen Rothwell #define RTAS_SEVERITY_ERROR 0x4 85b8b572e1SStephen Rothwell #define RTAS_SEVERITY_ERROR_SYNC 0x3 86b8b572e1SStephen Rothwell #define RTAS_SEVERITY_WARNING 0x2 87b8b572e1SStephen Rothwell #define RTAS_SEVERITY_EVENT 0x1 88b8b572e1SStephen Rothwell #define RTAS_SEVERITY_NO_ERROR 0x0 89b8b572e1SStephen Rothwell 90b8b572e1SStephen Rothwell /* RTAS event disposition */ 91b8b572e1SStephen Rothwell #define RTAS_DISP_FULLY_RECOVERED 0x0 92b8b572e1SStephen Rothwell #define RTAS_DISP_LIMITED_RECOVERY 0x1 93b8b572e1SStephen Rothwell #define RTAS_DISP_NOT_RECOVERED 0x2 94b8b572e1SStephen Rothwell 95b8b572e1SStephen Rothwell /* RTAS event initiator */ 96b8b572e1SStephen Rothwell #define RTAS_INITIATOR_UNKNOWN 0x0 97b8b572e1SStephen Rothwell #define RTAS_INITIATOR_CPU 0x1 98b8b572e1SStephen Rothwell #define RTAS_INITIATOR_PCI 0x2 99b8b572e1SStephen Rothwell #define RTAS_INITIATOR_ISA 0x3 100b8b572e1SStephen Rothwell #define RTAS_INITIATOR_MEMORY 0x4 101b8b572e1SStephen Rothwell #define RTAS_INITIATOR_POWERMGM 0x5 102b8b572e1SStephen Rothwell 103b8b572e1SStephen Rothwell /* RTAS event target */ 104b8b572e1SStephen Rothwell #define RTAS_TARGET_UNKNOWN 0x0 105b8b572e1SStephen Rothwell #define RTAS_TARGET_CPU 0x1 106b8b572e1SStephen Rothwell #define RTAS_TARGET_PCI 0x2 107b8b572e1SStephen Rothwell #define RTAS_TARGET_ISA 0x3 108b8b572e1SStephen Rothwell #define RTAS_TARGET_MEMORY 0x4 109b8b572e1SStephen Rothwell #define RTAS_TARGET_POWERMGM 0x5 110b8b572e1SStephen Rothwell 111b8b572e1SStephen Rothwell /* RTAS event type */ 112b8b572e1SStephen Rothwell #define RTAS_TYPE_RETRY 0x01 113b8b572e1SStephen Rothwell #define RTAS_TYPE_TCE_ERR 0x02 114b8b572e1SStephen Rothwell #define RTAS_TYPE_INTERN_DEV_FAIL 0x03 115b8b572e1SStephen Rothwell #define RTAS_TYPE_TIMEOUT 0x04 116b8b572e1SStephen Rothwell #define RTAS_TYPE_DATA_PARITY 0x05 117b8b572e1SStephen Rothwell #define RTAS_TYPE_ADDR_PARITY 0x06 118b8b572e1SStephen Rothwell #define RTAS_TYPE_CACHE_PARITY 0x07 119b8b572e1SStephen Rothwell #define RTAS_TYPE_ADDR_INVALID 0x08 120b8b572e1SStephen Rothwell #define RTAS_TYPE_ECC_UNCORR 0x09 121b8b572e1SStephen Rothwell #define RTAS_TYPE_ECC_CORR 0x0a 122b8b572e1SStephen Rothwell #define RTAS_TYPE_EPOW 0x40 123b8b572e1SStephen Rothwell #define RTAS_TYPE_PLATFORM 0xE0 124b8b572e1SStephen Rothwell #define RTAS_TYPE_IO 0xE1 125b8b572e1SStephen Rothwell #define RTAS_TYPE_INFO 0xE2 126b8b572e1SStephen Rothwell #define RTAS_TYPE_DEALLOC 0xE3 127b8b572e1SStephen Rothwell #define RTAS_TYPE_DUMP 0xE4 128b8b572e1SStephen Rothwell /* I don't add PowerMGM events right now, this is a different topic */ 129b8b572e1SStephen Rothwell #define RTAS_TYPE_PMGM_POWER_SW_ON 0x60 130b8b572e1SStephen Rothwell #define RTAS_TYPE_PMGM_POWER_SW_OFF 0x61 131b8b572e1SStephen Rothwell #define RTAS_TYPE_PMGM_LID_OPEN 0x62 132b8b572e1SStephen Rothwell #define RTAS_TYPE_PMGM_LID_CLOSE 0x63 133b8b572e1SStephen Rothwell #define RTAS_TYPE_PMGM_SLEEP_BTN 0x64 134b8b572e1SStephen Rothwell #define RTAS_TYPE_PMGM_WAKE_BTN 0x65 135b8b572e1SStephen Rothwell #define RTAS_TYPE_PMGM_BATTERY_WARN 0x66 136b8b572e1SStephen Rothwell #define RTAS_TYPE_PMGM_BATTERY_CRIT 0x67 137b8b572e1SStephen Rothwell #define RTAS_TYPE_PMGM_SWITCH_TO_BAT 0x68 138b8b572e1SStephen Rothwell #define RTAS_TYPE_PMGM_SWITCH_TO_AC 0x69 139b8b572e1SStephen Rothwell #define RTAS_TYPE_PMGM_KBD_OR_MOUSE 0x6a 140b8b572e1SStephen Rothwell #define RTAS_TYPE_PMGM_ENCLOS_OPEN 0x6b 141b8b572e1SStephen Rothwell #define RTAS_TYPE_PMGM_ENCLOS_CLOSED 0x6c 142b8b572e1SStephen Rothwell #define RTAS_TYPE_PMGM_RING_INDICATE 0x6d 143b8b572e1SStephen Rothwell #define RTAS_TYPE_PMGM_LAN_ATTENTION 0x6e 144b8b572e1SStephen Rothwell #define RTAS_TYPE_PMGM_TIME_ALARM 0x6f 145b8b572e1SStephen Rothwell #define RTAS_TYPE_PMGM_CONFIG_CHANGE 0x70 146b8b572e1SStephen Rothwell #define RTAS_TYPE_PMGM_SERVICE_PROC 0x71 147b8b572e1SStephen Rothwell 148b08e281bSMark Nelson /* RTAS check-exception vector offset */ 149b08e281bSMark Nelson #define RTAS_VECTOR_EXTERNAL_INTERRUPT 0x500 150b08e281bSMark Nelson 151b8b572e1SStephen Rothwell struct rtas_error_log { 152b8b572e1SStephen Rothwell unsigned long version:8; /* Architectural version */ 153b8b572e1SStephen Rothwell unsigned long severity:3; /* Severity level of error */ 154b8b572e1SStephen Rothwell unsigned long disposition:2; /* Degree of recovery */ 155b8b572e1SStephen Rothwell unsigned long extended:1; /* extended log present? */ 156b8b572e1SStephen Rothwell unsigned long /* reserved */ :2; /* Reserved for future use */ 157b8b572e1SStephen Rothwell unsigned long initiator:4; /* Initiator of event */ 158b8b572e1SStephen Rothwell unsigned long target:4; /* Target of failed operation */ 159b8b572e1SStephen Rothwell unsigned long type:8; /* General event or error*/ 160b8b572e1SStephen Rothwell unsigned long extended_log_length:32; /* length in bytes */ 161b8b572e1SStephen Rothwell unsigned char buffer[1]; 162b8b572e1SStephen Rothwell }; 163b8b572e1SStephen Rothwell 164b8b572e1SStephen Rothwell /* 165b8b572e1SStephen Rothwell * This can be set by the rtas_flash module so that it can get called 166b8b572e1SStephen Rothwell * as the absolutely last thing before the kernel terminates. 167b8b572e1SStephen Rothwell */ 168b8b572e1SStephen Rothwell extern void (*rtas_flash_term_hook)(int); 169b8b572e1SStephen Rothwell 170b8b572e1SStephen Rothwell extern struct rtas_t rtas; 171b8b572e1SStephen Rothwell 172b8b572e1SStephen Rothwell extern void enter_rtas(unsigned long); 173b8b572e1SStephen Rothwell extern int rtas_token(const char *service); 174b8b572e1SStephen Rothwell extern int rtas_service_present(const char *service); 175b8b572e1SStephen Rothwell extern int rtas_call(int token, int, int, int *, ...); 176b8b572e1SStephen Rothwell extern void rtas_restart(char *cmd); 177b8b572e1SStephen Rothwell extern void rtas_power_off(void); 178b8b572e1SStephen Rothwell extern void rtas_halt(void); 179b8b572e1SStephen Rothwell extern void rtas_os_term(char *str); 180b8b572e1SStephen Rothwell extern int rtas_get_sensor(int sensor, int index, int *state); 181b8b572e1SStephen Rothwell extern int rtas_get_power_level(int powerdomain, int *level); 182b8b572e1SStephen Rothwell extern int rtas_set_power_level(int powerdomain, int level, int *setlevel); 183edc72ac4SNathan Lynch extern bool rtas_indicator_present(int token, int *maxindex); 184b8b572e1SStephen Rothwell extern int rtas_set_indicator(int indicator, int index, int new_value); 185b8b572e1SStephen Rothwell extern int rtas_set_indicator_fast(int indicator, int index, int new_value); 186b8b572e1SStephen Rothwell extern void rtas_progress(char *s, unsigned short hex); 187b8b572e1SStephen Rothwell extern void rtas_initialize(void); 1888fe93f8dSBrian King extern int rtas_suspend_cpu(struct rtas_suspend_me_data *data); 1898fe93f8dSBrian King extern int rtas_suspend_last_cpu(struct rtas_suspend_me_data *data); 190b8b572e1SStephen Rothwell 191b8b572e1SStephen Rothwell struct rtc_time; 192b8b572e1SStephen Rothwell extern unsigned long rtas_get_boot_time(void); 193b8b572e1SStephen Rothwell extern void rtas_get_rtc_time(struct rtc_time *rtc_time); 194b8b572e1SStephen Rothwell extern int rtas_set_rtc_time(struct rtc_time *rtc_time); 195b8b572e1SStephen Rothwell 196b8b572e1SStephen Rothwell extern unsigned int rtas_busy_delay_time(int status); 197b8b572e1SStephen Rothwell extern unsigned int rtas_busy_delay(int status); 198b8b572e1SStephen Rothwell 199b8b572e1SStephen Rothwell extern int early_init_dt_scan_rtas(unsigned long node, 200b8b572e1SStephen Rothwell const char *uname, int depth, void *data); 201b8b572e1SStephen Rothwell 202b8b572e1SStephen Rothwell extern void pSeries_log_error(char *buf, unsigned int err_type, int fatal); 203b8b572e1SStephen Rothwell 204b8b572e1SStephen Rothwell /* Error types logged. */ 205b8b572e1SStephen Rothwell #define ERR_FLAG_ALREADY_LOGGED 0x0 206b8b572e1SStephen Rothwell #define ERR_FLAG_BOOT 0x1 /* log was pulled from NVRAM on boot */ 207b8b572e1SStephen Rothwell #define ERR_TYPE_RTAS_LOG 0x2 /* from rtas event-scan */ 208b8b572e1SStephen Rothwell #define ERR_TYPE_KERNEL_PANIC 0x4 /* from panic() */ 209b8b572e1SStephen Rothwell 210b8b572e1SStephen Rothwell /* All the types and not flags */ 211b8b572e1SStephen Rothwell #define ERR_TYPE_MASK (ERR_TYPE_RTAS_LOG | ERR_TYPE_KERNEL_PANIC) 212b8b572e1SStephen Rothwell 213b8b572e1SStephen Rothwell #define RTAS_DEBUG KERN_DEBUG "RTAS: " 214b8b572e1SStephen Rothwell 215b8b572e1SStephen Rothwell #define RTAS_ERROR_LOG_MAX 2048 216b8b572e1SStephen Rothwell 217b8b572e1SStephen Rothwell /* 218b8b572e1SStephen Rothwell * Return the firmware-specified size of the error log buffer 219b8b572e1SStephen Rothwell * for all rtas calls that require an error buffer argument. 220b8b572e1SStephen Rothwell * This includes 'check-exception' and 'rtas-last-error'. 221b8b572e1SStephen Rothwell */ 222b8b572e1SStephen Rothwell extern int rtas_get_error_log_max(void); 223b8b572e1SStephen Rothwell 224b8b572e1SStephen Rothwell /* Event Scan Parameters */ 225b8b572e1SStephen Rothwell #define EVENT_SCAN_ALL_EVENTS 0xf0000000 226b8b572e1SStephen Rothwell #define SURVEILLANCE_TOKEN 9000 227b8b572e1SStephen Rothwell #define LOG_NUMBER 64 /* must be a power of two */ 228b8b572e1SStephen Rothwell #define LOG_NUMBER_MASK (LOG_NUMBER-1) 229b8b572e1SStephen Rothwell 230b8b572e1SStephen Rothwell /* Some RTAS ops require a data buffer and that buffer must be < 4G. 231b8b572e1SStephen Rothwell * Rather than having a memory allocator, just use this buffer 232b8b572e1SStephen Rothwell * (get the lock first), make the RTAS call. Copy the data instead 233b8b572e1SStephen Rothwell * of holding the buffer for long. 234b8b572e1SStephen Rothwell */ 235b8b572e1SStephen Rothwell 236b8b572e1SStephen Rothwell #define RTAS_DATA_BUF_SIZE 4096 237b8b572e1SStephen Rothwell extern spinlock_t rtas_data_buf_lock; 238b8b572e1SStephen Rothwell extern char rtas_data_buf[RTAS_DATA_BUF_SIZE]; 239b8b572e1SStephen Rothwell 240b8b572e1SStephen Rothwell /* RMO buffer reserved for user-space RTAS use */ 241b8b572e1SStephen Rothwell extern unsigned long rtas_rmo_buf; 242b8b572e1SStephen Rothwell 243b8b572e1SStephen Rothwell #define GLOBAL_INTERRUPT_QUEUE 9005 244b8b572e1SStephen Rothwell 245b8b572e1SStephen Rothwell /** 246b8b572e1SStephen Rothwell * rtas_config_addr - Format a busno, devfn and reg for RTAS. 247b8b572e1SStephen Rothwell * @busno: The bus number. 248b8b572e1SStephen Rothwell * @devfn: The device and function number as encoded by PCI_DEVFN(). 249b8b572e1SStephen Rothwell * @reg: The register number. 250b8b572e1SStephen Rothwell * 251b8b572e1SStephen Rothwell * This function encodes the given busno, devfn and register number as 252b8b572e1SStephen Rothwell * required for RTAS calls that take a "config_addr" parameter. 253b8b572e1SStephen Rothwell * See PAPR requirement 7.3.4-1 for more info. 254b8b572e1SStephen Rothwell */ 255b8b572e1SStephen Rothwell static inline u32 rtas_config_addr(int busno, int devfn, int reg) 256b8b572e1SStephen Rothwell { 257b8b572e1SStephen Rothwell return ((reg & 0xf00) << 20) | ((busno & 0xff) << 16) | 258b8b572e1SStephen Rothwell (devfn << 8) | (reg & 0xff); 259b8b572e1SStephen Rothwell } 260b8b572e1SStephen Rothwell 261c4007a2fSBenjamin Herrenschmidt extern void __cpuinit rtas_give_timebase(void); 262c4007a2fSBenjamin Herrenschmidt extern void __cpuinit rtas_take_timebase(void); 263c4007a2fSBenjamin Herrenschmidt 264b8b572e1SStephen Rothwell #endif /* __KERNEL__ */ 265b8b572e1SStephen Rothwell #endif /* _POWERPC_RTAS_H */ 266