[mirror_ubuntu-hirsute-kernel.git] / include / linux / pci-epf.h

/* SPDX-License-Identifier: GPL-2.0 */
/**
 * PCI Endpoint *Function* (EPF) header file
 *
 * Copyright (C) 2017 Texas Instruments
 * Author: Kishon Vijay Abraham I <kishon@ti.com>
 */

#ifndef __LINUX_PCI_EPF_H
#define __LINUX_PCI_EPF_H

#include <linux/device.h>
#include <linux/mod_devicetable.h>
#include <linux/pci.h>

struct pci_epf;

enum pci_barno {
	BAR_0,
	BAR_1,
	BAR_2,
	BAR_3,
	BAR_4,
	BAR_5,
};

/**
 * struct pci_epf_header - represents standard configuration header
 * @vendorid: identifies device manufacturer
 * @deviceid: identifies a particular device
 * @revid: specifies a device-specific revision identifier
 * @progif_code: identifies a specific register-level programming interface
 * @subclass_code: identifies more specifically the function of the device
 * @baseclass_code: broadly classifies the type of function the device performs
 * @cache_line_size: specifies the system cacheline size in units of DWORDs
 * @subsys_vendor_id: vendor of the add-in card or subsystem
 * @subsys_id: id specific to vendor
 * @interrupt_pin: interrupt pin the device (or device function) uses
 */
struct pci_epf_header {
	u16	vendorid;
	u16	deviceid;
	u8	revid;
	u8	progif_code;
	u8	subclass_code;
	u8	baseclass_code;
	u8	cache_line_size;
	u16	subsys_vendor_id;
	u16	subsys_id;
	enum pci_interrupt_pin interrupt_pin;
};

/**
 * struct pci_epf_ops - set of function pointers for performing EPF operations
 * @bind: ops to perform when a EPC device has been bound to EPF device
 * @unbind: ops to perform when a binding has been lost between a EPC device
 *	    and EPF device
 * @linkup: ops to perform when the EPC device has established a connection with
 *	    a host system
 */
struct pci_epf_ops {
	int	(*bind)(struct pci_epf *epf);
	void	(*unbind)(struct pci_epf *epf);
	void	(*linkup)(struct pci_epf *epf);
};

/**
 * struct pci_epf_driver - represents the PCI EPF driver
 * @probe: ops to perform when a new EPF device has been bound to the EPF driver
 * @remove: ops to perform when the binding between the EPF device and EPF
 *	    driver is broken
 * @driver: PCI EPF driver
 * @ops: set of function pointers for performing EPF operations
 * @owner: the owner of the module that registers the PCI EPF driver
 * @epf_group: list of configfs group corresponding to the PCI EPF driver
 * @id_table: identifies EPF devices for probing
 */
struct pci_epf_driver {
	int	(*probe)(struct pci_epf *epf);
	int	(*remove)(struct pci_epf *epf);

	struct device_driver	driver;
	struct pci_epf_ops	*ops;
	struct module		*owner;
	struct list_head	epf_group;
	const struct pci_epf_device_id	*id_table;
};

#define to_pci_epf_driver(drv) (container_of((drv), struct pci_epf_driver, \
				driver))

/**
 * struct pci_epf_bar - represents the BAR of EPF device
 * @phys_addr: physical address that should be mapped to the BAR
 * @size: the size of the address space present in BAR
 */
struct pci_epf_bar {
	dma_addr_t	phys_addr;
	size_t		size;
	enum pci_barno	barno;
	int		flags;
};

/**
 * struct pci_epf - represents the PCI EPF device
 * @dev: the PCI EPF device
 * @name: the name of the PCI EPF device
 * @header: represents standard configuration header
 * @bar: represents the BAR of EPF device
 * @msi_interrupts: number of MSI interrupts required by this function
 * @func_no: unique function number within this endpoint device
 * @epc: the EPC device to which this EPF device is bound
 * @driver: the EPF driver to which this EPF device is bound
 * @list: to add pci_epf as a list of PCI endpoint functions to pci_epc
 */
