xref: /linux/arch/powerpc/include/asm/opal.h (revision f3a8b6645dc2e60d11f20c1c23afd964ff4e55ae)
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_console_flush(int64_t term_number);
39 int64_t opal_rtc_read(__be32 *year_month_day,
40 		      __be64 *hour_minute_second_millisecond);
41 int64_t opal_rtc_write(uint32_t year_month_day,
42 		       uint64_t hour_minute_second_millisecond);
43 int64_t opal_tpo_read(uint64_t token, __be32 *year_mon_day, __be32 *hour_min);
44 int64_t opal_tpo_write(uint64_t token, uint32_t year_mon_day,
45 		       uint32_t hour_min);
46 int64_t opal_cec_power_down(uint64_t request);
47 int64_t opal_cec_reboot(void);
48 int64_t opal_cec_reboot2(uint32_t reboot_type, char *diag);
49 int64_t opal_read_nvram(uint64_t buffer, uint64_t size, uint64_t offset);
50 int64_t opal_write_nvram(uint64_t buffer, uint64_t size, uint64_t offset);
51 int64_t opal_handle_interrupt(uint64_t isn, __be64 *outstanding_event_mask);
52 int64_t opal_poll_events(__be64 *outstanding_event_mask);
53 int64_t opal_pci_set_hub_tce_memory(uint64_t hub_id, uint64_t tce_mem_addr,
54 				    uint64_t tce_mem_size);
55 int64_t opal_pci_set_phb_tce_memory(uint64_t phb_id, uint64_t tce_mem_addr,
56 				    uint64_t tce_mem_size);
57 int64_t opal_pci_config_read_byte(uint64_t phb_id, uint64_t bus_dev_func,
58 				  uint64_t offset, uint8_t *data);
59 int64_t opal_pci_config_read_half_word(uint64_t phb_id, uint64_t bus_dev_func,
60 				       uint64_t offset, __be16 *data);
61 int64_t opal_pci_config_read_word(uint64_t phb_id, uint64_t bus_dev_func,
62 				  uint64_t offset, __be32 *data);
63 int64_t opal_pci_config_write_byte(uint64_t phb_id, uint64_t bus_dev_func,
64 				   uint64_t offset, uint8_t data);
65 int64_t opal_pci_config_write_half_word(uint64_t phb_id, uint64_t bus_dev_func,
66 					uint64_t offset, uint16_t data);
67 int64_t opal_pci_config_write_word(uint64_t phb_id, uint64_t bus_dev_func,
68 				   uint64_t offset, uint32_t data);
69 int64_t opal_set_xive(uint32_t isn, uint16_t server, uint8_t priority);
70 int64_t opal_rm_set_xive(uint32_t isn, uint16_t server, uint8_t priority);
71 int64_t opal_get_xive(uint32_t isn, __be16 *server, uint8_t *priority);
72 int64_t opal_register_exception_handler(uint64_t opal_exception,
73 					uint64_t handler_address,
74 					uint64_t glue_cache_line);
75 int64_t opal_pci_eeh_freeze_status(uint64_t phb_id, uint64_t pe_number,
76 				   uint8_t *freeze_state,
77 				   __be16 *pci_error_type,
78 				   __be64 *phb_status);
79 int64_t opal_pci_eeh_freeze_clear(uint64_t phb_id, uint64_t pe_number,
80 				  uint64_t eeh_action_token);
81 int64_t opal_pci_eeh_freeze_set(uint64_t phb_id, uint64_t pe_number,
82 				uint64_t eeh_action_token);
83 int64_t opal_pci_err_inject(uint64_t phb_id, uint32_t pe_no, uint32_t type,
84 			    uint32_t func, uint64_t addr, uint64_t mask);
85 int64_t opal_pci_shpc(uint64_t phb_id, uint64_t shpc_action, uint8_t *state);
86 
87 
88 
89 int64_t opal_pci_phb_mmio_enable(uint64_t phb_id, uint16_t window_type,
90 				 uint16_t window_num, uint16_t enable);
91 int64_t opal_pci_set_phb_mem_window(uint64_t phb_id, uint16_t window_type,
92 				    uint16_t window_num,
93 				    uint64_t starting_real_address,
94 				    uint64_t starting_pci_address,
95 				    uint64_t size);
96 int64_t opal_pci_map_pe_mmio_window(uint64_t phb_id, uint16_t pe_number,
97 				    uint16_t window_type, uint16_t window_num,
98 				    uint16_t segment_num);
99 int64_t opal_pci_set_phb_table_memory(uint64_t phb_id, uint64_t rtt_addr,
100 				      uint64_t ivt_addr, uint64_t ivt_len,
101 				      uint64_t reject_array_addr,
102 				      uint64_t peltv_addr);
103 int64_t opal_pci_set_pe(uint64_t phb_id, uint64_t pe_number, uint64_t bus_dev_func,
104 			uint8_t bus_compare, uint8_t dev_compare, uint8_t func_compare,
105 			uint8_t pe_action);
106 int64_t opal_pci_set_peltv(uint64_t phb_id, uint32_t parent_pe, uint32_t child_pe,
107 			   uint8_t state);
108 int64_t opal_pci_set_mve(uint64_t phb_id, uint32_t mve_number, uint32_t pe_number);
109 int64_t opal_pci_set_mve_enable(uint64_t phb_id, uint32_t mve_number,
110 				uint32_t state);
111 int64_t opal_pci_get_xive_reissue(uint64_t phb_id, uint32_t xive_number,
112 				  uint8_t *p_bit, uint8_t *q_bit);
113 int64_t opal_pci_set_xive_reissue(uint64_t phb_id, uint32_t xive_number,
114 				  uint8_t p_bit, uint8_t q_bit);
115 int64_t opal_pci_msi_eoi(uint64_t phb_id, uint32_t hw_irq);
116 int64_t opal_pci_set_xive_pe(uint64_t phb_id, uint32_t pe_number,
117 			     uint32_t xive_num);
118 int64_t opal_get_xive_source(uint64_t phb_id, uint32_t xive_num,
119 			     __be32 *interrupt_source_number);
120 int64_t opal_get_msi_32(uint64_t phb_id, uint32_t mve_number, uint32_t xive_num,
121 			uint8_t msi_range, __be32 *msi_address,
122 			__be32 *message_data);
123 int64_t opal_get_msi_64(uint64_t phb_id, uint32_t mve_number,
124 			uint32_t xive_num, uint8_t msi_range,
125 			__be64 *msi_address, __be32 *message_data);
126 int64_t opal_start_cpu(uint64_t thread_number, uint64_t start_address);
127 int64_t opal_query_cpu_status(uint64_t thread_number, uint8_t *thread_status);
128 int64_t opal_write_oppanel(oppanel_line_t *lines, uint64_t num_lines);
129 int64_t opal_pci_map_pe_dma_window(uint64_t phb_id, uint16_t pe_number, uint16_t window_id,
130 				   uint16_t tce_levels, uint64_t tce_table_addr,
131 				   uint64_t tce_table_size, uint64_t tce_page_size);
132 int64_t opal_pci_map_pe_dma_window_real(uint64_t phb_id, uint16_t pe_number,
133 					uint16_t dma_window_number, uint64_t pci_start_addr,
134 					uint64_t pci_mem_size);
135 int64_t opal_pci_reset(uint64_t id, uint8_t reset_scope, uint8_t assert_state);
136 
137 int64_t opal_pci_get_hub_diag_data(uint64_t hub_id, void *diag_buffer,
138 				   uint64_t diag_buffer_len);
139 int64_t opal_pci_get_phb_diag_data(uint64_t phb_id, void *diag_buffer,
140 				   uint64_t diag_buffer_len);
141 int64_t opal_pci_get_phb_diag_data2(uint64_t phb_id, void *diag_buffer,
142 				    uint64_t diag_buffer_len);
143 int64_t opal_pci_fence_phb(uint64_t phb_id);
144 int64_t opal_pci_reinit(uint64_t phb_id, uint64_t reinit_scope, uint64_t data);
145 int64_t opal_pci_mask_pe_error(uint64_t phb_id, uint16_t pe_number, uint8_t error_type, uint8_t mask_action);
146 int64_t opal_set_slot_led_status(uint64_t phb_id, uint64_t slot_id, uint8_t led_type, uint8_t led_action);
147 int64_t opal_get_epow_status(__be16 *epow_status, __be16 *num_epow_classes);
148 int64_t opal_get_dpo_status(__be64 *dpo_timeout);
149 int64_t opal_set_system_attention_led(uint8_t led_action);
150 int64_t opal_pci_next_error(uint64_t phb_id, __be64 *first_frozen_pe,
151 			    __be16 *pci_error_type, __be16 *severity);
152 int64_t opal_pci_poll(uint64_t id);
153 int64_t opal_return_cpu(void);
154 int64_t opal_check_token(uint64_t token);
155 int64_t opal_reinit_cpus(uint64_t flags);
156 
157 int64_t opal_xscom_read(uint32_t gcid, uint64_t pcb_addr, __be64 *val);
158 int64_t opal_xscom_write(uint32_t gcid, uint64_t pcb_addr, uint64_t val);
159 
160 int64_t opal_lpc_write(uint32_t chip_id, enum OpalLPCAddressType addr_type,
161 		       uint32_t addr, uint32_t data, uint32_t sz);
162 int64_t opal_lpc_read(uint32_t chip_id, enum OpalLPCAddressType addr_type,
163 		      uint32_t addr, __be32 *data, uint32_t sz);
164 
165 int64_t opal_read_elog(uint64_t buffer, uint64_t size, uint64_t log_id);
166 int64_t opal_get_elog_size(__be64 *log_id, __be64 *size, __be64 *elog_type);
167 int64_t opal_write_elog(uint64_t buffer, uint64_t size, uint64_t offset);
168 int64_t opal_send_ack_elog(uint64_t log_id);
169 void opal_resend_pending_logs(void);
170 
171 int64_t opal_validate_flash(uint64_t buffer, uint32_t *size, uint32_t *result);
172 int64_t opal_manage_flash(uint8_t op);
173 int64_t opal_update_flash(uint64_t blk_list);
174 int64_t opal_dump_init(uint8_t dump_type);
175 int64_t opal_dump_info(__be32 *dump_id, __be32 *dump_size);
176 int64_t opal_dump_info2(__be32 *dump_id, __be32 *dump_size, __be32 *dump_type);
177 int64_t opal_dump_read(uint32_t dump_id, uint64_t buffer);
178 int64_t opal_dump_ack(uint32_t dump_id);
179 int64_t opal_dump_resend_notification(void);
180 
181 int64_t opal_get_msg(uint64_t buffer, uint64_t size);
182 int64_t opal_write_oppanel_async(uint64_t token, oppanel_line_t *lines,
183 					uint64_t num_lines);
184 int64_t opal_check_completion(uint64_t buffer, uint64_t size, uint64_t token);
185 int64_t opal_sync_host_reboot(void);
186 int64_t opal_get_param(uint64_t token, uint32_t param_id, uint64_t buffer,
187 		uint64_t length);
188 int64_t opal_set_param(uint64_t token, uint32_t param_id, uint64_t buffer,
189 		uint64_t length);
190 int64_t opal_sensor_read(uint32_t sensor_hndl, int token, __be32 *sensor_data);
191 int64_t opal_handle_hmi(void);
192 int64_t opal_register_dump_region(uint32_t id, uint64_t start, uint64_t end);
193 int64_t opal_unregister_dump_region(uint32_t id);
194 int64_t opal_slw_set_reg(uint64_t cpu_pir, uint64_t sprn, uint64_t val);
195 int64_t opal_config_cpu_idle_state(uint64_t state, uint64_t flag);
196 int64_t opal_pci_set_phb_cxl_mode(uint64_t phb_id, uint64_t mode, uint64_t pe_number);
197 int64_t opal_ipmi_send(uint64_t interface, struct opal_ipmi_msg *msg,
198 		uint64_t msg_len);
199 int64_t opal_ipmi_recv(uint64_t interface, struct opal_ipmi_msg *msg,
200 		uint64_t *msg_len);
201 int64_t opal_i2c_request(uint64_t async_token, uint32_t bus_id,
202 			 struct opal_i2c_request *oreq);
203 int64_t opal_prd_msg(struct opal_prd_msg *msg);
204 int64_t opal_leds_get_ind(char *loc_code, __be64 *led_mask,
205 			  __be64 *led_value, __be64 *max_led_type);
206 int64_t opal_leds_set_ind(uint64_t token, char *loc_code, const u64 led_mask,
207 			  const u64 led_value, __be64 *max_led_type);
208 
209 int64_t opal_flash_read(uint64_t id, uint64_t offset, uint64_t buf,
210 		uint64_t size, uint64_t token);
211 int64_t opal_flash_write(uint64_t id, uint64_t offset, uint64_t buf,
212 		uint64_t size, uint64_t token);
213 int64_t opal_flash_erase(uint64_t id, uint64_t offset, uint64_t size,
214 		uint64_t token);
215 int64_t opal_get_device_tree(uint32_t phandle, uint64_t buf, uint64_t len);
216 int64_t opal_pci_get_presence_state(uint64_t id, uint64_t data);
217 int64_t opal_pci_get_power_state(uint64_t id, uint64_t data);
218 int64_t opal_pci_set_power_state(uint64_t async_token, uint64_t id,
219 				 uint64_t data);
220 int64_t opal_pci_poll2(uint64_t id, uint64_t data);
221 
222 int64_t opal_int_get_xirr(uint32_t *out_xirr, bool just_poll);
223 int64_t opal_int_set_cppr(uint8_t cppr);
224 int64_t opal_int_eoi(uint32_t xirr);
225 int64_t opal_int_set_mfrr(uint32_t cpu, uint8_t mfrr);
226 int64_t opal_pci_tce_kill(uint64_t phb_id, uint32_t kill_type,
227 			  uint32_t pe_num, uint32_t tce_size,
228 			  uint64_t dma_addr, uint32_t npages);
229 int64_t opal_rm_pci_tce_kill(uint64_t phb_id, uint32_t kill_type,
230 			     uint32_t pe_num, uint32_t tce_size,
231 			     uint64_t dma_addr, uint32_t npages);
232 
233 /* Internal functions */
234 extern int early_init_dt_scan_opal(unsigned long node, const char *uname,
235 				   int depth, void *data);
236 extern int early_init_dt_scan_recoverable_ranges(unsigned long node,
237 				 const char *uname, int depth, void *data);
238 extern void opal_configure_cores(void);
239 
240 extern int opal_get_chars(uint32_t vtermno, char *buf, int count);
241 extern int opal_put_chars(uint32_t vtermno, const char *buf, int total_len);
242 
243 extern void hvc_opal_init_early(void);
244 
245 extern int opal_notifier_register(struct notifier_block *nb);
246 extern int opal_notifier_unregister(struct notifier_block *nb);
247 
248 extern int opal_message_notifier_register(enum opal_msg_type msg_type,
249 						struct notifier_block *nb);
250 extern int opal_message_notifier_unregister(enum opal_msg_type msg_type,
251 					    struct notifier_block *nb);
252 extern void opal_notifier_enable(void);
253 extern void opal_notifier_disable(void);
254 extern void opal_notifier_update_evt(uint64_t evt_mask, uint64_t evt_val);
255 
256 extern int __opal_async_get_token(void);
257 extern int opal_async_get_token_interruptible(void);
258 extern int __opal_async_release_token(int token);
259 extern int opal_async_release_token(int token);
260 extern int opal_async_wait_response(uint64_t token, struct opal_msg *msg);
261 extern int opal_get_sensor_data(u32 sensor_hndl, u32 *sensor_data);
262 
263 struct rtc_time;
264 extern unsigned long opal_get_boot_time(void);
265 extern void opal_nvram_init(void);
266 extern void opal_flash_update_init(void);
267 extern void opal_flash_term_callback(void);
268 extern int opal_elog_init(void);
269 extern void opal_platform_dump_init(void);
270 extern void opal_sys_param_init(void);
271 extern void opal_msglog_init(void);
272 extern void opal_msglog_sysfs_init(void);
273 extern int opal_async_comp_init(void);
274 extern int opal_sensor_init(void);
275 extern int opal_hmi_handler_init(void);
276 extern int opal_event_init(void);
277 
278 extern int opal_machine_check(struct pt_regs *regs);
279 extern bool opal_mce_check_early_recovery(struct pt_regs *regs);
280 extern int opal_hmi_exception_early(struct pt_regs *regs);
281 extern int opal_handle_hmi_exception(struct pt_regs *regs);
282 
283 extern void opal_shutdown(void);
284 extern int opal_resync_timebase(void);
285 
286 extern void opal_lpc_init(void);
287 
288 extern void opal_kmsg_init(void);
289 
290 extern int opal_event_request(unsigned int opal_event_nr);
291 
292 struct opal_sg_list *opal_vmalloc_to_sg_list(void *vmalloc_addr,
293 					     unsigned long vmalloc_size);
294 void opal_free_sg_list(struct opal_sg_list *sg);
295 
296 extern int opal_error_code(int rc);
297 
298 ssize_t opal_msglog_copy(char *to, loff_t pos, size_t count);
299 
300 static inline int opal_get_async_rc(struct opal_msg msg)
301 {
302 	if (msg.msg_type != OPAL_MSG_ASYNC_COMP)
303 		return OPAL_PARAMETER;
304 	else
305 		return be64_to_cpu(msg.params[1]);
306 }
307 
308 void opal_wake_poller(void);
309 
310 #endif /* __ASSEMBLY__ */
311 
312 #endif /* _ASM_POWERPC_OPAL_H */
313