linux-stable-mirror/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/configfs.h>
#include <linux/device.h>
#include <linux/device-id/pci.h>
#include <linux/msi.h>
#include <linux/pci.h>

struct pci_epf;
struct pci_epc_features;
enum pci_epc_interface_type;

enum pci_barno {
	NO_BAR = -1,
	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
 * @add_cfs: ops to initialize function-specific configfs attributes
 */
struct pci_epf_ops {
	int	(*bind)(struct pci_epf *epf);
	void	(*unbind)(struct pci_epf *epf);
	struct config_group *(*add_cfs)(struct pci_epf *epf,
					struct config_group *group);
};

/**
 * struct pci_epc_event_ops - Callbacks for capturing the EPC events
 * @epc_init: Callback for the EPC initialization complete event
 * @epc_deinit: Callback for the EPC deinitialization event
 * @link_up: Callback for the EPC link up event
 * @link_down: Callback for the EPC link down event
 * @bus_master_enable: Callback for the EPC Bus Master Enable event
 */
struct pci_epc_event_ops {
	int (*epc_init)(struct pci_epf *epf);
	void (*epc_deinit)(struct pci_epf *epf);
	int (*link_up)(struct pci_epf *epf);
	int (*link_down)(struct pci_epf *epf);
	int (*bus_master_enable)(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,
			 const struct pci_epf_device_id *id);
	void	(*remove)(struct pci_epf *epf);

	struct device_driver	driver;
	const 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_const((drv), struct pci_epf_driver, driver)

/**
 * struct pci_epf_bar_submap - BAR subrange for inbound mapping
 * @phys_addr: target physical/DMA address for this subrange
 * @size: the size of the subrange to be mapped
 *
 * When pci_epf_bar.num_submap is >0, pci_epf_bar.submap describes the
 * complete BAR layout. This allows an EPC driver to program multiple
 * inbound translation windows for a single BAR when supported by the
 * controller. The array order defines the BAR layout (submap[0] at offset
 * 0, and each immediately follows the previous one).
 */
struct pci_epf_bar_submap {
	dma_addr_t	phys_addr;
	size_t		size;
};

/**
 * struct pci_epf_bar - represents the BAR of EPF device
 * @phys_addr: physical address that should be mapped to the BAR
 * @addr: virtual address corresponding to the @phys_addr
 * @size: the size of the address space present in BAR
 * @mem_size: the size actually allocated to accommodate the iATU alignment
 *            requirement
 * @barno: BAR number
 * @flags: flags that are set for the BAR
 * @num_submap: number of entries in @submap
 * @submap: array of subrange descriptors allocated by the caller. See
 *          struct pci_epf_bar_submap for the semantics in detail.
 */
struct pci_epf_bar {
	dma_addr_t	phys_addr;
	void		*addr;
	size_t		size;
	size_t		mem_size;
	enum pci_barno	barno;
	int		flags;