struct pci_epf {
	struct device		dev;
	const char		*name;
	struct pci_epf_header	*header;
	struct pci_epf_bar	bar[6];
	u8			msi_interrupts;
	u16			msix_interrupts;
	u8			func_no;

	struct pci_epc		*epc;
	struct pci_epf_driver	*driver;
	struct list_head	list;
};

#define to_pci_epf(epf_dev) container_of((epf_dev), struct pci_epf, dev)

#define pci_epf_register_driver(driver)    \
		__pci_epf_register_driver((driver), THIS_MODULE)

static inline void epf_set_drvdata(struct pci_epf *epf, void *data)
{
	dev_set_drvdata(&epf->dev, data);
}

static inline void *epf_get_drvdata(struct pci_epf *epf)
{
	return dev_get_drvdata(&epf->dev);
}

const struct pci_epf_device_id *
pci_epf_match_device(const struct pci_epf_device_id *id, struct pci_epf *epf);
struct pci_epf *pci_epf_create(const char *name);
void pci_epf_destroy(struct pci_epf *epf);
int __pci_epf_register_driver(struct pci_epf_driver *driver,
			      struct module *owner);
void pci_epf_unregister_driver(struct pci_epf_driver *driver);
void *pci_epf_alloc_space(struct pci_epf *epf, size_t size, enum pci_barno bar,
			  size_t align);
