1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * Copyright 2016 Broadcom
4  */
5 #ifndef DRIVERS_PCI_ECAM_H
6 #define DRIVERS_PCI_ECAM_H
7 
8 #include <linux/pci.h>
9 #include <linux/kernel.h>
10 #include <linux/platform_device.h>
11 
12 /*
13  * struct to hold pci ops and bus shift of the config window
14  * for a PCI controller.
15  */
16 struct pci_config_window;
17 struct pci_ecam_ops {
18 	unsigned int			bus_shift;
19 	struct pci_ops			pci_ops;
20 	int				(*init)(struct pci_config_window *);
21 };
22 
23 /*
24  * struct to hold the mappings of a config space window. This
25  * is expected to be used as sysdata for PCI controllers that
26  * use ECAM.
27  */
28 struct pci_config_window {
29 	struct resource			res;
30 	struct resource			busr;
31 	void				*priv;
32 	const struct pci_ecam_ops	*ops;
33 	union {
34 		void __iomem		*win;	/* 64-bit single mapping */
35 		void __iomem		**winp; /* 32-bit per-bus mapping */
36 	};
37 	struct device			*parent;/* ECAM res was from this dev */
38 };
39 
40 /* create and free pci_config_window */
41 struct pci_config_window *pci_ecam_create(struct device *dev,
42 		struct resource *cfgres, struct resource *busr,
43 		const struct pci_ecam_ops *ops);
44 void pci_ecam_free(struct pci_config_window *cfg);
45 
46 /* map_bus when ->sysdata is an instance of pci_config_window */
47 void __iomem *pci_ecam_map_bus(struct pci_bus *bus, unsigned int devfn,
48 			       int where);
49 /* default ECAM ops */
50 extern const struct pci_ecam_ops pci_generic_ecam_ops;
51 
52 #if defined(CONFIG_ACPI) && defined(CONFIG_PCI_QUIRKS)
53 extern const struct pci_ecam_ops pci_32b_ops;	/* 32-bit accesses only */
54 extern const struct pci_ecam_ops pci_32b_read_ops; /* 32-bit read only */
55 extern const struct pci_ecam_ops hisi_pcie_ops;	/* HiSilicon */
56 extern const struct pci_ecam_ops thunder_pem_ecam_ops; /* Cavium ThunderX 1.x & 2.x */
57 extern const struct pci_ecam_ops pci_thunder_ecam_ops; /* Cavium ThunderX 1.x */
58 extern const struct pci_ecam_ops xgene_v1_pcie_ecam_ops; /* APM X-Gene PCIe v1 */
59 extern const struct pci_ecam_ops xgene_v2_pcie_ecam_ops; /* APM X-Gene PCIe v2.x */
60 extern const struct pci_ecam_ops al_pcie_ops;	/* Amazon Annapurna Labs PCIe */
61 #endif
62 
63 #if IS_ENABLED(CONFIG_PCI_HOST_COMMON)
64 /* for DT-based PCI controllers that support ECAM */
65 int pci_host_common_probe(struct platform_device *pdev);
66 int pci_host_common_remove(struct platform_device *pdev);
67 #endif
68 #endif
69