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/mutex.h>
   7 #include <linux/spinlock.h>
   8 #include <asm/page.h>
   9 #include <asm/rtas-types.h>
  10 #include <linux/time.h>
  11 #include <linux/cpumask.h>
  12
  13 /*
  14  * Definitions for talking to the RTAS on CHRP machines.
  15  *
  16  * Copyright (C) 2001 Peter Bergner
  17  * Copyright (C) 2001 PPC 64 Team, IBM Corp
  18  */
  19
  20 enum rtas_function_index {
  21         RTAS_FNIDX__CHECK_EXCEPTION,
  22         RTAS_FNIDX__DISPLAY_CHARACTER,
  23         RTAS_FNIDX__EVENT_SCAN,
  24         RTAS_FNIDX__FREEZE_TIME_BASE,
  25         RTAS_FNIDX__GET_POWER_LEVEL,
  26         RTAS_FNIDX__GET_SENSOR_STATE,
  27         RTAS_FNIDX__GET_TERM_CHAR,
  28         RTAS_FNIDX__GET_TIME_OF_DAY,
  29         RTAS_FNIDX__IBM_ACTIVATE_FIRMWARE,
  30         RTAS_FNIDX__IBM_CBE_START_PTCAL,
  31         RTAS_FNIDX__IBM_CBE_STOP_PTCAL,
  32         RTAS_FNIDX__IBM_CHANGE_MSI,
  33         RTAS_FNIDX__IBM_CLOSE_ERRINJCT,
  34         RTAS_FNIDX__IBM_CONFIGURE_BRIDGE,
  35         RTAS_FNIDX__IBM_CONFIGURE_CONNECTOR,
  36         RTAS_FNIDX__IBM_CONFIGURE_KERNEL_DUMP,
  37         RTAS_FNIDX__IBM_CONFIGURE_PE,
  38         RTAS_FNIDX__IBM_CREATE_PE_DMA_WINDOW,
  39         RTAS_FNIDX__IBM_DISPLAY_MESSAGE,
  40         RTAS_FNIDX__IBM_ERRINJCT,
  41         RTAS_FNIDX__IBM_EXTI2C,
  42         RTAS_FNIDX__IBM_GET_CONFIG_ADDR_INFO,
  43         RTAS_FNIDX__IBM_GET_CONFIG_ADDR_INFO2,
  44         RTAS_FNIDX__IBM_GET_DYNAMIC_SENSOR_STATE,
  45         RTAS_FNIDX__IBM_GET_INDICES,
  46         RTAS_FNIDX__IBM_GET_RIO_TOPOLOGY,
  47         RTAS_FNIDX__IBM_GET_SYSTEM_PARAMETER,
  48         RTAS_FNIDX__IBM_GET_VPD,
  49         RTAS_FNIDX__IBM_GET_XIVE,
  50         RTAS_FNIDX__IBM_INT_OFF,
  51         RTAS_FNIDX__IBM_INT_ON,
  52         RTAS_FNIDX__IBM_IO_QUIESCE_ACK,
  53         RTAS_FNIDX__IBM_LPAR_PERFTOOLS,
  54         RTAS_FNIDX__IBM_MANAGE_FLASH_IMAGE,
  55         RTAS_FNIDX__IBM_MANAGE_STORAGE_PRESERVATION,
  56         RTAS_FNIDX__IBM_NMI_INTERLOCK,
  57         RTAS_FNIDX__IBM_NMI_REGISTER,
  58         RTAS_FNIDX__IBM_OPEN_ERRINJCT,
  59         RTAS_FNIDX__IBM_OPEN_SRIOV_ALLOW_UNFREEZE,
  60         RTAS_FNIDX__IBM_OPEN_SRIOV_MAP_PE_NUMBER,
  61         RTAS_FNIDX__IBM_OS_TERM,
  62         RTAS_FNIDX__IBM_PARTNER_CONTROL,
  63         RTAS_FNIDX__IBM_PHYSICAL_ATTESTATION,
  64         RTAS_FNIDX__IBM_PLATFORM_DUMP,
  65         RTAS_FNIDX__IBM_POWER_OFF_UPS,
  66         RTAS_FNIDX__IBM_QUERY_INTERRUPT_SOURCE_NUMBER,
  67         RTAS_FNIDX__IBM_QUERY_PE_DMA_WINDOW,
  68         RTAS_FNIDX__IBM_READ_PCI_CONFIG,
  69         RTAS_FNIDX__IBM_READ_SLOT_RESET_STATE,
  70         RTAS_FNIDX__IBM_READ_SLOT_RESET_STATE2,
  71         RTAS_FNIDX__IBM_REMOVE_PE_DMA_WINDOW,
  72         RTAS_FNIDX__IBM_RESET_PE_DMA_WINDOW,
  73         RTAS_FNIDX__IBM_SCAN_LOG_DUMP,
  74         RTAS_FNIDX__IBM_SET_DYNAMIC_INDICATOR,
  75         RTAS_FNIDX__IBM_SET_EEH_OPTION,
  76         RTAS_FNIDX__IBM_SET_SLOT_RESET,
  77         RTAS_FNIDX__IBM_SET_SYSTEM_PARAMETER,
  78         RTAS_FNIDX__IBM_SET_XIVE,
  79         RTAS_FNIDX__IBM_SLOT_ERROR_DETAIL,
  80         RTAS_FNIDX__IBM_SUSPEND_ME,
  81         RTAS_FNIDX__IBM_TUNE_DMA_PARMS,
  82         RTAS_FNIDX__IBM_UPDATE_FLASH_64_AND_REBOOT,
  83         RTAS_FNIDX__IBM_UPDATE_NODES,
  84         RTAS_FNIDX__IBM_UPDATE_PROPERTIES,
  85         RTAS_FNIDX__IBM_VALIDATE_FLASH_IMAGE,
  86         RTAS_FNIDX__IBM_WRITE_PCI_CONFIG,
  87         RTAS_FNIDX__NVRAM_FETCH,
  88         RTAS_FNIDX__NVRAM_STORE,
  89         RTAS_FNIDX__POWER_OFF,
  90         RTAS_FNIDX__PUT_TERM_CHAR,
  91         RTAS_FNIDX__QUERY_CPU_STOPPED_STATE,
  92         RTAS_FNIDX__READ_PCI_CONFIG,
  93         RTAS_FNIDX__RTAS_LAST_ERROR,
  94         RTAS_FNIDX__SET_INDICATOR,
  95         RTAS_FNIDX__SET_POWER_LEVEL,
  96         RTAS_FNIDX__SET_TIME_FOR_POWER_ON,
  97         RTAS_FNIDX__SET_TIME_OF_DAY,
  98         RTAS_FNIDX__START_CPU,
  99         RTAS_FNIDX__STOP_SELF,
 100         RTAS_FNIDX__SYSTEM_REBOOT,
 101         RTAS_FNIDX__THAW_TIME_BASE,
 102         RTAS_FNIDX__WRITE_PCI_CONFIG,
 103 };
 104
 105 /*
 106  * Opaque handle for client code to refer to RTAS functions. All valid
 107  * function handles are build-time constants prefixed with RTAS_FN_.
 108  */
 109 typedef struct {
 110         const enum rtas_function_index index;
 111 } rtas_fn_handle_t;
 112
 113
 114 #define rtas_fn_handle(x_) ((const rtas_fn_handle_t) { .index = x_, })
 115
 116 #define RTAS_FN_CHECK_EXCEPTION                   rtas_fn_handle(RTAS_FNIDX__CHECK_EXCEPTION)
 117 #define RTAS_FN_DISPLAY_CHARACTER                 rtas_fn_handle(RTAS_FNIDX__DISPLAY_CHARACTER)
 118 #define RTAS_FN_EVENT_SCAN                        rtas_fn_handle(RTAS_FNIDX__EVENT_SCAN)
 119 #define RTAS_FN_FREEZE_TIME_BASE                  rtas_fn_handle(RTAS_FNIDX__FREEZE_TIME_BASE)
 120 #define RTAS_FN_GET_POWER_LEVEL                   rtas_fn_handle(RTAS_FNIDX__GET_POWER_LEVEL)
 121 #define RTAS_FN_GET_SENSOR_STATE                  rtas_fn_handle(RTAS_FNIDX__GET_SENSOR_STATE)
 122 #define RTAS_FN_GET_TERM_CHAR                     rtas_fn_handle(RTAS_FNIDX__GET_TERM_CHAR)
 123 #define RTAS_FN_GET_TIME_OF_DAY                   rtas_fn_handle(RTAS_FNIDX__GET_TIME_OF_DAY)
 124 #define RTAS_FN_IBM_ACTIVATE_FIRMWARE             rtas_fn_handle(RTAS_FNIDX__IBM_ACTIVATE_FIRMWARE)
 125 #define RTAS_FN_IBM_CBE_START_PTCAL               rtas_fn_handle(RTAS_FNIDX__IBM_CBE_START_PTCAL)
 126 #define RTAS_FN_IBM_CBE_STOP_PTCAL                rtas_fn_handle(RTAS_FNIDX__IBM_CBE_STOP_PTCAL)
 127 #define RTAS_FN_IBM_CHANGE_MSI                    rtas_fn_handle(RTAS_FNIDX__IBM_CHANGE_MSI)
 128 #define RTAS_FN_IBM_CLOSE_ERRINJCT                rtas_fn_handle(RTAS_FNIDX__IBM_CLOSE_ERRINJCT)
 129 #define RTAS_FN_IBM_CONFIGURE_BRIDGE              rtas_fn_handle(RTAS_FNIDX__IBM_CONFIGURE_BRIDGE)
 130 #define RTAS_FN_IBM_CONFIGURE_CONNECTOR           rtas_fn_handle(RTAS_FNIDX__IBM_CONFIGURE_CONNECTOR)
 131 #define RTAS_FN_IBM_CONFIGURE_KERNEL_DUMP         rtas_fn_handle(RTAS_FNIDX__IBM_CONFIGURE_KERNEL_DUMP)
 132 #define RTAS_FN_IBM_CONFIGURE_PE                  rtas_fn_handle(RTAS_FNIDX__IBM_CONFIGURE_PE)
 133 #define RTAS_FN_IBM_CREATE_PE_DMA_WINDOW          rtas_fn_handle(RTAS_FNIDX__IBM_CREATE_PE_DMA_WINDOW)
 134 #define RTAS_FN_IBM_DISPLAY_MESSAGE               rtas_fn_handle(RTAS_FNIDX__IBM_DISPLAY_MESSAGE)
 135 #define RTAS_FN_IBM_ERRINJCT                      rtas_fn_handle(RTAS_FNIDX__IBM_ERRINJCT)
 136 #define RTAS_FN_IBM_EXTI2C                        rtas_fn_handle(RTAS_FNIDX__IBM_EXTI2C)
 137 #define RTAS_FN_IBM_GET_CONFIG_ADDR_INFO          rtas_fn_handle(RTAS_FNIDX__IBM_GET_CONFIG_ADDR_INFO)
 138 #define RTAS_FN_IBM_GET_CONFIG_ADDR_INFO2         rtas_fn_handle(RTAS_FNIDX__IBM_GET_CONFIG_ADDR_INFO2)
 139 #define RTAS_FN_IBM_GET_DYNAMIC_SENSOR_STATE      rtas_fn_handle(RTAS_FNIDX__IBM_GET_DYNAMIC_SENSOR_STATE)
 140 #define RTAS_FN_IBM_GET_INDICES                   rtas_fn_handle(RTAS_FNIDX__IBM_GET_INDICES)
 141 #define RTAS_FN_IBM_GET_RIO_TOPOLOGY              rtas_fn_handle(RTAS_FNIDX__IBM_GET_RIO_TOPOLOGY)
 142 #define RTAS_FN_IBM_GET_SYSTEM_PARAMETER          rtas_fn_handle(RTAS_FNIDX__IBM_GET_SYSTEM_PARAMETER)
 143 #define RTAS_FN_IBM_GET_VPD                       rtas_fn_handle(RTAS_FNIDX__IBM_GET_VPD)
 144 #define RTAS_FN_IBM_GET_XIVE                      rtas_fn_handle(RTAS_FNIDX__IBM_GET_XIVE)
 145 #define RTAS_FN_IBM_INT_OFF                       rtas_fn_handle(RTAS_FNIDX__IBM_INT_OFF)
 146 #define RTAS_FN_IBM_INT_ON                        rtas_fn_handle(RTAS_FNIDX__IBM_INT_ON)
 147 #define RTAS_FN_IBM_IO_QUIESCE_ACK                rtas_fn_handle(RTAS_FNIDX__IBM_IO_QUIESCE_ACK)
 148 #define RTAS_FN_IBM_LPAR_PERFTOOLS                rtas_fn_handle(RTAS_FNIDX__IBM_LPAR_PERFTOOLS)
 149 #define RTAS_FN_IBM_MANAGE_FLASH_IMAGE            rtas_fn_handle(RTAS_FNIDX__IBM_MANAGE_FLASH_IMAGE)
 150 #define RTAS_FN_IBM_MANAGE_STORAGE_PRESERVATION   rtas_fn_handle(RTAS_FNIDX__IBM_MANAGE_STORAGE_PRESERVATION)
 151 #define RTAS_FN_IBM_NMI_INTERLOCK                 rtas_fn_handle(RTAS_FNIDX__IBM_NMI_INTERLOCK)
 152 #define RTAS_FN_IBM_NMI_REGISTER                  rtas_fn_handle(RTAS_FNIDX__IBM_NMI_REGISTER)
 153 #define RTAS_FN_IBM_OPEN_ERRINJCT                 rtas_fn_handle(RTAS_FNIDX__IBM_OPEN_ERRINJCT)
 154 #define RTAS_FN_IBM_OPEN_SRIOV_ALLOW_UNFREEZE     rtas_fn_handle(RTAS_FNIDX__IBM_OPEN_SRIOV_ALLOW_UNFREEZE)
 155 #define RTAS_FN_IBM_OPEN_SRIOV_MAP_PE_NUMBER      rtas_fn_handle(RTAS_FNIDX__IBM_OPEN_SRIOV_MAP_PE_NUMBER)
 156 #define RTAS_FN_IBM_OS_TERM                       rtas_fn_handle(RTAS_FNIDX__IBM_OS_TERM)
 157 #define RTAS_FN_IBM_PARTNER_CONTROL               rtas_fn_handle(RTAS_FNIDX__IBM_PARTNER_CONTROL)
 158 #define RTAS_FN_IBM_PHYSICAL_ATTESTATION          rtas_fn_handle(RTAS_FNIDX__IBM_PHYSICAL_ATTESTATION)
 159 #define RTAS_FN_IBM_PLATFORM_DUMP                 rtas_fn_handle(RTAS_FNIDX__IBM_PLATFORM_DUMP)
 160 #define RTAS_FN_IBM_POWER_OFF_UPS                 rtas_fn_handle(RTAS_FNIDX__IBM_POWER_OFF_UPS)
 161 #define RTAS_FN_IBM_QUERY_INTERRUPT_SOURCE_NUMBER rtas_fn_handle(RTAS_FNIDX__IBM_QUERY_INTERRUPT_SOURCE_NUMBER)
 162 #define RTAS_FN_IBM_QUERY_PE_DMA_WINDOW           rtas_fn_handle(RTAS_FNIDX__IBM_QUERY_PE_DMA_WINDOW)
 163 #define RTAS_FN_IBM_READ_PCI_CONFIG               rtas_fn_handle(RTAS_FNIDX__IBM_READ_PCI_CONFIG)
 164 #define RTAS_FN_IBM_READ_SLOT_RESET_STATE         rtas_fn_handle(RTAS_FNIDX__IBM_READ_SLOT_RESET_STATE)
 165 #define RTAS_FN_IBM_READ_SLOT_RESET_STATE2        rtas_fn_handle(RTAS_FNIDX__IBM_READ_SLOT_RESET_STATE2)
 166 #define RTAS_FN_IBM_REMOVE_PE_DMA_WINDOW          rtas_fn_handle(RTAS_FNIDX__IBM_REMOVE_PE_DMA_WINDOW)
 167 #define RTAS_FN_IBM_RESET_PE_DMA_WINDOW           rtas_fn_handle(RTAS_FNIDX__IBM_RESET_PE_DMA_WINDOW)
 168 #define RTAS_FN_IBM_SCAN_LOG_DUMP                 rtas_fn_handle(RTAS_FNIDX__IBM_SCAN_LOG_DUMP)
 169 #define RTAS_FN_IBM_SET_DYNAMIC_INDICATOR         rtas_fn_handle(RTAS_FNIDX__IBM_SET_DYNAMIC_INDICATOR)
 170 #define RTAS_FN_IBM_SET_EEH_OPTION                rtas_fn_handle(RTAS_FNIDX__IBM_SET_EEH_OPTION)
 171 #define RTAS_FN_IBM_SET_SLOT_RESET                rtas_fn_handle(RTAS_FNIDX__IBM_SET_SLOT_RESET)
 172 #define RTAS_FN_IBM_SET_SYSTEM_PARAMETER          rtas_fn_handle(RTAS_FNIDX__IBM_SET_SYSTEM_PARAMETER)
 173 #define RTAS_FN_IBM_SET_XIVE                      rtas_fn_handle(RTAS_FNIDX__IBM_SET_XIVE)
 174 #define RTAS_FN_IBM_SLOT_ERROR_DETAIL             rtas_fn_handle(RTAS_FNIDX__IBM_SLOT_ERROR_DETAIL)
 175 #define RTAS_FN_IBM_SUSPEND_ME                    rtas_fn_handle(RTAS_FNIDX__IBM_SUSPEND_ME)
 176 #define RTAS_FN_IBM_TUNE_DMA_PARMS                rtas_fn_handle(RTAS_FNIDX__IBM_TUNE_DMA_PARMS)
 177 #define RTAS_FN_IBM_UPDATE_FLASH_64_AND_REBOOT    rtas_fn_handle(RTAS_FNIDX__IBM_UPDATE_FLASH_64_AND_REBOOT)
 178 #define RTAS_FN_IBM_UPDATE_NODES                  rtas_fn_handle(RTAS_FNIDX__IBM_UPDATE_NODES)
 179 #define RTAS_FN_IBM_UPDATE_PROPERTIES             rtas_fn_handle(RTAS_FNIDX__IBM_UPDATE_PROPERTIES)
 180 #define RTAS_FN_IBM_VALIDATE_FLASH_IMAGE          rtas_fn_handle(RTAS_FNIDX__IBM_VALIDATE_FLASH_IMAGE)
 181 #define RTAS_FN_IBM_WRITE_PCI_CONFIG              rtas_fn_handle(RTAS_FNIDX__IBM_WRITE_PCI_CONFIG)
 182 #define RTAS_FN_NVRAM_FETCH                       rtas_fn_handle(RTAS_FNIDX__NVRAM_FETCH)
 183 #define RTAS_FN_NVRAM_STORE                       rtas_fn_handle(RTAS_FNIDX__NVRAM_STORE)
 184 #define RTAS_FN_POWER_OFF                         rtas_fn_handle(RTAS_FNIDX__POWER_OFF)
 185 #define RTAS_FN_PUT_TERM_CHAR                     rtas_fn_handle(RTAS_FNIDX__PUT_TERM_CHAR)
 186 #define RTAS_FN_QUERY_CPU_STOPPED_STATE           rtas_fn_handle(RTAS_FNIDX__QUERY_CPU_STOPPED_STATE)
 187 #define RTAS_FN_READ_PCI_CONFIG                   rtas_fn_handle(RTAS_FNIDX__READ_PCI_CONFIG)
 188 #define RTAS_FN_RTAS_LAST_ERROR                   rtas_fn_handle(RTAS_FNIDX__RTAS_LAST_ERROR)
 189 #define RTAS_FN_SET_INDICATOR                     rtas_fn_handle(RTAS_FNIDX__SET_INDICATOR)
 190 #define RTAS_FN_SET_POWER_LEVEL                   rtas_fn_handle(RTAS_FNIDX__SET_POWER_LEVEL)
 191 #define RTAS_FN_SET_TIME_FOR_POWER_ON             rtas_fn_handle(RTAS_FNIDX__SET_TIME_FOR_POWER_ON)
 192 #define RTAS_FN_SET_TIME_OF_DAY                   rtas_fn_handle(RTAS_FNIDX__SET_TIME_OF_DAY)
 193 #define RTAS_FN_START_CPU                         rtas_fn_handle(RTAS_FNIDX__START_CPU)
 194 #define RTAS_FN_STOP_SELF                         rtas_fn_handle(RTAS_FNIDX__STOP_SELF)
 195 #define RTAS_FN_SYSTEM_REBOOT                     rtas_fn_handle(RTAS_FNIDX__SYSTEM_REBOOT)
 196 #define RTAS_FN_THAW_TIME_BASE                    rtas_fn_handle(RTAS_FNIDX__THAW_TIME_BASE)
 197 #define RTAS_FN_WRITE_PCI_CONFIG                  rtas_fn_handle(RTAS_FNIDX__WRITE_PCI_CONFIG)
 198
 199 #define RTAS_UNKNOWN_SERVICE (-1)
 200 #define RTAS_INSTANTIATE_MAX (1ULL<<30) /* Don't instantiate rtas at/above this value */
 201
 202 /* Memory set aside for sys_rtas to use with calls that need a work area. */
 203 #define RTAS_USER_REGION_SIZE (64 * 1024)
 204
 205 /*
 206  * Common RTAS function return values, derived from the table "RTAS
 207  * Status Word Values" in PAPR+ v2.13 7.2.8: "Return Codes". If a
 208  * function can return a value in this table then generally it has the
 209  * meaning listed here. More extended commentary in the documentation
 210  * for rtas_call().
 211  *
 212  * RTAS functions may use negative and positive numbers not in this
 213  * set for function-specific error and success conditions,
 214  * respectively.
 215  */
 216 #define RTAS_SUCCESS                     0 /* Success. */
 217 #define RTAS_HARDWARE_ERROR             -1 /* Hardware or other unspecified error. */
 218 #define RTAS_BUSY                       -2 /* Retry immediately. */
 219 #define RTAS_INVALID_PARAMETER          -3 /* Invalid indicator/domain/sensor etc. */
 220 #define RTAS_UNEXPECTED_STATE_CHANGE    -7 /* Seems limited to EEH and slot reset. */
 221 #define RTAS_EXTENDED_DELAY_MIN       9900 /* Retry after delaying for ~1ms. */
 222 #define RTAS_EXTENDED_DELAY_MAX       9905 /* Retry after delaying for ~100s. */
 223 #define RTAS_ML_ISOLATION_ERROR      -9000 /* Multi-level isolation error. */
 224
 225 /* statuses specific to ibm,suspend-me */
 226 #define RTAS_SUSPEND_ABORTED     9000 /* Suspension aborted */
 227 #define RTAS_NOT_SUSPENDABLE    -9004 /* Partition not suspendable */
 228 #define RTAS_THREADS_ACTIVE     -9005 /* Multiple processor threads active */
 229 #define RTAS_OUTSTANDING_COPROC -9006 /* Outstanding coprocessor operations */
 230
 231 /* RTAS event classes */
 232 #define RTAS_INTERNAL_ERROR             0x80000000 /* set bit 0 */
 233 #define RTAS_EPOW_WARNING               0x40000000 /* set bit 1 */
 234 #define RTAS_HOTPLUG_EVENTS             0x10000000 /* set bit 3 */
 235 #define RTAS_IO_EVENTS                  0x08000000 /* set bit 4 */
 236 #define RTAS_EVENT_SCAN_ALL_EVENTS      0xffffffff
 237
 238 /* RTAS event severity */
 239 #define RTAS_SEVERITY_FATAL             0x5
 240 #define RTAS_SEVERITY_ERROR             0x4
 241 #define RTAS_SEVERITY_ERROR_SYNC        0x3
 242 #define RTAS_SEVERITY_WARNING           0x2
 243 #define RTAS_SEVERITY_EVENT             0x1
 244 #define RTAS_SEVERITY_NO_ERROR          0x0
 245
 246 /* RTAS event disposition */
 247 #define RTAS_DISP_FULLY_RECOVERED       0x0
 248 #define RTAS_DISP_LIMITED_RECOVERY      0x1
 249 #define RTAS_DISP_NOT_RECOVERED         0x2
 250
 251 /* RTAS event initiator */
 252 #define RTAS_INITIATOR_UNKNOWN          0x0
 253 #define RTAS_INITIATOR_CPU              0x1
 254 #define RTAS_INITIATOR_PCI              0x2
 255 #define RTAS_INITIATOR_ISA              0x3
 256 #define RTAS_INITIATOR_MEMORY           0x4
 257 #define RTAS_INITIATOR_POWERMGM         0x5
 258
 259 /* RTAS event target */
 260 #define RTAS_TARGET_UNKNOWN             0x0
 261 #define RTAS_TARGET_CPU                 0x1
 262 #define RTAS_TARGET_PCI                 0x2
 263 #define RTAS_TARGET_ISA                 0x3
 264 #define RTAS_TARGET_MEMORY              0x4
 265 #define RTAS_TARGET_POWERMGM            0x5
 266
 267 /* RTAS event type */
 268 #define RTAS_TYPE_RETRY                 0x01
 269 #define RTAS_TYPE_TCE_ERR               0x02
 270 #define RTAS_TYPE_INTERN_DEV_FAIL       0x03
 271 #define RTAS_TYPE_TIMEOUT               0x04
 272 #define RTAS_TYPE_DATA_PARITY           0x05
 273 #define RTAS_TYPE_ADDR_PARITY           0x06
 274 #define RTAS_TYPE_CACHE_PARITY          0x07
 275 #define RTAS_TYPE_ADDR_INVALID          0x08
 276 #define RTAS_TYPE_ECC_UNCORR            0x09
 277 #define RTAS_TYPE_ECC_CORR              0x0a
 278 #define RTAS_TYPE_EPOW                  0x40
 279 #define RTAS_TYPE_PLATFORM              0xE0
 280 #define RTAS_TYPE_IO                    0xE1
 281 #define RTAS_TYPE_INFO                  0xE2
 282 #define RTAS_TYPE_DEALLOC               0xE3
 283 #define RTAS_TYPE_DUMP                  0xE4
 284 #define RTAS_TYPE_HOTPLUG               0xE5
 285 /* I don't add PowerMGM events right now, this is a different topic */
 286 #define RTAS_TYPE_PMGM_POWER_SW_ON      0x60
 287 #define RTAS_TYPE_PMGM_POWER_SW_OFF     0x61
 288 #define RTAS_TYPE_PMGM_LID_OPEN         0x62
 289 #define RTAS_TYPE_PMGM_LID_CLOSE        0x63
 290 #define RTAS_TYPE_PMGM_SLEEP_BTN        0x64
 291 #define RTAS_TYPE_PMGM_WAKE_BTN         0x65
 292 #define RTAS_TYPE_PMGM_BATTERY_WARN     0x66
 293 #define RTAS_TYPE_PMGM_BATTERY_CRIT     0x67
 294 #define RTAS_TYPE_PMGM_SWITCH_TO_BAT    0x68
 295 #define RTAS_TYPE_PMGM_SWITCH_TO_AC     0x69
 296 #define RTAS_TYPE_PMGM_KBD_OR_MOUSE     0x6a
 297 #define RTAS_TYPE_PMGM_ENCLOS_OPEN      0x6b
 298 #define RTAS_TYPE_PMGM_ENCLOS_CLOSED    0x6c
 299 #define RTAS_TYPE_PMGM_RING_INDICATE    0x6d
 300 #define RTAS_TYPE_PMGM_LAN_ATTENTION    0x6e
 301 #define RTAS_TYPE_PMGM_TIME_ALARM       0x6f
 302 #define RTAS_TYPE_PMGM_CONFIG_CHANGE    0x70
 303 #define RTAS_TYPE_PMGM_SERVICE_PROC     0x71
 304 /* Platform Resource Reassignment Notification */
 305 #define RTAS_TYPE_PRRN                  0xA0
 306
 307 /* RTAS check-exception vector offset */
 308 #define RTAS_VECTOR_EXTERNAL_INTERRUPT  0x500
 309
 310 static inline uint8_t rtas_error_severity(const struct rtas_error_log *elog)
 311 {
 312         return (elog->byte1 & 0xE0) >> 5;
 313 }
 314
 315 static inline uint8_t rtas_error_disposition(const struct rtas_error_log *elog)
 316 {
 317         return (elog->byte1 & 0x18) >> 3;
 318 }
 319
 320 static inline
 321 void rtas_set_disposition_recovered(struct rtas_error_log *elog)
 322 {
 323         elog->byte1 &= ~0x18;
 324         elog->byte1 |= (RTAS_DISP_FULLY_RECOVERED << 3);
 325 }
 326
 327 static inline uint8_t rtas_error_extended(const struct rtas_error_log *elog)
 328 {
 329         return (elog->byte1 & 0x04) >> 2;
 330 }
 331
 332 static inline uint8_t rtas_error_initiator(const struct rtas_error_log *elog)
 333 {
 334         return (elog->byte2 & 0xf0) >> 4;
 335 }
 336
 337 #define rtas_error_type(x)      ((x)->byte3)
 338
 339 static inline
 340 uint32_t rtas_error_extended_log_length(const struct rtas_error_log *elog)
 341 {
 342         return be32_to_cpu(elog->extended_log_length);
 343 }
 344
 345 #define RTAS_V6EXT_LOG_FORMAT_EVENT_LOG 14
 346
 347 #define RTAS_V6EXT_COMPANY_ID_IBM       (('I' << 24) | ('B' << 16) | ('M' << 8))
 348
 349 static
 350 inline uint8_t rtas_ext_event_log_format(struct rtas_ext_event_log_v6 *ext_log)
 351 {
 352         return ext_log->byte2 & 0x0F;
 353 }
 354
 355 static
 356 inline uint32_t rtas_ext_event_company_id(struct rtas_ext_event_log_v6 *ext_log)
 357 {
 358         return be32_to_cpu(ext_log->company_id);
 359 }
 360
 361 /* pSeries event log format */
 362
 363 /* Two bytes ASCII section IDs */
 364 #define PSERIES_ELOG_SECT_ID_PRIV_HDR           (('P' << 8) | 'H')
 365 #define PSERIES_ELOG_SECT_ID_USER_HDR           (('U' << 8) | 'H')
 366 #define PSERIES_ELOG_SECT_ID_PRIMARY_SRC        (('P' << 8) | 'S')
 367 #define PSERIES_ELOG_SECT_ID_EXTENDED_UH        (('E' << 8) | 'H')
 368 #define PSERIES_ELOG_SECT_ID_FAILING_MTMS       (('M' << 8) | 'T')
 369 #define PSERIES_ELOG_SECT_ID_SECONDARY_SRC      (('S' << 8) | 'S')
 370 #define PSERIES_ELOG_SECT_ID_DUMP_LOCATOR       (('D' << 8) | 'H')
 371 #define PSERIES_ELOG_SECT_ID_FW_ERROR           (('S' << 8) | 'W')
 372 #define PSERIES_ELOG_SECT_ID_IMPACT_PART_ID     (('L' << 8) | 'P')
 373 #define PSERIES_ELOG_SECT_ID_LOGIC_RESOURCE_ID  (('L' << 8) | 'R')
 374 #define PSERIES_ELOG_SECT_ID_HMC_ID             (('H' << 8) | 'M')
 375 #define PSERIES_ELOG_SECT_ID_EPOW               (('E' << 8) | 'P')
 376 #define PSERIES_ELOG_SECT_ID_IO_EVENT           (('I' << 8) | 'E')
 377 #define PSERIES_ELOG_SECT_ID_MANUFACT_INFO      (('M' << 8) | 'I')
 378 #define PSERIES_ELOG_SECT_ID_CALL_HOME          (('C' << 8) | 'H')
 379 #define PSERIES_ELOG_SECT_ID_USER_DEF           (('U' << 8) | 'D')
 380 #define PSERIES_ELOG_SECT_ID_HOTPLUG            (('H' << 8) | 'P')
 381 #define PSERIES_ELOG_SECT_ID_MCE                (('M' << 8) | 'C')
 382
 383 static
 384 inline uint16_t pseries_errorlog_id(struct pseries_errorlog *sect)
 385 {
 386         return be16_to_cpu(sect->id);
 387 }
 388
 389 static
 390 inline uint16_t pseries_errorlog_length(struct pseries_errorlog *sect)
 391 {
 392         return be16_to_cpu(sect->length);
 393 }
 394
 395 #define PSERIES_HP_ELOG_RESOURCE_CPU    1
 396 #define PSERIES_HP_ELOG_RESOURCE_MEM    2
 397 #define PSERIES_HP_ELOG_RESOURCE_SLOT   3
 398 #define PSERIES_HP_ELOG_RESOURCE_PHB    4
 399 #define PSERIES_HP_ELOG_RESOURCE_PMEM   6
 400
 401 #define PSERIES_HP_ELOG_ACTION_ADD      1
 402 #define PSERIES_HP_ELOG_ACTION_REMOVE   2
 403
 404 #define PSERIES_HP_ELOG_ID_DRC_NAME     1
 405 #define PSERIES_HP_ELOG_ID_DRC_INDEX    2
 406 #define PSERIES_HP_ELOG_ID_DRC_COUNT    3
 407 #define PSERIES_HP_ELOG_ID_DRC_IC       4
 408
 409 struct pseries_errorlog *get_pseries_errorlog(struct rtas_error_log *log,
 410                                               uint16_t section_id);
 411
 412 /*
 413  * This can be set by the rtas_flash module so that it can get called
 414  * as the absolutely last thing before the kernel terminates.
 415  */
 416 extern void (*rtas_flash_term_hook)(int);
 417
 418 extern struct rtas_t rtas;
 419
 420 s32 rtas_function_token(const rtas_fn_handle_t handle);
 421 static inline bool rtas_function_implemented(const rtas_fn_handle_t handle)
 422 {
 423         return rtas_function_token(handle) != RTAS_UNKNOWN_SERVICE;
 424 }
 425 int rtas_token(const char *service);
 426 int rtas_call(int token, int nargs, int nret, int *outputs, ...);
 427 void rtas_call_unlocked(struct rtas_args *args, int token, int nargs,
 428                         int nret, ...);
 429 void __noreturn rtas_restart(char *cmd);
 430 void rtas_power_off(void);
 431 void __noreturn rtas_halt(void);
 432 void rtas_os_term(char *str);
 433 void rtas_activate_firmware(void);
 434 int rtas_get_sensor(int sensor, int index, int *state);
 435 int rtas_get_sensor_fast(int sensor, int index, int *state);
 436 int rtas_get_power_level(int powerdomain, int *level);
 437 int rtas_set_power_level(int powerdomain, int level, int *setlevel);
 438 bool rtas_indicator_present(int token, int *maxindex);
 439 int rtas_set_indicator(int indicator, int index, int new_value);
 440 int rtas_set_indicator_fast(int indicator, int index, int new_value);
 441 void rtas_progress(char *s, unsigned short hex);
 442 int rtas_ibm_suspend_me(int *fw_status);
 443 int rtas_error_rc(int rtas_rc);
 444
 445 struct rtc_time;
 446 time64_t rtas_get_boot_time(void);
 447 void rtas_get_rtc_time(struct rtc_time *rtc_time);
 448 int rtas_set_rtc_time(struct rtc_time *rtc_time);
 449
 450 unsigned int rtas_busy_delay_time(int status);
 451 bool rtas_busy_delay(int status);
 452
 453 int early_init_dt_scan_rtas(unsigned long node, const char *uname, int depth, void *data);
 454
 455 void pSeries_log_error(char *buf, unsigned int err_type, int fatal);
 456
 457 #ifdef CONFIG_PPC_PSERIES
 458 extern time64_t last_rtas_event;
 459 int clobbering_unread_rtas_event(void);
 460 int rtas_syscall_dispatch_ibm_suspend_me(u64 handle);
 461 #else
 462 static inline int clobbering_unread_rtas_event(void) { return 0; }
 463 static inline int rtas_syscall_dispatch_ibm_suspend_me(u64 handle)
 464 {
 465         return -EINVAL;
 466 }
 467 #endif
 468
 469 #ifdef CONFIG_PPC_RTAS_DAEMON
 470 void rtas_cancel_event_scan(void);
 471 #else
 472 static inline void rtas_cancel_event_scan(void) { }
 473 #endif
 474
 475 /* Error types logged.  */
 476 #define ERR_FLAG_ALREADY_LOGGED 0x0
 477 #define ERR_FLAG_BOOT           0x1     /* log was pulled from NVRAM on boot */
 478 #define ERR_TYPE_RTAS_LOG       0x2     /* from rtas event-scan */
 479 #define ERR_TYPE_KERNEL_PANIC   0x4     /* from die()/panic() */
 480 #define ERR_TYPE_KERNEL_PANIC_GZ 0x8    /* ditto, compressed */
 481
 482 /* All the types and not flags */
 483 #define ERR_TYPE_MASK \
 484         (ERR_TYPE_RTAS_LOG | ERR_TYPE_KERNEL_PANIC | ERR_TYPE_KERNEL_PANIC_GZ)
 485
 486 #define RTAS_DEBUG KERN_DEBUG "RTAS: "
 487
 488 #define RTAS_ERROR_LOG_MAX 2048
 489
 490 /*
 491  * Return the firmware-specified size of the error log buffer
 492  *  for all rtas calls that require an error buffer argument.
 493  *  This includes 'check-exception' and 'rtas-last-error'.
 494  */
 495 int rtas_get_error_log_max(void);
 496
 497 /* Event Scan Parameters */
 498 #define EVENT_SCAN_ALL_EVENTS   0xf0000000
 499 #define SURVEILLANCE_TOKEN      9000
 500 #define LOG_NUMBER              64              /* must be a power of two */
 501 #define LOG_NUMBER_MASK         (LOG_NUMBER-1)
 502
 503 /* Some RTAS ops require a data buffer and that buffer must be < 4G.
 504  * Rather than having a memory allocator, just use this buffer
 505  * (get the lock first), make the RTAS call.  Copy the data instead
 506  * of holding the buffer for long.
 507  */
 508
 509 #define RTAS_DATA_BUF_SIZE 4096
 510 extern spinlock_t rtas_data_buf_lock;
 511 extern char rtas_data_buf[RTAS_DATA_BUF_SIZE];
 512
 513 /* RMO buffer reserved for user-space RTAS use */
 514 extern unsigned long rtas_rmo_buf;
 515
 516 extern struct mutex rtas_ibm_get_vpd_lock;
 517
 518 #define GLOBAL_INTERRUPT_QUEUE 9005
 519
 520 /**
 521  * rtas_config_addr - Format a busno, devfn and reg for RTAS.
 522  * @busno: The bus number.
 523  * @devfn: The device and function number as encoded by PCI_DEVFN().
 524  * @reg: The register number.
 525  *
 526  * This function encodes the given busno, devfn and register number as
 527  * required for RTAS calls that take a "config_addr" parameter.
 528  * See PAPR requirement 7.3.4-1 for more info.
 529  */
 530 static inline u32 rtas_config_addr(int busno, int devfn, int reg)
 531 {
 532         return ((reg & 0xf00) << 20) | ((busno & 0xff) << 16) |
 533                         (devfn << 8) | (reg & 0xff);
 534 }
 535
 536 void rtas_give_timebase(void);
 537 void rtas_take_timebase(void);
 538
 539 #ifdef CONFIG_PPC_RTAS
 540 static inline int page_is_rtas_user_buf(unsigned long pfn)
 541 {
 542         unsigned long paddr = (pfn << PAGE_SHIFT);
 543         if (paddr >= rtas_rmo_buf && paddr < (rtas_rmo_buf + RTAS_USER_REGION_SIZE))
 544                 return 1;
 545         return 0;
 546 }
 547
 548 /* Not the best place to put pSeries_coalesce_init, will be fixed when we
 549  * move some of the rtas suspend-me stuff to pseries */
 550 void pSeries_coalesce_init(void);
 551 void rtas_initialize(void);
 552 #else
 553 static inline int page_is_rtas_user_buf(unsigned long pfn) { return 0;}
 554 static inline void pSeries_coalesce_init(void) { }
 555 static inline void rtas_initialize(void) { }
 556 #endif
 557
 558 #ifdef CONFIG_HV_PERF_CTRS
 559 void read_24x7_sys_info(void);
 560 #else
 561 static inline void read_24x7_sys_info(void) { }
 562 #endif
 563
 564 #endif /* __KERNEL__ */
 565 #endif /* _POWERPC_RTAS_H */