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_RC_PORT                    4       /* Root port of RC */
  14 #define PCIE_SW_UPSTREAM_PORT           5       /* Upstream port of Switch */
  15 #define PCIE_SW_DOWNSTREAM_PORT         6       /* Downstream port of Switch */
  16 #define PCIE_ANY_PORT                   7
  17
  18 /* Service Type */
  19 #define PCIE_PORT_SERVICE_PME           1       /* Power Management Event */
  20 #define PCIE_PORT_SERVICE_AER           2       /* Advanced Error Reporting */
  21 #define PCIE_PORT_SERVICE_HP            4       /* Native Hotplug */
  22 #define PCIE_PORT_SERVICE_VC            8       /* Virtual Channel */
  23
  24 /* Root/Upstream/Downstream Port's Interrupt Mode */
  25 #define PCIE_PORT_NO_IRQ                (-1)
  26 #define PCIE_PORT_INTx_MODE             0
  27 #define PCIE_PORT_MSI_MODE              1
  28 #define PCIE_PORT_MSIX_MODE             2
  29
  30 struct pcie_port_data {
  31         int port_type;          /* Type of the port */
  32         int port_irq_mode;      /* [0:INTx | 1:MSI | 2:MSI-X] */
  33 };
  34
  35 struct pcie_device {
  36         int             irq;        /* Service IRQ/MSI/MSI-X Vector */
  37         struct pci_dev *port;       /* Root/Upstream/Downstream Port */
  38         u32             service;    /* Port service this device represents */
  39         void            *priv_data; /* Service Private Data */
  40         struct device   device;     /* Generic Device Interface */
  41 };
  42 #define to_pcie_device(d) container_of(d, struct pcie_device, device)
  43
  44 static inline void set_service_data(struct pcie_device *dev, void *data)
  45 {
  46         dev->priv_data = data;
  47 }
  48
  49 static inline void* get_service_data(struct pcie_device *dev)
  50 {
  51         return dev->priv_data;
  52 }
  53
  54 struct pcie_port_service_driver {
  55         const char *name;
  56         int (*probe) (struct pcie_device *dev);
  57         void (*remove) (struct pcie_device *dev);
  58         int (*suspend) (struct pcie_device *dev, pm_message_t state);
  59         int (*resume) (struct pcie_device *dev);
  60
  61         /* Service Error Recovery Handler */
  62         struct pci_error_handlers *err_handler;
  63
  64         /* Link Reset Capability - AER service driver specific */
  65         pci_ers_result_t (*reset_link) (struct pci_dev *dev);
  66
  67         int port_type;  /* Type of the port this driver can handle */
  68         u32 service;    /* Port service this device represents */
  69
  70         struct device_driver driver;
  71 };
  72 #define to_service_driver(d) \
  73         container_of(d, struct pcie_port_service_driver, driver)
  74
  75 extern int pcie_port_service_register(struct pcie_port_service_driver *new);
  76 extern void pcie_port_service_unregister(struct pcie_port_service_driver *new);
  77
  78 #endif /* _PCIEPORT_IF_H_ */