1 /*- 2 * Copyright (c) 2015 Nathan Whitehorn 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24 * SUCH DAMAGE. 25 */ 26 27 #ifndef _POWERNV_OPAL_H 28 #define _POWERNV_OPAL_H 29 30 #include <sys/cdefs.h> 31 #include <sys/types.h> 32 #include <sys/_eventhandler.h> 33 34 /* Check if OPAL is correctly instantiated. Will try to instantiate it. */ 35 int opal_check(void); 36 37 /* Call an OPAL method. Any pointers passed must be real-mode accessible! */ 38 int opal_call(uint64_t token, ...); 39 40 #define OPAL_CONSOLE_WRITE 1 41 #define OPAL_CONSOLE_READ 2 42 #define OPAL_RTC_READ 3 43 #define OPAL_RTC_WRITE 4 44 #define OPAL_CEC_POWER_DOWN 5 45 #define OPAL_CEC_REBOOT 6 46 #define OPAL_READ_NVRAM 7 47 #define OPAL_WRITE_NVRAM 8 48 #define OPAL_HANDLE_INTERRUPT 9 49 #define OPAL_POLL_EVENTS 10 50 #define OPAL_PCI_CONFIG_READ_BYTE 13 51 #define OPAL_PCI_CONFIG_READ_HALF_WORD 14 52 #define OPAL_PCI_CONFIG_READ_WORD 15 53 #define OPAL_PCI_CONFIG_WRITE_BYTE 16 54 #define OPAL_PCI_CONFIG_WRITE_HALF_WORD 17 55 #define OPAL_PCI_CONFIG_WRITE_WORD 18 56 #define OPAL_PCI_EEH_FREEZE_STATUS 23 57 #define OPAL_CONSOLE_WRITE_BUFFER_SPACE 25 58 #define OPAL_PCI_EEH_FREEZE_CLEAR 26 59 #define OPAL_PCI_PHB_MMIO_ENABLE 27 60 #define OPAL_PCI_SET_PHB_MEM_WINDOW 28 61 #define OPAL_PCI_MAP_PE_MMIO_WINDOW 29 62 #define OPAL_PCI_SET_XIVE_PE 37 63 #define OPAL_PCI_RESET 49 64 #define OPAL_PCI_POLL 62 65 #define OPAL_SET_XIVE 19 66 #define OPAL_GET_XIVE 20 67 #define OPAL_PCI_SET_PE 31 68 #define OPAL_GET_MSI_32 39 69 #define OPAL_GET_MSI_64 40 70 #define OPAL_PCI_MSI_EOI 63 71 #define OPAL_PCI_GET_PHB_DIAG_DATA2 64 72 #define OPAL_START_CPU 41 73 #define OPAL_PCI_MAP_PE_DMA_WINDOW 44 74 #define OPAL_PCI_MAP_PE_DMA_WINDOW_REAL 45 75 #define OPAL_RETURN_CPU 69 76 #define OPAL_REINIT_CPUS 70 77 #define OPAL_CHECK_TOKEN 80 78 #define OPAL_GET_MSG 85 79 #define OPAL_CHECK_ASYNC_COMPLETION 86 80 #define OPAL_SENSOR_READ 88 81 #define OPAL_HANDLE_HMI 98 82 #define OPAL_IPMI_SEND 107 83 #define OPAL_IPMI_RECV 108 84 #define OPAL_I2C_REQUEST 109 85 #define OPAL_FLASH_READ 110 86 #define OPAL_FLASH_WRITE 111 87 #define OPAL_FLASH_ERASE 112 88 #define OPAL_INT_GET_XIRR 122 89 #define OPAL_INT_SET_CPPR 123 90 #define OPAL_INT_EOI 124 91 #define OPAL_INT_SET_MFRR 125 92 #define OPAL_PCI_TCE_KILL 126 93 #define OPAL_NMMU_SET_PTCR 127 94 #define OPAL_XIVE_RESET 128 95 #define OPAL_XIVE_GET_IRQ_INFO 129 96 #define OPAL_XIVE_GET_IRQ_CONFIG 130 97 #define OPAL_XIVE_SET_IRQ_CONFIG 131 98 #define OPAL_XIVE_GET_QUEUE_INFO 132 99 #define OPAL_XIVE_SET_QUEUE_INFO 133 100 #define OPAL_XIVE_DONATE_PAGE 134 101 #define OPAL_XIVE_ALLOCATE_VP_BLOCK 135 102 #define OPAL_XIVE_FREE_VP_BLOCK 136 103 #define OPAL_XIVE_GET_VP_INFO 137 104 #define OPAL_XIVE_SET_VP_INFO 138 105 #define OPAL_XIVE_ALLOCATE_IRQ 139 106 #define OPAL_XIVE_FREE_IRQ 140 107 #define OPAL_XIVE_SYNC 141 108 #define OPAL_XIVE_DUMP 142 109 #define OPAL_SENSOR_GROUP_CLEAR 156 110 #define OPAL_SENSOR_READ_U64 162 111 #define OPAL_SENSOR_GROUP_ENABLE 163 112 #define OPAL_HANDLE_HMI2 166 113 114 /* For OPAL_PCI_SET_PE */ 115 #define OPAL_UNMAP_PE 0 116 #define OPAL_MAP_PE 1 117 118 #define OPAL_PCI_BUS_ANY 0 119 #define OPAL_PCI_BUS_3BITS 2 120 #define OPAL_PCI_BUS_4BITS 3 121 #define OPAL_PCI_BUS_5BITS 4 122 #define OPAL_PCI_BUS_6BITS 5 123 #define OPAL_PCI_BUS_7BITS 6 124 #define OPAL_PCI_BUS_ALL 7 /* Match bus number exactly */ 125 126 #define OPAL_IGNORE_RID_DEVICE_NUMBER 0 127 #define OPAL_COMPARE_RID_DEVICE_NUMBER 1 128 129 #define OPAL_IGNORE_RID_FUNC_NUMBER 0 130 #define OPAL_COMPARE_RID_FUNC_NUMBER 1 131 132 /* For OPAL_PCI_TCE_KILL */ 133 #define OPAL_PCI_TCE_KILL_PAGE 0 134 #define OPAL_PCI_TCE_KILL_PE 1 135 #define OPAL_PCI_TCE_KILL_ALL 2 136 137 #define OPAL_SUCCESS 0 138 #define OPAL_PARAMETER -1 139 #define OPAL_BUSY -2 140 #define OPAL_PARTIAL -3 141 #define OPAL_CONSTRAINED -4 142 #define OPAL_CLOSED -5 143 #define OPAL_HARDWARE -6 144 #define OPAL_UNSUPPORTED -7 145 #define OPAL_PERMISSION -8 146 #define OPAL_NO_MEM -9 147 #define OPAL_RESOURCE -10 148 #define OPAL_INTERNAL_ERROR -11 149 #define OPAL_BUSY_EVENT -12 150 #define OPAL_HARDWARE_FROZEN -13 151 #define OPAL_WRONG_STATE -14 152 #define OPAL_ASYNC_COMPLETION -15 153 #define OPAL_EMPTY -16 154 #define OPAL_I2C_TIMEOUT -17 155 #define OPAL_I2C_INVALID_CMD -18 156 #define OPAL_I2C_LBUS_PARITY -19 157 #define OPAL_I2C_BKEND_OVERRUN -20 158 #define OPAL_I2C_BKEND_ACCESS -21 159 #define OPAL_I2C_ARBT_LOST -22 160 #define OPAL_I2C_NACK_RCVD -23 161 #define OPAL_I2C_STOP_ERR -24 162 #define OPAL_XSCOM_PARTIAL_GOOD -25 163 #define OPAL_XSCOM_ADDR_ERROR -26 164 #define OPAL_XSCOM_CLOCK_ERROR -27 165 #define OPAL_XSCOM_PARITY_ERROR -28 166 #define OPAL_XSCOM_TIMEOUT -29 167 #define OPAL_XSCOM_CTR_OFFLINED -30 168 #define OPAL_XIVE_PROVISIONING -31 169 #define OPAL_XIVE_FREE_ACTIVE -32 170 #define OPAL_TIMEOUT -33 171 172 #define OPAL_TOKEN_ABSENT 0 173 #define OPAL_TOKEN_PRESENT 1 174 175 #define OPAL_EVENT_OPAL_INTERNAL 0x1 176 #define OPAL_EVENT_NVRAM 0x2 177 #define OPAL_EVENT_RTC 0x4 178 #define OPAL_EVENT_CONSOLE_INPUT 0x8 179 #define OPAL_EVENT_CONSOLE_OUTPUT 0x10 180 #define OPAL_EVENT_ERROR_LOG_AVAIL 0x20 181 #define OPAL_EVENT_ERROR_LOG 0x40 182 #define OPAL_EVENT_EPOW 0x80 183 #define OPAL_EVENT_LED_STATUS 0x100 184 #define OPAL_EVENT_PCI_ERROR 0x200 185 #define OPAL_EVENT_DUMP_AVAIL 0x400 186 #define OPAL_EVENT_MSG_PENDING 0x800 187 188 #define OPAL_HMI_FLAGS_TB_RESYNC (1ull << 0) 189 #define OPAL_HMI_FLAGS_DEC_LOST (1ull << 1) 190 #define OPAL_HMI_FLAGS_HDEC_LOST (1ull << 2) 191 #define OPAL_HMI_FLAGS_TOD_TB_FAIL (1ull << 3) 192 #define OPAL_HMI_FLAGS_NEW_EVENT (1ull << 63) 193 194 #define OPAL_XIVE_XICS_MODE_EMU 0 195 #define OPAL_XIVE_XICS_MODE_EXP 1 196 197 #define OPAL_XIVE_SYNC_EAS 0x00000001 198 #define OPAL_XIVE_SYNC_QUEUE 0x00000002 199 200 #define OPAL_XIVE_VP_ENABLED 0x00000001 201 #define OPAL_XIVE_VP_SINGLE_ESCALATION 0x00000002 202 203 #define OPAL_XIVE_EQ_ENABLED 0x00000001 204 #define OPAL_XIVE_EQ_ALWAYS_NOTIFY 0x00000002 205 #define OPAL_XIVE_EQ_ESCALATE 0x00000004 206 207 struct opal_msg { 208 uint32_t msg_type; 209 uint32_t reserved; 210 uint64_t params[8]; 211 }; 212 213 enum opal_msg_type { 214 OPAL_MSG_ASYNC_COMP = 0, 215 OPAL_MSG_MEM_ERR = 1, 216 OPAL_MSG_EPOW = 2, 217 OPAL_MSG_SHUTDOWN = 3, 218 OPAL_MSG_HMI_EVT = 4, 219 OPAL_MSG_DPO = 5, 220 OPAL_MSG_PRD = 6, 221 OPAL_MSG_OCC = 7, 222 OPAL_MSG_TYPE_MAX, 223 }; 224 225 #define OPAL_IPMI_MSG_FORMAT_VERSION_1 1 226 227 struct opal_ipmi_msg { 228 uint8_t version; 229 uint8_t netfn; 230 uint8_t cmd; 231 uint8_t data[]; 232 }; 233 234 int opal_init_async_tokens(int); 235 int opal_alloc_async_token(void); 236 void opal_free_async_token(int); 237 int opal_wait_completion(void *, uint64_t, int); 238 239 typedef void (*opal_msg_handler_fn)(void *, struct opal_msg *); 240 EVENTHANDLER_DECLARE(OPAL_ASYNC_COMP, opal_msg_handler_fn); 241 EVENTHANDLER_DECLARE(OPAL_EPOW, opal_msg_handler_fn); 242 EVENTHANDLER_DECLARE(OPAL_SHUTDOWN, opal_msg_handler_fn); 243 EVENTHANDLER_DECLARE(OPAL_HMI_EVT, opal_msg_handler_fn); 244 EVENTHANDLER_DECLARE(OPAL_DPO, opal_msg_handler_fn); 245 EVENTHANDLER_DECLARE(OPAL_OCC, opal_msg_handler_fn); 246 EVENTHANDLER_LIST_DECLARE(OPAL_ASYNC_COMP); 247 EVENTHANDLER_LIST_DECLARE(OPAL_EPOW); 248 EVENTHANDLER_LIST_DECLARE(OPAL_SHUTDOWN); 249 EVENTHANDLER_LIST_DECLARE(OPAL_HMI_EVT); 250 EVENTHANDLER_LIST_DECLARE(OPAL_DPO); 251 EVENTHANDLER_LIST_DECLARE(OPAL_OCC); 252 #endif 253