include/linux/pcieport_if.h

   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 */
  13 #define PCIE_ANY_PORT                   (~0)
  14
  15 /* Service Type */
  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)
  24 #define PCIE_PORT_SERVICE_DPC_SHIFT     4       /* Downstream Port Containment */
  25 #define PCIE_PORT_SERVICE_DPC           (1 << PCIE_PORT_SERVICE_DPC_SHIFT)
  26
  27 struct pcie_device {
  28         int             irq;        /* Service IRQ/MSI/MSI-X Vector */
  29         struct pci_dev *port;       /* Root/Upstream/Downstream Port */
  30         u32             service;    /* Port service this device represents */
  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;
  48         int (*probe) (struct pcie_device *dev);
  49         void (*remove) (struct pcie_device *dev);
  50         int (*suspend) (struct pcie_device *dev);
  51         int (*resume) (struct pcie_device *dev);
  52
  53         /* Service Error Recovery Handler */
  54         const struct pci_error_handlers *err_handler;
  55
  56         /* Link Reset Capability - AER service driver specific */
  57         pci_ers_result_t (*reset_link) (struct pci_dev *dev);
  58
  59         int port_type;  /* Type of the port this driver can handle */
  60         u32 service;    /* Port service this device represents */
  61
  62         struct device_driver driver;
  63 };
  64 #define to_service_driver(d) \
  65         container_of(d, struct pcie_port_service_driver, driver)
  66
  67 int pcie_port_service_register(struct pcie_port_service_driver *new);
  68 void pcie_port_service_unregister(struct pcie_port_service_driver *new);
  69
  70 #endif /* _PCIEPORT_IF_H_ */