void pci_epf_free_space(struct pci_epf *epf, void *addr, enum pci_barno bar);
int pci_epf_bind(struct pci_epf *epf);
void pci_epf_unbind(struct pci_epf *epf);
void pci_epf_linkup(struct pci_epf *epf);
#endif /* __LINUX_PCI_EPF_H */
Commit	Line	Data
8cfab3cf	1	/* SPDX-License-Identifier: GPL-2.0 */
5e8cb403 KVA	2	/**
	3	* PCI Endpoint Function (EPF) 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_EPF_H
	10	#define __LINUX_PCI_EPF_H
	11
	12	#include <linux/device.h>
	13	#include <linux/mod_devicetable.h>
b352baf1	14	#include <linux/pci.h>
5e8cb403 KVA	15
	16	struct pci_epf;
	17
5e8cb403 KVA	18	enum pci_barno {
	19	BAR_0,
	20	BAR_1,
	21	BAR_2,
	22	BAR_3,
	23	BAR_4,
	24	BAR_5,
	25	};
	26
	27	/**
	28	* struct pci_epf_header - represents standard configuration header
	29	* @vendorid: identifies device manufacturer
	30	* @deviceid: identifies a particular device
	31	* @revid: specifies a device-specific revision identifier
	32	* @progif_code: identifies a specific register-level programming interface
	33	* @subclass_code: identifies more specifically the function of the device
	34	* @baseclass_code: broadly classifies the type of function the device performs
	35	* @cache_line_size: specifies the system cacheline size in units of DWORDs
	36	* @subsys_vendor_id: vendor of the add-in card or subsystem
	37	* @subsys_id: id specific to vendor
	38	* @interrupt_pin: interrupt pin the device (or device function) uses
	39	*/
	40	struct pci_epf_header {
	41	u16 vendorid;
	42	u16 deviceid;
	43	u8 revid;
	44	u8 progif_code;
	45	u8 subclass_code;
	46	u8 baseclass_code;
	47	u8 cache_line_size;
	48	u16 subsys_vendor_id;
	49	u16 subsys_id;
	50	enum pci_interrupt_pin interrupt_pin;
	51	};
	52
	53	/**
	54	* struct pci_epf_ops - set of function pointers for performing EPF operations
	55	* @bind: ops to perform when a EPC device has been bound to EPF device
	56	* @unbind: ops to perform when a binding has been lost between a EPC device
	57	* and EPF device
	58	* @linkup: ops to perform when the EPC device has established a connection with
	59	* a host system
	60	*/
	61	struct pci_epf_ops {
	62	int (bind)(struct pci_epf epf);
	63	void (unbind)(struct pci_epf epf);
	64	void (linkup)(struct pci_epf epf);
	65	};
	66
	67	/**
	68	* struct pci_epf_driver - represents the PCI EPF driver
	69	* @probe: ops to perform when a new EPF device has been bound to the EPF driver
	70	* @remove: ops to perform when the binding between the EPF device and EPF
	71	* driver is broken
	72	* @driver: PCI EPF driver
	73	* @ops: set of function pointers for performing EPF operations
	74	* @owner: the owner of the module that registers the PCI EPF driver
ef1433f7	75	* @epf_group: list of configfs group corresponding to the PCI EPF driver
5e8cb403 KVA	76	* @id_table: identifies EPF devices for probing
	77	*/
	78	struct pci_epf_driver {
	79	int (probe)(struct pci_epf epf);
	80	int (remove)(struct pci_epf epf);
	81
	82	struct device_driver driver;
	83	struct pci_epf_ops *ops;
	84	struct module *owner;
ef1433f7	85	struct list_head epf_group;
5e8cb403 KVA	86	const struct pci_epf_device_id *id_table;
	87	};
	88
	89	#define to_pci_epf_driver(drv) (container_of((drv), struct pci_epf_driver, \
	90	driver))
	91
	92	/**
	93	* struct pci_epf_bar - represents the BAR of EPF device
	94	* @phys_addr: physical address that should be mapped to the BAR
	95	* @size: the size of the address space present in BAR
	96	*/
	97	struct pci_epf_bar {
	98	dma_addr_t phys_addr;
	99	size_t size;
bc4a4897 NC	100	enum pci_barno barno;
bc4a4897 NC	101	int flags;
5e8cb403 KVA	102	};
	103
	104	/**
	105	* struct pci_epf - represents the PCI EPF device
	106	* @dev: the PCI EPF device
	107	* @name: the name of the PCI EPF device
	108	* @header: represents standard configuration header
	109	* @bar: represents the BAR of EPF device
	110	* @msi_interrupts: number of MSI interrupts required by this function
	111	* @func_no: unique function number within this endpoint device
	112	* @epc: the EPC device to which this EPF device is bound
	113	* @driver: the EPF driver to which this EPF device is bound
	114	* @list: to add pci_epf as a list of PCI endpoint functions to pci_epc
	115	*/
	116	struct pci_epf {
	117	struct device dev;
	118	const char *name;
	119	struct pci_epf_header *header;
	120	struct pci_epf_bar bar[6];
	121	u8 msi_interrupts;
8963106e	122	u16 msix_interrupts;
5e8cb403 KVA	123	u8 func_no;
	124
	125	struct pci_epc *epc;
	126	struct pci_epf_driver *driver;
	127	struct list_head list;
	128	};
	129
	130	#define to_pci_epf(epf_dev) container_of((epf_dev), struct pci_epf, dev)
	131
	132	#define pci_epf_register_driver(driver) \
	133	__pci_epf_register_driver((driver), THIS_MODULE)
	134
	135	static inline void epf_set_drvdata(struct pci_epf epf, void data)
	136	{
	137	dev_set_drvdata(&epf->dev, data);
	138	}
	139
	140	static inline void epf_get_drvdata(struct pci_epf epf)
	141	{
	142	return dev_get_drvdata(&epf->dev);
	143	}
	144
f01f969e KVA	145	const struct pci_epf_device_id *
f01f969e KVA	146	pci_epf_match_device(const struct pci_epf_device_id id, struct pci_epf epf);
5e8cb403 KVA	147	struct pci_epf pci_epf_create(const char name);
	148	void pci_epf_destroy(struct pci_epf *epf);
	149	int __pci_epf_register_driver(struct pci_epf_driver *driver,
	150	struct module *owner);
	151	void pci_epf_unregister_driver(struct pci_epf_driver *driver);
2a9a8016 KVA	152	void pci_epf_alloc_space(struct pci_epf epf, size_t size, enum pci_barno bar,
2a9a8016 KVA	153	size_t align);
5e8cb403 KVA	154	void pci_epf_free_space(struct pci_epf epf, void addr, enum pci_barno bar);
	155	int pci_epf_bind(struct pci_epf *epf);
	156	void pci_epf_unbind(struct pci_epf *epf);
	157	void pci_epf_linkup(struct pci_epf *epf);
	158	#endif /* __LINUX_PCI_EPF_H */