[mirror_ubuntu-bionic-kernel.git] / include / linux / pcieport_if.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * File:	pcieport_if.h
 * Purpose:	PCI Express Port Bus Driver's IF Data Structure
 *
 * Copyright (C) 2004 Intel
 * Copyright (C) Tom Long Nguyen (tom.l.nguyen@intel.com)
 */

#ifndef _PCIEPORT_IF_H_
#define _PCIEPORT_IF_H_

/* Port Type */
#define PCIE_ANY_PORT			(~0)

/* Service Type */
#define PCIE_PORT_SERVICE_PME_SHIFT	0	/* Power Management Event */
#define PCIE_PORT_SERVICE_PME		(1 << PCIE_PORT_SERVICE_PME_SHIFT)
#define PCIE_PORT_SERVICE_AER_SHIFT	1	/* Advanced Error Reporting */
#define PCIE_PORT_SERVICE_AER		(1 << PCIE_PORT_SERVICE_AER_SHIFT)
#define PCIE_PORT_SERVICE_HP_SHIFT	2	/* Native Hotplug */
#define PCIE_PORT_SERVICE_HP		(1 << PCIE_PORT_SERVICE_HP_SHIFT)
#define PCIE_PORT_SERVICE_VC_SHIFT	3	/* Virtual Channel */
#define PCIE_PORT_SERVICE_VC		(1 << PCIE_PORT_SERVICE_VC_SHIFT)
#define PCIE_PORT_SERVICE_DPC_SHIFT	4	/* Downstream Port Containment */
#define PCIE_PORT_SERVICE_DPC		(1 << PCIE_PORT_SERVICE_DPC_SHIFT)

struct pcie_device {
	int		irq;	    /* Service IRQ/MSI/MSI-X Vector */
	struct pci_dev *port;	    /* Root/Upstream/Downstream Port */
	u32		service;    /* Port service this device represents */
	void		*priv_data; /* Service Private Data */
	struct device	device;     /* Generic Device Interface */
};
#define to_pcie_device(d) container_of(d, struct pcie_device, device)

static inline void set_service_data(struct pcie_device *dev, void *data)
{
	dev->priv_data = data;
}

static inline void *get_service_data(struct pcie_device *dev)
{
	return dev->priv_data;
}

struct pcie_port_service_driver {
	const char *name;
	int (*probe) (struct pcie_device *dev);
	void (*remove) (struct pcie_device *dev);
	int (*suspend) (struct pcie_device *dev);
	int (*resume) (struct pcie_device *dev);

	/* Device driver may resume normal operations */
	void (*error_resume)(struct pci_dev *dev);

	/* Link Reset Capability - AER service driver specific */
	pci_ers_result_t (*reset_link) (struct pci_dev *dev);

	int port_type;  /* Type of the port this driver can handle */
	u32 service;    /* Port service this device represents */

	struct device_driver driver;
};
#define to_service_driver(d) \
	container_of(d, struct pcie_port_service_driver, driver)

int pcie_port_service_register(struct pcie_port_service_driver *new);
void pcie_port_service_unregister(struct pcie_port_service_driver *new);

#endif /* _PCIEPORT_IF_H_ */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
1da177e4 LT	2	/*
	3	* File: pcieport_if.h
	4	* Purpose: PCI Express Port Bus Driver's IF Data Structure
	5	*
	6	* Copyright (C) 2004 Intel
	7	* Copyright (C) Tom Long Nguyen (tom.l.nguyen@intel.com)
	8	*/
	9
	10	#ifndef _PCIEPORT_IF_H_
	11	#define _PCIEPORT_IF_H_
	12
	13	/* Port Type */
694f88ef	14	#define PCIE_ANY_PORT (~0)
1da177e4 LT	15
1da177e4 LT	16	/* Service Type */
b43d4513 RW	17	#define PCIE_PORT_SERVICE_PME_SHIFT 0 /* Power Management Event */
	18	#define PCIE_PORT_SERVICE_PME (1 << PCIE_PORT_SERVICE_PME_SHIFT)
	19	#define PCIE_PORT_SERVICE_AER_SHIFT 1 /* Advanced Error Reporting */
	20	#define PCIE_PORT_SERVICE_AER (1 << PCIE_PORT_SERVICE_AER_SHIFT)
	21	#define PCIE_PORT_SERVICE_HP_SHIFT 2 /* Native Hotplug */
	22	#define PCIE_PORT_SERVICE_HP (1 << PCIE_PORT_SERVICE_HP_SHIFT)
	23	#define PCIE_PORT_SERVICE_VC_SHIFT 3 /* Virtual Channel */
	24	#define PCIE_PORT_SERVICE_VC (1 << PCIE_PORT_SERVICE_VC_SHIFT)
10126ac1 KB	25	#define PCIE_PORT_SERVICE_DPC_SHIFT 4 /* Downstream Port Containment */
10126ac1 KB	26	#define PCIE_PORT_SERVICE_DPC (1 << PCIE_PORT_SERVICE_DPC_SHIFT)
1da177e4	27
1da177e4	28	struct pcie_device {
f7625980	29	int irq; /* Service IRQ/MSI/MSI-X Vector */
22106368 RW	30	struct pci_dev port; / Root/Upstream/Downstream Port */
22106368 RW	31	u32 service; /* Port service this device represents */
1da177e4 LT	32	void priv_data; / Service Private Data */
	33	struct device device; /* Generic Device Interface */
	34	};
	35	#define to_pcie_device(d) container_of(d, struct pcie_device, device)
	36
	37	static inline void set_service_data(struct pcie_device dev, void data)
	38	{
	39	dev->priv_data = data;
	40	}
	41
96291d56	42	static inline void get_service_data(struct pcie_device dev)
1da177e4 LT	43	{
	44	return dev->priv_data;
	45	}
	46
	47	struct pcie_port_service_driver {
	48	const char *name;
0516c8bc	49	int (probe) (struct pcie_device dev);
1da177e4	50	void (remove) (struct pcie_device dev);
3a3c244c	51	int (suspend) (struct pcie_device dev);
1da177e4 LT	52	int (resume) (struct pcie_device dev);
1da177e4 LT	53
c5dc3c69 CH	54	/* Device driver may resume normal operations */
c5dc3c69 CH	55	void (error_resume)(struct pci_dev dev);
6c2b374d ZY	56
	57	/* Link Reset Capability - AER service driver specific */
	58	pci_ers_result_t (reset_link) (struct pci_dev dev);
	59
22106368 RW	60	int port_type; /* Type of the port this driver can handle */
	61	u32 service; /* Port service this device represents */
	62
1da177e4 LT	63	struct device_driver driver;
	64	};
	65	#define to_service_driver(d) \
	66	container_of(d, struct pcie_port_service_driver, driver)
	67
f39d5b72 BH	68	int pcie_port_service_register(struct pcie_port_service_driver *new);
f39d5b72 BH	69	void pcie_port_service_unregister(struct pcie_port_service_driver *new);
1da177e4 LT	70
1da177e4 LT	71	#endif /* _PCIEPORT_IF_H_ */