1 /* SPDX-License-Identifier: GPL-2.0 */
3 * PCI Endpoint *Controller* (EPC) header file
5 * Copyright (C) 2017 Texas Instruments
6 * Author: Kishon Vijay Abraham I <kishon@ti.com>
9 #ifndef __LINUX_PCI_EPC_H
10 #define __LINUX_PCI_EPC_H
12 #include <linux/pci-epf.h>
16 enum pci_epc_irq_type {
24 * struct pci_epc_ops - set of function pointers for performing EPC operations
25 * @write_header: ops to populate configuration space header
26 * @set_bar: ops to configure the BAR
27 * @clear_bar: ops to reset the BAR
28 * @map_addr: ops to map CPU address to PCI address
29 * @unmap_addr: ops to unmap CPU address and PCI address
30 * @set_msi: ops to set the requested number of MSI interrupts in the MSI
32 * @get_msi: ops to get the number of MSI interrupts allocated by the RC from
33 * the MSI capability register
34 * @set_msix: ops to set the requested number of MSI-X interrupts in the
35 * MSI-X capability register
36 * @get_msix: ops to get the number of MSI-X interrupts allocated by the RC
37 * from the MSI-X capability register
38 * @raise_irq: ops to raise a legacy, MSI or MSI-X interrupt
39 * @start: ops to start the PCI link
40 * @stop: ops to stop the PCI link
41 * @owner: the module owner containing the ops
44 int (*write_header)(struct pci_epc *epc, u8 func_no,
45 struct pci_epf_header *hdr);
46 int (*set_bar)(struct pci_epc *epc, u8 func_no,
47 struct pci_epf_bar *epf_bar);
48 void (*clear_bar)(struct pci_epc *epc, u8 func_no,
49 struct pci_epf_bar *epf_bar);
50 int (*map_addr)(struct pci_epc *epc, u8 func_no,
51 phys_addr_t addr, u64 pci_addr, size_t size);
52 void (*unmap_addr)(struct pci_epc *epc, u8 func_no,
54 int (*set_msi)(struct pci_epc *epc, u8 func_no, u8 interrupts);
55 int (*get_msi)(struct pci_epc *epc, u8 func_no);
56 int (*set_msix)(struct pci_epc *epc, u8 func_no, u16 interrupts);
57 int (*get_msix)(struct pci_epc *epc, u8 func_no);
58 int (*raise_irq)(struct pci_epc *epc, u8 func_no,
59 enum pci_epc_irq_type type, u16 interrupt_num);
60 int (*start)(struct pci_epc *epc);
61 void (*stop)(struct pci_epc *epc);
62 const struct pci_epc_features* (*get_features)(struct pci_epc *epc,
68 * struct pci_epc_mem - address space of the endpoint controller
69 * @phys_base: physical base address of the PCI address space
70 * @size: the size of the PCI address space
71 * @bitmap: bitmap to manage the PCI address space
72 * @pages: number of bits representing the address region
73 * @page_size: size of each page
74 * @lock: mutex to protect bitmap
77 phys_addr_t phys_base;
79 unsigned long *bitmap;
82 /* mutex to protect against concurrent access for memory allocation*/
87 * struct pci_epc - represents the PCI EPC device
88 * @dev: PCI EPC device
89 * @pci_epf: list of endpoint functions present in this EPC device
90 * @ops: function pointers for performing endpoint operations
91 * @mem: address space of the endpoint controller
92 * @max_functions: max number of functions that can be configured in this EPC
93 * @group: configfs group representing the PCI EPC device
94 * @lock: spinlock to protect pci_epc ops
98 struct list_head pci_epf;
99 const struct pci_epc_ops *ops;
100 struct pci_epc_mem *mem;
102 struct config_group *group;
103 /* spinlock to protect against concurrent access of EP controller */
108 * struct pci_epc_features - features supported by a EPC device per function
109 * @linkup_notifier: indicate if the EPC device can notify EPF driver on link up
110 * @msi_capable: indicate if the endpoint function has MSI capability
111 * @msix_capable: indicate if the endpoint function has MSI-X capability
112 * @reserved_bar: bitmap to indicate reserved BAR unavailable to function driver
113 * @bar_fixed_64bit: bitmap to indicate fixed 64bit BARs
114 * @bar_fixed_size: Array specifying the size supported by each BAR
115 * @align: alignment size required for BAR buffer allocation
117 struct pci_epc_features {
118 unsigned int linkup_notifier : 1;
119 unsigned int msi_capable : 1;
120 unsigned int msix_capable : 1;
123 u64 bar_fixed_size[BAR_5 + 1];
127 #define to_pci_epc(device) container_of((device), struct pci_epc, dev)
129 #define pci_epc_create(dev, ops) \
130 __pci_epc_create((dev), (ops), THIS_MODULE)
131 #define devm_pci_epc_create(dev, ops) \
132 __devm_pci_epc_create((dev), (ops), THIS_MODULE)
134 #define pci_epc_mem_init(epc, phys_addr, size) \
135 __pci_epc_mem_init((epc), (phys_addr), (size), PAGE_SIZE)
137 static inline void epc_set_drvdata(struct pci_epc *epc, void *data)
139 dev_set_drvdata(&epc->dev, data);
142 static inline void *epc_get_drvdata(struct pci_epc *epc)
144 return dev_get_drvdata(&epc->dev);
148 __devm_pci_epc_create(struct device *dev, const struct pci_epc_ops *ops,
149 struct module *owner);
151 __pci_epc_create(struct device *dev, const struct pci_epc_ops *ops,
152 struct module *owner);
153 void devm_pci_epc_destroy(struct device *dev, struct pci_epc *epc);
154 void pci_epc_destroy(struct pci_epc *epc);
155 int pci_epc_add_epf(struct pci_epc *epc, struct pci_epf *epf);
156 void pci_epc_linkup(struct pci_epc *epc);
157 void pci_epc_remove_epf(struct pci_epc *epc, struct pci_epf *epf);
158 int pci_epc_write_header(struct pci_epc *epc, u8 func_no,
159 struct pci_epf_header *hdr);
160 int pci_epc_set_bar(struct pci_epc *epc, u8 func_no,
161 struct pci_epf_bar *epf_bar);
162 void pci_epc_clear_bar(struct pci_epc *epc, u8 func_no,
163 struct pci_epf_bar *epf_bar);
164 int pci_epc_map_addr(struct pci_epc *epc, u8 func_no,
165 phys_addr_t phys_addr,
166 u64 pci_addr, size_t size);
167 void pci_epc_unmap_addr(struct pci_epc *epc, u8 func_no,
168 phys_addr_t phys_addr);
169 int pci_epc_set_msi(struct pci_epc *epc, u8 func_no, u8 interrupts);
170 int pci_epc_get_msi(struct pci_epc *epc, u8 func_no);
171 int pci_epc_set_msix(struct pci_epc *epc, u8 func_no, u16 interrupts);
172 int pci_epc_get_msix(struct pci_epc *epc, u8 func_no);
173 int pci_epc_raise_irq(struct pci_epc *epc, u8 func_no,
174 enum pci_epc_irq_type type, u16 interrupt_num);
175 int pci_epc_start(struct pci_epc *epc);
176 void pci_epc_stop(struct pci_epc *epc);
177 const struct pci_epc_features *pci_epc_get_features(struct pci_epc *epc,
179 unsigned int pci_epc_get_first_free_bar(const struct pci_epc_features
181 struct pci_epc *pci_epc_get(const char *epc_name);
182 void pci_epc_put(struct pci_epc *epc);
184 int __pci_epc_mem_init(struct pci_epc *epc, phys_addr_t phys_addr, size_t size,
186 void pci_epc_mem_exit(struct pci_epc *epc);
187 void __iomem *pci_epc_mem_alloc_addr(struct pci_epc *epc,
188 phys_addr_t *phys_addr, size_t size);
189 void pci_epc_mem_free_addr(struct pci_epc *epc, phys_addr_t phys_addr,
190 void __iomem *virt_addr, size_t size);
191 #endif /* __LINUX_PCI_EPC_H */