include/asm-ppc64/rtas.h

   1 #ifndef _PPC64_RTAS_H
   2 #define _PPC64_RTAS_H
   3
   4 #include <linux/spinlock.h>
   5 #include <asm/page.h>
   6
   7 /*
   8  * Definitions for talking to the RTAS on CHRP machines.
   9  *
  10  * Copyright (C) 2001 Peter Bergner
  11  * Copyright (C) 2001 PPC 64 Team, IBM Corp
  12  *
  13  * This program is free software; you can redistribute it and/or
  14  * modify it under the terms of the GNU General Public License
  15  * as published by the Free Software Foundation; either version
  16  * 2 of the License, or (at your option) any later version.
  17  */
  18
  19 #define RTAS_UNKNOWN_SERVICE (-1)
  20 #define RTAS_INSTANTIATE_MAX (1UL<<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 codes */
  26 #define RTAS_BUSY               -2      /* RTAS Return Status - Busy */
  27 #define RTAS_EXTENDED_DELAY_MIN 9900
  28 #define RTAS_EXTENDED_DELAY_MAX 9905
  29
  30 #define RTAS_UNKNOWN_OP         -1099   /* Return Status - Unknown RTAS Token */
  31
  32 /*
  33  * In general to call RTAS use rtas_token("string") to lookup
  34  * an RTAS token for the given string (e.g. "event-scan").
  35  * To actually perform the call use
  36  *    ret = rtas_call(token, n_in, n_out, ...)
  37  * Where n_in is the number of input parameters and
  38  *       n_out is the number of output parameters
  39  *
  40  * If the "string" is invalid on this system, RTAS_UNKOWN_SERVICE
  41  * will be returned as a token.  rtas_call() does look for this
  42  * token and error out gracefully so rtas_call(rtas_token("str"), ...)
  43  * may be safely used for one-shot calls to RTAS.
  44  *
  45  */
  46
  47 typedef u32 rtas_arg_t;
  48
  49 struct rtas_args {
  50         u32 token;
  51         u32 nargs;
  52         u32 nret;
  53         rtas_arg_t args[16];
  54 #if 0
  55         spinlock_t lock;
  56 #endif
  57         rtas_arg_t *rets;     /* Pointer to return values in args[]. */
  58 };
  59
  60 struct rtas_t {
  61         unsigned long entry;            /* physical address pointer */
  62         unsigned long base;             /* physical address pointer */
  63         unsigned long size;
  64         spinlock_t lock;
  65
  66         struct device_node *dev;        /* virtual address pointer */
  67 };
  68
  69 /* Event classes */
  70 #define RTAS_INTERNAL_ERROR             0x80000000 /* set bit 0 */
  71 #define RTAS_EPOW_WARNING               0x40000000 /* set bit 1 */
  72 #define RTAS_POWERMGM_EVENTS            0x20000000 /* set bit 2 */
  73 #define RTAS_HOTPLUG_EVENTS             0x10000000 /* set bit 3 */
  74 #define RTAS_EVENT_SCAN_ALL_EVENTS      0xf0000000
  75
  76 /* event-scan returns */
  77 #define SEVERITY_FATAL          0x5
  78 #define SEVERITY_ERROR          0x4
  79 #define SEVERITY_ERROR_SYNC     0x3
  80 #define SEVERITY_WARNING        0x2
  81 #define SEVERITY_EVENT          0x1
  82 #define SEVERITY_NO_ERROR       0x0
  83 #define DISP_FULLY_RECOVERED    0x0
  84 #define DISP_LIMITED_RECOVERY   0x1
  85 #define DISP_NOT_RECOVERED      0x2
  86 #define PART_PRESENT            0x0
  87 #define PART_NOT_PRESENT        0x1
  88 #define INITIATOR_UNKNOWN       0x0
  89 #define INITIATOR_CPU           0x1
  90 #define INITIATOR_PCI           0x2
  91 #define INITIATOR_ISA           0x3
  92 #define INITIATOR_MEMORY        0x4
  93 #define INITIATOR_POWERMGM      0x5
  94 #define TARGET_UNKNOWN          0x0
  95 #define TARGET_CPU              0x1
  96 #define TARGET_PCI              0x2
  97 #define TARGET_ISA              0x3
  98 #define TARGET_MEMORY           0x4
  99 #define TARGET_POWERMGM         0x5
 100 #define TYPE_RETRY              0x01
 101 #define TYPE_TCE_ERR            0x02
 102 #define TYPE_INTERN_DEV_FAIL    0x03
 103 #define TYPE_TIMEOUT            0x04
 104 #define TYPE_DATA_PARITY        0x05
 105 #define TYPE_ADDR_PARITY        0x06
 106 #define TYPE_CACHE_PARITY       0x07
 107 #define TYPE_ADDR_INVALID       0x08
 108 #define TYPE_ECC_UNCORR         0x09
 109 #define TYPE_ECC_CORR           0x0a
 110 #define TYPE_EPOW               0x40
 111 /* I don't add PowerMGM events right now, this is a different topic */
 112 #define TYPE_PMGM_POWER_SW_ON   0x60
 113 #define TYPE_PMGM_POWER_SW_OFF  0x61
 114 #define TYPE_PMGM_LID_OPEN      0x62
 115 #define TYPE_PMGM_LID_CLOSE     0x63
 116 #define TYPE_PMGM_SLEEP_BTN     0x64
 117 #define TYPE_PMGM_WAKE_BTN      0x65
 118 #define TYPE_PMGM_BATTERY_WARN  0x66
 119 #define TYPE_PMGM_BATTERY_CRIT  0x67
 120 #define TYPE_PMGM_SWITCH_TO_BAT 0x68
 121 #define TYPE_PMGM_SWITCH_TO_AC  0x69
 122 #define TYPE_PMGM_KBD_OR_MOUSE  0x6a
 123 #define TYPE_PMGM_ENCLOS_OPEN   0x6b
 124 #define TYPE_PMGM_ENCLOS_CLOSED 0x6c
 125 #define TYPE_PMGM_RING_INDICATE 0x6d
 126 #define TYPE_PMGM_LAN_ATTENTION 0x6e
 127 #define TYPE_PMGM_TIME_ALARM    0x6f
 128 #define TYPE_PMGM_CONFIG_CHANGE 0x70
 129 #define TYPE_PMGM_SERVICE_PROC  0x71
 130
 131 struct rtas_error_log {
 132         unsigned long version:8;                /* Architectural version */
 133         unsigned long severity:3;               /* Severity level of error */
 134         unsigned long disposition:2;            /* Degree of recovery */
 135         unsigned long extended:1;               /* extended log present? */
 136         unsigned long /* reserved */ :2;        /* Reserved for future use */
 137         unsigned long initiator:4;              /* Initiator of event */
 138         unsigned long target:4;                 /* Target of failed operation */
 139         unsigned long type:8;                   /* General event or error*/
 140         unsigned long extended_log_length:32;   /* length in bytes */
 141         unsigned char buffer[1];                /* allocated by klimit bump */
 142 };
 143
 144 struct flash_block {
 145         char *data;
 146         unsigned long length;
 147 };
 148
 149 /* This struct is very similar but not identical to
 150  * that needed by the rtas flash update.
 151  * All we need to do for rtas is rewrite num_blocks
 152  * into a version/length and translate the pointers
 153  * to absolute.
 154  */
 155 #define FLASH_BLOCKS_PER_NODE ((PAGE_SIZE - 16) / sizeof(struct flash_block))
 156 struct flash_block_list {
 157         unsigned long num_blocks;
 158         struct flash_block_list *next;
 159         struct flash_block blocks[FLASH_BLOCKS_PER_NODE];
 160 };
 161 struct flash_block_list_header { /* just the header of flash_block_list */
 162         unsigned long num_blocks;
 163         struct flash_block_list *next;
 164 };
 165 extern struct flash_block_list_header rtas_firmware_flash_list;
 166
 167 extern struct rtas_t rtas;
 168
 169 extern void enter_rtas(unsigned long);
 170 extern int rtas_token(const char *service);
 171 extern long rtas_call(int token, int, int, unsigned long *, ...);
 172 extern void call_rtas_display_status(char);
 173 extern void rtas_restart(char *cmd);
 174 extern void rtas_power_off(void);
 175 extern void rtas_halt(void);
 176 extern void rtas_os_term(char *str);
 177 extern int rtas_get_sensor(int sensor, int index, int *state);
 178 extern int rtas_get_power_level(int powerdomain, int *level);
 179 extern int rtas_set_power_level(int powerdomain, int level, int *setlevel);
 180 extern int rtas_set_indicator(int indicator, int index, int new_value);
 181
 182 /* Given an RTAS status code of 9900..9905 compute the hinted delay */
 183 unsigned int rtas_extended_busy_delay_time(int status);
 184 static inline int rtas_is_extended_busy(int status)
 185 {
 186         return status >= 9900 && status <= 9909;
 187 }
 188
 189 extern void pSeries_log_error(char *buf, unsigned int err_type, int fatal);
 190
 191 /* Error types logged.  */
 192 #define ERR_FLAG_ALREADY_LOGGED 0x0
 193 #define ERR_FLAG_BOOT           0x1     /* log was pulled from NVRAM on boot */
 194 #define ERR_TYPE_RTAS_LOG       0x2     /* from rtas event-scan */
 195 #define ERR_TYPE_KERNEL_PANIC   0x4     /* from panic() */
 196
 197 /* All the types and not flags */
 198 #define ERR_TYPE_MASK   (ERR_TYPE_RTAS_LOG | ERR_TYPE_KERNEL_PANIC)
 199
 200 #define RTAS_DEBUG KERN_DEBUG "RTAS: "
 201
 202 #define RTAS_ERROR_LOG_MAX 2048
 203
 204
 205 /* Event Scan Parameters */
 206 #define EVENT_SCAN_ALL_EVENTS   0xf0000000
 207 #define SURVEILLANCE_TOKEN      9000
 208 #define LOG_NUMBER              64              /* must be a power of two */
 209 #define LOG_NUMBER_MASK         (LOG_NUMBER-1)
 210
 211 /* Some RTAS ops require a data buffer and that buffer must be < 4G.
 212  * Rather than having a memory allocator, just use this buffer
 213  * (get the lock first), make the RTAS call.  Copy the data instead
 214  * of holding the buffer for long.
 215  */
 216
 217 #define RTAS_DATA_BUF_SIZE 4096
 218 extern spinlock_t rtas_data_buf_lock;
 219 extern char rtas_data_buf[RTAS_DATA_BUF_SIZE];
 220
 221 extern void rtas_stop_self(void);
 222
 223 /* RMO buffer reserved for user-space RTAS use */
 224 extern unsigned long rtas_rmo_buf;
 225
 226 #endif /* _PPC64_RTAS_H */