include/linux/pci-ecam.h

   1 /*
   2  * Copyright 2016 Broadcom
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License, version 2, as
   6  * published by the Free Software Foundation (the "GPL").
   7  *
   8  * This program is distributed in the hope that it will be useful, but
   9  * WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11  * General Public License version 2 (GPLv2) for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * version 2 (GPLv2) along with this source code.
  15  */
  16 #ifndef DRIVERS_PCI_ECAM_H
  17 #define DRIVERS_PCI_ECAM_H
  18
  19 #include <linux/pci.h>
  20 #include <linux/kernel.h>
  21 #include <linux/platform_device.h>
  22
  23 /*
  24  * struct to hold pci ops and bus shift of the config window
  25  * for a PCI controller.
  26  */
  27 struct pci_config_window;
  28 struct pci_ecam_ops {
  29         unsigned int                    bus_shift;
  30         struct pci_ops                  pci_ops;
  31         int                             (*init)(struct pci_config_window *);
  32 };
  33
  34 /*
  35  * struct to hold the mappings of a config space window. This
  36  * is expected to be used as sysdata for PCI controllers that
  37  * use ECAM.
  38  */
  39 struct pci_config_window {
  40         struct resource                 res;
  41         struct resource                 busr;
  42         void                            *priv;
  43         struct pci_ecam_ops             *ops;
  44         union {
  45                 void __iomem            *win;   /* 64-bit single mapping */
  46                 void __iomem            **winp; /* 32-bit per-bus mapping */
  47         };
  48         struct device                   *parent;/* ECAM res was from this dev */
  49 };
  50
  51 /* create and free pci_config_window */
  52 struct pci_config_window *pci_ecam_create(struct device *dev,
  53                 struct resource *cfgres, struct resource *busr,
  54                 struct pci_ecam_ops *ops);
  55 void pci_ecam_free(struct pci_config_window *cfg);
  56
  57 /* map_bus when ->sysdata is an instance of pci_config_window */
  58 void __iomem *pci_ecam_map_bus(struct pci_bus *bus, unsigned int devfn,
  59                                int where);
  60 /* default ECAM ops */
  61 extern struct pci_ecam_ops pci_generic_ecam_ops;
  62
  63 #if defined(CONFIG_ACPI) && defined(CONFIG_PCI_QUIRKS)
  64 extern struct pci_ecam_ops pci_32b_ops;         /* 32-bit accesses only */
  65 extern struct pci_ecam_ops hisi_pcie_ops;       /* HiSilicon */
  66 extern struct pci_ecam_ops thunder_pem_ecam_ops; /* Cavium ThunderX 1.x & 2.x */
  67 extern struct pci_ecam_ops pci_thunder_ecam_ops; /* Cavium ThunderX 1.x */
  68 extern struct pci_ecam_ops xgene_v1_pcie_ecam_ops; /* APM X-Gene PCIe v1 */
  69 extern struct pci_ecam_ops xgene_v2_pcie_ecam_ops; /* APM X-Gene PCIe v2.x */
  70 #endif
  71
  72 #ifdef CONFIG_PCI_HOST_COMMON
  73 /* for DT-based PCI controllers that support ECAM */
  74 int pci_host_common_probe(struct platform_device *pdev,
  75                           struct pci_ecam_ops *ops);
  76 #endif
  77 #endif