1
2
3
4
5
6
7
8
9#ifndef __LINUX_PCI_EPC_H
10#define __LINUX_PCI_EPC_H
11
12#include <linux/pci-epf.h>
13
14struct pci_epc;
15
16enum pci_epc_interface_type {
17 UNKNOWN_INTERFACE = -1,
18 PRIMARY_INTERFACE,
19 SECONDARY_INTERFACE,
20};
21
22enum pci_epc_irq_type {
23 PCI_EPC_IRQ_UNKNOWN,
24 PCI_EPC_IRQ_LEGACY,
25 PCI_EPC_IRQ_MSI,
26 PCI_EPC_IRQ_MSIX,
27};
28
29static inline const char *
30pci_epc_interface_string(enum pci_epc_interface_type type)
31{
32 switch (type) {
33 case PRIMARY_INTERFACE:
34 return "primary";
35 case SECONDARY_INTERFACE:
36 return "secondary";
37 default:
38 return "UNKNOWN interface";
39 }
40}
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64struct pci_epc_ops {
65 int (*write_header)(struct pci_epc *epc, u8 func_no, u8 vfunc_no,
66 struct pci_epf_header *hdr);
67 int (*set_bar)(struct pci_epc *epc, u8 func_no, u8 vfunc_no,
68 struct pci_epf_bar *epf_bar);
69 void (*clear_bar)(struct pci_epc *epc, u8 func_no, u8 vfunc_no,
70 struct pci_epf_bar *epf_bar);
71 int (*map_addr)(struct pci_epc *epc, u8 func_no, u8 vfunc_no,
72 phys_addr_t addr, u64 pci_addr, size_t size);
73 void (*unmap_addr)(struct pci_epc *epc, u8 func_no, u8 vfunc_no,
74 phys_addr_t addr);
75 int (*set_msi)(struct pci_epc *epc, u8 func_no, u8 vfunc_no,
76 u8 interrupts);
77 int (*get_msi)(struct pci_epc *epc, u8 func_no, u8 vfunc_no);
78 int (*set_msix)(struct pci_epc *epc, u8 func_no, u8 vfunc_no,
79 u16 interrupts, enum pci_barno, u32 offset);
80 int (*get_msix)(struct pci_epc *epc, u8 func_no, u8 vfunc_no);
81 int (*raise_irq)(struct pci_epc *epc, u8 func_no, u8 vfunc_no,
82 enum pci_epc_irq_type type, u16 interrupt_num);
83 int (*map_msi_irq)(struct pci_epc *epc, u8 func_no, u8 vfunc_no,
84 phys_addr_t phys_addr, u8 interrupt_num,
85 u32 entry_size, u32 *msi_data,
86 u32 *msi_addr_offset);
87 int (*start)(struct pci_epc *epc);
88 void (*stop)(struct pci_epc *epc);
89 const struct pci_epc_features* (*get_features)(struct pci_epc *epc,
90 u8 func_no, u8 vfunc_no);
91 struct module *owner;
92};
93
94
95
96
97
98
99
100struct pci_epc_mem_window {
101 phys_addr_t phys_base;
102 size_t size;
103 size_t page_size;
104};
105
106
107
108
109
110
111
112
113struct pci_epc_mem {
114 struct pci_epc_mem_window window;
115 unsigned long *bitmap;
116 int pages;
117
118 struct mutex lock;
119};
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139struct pci_epc {
140 struct device dev;
141 struct list_head pci_epf;
142 const struct pci_epc_ops *ops;
143 struct pci_epc_mem **windows;
144 struct pci_epc_mem *mem;
145 unsigned int num_windows;
146 u8 max_functions;
147 u8 *max_vfs;
148 struct config_group *group;
149
150 struct mutex lock;
151 unsigned long function_num_map;
152 struct atomic_notifier_head notifier;
153};
154
155
156
157
158
159
160
161
162
163
164
165
166
167struct pci_epc_features {
168 unsigned int linkup_notifier : 1;
169 unsigned int core_init_notifier : 1;
170 unsigned int msi_capable : 1;
171 unsigned int msix_capable : 1;
172 u8 reserved_bar;
173 u8 bar_fixed_64bit;
174 u64 bar_fixed_size[PCI_STD_NUM_BARS];
175 size_t align;
176};
177
178#define to_pci_epc(device) container_of((device), struct pci_epc, dev)
179
180#define pci_epc_create(dev, ops) \
181 __pci_epc_create((dev), (ops), THIS_MODULE)
182#define devm_pci_epc_create(dev, ops) \
183 __devm_pci_epc_create((dev), (ops), THIS_MODULE)
184
185static inline void epc_set_drvdata(struct pci_epc *epc, void *data)
186{
187 dev_set_drvdata(&epc->dev, data);
188}
189
190static inline void *epc_get_drvdata(struct pci_epc *epc)
191{
192 return dev_get_drvdata(&epc->dev);
193}
194
195static inline int
196pci_epc_register_notifier(struct pci_epc *epc, struct notifier_block *nb)
197{
198 return atomic_notifier_chain_register(&epc->notifier, nb);
199}
200
201struct pci_epc *
202__devm_pci_epc_create(struct device *dev, const struct pci_epc_ops *ops,
203 struct module *owner);
204struct pci_epc *
205__pci_epc_create(struct device *dev, const struct pci_epc_ops *ops,
206 struct module *owner);
207void devm_pci_epc_destroy(struct device *dev, struct pci_epc *epc);
208void pci_epc_destroy(struct pci_epc *epc);
209int pci_epc_add_epf(struct pci_epc *epc, struct pci_epf *epf,
210 enum pci_epc_interface_type type);
211void pci_epc_linkup(struct pci_epc *epc);
212void pci_epc_init_notify(struct pci_epc *epc);
213void pci_epc_remove_epf(struct pci_epc *epc, struct pci_epf *epf,
214 enum pci_epc_interface_type type);
215int pci_epc_write_header(struct pci_epc *epc, u8 func_no, u8 vfunc_no,
216 struct pci_epf_header *hdr);
217int pci_epc_set_bar(struct pci_epc *epc, u8 func_no, u8 vfunc_no,
218 struct pci_epf_bar *epf_bar);
219void pci_epc_clear_bar(struct pci_epc *epc, u8 func_no, u8 vfunc_no,
220 struct pci_epf_bar *epf_bar);
221int pci_epc_map_addr(struct pci_epc *epc, u8 func_no, u8 vfunc_no,
222 phys_addr_t phys_addr,
223 u64 pci_addr, size_t size);
224void pci_epc_unmap_addr(struct pci_epc *epc, u8 func_no, u8 vfunc_no,
225 phys_addr_t phys_addr);
226int pci_epc_set_msi(struct pci_epc *epc, u8 func_no, u8 vfunc_no,
227 u8 interrupts);
228int pci_epc_get_msi(struct pci_epc *epc, u8 func_no, u8 vfunc_no);
229int pci_epc_set_msix(struct pci_epc *epc, u8 func_no, u8 vfunc_no,
230 u16 interrupts, enum pci_barno, u32 offset);
231int pci_epc_get_msix(struct pci_epc *epc, u8 func_no, u8 vfunc_no);
232int pci_epc_map_msi_irq(struct pci_epc *epc, u8 func_no, u8 vfunc_no,
233 phys_addr_t phys_addr, u8 interrupt_num,
234 u32 entry_size, u32 *msi_data, u32 *msi_addr_offset);
235int pci_epc_raise_irq(struct pci_epc *epc, u8 func_no, u8 vfunc_no,
236 enum pci_epc_irq_type type, u16 interrupt_num);
237int pci_epc_start(struct pci_epc *epc);
238void pci_epc_stop(struct pci_epc *epc);
239const struct pci_epc_features *pci_epc_get_features(struct pci_epc *epc,
240 u8 func_no, u8 vfunc_no);
241enum pci_barno
242pci_epc_get_first_free_bar(const struct pci_epc_features *epc_features);
243enum pci_barno pci_epc_get_next_free_bar(const struct pci_epc_features
244 *epc_features, enum pci_barno bar);
245struct pci_epc *pci_epc_get(const char *epc_name);
246void pci_epc_put(struct pci_epc *epc);
247
248int pci_epc_mem_init(struct pci_epc *epc, phys_addr_t base,
249 size_t size, size_t page_size);
250int pci_epc_multi_mem_init(struct pci_epc *epc,
251 struct pci_epc_mem_window *window,
252 unsigned int num_windows);
253void pci_epc_mem_exit(struct pci_epc *epc);
254void __iomem *pci_epc_mem_alloc_addr(struct pci_epc *epc,
255 phys_addr_t *phys_addr, size_t size);
256void pci_epc_mem_free_addr(struct pci_epc *epc, phys_addr_t phys_addr,
257 void __iomem *virt_addr, size_t size);
258#endif
259