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