1 /* SPDX-License-Identifier: GPL-2.0-or-later */ 2 #ifndef _POWERPC_RTAS_H 3 #define _POWERPC_RTAS_H 4 #ifdef __KERNEL__ 5 6 #include <linux/spinlock.h> 7 #include <asm/page.h> 8 #include <asm/rtas-types.h> 9 #include <linux/time.h> 10 #include <linux/cpumask.h> 11 12 /* 13 * Definitions for talking to the RTAS on CHRP machines. 14 * 15 * Copyright (C) 2001 Peter Bergner 16 * Copyright (C) 2001 PPC 64 Team, IBM Corp 17 */ 18 19 #define RTAS_UNKNOWN_SERVICE (-1) 20 #define RTAS_INSTANTIATE_MAX (1ULL<<30) /* Don't instantiate rtas at/above this value */ 21 22 /* Memory set aside for sys_rtas to use with calls that need a work area. */ 23 #define RTAS_USER_REGION_SIZE (64 * 1024) 24 25 /* RTAS return status codes */ 26 #define RTAS_BUSY -2 /* RTAS Busy */ 27 #define RTAS_EXTENDED_DELAY_MIN 9900 28 #define RTAS_EXTENDED_DELAY_MAX 9905 29 30 /* statuses specific to ibm,suspend-me */ 31 #define RTAS_SUSPEND_ABORTED 9000 /* Suspension aborted */ 32 #define RTAS_NOT_SUSPENDABLE -9004 /* Partition not suspendable */ 33 #define RTAS_THREADS_ACTIVE -9005 /* Multiple processor threads active */ 34 #define RTAS_OUTSTANDING_COPROC -9006 /* Outstanding coprocessor operations */ 35 36 /* RTAS event classes */ 37 #define RTAS_INTERNAL_ERROR 0x80000000 /* set bit 0 */ 38 #define RTAS_EPOW_WARNING 0x40000000 /* set bit 1 */ 39 #define RTAS_HOTPLUG_EVENTS 0x10000000 /* set bit 3 */ 40 #define RTAS_IO_EVENTS 0x08000000 /* set bit 4 */ 41 #define RTAS_EVENT_SCAN_ALL_EVENTS 0xffffffff 42 43 /* RTAS event severity */ 44 #define RTAS_SEVERITY_FATAL 0x5 45 #define RTAS_SEVERITY_ERROR 0x4 46 #define RTAS_SEVERITY_ERROR_SYNC 0x3 47 #define RTAS_SEVERITY_WARNING 0x2 48 #define RTAS_SEVERITY_EVENT 0x1 49 #define RTAS_SEVERITY_NO_ERROR 0x0 50 51 /* RTAS event disposition */ 52 #define RTAS_DISP_FULLY_RECOVERED 0x0 53 #define RTAS_DISP_LIMITED_RECOVERY 0x1 54 #define RTAS_DISP_NOT_RECOVERED 0x2 55 56 /* RTAS event initiator */ 57 #define RTAS_INITIATOR_UNKNOWN 0x0 58 #define RTAS_INITIATOR_CPU 0x1 59 #define RTAS_INITIATOR_PCI 0x2 60 #define RTAS_INITIATOR_ISA 0x3 61 #define RTAS_INITIATOR_MEMORY 0x4 62 #define RTAS_INITIATOR_POWERMGM 0x5 63 64 /* RTAS event target */ 65 #define RTAS_TARGET_UNKNOWN 0x0 66 #define RTAS_TARGET_CPU 0x1 67 #define RTAS_TARGET_PCI 0x2 68 #define RTAS_TARGET_ISA 0x3 69 #define RTAS_TARGET_MEMORY 0x4 70 #define RTAS_TARGET_POWERMGM 0x5 71 72 /* RTAS event type */ 73 #define RTAS_TYPE_RETRY 0x01 74 #define RTAS_TYPE_TCE_ERR 0x02 75 #define RTAS_TYPE_INTERN_DEV_FAIL 0x03 76 #define RTAS_TYPE_TIMEOUT 0x04 77 #define RTAS_TYPE_DATA_PARITY 0x05 78 #define RTAS_TYPE_ADDR_PARITY 0x06 79 #define RTAS_TYPE_CACHE_PARITY 0x07 80 #define RTAS_TYPE_ADDR_INVALID 0x08 81 #define RTAS_TYPE_ECC_UNCORR 0x09 82 #define RTAS_TYPE_ECC_CORR 0x0a 83 #define RTAS_TYPE_EPOW 0x40 84 #define RTAS_TYPE_PLATFORM 0xE0 85 #define RTAS_TYPE_IO 0xE1 86 #define RTAS_TYPE_INFO 0xE2 87 #define RTAS_TYPE_DEALLOC 0xE3 88 #define RTAS_TYPE_DUMP 0xE4 89 #define RTAS_TYPE_HOTPLUG 0xE5 90 /* I don't add PowerMGM events right now, this is a different topic */ 91 #define RTAS_TYPE_PMGM_POWER_SW_ON 0x60 92 #define RTAS_TYPE_PMGM_POWER_SW_OFF 0x61 93 #define RTAS_TYPE_PMGM_LID_OPEN 0x62 94 #define RTAS_TYPE_PMGM_LID_CLOSE 0x63 95 #define RTAS_TYPE_PMGM_SLEEP_BTN 0x64 96 #define RTAS_TYPE_PMGM_WAKE_BTN 0x65 97 #define RTAS_TYPE_PMGM_BATTERY_WARN 0x66 98 #define RTAS_TYPE_PMGM_BATTERY_CRIT 0x67 99 #define RTAS_TYPE_PMGM_SWITCH_TO_BAT 0x68 100 #define RTAS_TYPE_PMGM_SWITCH_TO_AC 0x69 101 #define RTAS_TYPE_PMGM_KBD_OR_MOUSE 0x6a 102 #define RTAS_TYPE_PMGM_ENCLOS_OPEN 0x6b 103 #define RTAS_TYPE_PMGM_ENCLOS_CLOSED 0x6c 104 #define RTAS_TYPE_PMGM_RING_INDICATE 0x6d 105 #define RTAS_TYPE_PMGM_LAN_ATTENTION 0x6e 106 #define RTAS_TYPE_PMGM_TIME_ALARM 0x6f 107 #define RTAS_TYPE_PMGM_CONFIG_CHANGE 0x70 108 #define RTAS_TYPE_PMGM_SERVICE_PROC 0x71 109 /* Platform Resource Reassignment Notification */ 110 #define RTAS_TYPE_PRRN 0xA0 111 112 /* RTAS check-exception vector offset */ 113 #define RTAS_VECTOR_EXTERNAL_INTERRUPT 0x500 114 115 static inline uint8_t rtas_error_severity(const struct rtas_error_log *elog) 116 { 117 return (elog->byte1 & 0xE0) >> 5; 118 } 119 120 static inline uint8_t rtas_error_disposition(const struct rtas_error_log *elog) 121 { 122 return (elog->byte1 & 0x18) >> 3; 123 } 124 125 static inline 126 void rtas_set_disposition_recovered(struct rtas_error_log *elog) 127 { 128 elog->byte1 &= ~0x18; 129 elog->byte1 |= (RTAS_DISP_FULLY_RECOVERED << 3); 130 } 131 132 static inline uint8_t rtas_error_extended(const struct rtas_error_log *elog) 133 { 134 return (elog->byte1 & 0x04) >> 2; 135 } 136 137 static inline uint8_t rtas_error_initiator(const struct rtas_error_log *elog) 138 { 139 return (elog->byte2 & 0xf0) >> 4; 140 } 141 142 #define rtas_error_type(x) ((x)->byte3) 143 144 static inline 145 uint32_t rtas_error_extended_log_length(const struct rtas_error_log *elog) 146 { 147 return be32_to_cpu(elog->extended_log_length); 148 } 149 150 #define RTAS_V6EXT_LOG_FORMAT_EVENT_LOG 14 151 152 #define RTAS_V6EXT_COMPANY_ID_IBM (('I' << 24) | ('B' << 16) | ('M' << 8)) 153 154 static 155 inline uint8_t rtas_ext_event_log_format(struct rtas_ext_event_log_v6 *ext_log) 156 { 157 return ext_log->byte2 & 0x0F; 158 } 159 160 static 161 inline uint32_t rtas_ext_event_company_id(struct rtas_ext_event_log_v6 *ext_log) 162 { 163 return be32_to_cpu(ext_log->company_id); 164 } 165 166 /* pSeries event log format */ 167 168 /* Two bytes ASCII section IDs */ 169 #define PSERIES_ELOG_SECT_ID_PRIV_HDR (('P' << 8) | 'H') 170 #define PSERIES_ELOG_SECT_ID_USER_HDR (('U' << 8) | 'H') 171 #define PSERIES_ELOG_SECT_ID_PRIMARY_SRC (('P' << 8) | 'S') 172 #define PSERIES_ELOG_SECT_ID_EXTENDED_UH (('E' << 8) | 'H') 173 #define PSERIES_ELOG_SECT_ID_FAILING_MTMS (('M' << 8) | 'T') 174 #define PSERIES_ELOG_SECT_ID_SECONDARY_SRC (('S' << 8) | 'S') 175 #define PSERIES_ELOG_SECT_ID_DUMP_LOCATOR (('D' << 8) | 'H') 176 #define PSERIES_ELOG_SECT_ID_FW_ERROR (('S' << 8) | 'W') 177 #define PSERIES_ELOG_SECT_ID_IMPACT_PART_ID (('L' << 8) | 'P') 178 #define PSERIES_ELOG_SECT_ID_LOGIC_RESOURCE_ID (('L' << 8) | 'R') 179 #define PSERIES_ELOG_SECT_ID_HMC_ID (('H' << 8) | 'M') 180 #define PSERIES_ELOG_SECT_ID_EPOW (('E' << 8) | 'P') 181 #define PSERIES_ELOG_SECT_ID_IO_EVENT (('I' << 8) | 'E') 182 #define PSERIES_ELOG_SECT_ID_MANUFACT_INFO (('M' << 8) | 'I') 183 #define PSERIES_ELOG_SECT_ID_CALL_HOME (('C' << 8) | 'H') 184 #define PSERIES_ELOG_SECT_ID_USER_DEF (('U' << 8) | 'D') 185 #define PSERIES_ELOG_SECT_ID_HOTPLUG (('H' << 8) | 'P') 186 #define PSERIES_ELOG_SECT_ID_MCE (('M' << 8) | 'C') 187 188 static 189 inline uint16_t pseries_errorlog_id(struct pseries_errorlog *sect) 190 { 191 return be16_to_cpu(sect->id); 192 } 193 194 static 195 inline uint16_t pseries_errorlog_length(struct pseries_errorlog *sect) 196 { 197 return be16_to_cpu(sect->length); 198 } 199 200 #define PSERIES_HP_ELOG_RESOURCE_CPU 1 201 #define PSERIES_HP_ELOG_RESOURCE_MEM 2 202 #define PSERIES_HP_ELOG_RESOURCE_SLOT 3 203 #define PSERIES_HP_ELOG_RESOURCE_PHB 4 204 #define PSERIES_HP_ELOG_RESOURCE_PMEM 6 205 206 #define PSERIES_HP_ELOG_ACTION_ADD 1 207 #define PSERIES_HP_ELOG_ACTION_REMOVE 2 208 209 #define PSERIES_HP_ELOG_ID_DRC_NAME 1 210 #define PSERIES_HP_ELOG_ID_DRC_INDEX 2 211 #define PSERIES_HP_ELOG_ID_DRC_COUNT 3 212 #define PSERIES_HP_ELOG_ID_DRC_IC 4 213 214 struct pseries_errorlog *get_pseries_errorlog(struct rtas_error_log *log, 215 uint16_t section_id); 216 217 /* 218 * This can be set by the rtas_flash module so that it can get called 219 * as the absolutely last thing before the kernel terminates. 220 */ 221 extern void (*rtas_flash_term_hook)(int); 222 223 extern struct rtas_t rtas; 224 225 extern int rtas_token(const char *service); 226 extern int rtas_service_present(const char *service); 227 extern int rtas_call(int token, int, int, int *, ...); 228 void rtas_call_unlocked(struct rtas_args *args, int token, int nargs, 229 int nret, ...); 230 extern void __noreturn rtas_restart(char *cmd); 231 extern void rtas_power_off(void); 232 extern void __noreturn rtas_halt(void); 233 extern void rtas_os_term(char *str); 234 void rtas_activate_firmware(void); 235 extern int rtas_get_sensor(int sensor, int index, int *state); 236 extern int rtas_get_sensor_fast(int sensor, int index, int *state); 237 extern int rtas_get_power_level(int powerdomain, int *level); 238 extern int rtas_set_power_level(int powerdomain, int level, int *setlevel); 239 extern bool rtas_indicator_present(int token, int *maxindex); 240 extern int rtas_set_indicator(int indicator, int index, int new_value); 241 extern int rtas_set_indicator_fast(int indicator, int index, int new_value); 242 extern void rtas_progress(char *s, unsigned short hex); 243 int rtas_ibm_suspend_me(int *fw_status); 244 245 struct rtc_time; 246 extern time64_t rtas_get_boot_time(void); 247 extern void rtas_get_rtc_time(struct rtc_time *rtc_time); 248 extern int rtas_set_rtc_time(struct rtc_time *rtc_time); 249 250 extern unsigned int rtas_busy_delay_time(int status); 251 bool rtas_busy_delay(int status); 252 253 extern int early_init_dt_scan_rtas(unsigned long node, 254 const char *uname, int depth, void *data); 255 256 extern void pSeries_log_error(char *buf, unsigned int err_type, int fatal); 257 258 #ifdef CONFIG_PPC_PSERIES 259 extern time64_t last_rtas_event; 260 extern int clobbering_unread_rtas_event(void); 261 extern void post_mobility_fixup(void); 262 int rtas_syscall_dispatch_ibm_suspend_me(u64 handle); 263 #else 264 static inline int clobbering_unread_rtas_event(void) { return 0; } 265 static inline int rtas_syscall_dispatch_ibm_suspend_me(u64 handle) 266 { 267 return -EINVAL; 268 } 269 #endif 270 271 #ifdef CONFIG_PPC_RTAS_DAEMON 272 extern void rtas_cancel_event_scan(void); 273 #else 274 static inline void rtas_cancel_event_scan(void) { } 275 #endif 276 277 /* Error types logged. */ 278 #define ERR_FLAG_ALREADY_LOGGED 0x0 279 #define ERR_FLAG_BOOT 0x1 /* log was pulled from NVRAM on boot */ 280 #define ERR_TYPE_RTAS_LOG 0x2 /* from rtas event-scan */ 281 #define ERR_TYPE_KERNEL_PANIC 0x4 /* from die()/panic() */ 282 #define ERR_TYPE_KERNEL_PANIC_GZ 0x8 /* ditto, compressed */ 283 284 /* All the types and not flags */ 285 #define ERR_TYPE_MASK \ 286 (ERR_TYPE_RTAS_LOG | ERR_TYPE_KERNEL_PANIC | ERR_TYPE_KERNEL_PANIC_GZ) 287 288 #define RTAS_DEBUG KERN_DEBUG "RTAS: " 289 290 #define RTAS_ERROR_LOG_MAX 2048 291 292 /* 293 * Return the firmware-specified size of the error log buffer 294 * for all rtas calls that require an error buffer argument. 295 * This includes 'check-exception' and 'rtas-last-error'. 296 */ 297 extern int rtas_get_error_log_max(void); 298 299 /* Event Scan Parameters */ 300 #define EVENT_SCAN_ALL_EVENTS 0xf0000000 301 #define SURVEILLANCE_TOKEN 9000 302 #define LOG_NUMBER 64 /* must be a power of two */ 303 #define LOG_NUMBER_MASK (LOG_NUMBER-1) 304 305 /* Some RTAS ops require a data buffer and that buffer must be < 4G. 306 * Rather than having a memory allocator, just use this buffer 307 * (get the lock first), make the RTAS call. Copy the data instead 308 * of holding the buffer for long. 309 */ 310 311 #define RTAS_DATA_BUF_SIZE 4096 312 extern spinlock_t rtas_data_buf_lock; 313 extern char rtas_data_buf[RTAS_DATA_BUF_SIZE]; 314 315 /* RMO buffer reserved for user-space RTAS use */ 316 extern unsigned long rtas_rmo_buf; 317 318 #define GLOBAL_INTERRUPT_QUEUE 9005 319 320 /** 321 * rtas_config_addr - Format a busno, devfn and reg for RTAS. 322 * @busno: The bus number. 323 * @devfn: The device and function number as encoded by PCI_DEVFN(). 324 * @reg: The register number. 325 * 326 * This function encodes the given busno, devfn and register number as 327 * required for RTAS calls that take a "config_addr" parameter. 328 * See PAPR requirement 7.3.4-1 for more info. 329 */ 330 static inline u32 rtas_config_addr(int busno, int devfn, int reg) 331 { 332 return ((reg & 0xf00) << 20) | ((busno & 0xff) << 16) | 333 (devfn << 8) | (reg & 0xff); 334 } 335 336 extern void rtas_give_timebase(void); 337 extern void rtas_take_timebase(void); 338 339 #ifdef CONFIG_PPC_RTAS 340 static inline int page_is_rtas_user_buf(unsigned long pfn) 341 { 342 unsigned long paddr = (pfn << PAGE_SHIFT); 343 if (paddr >= rtas_rmo_buf && paddr < (rtas_rmo_buf + RTAS_USER_REGION_SIZE)) 344 return 1; 345 return 0; 346 } 347 348 /* Not the best place to put pSeries_coalesce_init, will be fixed when we 349 * move some of the rtas suspend-me stuff to pseries */ 350 extern void pSeries_coalesce_init(void); 351 void rtas_initialize(void); 352 #else 353 static inline int page_is_rtas_user_buf(unsigned long pfn) { return 0;} 354 static inline void pSeries_coalesce_init(void) { } 355 static inline void rtas_initialize(void) { } 356 #endif 357 358 extern int call_rtas(const char *, int, int, unsigned long *, ...); 359 360 #ifdef CONFIG_HV_PERF_CTRS 361 void read_24x7_sys_info(void); 362 #else 363 static inline void read_24x7_sys_info(void) { } 364 #endif 365 366 #endif /* __KERNEL__ */ 367 #endif /* _POWERPC_RTAS_H */ 368