[linux-2.6-block.git] / include / linux / pcieport_if.h

/*
 * 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);

	/* Service Error Recovery Handler */
	const struct pci_error_handlers *err_handler;

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