kernel/arch/powerpc/include/asm/opal.h

   1 /*
   2  * PowerNV OPAL definitions.
   3  *
   4  * Copyright 2011 IBM Corp.
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License
   8  * as published by the Free Software Foundation; either version
   9  * 2 of the License, or (at your option) any later version.
  10  */
  11
  12 #ifndef _ASM_POWERPC_OPAL_H
  13 #define _ASM_POWERPC_OPAL_H
  14
  15 #include <asm/opal-api.h>
  16
  17 #ifndef __ASSEMBLY__
  18
  19 #include <linux/notifier.h>
  20
  21 /* We calculate number of sg entries based on PAGE_SIZE */
  22 #define SG_ENTRIES_PER_NODE ((PAGE_SIZE - 16) / sizeof(struct opal_sg_entry))
  23
  24 /* /sys/firmware/opal */
  25 extern struct kobject *opal_kobj;
  26
  27 /* /ibm,opal */
  28 extern struct device_node *opal_node;
  29
  30 /* API functions */
  31 int64_t opal_invalid_call(void);
  32 int64_t opal_console_write(int64_t term_number, __be64 *length,
  33                            const uint8_t *buffer);
  34 int64_t opal_console_read(int64_t term_number, __be64 *length,
  35                           uint8_t *buffer);
  36 int64_t opal_console_write_buffer_space(int64_t term_number,
  37                                         __be64 *length);
  38 int64_t opal_rtc_read(__be32 *year_month_day,
  39                       __be64 *hour_minute_second_millisecond);
  40 int64_t opal_rtc_write(uint32_t year_month_day,
  41                        uint64_t hour_minute_second_millisecond);
  42 int64_t opal_tpo_read(uint64_t token, __be32 *year_mon_day, __be32 *hour_min);
  43 int64_t opal_tpo_write(uint64_t token, uint32_t year_mon_day,
  44                        uint32_t hour_min);
  45 int64_t opal_cec_power_down(uint64_t request);
  46 int64_t opal_cec_reboot(void);
  47 int64_t opal_read_nvram(uint64_t buffer, uint64_t size, uint64_t offset);
  48 int64_t opal_write_nvram(uint64_t buffer, uint64_t size, uint64_t offset);
  49 int64_t opal_handle_interrupt(uint64_t isn, __be64 *outstanding_event_mask);
  50 int64_t opal_poll_events(__be64 *outstanding_event_mask);
  51 int64_t opal_pci_set_hub_tce_memory(uint64_t hub_id, uint64_t tce_mem_addr,
  52                                     uint64_t tce_mem_size);
  53 int64_t opal_pci_set_phb_tce_memory(uint64_t phb_id, uint64_t tce_mem_addr,
  54                                     uint64_t tce_mem_size);
  55 int64_t opal_pci_config_read_byte(uint64_t phb_id, uint64_t bus_dev_func,
  56                                   uint64_t offset, uint8_t *data);
  57 int64_t opal_pci_config_read_half_word(uint64_t phb_id, uint64_t bus_dev_func,
  58                                        uint64_t offset, __be16 *data);
  59 int64_t opal_pci_config_read_word(uint64_t phb_id, uint64_t bus_dev_func,
  60                                   uint64_t offset, __be32 *data);
  61 int64_t opal_pci_config_write_byte(uint64_t phb_id, uint64_t bus_dev_func,
  62                                    uint64_t offset, uint8_t data);
  63 int64_t opal_pci_config_write_half_word(uint64_t phb_id, uint64_t bus_dev_func,
  64                                         uint64_t offset, uint16_t data);
  65 int64_t opal_pci_config_write_word(uint64_t phb_id, uint64_t bus_dev_func,
  66                                    uint64_t offset, uint32_t data);
  67 int64_t opal_set_xive(uint32_t isn, uint16_t server, uint8_t priority);
  68 int64_t opal_get_xive(uint32_t isn, __be16 *server, uint8_t *priority);
  69 int64_t opal_register_exception_handler(uint64_t opal_exception,
  70                                         uint64_t handler_address,
  71                                         uint64_t glue_cache_line);
  72 int64_t opal_pci_eeh_freeze_status(uint64_t phb_id, uint64_t pe_number,
  73                                    uint8_t *freeze_state,
  74                                    __be16 *pci_error_type,
  75                                    __be64 *phb_status);
  76 int64_t opal_pci_eeh_freeze_clear(uint64_t phb_id, uint64_t pe_number,
  77                                   uint64_t eeh_action_token);
  78 int64_t opal_pci_eeh_freeze_set(uint64_t phb_id, uint64_t pe_number,
  79                                 uint64_t eeh_action_token);
  80 int64_t opal_pci_err_inject(uint64_t phb_id, uint32_t pe_no, uint32_t type,
  81                             uint32_t func, uint64_t addr, uint64_t mask);
  82 int64_t opal_pci_shpc(uint64_t phb_id, uint64_t shpc_action, uint8_t *state);
  83
  84
  85
  86 int64_t opal_pci_phb_mmio_enable(uint64_t phb_id, uint16_t window_type,
  87                                  uint16_t window_num, uint16_t enable);
  88 int64_t opal_pci_set_phb_mem_window(uint64_t phb_id, uint16_t window_type,
  89                                     uint16_t window_num,
  90                                     uint64_t starting_real_address,
  91                                     uint64_t starting_pci_address,
  92                                     uint64_t size);
  93 int64_t opal_pci_map_pe_mmio_window(uint64_t phb_id, uint16_t pe_number,
  94                                     uint16_t window_type, uint16_t window_num,
  95                                     uint16_t segment_num);
  96 int64_t opal_pci_set_phb_table_memory(uint64_t phb_id, uint64_t rtt_addr,
  97                                       uint64_t ivt_addr, uint64_t ivt_len,
  98                                       uint64_t reject_array_addr,
  99                                       uint64_t peltv_addr);
 100 int64_t opal_pci_set_pe(uint64_t phb_id, uint64_t pe_number, uint64_t bus_dev_func,
 101                         uint8_t bus_compare, uint8_t dev_compare, uint8_t func_compare,
 102                         uint8_t pe_action);
 103 int64_t opal_pci_set_peltv(uint64_t phb_id, uint32_t parent_pe, uint32_t child_pe,
 104                            uint8_t state);
 105 int64_t opal_pci_set_mve(uint64_t phb_id, uint32_t mve_number, uint32_t pe_number);
 106 int64_t opal_pci_set_mve_enable(uint64_t phb_id, uint32_t mve_number,
 107                                 uint32_t state);
 108 int64_t opal_pci_get_xive_reissue(uint64_t phb_id, uint32_t xive_number,
 109                                   uint8_t *p_bit, uint8_t *q_bit);
 110 int64_t opal_pci_set_xive_reissue(uint64_t phb_id, uint32_t xive_number,
 111                                   uint8_t p_bit, uint8_t q_bit);
 112 int64_t opal_pci_msi_eoi(uint64_t phb_id, uint32_t hw_irq);
 113 int64_t opal_pci_set_xive_pe(uint64_t phb_id, uint32_t pe_number,
 114                              uint32_t xive_num);
 115 int64_t opal_get_xive_source(uint64_t phb_id, uint32_t xive_num,
 116                              __be32 *interrupt_source_number);
 117 int64_t opal_get_msi_32(uint64_t phb_id, uint32_t mve_number, uint32_t xive_num,
 118                         uint8_t msi_range, __be32 *msi_address,
 119                         __be32 *message_data);
 120 int64_t opal_get_msi_64(uint64_t phb_id, uint32_t mve_number,
 121                         uint32_t xive_num, uint8_t msi_range,
 122                         __be64 *msi_address, __be32 *message_data);
 123 int64_t opal_start_cpu(uint64_t thread_number, uint64_t start_address);
 124 int64_t opal_query_cpu_status(uint64_t thread_number, uint8_t *thread_status);
 125 int64_t opal_write_oppanel(oppanel_line_t *lines, uint64_t num_lines);
 126 int64_t opal_pci_map_pe_dma_window(uint64_t phb_id, uint16_t pe_number, uint16_t window_id,
 127                                    uint16_t tce_levels, uint64_t tce_table_addr,
 128                                    uint64_t tce_table_size, uint64_t tce_page_size);
 129 int64_t opal_pci_map_pe_dma_window_real(uint64_t phb_id, uint16_t pe_number,
 130                                         uint16_t dma_window_number, uint64_t pci_start_addr,
 131                                         uint64_t pci_mem_size);
 132 int64_t opal_pci_reset(uint64_t phb_id, uint8_t reset_scope, uint8_t assert_state);
 133
 134 int64_t opal_pci_get_hub_diag_data(uint64_t hub_id, void *diag_buffer,
 135                                    uint64_t diag_buffer_len);
 136 int64_t opal_pci_get_phb_diag_data(uint64_t phb_id, void *diag_buffer,
 137                                    uint64_t diag_buffer_len);
 138 int64_t opal_pci_get_phb_diag_data2(uint64_t phb_id, void *diag_buffer,
 139                                     uint64_t diag_buffer_len);
 140 int64_t opal_pci_fence_phb(uint64_t phb_id);
 141 int64_t opal_pci_reinit(uint64_t phb_id, uint64_t reinit_scope, uint64_t data);
 142 int64_t opal_pci_mask_pe_error(uint64_t phb_id, uint16_t pe_number, uint8_t error_type, uint8_t mask_action);
 143 int64_t opal_set_slot_led_status(uint64_t phb_id, uint64_t slot_id, uint8_t led_type, uint8_t led_action);
 144 int64_t opal_get_epow_status(__be64 *status);
 145 int64_t opal_set_system_attention_led(uint8_t led_action);
 146 int64_t opal_pci_next_error(uint64_t phb_id, __be64 *first_frozen_pe,
 147                             __be16 *pci_error_type, __be16 *severity);
 148 int64_t opal_pci_poll(uint64_t phb_id);
 149 int64_t opal_return_cpu(void);
 150 int64_t opal_check_token(uint64_t token);
 151 int64_t opal_reinit_cpus(uint64_t flags);
 152
 153 int64_t opal_xscom_read(uint32_t gcid, uint64_t pcb_addr, __be64 *val);
 154 int64_t opal_xscom_write(uint32_t gcid, uint64_t pcb_addr, uint64_t val);
 155
 156 int64_t opal_lpc_write(uint32_t chip_id, enum OpalLPCAddressType addr_type,
 157                        uint32_t addr, uint32_t data, uint32_t sz);
 158 int64_t opal_lpc_read(uint32_t chip_id, enum OpalLPCAddressType addr_type,
 159                       uint32_t addr, __be32 *data, uint32_t sz);
 160
 161 int64_t opal_read_elog(uint64_t buffer, uint64_t size, uint64_t log_id);
 162 int64_t opal_get_elog_size(__be64 *log_id, __be64 *size, __be64 *elog_type);
 163 int64_t opal_write_elog(uint64_t buffer, uint64_t size, uint64_t offset);
 164 int64_t opal_send_ack_elog(uint64_t log_id);
 165 void opal_resend_pending_logs(void);
 166
 167 int64_t opal_validate_flash(uint64_t buffer, uint32_t *size, uint32_t *result);
 168 int64_t opal_manage_flash(uint8_t op);
 169 int64_t opal_update_flash(uint64_t blk_list);
 170 int64_t opal_dump_init(uint8_t dump_type);
 171 int64_t opal_dump_info(__be32 *dump_id, __be32 *dump_size);
 172 int64_t opal_dump_info2(__be32 *dump_id, __be32 *dump_size, __be32 *dump_type);
 173 int64_t opal_dump_read(uint32_t dump_id, uint64_t buffer);
 174 int64_t opal_dump_ack(uint32_t dump_id);
 175 int64_t opal_dump_resend_notification(void);
 176
 177 int64_t opal_get_msg(uint64_t buffer, uint64_t size);
 178 int64_t opal_check_completion(uint64_t buffer, uint64_t size, uint64_t token);
 179 int64_t opal_sync_host_reboot(void);
 180 int64_t opal_get_param(uint64_t token, uint32_t param_id, uint64_t buffer,
 181                 uint64_t length);
 182 int64_t opal_set_param(uint64_t token, uint32_t param_id, uint64_t buffer,
 183                 uint64_t length);
 184 int64_t opal_sensor_read(uint32_t sensor_hndl, int token, __be32 *sensor_data);
 185 int64_t opal_handle_hmi(void);
 186 int64_t opal_register_dump_region(uint32_t id, uint64_t start, uint64_t end);
 187 int64_t opal_unregister_dump_region(uint32_t id);
 188 int64_t opal_slw_set_reg(uint64_t cpu_pir, uint64_t sprn, uint64_t val);
 189 int64_t opal_pci_set_phb_cxl_mode(uint64_t phb_id, uint64_t mode, uint64_t pe_number);
 190 int64_t opal_ipmi_send(uint64_t interface, struct opal_ipmi_msg *msg,
 191                 uint64_t msg_len);
 192 int64_t opal_ipmi_recv(uint64_t interface, struct opal_ipmi_msg *msg,
 193                 uint64_t *msg_len);
 194 int64_t opal_i2c_request(uint64_t async_token, uint32_t bus_id,
 195                          struct opal_i2c_request *oreq);
 196
 197 int64_t opal_flash_read(uint64_t id, uint64_t offset, uint64_t buf,
 198                 uint64_t size, uint64_t token);
 199 int64_t opal_flash_write(uint64_t id, uint64_t offset, uint64_t buf,
 200                 uint64_t size, uint64_t token);
 201 int64_t opal_flash_erase(uint64_t id, uint64_t offset, uint64_t size,
 202                 uint64_t token);
 203
 204 /* Internal functions */
 205 extern int early_init_dt_scan_opal(unsigned long node, const char *uname,
 206                                    int depth, void *data);
 207 extern int early_init_dt_scan_recoverable_ranges(unsigned long node,
 208                                  const char *uname, int depth, void *data);
 209
 210 extern int opal_get_chars(uint32_t vtermno, char *buf, int count);
 211 extern int opal_put_chars(uint32_t vtermno, const char *buf, int total_len);
 212
 213 extern void hvc_opal_init_early(void);
 214
 215 extern int opal_notifier_register(struct notifier_block *nb);
 216 extern int opal_notifier_unregister(struct notifier_block *nb);
 217
 218 extern int opal_message_notifier_register(enum opal_msg_type msg_type,
 219                                                 struct notifier_block *nb);
 220 extern int opal_message_notifier_unregister(enum opal_msg_type msg_type,
 221                                             struct notifier_block *nb);
 222 extern void opal_notifier_enable(void);
 223 extern void opal_notifier_disable(void);
 224 extern void opal_notifier_update_evt(uint64_t evt_mask, uint64_t evt_val);
 225
 226 extern int __opal_async_get_token(void);
 227 extern int opal_async_get_token_interruptible(void);
 228 extern int __opal_async_release_token(int token);
 229 extern int opal_async_release_token(int token);
 230 extern int opal_async_wait_response(uint64_t token, struct opal_msg *msg);
 231 extern int opal_get_sensor_data(u32 sensor_hndl, u32 *sensor_data);
 232
 233 struct rtc_time;
 234 extern unsigned long opal_get_boot_time(void);
 235 extern void opal_nvram_init(void);
 236 extern void opal_flash_update_init(void);
 237 extern void opal_flash_term_callback(void);
 238 extern int opal_elog_init(void);
 239 extern void opal_platform_dump_init(void);
 240 extern void opal_sys_param_init(void);
 241 extern void opal_msglog_init(void);
 242
 243 extern int opal_machine_check(struct pt_regs *regs);
 244 extern bool opal_mce_check_early_recovery(struct pt_regs *regs);
 245 extern int opal_hmi_exception_early(struct pt_regs *regs);
 246 extern int opal_handle_hmi_exception(struct pt_regs *regs);
 247
 248 extern void opal_shutdown(void);
 249 extern int opal_resync_timebase(void);
 250
 251 extern void opal_lpc_init(void);
 252
 253 struct opal_sg_list *opal_vmalloc_to_sg_list(void *vmalloc_addr,
 254                                              unsigned long vmalloc_size);
 255 void opal_free_sg_list(struct opal_sg_list *sg);
 256
 257 extern int opal_error_code(int rc);
 258
 259 #endif /* __ASSEMBLY__ */
 260
 261 #endif /* _ASM_POWERPC_OPAL_H */