xref: /openbmc/linux/include/linux/of_irq.h (revision 612d5494)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __OF_IRQ_H
3 #define __OF_IRQ_H
4 
5 #include <linux/types.h>
6 #include <linux/errno.h>
7 #include <linux/irq.h>
8 #include <linux/irqdomain.h>
9 #include <linux/ioport.h>
10 #include <linux/of.h>
11 
12 typedef int (*of_irq_init_cb_t)(struct device_node *, struct device_node *);
13 
14 /*
15  * Workarounds only applied to 32bit powermac machines
16  */
17 #define OF_IMAP_OLDWORLD_MAC	0x00000001
18 #define OF_IMAP_NO_PHANDLE	0x00000002
19 
20 #if defined(CONFIG_PPC32) && defined(CONFIG_PPC_PMAC)
21 extern unsigned int of_irq_workarounds;
22 extern struct device_node *of_irq_dflt_pic;
23 int of_irq_parse_oldworld(const struct device_node *device, int index,
24 			  struct of_phandle_args *out_irq);
25 #else /* CONFIG_PPC32 && CONFIG_PPC_PMAC */
26 #define of_irq_workarounds (0)
27 #define of_irq_dflt_pic (NULL)
of_irq_parse_oldworld(const struct device_node * device,int index,struct of_phandle_args * out_irq)28 static inline int of_irq_parse_oldworld(const struct device_node *device, int index,
29 				      struct of_phandle_args *out_irq)
30 {
31 	return -EINVAL;
32 }
33 #endif /* CONFIG_PPC32 && CONFIG_PPC_PMAC */
34 
35 extern int of_irq_parse_raw(const __be32 *addr, struct of_phandle_args *out_irq);
36 extern unsigned int irq_create_of_mapping(struct of_phandle_args *irq_data);
37 extern int of_irq_to_resource(struct device_node *dev, int index,
38 			      struct resource *r);
39 
40 #ifdef CONFIG_OF_IRQ
41 extern void of_irq_init(const struct of_device_id *matches);
42 extern int of_irq_parse_one(struct device_node *device, int index,
43 			  struct of_phandle_args *out_irq);
44 extern int of_irq_count(struct device_node *dev);
45 extern int of_irq_get(struct device_node *dev, int index);
46 extern int of_irq_get_byname(struct device_node *dev, const char *name);
47 extern int of_irq_to_resource_table(struct device_node *dev,
48 		struct resource *res, int nr_irqs);
49 extern struct device_node *of_irq_find_parent(struct device_node *child);
50 extern struct irq_domain *of_msi_get_domain(struct device *dev,
51 					    struct device_node *np,
52 					    enum irq_domain_bus_token token);
53 extern struct irq_domain *of_msi_map_get_device_domain(struct device *dev,
54 							u32 id,
55 							u32 bus_token);
56 extern void of_msi_configure(struct device *dev, struct device_node *np);
57 u32 of_msi_map_id(struct device *dev, struct device_node *msi_np, u32 id_in);
58 #else
of_irq_init(const struct of_device_id * matches)59 static inline void of_irq_init(const struct of_device_id *matches)
60 {
61 }
of_irq_parse_one(struct device_node * device,int index,struct of_phandle_args * out_irq)62 static inline int of_irq_parse_one(struct device_node *device, int index,
63 				   struct of_phandle_args *out_irq)
64 {
65 	return -EINVAL;
66 }
of_irq_count(struct device_node * dev)67 static inline int of_irq_count(struct device_node *dev)
68 {
69 	return 0;
70 }
of_irq_get(struct device_node * dev,int index)71 static inline int of_irq_get(struct device_node *dev, int index)
72 {
73 	return 0;
74 }
of_irq_get_byname(struct device_node * dev,const char * name)75 static inline int of_irq_get_byname(struct device_node *dev, const char *name)
76 {
77 	return 0;
78 }
of_irq_to_resource_table(struct device_node * dev,struct resource * res,int nr_irqs)79 static inline int of_irq_to_resource_table(struct device_node *dev,
80 					   struct resource *res, int nr_irqs)
81 {
82 	return 0;
83 }
of_irq_find_parent(struct device_node * child)84 static inline void *of_irq_find_parent(struct device_node *child)
85 {
86 	return NULL;
87 }
88 
of_msi_get_domain(struct device * dev,struct device_node * np,enum irq_domain_bus_token token)89 static inline struct irq_domain *of_msi_get_domain(struct device *dev,
90 						   struct device_node *np,
91 						   enum irq_domain_bus_token token)
92 {
93 	return NULL;
94 }
of_msi_map_get_device_domain(struct device * dev,u32 id,u32 bus_token)95 static inline struct irq_domain *of_msi_map_get_device_domain(struct device *dev,
96 						u32 id, u32 bus_token)
97 {
98 	return NULL;
99 }
of_msi_configure(struct device * dev,struct device_node * np)100 static inline void of_msi_configure(struct device *dev, struct device_node *np)
101 {
102 }
of_msi_map_id(struct device * dev,struct device_node * msi_np,u32 id_in)103 static inline u32 of_msi_map_id(struct device *dev,
104 				 struct device_node *msi_np, u32 id_in)
105 {
106 	return id_in;
107 }
108 #endif
109 
110 #if defined(CONFIG_OF_IRQ) || defined(CONFIG_SPARC)
111 /*
112  * irq_of_parse_and_map() is used by all OF enabled platforms; but SPARC
113  * implements it differently.  However, the prototype is the same for all,
114  * so declare it here regardless of the CONFIG_OF_IRQ setting.
115  */
116 extern unsigned int irq_of_parse_and_map(struct device_node *node, int index);
117 
118 #else /* !CONFIG_OF && !CONFIG_SPARC */
irq_of_parse_and_map(struct device_node * dev,int index)119 static inline unsigned int irq_of_parse_and_map(struct device_node *dev,
120 						int index)
121 {
122 	return 0;
123 }
124 #endif /* !CONFIG_OF */
125 
126 #endif /* __OF_IRQ_H */
127