blob: 4f1089f2cc98b6b4690ac67aedce42ef4350e122 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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 */
Kenji Kaneshige694f88e2009-11-25 21:06:15 +090013#define PCIE_ANY_PORT (~0)
Linus Torvalds1da177e2005-04-16 15:20:36 -070014
15/* Service Type */
Rafael J. Wysockib43d4512009-01-24 00:23:22 +010016#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)
Linus Torvalds1da177e2005-04-16 15:20:36 -070024
Linus Torvalds1da177e2005-04-16 15:20:36 -070025struct pcie_device {
Bjorn Helgaasf7625982013-11-14 11:28:18 -070026 int irq; /* Service IRQ/MSI/MSI-X Vector */
Rafael J. Wysocki22106362009-01-13 14:46:46 +010027 struct pci_dev *port; /* Root/Upstream/Downstream Port */
28 u32 service; /* Port service this device represents */
Linus Torvalds1da177e2005-04-16 15:20:36 -070029 void *priv_data; /* Service Private Data */
30 struct device device; /* Generic Device Interface */
31};
32#define to_pcie_device(d) container_of(d, struct pcie_device, device)
33
34static inline void set_service_data(struct pcie_device *dev, void *data)
35{
36 dev->priv_data = data;
37}
38
39static inline void* get_service_data(struct pcie_device *dev)
40{
41 return dev->priv_data;
42}
43
44struct pcie_port_service_driver {
45 const char *name;
Rafael J. Wysocki0516c8b2009-01-13 14:44:19 +010046 int (*probe) (struct pcie_device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -070047 void (*remove) (struct pcie_device *dev);
Rafael J. Wysocki3a3c2442009-02-15 22:32:48 +010048 int (*suspend) (struct pcie_device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -070049 int (*resume) (struct pcie_device *dev);
50
Zhang, Yanmin6c2b3742006-07-31 15:21:33 +080051 /* Service Error Recovery Handler */
Stephen Hemminger49453022012-09-07 09:33:14 -070052 const struct pci_error_handlers *err_handler;
Zhang, Yanmin6c2b3742006-07-31 15:21:33 +080053
54 /* Link Reset Capability - AER service driver specific */
55 pci_ers_result_t (*reset_link) (struct pci_dev *dev);
56
Rafael J. Wysocki22106362009-01-13 14:46:46 +010057 int port_type; /* Type of the port this driver can handle */
58 u32 service; /* Port service this device represents */
59
Linus Torvalds1da177e2005-04-16 15:20:36 -070060 struct device_driver driver;
61};
62#define to_service_driver(d) \
63 container_of(d, struct pcie_port_service_driver, driver)
64
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -060065int pcie_port_service_register(struct pcie_port_service_driver *new);
66void pcie_port_service_unregister(struct pcie_port_service_driver *new);
Linus Torvalds1da177e2005-04-16 15:20:36 -070067
68#endif /* _PCIEPORT_IF_H_ */