x86, irq: Introduce helper to check whether an IOAPIC has been registered
[cascardo/linux.git] / arch / x86 / include / asm / io_apic.h
1 #ifndef _ASM_X86_IO_APIC_H
2 #define _ASM_X86_IO_APIC_H
3
4 #include <linux/types.h>
5 #include <asm/mpspec.h>
6 #include <asm/apicdef.h>
7 #include <asm/irq_vectors.h>
8 #include <asm/x86_init.h>
9 /*
10  * Intel IO-APIC support for SMP and UP systems.
11  *
12  * Copyright (C) 1997, 1998, 1999, 2000 Ingo Molnar
13  */
14
15 /* I/O Unit Redirection Table */
16 #define IO_APIC_REDIR_VECTOR_MASK       0x000FF
17 #define IO_APIC_REDIR_DEST_LOGICAL      0x00800
18 #define IO_APIC_REDIR_DEST_PHYSICAL     0x00000
19 #define IO_APIC_REDIR_SEND_PENDING      (1 << 12)
20 #define IO_APIC_REDIR_REMOTE_IRR        (1 << 14)
21 #define IO_APIC_REDIR_LEVEL_TRIGGER     (1 << 15)
22 #define IO_APIC_REDIR_MASKED            (1 << 16)
23
24 /*
25  * The structure of the IO-APIC:
26  */
27 union IO_APIC_reg_00 {
28         u32     raw;
29         struct {
30                 u32     __reserved_2    : 14,
31                         LTS             :  1,
32                         delivery_type   :  1,
33                         __reserved_1    :  8,
34                         ID              :  8;
35         } __attribute__ ((packed)) bits;
36 };
37
38 union IO_APIC_reg_01 {
39         u32     raw;
40         struct {
41                 u32     version         :  8,
42                         __reserved_2    :  7,
43                         PRQ             :  1,
44                         entries         :  8,
45                         __reserved_1    :  8;
46         } __attribute__ ((packed)) bits;
47 };
48
49 union IO_APIC_reg_02 {
50         u32     raw;
51         struct {
52                 u32     __reserved_2    : 24,
53                         arbitration     :  4,
54                         __reserved_1    :  4;
55         } __attribute__ ((packed)) bits;
56 };
57
58 union IO_APIC_reg_03 {
59         u32     raw;
60         struct {
61                 u32     boot_DT         :  1,
62                         __reserved_1    : 31;
63         } __attribute__ ((packed)) bits;
64 };
65
66 struct IO_APIC_route_entry {
67         __u32   vector          :  8,
68                 delivery_mode   :  3,   /* 000: FIXED
69                                          * 001: lowest prio
70                                          * 111: ExtINT
71                                          */
72                 dest_mode       :  1,   /* 0: physical, 1: logical */
73                 delivery_status :  1,
74                 polarity        :  1,
75                 irr             :  1,
76                 trigger         :  1,   /* 0: edge, 1: level */
77                 mask            :  1,   /* 0: enabled, 1: disabled */
78                 __reserved_2    : 15;
79
80         __u32   __reserved_3    : 24,
81                 dest            :  8;
82 } __attribute__ ((packed));
83
84 struct IR_IO_APIC_route_entry {
85         __u64   vector          : 8,
86                 zero            : 3,
87                 index2          : 1,
88                 delivery_status : 1,
89                 polarity        : 1,
90                 irr             : 1,
91                 trigger         : 1,
92                 mask            : 1,
93                 reserved        : 31,
94                 format          : 1,
95                 index           : 15;
96 } __attribute__ ((packed));
97
98 #define IOAPIC_AUTO     -1
99 #define IOAPIC_EDGE     0
100 #define IOAPIC_LEVEL    1
101 #define IOAPIC_MAP_ALLOC                0x1
102 #define IOAPIC_MAP_CHECK                0x2
103
104 #ifdef CONFIG_X86_IO_APIC
105
106 /*
107  * # of IO-APICs and # of IRQ routing registers
108  */
109 extern int nr_ioapics;
110
111 extern int mpc_ioapic_id(int ioapic);
112 extern unsigned int mpc_ioapic_addr(int ioapic);
113 extern struct mp_ioapic_gsi *mp_ioapic_gsi_routing(int ioapic);
114
115 #define MP_MAX_IOAPIC_PIN 127
116
117 /* # of MP IRQ source entries */
118 extern int mp_irq_entries;
119
120 /* MP IRQ source entries */
121 extern struct mpc_intsrc mp_irqs[MAX_IRQ_SOURCES];
122
123 /* Older SiS APIC requires we rewrite the index register */
124 extern int sis_apic_bug;
125
126 /* 1 if "noapic" boot option passed */
127 extern int skip_ioapic_setup;
128
129 /* 1 if "noapic" boot option passed */
130 extern int noioapicquirk;
131
132 /* -1 if "noapic" boot option passed */
133 extern int noioapicreroute;
134
135 /*
136  * If we use the IO-APIC for IRQ routing, disable automatic
137  * assignment of PCI IRQ's.
138  */
139 #define io_apic_assign_pci_irqs \
140         (mp_irq_entries && !skip_ioapic_setup && io_apic_irqs)
141
142 struct io_apic_irq_attr;
143 struct irq_cfg;
144 extern void ioapic_insert_resources(void);
145
146 extern int native_setup_ioapic_entry(int, struct IO_APIC_route_entry *,
147                                      unsigned int, int,
148                                      struct io_apic_irq_attr *);
149 extern void eoi_ioapic_irq(unsigned int irq, struct irq_cfg *cfg);
150
151 extern void native_compose_msi_msg(struct pci_dev *pdev,
152                                    unsigned int irq, unsigned int dest,
153                                    struct msi_msg *msg, u8 hpet_id);
154 extern void native_eoi_ioapic_pin(int apic, int pin, int vector);
155
156 extern int save_ioapic_entries(void);
157 extern void mask_ioapic_entries(void);
158 extern int restore_ioapic_entries(void);
159
160 extern void setup_ioapic_ids_from_mpc(void);
161 extern void setup_ioapic_ids_from_mpc_nocheck(void);
162
163 enum ioapic_domain_type {
164         IOAPIC_DOMAIN_INVALID,
165         IOAPIC_DOMAIN_LEGACY,
166         IOAPIC_DOMAIN_STRICT,
167         IOAPIC_DOMAIN_DYNAMIC,
168 };
169
170 struct device_node;
171 struct irq_domain;
172 struct irq_domain_ops;
173
174 struct ioapic_domain_cfg {
175         enum ioapic_domain_type         type;
176         const struct irq_domain_ops     *ops;
177         struct device_node              *dev;
178 };
179
180 struct mp_ioapic_gsi{
181         u32 gsi_base;
182         u32 gsi_end;
183 };
184 extern u32 gsi_top;
185
186 extern int mp_find_ioapic(u32 gsi);
187 extern int mp_find_ioapic_pin(int ioapic, u32 gsi);
188 extern u32 mp_pin_to_gsi(int ioapic, int pin);
189 extern int mp_map_gsi_to_irq(u32 gsi, unsigned int flags);
190 extern void mp_unmap_irq(int irq);
191 extern int mp_register_ioapic(int id, u32 address, u32 gsi_base,
192                               struct ioapic_domain_cfg *cfg);
193 extern int mp_unregister_ioapic(u32 gsi_base);
194 extern int mp_ioapic_registered(u32 gsi_base);
195 extern int mp_irqdomain_map(struct irq_domain *domain, unsigned int virq,
196                             irq_hw_number_t hwirq);
197 extern void mp_irqdomain_unmap(struct irq_domain *domain, unsigned int virq);
198 extern int mp_set_gsi_attr(u32 gsi, int trigger, int polarity, int node);
199 extern void __init pre_init_apic_IRQ0(void);
200
201 extern void mp_save_irq(struct mpc_intsrc *m);
202
203 extern void disable_ioapic_support(void);
204
205 extern void __init native_io_apic_init_mappings(void);
206 extern unsigned int native_io_apic_read(unsigned int apic, unsigned int reg);
207 extern void native_io_apic_write(unsigned int apic, unsigned int reg, unsigned int val);
208 extern void native_io_apic_modify(unsigned int apic, unsigned int reg, unsigned int val);
209 extern void native_disable_io_apic(void);
210 extern void native_io_apic_print_entries(unsigned int apic, unsigned int nr_entries);
211 extern void intel_ir_io_apic_print_entries(unsigned int apic, unsigned int nr_entries);
212 extern int native_ioapic_set_affinity(struct irq_data *,
213                                       const struct cpumask *,
214                                       bool);
215
216 static inline unsigned int io_apic_read(unsigned int apic, unsigned int reg)
217 {
218         return x86_io_apic_ops.read(apic, reg);
219 }
220
221 static inline void io_apic_write(unsigned int apic, unsigned int reg, unsigned int value)
222 {
223         x86_io_apic_ops.write(apic, reg, value);
224 }
225 static inline void io_apic_modify(unsigned int apic, unsigned int reg, unsigned int value)
226 {
227         x86_io_apic_ops.modify(apic, reg, value);
228 }
229
230 extern void io_apic_eoi(unsigned int apic, unsigned int vector);
231
232 #else  /* !CONFIG_X86_IO_APIC */
233
234 #define io_apic_assign_pci_irqs 0
235 #define setup_ioapic_ids_from_mpc x86_init_noop
236 static inline void ioapic_insert_resources(void) { }
237 #define gsi_top (NR_IRQS_LEGACY)
238 static inline int mp_find_ioapic(u32 gsi) { return 0; }
239 static inline u32 mp_pin_to_gsi(int ioapic, int pin) { return UINT_MAX; }
240 static inline int mp_map_gsi_to_irq(u32 gsi, unsigned int flags) { return gsi; }
241 static inline void mp_unmap_irq(int irq) { }
242
243 static inline int save_ioapic_entries(void)
244 {
245         return -ENOMEM;
246 }
247
248 static inline void mask_ioapic_entries(void) { }
249 static inline int restore_ioapic_entries(void)
250 {
251         return -ENOMEM;
252 }
253
254 static inline void mp_save_irq(struct mpc_intsrc *m) { };
255 static inline void disable_ioapic_support(void) { }
256 #define native_io_apic_init_mappings    NULL
257 #define native_io_apic_read             NULL
258 #define native_io_apic_write            NULL
259 #define native_io_apic_modify           NULL
260 #define native_disable_io_apic          NULL
261 #define native_io_apic_print_entries    NULL
262 #define native_ioapic_set_affinity      NULL
263 #define native_setup_ioapic_entry       NULL
264 #define native_compose_msi_msg          NULL
265 #define native_eoi_ioapic_pin           NULL
266 #endif
267
268 #endif /* _ASM_X86_IO_APIC_H */