drivers/pci/controller/pcie-iproc.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * Copyright (C) 2014-2015 Broadcom Corporation
   4  */
   5
   6 #ifndef _PCIE_IPROC_H
   7 #define _PCIE_IPROC_H
   8
   9 /**
  10  * iProc PCIe interface type
  11  *
  12  * PAXB is the wrapper used in root complex that can be connected to an
  13  * external endpoint device.
  14  *
  15  * PAXC is the wrapper used in root complex dedicated for internal emulated
  16  * endpoint devices.
  17  */
  18 enum iproc_pcie_type {
  19         IPROC_PCIE_PAXB_BCMA = 0,
  20         IPROC_PCIE_PAXB,
  21         IPROC_PCIE_PAXB_V2,
  22         IPROC_PCIE_PAXC,
  23         IPROC_PCIE_PAXC_V2,
  24 };
  25
  26 /**
  27  * iProc PCIe outbound mapping
  28  * @axi_offset: offset from the AXI address to the internal address used by
  29  * the iProc PCIe core
  30  * @nr_windows: total number of supported outbound mapping windows
  31  */
  32 struct iproc_pcie_ob {
  33         resource_size_t axi_offset;
  34         unsigned int nr_windows;
  35 };
  36
  37 /**
  38  * iProc PCIe inbound mapping
  39  * @nr_regions: total number of supported inbound mapping regions
  40  */
  41 struct iproc_pcie_ib {
  42         unsigned int nr_regions;
  43 };
  44
  45 struct iproc_pcie_ob_map;
  46 struct iproc_pcie_ib_map;
  47 struct iproc_msi;
  48
  49 /**
  50  * iProc PCIe device
  51  *
  52  * @dev: pointer to device data structure
  53  * @type: iProc PCIe interface type
  54  * @reg_offsets: register offsets
  55  * @base: PCIe host controller I/O register base
  56  * @base_addr: PCIe host controller register base physical address
  57  * @root_bus: pointer to root bus
  58  * @phy: optional PHY device that controls the Serdes
  59  * @map_irq: function callback to map interrupts
  60  * @ep_is_internal: indicates an internal emulated endpoint device is connected
  61  * @iproc_cfg_read: indicates the iProc config read function should be used
  62  * @rej_unconfig_pf: indicates the root complex needs to detect and reject
  63  * enumeration against unconfigured physical functions emulated in the ASIC
  64  * @has_apb_err_disable: indicates the controller can be configured to prevent
  65  * unsupported request from being forwarded as an APB bus error
  66  * @fix_paxc_cap: indicates the controller has corrupted capability list in its
  67  * config space registers and requires SW based fixup
  68  *
  69  * @need_ob_cfg: indicates SW needs to configure the outbound mapping window
  70  * @ob: outbound mapping related parameters
  71  * @ob_map: outbound mapping related parameters specific to the controller
  72  *
  73  * @need_ib_cfg: indicates SW needs to configure the inbound mapping window
  74  * @ib: inbound mapping related parameters
  75  * @ib_map: outbound mapping region related parameters
  76  *
  77  * @need_msi_steer: indicates additional configuration of the iProc PCIe
  78  * controller is required to steer MSI writes to external interrupt controller
  79  * @msi: MSI data
  80  */
  81 struct iproc_pcie {
  82         struct device *dev;
  83         enum iproc_pcie_type type;
  84         u16 *reg_offsets;
  85         void __iomem *base;
  86         phys_addr_t base_addr;
  87         struct resource mem;
  88         struct pci_bus *root_bus;
  89         struct phy *phy;
  90         int (*map_irq)(const struct pci_dev *, u8, u8);
  91         bool ep_is_internal;
  92         bool iproc_cfg_read;
  93         bool rej_unconfig_pf;
  94         bool has_apb_err_disable;
  95         bool fix_paxc_cap;
  96
  97         bool need_ob_cfg;
  98         struct iproc_pcie_ob ob;
  99         const struct iproc_pcie_ob_map *ob_map;
 100
 101         bool need_ib_cfg;
 102         struct iproc_pcie_ib ib;
 103         const struct iproc_pcie_ib_map *ib_map;
 104
 105         bool need_msi_steer;
 106         struct iproc_msi *msi;
 107 };
 108
 109 int iproc_pcie_setup(struct iproc_pcie *pcie, struct list_head *res);
 110 int iproc_pcie_remove(struct iproc_pcie *pcie);
 111 int iproc_pcie_shutdown(struct iproc_pcie *pcie);
 112
 113 #ifdef CONFIG_PCIE_IPROC_MSI
 114 int iproc_msi_init(struct iproc_pcie *pcie, struct device_node *node);
 115 void iproc_msi_exit(struct iproc_pcie *pcie);
 116 #else
 117 static inline int iproc_msi_init(struct iproc_pcie *pcie,
 118                                  struct device_node *node)
 119 {
 120         return -ENODEV;
 121 }
 122 static inline void iproc_msi_exit(struct iproc_pcie *pcie)
 123 {
 124 }
 125 #endif
 126
 127 #endif /* _PCIE_IPROC_H */