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 {
23 * struct pci_epc_ops - set of function pointers for performing EPC operations
24 * @write_header: ops to populate configuration space header
25 * @set_bar: ops to configure the BAR
26 * @clear_bar: ops to reset the BAR
27 * @map_addr: ops to map CPU address to PCI address
28 * @unmap_addr: ops to unmap CPU address and PCI address
29 * @set_msi: ops to set the requested number of MSI interrupts in the MSI
31 * @get_msi: ops to get the number of MSI interrupts allocated by the RC from
32 * the MSI capability register
33 * @raise_irq: ops to raise a legacy or MSI interrupt
34 * @start: ops to start the PCI link
35 * @stop: ops to stop the PCI link
36 * @owner: the module owner containing the ops
39 int (*write_header)(struct pci_epc *epc, u8 func_no,
40 struct pci_epf_header *hdr);
41 int (*set_bar)(struct pci_epc *epc, u8 func_no,
42 struct pci_epf_bar *epf_bar);
43 void (*clear_bar)(struct pci_epc *epc, u8 func_no,
44 struct pci_epf_bar *epf_bar);
45 int (*map_addr)(struct pci_epc *epc, u8 func_no,
46 phys_addr_t addr, u64 pci_addr, size_t size);
47 void (*unmap_addr)(struct pci_epc *epc, u8 func_no,
49 int (*set_msi)(struct pci_epc *epc, u8 func_no, u8 interrupts);
50 int (*get_msi)(struct pci_epc *epc, u8 func_no);
51 int (*raise_irq)(struct pci_epc *epc, u8 func_no,
52 enum pci_epc_irq_type type, u8 interrupt_num);
53 int (*start)(struct pci_epc *epc);
54 void (*stop)(struct pci_epc *epc);
59 * struct pci_epc_mem - address space of the endpoint controller
60 * @phys_base: physical base address of the PCI address space
61 * @size: the size of the PCI address space
62 * @bitmap: bitmap to manage the PCI address space
63 * @pages: number of bits representing the address region
64 * @page_size: size of each page
67 phys_addr_t phys_base;
69 unsigned long *bitmap;
75 * struct pci_epc - represents the PCI EPC device
76 * @dev: PCI EPC device
77 * @pci_epf: list of endpoint functions present in this EPC device
78 * @ops: function pointers for performing endpoint operations
79 * @mem: address space of the endpoint controller
80 * @max_functions: max number of functions that can be configured in this EPC
81 * @group: configfs group representing the PCI EPC device
82 * @lock: spinlock to protect pci_epc ops
86 struct list_head pci_epf;
87 const struct pci_epc_ops *ops;
88 struct pci_epc_mem *mem;
90 struct config_group *group;
91 /* spinlock to protect against concurrent access of EP controller */
95 #define to_pci_epc(device) container_of((device), struct pci_epc, dev)
97 #define pci_epc_create(dev, ops) \
98 __pci_epc_create((dev), (ops), THIS_MODULE)
99 #define devm_pci_epc_create(dev, ops) \
100 __devm_pci_epc_create((dev), (ops), THIS_MODULE)
102 #define pci_epc_mem_init(epc, phys_addr, size) \
103 __pci_epc_mem_init((epc), (phys_addr), (size), PAGE_SIZE)
105 static inline void epc_set_drvdata(struct pci_epc *epc, void *data)
107 dev_set_drvdata(&epc->dev, data);
110 static inline void *epc_get_drvdata(struct pci_epc *epc)
112 return dev_get_drvdata(&epc->dev);
116 __devm_pci_epc_create(struct device *dev, const struct pci_epc_ops *ops,
117 struct module *owner);
119 __pci_epc_create(struct device *dev, const struct pci_epc_ops *ops,
120 struct module *owner);
121 void devm_pci_epc_destroy(struct device *dev, struct pci_epc *epc);
122 void pci_epc_destroy(struct pci_epc *epc);
123 int pci_epc_add_epf(struct pci_epc *epc, struct pci_epf *epf);
124 void pci_epc_linkup(struct pci_epc *epc);
125 void pci_epc_remove_epf(struct pci_epc *epc, struct pci_epf *epf);
126 int pci_epc_write_header(struct pci_epc *epc, u8 func_no,
127 struct pci_epf_header *hdr);
128 int pci_epc_set_bar(struct pci_epc *epc, u8 func_no,
129 struct pci_epf_bar *epf_bar);
130 void pci_epc_clear_bar(struct pci_epc *epc, u8 func_no,
131 struct pci_epf_bar *epf_bar);
132 int pci_epc_map_addr(struct pci_epc *epc, u8 func_no,
133 phys_addr_t phys_addr,
134 u64 pci_addr, size_t size);
135 void pci_epc_unmap_addr(struct pci_epc *epc, u8 func_no,
136 phys_addr_t phys_addr);
137 int pci_epc_set_msi(struct pci_epc *epc, u8 func_no, u8 interrupts);
138 int pci_epc_get_msi(struct pci_epc *epc, u8 func_no);
139 int pci_epc_raise_irq(struct pci_epc *epc, u8 func_no,
140 enum pci_epc_irq_type type, u8 interrupt_num);
141 int pci_epc_start(struct pci_epc *epc);
142 void pci_epc_stop(struct pci_epc *epc);
143 struct pci_epc *pci_epc_get(const char *epc_name);
144 void pci_epc_put(struct pci_epc *epc);
146 int __pci_epc_mem_init(struct pci_epc *epc, phys_addr_t phys_addr, size_t size,
148 void pci_epc_mem_exit(struct pci_epc *epc);
149 void __iomem *pci_epc_mem_alloc_addr(struct pci_epc *epc,
150 phys_addr_t *phys_addr, size_t size);
151 void pci_epc_mem_free_addr(struct pci_epc *epc, phys_addr_t phys_addr,
152 void __iomem *virt_addr, size_t size);
153 #endif /* __LINUX_PCI_EPC_H */