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 47typedef u32 rtas_arg_t; 48 49struct rtas_args { 50 u32 token; 51 u32 nargs; 52 u32 nret; 53 rtas_arg_t args[16]; 54 rtas_arg_t *rets; /* Pointer to return values in args[]. */ 55}; 56 57struct 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 66struct 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_POWERMGM_EVENTS 0x20000000 /* set bit 2 */ 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 148/* RTAS check-exception vector offset */ 149#define RTAS_VECTOR_EXTERNAL_INTERRUPT 0x500 150 151struct rtas_error_log { 152 unsigned long version:8; /* Architectural version */ 153 unsigned long severity:3; /* Severity level of error */ 154 unsigned long disposition:2; /* Degree of recovery */ 155 unsigned long extended:1; /* extended log present? */ 156 unsigned long /* reserved */ :2; /* Reserved for future use */ 157 unsigned long initiator:4; /* Initiator of event */ 158 unsigned long target:4; /* Target of failed operation */ 159 unsigned long type:8; /* General event or error*/ 160 unsigned long extended_log_length:32; /* length in bytes */ 161 unsigned char buffer[1]; 162}; 163 164/* 165 * This can be set by the rtas_flash module so that it can get called 166 * as the absolutely last thing before the kernel terminates. 167 */ 168extern void (*rtas_flash_term_hook)(int); 169 170extern struct rtas_t rtas; 171 172extern void enter_rtas(unsigned long); 173extern int rtas_token(const char *service); 174extern int rtas_service_present(const char *service); 175extern int rtas_call(int token, int, int, int *, ...); 176extern void rtas_restart(char *cmd); 177extern void rtas_power_off(void); 178extern void rtas_halt(void); 179extern void rtas_os_term(char *str); 180extern int rtas_get_sensor(int sensor, int index, int *state); 181extern int rtas_get_power_level(int powerdomain, int *level); 182extern int rtas_set_power_level(int powerdomain, int level, int *setlevel); 183extern bool rtas_indicator_present(int token, int *maxindex); 184extern int rtas_set_indicator(int indicator, int index, int new_value); 185extern int rtas_set_indicator_fast(int indicator, int index, int new_value); 186extern void rtas_progress(char *s, unsigned short hex); 187extern void rtas_initialize(void); 188extern int rtas_suspend_cpu(struct rtas_suspend_me_data *data); 189extern int rtas_suspend_last_cpu(struct rtas_suspend_me_data *data); 190 191struct rtc_time; 192extern unsigned long rtas_get_boot_time(void); 193extern void rtas_get_rtc_time(struct rtc_time *rtc_time); 194extern int rtas_set_rtc_time(struct rtc_time *rtc_time); 195 196extern unsigned int rtas_busy_delay_time(int status); 197extern unsigned int rtas_busy_delay(int status); 198 199extern int early_init_dt_scan_rtas(unsigned long node, 200 const char *uname, int depth, void *data); 201 202extern void pSeries_log_error(char *buf, unsigned int err_type, int fatal); 203 204/* Error types logged. */ 205#define ERR_FLAG_ALREADY_LOGGED 0x0 206#define ERR_FLAG_BOOT 0x1 /* log was pulled from NVRAM on boot */ 207#define ERR_TYPE_RTAS_LOG 0x2 /* from rtas event-scan */ 208#define ERR_TYPE_KERNEL_PANIC 0x4 /* from panic() */ 209 210/* All the types and not flags */ 211#define ERR_TYPE_MASK (ERR_TYPE_RTAS_LOG | ERR_TYPE_KERNEL_PANIC) 212 213#define RTAS_DEBUG KERN_DEBUG "RTAS: " 214 215#define RTAS_ERROR_LOG_MAX 2048 216 217/* 218 * Return the firmware-specified size of the error log buffer 219 * for all rtas calls that require an error buffer argument. 220 * This includes 'check-exception' and 'rtas-last-error'. 221 */ 222extern int rtas_get_error_log_max(void); 223 224/* Event Scan Parameters */ 225#define EVENT_SCAN_ALL_EVENTS 0xf0000000 226#define SURVEILLANCE_TOKEN 9000 227#define LOG_NUMBER 64 /* must be a power of two */ 228#define LOG_NUMBER_MASK (LOG_NUMBER-1) 229 230/* Some RTAS ops require a data buffer and that buffer must be < 4G. 231 * Rather than having a memory allocator, just use this buffer 232 * (get the lock first), make the RTAS call. Copy the data instead 233 * of holding the buffer for long. 234 */ 235 236#define RTAS_DATA_BUF_SIZE 4096 237extern spinlock_t rtas_data_buf_lock; 238extern char rtas_data_buf[RTAS_DATA_BUF_SIZE]; 239 240/* RMO buffer reserved for user-space RTAS use */ 241extern unsigned long rtas_rmo_buf; 242 243#define GLOBAL_INTERRUPT_QUEUE 9005 244 245/** 246 * rtas_config_addr - Format a busno, devfn and reg for RTAS. 247 * @busno: The bus number. 248 * @devfn: The device and function number as encoded by PCI_DEVFN(). 249 * @reg: The register number. 250 * 251 * This function encodes the given busno, devfn and register number as 252 * required for RTAS calls that take a "config_addr" parameter. 253 * See PAPR requirement 7.3.4-1 for more info. 254 */ 255static inline u32 rtas_config_addr(int busno, int devfn, int reg) 256{ 257 return ((reg & 0xf00) << 20) | ((busno & 0xff) << 16) | 258 (devfn << 8) | (reg & 0xff); 259} 260 261extern void __cpuinit rtas_give_timebase(void); 262extern void __cpuinit rtas_take_timebase(void); 263 264#endif /* __KERNEL__ */ 265#endif /* _POWERPC_RTAS_H */ 266