Merge branch 'address-masking'
[linux-2.6-block.git] / include / linux / pci-epc.h
CommitLineData
8cfab3cf 1/* SPDX-License-Identifier: GPL-2.0 */
347269c1 2/*
5e8cb403
KVA
3 * PCI Endpoint *Controller* (EPC) header file
4 *
5 * Copyright (C) 2017 Texas Instruments
6 * Author: Kishon Vijay Abraham I <kishon@ti.com>
5e8cb403
KVA
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
63840ff5
KVA
16enum pci_epc_interface_type {
17 UNKNOWN_INTERFACE = -1,
18 PRIMARY_INTERFACE,
19 SECONDARY_INTERFACE,
20};
21
63840ff5
KVA
22static inline const char *
23pci_epc_interface_string(enum pci_epc_interface_type type)
24{
25 switch (type) {
26 case PRIMARY_INTERFACE:
27 return "primary";
28 case SECONDARY_INTERFACE:
29 return "secondary";
30 default:
31 return "UNKNOWN interface";
32 }
33}
34
5e8cb403
KVA
35/**
36 * struct pci_epc_ops - set of function pointers for performing EPC operations
37 * @write_header: ops to populate configuration space header
38 * @set_bar: ops to configure the BAR
39 * @clear_bar: ops to reset the BAR
40 * @map_addr: ops to map CPU address to PCI address
41 * @unmap_addr: ops to unmap CPU address and PCI address
42 * @set_msi: ops to set the requested number of MSI interrupts in the MSI
43 * capability register
44 * @get_msi: ops to get the number of MSI interrupts allocated by the RC from
45 * the MSI capability register
8963106e
GP
46 * @set_msix: ops to set the requested number of MSI-X interrupts in the
47 * MSI-X capability register
48 * @get_msix: ops to get the number of MSI-X interrupts allocated by the RC
49 * from the MSI-X capability register
d3c70a98 50 * @raise_irq: ops to raise a legacy, MSI or MSI-X interrupt
87d5972e 51 * @map_msi_irq: ops to map physical address to MSI address and return MSI data
5e8cb403
KVA
52 * @start: ops to start the PCI link
53 * @stop: ops to stop the PCI link
347269c1 54 * @get_features: ops to get the features supported by the EPC
5e8cb403
KVA
55 * @owner: the module owner containing the ops
56 */
57struct pci_epc_ops {
53fd3cbe 58 int (*write_header)(struct pci_epc *epc, u8 func_no, u8 vfunc_no,
5e8cb403 59 struct pci_epf_header *hdr);
53fd3cbe 60 int (*set_bar)(struct pci_epc *epc, u8 func_no, u8 vfunc_no,
bc4a4897 61 struct pci_epf_bar *epf_bar);
53fd3cbe 62 void (*clear_bar)(struct pci_epc *epc, u8 func_no, u8 vfunc_no,
77d08dbd 63 struct pci_epf_bar *epf_bar);
53fd3cbe 64 int (*map_addr)(struct pci_epc *epc, u8 func_no, u8 vfunc_no,
4494738d 65 phys_addr_t addr, u64 pci_addr, size_t size);
53fd3cbe 66 void (*unmap_addr)(struct pci_epc *epc, u8 func_no, u8 vfunc_no,
4494738d 67 phys_addr_t addr);
53fd3cbe
KVA
68 int (*set_msi)(struct pci_epc *epc, u8 func_no, u8 vfunc_no,
69 u8 interrupts);
70 int (*get_msi)(struct pci_epc *epc, u8 func_no, u8 vfunc_no);
71 int (*set_msix)(struct pci_epc *epc, u8 func_no, u8 vfunc_no,
72 u16 interrupts, enum pci_barno, u32 offset);
73 int (*get_msix)(struct pci_epc *epc, u8 func_no, u8 vfunc_no);
74 int (*raise_irq)(struct pci_epc *epc, u8 func_no, u8 vfunc_no,
74955cb8 75 unsigned int type, u16 interrupt_num);
53fd3cbe 76 int (*map_msi_irq)(struct pci_epc *epc, u8 func_no, u8 vfunc_no,
87d5972e
KVA
77 phys_addr_t phys_addr, u8 interrupt_num,
78 u32 entry_size, u32 *msi_data,
79 u32 *msi_addr_offset);
5e8cb403
KVA
80 int (*start)(struct pci_epc *epc);
81 void (*stop)(struct pci_epc *epc);
41cb8d18 82 const struct pci_epc_features* (*get_features)(struct pci_epc *epc,
53fd3cbe 83 u8 func_no, u8 vfunc_no);
5e8cb403
KVA
84 struct module *owner;
85};
86
d45e3c1a
LP
87/**
88 * struct pci_epc_mem_window - address window of the endpoint controller
89 * @phys_base: physical base address of the PCI address window
90 * @size: the size of the PCI address window
91 * @page_size: size of each page
92 */
93struct pci_epc_mem_window {
94 phys_addr_t phys_base;
95 size_t size;
96 size_t page_size;
97};
98
5e8cb403
KVA
99/**
100 * struct pci_epc_mem - address space of the endpoint controller
d45e3c1a 101 * @window: address window of the endpoint controller
5e8cb403
KVA
102 * @bitmap: bitmap to manage the PCI address space
103 * @pages: number of bits representing the address region
04e046ca 104 * @lock: mutex to protect bitmap
5e8cb403
KVA
105 */
106struct pci_epc_mem {
d45e3c1a 107 struct pci_epc_mem_window window;
5e8cb403
KVA
108 unsigned long *bitmap;
109 int pages;
04e046ca
KVA
110 /* mutex to protect against concurrent access for memory allocation*/
111 struct mutex lock;
5e8cb403
KVA
112};
113
114/**
115 * struct pci_epc - represents the PCI EPC device
116 * @dev: PCI EPC device
117 * @pci_epf: list of endpoint functions present in this EPC device
2db6b72c 118 * @list_lock: Mutex for protecting pci_epf list
5e8cb403 119 * @ops: function pointers for performing endpoint operations
d45e3c1a
LP
120 * @windows: array of address space of the endpoint controller
121 * @mem: first window of the endpoint controller, which corresponds to
122 * default address space of the endpoint controller supporting
123 * single window.
124 * @num_windows: number of windows supported by device
5e8cb403 125 * @max_functions: max number of functions that can be configured in this EPC
53fd3cbe
KVA
126 * @max_vfs: Array indicating the maximum number of virtual functions that can
127 * be associated with each physical function
3a401a2c 128 * @group: configfs group representing the PCI EPC device
3d3248db 129 * @lock: mutex to protect pci_epc ops
2499ee84 130 * @function_num_map: bitmap to manage physical function number
a01e7214
MS
131 * @init_complete: flag to indicate whether the EPC initialization is complete
132 * or not
5e8cb403
KVA
133 */
134struct pci_epc {
135 struct device dev;
136 struct list_head pci_epf;
d6dd5baf 137 struct mutex list_lock;
5e8cb403 138 const struct pci_epc_ops *ops;
d45e3c1a 139 struct pci_epc_mem **windows;
5e8cb403 140 struct pci_epc_mem *mem;
d45e3c1a 141 unsigned int num_windows;
5e8cb403 142 u8 max_functions;
53fd3cbe 143 u8 *max_vfs;
3a401a2c 144 struct config_group *group;
3d3248db
KVA
145 /* mutex to protect against concurrent access of EP controller */
146 struct mutex lock;
2499ee84 147 unsigned long function_num_map;
a01e7214 148 bool init_complete;
5e8cb403
KVA
149};
150
e01c9797
NC
151/**
152 * @BAR_PROGRAMMABLE: The BAR mask can be configured by the EPC.
153 * @BAR_FIXED: The BAR mask is fixed by the hardware.
154 * @BAR_RESERVED: The BAR should not be touched by an EPF driver.
155 */
156enum pci_epc_bar_type {
157 BAR_PROGRAMMABLE = 0,
158 BAR_FIXED,
159 BAR_RESERVED,
160};
161
162/**
163 * struct pci_epc_bar_desc - hardware description for a BAR
164 * @type: the type of the BAR
165 * @fixed_size: the fixed size, only applicable if type is BAR_FIXED_MASK.
166 * @only_64bit: if true, an EPF driver is not allowed to choose if this BAR
167 * should be configured as 32-bit or 64-bit, the EPF driver must
168 * configure this BAR as 64-bit. Additionally, the BAR succeeding
169 * this BAR must be set to type BAR_RESERVED.
92665146
NC
170 *
171 * only_64bit should not be set on a BAR of type BAR_RESERVED.
172 * (If BARx is a 64-bit BAR that an EPF driver is not allowed to
173 * touch, then both BARx and BARx+1 must be set to type
174 * BAR_RESERVED.)
e01c9797
NC
175 */
176struct pci_epc_bar_desc {
177 enum pci_epc_bar_type type;
178 u64 fixed_size;
179 bool only_64bit;
180};
181
41cb8d18
KVA
182/**
183 * struct pci_epc_features - features supported by a EPC device per function
184 * @linkup_notifier: indicate if the EPC device can notify EPF driver on link up
185 * @msi_capable: indicate if the endpoint function has MSI capability
186 * @msix_capable: indicate if the endpoint function has MSI-X capability
e01c9797 187 * @bar: array specifying the hardware description for each BAR
2a9a8016 188 * @align: alignment size required for BAR buffer allocation
41cb8d18
KVA
189 */
190struct pci_epc_features {
191 unsigned int linkup_notifier : 1;
192 unsigned int msi_capable : 1;
193 unsigned int msix_capable : 1;
e01c9797 194 struct pci_epc_bar_desc bar[PCI_STD_NUM_BARS];
2a9a8016 195 size_t align;
41cb8d18
KVA
196};
197
5e8cb403
KVA
198#define to_pci_epc(device) container_of((device), struct pci_epc, dev)
199
473b2cf9
MS
200#ifdef CONFIG_PCI_ENDPOINT
201
5e8cb403
KVA
202#define pci_epc_create(dev, ops) \
203 __pci_epc_create((dev), (ops), THIS_MODULE)
204#define devm_pci_epc_create(dev, ops) \
205 __devm_pci_epc_create((dev), (ops), THIS_MODULE)
206
207static inline void epc_set_drvdata(struct pci_epc *epc, void *data)
208{
209 dev_set_drvdata(&epc->dev, data);
210}
211
212static inline void *epc_get_drvdata(struct pci_epc *epc)
213{
214 return dev_get_drvdata(&epc->dev);
215}
216
217struct pci_epc *
218__devm_pci_epc_create(struct device *dev, const struct pci_epc_ops *ops,
219 struct module *owner);
220struct pci_epc *
221__pci_epc_create(struct device *dev, const struct pci_epc_ops *ops,
222 struct module *owner);
223void devm_pci_epc_destroy(struct device *dev, struct pci_epc *epc);
224void pci_epc_destroy(struct pci_epc *epc);
63840ff5
KVA
225int pci_epc_add_epf(struct pci_epc *epc, struct pci_epf *epf,
226 enum pci_epc_interface_type type);
5e8cb403 227void pci_epc_linkup(struct pci_epc *epc);
a1f6c3d7 228void pci_epc_linkdown(struct pci_epc *epc);
0ef22dcf 229void pci_epc_init_notify(struct pci_epc *epc);
a01e7214 230void pci_epc_notify_pending_init(struct pci_epc *epc, struct pci_epf *epf);
473b2cf9 231void pci_epc_deinit_notify(struct pci_epc *epc);
f58838d7 232void pci_epc_bus_master_enable_notify(struct pci_epc *epc);
63840ff5
KVA
233void pci_epc_remove_epf(struct pci_epc *epc, struct pci_epf *epf,
234 enum pci_epc_interface_type type);
53fd3cbe 235int pci_epc_write_header(struct pci_epc *epc, u8 func_no, u8 vfunc_no,
4494738d 236 struct pci_epf_header *hdr);
53fd3cbe 237int pci_epc_set_bar(struct pci_epc *epc, u8 func_no, u8 vfunc_no,
bc4a4897 238 struct pci_epf_bar *epf_bar);
53fd3cbe 239void pci_epc_clear_bar(struct pci_epc *epc, u8 func_no, u8 vfunc_no,
77d08dbd 240 struct pci_epf_bar *epf_bar);
53fd3cbe 241int pci_epc_map_addr(struct pci_epc *epc, u8 func_no, u8 vfunc_no,
4494738d 242 phys_addr_t phys_addr,
5e8cb403 243 u64 pci_addr, size_t size);
53fd3cbe 244void pci_epc_unmap_addr(struct pci_epc *epc, u8 func_no, u8 vfunc_no,
4494738d 245 phys_addr_t phys_addr);
53fd3cbe
KVA
246int pci_epc_set_msi(struct pci_epc *epc, u8 func_no, u8 vfunc_no,
247 u8 interrupts);
248int pci_epc_get_msi(struct pci_epc *epc, u8 func_no, u8 vfunc_no);
249int pci_epc_set_msix(struct pci_epc *epc, u8 func_no, u8 vfunc_no,
250 u16 interrupts, enum pci_barno, u32 offset);
251int pci_epc_get_msix(struct pci_epc *epc, u8 func_no, u8 vfunc_no);
252int pci_epc_map_msi_irq(struct pci_epc *epc, u8 func_no, u8 vfunc_no,
87d5972e
KVA
253 phys_addr_t phys_addr, u8 interrupt_num,
254 u32 entry_size, u32 *msi_data, u32 *msi_addr_offset);
53fd3cbe 255int pci_epc_raise_irq(struct pci_epc *epc, u8 func_no, u8 vfunc_no,
74955cb8 256 unsigned int type, u16 interrupt_num);
5e8cb403
KVA
257int pci_epc_start(struct pci_epc *epc);
258void pci_epc_stop(struct pci_epc *epc);
41cb8d18 259const struct pci_epc_features *pci_epc_get_features(struct pci_epc *epc,
53fd3cbe 260 u8 func_no, u8 vfunc_no);
0e27aecc
KVA
261enum pci_barno
262pci_epc_get_first_free_bar(const struct pci_epc_features *epc_features);
263enum pci_barno pci_epc_get_next_free_bar(const struct pci_epc_features
264 *epc_features, enum pci_barno bar);
5e8cb403
KVA
265struct pci_epc *pci_epc_get(const char *epc_name);
266void pci_epc_put(struct pci_epc *epc);
267
975cf23e
LP
268int pci_epc_mem_init(struct pci_epc *epc, phys_addr_t base,
269 size_t size, size_t page_size);
d45e3c1a
LP
270int pci_epc_multi_mem_init(struct pci_epc *epc,
271 struct pci_epc_mem_window *window,
272 unsigned int num_windows);
5e8cb403
KVA
273void pci_epc_mem_exit(struct pci_epc *epc);
274void __iomem *pci_epc_mem_alloc_addr(struct pci_epc *epc,
275 phys_addr_t *phys_addr, size_t size);
276void pci_epc_mem_free_addr(struct pci_epc *epc, phys_addr_t phys_addr,
277 void __iomem *virt_addr, size_t size);
473b2cf9
MS
278
279#else
280static inline void pci_epc_init_notify(struct pci_epc *epc)
281{
282}
283
284static inline void pci_epc_deinit_notify(struct pci_epc *epc)
285{
286}
287#endif /* CONFIG_PCI_ENDPOINT */
5e8cb403 288#endif /* __LINUX_PCI_EPC_H */