	/* Optional sub-range mapping */
	unsigned int	num_submap;
	struct pci_epf_bar_submap	*submap;
};

enum pci_epf_doorbell_type {
	PCI_EPF_DOORBELL_MSI = 0,
	PCI_EPF_DOORBELL_EMBEDDED,
};

/**
 * struct pci_epf_doorbell_msg - represents doorbell message
 * @msg: Doorbell address/data pair to be mapped into BAR space.
 *       For MSI-backed doorbells this is the MSI message, while for
 *       "embedded" doorbells this represents an MMIO write that asserts
 *       an interrupt on the EP side.
 * @virq: IRQ number of this doorbell message
 * @irq_flags: Required flags for request_irq()/request_threaded_irq().
 *             Callers may OR-in additional flags (e.g. IRQF_ONESHOT).
 * @type: Doorbell type.
 * @bar: BAR number where the doorbell target is already exposed to the RC
 *       (NO_BAR if not)
 * @offset: offset within @bar for the doorbell target (valid iff
 *          @bar != NO_BAR)
 * @iova_base: Internal: base DMA address returned by dma_map_resource() for the
 *             embedded doorbell MMIO window (used only for unmapping). Valid
 *             when @type is PCI_EPF_DOORBELL_EMBEDDED and @iova_size is
 *             non-zero.
 * @iova_size: Internal: size of the dma_map_resource() mapping at @iova_base.
 *             Zero when no mapping was created (e.g. pre-exposed fixed BAR).
 */
struct pci_epf_doorbell_msg {
	struct msi_msg msg;
	int virq;
	unsigned long irq_flags;
	enum pci_epf_doorbell_type type;
	enum pci_barno bar;
	resource_size_t offset;
	dma_addr_t iova_base;
	size_t iova_size;
};

/**
 * 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
 * @msix_interrupts: number of MSI-X interrupts required by this function
 * @func_no: unique (physical) function number within this endpoint device
 * @vfunc_no: unique virtual function number within a physical function
 * @epc: the EPC device to which this EPF device is bound
 * @epf_pf: the physical EPF device to which this virtual EPF device is bound
 * @driver: the EPF driver to which this EPF device is bound
 * @id: pointer to the EPF device ID
 * @list: to add pci_epf as a list of PCI endpoint functions to pci_epc
 * @lock: mutex to protect pci_epf_ops
 * @sec_epc: the secondary EPC device to which this EPF device is bound
 * @sec_epc_list: to add pci_epf as list of PCI endpoint functions to secondary
 *   EPC device
 * @sec_epc_bar: represents the BAR of EPF device associated with secondary EPC
 * @sec_epc_func_no: unique (physical) function number within the secondary EPC
 * @group: configfs group associated with the EPF device
 * @is_bound: indicates if bind notification to function driver has been invoked
 * @is_vf: true - virtual function, false - physical function
 * @vfunction_num_map: bitmap to manage virtual function number
 * @pci_vepf: list of virtual endpoint functions associated with this function
 * @event_ops: callbacks for capturing the EPC events
 * @db_msg: data for MSI from RC side
 * @num_db: number of doorbells
 */
struct pci_epf {
	struct device		dev;
	const char		*name;
	struct pci_epf_header	*header;
	struct pci_epf_bar	bar[PCI_STD_NUM_BARS];
	u8			msi_interrupts;
	u16			msix_interrupts;
	u8			func_no;
	u8			vfunc_no;

	struct pci_epc		*epc;
	struct pci_epf		*epf_pf;
	struct pci_epf_driver	*driver;
	const struct pci_epf_device_id *id;
	struct list_head	list;
	/* mutex to protect against concurrent access of pci_epf_ops */
	struct mutex		lock;

	/* Below members are to attach secondary EPC to an endpoint function */
	struct pci_epc		*sec_epc;
	struct list_head	sec_epc_list;
	struct pci_epf_bar	sec_epc_bar[PCI_STD_NUM_BARS];
	u8			sec_epc_func_no;
	struct config_group	*group;
	unsigned int		is_bound;
	unsigned int		is_vf;
	unsigned long		vfunction_num_map;
	struct list_head	pci_vepf;
	const struct pci_epc_event_ops *event_ops;
	struct pci_epf_doorbell_msg *db_msg;
	u16 num_db;
};

/**
 * struct pci_epf_msix_tbl - represents the MSI-X table entry structure
 * @msg_addr: Writes to this address will trigger MSI-X interrupt in host
 * @msg_data: Data that should be written to @msg_addr to trigger MSI-X
 *   interrupt
 * @vector_ctrl: Identifies if the function is prohibited from sending a message
 *   using this MSI-X table entry
 */
struct pci_epf_msix_tbl {
	u64 msg_addr;
	u32 msg_data;
	u32 vector_ctrl;
};

#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);
}

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,
			  const struct pci_epc_features *epc_features,
			  enum pci_epc_interface_type type);
void pci_epf_free_space(struct pci_epf *epf, void *addr, enum pci_barno bar,
			enum pci_epc_interface_type type);

int pci_epf_assign_bar_space(struct pci_epf *epf, size_t size,
			     enum pci_barno bar,
			     const struct pci_epc_features *epc_features,
			     enum pci_epc_interface_type type,
			     dma_addr_t bar_addr);

int pci_epf_align_inbound_addr(struct pci_epf *epf, enum pci_barno bar,
			       u64 addr, dma_addr_t *base, size_t *off);
int pci_epf_bind(struct pci_epf *epf);
void pci_epf_unbind(struct pci_epf *epf);
int pci_epf_add_vepf(struct pci_epf *epf_pf, struct pci_epf *epf_vf);
void pci_epf_remove_vepf(struct pci_epf *epf_pf, struct pci_epf *epf_vf);
#endif /* __LINUX_PCI_EPF_H */