drivers/pci/controller/dwc/pcie-designware.h - linux - Git at Google

 /* SPDX-License-Identifier: GPL-2.0 */
 /*
  * Synopsys DesignWare PCIe host controller driver
  *
  * Copyright (C) 2013 Samsung Electronics Co., Ltd.
  *		https://www.samsung.com
  *
  * Author: Jingoo Han <jg1.han@samsung.com>
  */

 #ifndef _PCIE_DESIGNWARE_H
 #define _PCIE_DESIGNWARE_H

 #include <linux/bitfield.h>
 #include <linux/dma-mapping.h>
 #include <linux/irq.h>
 #include <linux/msi.h>
 #include <linux/pci.h>

 #include <linux/pci-epc.h>
 #include <linux/pci-epf.h>

 /* Parameters for the waiting for link up routine */
 #define LINK_WAIT_MAX_RETRIES		10
 #define LINK_WAIT_USLEEP_MIN		90000
 #define LINK_WAIT_USLEEP_MAX		100000

 /* Parameters for the waiting for iATU enabled routine */
 #define LINK_WAIT_MAX_IATU_RETRIES	5
 #define LINK_WAIT_IATU			9

 /* Synopsys-specific PCIe configuration registers */
 #define PCIE_PORT_AFR			0x70C
 #define PORT_AFR_N_FTS_MASK		GENMASK(15, 8)
 #define PORT_AFR_N_FTS(n)		FIELD_PREP(PORT_AFR_N_FTS_MASK, n)
 #define PORT_AFR_CC_N_FTS_MASK		GENMASK(23, 16)
 #define PORT_AFR_CC_N_FTS(n)		FIELD_PREP(PORT_AFR_CC_N_FTS_MASK, n)
 #define PORT_AFR_ENTER_ASPM		BIT(30)
 #define PORT_AFR_L0S_ENTRANCE_LAT_SHIFT	24
 #define PORT_AFR_L0S_ENTRANCE_LAT_MASK	GENMASK(26, 24)
 #define PORT_AFR_L1_ENTRANCE_LAT_SHIFT	27
 #define PORT_AFR_L1_ENTRANCE_LAT_MASK	GENMASK(29, 27)

 #define PCIE_PORT_LINK_CONTROL		0x710
 #define PORT_LINK_DLL_LINK_EN		BIT(5)
 #define PORT_LINK_FAST_LINK_MODE	BIT(7)
 #define PORT_LINK_MODE_MASK		GENMASK(21, 16)
 #define PORT_LINK_MODE(n)		FIELD_PREP(PORT_LINK_MODE_MASK, n)
 #define PORT_LINK_MODE_1_LANES		PORT_LINK_MODE(0x1)
 #define PORT_LINK_MODE_2_LANES		PORT_LINK_MODE(0x3)
 #define PORT_LINK_MODE_4_LANES		PORT_LINK_MODE(0x7)
 #define PORT_LINK_MODE_8_LANES		PORT_LINK_MODE(0xf)

 #define PCIE_PORT_DEBUG0		0x728
 #define PORT_LOGIC_LTSSM_STATE_MASK	0x1f
 #define PORT_LOGIC_LTSSM_STATE_L0	0x11
 #define PCIE_PORT_DEBUG1		0x72C
 #define PCIE_PORT_DEBUG1_LINK_UP		BIT(4)
 #define PCIE_PORT_DEBUG1_LINK_IN_TRAINING	BIT(29)

 #define PCIE_LINK_WIDTH_SPEED_CONTROL	0x80C
 #define PORT_LOGIC_N_FTS_MASK		GENMASK(7, 0)
 #define PORT_LOGIC_SPEED_CHANGE		BIT(17)
 #define PORT_LOGIC_LINK_WIDTH_MASK	GENMASK(12, 8)
 #define PORT_LOGIC_LINK_WIDTH(n)	FIELD_PREP(PORT_LOGIC_LINK_WIDTH_MASK, n)
 #define PORT_LOGIC_LINK_WIDTH_1_LANES	PORT_LOGIC_LINK_WIDTH(0x1)
 #define PORT_LOGIC_LINK_WIDTH_2_LANES	PORT_LOGIC_LINK_WIDTH(0x2)
 #define PORT_LOGIC_LINK_WIDTH_4_LANES	PORT_LOGIC_LINK_WIDTH(0x4)
 #define PORT_LOGIC_LINK_WIDTH_8_LANES	PORT_LOGIC_LINK_WIDTH(0x8)

 #define PCIE_MSI_ADDR_LO		0x820
 #define PCIE_MSI_ADDR_HI		0x824
 #define PCIE_MSI_INTR0_ENABLE		0x828
 #define PCIE_MSI_INTR0_MASK		0x82C
 #define PCIE_MSI_INTR0_STATUS		0x830

 #define PCIE_PORT_MULTI_LANE_CTRL	0x8C0
 #define PORT_MLTI_UPCFG_SUPPORT		BIT(7)

 #define PCIE_ATU_VIEWPORT		0x900
 #define PCIE_ATU_REGION_INBOUND		BIT(31)
 #define PCIE_ATU_REGION_OUTBOUND	0
 #define PCIE_ATU_REGION_INDEX2		0x2
 #define PCIE_ATU_REGION_INDEX1		0x1
 #define PCIE_ATU_REGION_INDEX0		0x0
 #define PCIE_ATU_CR1			0x904
 #define PCIE_ATU_TYPE_MEM		0x0
 #define PCIE_ATU_TYPE_IO		0x2
 #define PCIE_ATU_TYPE_CFG0		0x4
 #define PCIE_ATU_TYPE_CFG1		0x5
 #define PCIE_ATU_FUNC_NUM(pf)           ((pf) << 20)
 #define PCIE_ATU_CR2			0x908
 #define PCIE_ATU_ENABLE			BIT(31)
 #define PCIE_ATU_BAR_MODE_ENABLE	BIT(30)
 #define PCIE_ATU_FUNC_NUM_MATCH_EN      BIT(19)
 #define PCIE_ATU_LOWER_BASE		0x90C
 #define PCIE_ATU_UPPER_BASE		0x910
 #define PCIE_ATU_LIMIT			0x914
 #define PCIE_ATU_LOWER_TARGET		0x918
 #define PCIE_ATU_BUS(x)			FIELD_PREP(GENMASK(31, 24), x)
 #define PCIE_ATU_DEV(x)			FIELD_PREP(GENMASK(23, 19), x)
 #define PCIE_ATU_FUNC(x)		FIELD_PREP(GENMASK(18, 16), x)
 #define PCIE_ATU_UPPER_TARGET		0x91C

 #define PCIE_MISC_CONTROL_1_OFF		0x8BC
 #define PCIE_DBI_RO_WR_EN		BIT(0)

 #define PCIE_MSIX_DOORBELL		0x948
 #define PCIE_MSIX_DOORBELL_PF_SHIFT	24

 #define PCIE_PL_CHK_REG_CONTROL_STATUS			0xB20
 #define PCIE_PL_CHK_REG_CHK_REG_START			BIT(0)
 #define PCIE_PL_CHK_REG_CHK_REG_CONTINUOUS		BIT(1)
 #define PCIE_PL_CHK_REG_CHK_REG_COMPARISON_ERROR	BIT(16)
 #define PCIE_PL_CHK_REG_CHK_REG_LOGIC_ERROR		BIT(17)
 #define PCIE_PL_CHK_REG_CHK_REG_COMPLETE		BIT(18)

 #define PCIE_PL_CHK_REG_ERR_ADDR			0xB28

 /*
  * iATU Unroll-specific register definitions
  * From 4.80 core version the address translation will be made by unroll
  */
 #define PCIE_ATU_UNR_REGION_CTRL1	0x00
 #define PCIE_ATU_UNR_REGION_CTRL2	0x04
 #define PCIE_ATU_UNR_LOWER_BASE		0x08
 #define PCIE_ATU_UNR_UPPER_BASE		0x0C
 #define PCIE_ATU_UNR_LOWER_LIMIT	0x10
 #define PCIE_ATU_UNR_LOWER_TARGET	0x14
 #define PCIE_ATU_UNR_UPPER_TARGET	0x18
 #define PCIE_ATU_UNR_UPPER_LIMIT	0x20

 /*
  * The default address offset between dbi_base and atu_base. Root controller
  * drivers are not required to initialize atu_base if the offset matches this
  * default; the driver core automatically derives atu_base from dbi_base using
  * this offset, if atu_base not set.
  */
 #define DEFAULT_DBI_ATU_OFFSET (0x3 << 20)

 /* Register address builder */
 #define PCIE_GET_ATU_OUTB_UNR_REG_OFFSET(region) \
 		((region) << 9)

 #define PCIE_GET_ATU_INB_UNR_REG_OFFSET(region) \
 		(((region) << 9) | BIT(8))

 #define MAX_MSI_IRQS			256
 #define MAX_MSI_IRQS_PER_CTRL		32
 #define MAX_MSI_CTRLS			(MAX_MSI_IRQS / MAX_MSI_IRQS_PER_CTRL)
 #define MSI_REG_CTRL_BLOCK_SIZE		12
 #define MSI_DEF_NUM_VECTORS		32

 /* Maximum number of inbound/outbound iATUs */
 #define MAX_IATU_IN			256
 #define MAX_IATU_OUT			256

 struct pcie_port;
 struct dw_pcie;
 struct dw_pcie_ep;

 enum dw_pcie_region_type {
 	DW_PCIE_REGION_UNKNOWN,
 	DW_PCIE_REGION_INBOUND,
 	DW_PCIE_REGION_OUTBOUND,
 };

 enum dw_pcie_device_mode {
 	DW_PCIE_UNKNOWN_TYPE,
 	DW_PCIE_EP_TYPE,
 	DW_PCIE_LEG_EP_TYPE,
 	DW_PCIE_RC_TYPE,
 };

 struct dw_pcie_host_ops {
 	int (*host_init)(struct pcie_port *pp);
 	void (*set_num_vectors)(struct pcie_port *pp);
 	int (*msi_host_init)(struct pcie_port *pp);
 };

 struct pcie_port {
 	u64			cfg0_base;
 	void __iomem		*va_cfg0_base;
 	u32			cfg0_size;
 	resource_size_t		io_base;
 	phys_addr_t		io_bus_addr;
 	u32			io_size;
 	int			irq;
 	const struct dw_pcie_host_ops *ops;
 	int			msi_irq;
 	struct irq_domain	*irq_domain;
 	struct irq_domain	*msi_domain;
 	u16			msi_msg;
 	dma_addr_t		msi_data;
 	struct irq_chip		*msi_irq_chip;
 	u32			num_vectors;
 	u32			irq_mask[MAX_MSI_CTRLS];
 	struct pci_host_bridge  *bridge;
 	raw_spinlock_t		lock;
 	DECLARE_BITMAP(msi_irq_in_use, MAX_MSI_IRQS);
 };

 enum dw_pcie_as_type {
 	DW_PCIE_AS_UNKNOWN,
 	DW_PCIE_AS_MEM,
 	DW_PCIE_AS_IO,
 };

 struct dw_pcie_ep_ops {
 	void	(*ep_init)(struct dw_pcie_ep *ep);
 	int	(*raise_irq)(struct dw_pcie_ep *ep, u8 func_no,
 			     enum pci_epc_irq_type type, u16 interrupt_num);
 	const struct pci_epc_features* (*get_features)(struct dw_pcie_ep *ep);
 	/*
 	 * Provide a method to implement the different func config space
 	 * access for different platform, if different func have different
 	 * offset, return the offset of func. if use write a register way
 	 * return a 0, and implement code in callback function of platform
 	 * driver.
 	 */
 	unsigned int (*func_conf_select)(struct dw_pcie_ep *ep, u8 func_no);
 };

 struct dw_pcie_ep_func {
 	struct list_head	list;
 	u8			func_no;
 	u8			msi_cap;	/* MSI capability offset */
 	u8			msix_cap;	/* MSI-X capability offset */
 };

 struct dw_pcie_ep {
 	struct pci_epc		*epc;
 	struct list_head	func_list;
 	const struct dw_pcie_ep_ops *ops;
 	phys_addr_t		phys_base;
 	size_t			addr_size;
 	size_t			page_size;
 	u8			bar_to_atu[PCI_STD_NUM_BARS];
 	phys_addr_t		*outbound_addr;
 	unsigned long		*ib_window_map;
 	unsigned long		*ob_window_map;
 	u32			num_ib_windows;
 	u32			num_ob_windows;
 	void __iomem		*msi_mem;
 	phys_addr_t		msi_mem_phys;
 	struct pci_epf_bar	*epf_bar[PCI_STD_NUM_BARS];
 };

 struct dw_pcie_ops {
 	u64	(*cpu_addr_fixup)(struct dw_pcie *pcie, u64 cpu_addr);
 	u32	(*read_dbi)(struct dw_pcie *pcie, void __iomem *base, u32 reg,
 			    size_t size);
 	void	(*write_dbi)(struct dw_pcie *pcie, void __iomem *base, u32 reg,
 			     size_t size, u32 val);
 	void    (*write_dbi2)(struct dw_pcie *pcie, void __iomem *base, u32 reg,
 			      size_t size, u32 val);
 	int	(*link_up)(struct dw_pcie *pcie);
 	int	(*start_link)(struct dw_pcie *pcie);
 	void	(*stop_link)(struct dw_pcie *pcie);
 };

 struct dw_pcie {
 	struct device		*dev;
 	void __iomem		*dbi_base;
 	void __iomem		*dbi_base2;
 	/* Used when iatu_unroll_enabled is true */
 	void __iomem		*atu_base;
 	u32			num_viewport;
 	u8			iatu_unroll_enabled;
 	struct pcie_port	pp;
 	struct dw_pcie_ep	ep;
 	const struct dw_pcie_ops *ops;
 	unsigned int		version;
 	int			num_lanes;
 	int			link_gen;
 	u8			n_fts[2];
 };

 #define to_dw_pcie_from_pp(port) container_of((port), struct dw_pcie, pp)

 #define to_dw_pcie_from_ep(endpoint)   \
 		container_of((endpoint), struct dw_pcie, ep)

 u8 dw_pcie_find_capability(struct dw_pcie *pci, u8 cap);
 u16 dw_pcie_find_ext_capability(struct dw_pcie *pci, u8 cap);

 int dw_pcie_read(void __iomem *addr, int size, u32 *val);
 int dw_pcie_write(void __iomem *addr, int size, u32 val);

 u32 dw_pcie_read_dbi(struct dw_pcie *pci, u32 reg, size_t size);
 void dw_pcie_write_dbi(struct dw_pcie *pci, u32 reg, size_t size, u32 val);
 void dw_pcie_write_dbi2(struct dw_pcie *pci, u32 reg, size_t size, u32 val);
 int dw_pcie_link_up(struct dw_pcie *pci);
 void dw_pcie_upconfig_setup(struct dw_pcie *pci);
 int dw_pcie_wait_for_link(struct dw_pcie *pci);
 void dw_pcie_prog_outbound_atu(struct dw_pcie *pci, int index,
 			       int type, u64 cpu_addr, u64 pci_addr,
 			       u32 size);
 void dw_pcie_prog_ep_outbound_atu(struct dw_pcie *pci, u8 func_no, int index,
 				  int type, u64 cpu_addr, u64 pci_addr,
 				  u32 size);
 int dw_pcie_prog_inbound_atu(struct dw_pcie *pci, u8 func_no, int index,
 			     int bar, u64 cpu_addr,
 			     enum dw_pcie_as_type as_type);
 void dw_pcie_disable_atu(struct dw_pcie *pci, int index,
 			 enum dw_pcie_region_type type);
 void dw_pcie_setup(struct dw_pcie *pci);

 static inline void dw_pcie_writel_dbi(struct dw_pcie *pci, u32 reg, u32 val)
 {
 	dw_pcie_write_dbi(pci, reg, 0x4, val);
 }

 static inline u32 dw_pcie_readl_dbi(struct dw_pcie *pci, u32 reg)
 {
 	return dw_pcie_read_dbi(pci, reg, 0x4);
 }

 static inline void dw_pcie_writew_dbi(struct dw_pcie *pci, u32 reg, u16 val)
 {
 	dw_pcie_write_dbi(pci, reg, 0x2, val);
 }

 static inline u16 dw_pcie_readw_dbi(struct dw_pcie *pci, u32 reg)
 {
 	return dw_pcie_read_dbi(pci, reg, 0x2);
 }

 static inline void dw_pcie_writeb_dbi(struct dw_pcie *pci, u32 reg, u8 val)
 {
 	dw_pcie_write_dbi(pci, reg, 0x1, val);
 }

 static inline u8 dw_pcie_readb_dbi(struct dw_pcie *pci, u32 reg)
 {
 	return dw_pcie_read_dbi(pci, reg, 0x1);
 }

 static inline void dw_pcie_writel_dbi2(struct dw_pcie *pci, u32 reg, u32 val)
 {
 	dw_pcie_write_dbi2(pci, reg, 0x4, val);
 }

 static inline void dw_pcie_dbi_ro_wr_en(struct dw_pcie *pci)
 {
 	u32 reg;
 	u32 val;

 	reg = PCIE_MISC_CONTROL_1_OFF;
 	val = dw_pcie_readl_dbi(pci, reg);
 	val |= PCIE_DBI_RO_WR_EN;
 	dw_pcie_writel_dbi(pci, reg, val);
 }

 static inline void dw_pcie_dbi_ro_wr_dis(struct dw_pcie *pci)
 {
 	u32 reg;
 	u32 val;

 	reg = PCIE_MISC_CONTROL_1_OFF;
 	val = dw_pcie_readl_dbi(pci, reg);
 	val &= ~PCIE_DBI_RO_WR_EN;
 	dw_pcie_writel_dbi(pci, reg, val);
 }

 #ifdef CONFIG_PCIE_DW_HOST
 irqreturn_t dw_handle_msi_irq(struct pcie_port *pp);
 void dw_pcie_msi_init(struct pcie_port *pp);
 void dw_pcie_free_msi(struct pcie_port *pp);
 void dw_pcie_setup_rc(struct pcie_port *pp);
 int dw_pcie_host_init(struct pcie_port *pp);
 void dw_pcie_host_deinit(struct pcie_port *pp);
 int dw_pcie_allocate_domains(struct pcie_port *pp);
 void __iomem *dw_pcie_own_conf_map_bus(struct pci_bus *bus, unsigned int devfn,
 				       int where);
 #else
 static inline irqreturn_t dw_handle_msi_irq(struct pcie_port *pp)
 {
 	return IRQ_NONE;
 }

 static inline void dw_pcie_msi_init(struct pcie_port *pp)
 {
 }

 static inline void dw_pcie_free_msi(struct pcie_port *pp)
 {
 }

 static inline void dw_pcie_setup_rc(struct pcie_port *pp)
 {
 }

 static inline int dw_pcie_host_init(struct pcie_port *pp)
 {
 	return 0;
 }

 static inline void dw_pcie_host_deinit(struct pcie_port *pp)
 {
 }

 static inline int dw_pcie_allocate_domains(struct pcie_port *pp)
 {
 	return 0;
 }
 static inline void __iomem *dw_pcie_own_conf_map_bus(struct pci_bus *bus,
 						     unsigned int devfn,
 						     int where)
 {
 	return NULL;
 }
 #endif

 #ifdef CONFIG_PCIE_DW_EP
 void dw_pcie_ep_linkup(struct dw_pcie_ep *ep);
 int dw_pcie_ep_init(struct dw_pcie_ep *ep);
 int dw_pcie_ep_init_complete(struct dw_pcie_ep *ep);
 void dw_pcie_ep_init_notify(struct dw_pcie_ep *ep);
 void dw_pcie_ep_exit(struct dw_pcie_ep *ep);
 int dw_pcie_ep_raise_legacy_irq(struct dw_pcie_ep *ep, u8 func_no);
 int dw_pcie_ep_raise_msi_irq(struct dw_pcie_ep *ep, u8 func_no,
 			     u8 interrupt_num);
 int dw_pcie_ep_raise_msix_irq(struct dw_pcie_ep *ep, u8 func_no,
 			     u16 interrupt_num);
 int dw_pcie_ep_raise_msix_irq_doorbell(struct dw_pcie_ep *ep, u8 func_no,
 				       u16 interrupt_num);
 void dw_pcie_ep_reset_bar(struct dw_pcie *pci, enum pci_barno bar);
 struct dw_pcie_ep_func *
 dw_pcie_ep_get_func_from_ep(struct dw_pcie_ep *ep, u8 func_no);
 #else
 static inline void dw_pcie_ep_linkup(struct dw_pcie_ep *ep)
 {
 }

 static inline int dw_pcie_ep_init(struct dw_pcie_ep *ep)
 {
 	return 0;
 }

 static inline int dw_pcie_ep_init_complete(struct dw_pcie_ep *ep)
 {
 	return 0;
 }

 static inline void dw_pcie_ep_init_notify(struct dw_pcie_ep *ep)
 {
 }

 static inline void dw_pcie_ep_exit(struct dw_pcie_ep *ep)
 {
 }

 static inline int dw_pcie_ep_raise_legacy_irq(struct dw_pcie_ep *ep, u8 func_no)
 {
 	return 0;
 }

 static inline int dw_pcie_ep_raise_msi_irq(struct dw_pcie_ep *ep, u8 func_no,
 					   u8 interrupt_num)
 {
 	return 0;
 }

 static inline int dw_pcie_ep_raise_msix_irq(struct dw_pcie_ep *ep, u8 func_no,
 					   u16 interrupt_num)
 {
 	return 0;
 }

 static inline int dw_pcie_ep_raise_msix_irq_doorbell(struct dw_pcie_ep *ep,
 						     u8 func_no,
 						     u16 interrupt_num)
 {
 	return 0;
 }

 static inline void dw_pcie_ep_reset_bar(struct dw_pcie *pci, enum pci_barno bar)
 {
 }

 static inline struct dw_pcie_ep_func *
 dw_pcie_ep_get_func_from_ep(struct dw_pcie_ep *ep, u8 func_no)
 {
 	return NULL;
 }
 #endif
 #endif /* _PCIE_DESIGNWARE_H */
	/* SPDX-License-Identifier: GPL-2.0 */
	/*
	* Synopsys DesignWare PCIe host controller driver
	*
	* Copyright (C) 2013 Samsung Electronics Co., Ltd.
	* https://www.samsung.com
	*
	* Author: Jingoo Han <jg1.han@samsung.com>
	*/

	#ifndef _PCIE_DESIGNWARE_H
	#define _PCIE_DESIGNWARE_H

	#include <linux/bitfield.h>
	#include <linux/dma-mapping.h>
	#include <linux/irq.h>
	#include <linux/msi.h>
	#include <linux/pci.h>

	#include <linux/pci-epc.h>
	#include <linux/pci-epf.h>

	/* Parameters for the waiting for link up routine */
	#define LINK_WAIT_MAX_RETRIES 10
	#define LINK_WAIT_USLEEP_MIN 90000
	#define LINK_WAIT_USLEEP_MAX 100000

	/* Parameters for the waiting for iATU enabled routine */
	#define LINK_WAIT_MAX_IATU_RETRIES 5
	#define LINK_WAIT_IATU 9

	/* Synopsys-specific PCIe configuration registers */
	#define PCIE_PORT_AFR 0x70C
	#define PORT_AFR_N_FTS_MASK GENMASK(15, 8)
	#define PORT_AFR_N_FTS(n) FIELD_PREP(PORT_AFR_N_FTS_MASK, n)
	#define PORT_AFR_CC_N_FTS_MASK GENMASK(23, 16)
	#define PORT_AFR_CC_N_FTS(n) FIELD_PREP(PORT_AFR_CC_N_FTS_MASK, n)
	#define PORT_AFR_ENTER_ASPM BIT(30)
	#define PORT_AFR_L0S_ENTRANCE_LAT_SHIFT 24
	#define PORT_AFR_L0S_ENTRANCE_LAT_MASK GENMASK(26, 24)
	#define PORT_AFR_L1_ENTRANCE_LAT_SHIFT 27
	#define PORT_AFR_L1_ENTRANCE_LAT_MASK GENMASK(29, 27)

	#define PCIE_PORT_LINK_CONTROL 0x710
	#define PORT_LINK_DLL_LINK_EN BIT(5)
	#define PORT_LINK_FAST_LINK_MODE BIT(7)
	#define PORT_LINK_MODE_MASK GENMASK(21, 16)
	#define PORT_LINK_MODE(n) FIELD_PREP(PORT_LINK_MODE_MASK, n)
	#define PORT_LINK_MODE_1_LANES PORT_LINK_MODE(0x1)
	#define PORT_LINK_MODE_2_LANES PORT_LINK_MODE(0x3)
	#define PORT_LINK_MODE_4_LANES PORT_LINK_MODE(0x7)
	#define PORT_LINK_MODE_8_LANES PORT_LINK_MODE(0xf)

	#define PCIE_PORT_DEBUG0 0x728
	#define PORT_LOGIC_LTSSM_STATE_MASK 0x1f
	#define PORT_LOGIC_LTSSM_STATE_L0 0x11
	#define PCIE_PORT_DEBUG1 0x72C
	#define PCIE_PORT_DEBUG1_LINK_UP BIT(4)
	#define PCIE_PORT_DEBUG1_LINK_IN_TRAINING BIT(29)

	#define PCIE_LINK_WIDTH_SPEED_CONTROL 0x80C
	#define PORT_LOGIC_N_FTS_MASK GENMASK(7, 0)
	#define PORT_LOGIC_SPEED_CHANGE BIT(17)
	#define PORT_LOGIC_LINK_WIDTH_MASK GENMASK(12, 8)
	#define PORT_LOGIC_LINK_WIDTH(n) FIELD_PREP(PORT_LOGIC_LINK_WIDTH_MASK, n)
	#define PORT_LOGIC_LINK_WIDTH_1_LANES PORT_LOGIC_LINK_WIDTH(0x1)
	#define PORT_LOGIC_LINK_WIDTH_2_LANES PORT_LOGIC_LINK_WIDTH(0x2)
	#define PORT_LOGIC_LINK_WIDTH_4_LANES PORT_LOGIC_LINK_WIDTH(0x4)
	#define PORT_LOGIC_LINK_WIDTH_8_LANES PORT_LOGIC_LINK_WIDTH(0x8)

	#define PCIE_MSI_ADDR_LO 0x820
	#define PCIE_MSI_ADDR_HI 0x824
	#define PCIE_MSI_INTR0_ENABLE 0x828
	#define PCIE_MSI_INTR0_MASK 0x82C
	#define PCIE_MSI_INTR0_STATUS 0x830

	#define PCIE_PORT_MULTI_LANE_CTRL 0x8C0
	#define PORT_MLTI_UPCFG_SUPPORT BIT(7)

	#define PCIE_ATU_VIEWPORT 0x900
	#define PCIE_ATU_REGION_INBOUND BIT(31)
	#define PCIE_ATU_REGION_OUTBOUND 0
	#define PCIE_ATU_REGION_INDEX2 0x2
	#define PCIE_ATU_REGION_INDEX1 0x1
	#define PCIE_ATU_REGION_INDEX0 0x0
	#define PCIE_ATU_CR1 0x904
	#define PCIE_ATU_TYPE_MEM 0x0
	#define PCIE_ATU_TYPE_IO 0x2
	#define PCIE_ATU_TYPE_CFG0 0x4
	#define PCIE_ATU_TYPE_CFG1 0x5
	#define PCIE_ATU_FUNC_NUM(pf) ((pf) << 20)
	#define PCIE_ATU_CR2 0x908
	#define PCIE_ATU_ENABLE BIT(31)
	#define PCIE_ATU_BAR_MODE_ENABLE BIT(30)
	#define PCIE_ATU_FUNC_NUM_MATCH_EN BIT(19)
	#define PCIE_ATU_LOWER_BASE 0x90C
	#define PCIE_ATU_UPPER_BASE 0x910
	#define PCIE_ATU_LIMIT 0x914
	#define PCIE_ATU_LOWER_TARGET 0x918
	#define PCIE_ATU_BUS(x) FIELD_PREP(GENMASK(31, 24), x)
	#define PCIE_ATU_DEV(x) FIELD_PREP(GENMASK(23, 19), x)
	#define PCIE_ATU_FUNC(x) FIELD_PREP(GENMASK(18, 16), x)
	#define PCIE_ATU_UPPER_TARGET 0x91C

	#define PCIE_MISC_CONTROL_1_OFF 0x8BC
	#define PCIE_DBI_RO_WR_EN BIT(0)

	#define PCIE_MSIX_DOORBELL 0x948
	#define PCIE_MSIX_DOORBELL_PF_SHIFT 24

	#define PCIE_PL_CHK_REG_CONTROL_STATUS 0xB20
	#define PCIE_PL_CHK_REG_CHK_REG_START BIT(0)
	#define PCIE_PL_CHK_REG_CHK_REG_CONTINUOUS BIT(1)
	#define PCIE_PL_CHK_REG_CHK_REG_COMPARISON_ERROR BIT(16)
	#define PCIE_PL_CHK_REG_CHK_REG_LOGIC_ERROR BIT(17)
	#define PCIE_PL_CHK_REG_CHK_REG_COMPLETE BIT(18)

	#define PCIE_PL_CHK_REG_ERR_ADDR 0xB28

	/*
	* iATU Unroll-specific register definitions
	* From 4.80 core version the address translation will be made by unroll
	*/
	#define PCIE_ATU_UNR_REGION_CTRL1 0x00
	#define PCIE_ATU_UNR_REGION_CTRL2 0x04
	#define PCIE_ATU_UNR_LOWER_BASE 0x08
	#define PCIE_ATU_UNR_UPPER_BASE 0x0C
	#define PCIE_ATU_UNR_LOWER_LIMIT 0x10
	#define PCIE_ATU_UNR_LOWER_TARGET 0x14
	#define PCIE_ATU_UNR_UPPER_TARGET 0x18
	#define PCIE_ATU_UNR_UPPER_LIMIT 0x20

	/*
	* The default address offset between dbi_base and atu_base. Root controller
	* drivers are not required to initialize atu_base if the offset matches this
	* default; the driver core automatically derives atu_base from dbi_base using
	* this offset, if atu_base not set.
	*/
	#define DEFAULT_DBI_ATU_OFFSET (0x3 << 20)

	/* Register address builder */
	#define PCIE_GET_ATU_OUTB_UNR_REG_OFFSET(region) \
	((region) << 9)

	#define PCIE_GET_ATU_INB_UNR_REG_OFFSET(region) \
	(((region) << 9) \| BIT(8))

	#define MAX_MSI_IRQS 256
	#define MAX_MSI_IRQS_PER_CTRL 32
	#define MAX_MSI_CTRLS (MAX_MSI_IRQS / MAX_MSI_IRQS_PER_CTRL)
	#define MSI_REG_CTRL_BLOCK_SIZE 12
	#define MSI_DEF_NUM_VECTORS 32

	/* Maximum number of inbound/outbound iATUs */
	#define MAX_IATU_IN 256
	#define MAX_IATU_OUT 256

	struct pcie_port;
	struct dw_pcie;
	struct dw_pcie_ep;

	enum dw_pcie_region_type {
	DW_PCIE_REGION_UNKNOWN,
	DW_PCIE_REGION_INBOUND,
	DW_PCIE_REGION_OUTBOUND,
	};

	enum dw_pcie_device_mode {
	DW_PCIE_UNKNOWN_TYPE,
	DW_PCIE_EP_TYPE,
	DW_PCIE_LEG_EP_TYPE,
	DW_PCIE_RC_TYPE,
	};

	struct dw_pcie_host_ops {
	int (host_init)(struct pcie_port pp);
	void (set_num_vectors)(struct pcie_port pp);
	int (msi_host_init)(struct pcie_port pp);
	};

	struct pcie_port {
	u64 cfg0_base;
	void __iomem *va_cfg0_base;
	u32 cfg0_size;
	resource_size_t io_base;
	phys_addr_t io_bus_addr;
	u32 io_size;
	int irq;
	const struct dw_pcie_host_ops *ops;
	int msi_irq;
	struct irq_domain *irq_domain;
	struct irq_domain *msi_domain;
	u16 msi_msg;
	dma_addr_t msi_data;
	struct irq_chip *msi_irq_chip;
	u32 num_vectors;
	u32 irq_mask[MAX_MSI_CTRLS];
	struct pci_host_bridge *bridge;
	raw_spinlock_t lock;
	DECLARE_BITMAP(msi_irq_in_use, MAX_MSI_IRQS);
	};

	enum dw_pcie_as_type {
	DW_PCIE_AS_UNKNOWN,
	DW_PCIE_AS_MEM,
	DW_PCIE_AS_IO,
	};

	struct dw_pcie_ep_ops {
	void (ep_init)(struct dw_pcie_ep ep);
	int (raise_irq)(struct dw_pcie_ep ep, u8 func_no,
	enum pci_epc_irq_type type, u16 interrupt_num);
	const struct pci_epc_features* (get_features)(struct dw_pcie_ep ep);
	/*
	* Provide a method to implement the different func config space
	* access for different platform, if different func have different
	* offset, return the offset of func. if use write a register way
	* return a 0, and implement code in callback function of platform
	* driver.
	*/
	unsigned int (func_conf_select)(struct dw_pcie_ep ep, u8 func_no);
	};

	struct dw_pcie_ep_func {
	struct list_head list;
	u8 func_no;
	u8 msi_cap; /* MSI capability offset */
	u8 msix_cap; /* MSI-X capability offset */
	};

	struct dw_pcie_ep {
	struct pci_epc *epc;
	struct list_head func_list;
	const struct dw_pcie_ep_ops *ops;
	phys_addr_t phys_base;
	size_t addr_size;
	size_t page_size;
	u8 bar_to_atu[PCI_STD_NUM_BARS];
	phys_addr_t *outbound_addr;
	unsigned long *ib_window_map;
	unsigned long *ob_window_map;
	u32 num_ib_windows;
	u32 num_ob_windows;
	void __iomem *msi_mem;
	phys_addr_t msi_mem_phys;
	struct pci_epf_bar *epf_bar[PCI_STD_NUM_BARS];
	};

	struct dw_pcie_ops {
	u64 (cpu_addr_fixup)(struct dw_pcie pcie, u64 cpu_addr);
	u32 (read_dbi)(struct dw_pcie pcie, void __iomem *base, u32 reg,
	size_t size);
	void (write_dbi)(struct dw_pcie pcie, void __iomem *base, u32 reg,
	size_t size, u32 val);
	void (write_dbi2)(struct dw_pcie pcie, void __iomem *base, u32 reg,
	size_t size, u32 val);
	int (link_up)(struct dw_pcie pcie);
	int (start_link)(struct dw_pcie pcie);
	void (stop_link)(struct dw_pcie pcie);
	};

	struct dw_pcie {
	struct device *dev;
	void __iomem *dbi_base;
	void __iomem *dbi_base2;
	/* Used when iatu_unroll_enabled is true */
	void __iomem *atu_base;
	u32 num_viewport;
	u8 iatu_unroll_enabled;
	struct pcie_port pp;
	struct dw_pcie_ep ep;
	const struct dw_pcie_ops *ops;
	unsigned int version;
	int num_lanes;
	int link_gen;
	u8 n_fts[2];
	};

	#define to_dw_pcie_from_pp(port) container_of((port), struct dw_pcie, pp)

	#define to_dw_pcie_from_ep(endpoint) \
	container_of((endpoint), struct dw_pcie, ep)

	u8 dw_pcie_find_capability(struct dw_pcie *pci, u8 cap);
	u16 dw_pcie_find_ext_capability(struct dw_pcie *pci, u8 cap);

	int dw_pcie_read(void __iomem addr, int size, u32 val);
	int dw_pcie_write(void __iomem *addr, int size, u32 val);

	u32 dw_pcie_read_dbi(struct dw_pcie *pci, u32 reg, size_t size);
	void dw_pcie_write_dbi(struct dw_pcie *pci, u32 reg, size_t size, u32 val);
	void dw_pcie_write_dbi2(struct dw_pcie *pci, u32 reg, size_t size, u32 val);
	int dw_pcie_link_up(struct dw_pcie *pci);
	void dw_pcie_upconfig_setup(struct dw_pcie *pci);
	int dw_pcie_wait_for_link(struct dw_pcie *pci);
	void dw_pcie_prog_outbound_atu(struct dw_pcie *pci, int index,
	int type, u64 cpu_addr, u64 pci_addr,
	u32 size);
	void dw_pcie_prog_ep_outbound_atu(struct dw_pcie *pci, u8 func_no, int index,
	int type, u64 cpu_addr, u64 pci_addr,
	u32 size);
	int dw_pcie_prog_inbound_atu(struct dw_pcie *pci, u8 func_no, int index,
	int bar, u64 cpu_addr,
	enum dw_pcie_as_type as_type);
	void dw_pcie_disable_atu(struct dw_pcie *pci, int index,
	enum dw_pcie_region_type type);
	void dw_pcie_setup(struct dw_pcie *pci);

	static inline void dw_pcie_writel_dbi(struct dw_pcie *pci, u32 reg, u32 val)
	{
	dw_pcie_write_dbi(pci, reg, 0x4, val);
	}

	static inline u32 dw_pcie_readl_dbi(struct dw_pcie *pci, u32 reg)
	{
	return dw_pcie_read_dbi(pci, reg, 0x4);
	}

	static inline void dw_pcie_writew_dbi(struct dw_pcie *pci, u32 reg, u16 val)
	{
	dw_pcie_write_dbi(pci, reg, 0x2, val);
	}

	static inline u16 dw_pcie_readw_dbi(struct dw_pcie *pci, u32 reg)
	{
	return dw_pcie_read_dbi(pci, reg, 0x2);
	}

	static inline void dw_pcie_writeb_dbi(struct dw_pcie *pci, u32 reg, u8 val)
	{
	dw_pcie_write_dbi(pci, reg, 0x1, val);
	}

	static inline u8 dw_pcie_readb_dbi(struct dw_pcie *pci, u32 reg)
	{
	return dw_pcie_read_dbi(pci, reg, 0x1);
	}

	static inline void dw_pcie_writel_dbi2(struct dw_pcie *pci, u32 reg, u32 val)
	{
	dw_pcie_write_dbi2(pci, reg, 0x4, val);
	}

	static inline void dw_pcie_dbi_ro_wr_en(struct dw_pcie *pci)
	{
	u32 reg;
	u32 val;

	reg = PCIE_MISC_CONTROL_1_OFF;
	val = dw_pcie_readl_dbi(pci, reg);
	val \|= PCIE_DBI_RO_WR_EN;
	dw_pcie_writel_dbi(pci, reg, val);
	}

	static inline void dw_pcie_dbi_ro_wr_dis(struct dw_pcie *pci)
	{
	u32 reg;
	u32 val;

	reg = PCIE_MISC_CONTROL_1_OFF;
	val = dw_pcie_readl_dbi(pci, reg);
	val &= ~PCIE_DBI_RO_WR_EN;
	dw_pcie_writel_dbi(pci, reg, val);
	}

	#ifdef CONFIG_PCIE_DW_HOST
	irqreturn_t dw_handle_msi_irq(struct pcie_port *pp);
	void dw_pcie_msi_init(struct pcie_port *pp);
	void dw_pcie_free_msi(struct pcie_port *pp);
	void dw_pcie_setup_rc(struct pcie_port *pp);
	int dw_pcie_host_init(struct pcie_port *pp);
	void dw_pcie_host_deinit(struct pcie_port *pp);
	int dw_pcie_allocate_domains(struct pcie_port *pp);
	void __iomem dw_pcie_own_conf_map_bus(struct pci_bus bus, unsigned int devfn,
	int where);
	#else
	static inline irqreturn_t dw_handle_msi_irq(struct pcie_port *pp)
	{
	return IRQ_NONE;
	}

	static inline void dw_pcie_msi_init(struct pcie_port *pp)
	{
	}

	static inline void dw_pcie_free_msi(struct pcie_port *pp)
	{
	}

	static inline void dw_pcie_setup_rc(struct pcie_port *pp)
	{
	}

	static inline int dw_pcie_host_init(struct pcie_port *pp)
	{
	return 0;
	}

	static inline void dw_pcie_host_deinit(struct pcie_port *pp)
	{
	}

	static inline int dw_pcie_allocate_domains(struct pcie_port *pp)
	{
	return 0;
	}
	static inline void __iomem dw_pcie_own_conf_map_bus(struct pci_bus bus,
	unsigned int devfn,
	int where)
	{
	return NULL;
	}
	#endif

	#ifdef CONFIG_PCIE_DW_EP
	void dw_pcie_ep_linkup(struct dw_pcie_ep *ep);
	int dw_pcie_ep_init(struct dw_pcie_ep *ep);
	int dw_pcie_ep_init_complete(struct dw_pcie_ep *ep);
	void dw_pcie_ep_init_notify(struct dw_pcie_ep *ep);
	void dw_pcie_ep_exit(struct dw_pcie_ep *ep);
	int dw_pcie_ep_raise_legacy_irq(struct dw_pcie_ep *ep, u8 func_no);
	int dw_pcie_ep_raise_msi_irq(struct dw_pcie_ep *ep, u8 func_no,
	u8 interrupt_num);
	int dw_pcie_ep_raise_msix_irq(struct dw_pcie_ep *ep, u8 func_no,
	u16 interrupt_num);
	int dw_pcie_ep_raise_msix_irq_doorbell(struct dw_pcie_ep *ep, u8 func_no,
	u16 interrupt_num);
	void dw_pcie_ep_reset_bar(struct dw_pcie *pci, enum pci_barno bar);
	struct dw_pcie_ep_func *
	dw_pcie_ep_get_func_from_ep(struct dw_pcie_ep *ep, u8 func_no);
	#else
	static inline void dw_pcie_ep_linkup(struct dw_pcie_ep *ep)
	{
	}

	static inline int dw_pcie_ep_init(struct dw_pcie_ep *ep)
	{
	return 0;
	}

	static inline int dw_pcie_ep_init_complete(struct dw_pcie_ep *ep)
	{
	return 0;
	}

	static inline void dw_pcie_ep_init_notify(struct dw_pcie_ep *ep)
	{
	}

	static inline void dw_pcie_ep_exit(struct dw_pcie_ep *ep)
	{
	}

	static inline int dw_pcie_ep_raise_legacy_irq(struct dw_pcie_ep *ep, u8 func_no)
	{
	return 0;
	}

	static inline int dw_pcie_ep_raise_msi_irq(struct dw_pcie_ep *ep, u8 func_no,
	u8 interrupt_num)
	{
	return 0;
	}

	static inline int dw_pcie_ep_raise_msix_irq(struct dw_pcie_ep *ep, u8 func_no,
	u16 interrupt_num)
	{
	return 0;
	}

	static inline int dw_pcie_ep_raise_msix_irq_doorbell(struct dw_pcie_ep *ep,
	u8 func_no,
	u16 interrupt_num)
	{
	return 0;
	}

	static inline void dw_pcie_ep_reset_bar(struct dw_pcie *pci, enum pci_barno bar)
	{
	}

	static inline struct dw_pcie_ep_func *
	dw_pcie_ep_get_func_from_ep(struct dw_pcie_ep *ep, u8 func_no)
	{
	return NULL;
	}
	#endif
	#endif /* _PCIE_DESIGNWARE_H */