include/asm/rtas.h

0001 /* SPDX-License-Identifier: GPL-2.0-or-later */
0002 #ifndef _POWERPC_RTAS_H
0003 #define _POWERPC_RTAS_H
0004 #ifdef __KERNEL__
0005
0006 #include <linux/spinlock.h>
0007 #include <asm/page.h>
0008 #include <asm/rtas-types.h>
0009 #include <linux/time.h>
0010 #include <linux/cpumask.h>
0011
0012 /*
0013  * Definitions for talking to the RTAS on CHRP machines.
0014  *
0015  * Copyright (C) 2001 Peter Bergner
0016  * Copyright (C) 2001 PPC 64 Team, IBM Corp
0017  */
0018
0019 #define RTAS_UNKNOWN_SERVICE (-1)
0020 #define RTAS_INSTANTIATE_MAX (1ULL<<30) /* Don't instantiate rtas at/above this value */
0021
0022 /* Memory set aside for sys_rtas to use with calls that need a work area. */
0023 #define RTAS_USER_REGION_SIZE (64 * 1024)
0024
0025 /* RTAS return status codes */
0026 #define RTAS_BUSY       -2    /* RTAS Busy */
0027 #define RTAS_EXTENDED_DELAY_MIN 9900
0028 #define RTAS_EXTENDED_DELAY_MAX 9905
0029
0030 /* statuses specific to ibm,suspend-me */
0031 #define RTAS_SUSPEND_ABORTED     9000 /* Suspension aborted */
0032 #define RTAS_NOT_SUSPENDABLE    -9004 /* Partition not suspendable */
0033 #define RTAS_THREADS_ACTIVE     -9005 /* Multiple processor threads active */
0034 #define RTAS_OUTSTANDING_COPROC -9006 /* Outstanding coprocessor operations */
0035
0036 /*
0037  * In general to call RTAS use rtas_token("string") to lookup
0038  * an RTAS token for the given string (e.g. "event-scan").
0039  * To actually perform the call use
0040  *    ret = rtas_call(token, n_in, n_out, ...)
0041  * Where n_in is the number of input parameters and
0042  *       n_out is the number of output parameters
0043  *
0044  * If the "string" is invalid on this system, RTAS_UNKNOWN_SERVICE
0045  * will be returned as a token.  rtas_call() does look for this
0046  * token and error out gracefully so rtas_call(rtas_token("str"), ...)
0047  * may be safely used for one-shot calls to RTAS.
0048  *
0049  */
0050
0051 /* RTAS event classes */
0052 #define RTAS_INTERNAL_ERROR     0x80000000 /* set bit 0 */
0053 #define RTAS_EPOW_WARNING       0x40000000 /* set bit 1 */
0054 #define RTAS_HOTPLUG_EVENTS     0x10000000 /* set bit 3 */
0055 #define RTAS_IO_EVENTS          0x08000000 /* set bit 4 */
0056 #define RTAS_EVENT_SCAN_ALL_EVENTS  0xffffffff
0057
0058 /* RTAS event severity */
0059 #define RTAS_SEVERITY_FATAL     0x5
0060 #define RTAS_SEVERITY_ERROR     0x4
0061 #define RTAS_SEVERITY_ERROR_SYNC    0x3
0062 #define RTAS_SEVERITY_WARNING       0x2
0063 #define RTAS_SEVERITY_EVENT     0x1
0064 #define RTAS_SEVERITY_NO_ERROR      0x0
0065
0066 /* RTAS event disposition */
0067 #define RTAS_DISP_FULLY_RECOVERED   0x0
0068 #define RTAS_DISP_LIMITED_RECOVERY  0x1
0069 #define RTAS_DISP_NOT_RECOVERED     0x2
0070
0071 /* RTAS event initiator */
0072 #define RTAS_INITIATOR_UNKNOWN      0x0
0073 #define RTAS_INITIATOR_CPU      0x1
0074 #define RTAS_INITIATOR_PCI      0x2
0075 #define RTAS_INITIATOR_ISA      0x3
0076 #define RTAS_INITIATOR_MEMORY       0x4
0077 #define RTAS_INITIATOR_POWERMGM     0x5
0078
0079 /* RTAS event target */
0080 #define RTAS_TARGET_UNKNOWN     0x0
0081 #define RTAS_TARGET_CPU         0x1
0082 #define RTAS_TARGET_PCI         0x2
0083 #define RTAS_TARGET_ISA         0x3
0084 #define RTAS_TARGET_MEMORY      0x4
0085 #define RTAS_TARGET_POWERMGM        0x5
0086
0087 /* RTAS event type */
0088 #define RTAS_TYPE_RETRY         0x01
0089 #define RTAS_TYPE_TCE_ERR       0x02
0090 #define RTAS_TYPE_INTERN_DEV_FAIL   0x03
0091 #define RTAS_TYPE_TIMEOUT       0x04
0092 #define RTAS_TYPE_DATA_PARITY       0x05
0093 #define RTAS_TYPE_ADDR_PARITY       0x06
0094 #define RTAS_TYPE_CACHE_PARITY      0x07
0095 #define RTAS_TYPE_ADDR_INVALID      0x08
0096 #define RTAS_TYPE_ECC_UNCORR        0x09
0097 #define RTAS_TYPE_ECC_CORR      0x0a
0098 #define RTAS_TYPE_EPOW          0x40
0099 #define RTAS_TYPE_PLATFORM      0xE0
0100 #define RTAS_TYPE_IO            0xE1
0101 #define RTAS_TYPE_INFO          0xE2
0102 #define RTAS_TYPE_DEALLOC       0xE3
0103 #define RTAS_TYPE_DUMP          0xE4
0104 #define RTAS_TYPE_HOTPLUG       0xE5
0105 /* I don't add PowerMGM events right now, this is a different topic */
0106 #define RTAS_TYPE_PMGM_POWER_SW_ON  0x60
0107 #define RTAS_TYPE_PMGM_POWER_SW_OFF 0x61
0108 #define RTAS_TYPE_PMGM_LID_OPEN     0x62
0109 #define RTAS_TYPE_PMGM_LID_CLOSE    0x63
0110 #define RTAS_TYPE_PMGM_SLEEP_BTN    0x64
0111 #define RTAS_TYPE_PMGM_WAKE_BTN     0x65
0112 #define RTAS_TYPE_PMGM_BATTERY_WARN 0x66
0113 #define RTAS_TYPE_PMGM_BATTERY_CRIT 0x67
0114 #define RTAS_TYPE_PMGM_SWITCH_TO_BAT    0x68
0115 #define RTAS_TYPE_PMGM_SWITCH_TO_AC 0x69
0116 #define RTAS_TYPE_PMGM_KBD_OR_MOUSE 0x6a
0117 #define RTAS_TYPE_PMGM_ENCLOS_OPEN  0x6b
0118 #define RTAS_TYPE_PMGM_ENCLOS_CLOSED    0x6c
0119 #define RTAS_TYPE_PMGM_RING_INDICATE    0x6d
0120 #define RTAS_TYPE_PMGM_LAN_ATTENTION    0x6e
0121 #define RTAS_TYPE_PMGM_TIME_ALARM   0x6f
0122 #define RTAS_TYPE_PMGM_CONFIG_CHANGE    0x70
0123 #define RTAS_TYPE_PMGM_SERVICE_PROC 0x71
0124 /* Platform Resource Reassignment Notification */
0125 #define RTAS_TYPE_PRRN          0xA0
0126
0127 /* RTAS check-exception vector offset */
0128 #define RTAS_VECTOR_EXTERNAL_INTERRUPT  0x500
0129
0130 static inline uint8_t rtas_error_severity(const struct rtas_error_log *elog)
0131 {
0132     return (elog->byte1 & 0xE0) >> 5;
0133 }
0134
0135 static inline uint8_t rtas_error_disposition(const struct rtas_error_log *elog)
0136 {
0137     return (elog->byte1 & 0x18) >> 3;
0138 }
0139
0140 static inline
0141 void rtas_set_disposition_recovered(struct rtas_error_log *elog)
0142 {
0143     elog->byte1 &= ~0x18;
0144     elog->byte1 |= (RTAS_DISP_FULLY_RECOVERED << 3);
0145 }
0146
0147 static inline uint8_t rtas_error_extended(const struct rtas_error_log *elog)
0148 {
0149     return (elog->byte1 & 0x04) >> 2;
0150 }
0151
0152 static inline uint8_t rtas_error_initiator(const struct rtas_error_log *elog)
0153 {
0154     return (elog->byte2 & 0xf0) >> 4;
0155 }
0156
0157 #define rtas_error_type(x)  ((x)->byte3)
0158
0159 static inline
0160 uint32_t rtas_error_extended_log_length(const struct rtas_error_log *elog)
0161 {
0162     return be32_to_cpu(elog->extended_log_length);
0163 }
0164
0165 #define RTAS_V6EXT_LOG_FORMAT_EVENT_LOG 14
0166
0167 #define RTAS_V6EXT_COMPANY_ID_IBM   (('I' << 24) | ('B' << 16) | ('M' << 8))
0168
0169 static
0170 inline uint8_t rtas_ext_event_log_format(struct rtas_ext_event_log_v6 *ext_log)
0171 {
0172     return ext_log->byte2 & 0x0F;
0173 }
0174
0175 static
0176 inline uint32_t rtas_ext_event_company_id(struct rtas_ext_event_log_v6 *ext_log)
0177 {
0178     return be32_to_cpu(ext_log->company_id);
0179 }
0180
0181 /* pSeries event log format */
0182
0183 /* Two bytes ASCII section IDs */
0184 #define PSERIES_ELOG_SECT_ID_PRIV_HDR       (('P' << 8) | 'H')
0185 #define PSERIES_ELOG_SECT_ID_USER_HDR       (('U' << 8) | 'H')
0186 #define PSERIES_ELOG_SECT_ID_PRIMARY_SRC    (('P' << 8) | 'S')
0187 #define PSERIES_ELOG_SECT_ID_EXTENDED_UH    (('E' << 8) | 'H')
0188 #define PSERIES_ELOG_SECT_ID_FAILING_MTMS   (('M' << 8) | 'T')
0189 #define PSERIES_ELOG_SECT_ID_SECONDARY_SRC  (('S' << 8) | 'S')
0190 #define PSERIES_ELOG_SECT_ID_DUMP_LOCATOR   (('D' << 8) | 'H')
0191 #define PSERIES_ELOG_SECT_ID_FW_ERROR       (('S' << 8) | 'W')
0192 #define PSERIES_ELOG_SECT_ID_IMPACT_PART_ID (('L' << 8) | 'P')
0193 #define PSERIES_ELOG_SECT_ID_LOGIC_RESOURCE_ID  (('L' << 8) | 'R')
0194 #define PSERIES_ELOG_SECT_ID_HMC_ID     (('H' << 8) | 'M')
0195 #define PSERIES_ELOG_SECT_ID_EPOW       (('E' << 8) | 'P')
0196 #define PSERIES_ELOG_SECT_ID_IO_EVENT       (('I' << 8) | 'E')
0197 #define PSERIES_ELOG_SECT_ID_MANUFACT_INFO  (('M' << 8) | 'I')
0198 #define PSERIES_ELOG_SECT_ID_CALL_HOME      (('C' << 8) | 'H')
0199 #define PSERIES_ELOG_SECT_ID_USER_DEF       (('U' << 8) | 'D')
0200 #define PSERIES_ELOG_SECT_ID_HOTPLUG        (('H' << 8) | 'P')
0201 #define PSERIES_ELOG_SECT_ID_MCE        (('M' << 8) | 'C')
0202
0203 static
0204 inline uint16_t pseries_errorlog_id(struct pseries_errorlog *sect)
0205 {
0206     return be16_to_cpu(sect->id);
0207 }
0208
0209 static
0210 inline uint16_t pseries_errorlog_length(struct pseries_errorlog *sect)
0211 {
0212     return be16_to_cpu(sect->length);
0213 }
0214
0215 #define PSERIES_HP_ELOG_RESOURCE_CPU    1
0216 #define PSERIES_HP_ELOG_RESOURCE_MEM    2
0217 #define PSERIES_HP_ELOG_RESOURCE_SLOT   3
0218 #define PSERIES_HP_ELOG_RESOURCE_PHB    4
0219 #define PSERIES_HP_ELOG_RESOURCE_PMEM   6
0220
0221 #define PSERIES_HP_ELOG_ACTION_ADD  1
0222 #define PSERIES_HP_ELOG_ACTION_REMOVE   2
0223
0224 #define PSERIES_HP_ELOG_ID_DRC_NAME 1
0225 #define PSERIES_HP_ELOG_ID_DRC_INDEX    2
0226 #define PSERIES_HP_ELOG_ID_DRC_COUNT    3
0227 #define PSERIES_HP_ELOG_ID_DRC_IC   4
0228
0229 struct pseries_errorlog *get_pseries_errorlog(struct rtas_error_log *log,
0230                           uint16_t section_id);
0231
0232 /*
0233  * This can be set by the rtas_flash module so that it can get called
0234  * as the absolutely last thing before the kernel terminates.
0235  */
0236 extern void (*rtas_flash_term_hook)(int);
0237
0238 extern struct rtas_t rtas;
0239
0240 extern int rtas_token(const char *service);
0241 extern int rtas_service_present(const char *service);
0242 extern int rtas_call(int token, int, int, int *, ...);
0243 int rtas_call_reentrant(int token, int nargs, int nret, int *outputs, ...);
0244 void rtas_call_unlocked(struct rtas_args *args, int token, int nargs,
0245             int nret, ...);
0246 extern void __noreturn rtas_restart(char *cmd);
0247 extern void rtas_power_off(void);
0248 extern void __noreturn rtas_halt(void);
0249 extern void rtas_os_term(char *str);
0250 void rtas_activate_firmware(void);
0251 extern int rtas_get_sensor(int sensor, int index, int *state);
0252 extern int rtas_get_sensor_fast(int sensor, int index, int *state);
0253 extern int rtas_get_power_level(int powerdomain, int *level);
0254 extern int rtas_set_power_level(int powerdomain, int level, int *setlevel);
0255 extern bool rtas_indicator_present(int token, int *maxindex);
0256 extern int rtas_set_indicator(int indicator, int index, int new_value);
0257 extern int rtas_set_indicator_fast(int indicator, int index, int new_value);
0258 extern void rtas_progress(char *s, unsigned short hex);
0259 int rtas_ibm_suspend_me(int *fw_status);
0260
0261 struct rtc_time;
0262 extern time64_t rtas_get_boot_time(void);
0263 extern void rtas_get_rtc_time(struct rtc_time *rtc_time);
0264 extern int rtas_set_rtc_time(struct rtc_time *rtc_time);
0265
0266 extern unsigned int rtas_busy_delay_time(int status);
0267 bool rtas_busy_delay(int status);
0268
0269 extern int early_init_dt_scan_rtas(unsigned long node,
0270         const char *uname, int depth, void *data);
0271
0272 extern void pSeries_log_error(char *buf, unsigned int err_type, int fatal);
0273
0274 #ifdef CONFIG_PPC_PSERIES
0275 extern time64_t last_rtas_event;
0276 extern int clobbering_unread_rtas_event(void);
0277 extern void post_mobility_fixup(void);
0278 int rtas_syscall_dispatch_ibm_suspend_me(u64 handle);
0279 #else
0280 static inline int clobbering_unread_rtas_event(void) { return 0; }
0281 static inline int rtas_syscall_dispatch_ibm_suspend_me(u64 handle)
0282 {
0283     return -EINVAL;
0284 }
0285 #endif
0286
0287 #ifdef CONFIG_PPC_RTAS_DAEMON
0288 extern void rtas_cancel_event_scan(void);
0289 #else
0290 static inline void rtas_cancel_event_scan(void) { }
0291 #endif
0292
0293 /* Error types logged.  */
0294 #define ERR_FLAG_ALREADY_LOGGED 0x0
0295 #define ERR_FLAG_BOOT       0x1     /* log was pulled from NVRAM on boot */
0296 #define ERR_TYPE_RTAS_LOG   0x2 /* from rtas event-scan */
0297 #define ERR_TYPE_KERNEL_PANIC   0x4 /* from die()/panic() */
0298 #define ERR_TYPE_KERNEL_PANIC_GZ 0x8    /* ditto, compressed */
0299
0300 /* All the types and not flags */
0301 #define ERR_TYPE_MASK \
0302     (ERR_TYPE_RTAS_LOG | ERR_TYPE_KERNEL_PANIC | ERR_TYPE_KERNEL_PANIC_GZ)
0303
0304 #define RTAS_DEBUG KERN_DEBUG "RTAS: "
0305
0306 #define RTAS_ERROR_LOG_MAX 2048
0307
0308 /*
0309  * Return the firmware-specified size of the error log buffer
0310  *  for all rtas calls that require an error buffer argument.
0311  *  This includes 'check-exception' and 'rtas-last-error'.
0312  */
0313 extern int rtas_get_error_log_max(void);
0314
0315 /* Event Scan Parameters */
0316 #define EVENT_SCAN_ALL_EVENTS   0xf0000000
0317 #define SURVEILLANCE_TOKEN  9000
0318 #define LOG_NUMBER      64      /* must be a power of two */
0319 #define LOG_NUMBER_MASK     (LOG_NUMBER-1)
0320
0321 /* Some RTAS ops require a data buffer and that buffer must be < 4G.
0322  * Rather than having a memory allocator, just use this buffer
0323  * (get the lock first), make the RTAS call.  Copy the data instead
0324  * of holding the buffer for long.
0325  */
0326
0327 #define RTAS_DATA_BUF_SIZE 4096
0328 extern spinlock_t rtas_data_buf_lock;
0329 extern char rtas_data_buf[RTAS_DATA_BUF_SIZE];
0330
0331 /* RMO buffer reserved for user-space RTAS use */
0332 extern unsigned long rtas_rmo_buf;
0333
0334 #define GLOBAL_INTERRUPT_QUEUE 9005
0335
0336 /**
0337  * rtas_config_addr - Format a busno, devfn and reg for RTAS.
0338  * @busno: The bus number.
0339  * @devfn: The device and function number as encoded by PCI_DEVFN().
0340  * @reg: The register number.
0341  *
0342  * This function encodes the given busno, devfn and register number as
0343  * required for RTAS calls that take a "config_addr" parameter.
0344  * See PAPR requirement 7.3.4-1 for more info.
0345  */
0346 static inline u32 rtas_config_addr(int busno, int devfn, int reg)
0347 {
0348     return ((reg & 0xf00) << 20) | ((busno & 0xff) << 16) |
0349             (devfn << 8) | (reg & 0xff);
0350 }
0351
0352 extern void rtas_give_timebase(void);
0353 extern void rtas_take_timebase(void);
0354
0355 #ifdef CONFIG_PPC_RTAS
0356 static inline int page_is_rtas_user_buf(unsigned long pfn)
0357 {
0358     unsigned long paddr = (pfn << PAGE_SHIFT);
0359     if (paddr >= rtas_rmo_buf && paddr < (rtas_rmo_buf + RTAS_USER_REGION_SIZE))
0360         return 1;
0361     return 0;
0362 }
0363
0364 /* Not the best place to put pSeries_coalesce_init, will be fixed when we
0365  * move some of the rtas suspend-me stuff to pseries */
0366 extern void pSeries_coalesce_init(void);
0367 void rtas_initialize(void);
0368 #else
0369 static inline int page_is_rtas_user_buf(unsigned long pfn) { return 0;}
0370 static inline void pSeries_coalesce_init(void) { }
0371 static inline void rtas_initialize(void) { }
0372 #endif
0373
0374 extern int call_rtas(const char *, int, int, unsigned long *, ...);
0375
0376 #ifdef CONFIG_HV_PERF_CTRS
0377 void read_24x7_sys_info(void);
0378 #else
0379 static inline void read_24x7_sys_info(void) { }
0380 #endif
0381
0382 #endif /* __KERNEL__ */
0383 #endif /* _POWERPC_RTAS_H */