Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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/pci.h>
16
17struct pci_epf;
18enum pci_epc_interface_type;
19
20enum pci_notify_event {
21 CORE_INIT,
22 LINK_UP,
23};
24
25enum pci_barno {
26 NO_BAR = -1,
27 BAR_0,
28 BAR_1,
29 BAR_2,
30 BAR_3,
31 BAR_4,
32 BAR_5,
33};
34
35/**
36 * struct pci_epf_header - represents standard configuration header
37 * @vendorid: identifies device manufacturer
38 * @deviceid: identifies a particular device
39 * @revid: specifies a device-specific revision identifier
40 * @progif_code: identifies a specific register-level programming interface
41 * @subclass_code: identifies more specifically the function of the device
42 * @baseclass_code: broadly classifies the type of function the device performs
43 * @cache_line_size: specifies the system cacheline size in units of DWORDs
44 * @subsys_vendor_id: vendor of the add-in card or subsystem
45 * @subsys_id: id specific to vendor
46 * @interrupt_pin: interrupt pin the device (or device function) uses
47 */
48struct pci_epf_header {
49 u16 vendorid;
50 u16 deviceid;
51 u8 revid;
52 u8 progif_code;
53 u8 subclass_code;
54 u8 baseclass_code;
55 u8 cache_line_size;
56 u16 subsys_vendor_id;
57 u16 subsys_id;
58 enum pci_interrupt_pin interrupt_pin;
59};
60
61/**
62 * struct pci_epf_ops - set of function pointers for performing EPF operations
63 * @bind: ops to perform when a EPC device has been bound to EPF device
64 * @unbind: ops to perform when a binding has been lost between a EPC device
65 * and EPF device
66 * @add_cfs: ops to initialize function specific configfs attributes
67 */
68struct pci_epf_ops {
69 int (*bind)(struct pci_epf *epf);
70 void (*unbind)(struct pci_epf *epf);
71 struct config_group *(*add_cfs)(struct pci_epf *epf,
72 struct config_group *group);
73};
74
75/**
76 * struct pci_epf_driver - represents the PCI EPF driver
77 * @probe: ops to perform when a new EPF device has been bound to the EPF driver
78 * @remove: ops to perform when the binding between the EPF device and EPF
79 * driver is broken
80 * @driver: PCI EPF driver
81 * @ops: set of function pointers for performing EPF operations
82 * @owner: the owner of the module that registers the PCI EPF driver
83 * @epf_group: list of configfs group corresponding to the PCI EPF driver
84 * @id_table: identifies EPF devices for probing
85 */
86struct pci_epf_driver {
87 int (*probe)(struct pci_epf *epf);
88 int (*remove)(struct pci_epf *epf);
89
90 struct device_driver driver;
91 struct pci_epf_ops *ops;
92 struct module *owner;
93 struct list_head epf_group;
94 const struct pci_epf_device_id *id_table;
95};
96
97#define to_pci_epf_driver(drv) (container_of((drv), struct pci_epf_driver, \
98 driver))
99
100/**
101 * struct pci_epf_bar - represents the BAR of EPF device
102 * @phys_addr: physical address that should be mapped to the BAR
103 * @addr: virtual address corresponding to the @phys_addr
104 * @size: the size of the address space present in BAR
105 */
106struct pci_epf_bar {
107 dma_addr_t phys_addr;
108 void *addr;
109 size_t size;
110 enum pci_barno barno;
111 int flags;
112};
113
114/**
115 * struct pci_epf - represents the PCI EPF device
116 * @dev: the PCI EPF device
117 * @name: the name of the PCI EPF device
118 * @header: represents standard configuration header
119 * @bar: represents the BAR of EPF device
120 * @msi_interrupts: number of MSI interrupts required by this function
121 * @func_no: unique function number within this endpoint device
122 * @epc: the EPC device to which this EPF device is bound
123 * @driver: the EPF driver to which this EPF device is bound
124 * @list: to add pci_epf as a list of PCI endpoint functions to pci_epc
125 * @nb: notifier block to notify EPF of any EPC events (like linkup)
126 * @lock: mutex to protect pci_epf_ops
127 * @sec_epc: the secondary EPC device to which this EPF device is bound
128 * @sec_epc_list: to add pci_epf as list of PCI endpoint functions to secondary
129 * EPC device
130 * @sec_epc_bar: represents the BAR of EPF device associated with secondary EPC
131 * @sec_epc_func_no: unique (physical) function number within the secondary EPC
132 * @group: configfs group associated with the EPF device
133 */
134struct pci_epf {
135 struct device dev;
136 const char *name;
137 struct pci_epf_header *header;
138 struct pci_epf_bar bar[6];
139 u8 msi_interrupts;
140 u16 msix_interrupts;
141 u8 func_no;
142
143 struct pci_epc *epc;
144 struct pci_epf_driver *driver;
145 struct list_head list;
146 struct notifier_block nb;
147 /* mutex to protect against concurrent access of pci_epf_ops */
148 struct mutex lock;
149
150 /* Below members are to attach secondary EPC to an endpoint function */
151 struct pci_epc *sec_epc;
152 struct list_head sec_epc_list;
153 struct pci_epf_bar sec_epc_bar[6];
154 u8 sec_epc_func_no;
155 struct config_group *group;
156};
157
158/**
159 * struct pci_epf_msix_tbl - represents the MSIX table entry structure
160 * @msg_addr: Writes to this address will trigger MSIX interrupt in host
161 * @msg_data: Data that should be written to @msg_addr to trigger MSIX interrupt
162 * @vector_ctrl: Identifies if the function is prohibited from sending a message
163 * using this MSIX table entry
164 */
165struct pci_epf_msix_tbl {
166 u64 msg_addr;
167 u32 msg_data;
168 u32 vector_ctrl;
169};
170
171#define to_pci_epf(epf_dev) container_of((epf_dev), struct pci_epf, dev)
172
173#define pci_epf_register_driver(driver) \
174 __pci_epf_register_driver((driver), THIS_MODULE)
175
176static inline void epf_set_drvdata(struct pci_epf *epf, void *data)
177{
178 dev_set_drvdata(&epf->dev, data);
179}
180
181static inline void *epf_get_drvdata(struct pci_epf *epf)
182{
183 return dev_get_drvdata(&epf->dev);
184}
185
186struct pci_epf *pci_epf_create(const char *name);
187void pci_epf_destroy(struct pci_epf *epf);
188int __pci_epf_register_driver(struct pci_epf_driver *driver,
189 struct module *owner);
190void pci_epf_unregister_driver(struct pci_epf_driver *driver);
191void *pci_epf_alloc_space(struct pci_epf *epf, size_t size, enum pci_barno bar,
192 size_t align, enum pci_epc_interface_type type);
193void pci_epf_free_space(struct pci_epf *epf, void *addr, enum pci_barno bar,
194 enum pci_epc_interface_type type);
195int pci_epf_bind(struct pci_epf *epf);
196void pci_epf_unbind(struct pci_epf *epf);
197struct config_group *pci_epf_type_add_cfs(struct pci_epf *epf,
198 struct config_group *group);
199#endif /* __LINUX_PCI_EPF_H */