[linux-2.6-block.git] / include / linux / pci-ecam.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * Copyright 2016 Broadcom
 */
#ifndef DRIVERS_PCI_ECAM_H
#define DRIVERS_PCI_ECAM_H

#include <linux/pci.h>
#include <linux/kernel.h>
#include <linux/platform_device.h>

/*
 * struct to hold pci ops and bus shift of the config window
 * for a PCI controller.
 */
struct pci_config_window;
struct pci_ecam_ops {
	unsigned int			bus_shift;
	struct pci_ops			pci_ops;
	int				(*init)(struct pci_config_window *);
};

/*
 * struct to hold the mappings of a config space window. This
 * is expected to be used as sysdata for PCI controllers that
 * use ECAM.
 */
struct pci_config_window {
	struct resource			res;
	struct resource			busr;
	void				*priv;
	struct pci_ecam_ops		*ops;
	union {
		void __iomem		*win;	/* 64-bit single mapping */
		void __iomem		**winp; /* 32-bit per-bus mapping */
	};
	struct device			*parent;/* ECAM res was from this dev */
};

/* create and free pci_config_window */
struct pci_config_window *pci_ecam_create(struct device *dev,
		struct resource *cfgres, struct resource *busr,
		struct pci_ecam_ops *ops);
void pci_ecam_free(struct pci_config_window *cfg);

/* map_bus when ->sysdata is an instance of pci_config_window */
void __iomem *pci_ecam_map_bus(struct pci_bus *bus, unsigned int devfn,
			       int where);
/* default ECAM ops */
extern struct pci_ecam_ops pci_generic_ecam_ops;

#if defined(CONFIG_ACPI) && defined(CONFIG_PCI_QUIRKS)
extern struct pci_ecam_ops pci_32b_ops;		/* 32-bit accesses only */
extern struct pci_ecam_ops hisi_pcie_ops;	/* HiSilicon */
extern struct pci_ecam_ops thunder_pem_ecam_ops; /* Cavium ThunderX 1.x & 2.x */
extern struct pci_ecam_ops pci_thunder_ecam_ops; /* Cavium ThunderX 1.x */
extern struct pci_ecam_ops xgene_v1_pcie_ecam_ops; /* APM X-Gene PCIe v1 */
extern struct pci_ecam_ops xgene_v2_pcie_ecam_ops; /* APM X-Gene PCIe v2.x */
#endif

#ifdef CONFIG_PCI_HOST_COMMON
/* for DT-based PCI controllers that support ECAM */
int pci_host_common_probe(struct platform_device *pdev,
			  struct pci_ecam_ops *ops);
#endif
#endif
Commit	Line	Data
8cfab3cf	1	/* SPDX-License-Identifier: GPL-2.0 */
35ff9477 J	2	/*
35ff9477 J	3	* Copyright 2016 Broadcom
35ff9477 J	4	*/
	5	#ifndef DRIVERS_PCI_ECAM_H
	6	#define DRIVERS_PCI_ECAM_H
	7
41334f54	8	#include <linux/pci.h>
35ff9477 J	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;
5c3d14f7	20	int (init)(struct pci_config_window );
35ff9477 J	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	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	};
5c3d14f7	37	struct device parent;/ ECAM res was from this dev */
35ff9477 J	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	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 struct pci_ecam_ops pci_generic_ecam_ops;
	51
2ca5b8dd CC	52	#if defined(CONFIG_ACPI) && defined(CONFIG_PCI_QUIRKS)
2ca5b8dd CC	53	extern struct pci_ecam_ops pci_32b_ops; /* 32-bit accesses only */
5f00f1a0	54	extern struct pci_ecam_ops hisi_pcie_ops; /* HiSilicon */
648d93fc TN	55	extern struct pci_ecam_ops thunder_pem_ecam_ops; /* Cavium ThunderX 1.x & 2.x */
648d93fc TN	56	extern struct pci_ecam_ops pci_thunder_ecam_ops; /* Cavium ThunderX 1.x */
c5d46039 DD	57	extern struct pci_ecam_ops xgene_v1_pcie_ecam_ops; /* APM X-Gene PCIe v1 */
c5d46039 DD	58	extern struct pci_ecam_ops xgene_v2_pcie_ecam_ops; /* APM X-Gene PCIe v2.x */
2ca5b8dd CC	59	#endif
2ca5b8dd CC	60
de5bbdd0	61	#ifdef CONFIG_PCI_HOST_COMMON
1958e717 J	62	/* for DT-based PCI controllers that support ECAM */
	63	int pci_host_common_probe(struct platform_device *pdev,
	64	struct pci_ecam_ops *ops);
	65	#endif
35ff9477	66	#endif