arch/powerpc/include/asm/opal.h

   1 /* SPDX-License-Identifier: GPL-2.0-or-later */
   2 /*
   3  * PowerNV OPAL definitions.
   4  *
   5  * Copyright 2011 IBM Corp.
   6  */
   7
   8 #ifndef _ASM_POWERPC_OPAL_H
   9 #define _ASM_POWERPC_OPAL_H
  10
  11 #include <asm/opal-api.h>
  12
  13 #ifndef __ASSEMBLY__
  14
  15 #include <linux/notifier.h>
  16
  17 /* We calculate number of sg entries based on PAGE_SIZE */
  18 #define SG_ENTRIES_PER_NODE ((PAGE_SIZE - 16) / sizeof(struct opal_sg_entry))
  19
  20 /* Default time to sleep or delay between OPAL_BUSY/OPAL_BUSY_EVENT loops */
  21 #define OPAL_BUSY_DELAY_MS      10
  22
  23 /* /sys/firmware/opal */
  24 extern struct kobject *opal_kobj;
  25
  26 /* /ibm,opal */
  27 extern struct device_node *opal_node;
  28
  29 /* API functions */
  30 int64_t opal_invalid_call(void);
  31 int64_t opal_npu_map_lpar(uint64_t phb_id, uint64_t bdf, uint64_t lparid,
  32                         uint64_t lpcr);
  33 int64_t opal_npu_spa_setup(uint64_t phb_id, uint32_t bdfn,
  34                         uint64_t addr, uint64_t PE_mask);
  35 int64_t opal_npu_spa_clear_cache(uint64_t phb_id, uint32_t bdfn,
  36                                 uint64_t PE_handle);
  37 int64_t opal_npu_tl_set(uint64_t phb_id, uint32_t bdfn, long cap,
  38                         uint64_t rate_phys, uint32_t size);
  39
  40 int64_t opal_console_write(int64_t term_number, __be64 *length,
  41                            const uint8_t *buffer);
  42 int64_t opal_console_read(int64_t term_number, __be64 *length,
  43                           uint8_t *buffer);
  44 int64_t opal_console_write_buffer_space(int64_t term_number,
  45                                         __be64 *length);
  46 int64_t opal_console_flush(int64_t term_number);
  47 int64_t opal_rtc_read(__be32 *year_month_day,
  48                       __be64 *hour_minute_second_millisecond);
  49 int64_t opal_rtc_write(uint32_t year_month_day,
  50                        uint64_t hour_minute_second_millisecond);
  51 int64_t opal_tpo_read(uint64_t token, __be32 *year_mon_day, __be32 *hour_min);
  52 int64_t opal_tpo_write(uint64_t token, uint32_t year_mon_day,
  53                        uint32_t hour_min);
  54 int64_t opal_cec_power_down(uint64_t request);
  55 int64_t opal_cec_reboot(void);
  56 int64_t opal_cec_reboot2(uint32_t reboot_type, const char *diag);
  57 int64_t opal_read_nvram(uint64_t buffer, uint64_t size, uint64_t offset);
  58 int64_t opal_write_nvram(uint64_t buffer, uint64_t size, uint64_t offset);
  59 int64_t opal_handle_interrupt(uint64_t isn, __be64 *outstanding_event_mask);
  60 int64_t opal_poll_events(__be64 *outstanding_event_mask);
  61 int64_t opal_pci_set_hub_tce_memory(uint64_t hub_id, uint64_t tce_mem_addr,
  62                                     uint64_t tce_mem_size);
  63 int64_t opal_pci_set_phb_tce_memory(uint64_t phb_id, uint64_t tce_mem_addr,
  64                                     uint64_t tce_mem_size);
  65 int64_t opal_pci_config_read_byte(uint64_t phb_id, uint64_t bus_dev_func,
  66                                   uint64_t offset, uint8_t *data);
  67 int64_t opal_pci_config_read_half_word(uint64_t phb_id, uint64_t bus_dev_func,
  68                                        uint64_t offset, __be16 *data);
  69 int64_t opal_pci_config_read_word(uint64_t phb_id, uint64_t bus_dev_func,
  70                                   uint64_t offset, __be32 *data);
  71 int64_t opal_pci_config_write_byte(uint64_t phb_id, uint64_t bus_dev_func,
  72                                    uint64_t offset, uint8_t data);
  73 int64_t opal_pci_config_write_half_word(uint64_t phb_id, uint64_t bus_dev_func,
  74                                         uint64_t offset, uint16_t data);
  75 int64_t opal_pci_config_write_word(uint64_t phb_id, uint64_t bus_dev_func,
  76                                    uint64_t offset, uint32_t data);
  77 int64_t opal_set_xive(uint32_t isn, uint16_t server, uint8_t priority);
  78 int64_t opal_get_xive(uint32_t isn, __be16 *server, uint8_t *priority);
  79 int64_t opal_register_exception_handler(uint64_t opal_exception,
  80                                         uint64_t handler_address,
  81                                         uint64_t glue_cache_line);
  82 int64_t opal_pci_eeh_freeze_status(uint64_t phb_id, uint64_t pe_number,
  83                                    uint8_t *freeze_state,
  84                                    __be16 *pci_error_type,
  85                                    __be64 *phb_status);
  86 int64_t opal_pci_eeh_freeze_clear(uint64_t phb_id, uint64_t pe_number,
  87                                   uint64_t eeh_action_token);
  88 int64_t opal_pci_eeh_freeze_set(uint64_t phb_id, uint64_t pe_number,
  89                                 uint64_t eeh_action_token);
  90 int64_t opal_pci_err_inject(uint64_t phb_id, uint32_t pe_no, uint32_t type,
  91                             uint32_t func, uint64_t addr, uint64_t mask);
  92 int64_t opal_pci_shpc(uint64_t phb_id, uint64_t shpc_action, uint8_t *state);
  93
  94
  95
  96 int64_t opal_pci_phb_mmio_enable(uint64_t phb_id, uint16_t window_type,
  97                                  uint16_t window_num, uint16_t enable);
  98 int64_t opal_pci_set_phb_mem_window(uint64_t phb_id, uint16_t window_type,
  99                                     uint16_t window_num,
 100                                     uint64_t starting_real_address,
 101                                     uint64_t starting_pci_address,
 102                                     uint64_t size);
 103 int64_t opal_pci_map_pe_mmio_window(uint64_t phb_id, uint16_t pe_number,
 104                                     uint16_t window_type, uint16_t window_num,
 105                                     uint16_t segment_num);
 106 int64_t opal_pci_set_phb_table_memory(uint64_t phb_id, uint64_t rtt_addr,
 107                                       uint64_t ivt_addr, uint64_t ivt_len,
 108                                       uint64_t reject_array_addr,
 109                                       uint64_t peltv_addr);
 110 int64_t opal_pci_set_pe(uint64_t phb_id, uint64_t pe_number, uint64_t bus_dev_func,
 111                         uint8_t bus_compare, uint8_t dev_compare, uint8_t func_compare,
 112                         uint8_t pe_action);
 113 int64_t opal_pci_set_peltv(uint64_t phb_id, uint32_t parent_pe, uint32_t child_pe,
 114                            uint8_t state);
 115 int64_t opal_pci_get_xive_reissue(uint64_t phb_id, uint32_t xive_number,
 116                                   uint8_t *p_bit, uint8_t *q_bit);
 117 int64_t opal_pci_set_xive_reissue(uint64_t phb_id, uint32_t xive_number,
 118                                   uint8_t p_bit, uint8_t q_bit);
 119 int64_t opal_pci_msi_eoi(uint64_t phb_id, uint32_t hw_irq);
 120 int64_t opal_pci_set_xive_pe(uint64_t phb_id, uint32_t pe_number,
 121                              uint32_t xive_num);
 122 int64_t opal_get_xive_source(uint64_t phb_id, uint32_t xive_num,
 123                              __be32 *interrupt_source_number);
 124 int64_t opal_get_msi_32(uint64_t phb_id, uint32_t mve_number, uint32_t xive_num,
 125                         uint8_t msi_range, __be32 *msi_address,
 126                         __be32 *message_data);
 127 int64_t opal_get_msi_64(uint64_t phb_id, uint32_t mve_number,
 128                         uint32_t xive_num, uint8_t msi_range,
 129                         __be64 *msi_address, __be32 *message_data);
 130 int64_t opal_start_cpu(uint64_t thread_number, uint64_t start_address);
 131 int64_t opal_query_cpu_status(uint64_t thread_number, uint8_t *thread_status);
 132 int64_t opal_write_oppanel(oppanel_line_t *lines, uint64_t num_lines);
 133 int64_t opal_pci_map_pe_dma_window(uint64_t phb_id, uint16_t pe_number, uint16_t window_id,
 134                                    uint16_t tce_levels, uint64_t tce_table_addr,
 135                                    uint64_t tce_table_size, uint64_t tce_page_size);
 136 int64_t opal_pci_map_pe_dma_window_real(uint64_t phb_id, uint16_t pe_number,
 137                                         uint16_t dma_window_number, uint64_t pci_start_addr,
 138                                         uint64_t pci_mem_size);
 139 int64_t opal_pci_reset(uint64_t id, uint8_t reset_scope, uint8_t assert_state);
 140
 141 int64_t opal_pci_get_hub_diag_data(uint64_t hub_id, void *diag_buffer,
 142                                    uint64_t diag_buffer_len);
 143 int64_t opal_pci_get_phb_diag_data(uint64_t phb_id, void *diag_buffer,
 144                                    uint64_t diag_buffer_len);
 145 int64_t opal_pci_get_phb_diag_data2(uint64_t phb_id, void *diag_buffer,
 146                                     uint64_t diag_buffer_len);
 147 int64_t opal_pci_fence_phb(uint64_t phb_id);
 148 int64_t opal_pci_reinit(uint64_t phb_id, uint64_t reinit_scope, uint64_t data);
 149 int64_t opal_pci_mask_pe_error(uint64_t phb_id, uint16_t pe_number, uint8_t error_type, uint8_t mask_action);
 150 int64_t opal_set_slot_led_status(uint64_t phb_id, uint64_t slot_id, uint8_t led_type, uint8_t led_action);
 151 int64_t opal_get_epow_status(__be16 *epow_status, __be16 *num_epow_classes);
 152 int64_t opal_get_dpo_status(__be64 *dpo_timeout);
 153 int64_t opal_set_system_attention_led(uint8_t led_action);
 154 int64_t opal_pci_next_error(uint64_t phb_id, __be64 *first_frozen_pe,
 155                             __be16 *pci_error_type, __be16 *severity);
 156 int64_t opal_pci_poll(uint64_t id);
 157 int64_t opal_return_cpu(void);
 158 int64_t opal_check_token(uint64_t token);
 159 int64_t opal_reinit_cpus(uint64_t flags);
 160
 161 int64_t opal_xscom_read(uint32_t gcid, uint64_t pcb_addr, __be64 *val);
 162 int64_t opal_xscom_write(uint32_t gcid, uint64_t pcb_addr, uint64_t val);
 163
 164 int64_t opal_lpc_write(uint32_t chip_id, enum OpalLPCAddressType addr_type,
 165                        uint32_t addr, uint32_t data, uint32_t sz);
 166 int64_t opal_lpc_read(uint32_t chip_id, enum OpalLPCAddressType addr_type,
 167                       uint32_t addr, __be32 *data, uint32_t sz);
 168
 169 int64_t opal_read_elog(uint64_t buffer, uint64_t size, uint64_t log_id);
 170 int64_t opal_get_elog_size(__be64 *log_id, __be64 *size, __be64 *elog_type);
 171 int64_t opal_write_elog(uint64_t buffer, uint64_t size, uint64_t offset);
 172 int64_t opal_send_ack_elog(uint64_t log_id);
 173 void opal_resend_pending_logs(void);
 174
 175 int64_t opal_validate_flash(uint64_t buffer, uint32_t *size, uint32_t *result);
 176 int64_t opal_manage_flash(uint8_t op);
 177 int64_t opal_update_flash(uint64_t blk_list);
 178 int64_t opal_dump_init(uint8_t dump_type);
 179 int64_t opal_dump_info(__be32 *dump_id, __be32 *dump_size);
 180 int64_t opal_dump_info2(__be32 *dump_id, __be32 *dump_size, __be32 *dump_type);
 181 int64_t opal_dump_read(uint32_t dump_id, uint64_t buffer);
 182 int64_t opal_dump_ack(uint32_t dump_id);
 183 int64_t opal_dump_resend_notification(void);
 184
 185 int64_t opal_get_msg(uint64_t buffer, uint64_t size);
 186 int64_t opal_write_oppanel_async(uint64_t token, oppanel_line_t *lines,
 187                                         uint64_t num_lines);
 188 int64_t opal_check_completion(uint64_t buffer, uint64_t size, uint64_t token);
 189 int64_t opal_sync_host_reboot(void);
 190 int64_t opal_get_param(uint64_t token, uint32_t param_id, uint64_t buffer,
 191                 uint64_t length);
 192 int64_t opal_set_param(uint64_t token, uint32_t param_id, uint64_t buffer,
 193                 uint64_t length);
 194 int64_t opal_sensor_read(uint32_t sensor_hndl, int token, __be32 *sensor_data);
 195 int64_t opal_sensor_read_u64(u32 sensor_hndl, int token, __be64 *sensor_data);
 196 int64_t opal_handle_hmi(void);
 197 int64_t opal_handle_hmi2(__be64 *out_flags);
 198 int64_t opal_register_dump_region(uint32_t id, uint64_t start, uint64_t end);
 199 int64_t opal_unregister_dump_region(uint32_t id);
 200 int64_t opal_slw_set_reg(uint64_t cpu_pir, uint64_t sprn, uint64_t val);
 201 int64_t opal_config_cpu_idle_state(uint64_t state, uint64_t flag);
 202 int64_t opal_pci_set_phb_cxl_mode(uint64_t phb_id, uint64_t mode, uint64_t pe_number);
 203 int64_t opal_pci_get_pbcq_tunnel_bar(uint64_t phb_id, uint64_t *addr);
 204 int64_t opal_pci_set_pbcq_tunnel_bar(uint64_t phb_id, uint64_t addr);
 205 int64_t opal_ipmi_send(uint64_t interface, struct opal_ipmi_msg *msg,
 206                 uint64_t msg_len);
 207 int64_t opal_ipmi_recv(uint64_t interface, struct opal_ipmi_msg *msg,
 208                 uint64_t *msg_len);
 209 int64_t opal_i2c_request(uint64_t async_token, uint32_t bus_id,
 210                          struct opal_i2c_request *oreq);
 211 int64_t opal_prd_msg(struct opal_prd_msg *msg);
 212 int64_t opal_leds_get_ind(char *loc_code, __be64 *led_mask,
 213                           __be64 *led_value, __be64 *max_led_type);
 214 int64_t opal_leds_set_ind(uint64_t token, char *loc_code, const u64 led_mask,
 215                           const u64 led_value, __be64 *max_led_type);
 216
 217 int64_t opal_flash_read(uint64_t id, uint64_t offset, uint64_t buf,
 218                 uint64_t size, uint64_t token);
 219 int64_t opal_flash_write(uint64_t id, uint64_t offset, uint64_t buf,
 220                 uint64_t size, uint64_t token);
 221 int64_t opal_flash_erase(uint64_t id, uint64_t offset, uint64_t size,
 222                 uint64_t token);
 223 int64_t opal_get_device_tree(uint32_t phandle, uint64_t buf, uint64_t len);
 224 int64_t opal_pci_get_presence_state(uint64_t id, uint64_t data);
 225 int64_t opal_pci_get_power_state(uint64_t id, uint64_t data);
 226 int64_t opal_pci_set_power_state(uint64_t async_token, uint64_t id,
 227                                  uint64_t data);
 228 int64_t opal_pci_poll2(uint64_t id, uint64_t data);
 229
 230 int64_t opal_int_get_xirr(__be32 *out_xirr, bool just_poll);
 231 int64_t opal_int_set_cppr(uint8_t cppr);
 232 int64_t opal_int_eoi(uint32_t xirr);
 233 int64_t opal_int_set_mfrr(uint32_t cpu, uint8_t mfrr);
 234 int64_t opal_pci_tce_kill(uint64_t phb_id, uint32_t kill_type,
 235                           uint32_t pe_num, uint32_t tce_size,
 236                           uint64_t dma_addr, uint32_t npages);
 237 int64_t opal_nmmu_set_ptcr(uint64_t chip_id, uint64_t ptcr);
 238 int64_t opal_xive_reset(uint64_t version);
 239 int64_t opal_xive_get_irq_info(uint32_t girq,
 240                                __be64 *out_flags,
 241                                __be64 *out_eoi_page,
 242                                __be64 *out_trig_page,
 243                                __be32 *out_esb_shift,
 244                                __be32 *out_src_chip);
 245 int64_t opal_xive_get_irq_config(uint32_t girq, __be64 *out_vp,
 246                                  uint8_t *out_prio, __be32 *out_lirq);
 247 int64_t opal_xive_set_irq_config(uint32_t girq, uint64_t vp, uint8_t prio,
 248                                  uint32_t lirq);
 249 int64_t opal_xive_get_queue_info(uint64_t vp, uint32_t prio,
 250                                  __be64 *out_qpage,
 251                                  __be64 *out_qsize,
 252                                  __be64 *out_qeoi_page,
 253                                  __be32 *out_escalate_irq,
 254                                  __be64 *out_qflags);
 255 int64_t opal_xive_set_queue_info(uint64_t vp, uint32_t prio,
 256                                  uint64_t qpage,
 257                                  uint64_t qsize,
 258                                  uint64_t qflags);
 259 int64_t opal_xive_donate_page(uint32_t chip_id, uint64_t addr);
 260 int64_t opal_xive_alloc_vp_block(uint32_t alloc_order);
 261 int64_t opal_xive_free_vp_block(uint64_t vp);
 262 int64_t opal_xive_get_vp_info(uint64_t vp,
 263                               __be64 *out_flags,
 264                               __be64 *out_cam_value,
 265                               __be64 *out_report_cl_pair,
 266                               __be32 *out_chip_id);
 267 int64_t opal_xive_set_vp_info(uint64_t vp,
 268                               uint64_t flags,
 269                               uint64_t report_cl_pair);
 270 int64_t opal_xive_allocate_irq_raw(uint32_t chip_id);
 271 int64_t opal_xive_free_irq(uint32_t girq);
 272 int64_t opal_xive_sync(uint32_t type, uint32_t id);
 273 int64_t opal_xive_dump(uint32_t type, uint32_t id);
 274 int64_t opal_xive_get_queue_state(uint64_t vp, uint32_t prio,
 275                                   __be32 *out_qtoggle,
 276                                   __be32 *out_qindex);
 277 int64_t opal_xive_set_queue_state(uint64_t vp, uint32_t prio,
 278                                   uint32_t qtoggle,
 279                                   uint32_t qindex);
 280 int64_t opal_xive_get_vp_state(uint64_t vp, __be64 *out_w01);
 281
 282 int64_t opal_imc_counters_init(uint32_t type, uint64_t address,
 283                                                         uint64_t cpu_pir);
 284 int64_t opal_imc_counters_start(uint32_t type, uint64_t cpu_pir);
 285 int64_t opal_imc_counters_stop(uint32_t type, uint64_t cpu_pir);
 286
 287 int opal_get_powercap(u32 handle, int token, u32 *pcap);
 288 int opal_set_powercap(u32 handle, int token, u32 pcap);
 289 int opal_get_power_shift_ratio(u32 handle, int token, u32 *psr);
 290 int opal_set_power_shift_ratio(u32 handle, int token, u32 psr);
 291 int opal_sensor_group_clear(u32 group_hndl, int token);
 292 int opal_sensor_group_enable(u32 group_hndl, int token, bool enable);
 293 int opal_nx_coproc_init(uint32_t chip_id, uint32_t ct);
 294
 295 int opal_secvar_get(const char *key, uint64_t key_len, u8 *data,
 296                     uint64_t *data_size);
 297 int opal_secvar_get_next(const char *key, uint64_t *key_len,
 298                          uint64_t key_buf_size);
 299 int opal_secvar_enqueue_update(const char *key, uint64_t key_len, u8 *data,
 300                                uint64_t data_size);
 301
 302 s64 opal_mpipl_update(enum opal_mpipl_ops op, u64 src, u64 dest, u64 size);
 303 s64 opal_mpipl_register_tag(enum opal_mpipl_tags tag, u64 addr);
 304 s64 opal_mpipl_query_tag(enum opal_mpipl_tags tag, __be64 *addr);
 305
 306 s64 opal_signal_system_reset(s32 cpu);
 307 s64 opal_quiesce(u64 shutdown_type, s32 cpu);
 308
 309 /* Internal functions */
 310 extern int early_init_dt_scan_opal(unsigned long node, const char *uname,
 311                                    int depth, void *data);
 312 extern int early_init_dt_scan_recoverable_ranges(unsigned long node,
 313                                  const char *uname, int depth, void *data);
 314 void __init opal_configure_cores(void);
 315
 316 extern ssize_t opal_get_chars(uint32_t vtermno, u8 *buf, size_t count);
 317 extern ssize_t opal_put_chars(uint32_t vtermno, const u8 *buf,
 318                               size_t total_len);
 319 extern ssize_t opal_put_chars_atomic(uint32_t vtermno, const u8 *buf,
 320                                      size_t total_len);
 321 extern int opal_flush_chars(uint32_t vtermno, bool wait);
 322 extern int opal_flush_console(uint32_t vtermno);
 323
 324 extern void hvc_opal_init_early(void);
 325
 326 extern int opal_message_notifier_register(enum opal_msg_type msg_type,
 327                                                 struct notifier_block *nb);
 328 extern int opal_message_notifier_unregister(enum opal_msg_type msg_type,
 329                                             struct notifier_block *nb);
 330
 331 extern int opal_async_get_token_interruptible(void);
 332 extern int opal_async_release_token(int token);
 333 extern int opal_async_wait_response(uint64_t token, struct opal_msg *msg);
 334 extern int opal_async_wait_response_interruptible(uint64_t token,
 335                 struct opal_msg *msg);
 336 extern int opal_get_sensor_data(u32 sensor_hndl, u32 *sensor_data);
 337 extern int opal_get_sensor_data_u64(u32 sensor_hndl, u64 *sensor_data);
 338 extern int sensor_group_enable(u32 grp_hndl, bool enable);
 339
 340 struct rtc_time;
 341 extern time64_t opal_get_boot_time(void);
 342 extern void opal_nvram_init(void);
 343 extern void opal_flash_update_init(void);
 344 extern void opal_flash_update_print_message(void);
 345 extern int opal_elog_init(void);
 346 extern void opal_platform_dump_init(void);
 347 extern void opal_sys_param_init(void);
 348 extern void opal_msglog_init(void);
 349 extern void opal_msglog_sysfs_init(void);
 350 extern int opal_async_comp_init(void);
 351 extern int opal_sensor_init(void);
 352 extern int opal_hmi_handler_init(void);
 353 extern int opal_event_init(void);
 354 int opal_power_control_init(void);
 355
 356 extern int opal_machine_check(struct pt_regs *regs);
 357 extern bool opal_mce_check_early_recovery(struct pt_regs *regs);
 358 extern int opal_hmi_exception_early(struct pt_regs *regs);
 359 extern int opal_hmi_exception_early2(struct pt_regs *regs);
 360 extern int opal_handle_hmi_exception(struct pt_regs *regs);
 361
 362 extern void opal_shutdown(void);
 363 extern int opal_resync_timebase(void);
 364
 365 extern void opal_lpc_init(void);
 366
 367 extern void opal_kmsg_init(void);
 368
 369 extern int opal_event_request(unsigned int opal_event_nr);
 370
 371 struct opal_sg_list *opal_vmalloc_to_sg_list(void *vmalloc_addr,
 372                                              unsigned long vmalloc_size);
 373 void opal_free_sg_list(struct opal_sg_list *sg);
 374
 375 extern int opal_error_code(int rc);
 376
 377 ssize_t opal_msglog_copy(char *to, loff_t pos, size_t count);
 378
 379 static inline int opal_get_async_rc(struct opal_msg msg)
 380 {
 381         if (msg.msg_type != OPAL_MSG_ASYNC_COMP)
 382                 return OPAL_PARAMETER;
 383         else
 384                 return be64_to_cpu(msg.params[1]);
 385 }
 386
 387 void opal_wake_poller(void);
 388
 389 void opal_powercap_init(void);
 390 void opal_psr_init(void);
 391 void opal_sensor_groups_init(void);
 392
 393 #endif /* __ASSEMBLY__ */
 394
 395 #endif /* _ASM_POWERPC_OPAL_H */