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 <linux/time.h>
   9 #include <linux/cpumask.h>
  10
  11 /*
  12  * Definitions for talking to the RTAS on CHRP machines.
  13  *
  14  * Copyright (C) 2001 Peter Bergner
  15  * Copyright (C) 2001 PPC 64 Team, IBM Corp
  16  */
  17
  18 #define RTAS_UNKNOWN_SERVICE (-1)
  19 #define RTAS_INSTANTIATE_MAX (1ULL<<30) /* Don't instantiate rtas at/above this value */
  20
  21 /* Buffer size for ppc_rtas system call. */
  22 #define RTAS_RMOBUF_MAX (64 * 1024)
  23
  24 /* RTAS return status codes */
  25 #define RTAS_NOT_SUSPENDABLE    -9004
  26 #define RTAS_BUSY               -2    /* RTAS Busy */
  27 #define RTAS_EXTENDED_DELAY_MIN 9900
  28 #define RTAS_EXTENDED_DELAY_MAX 9905
  29
  30 /*
  31  * In general to call RTAS use rtas_token("string") to lookup
  32  * an RTAS token for the given string (e.g. "event-scan").
  33  * To actually perform the call use
  34  *    ret = rtas_call(token, n_in, n_out, ...)
  35  * Where n_in is the number of input parameters and
  36  *       n_out is the number of output parameters
  37  *
  38  * If the "string" is invalid on this system, RTAS_UNKNOWN_SERVICE
  39  * will be returned as a token.  rtas_call() does look for this
  40  * token and error out gracefully so rtas_call(rtas_token("str"), ...)
  41  * may be safely used for one-shot calls to RTAS.
  42  *
  43  */
  44
  45 typedef __be32 rtas_arg_t;
  46
  47 struct rtas_args {
  48         __be32 token;
  49         __be32 nargs;
  50         __be32 nret;
  51         rtas_arg_t args[16];
  52         rtas_arg_t *rets;     /* Pointer to return values in args[]. */
  53 };
  54
  55 struct rtas_t {
  56         unsigned long entry;            /* physical address pointer */
  57         unsigned long base;             /* physical address pointer */
  58         unsigned long size;
  59         arch_spinlock_t lock;
  60         struct rtas_args args;
  61         struct device_node *dev;        /* virtual address pointer */
  62 };
  63
  64 struct rtas_suspend_me_data {
  65         atomic_t working; /* number of cpus accessing this struct */
  66         atomic_t done;
  67         int token; /* ibm,suspend-me */
  68         atomic_t error;
  69         struct completion *complete; /* wait on this until working == 0 */
  70 };
  71
  72 /* RTAS event classes */
  73 #define RTAS_INTERNAL_ERROR             0x80000000 /* set bit 0 */
  74 #define RTAS_EPOW_WARNING               0x40000000 /* set bit 1 */
  75 #define RTAS_HOTPLUG_EVENTS             0x10000000 /* set bit 3 */
  76 #define RTAS_IO_EVENTS                  0x08000000 /* set bit 4 */
  77 #define RTAS_EVENT_SCAN_ALL_EVENTS      0xffffffff
  78
  79 /* RTAS event severity */
  80 #define RTAS_SEVERITY_FATAL             0x5
  81 #define RTAS_SEVERITY_ERROR             0x4
  82 #define RTAS_SEVERITY_ERROR_SYNC        0x3
  83 #define RTAS_SEVERITY_WARNING           0x2
  84 #define RTAS_SEVERITY_EVENT             0x1
  85 #define RTAS_SEVERITY_NO_ERROR          0x0
  86
  87 /* RTAS event disposition */
  88 #define RTAS_DISP_FULLY_RECOVERED       0x0
  89 #define RTAS_DISP_LIMITED_RECOVERY      0x1
  90 #define RTAS_DISP_NOT_RECOVERED         0x2
  91
  92 /* RTAS event initiator */
  93 #define RTAS_INITIATOR_UNKNOWN          0x0
  94 #define RTAS_INITIATOR_CPU              0x1
  95 #define RTAS_INITIATOR_PCI              0x2
  96 #define RTAS_INITIATOR_ISA              0x3
  97 #define RTAS_INITIATOR_MEMORY           0x4
  98 #define RTAS_INITIATOR_POWERMGM         0x5
  99
 100 /* RTAS event target */
 101 #define RTAS_TARGET_UNKNOWN             0x0
 102 #define RTAS_TARGET_CPU                 0x1
 103 #define RTAS_TARGET_PCI                 0x2
 104 #define RTAS_TARGET_ISA                 0x3
 105 #define RTAS_TARGET_MEMORY              0x4
 106 #define RTAS_TARGET_POWERMGM            0x5
 107
 108 /* RTAS event type */
 109 #define RTAS_TYPE_RETRY                 0x01
 110 #define RTAS_TYPE_TCE_ERR               0x02
 111 #define RTAS_TYPE_INTERN_DEV_FAIL       0x03
 112 #define RTAS_TYPE_TIMEOUT               0x04
 113 #define RTAS_TYPE_DATA_PARITY           0x05
 114 #define RTAS_TYPE_ADDR_PARITY           0x06
 115 #define RTAS_TYPE_CACHE_PARITY          0x07
 116 #define RTAS_TYPE_ADDR_INVALID          0x08
 117 #define RTAS_TYPE_ECC_UNCORR            0x09
 118 #define RTAS_TYPE_ECC_CORR              0x0a
 119 #define RTAS_TYPE_EPOW                  0x40
 120 #define RTAS_TYPE_PLATFORM              0xE0
 121 #define RTAS_TYPE_IO                    0xE1
 122 #define RTAS_TYPE_INFO                  0xE2
 123 #define RTAS_TYPE_DEALLOC               0xE3
 124 #define RTAS_TYPE_DUMP                  0xE4
 125 #define RTAS_TYPE_HOTPLUG               0xE5
 126 /* I don't add PowerMGM events right now, this is a different topic */
 127 #define RTAS_TYPE_PMGM_POWER_SW_ON      0x60
 128 #define RTAS_TYPE_PMGM_POWER_SW_OFF     0x61
 129 #define RTAS_TYPE_PMGM_LID_OPEN         0x62
 130 #define RTAS_TYPE_PMGM_LID_CLOSE        0x63
 131 #define RTAS_TYPE_PMGM_SLEEP_BTN        0x64
 132 #define RTAS_TYPE_PMGM_WAKE_BTN         0x65
 133 #define RTAS_TYPE_PMGM_BATTERY_WARN     0x66
 134 #define RTAS_TYPE_PMGM_BATTERY_CRIT     0x67
 135 #define RTAS_TYPE_PMGM_SWITCH_TO_BAT    0x68
 136 #define RTAS_TYPE_PMGM_SWITCH_TO_AC     0x69
 137 #define RTAS_TYPE_PMGM_KBD_OR_MOUSE     0x6a
 138 #define RTAS_TYPE_PMGM_ENCLOS_OPEN      0x6b
 139 #define RTAS_TYPE_PMGM_ENCLOS_CLOSED    0x6c
 140 #define RTAS_TYPE_PMGM_RING_INDICATE    0x6d
 141 #define RTAS_TYPE_PMGM_LAN_ATTENTION    0x6e
 142 #define RTAS_TYPE_PMGM_TIME_ALARM       0x6f
 143 #define RTAS_TYPE_PMGM_CONFIG_CHANGE    0x70
 144 #define RTAS_TYPE_PMGM_SERVICE_PROC     0x71
 145 /* Platform Resource Reassignment Notification */
 146 #define RTAS_TYPE_PRRN                  0xA0
 147
 148 /* RTAS check-exception vector offset */
 149 #define RTAS_VECTOR_EXTERNAL_INTERRUPT  0x500
 150
 151 struct rtas_error_log {
 152         /* Byte 0 */
 153         uint8_t         byte0;                  /* Architectural version */
 154
 155         /* Byte 1 */
 156         uint8_t         byte1;
 157         /* XXXXXXXX
 158          * XXX          3: Severity level of error
 159          *    XX        2: Degree of recovery
 160          *      X       1: Extended log present?
 161          *       XX     2: Reserved
 162          */
 163
 164         /* Byte 2 */
 165         uint8_t         byte2;
 166         /* XXXXXXXX
 167          * XXXX         4: Initiator of event
 168          *     XXXX     4: Target of failed operation
 169          */
 170         uint8_t         byte3;                  /* General event or error*/
 171         __be32          extended_log_length;    /* length in bytes */
 172         unsigned char   buffer[1];              /* Start of extended log */
 173                                                 /* Variable length.      */
 174 };
 175
 176 static inline uint8_t rtas_error_severity(const struct rtas_error_log *elog)
 177 {
 178         return (elog->byte1 & 0xE0) >> 5;
 179 }
 180
 181 static inline uint8_t rtas_error_disposition(const struct rtas_error_log *elog)
 182 {
 183         return (elog->byte1 & 0x18) >> 3;
 184 }
 185
 186 static inline
 187 void rtas_set_disposition_recovered(struct rtas_error_log *elog)
 188 {
 189         elog->byte1 &= ~0x18;
 190         elog->byte1 |= (RTAS_DISP_FULLY_RECOVERED << 3);
 191 }
 192
 193 static inline uint8_t rtas_error_extended(const struct rtas_error_log *elog)
 194 {
 195         return (elog->byte1 & 0x04) >> 2;
 196 }
 197
 198 static inline uint8_t rtas_error_initiator(const struct rtas_error_log *elog)
 199 {
 200         return (elog->byte2 & 0xf0) >> 4;
 201 }
 202
 203 #define rtas_error_type(x)      ((x)->byte3)
 204
 205 static inline
 206 uint32_t rtas_error_extended_log_length(const struct rtas_error_log *elog)
 207 {
 208         return be32_to_cpu(elog->extended_log_length);
 209 }
 210
 211 #define RTAS_V6EXT_LOG_FORMAT_EVENT_LOG 14
 212
 213 #define RTAS_V6EXT_COMPANY_ID_IBM       (('I' << 24) | ('B' << 16) | ('M' << 8))
 214
 215 /* RTAS general extended event log, Version 6. The extended log starts
 216  * from "buffer" field of struct rtas_error_log defined above.
 217  */
 218 struct rtas_ext_event_log_v6 {
 219         /* Byte 0 */
 220         uint8_t byte0;
 221         /* XXXXXXXX
 222          * X            1: Log valid
 223          *  X           1: Unrecoverable error
 224          *   X          1: Recoverable (correctable or successfully retried)
 225          *    X         1: Bypassed unrecoverable error (degraded operation)
 226          *     X        1: Predictive error
 227          *      X       1: "New" log (always 1 for data returned from RTAS)
 228          *       X      1: Big Endian
 229          *        X     1: Reserved
 230          */
 231
 232         /* Byte 1 */
 233         uint8_t byte1;                  /* reserved */
 234
 235         /* Byte 2 */
 236         uint8_t byte2;
 237         /* XXXXXXXX
 238          * X            1: Set to 1 (indicating log is in PowerPC format)
 239          *  XXX         3: Reserved
 240          *     XXXX     4: Log format used for bytes 12-2047
 241          */
 242
 243         /* Byte 3 */
 244         uint8_t byte3;                  /* reserved */
 245         /* Byte 4-11 */
 246         uint8_t reserved[8];            /* reserved */
 247         /* Byte 12-15 */
 248         __be32  company_id;             /* Company ID of the company    */
 249                                         /* that defines the format for  */
 250                                         /* the vendor specific log type */
 251         /* Byte 16-end of log */
 252         uint8_t vendor_log[1];          /* Start of vendor specific log */
 253                                         /* Variable length.             */
 254 };
 255
 256 static
 257 inline uint8_t rtas_ext_event_log_format(struct rtas_ext_event_log_v6 *ext_log)
 258 {
 259         return ext_log->byte2 & 0x0F;
 260 }
 261
 262 static
 263 inline uint32_t rtas_ext_event_company_id(struct rtas_ext_event_log_v6 *ext_log)
 264 {
 265         return be32_to_cpu(ext_log->company_id);
 266 }
 267
 268 /* pSeries event log format */
 269
 270 /* Two bytes ASCII section IDs */
 271 #define PSERIES_ELOG_SECT_ID_PRIV_HDR           (('P' << 8) | 'H')
 272 #define PSERIES_ELOG_SECT_ID_USER_HDR           (('U' << 8) | 'H')
 273 #define PSERIES_ELOG_SECT_ID_PRIMARY_SRC        (('P' << 8) | 'S')
 274 #define PSERIES_ELOG_SECT_ID_EXTENDED_UH        (('E' << 8) | 'H')
 275 #define PSERIES_ELOG_SECT_ID_FAILING_MTMS       (('M' << 8) | 'T')
 276 #define PSERIES_ELOG_SECT_ID_SECONDARY_SRC      (('S' << 8) | 'S')
 277 #define PSERIES_ELOG_SECT_ID_DUMP_LOCATOR       (('D' << 8) | 'H')
 278 #define PSERIES_ELOG_SECT_ID_FW_ERROR           (('S' << 8) | 'W')
 279 #define PSERIES_ELOG_SECT_ID_IMPACT_PART_ID     (('L' << 8) | 'P')
 280 #define PSERIES_ELOG_SECT_ID_LOGIC_RESOURCE_ID  (('L' << 8) | 'R')
 281 #define PSERIES_ELOG_SECT_ID_HMC_ID             (('H' << 8) | 'M')
 282 #define PSERIES_ELOG_SECT_ID_EPOW               (('E' << 8) | 'P')
 283 #define PSERIES_ELOG_SECT_ID_IO_EVENT           (('I' << 8) | 'E')
 284 #define PSERIES_ELOG_SECT_ID_MANUFACT_INFO      (('M' << 8) | 'I')
 285 #define PSERIES_ELOG_SECT_ID_CALL_HOME          (('C' << 8) | 'H')
 286 #define PSERIES_ELOG_SECT_ID_USER_DEF           (('U' << 8) | 'D')
 287 #define PSERIES_ELOG_SECT_ID_HOTPLUG            (('H' << 8) | 'P')
 288 #define PSERIES_ELOG_SECT_ID_MCE                (('M' << 8) | 'C')
 289
 290 /* Vendor specific Platform Event Log Format, Version 6, section header */
 291 struct pseries_errorlog {
 292         __be16 id;                      /* 0x00 2-byte ASCII section ID */
 293         __be16 length;                  /* 0x02 Section length in bytes */
 294         uint8_t version;                /* 0x04 Section version         */
 295         uint8_t subtype;                /* 0x05 Section subtype         */
 296         __be16 creator_component;       /* 0x06 Creator component ID    */
 297         uint8_t data[];                 /* 0x08 Start of section data   */
 298 };
 299
 300 static
 301 inline uint16_t pseries_errorlog_id(struct pseries_errorlog *sect)
 302 {
 303         return be16_to_cpu(sect->id);
 304 }
 305
 306 static
 307 inline uint16_t pseries_errorlog_length(struct pseries_errorlog *sect)
 308 {
 309         return be16_to_cpu(sect->length);
 310 }
 311
 312 /* RTAS pseries hotplug errorlog section */
 313 struct pseries_hp_errorlog {
 314         u8      resource;
 315         u8      action;
 316         u8      id_type;
 317         u8      reserved;
 318         union {
 319                 __be32  drc_index;
 320                 __be32  drc_count;
 321                 struct { __be32 count, index; } ic;
 322                 char    drc_name[1];
 323         } _drc_u;
 324 };
 325
 326 #define PSERIES_HP_ELOG_RESOURCE_CPU    1
 327 #define PSERIES_HP_ELOG_RESOURCE_MEM    2
 328 #define PSERIES_HP_ELOG_RESOURCE_SLOT   3
 329 #define PSERIES_HP_ELOG_RESOURCE_PHB    4
 330 #define PSERIES_HP_ELOG_RESOURCE_PMEM   6
 331
 332 #define PSERIES_HP_ELOG_ACTION_ADD      1
 333 #define PSERIES_HP_ELOG_ACTION_REMOVE   2
 334 #define PSERIES_HP_ELOG_ACTION_READD    3
 335
 336 #define PSERIES_HP_ELOG_ID_DRC_NAME     1
 337 #define PSERIES_HP_ELOG_ID_DRC_INDEX    2
 338 #define PSERIES_HP_ELOG_ID_DRC_COUNT    3
 339 #define PSERIES_HP_ELOG_ID_DRC_IC       4
 340
 341 struct pseries_errorlog *get_pseries_errorlog(struct rtas_error_log *log,
 342                                               uint16_t section_id);
 343
 344 /*
 345  * This can be set by the rtas_flash module so that it can get called
 346  * as the absolutely last thing before the kernel terminates.
 347  */
 348 extern void (*rtas_flash_term_hook)(int);
 349
 350 extern struct rtas_t rtas;
 351
 352 extern int rtas_token(const char *service);
 353 extern int rtas_service_present(const char *service);
 354 extern int rtas_call(int token, int, int, int *, ...);
 355 void rtas_call_unlocked(struct rtas_args *args, int token, int nargs,
 356                         int nret, ...);
 357 extern void __noreturn rtas_restart(char *cmd);
 358 extern void rtas_power_off(void);
 359 extern void __noreturn rtas_halt(void);
 360 extern void rtas_os_term(char *str);
 361 extern int rtas_get_sensor(int sensor, int index, int *state);
 362 extern int rtas_get_sensor_fast(int sensor, int index, int *state);
 363 extern int rtas_get_power_level(int powerdomain, int *level);
 364 extern int rtas_set_power_level(int powerdomain, int level, int *setlevel);
 365 extern bool rtas_indicator_present(int token, int *maxindex);
 366 extern int rtas_set_indicator(int indicator, int index, int new_value);
 367 extern int rtas_set_indicator_fast(int indicator, int index, int new_value);
 368 extern void rtas_progress(char *s, unsigned short hex);
 369 extern int rtas_suspend_cpu(struct rtas_suspend_me_data *data);
 370 extern int rtas_suspend_last_cpu(struct rtas_suspend_me_data *data);
 371 extern int rtas_online_cpus_mask(cpumask_var_t cpus);
 372 extern int rtas_offline_cpus_mask(cpumask_var_t cpus);
 373 extern int rtas_ibm_suspend_me(u64 handle);
 374
 375 struct rtc_time;
 376 extern time64_t rtas_get_boot_time(void);
 377 extern void rtas_get_rtc_time(struct rtc_time *rtc_time);
 378 extern int rtas_set_rtc_time(struct rtc_time *rtc_time);
 379
 380 extern unsigned int rtas_busy_delay_time(int status);
 381 extern unsigned int rtas_busy_delay(int status);
 382
 383 extern int early_init_dt_scan_rtas(unsigned long node,
 384                 const char *uname, int depth, void *data);
 385
 386 extern void pSeries_log_error(char *buf, unsigned int err_type, int fatal);
 387
 388 #ifdef CONFIG_PPC_PSERIES
 389 extern time64_t last_rtas_event;
 390 extern int clobbering_unread_rtas_event(void);
 391 extern int pseries_devicetree_update(s32 scope);
 392 extern void post_mobility_fixup(void);
 393 #else
 394 static inline int clobbering_unread_rtas_event(void) { return 0; }
 395 #endif
 396
 397 #ifdef CONFIG_PPC_RTAS_DAEMON
 398 extern void rtas_cancel_event_scan(void);
 399 #else
 400 static inline void rtas_cancel_event_scan(void) { }
 401 #endif
 402
 403 /* Error types logged.  */
 404 #define ERR_FLAG_ALREADY_LOGGED 0x0
 405 #define ERR_FLAG_BOOT           0x1     /* log was pulled from NVRAM on boot */
 406 #define ERR_TYPE_RTAS_LOG       0x2     /* from rtas event-scan */
 407 #define ERR_TYPE_KERNEL_PANIC   0x4     /* from die()/panic() */
 408 #define ERR_TYPE_KERNEL_PANIC_GZ 0x8    /* ditto, compressed */
 409
 410 /* All the types and not flags */
 411 #define ERR_TYPE_MASK \
 412         (ERR_TYPE_RTAS_LOG | ERR_TYPE_KERNEL_PANIC | ERR_TYPE_KERNEL_PANIC_GZ)
 413
 414 #define RTAS_DEBUG KERN_DEBUG "RTAS: "
 415
 416 #define RTAS_ERROR_LOG_MAX 2048
 417
 418 /*
 419  * Return the firmware-specified size of the error log buffer
 420  *  for all rtas calls that require an error buffer argument.
 421  *  This includes 'check-exception' and 'rtas-last-error'.
 422  */
 423 extern int rtas_get_error_log_max(void);
 424
 425 /* Event Scan Parameters */
 426 #define EVENT_SCAN_ALL_EVENTS   0xf0000000
 427 #define SURVEILLANCE_TOKEN      9000
 428 #define LOG_NUMBER              64              /* must be a power of two */
 429 #define LOG_NUMBER_MASK         (LOG_NUMBER-1)
 430
 431 /* Some RTAS ops require a data buffer and that buffer must be < 4G.
 432  * Rather than having a memory allocator, just use this buffer
 433  * (get the lock first), make the RTAS call.  Copy the data instead
 434  * of holding the buffer for long.
 435  */
 436
 437 #define RTAS_DATA_BUF_SIZE 4096
 438 extern spinlock_t rtas_data_buf_lock;
 439 extern char rtas_data_buf[RTAS_DATA_BUF_SIZE];
 440
 441 /* RMO buffer reserved for user-space RTAS use */
 442 extern unsigned long rtas_rmo_buf;
 443
 444 #define GLOBAL_INTERRUPT_QUEUE 9005
 445
 446 /**
 447  * rtas_config_addr - Format a busno, devfn and reg for RTAS.
 448  * @busno: The bus number.
 449  * @devfn: The device and function number as encoded by PCI_DEVFN().
 450  * @reg: The register number.
 451  *
 452  * This function encodes the given busno, devfn and register number as
 453  * required for RTAS calls that take a "config_addr" parameter.
 454  * See PAPR requirement 7.3.4-1 for more info.
 455  */
 456 static inline u32 rtas_config_addr(int busno, int devfn, int reg)
 457 {
 458         return ((reg & 0xf00) << 20) | ((busno & 0xff) << 16) |
 459                         (devfn << 8) | (reg & 0xff);
 460 }
 461
 462 extern void rtas_give_timebase(void);
 463 extern void rtas_take_timebase(void);
 464
 465 #ifdef CONFIG_PPC_RTAS
 466 static inline int page_is_rtas_user_buf(unsigned long pfn)
 467 {
 468         unsigned long paddr = (pfn << PAGE_SHIFT);
 469         if (paddr >= rtas_rmo_buf && paddr < (rtas_rmo_buf + RTAS_RMOBUF_MAX))
 470                 return 1;
 471         return 0;
 472 }
 473
 474 /* Not the best place to put pSeries_coalesce_init, will be fixed when we
 475  * move some of the rtas suspend-me stuff to pseries */
 476 extern void pSeries_coalesce_init(void);
 477 void rtas_initialize(void);
 478 #else
 479 static inline int page_is_rtas_user_buf(unsigned long pfn) { return 0;}
 480 static inline void pSeries_coalesce_init(void) { }
 481 static inline void rtas_initialize(void) { };
 482 #endif
 483
 484 extern int call_rtas(const char *, int, int, unsigned long *, ...);
 485
 486 #endif /* __KERNEL__ */
 487 #endif /* _POWERPC_RTAS_H */