arch/powerpc/include/asm/rtas.h

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