1/* SPDX-License-Identifier: GPL-2.0 */
2/*
3 * PCI Endpoint *Function* (EPF) header file
4 *
5 * Copyright (C) 2017 Texas Instruments
6 * Author: Kishon Vijay Abraham I <kishon@ti.com>
7 */
8
9#ifndef __LINUX_PCI_EPF_H
10#define __LINUX_PCI_EPF_H
11
12#include <linux/configfs.h>
13#include <linux/device.h>
14#include <linux/mod_devicetable.h>
15#include <linux/msi.h>
16#include <linux/pci.h>
17
18struct pci_epf;
19struct pci_epc_features;
20enum pci_epc_interface_type;
21
22enum pci_barno {
23 NO_BAR = -1,
24 BAR_0,
25 BAR_1,
26 BAR_2,
27 BAR_3,
28 BAR_4,
29 BAR_5,
30};
31
32/**
33 * struct pci_epf_header - represents standard configuration header
34 * @vendorid: identifies device manufacturer
35 * @deviceid: identifies a particular device
36 * @revid: specifies a device-specific revision identifier
37 * @progif_code: identifies a specific register-level programming interface
38 * @subclass_code: identifies more specifically the function of the device
39 * @baseclass_code: broadly classifies the type of function the device performs
40 * @cache_line_size: specifies the system cacheline size in units of DWORDs
41 * @subsys_vendor_id: vendor of the add-in card or subsystem
42 * @subsys_id: ID specific to vendor
43 * @interrupt_pin: interrupt pin the device (or device function) uses
44 */
45struct pci_epf_header {
46 u16 vendorid;
47 u16 deviceid;
48 u8 revid;
49 u8 progif_code;
50 u8 subclass_code;
51 u8 baseclass_code;
52 u8 cache_line_size;
53 u16 subsys_vendor_id;
54 u16 subsys_id;
55 enum pci_interrupt_pin interrupt_pin;
56};
57
58/**
59 * struct pci_epf_ops - set of function pointers for performing EPF operations
60 * @bind: ops to perform when a EPC device has been bound to EPF device
61 * @unbind: ops to perform when a binding has been lost between a EPC device
62 * and EPF device
63 * @add_cfs: ops to initialize function-specific configfs attributes
64 */
65struct pci_epf_ops {
66 int (*bind)(struct pci_epf *epf);
67 void (*unbind)(struct pci_epf *epf);
68 struct config_group *(*add_cfs)(struct pci_epf *epf,
69 struct config_group *group);
70};
71
72/**
73 * struct pci_epc_event_ops - Callbacks for capturing the EPC events
74 * @epc_init: Callback for the EPC initialization complete event
75 * @epc_deinit: Callback for the EPC deinitialization event
76 * @link_up: Callback for the EPC link up event
77 * @link_down: Callback for the EPC link down event
78 * @bus_master_enable: Callback for the EPC Bus Master Enable event
79 */
80struct pci_epc_event_ops {
81 int (*epc_init)(struct pci_epf *epf);
82 void (*epc_deinit)(struct pci_epf *epf);
83 int (*link_up)(struct pci_epf *epf);
84 int (*link_down)(struct pci_epf *epf);
85 int (*bus_master_enable)(struct pci_epf *epf);
86};
87
88/**
89 * struct pci_epf_driver - represents the PCI EPF driver
90 * @probe: ops to perform when a new EPF device has been bound to the EPF driver
91 * @remove: ops to perform when the binding between the EPF device and EPF
92 * driver is broken
93 * @driver: PCI EPF driver
94 * @ops: set of function pointers for performing EPF operations
95 * @owner: the owner of the module that registers the PCI EPF driver
96 * @epf_group: list of configfs group corresponding to the PCI EPF driver
97 * @id_table: identifies EPF devices for probing
98 */
99struct pci_epf_driver {
100 int (*probe)(struct pci_epf *epf,
101 const struct pci_epf_device_id *id);
102 void (*remove)(struct pci_epf *epf);
103
104 struct device_driver driver;
105 const struct pci_epf_ops *ops;
106 struct module *owner;
107 struct list_head epf_group;
108 const struct pci_epf_device_id *id_table;
109};
110
111#define to_pci_epf_driver(drv) container_of_const((drv), struct pci_epf_driver, driver)
112
113/**
114 * struct pci_epf_bar - represents the BAR of EPF device
115 * @phys_addr: physical address that should be mapped to the BAR
116 * @addr: virtual address corresponding to the @phys_addr
117 * @size: the size of the address space present in BAR
118 * @mem_size: the size actually allocated to accommodate the iATU alignment
119 * requirement
120 * @barno: BAR number
121 * @flags: flags that are set for the BAR
122 */
123struct pci_epf_bar {
124 dma_addr_t phys_addr;
125 void *addr;
126 size_t size;
127 size_t mem_size;
128 enum pci_barno barno;
129 int flags;
130};
131
132/**
133 * struct pci_epf_doorbell_msg - represents doorbell message
134 * @msg: MSI message
135 * @virq: IRQ number of this doorbell MSI message
136 */
137struct pci_epf_doorbell_msg {
138 struct msi_msg msg;
139 int virq;
140};
141
142/**
143 * struct pci_epf - represents the PCI EPF device
144 * @dev: the PCI EPF device
145 * @name: the name of the PCI EPF device
146 * @header: represents standard configuration header
147 * @bar: represents the BAR of EPF device
148 * @msi_interrupts: number of MSI interrupts required by this function
149 * @msix_interrupts: number of MSI-X interrupts required by this function
150 * @func_no: unique (physical) function number within this endpoint device
151 * @vfunc_no: unique virtual function number within a physical function
152 * @epc: the EPC device to which this EPF device is bound
153 * @epf_pf: the physical EPF device to which this virtual EPF device is bound
154 * @driver: the EPF driver to which this EPF device is bound
155 * @id: pointer to the EPF device ID
156 * @list: to add pci_epf as a list of PCI endpoint functions to pci_epc
157 * @lock: mutex to protect pci_epf_ops
158 * @sec_epc: the secondary EPC device to which this EPF device is bound
159 * @sec_epc_list: to add pci_epf as list of PCI endpoint functions to secondary
160 * EPC device
161 * @sec_epc_bar: represents the BAR of EPF device associated with secondary EPC
162 * @sec_epc_func_no: unique (physical) function number within the secondary EPC
163 * @group: configfs group associated with the EPF device
164 * @is_bound: indicates if bind notification to function driver has been invoked
165 * @is_vf: true - virtual function, false - physical function
166 * @vfunction_num_map: bitmap to manage virtual function number
167 * @pci_vepf: list of virtual endpoint functions associated with this function
168 * @event_ops: callbacks for capturing the EPC events
169 * @db_msg: data for MSI from RC side
170 * @num_db: number of doorbells
171 */
172struct pci_epf {
173 struct device dev;
174 const char *name;
175 struct pci_epf_header *header;
176 struct pci_epf_bar bar[PCI_STD_NUM_BARS];
177 u8 msi_interrupts;
178 u16 msix_interrupts;
179 u8 func_no;
180 u8 vfunc_no;
181
182 struct pci_epc *epc;
183 struct pci_epf *epf_pf;
184 struct pci_epf_driver *driver;
185 const struct pci_epf_device_id *id;
186 struct list_head list;
187 /* mutex to protect against concurrent access of pci_epf_ops */
188 struct mutex lock;
189
190 /* Below members are to attach secondary EPC to an endpoint function */
191 struct pci_epc *sec_epc;
192 struct list_head sec_epc_list;
193 struct pci_epf_bar sec_epc_bar[PCI_STD_NUM_BARS];
194 u8 sec_epc_func_no;
195 struct config_group *group;
196 unsigned int is_bound;
197 unsigned int is_vf;
198 unsigned long vfunction_num_map;
199 struct list_head pci_vepf;
200 const struct pci_epc_event_ops *event_ops;
201 struct pci_epf_doorbell_msg *db_msg;
202 u16 num_db;
203};
204
205/**
206 * struct pci_epf_msix_tbl - represents the MSI-X table entry structure
207 * @msg_addr: Writes to this address will trigger MSI-X interrupt in host
208 * @msg_data: Data that should be written to @msg_addr to trigger MSI-X
209 * interrupt
210 * @vector_ctrl: Identifies if the function is prohibited from sending a message
211 * using this MSI-X table entry
212 */
213struct pci_epf_msix_tbl {
214 u64 msg_addr;
215 u32 msg_data;
216 u32 vector_ctrl;
217};
218
219#define to_pci_epf(epf_dev) container_of((epf_dev), struct pci_epf, dev)
220
221#define pci_epf_register_driver(driver) \
222 __pci_epf_register_driver((driver), THIS_MODULE)
223
224static inline void epf_set_drvdata(struct pci_epf *epf, void *data)
225{
226 dev_set_drvdata(dev: &epf->dev, data);
227}
228
229static inline void *epf_get_drvdata(struct pci_epf *epf)
230{
231 return dev_get_drvdata(dev: &epf->dev);
232}
233
234struct pci_epf *pci_epf_create(const char *name);
235void pci_epf_destroy(struct pci_epf *epf);
236int __pci_epf_register_driver(struct pci_epf_driver *driver,
237 struct module *owner);
238void pci_epf_unregister_driver(struct pci_epf_driver *driver);
239void *pci_epf_alloc_space(struct pci_epf *epf, size_t size, enum pci_barno bar,
240 const struct pci_epc_features *epc_features,
241 enum pci_epc_interface_type type);
242void pci_epf_free_space(struct pci_epf *epf, void *addr, enum pci_barno bar,
243 enum pci_epc_interface_type type);
244
245int pci_epf_assign_bar_space(struct pci_epf *epf, size_t size,
246 enum pci_barno bar,
247 const struct pci_epc_features *epc_features,
248 enum pci_epc_interface_type type,
249 dma_addr_t bar_addr);
250
251int pci_epf_align_inbound_addr(struct pci_epf *epf, enum pci_barno bar,
252 u64 addr, dma_addr_t *base, size_t *off);
253int pci_epf_bind(struct pci_epf *epf);
254void pci_epf_unbind(struct pci_epf *epf);
255int pci_epf_add_vepf(struct pci_epf *epf_pf, struct pci_epf *epf_vf);
256void pci_epf_remove_vepf(struct pci_epf *epf_pf, struct pci_epf *epf_vf);
257#endif /* __LINUX_PCI_EPF_H */
258

source code of linux/include/linux/pci-epf.h