Linux Kernel  3.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
opal.h
Go to the documentation of this file.
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 __OPAL_H
13 #define __OPAL_H
14 
15 /****** Takeover interface ********/
16 
17 /* PAPR H-Call used to querty the HAL existence and/or instanciate
18  * it from within pHyp (tech preview only).
19  *
20  * This is exclusively used in prom_init.c
21  */
22 
23 #ifndef __ASSEMBLY__
24 
26  u64 k_image; /* r4 */
27  u64 k_size; /* r5 */
28  u64 k_entry; /* r6 */
29  u64 k_entry2; /* r7 */
30  u64 hal_addr; /* r8 */
31  u64 rd_image; /* r9 */
32  u64 rd_size; /* r10 */
33  u64 rd_loc; /* r11 */
34 };
35 
36 extern long opal_query_takeover(u64 *hal_size, u64 *hal_align);
37 
38 extern long opal_do_takeover(struct opal_takeover_args *args);
39 
40 struct rtas_args;
41 extern int opal_enter_rtas(struct rtas_args *args,
42  unsigned long data,
43  unsigned long entry);
44 
45 #endif /* __ASSEMBLY__ */
46 
47 /****** OPAL APIs ******/
48 
49 /* Return codes */
50 #define OPAL_SUCCESS 0
51 #define OPAL_PARAMETER -1
52 #define OPAL_BUSY -2
53 #define OPAL_PARTIAL -3
54 #define OPAL_CONSTRAINED -4
55 #define OPAL_CLOSED -5
56 #define OPAL_HARDWARE -6
57 #define OPAL_UNSUPPORTED -7
58 #define OPAL_PERMISSION -8
59 #define OPAL_NO_MEM -9
60 #define OPAL_RESOURCE -10
61 #define OPAL_INTERNAL_ERROR -11
62 #define OPAL_BUSY_EVENT -12
63 #define OPAL_HARDWARE_FROZEN -13
64 
65 /* API Tokens (in r0) */
66 #define OPAL_CONSOLE_WRITE 1
67 #define OPAL_CONSOLE_READ 2
68 #define OPAL_RTC_READ 3
69 #define OPAL_RTC_WRITE 4
70 #define OPAL_CEC_POWER_DOWN 5
71 #define OPAL_CEC_REBOOT 6
72 #define OPAL_READ_NVRAM 7
73 #define OPAL_WRITE_NVRAM 8
74 #define OPAL_HANDLE_INTERRUPT 9
75 #define OPAL_POLL_EVENTS 10
76 #define OPAL_PCI_SET_HUB_TCE_MEMORY 11
77 #define OPAL_PCI_SET_PHB_TCE_MEMORY 12
78 #define OPAL_PCI_CONFIG_READ_BYTE 13
79 #define OPAL_PCI_CONFIG_READ_HALF_WORD 14
80 #define OPAL_PCI_CONFIG_READ_WORD 15
81 #define OPAL_PCI_CONFIG_WRITE_BYTE 16
82 #define OPAL_PCI_CONFIG_WRITE_HALF_WORD 17
83 #define OPAL_PCI_CONFIG_WRITE_WORD 18
84 #define OPAL_SET_XIVE 19
85 #define OPAL_GET_XIVE 20
86 #define OPAL_GET_COMPLETION_TOKEN_STATUS 21 /* obsolete */
87 #define OPAL_REGISTER_OPAL_EXCEPTION_HANDLER 22
88 #define OPAL_PCI_EEH_FREEZE_STATUS 23
89 #define OPAL_PCI_SHPC 24
90 #define OPAL_CONSOLE_WRITE_BUFFER_SPACE 25
91 #define OPAL_PCI_EEH_FREEZE_CLEAR 26
92 #define OPAL_PCI_PHB_MMIO_ENABLE 27
93 #define OPAL_PCI_SET_PHB_MEM_WINDOW 28
94 #define OPAL_PCI_MAP_PE_MMIO_WINDOW 29
95 #define OPAL_PCI_SET_PHB_TABLE_MEMORY 30
96 #define OPAL_PCI_SET_PE 31
97 #define OPAL_PCI_SET_PELTV 32
98 #define OPAL_PCI_SET_MVE 33
99 #define OPAL_PCI_SET_MVE_ENABLE 34
100 #define OPAL_PCI_GET_XIVE_REISSUE 35
101 #define OPAL_PCI_SET_XIVE_REISSUE 36
102 #define OPAL_PCI_SET_XIVE_PE 37
103 #define OPAL_GET_XIVE_SOURCE 38
104 #define OPAL_GET_MSI_32 39
105 #define OPAL_GET_MSI_64 40
106 #define OPAL_START_CPU 41
107 #define OPAL_QUERY_CPU_STATUS 42
108 #define OPAL_WRITE_OPPANEL 43
109 #define OPAL_PCI_MAP_PE_DMA_WINDOW 44
110 #define OPAL_PCI_MAP_PE_DMA_WINDOW_REAL 45
111 #define OPAL_PCI_RESET 49
112 #define OPAL_PCI_GET_HUB_DIAG_DATA 50
113 #define OPAL_PCI_GET_PHB_DIAG_DATA 51
114 #define OPAL_PCI_FENCE_PHB 52
115 #define OPAL_PCI_REINIT 53
116 #define OPAL_PCI_MASK_PE_ERROR 54
117 #define OPAL_SET_SLOT_LED_STATUS 55
118 #define OPAL_GET_EPOW_STATUS 56
119 #define OPAL_SET_SYSTEM_ATTENTION_LED 57
120 
121 #ifndef __ASSEMBLY__
122 
123 /* Other enums */
126 };
135 };
140 };
152 };
156 };
160 };
165 };
169 };
174 };
185 };
186 
187 /* Machine check related definitions */
190 };
191 
197 };
198 
202 };
203 
207 };
208 
215 };
216 
223 };
224 
229 };
230 
235 };
236 
241 };
242 
246 };
247 
249  OpalPciBusAny = 0, /* Any bus number match */
250  OpalPciBus3Bits = 2, /* Match top 3 bits of bus number */
251  OpalPciBus4Bits = 3, /* Match top 4 bits of bus number */
252  OpalPciBus5Bits = 4, /* Match top 5 bits of bus number */
253  OpalPciBus6Bits = 5, /* Match top 6 bits of bus number */
254  OpalPciBus7Bits = 6, /* Match top 7 bits of bus number */
255  OpalPciBusAll = 7, /* Match bus number exactly */
256 };
257 
261 };
262 
266 };
267 
271 };
272 
276 };
277 
281 };
282 
287 };
288 
292 };
293 
297 };
298 
302 };
303 
308 };
309 
315 };
316 
318  enum OpalMCE_Version version:8; /* 0x00 */
319  uint8_t in_use; /* 0x01 */
320  enum OpalMCE_Severity severity:8; /* 0x02 */
321  enum OpalMCE_Initiator initiator:8; /* 0x03 */
322  enum OpalMCE_ErrorType error_type:8; /* 0x04 */
323  enum OpalMCE_Disposition disposition:8; /* 0x05 */
324  uint8_t reserved_1[2]; /* 0x06 */
325  uint64_t gpr3; /* 0x08 */
326  uint64_t srr0; /* 0x10 */
327  uint64_t srr1; /* 0x18 */
328  union { /* 0x20 */
329  struct {
330  enum OpalMCE_UeErrorType ue_error_type:8;
333  uint8_t reserved_1[5];
337  } ue_error;
338 
339  struct {
340  enum OpalMCE_SlbErrorType slb_error_type:8;
342  uint8_t reserved_1[6];
344  uint8_t reserved_2[16];
345  } slb_error;
346 
347  struct {
348  enum OpalMCE_EratErrorType erat_error_type:8;
350  uint8_t reserved_1[6];
352  uint8_t reserved_2[16];
353  } erat_error;
354 
355  struct {
356  enum OpalMCE_TlbErrorType tlb_error_type:8;
358  uint8_t reserved_1[6];
360  uint8_t reserved_2[16];
361  } tlb_error;
362  } u;
363 };
364 
369 enum {
371 };
372 
375 
376  // P7IOC utl regs
380 
381  // P7IOC cfg regs
387 
388  // cfg AER regs
397 
399 
400  // Record data about the call to allocate a buffer.
403 
404  //P7IOC MMIO Error Regs
407  uint64_t lemFir; // nC00
409  uint64_t lemWOF; // nC40
428 };
429 
430 typedef struct oppanel_line {
431  const char * line;
434 
435 /* API functions */
436 int64_t opal_console_write(int64_t term_number, int64_t *length,
437  const uint8_t *buffer);
438 int64_t opal_console_read(int64_t term_number, int64_t *length,
439  uint8_t *buffer);
440 int64_t opal_console_write_buffer_space(int64_t term_number,
441  int64_t *length);
442 int64_t opal_rtc_read(uint32_t *year_month_day,
443  uint64_t *hour_minute_second_millisecond);
444 int64_t opal_rtc_write(uint32_t year_month_day,
445  uint64_t hour_minute_second_millisecond);
447 int64_t opal_cec_reboot(void);
450 int64_t opal_handle_interrupt(uint64_t isn, uint64_t *outstanding_event_mask);
451 int64_t opal_poll_events(uint64_t *outstanding_event_mask);
452 int64_t opal_pci_set_hub_tce_memory(uint64_t hub_id, uint64_t tce_mem_addr,
453  uint64_t tce_mem_size);
454 int64_t opal_pci_set_phb_tce_memory(uint64_t phb_id, uint64_t tce_mem_addr,
455  uint64_t tce_mem_size);
456 int64_t opal_pci_config_read_byte(uint64_t phb_id, uint64_t bus_dev_func,
458 int64_t opal_pci_config_read_half_word(uint64_t phb_id, uint64_t bus_dev_func,
460 int64_t opal_pci_config_read_word(uint64_t phb_id, uint64_t bus_dev_func,
462 int64_t opal_pci_config_write_byte(uint64_t phb_id, uint64_t bus_dev_func,
464 int64_t opal_pci_config_write_half_word(uint64_t phb_id, uint64_t bus_dev_func,
466 int64_t opal_pci_config_write_word(uint64_t phb_id, uint64_t bus_dev_func,
468 int64_t opal_set_xive(uint32_t isn, uint16_t server, uint8_t priority);
469 int64_t opal_get_xive(uint32_t isn, uint16_t *server, uint8_t *priority);
470 int64_t opal_register_exception_handler(uint64_t opal_exception,
471  uint64_t handler_address,
472  uint64_t glue_cache_line);
473 int64_t opal_pci_eeh_freeze_status(uint64_t phb_id, uint64_t pe_number,
474  uint8_t *freeze_state,
475  uint16_t *pci_error_type,
476  uint64_t *phb_status);
477 int64_t opal_pci_eeh_freeze_clear(uint64_t phb_id, uint64_t pe_number,
478  uint64_t eeh_action_token);
479 int64_t opal_pci_shpc(uint64_t phb_id, uint64_t shpc_action, uint8_t *state);
480 
481 
482 
484  uint16_t window_num, uint16_t enable);
486  uint16_t window_num,
487  uint64_t starting_real_address,
488  uint64_t starting_pci_address,
489  uint16_t segment_size);
490 int64_t opal_pci_map_pe_mmio_window(uint64_t phb_id, uint16_t pe_number,
491  uint16_t window_type, uint16_t window_num,
492  uint16_t segment_num);
493 int64_t opal_pci_set_phb_table_memory(uint64_t phb_id, uint64_t rtt_addr,
494  uint64_t ivt_addr, uint64_t ivt_len,
495  uint64_t reject_array_addr,
496  uint64_t peltv_addr);
497 int64_t opal_pci_set_pe(uint64_t phb_id, uint64_t pe_number, uint64_t bus_dev_func,
498  uint8_t bus_compare, uint8_t dev_compare, uint8_t func_compare,
499  uint8_t pe_action);
500 int64_t opal_pci_set_peltv(uint64_t phb_id, uint32_t parent_pe, uint32_t child_pe,
501  uint8_t state);
502 int64_t opal_pci_set_mve(uint64_t phb_id, uint32_t mve_number, uint32_t pe_number);
503 int64_t opal_pci_set_mve_enable(uint64_t phb_id, uint32_t mve_number,
504  uint32_t state);
505 int64_t opal_pci_get_xive_reissue(uint64_t phb_id, uint32_t xive_number,
506  uint8_t *p_bit, uint8_t *q_bit);
507 int64_t opal_pci_set_xive_reissue(uint64_t phb_id, uint32_t xive_number,
508  uint8_t p_bit, uint8_t q_bit);
509 int64_t opal_pci_set_xive_pe(uint64_t phb_id, uint32_t pe_number,
510  uint32_t xive_num);
511 int64_t opal_get_xive_source(uint64_t phb_id, uint32_t xive_num,
512  int32_t *interrupt_source_number);
513 int64_t opal_get_msi_32(uint64_t phb_id, uint32_t mve_number, uint32_t xive_num,
514  uint8_t msi_range, uint32_t *msi_address,
515  uint32_t *message_data);
516 int64_t opal_get_msi_64(uint64_t phb_id, uint32_t mve_number,
517  uint32_t xive_num, uint8_t msi_range,
518  uint64_t *msi_address, uint32_t *message_data);
519 int64_t opal_start_cpu(uint64_t thread_number, uint64_t start_address);
520 int64_t opal_query_cpu_status(uint64_t thread_number, uint8_t *thread_status);
521 int64_t opal_write_oppanel(oppanel_line_t *lines, uint64_t num_lines);
522 int64_t opal_pci_map_pe_dma_window(uint64_t phb_id, uint16_t pe_number, uint16_t window_id,
523  uint16_t tce_levels, uint64_t tce_table_addr,
524  uint64_t tce_table_size, uint64_t tce_page_size);
525 int64_t opal_pci_map_pe_dma_window_real(uint64_t phb_id, uint16_t pe_number,
526  uint16_t dma_window_number, uint64_t pci_start_addr,
527  uint64_t pci_mem_size);
528 int64_t opal_pci_reset(uint64_t phb_id, uint8_t reset_scope, uint8_t assert_state);
529 
530 int64_t opal_pci_get_hub_diag_data(uint64_t hub_id, void *diag_buffer, uint64_t diag_buffer_len);
531 int64_t opal_pci_get_phb_diag_data(uint64_t phb_id, void *diag_buffer, uint64_t diag_buffer_len);
532 int64_t opal_pci_fence_phb(uint64_t phb_id);
533 int64_t opal_pci_reinit(uint64_t phb_id, uint8_t reinit_scope);
534 int64_t opal_pci_mask_pe_error(uint64_t phb_id, uint16_t pe_number, uint8_t error_type, uint8_t mask_action);
535 int64_t opal_set_slot_led_status(uint64_t phb_id, uint64_t slot_id, uint8_t led_type, uint8_t led_action);
537 int64_t opal_set_system_attention_led(uint8_t led_action);
538 
539 /* Internal functions */
540 extern int early_init_dt_scan_opal(unsigned long node, const char *uname, int depth, void *data);
541 
542 extern int opal_get_chars(uint32_t vtermno, char *buf, int count);
543 extern int opal_put_chars(uint32_t vtermno, const char *buf, int total_len);
544 
545 extern void hvc_opal_init_early(void);
546 
547 /* Internal functions */
548 extern int early_init_dt_scan_opal(unsigned long node, const char *uname,
549  int depth, void *data);
550 
551 extern int opal_get_chars(uint32_t vtermno, char *buf, int count);
552 extern int opal_put_chars(uint32_t vtermno, const char *buf, int total_len);
553 
554 extern void hvc_opal_init_early(void);
555 
556 struct rtc_time;
557 extern int opal_set_rtc_time(struct rtc_time *tm);
558 extern void opal_get_rtc_time(struct rtc_time *tm);
559 extern unsigned long opal_get_boot_time(void);
560 extern void opal_nvram_init(void);
561 
562 extern int opal_machine_check(struct pt_regs *regs);
563 
564 #endif /* __ASSEMBLY__ */
565 
566 #endif /* __OPAL_H */