PCI: dwc: dra7xx: Facilitate wrapper and MSI interrupts to be enabled independently
[linux-block.git] / drivers / pci / dwc / pcie-designware.h
CommitLineData
4b1ced84
JH
1/*
2 * Synopsys Designware PCIe host controller driver
3 *
4 * Copyright (C) 2013 Samsung Electronics Co., Ltd.
5 * http://www.samsung.com
6 *
7 * Author: Jingoo Han <jg1.han@samsung.com>
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
12 */
13
18edf451
SJ
14#ifndef _PCIE_DESIGNWARE_H
15#define _PCIE_DESIGNWARE_H
16
feb85d9b
KVA
17#include <linux/irq.h>
18#include <linux/msi.h>
19#include <linux/pci.h>
20
f8aed6ec
KVA
21#include <linux/pci-epc.h>
22#include <linux/pci-epf.h>
23
b90dc392
KVA
24/* Parameters for the waiting for link up routine */
25#define LINK_WAIT_MAX_RETRIES 10
26#define LINK_WAIT_USLEEP_MIN 90000
27#define LINK_WAIT_USLEEP_MAX 100000
28
29/* Parameters for the waiting for iATU enabled routine */
30#define LINK_WAIT_MAX_IATU_RETRIES 5
31#define LINK_WAIT_IATU_MIN 9000
32#define LINK_WAIT_IATU_MAX 10000
33
34/* Synopsys-specific PCIe configuration registers */
35#define PCIE_PORT_LINK_CONTROL 0x710
36#define PORT_LINK_MODE_MASK (0x3f << 16)
37#define PORT_LINK_MODE_1_LANES (0x1 << 16)
38#define PORT_LINK_MODE_2_LANES (0x3 << 16)
39#define PORT_LINK_MODE_4_LANES (0x7 << 16)
40#define PORT_LINK_MODE_8_LANES (0xf << 16)
41
42#define PCIE_LINK_WIDTH_SPEED_CONTROL 0x80C
43#define PORT_LOGIC_SPEED_CHANGE (0x1 << 17)
44#define PORT_LOGIC_LINK_WIDTH_MASK (0x1f << 8)
45#define PORT_LOGIC_LINK_WIDTH_1_LANES (0x1 << 8)
46#define PORT_LOGIC_LINK_WIDTH_2_LANES (0x2 << 8)
47#define PORT_LOGIC_LINK_WIDTH_4_LANES (0x4 << 8)
48#define PORT_LOGIC_LINK_WIDTH_8_LANES (0x8 << 8)
49
50#define PCIE_MSI_ADDR_LO 0x820
51#define PCIE_MSI_ADDR_HI 0x824
52#define PCIE_MSI_INTR0_ENABLE 0x828
53#define PCIE_MSI_INTR0_MASK 0x82C
54#define PCIE_MSI_INTR0_STATUS 0x830
55
56#define PCIE_ATU_VIEWPORT 0x900
57#define PCIE_ATU_REGION_INBOUND (0x1 << 31)
58#define PCIE_ATU_REGION_OUTBOUND (0x0 << 31)
59#define PCIE_ATU_REGION_INDEX2 (0x2 << 0)
60#define PCIE_ATU_REGION_INDEX1 (0x1 << 0)
61#define PCIE_ATU_REGION_INDEX0 (0x0 << 0)
62#define PCIE_ATU_CR1 0x904
63#define PCIE_ATU_TYPE_MEM (0x0 << 0)
64#define PCIE_ATU_TYPE_IO (0x2 << 0)
65#define PCIE_ATU_TYPE_CFG0 (0x4 << 0)
66#define PCIE_ATU_TYPE_CFG1 (0x5 << 0)
67#define PCIE_ATU_CR2 0x908
68#define PCIE_ATU_ENABLE (0x1 << 31)
69#define PCIE_ATU_BAR_MODE_ENABLE (0x1 << 30)
70#define PCIE_ATU_LOWER_BASE 0x90C
71#define PCIE_ATU_UPPER_BASE 0x910
72#define PCIE_ATU_LIMIT 0x914
73#define PCIE_ATU_LOWER_TARGET 0x918
74#define PCIE_ATU_BUS(x) (((x) & 0xff) << 24)
75#define PCIE_ATU_DEV(x) (((x) & 0x1f) << 19)
76#define PCIE_ATU_FUNC(x) (((x) & 0x7) << 16)
77#define PCIE_ATU_UPPER_TARGET 0x91C
78
79/*
80 * iATU Unroll-specific register definitions
81 * From 4.80 core version the address translation will be made by unroll
82 */
83#define PCIE_ATU_UNR_REGION_CTRL1 0x00
84#define PCIE_ATU_UNR_REGION_CTRL2 0x04
85#define PCIE_ATU_UNR_LOWER_BASE 0x08
86#define PCIE_ATU_UNR_UPPER_BASE 0x0C
87#define PCIE_ATU_UNR_LIMIT 0x10
88#define PCIE_ATU_UNR_LOWER_TARGET 0x14
89#define PCIE_ATU_UNR_UPPER_TARGET 0x18
90
91/* Register address builder */
92#define PCIE_GET_ATU_OUTB_UNR_REG_OFFSET(region) \
93 ((0x3 << 20) | ((region) << 9))
94
f8aed6ec
KVA
95#define PCIE_GET_ATU_INB_UNR_REG_OFFSET(region) \
96 ((0x3 << 20) | ((region) << 9) | (0x1 << 8))
97
98#define MSI_MESSAGE_CONTROL 0x52
99#define MSI_CAP_MMC_SHIFT 1
100#define MSI_CAP_MME_SHIFT 4
101#define MSI_CAP_MME_MASK (7 << MSI_CAP_MME_SHIFT)
102#define MSI_MESSAGE_ADDR_L32 0x54
103#define MSI_MESSAGE_ADDR_U32 0x58
104
f342d940
JH
105/*
106 * Maximum number of MSI IRQs can be 256 per controller. But keep
107 * it 32 as of now. Probably we will never need more than 32. If needed,
108 * then increment it in multiple of 32.
109 */
110#define MAX_MSI_IRQS 32
111#define MAX_MSI_CTRLS (MAX_MSI_IRQS / 32)
112
442ec4c0
KVA
113struct pcie_port;
114struct dw_pcie;
f8aed6ec
KVA
115struct dw_pcie_ep;
116
117enum dw_pcie_region_type {
118 DW_PCIE_REGION_UNKNOWN,
119 DW_PCIE_REGION_INBOUND,
120 DW_PCIE_REGION_OUTBOUND,
121};
442ec4c0
KVA
122
123struct dw_pcie_host_ops {
124 int (*rd_own_conf)(struct pcie_port *pp, int where, int size, u32 *val);
125 int (*wr_own_conf)(struct pcie_port *pp, int where, int size, u32 val);
126 int (*rd_other_conf)(struct pcie_port *pp, struct pci_bus *bus,
127 unsigned int devfn, int where, int size, u32 *val);
128 int (*wr_other_conf)(struct pcie_port *pp, struct pci_bus *bus,
129 unsigned int devfn, int where, int size, u32 val);
130 void (*host_init)(struct pcie_port *pp);
131 void (*msi_set_irq)(struct pcie_port *pp, int irq);
132 void (*msi_clear_irq)(struct pcie_port *pp, int irq);
133 phys_addr_t (*get_msi_addr)(struct pcie_port *pp);
134 u32 (*get_msi_data)(struct pcie_port *pp, int pos);
135 void (*scan_bus)(struct pcie_port *pp);
136 int (*msi_host_init)(struct pcie_port *pp, struct msi_controller *chip);
137};
138
4b1ced84 139struct pcie_port {
4b1ced84 140 u8 root_bus_nr;
4b1ced84
JH
141 u64 cfg0_base;
142 void __iomem *va_cfg0_base;
adf70fc0 143 u32 cfg0_size;
4b1ced84
JH
144 u64 cfg1_base;
145 void __iomem *va_cfg1_base;
adf70fc0 146 u32 cfg1_size;
0021d22b 147 resource_size_t io_base;
adf70fc0
PA
148 phys_addr_t io_bus_addr;
149 u32 io_size;
4b1ced84 150 u64 mem_base;
adf70fc0
PA
151 phys_addr_t mem_bus_addr;
152 u32 mem_size;
0021d22b
ZW
153 struct resource *cfg;
154 struct resource *io;
155 struct resource *mem;
156 struct resource *busn;
4b1ced84 157 int irq;
442ec4c0 158 struct dw_pcie_host_ops *ops;
f342d940 159 int msi_irq;
904d0e78 160 struct irq_domain *irq_domain;
f342d940
JH
161 unsigned long msi_data;
162 DECLARE_BITMAP(msi_irq_in_use, MAX_MSI_IRQS);
4b1ced84
JH
163};
164
f8aed6ec
KVA
165enum dw_pcie_as_type {
166 DW_PCIE_AS_UNKNOWN,
167 DW_PCIE_AS_MEM,
168 DW_PCIE_AS_IO,
169};
170
171struct dw_pcie_ep_ops {
172 void (*ep_init)(struct dw_pcie_ep *ep);
173 int (*raise_irq)(struct dw_pcie_ep *ep, enum pci_epc_irq_type type,
174 u8 interrupt_num);
175};
176
177struct dw_pcie_ep {
178 struct pci_epc *epc;
179 struct dw_pcie_ep_ops *ops;
180 phys_addr_t phys_base;
181 size_t addr_size;
182 u8 bar_to_atu[6];
183 phys_addr_t *outbound_addr;
184 unsigned long ib_window_map;
185 unsigned long ob_window_map;
186 u32 num_ib_windows;
187 u32 num_ob_windows;
188};
189
442ec4c0 190struct dw_pcie_ops {
a660083e 191 u64 (*cpu_addr_fixup)(u64 cpu_addr);
a509d7d9
KVA
192 u32 (*read_dbi)(struct dw_pcie *pcie, void __iomem *base, u32 reg,
193 size_t size);
194 void (*write_dbi)(struct dw_pcie *pcie, void __iomem *base, u32 reg,
195 size_t size, u32 val);
442ec4c0 196 int (*link_up)(struct dw_pcie *pcie);
f8aed6ec
KVA
197 int (*start_link)(struct dw_pcie *pcie);
198 void (*stop_link)(struct dw_pcie *pcie);
4b1ced84
JH
199};
200
442ec4c0
KVA
201struct dw_pcie {
202 struct device *dev;
203 void __iomem *dbi_base;
f8aed6ec 204 void __iomem *dbi_base2;
442ec4c0
KVA
205 u32 num_viewport;
206 u8 iatu_unroll_enabled;
207 struct pcie_port pp;
f8aed6ec 208 struct dw_pcie_ep ep;
442ec4c0
KVA
209 const struct dw_pcie_ops *ops;
210};
211
212#define to_dw_pcie_from_pp(port) container_of((port), struct dw_pcie, pp)
213
f8aed6ec
KVA
214#define to_dw_pcie_from_ep(endpoint) \
215 container_of((endpoint), struct dw_pcie, ep)
216
19ce01cc
KVA
217int dw_pcie_read(void __iomem *addr, int size, u32 *val);
218int dw_pcie_write(void __iomem *addr, int size, u32 val);
18edf451 219
a509d7d9
KVA
220u32 __dw_pcie_read_dbi(struct dw_pcie *pci, void __iomem *base, u32 reg,
221 size_t size);
222void __dw_pcie_write_dbi(struct dw_pcie *pci, void __iomem *base, u32 reg,
223 size_t size, u32 val);
442ec4c0
KVA
224int dw_pcie_link_up(struct dw_pcie *pci);
225int dw_pcie_wait_for_link(struct dw_pcie *pci);
feb85d9b
KVA
226void dw_pcie_prog_outbound_atu(struct dw_pcie *pci, int index,
227 int type, u64 cpu_addr, u64 pci_addr,
228 u32 size);
f8aed6ec
KVA
229int dw_pcie_prog_inbound_atu(struct dw_pcie *pci, int index, int bar,
230 u64 cpu_addr, enum dw_pcie_as_type as_type);
231void dw_pcie_disable_atu(struct dw_pcie *pci, int index,
232 enum dw_pcie_region_type type);
feb85d9b 233void dw_pcie_setup(struct dw_pcie *pci);
a0560209 234
b50b2db2
KVA
235static inline void dw_pcie_writel_dbi(struct dw_pcie *pci, u32 reg, u32 val)
236{
a509d7d9 237 __dw_pcie_write_dbi(pci, pci->dbi_base, reg, 0x4, val);
b50b2db2
KVA
238}
239
240static inline u32 dw_pcie_readl_dbi(struct dw_pcie *pci, u32 reg)
241{
a509d7d9 242 return __dw_pcie_read_dbi(pci, pci->dbi_base, reg, 0x4);
b50b2db2
KVA
243}
244
f8aed6ec
KVA
245static inline void dw_pcie_writew_dbi(struct dw_pcie *pci, u32 reg, u16 val)
246{
247 __dw_pcie_write_dbi(pci, pci->dbi_base, reg, 0x2, val);
248}
249
250static inline u16 dw_pcie_readw_dbi(struct dw_pcie *pci, u32 reg)
251{
252 return __dw_pcie_read_dbi(pci, pci->dbi_base, reg, 0x2);
253}
254
255static inline void dw_pcie_writeb_dbi(struct dw_pcie *pci, u32 reg, u8 val)
256{
257 __dw_pcie_write_dbi(pci, pci->dbi_base, reg, 0x1, val);
258}
259
260static inline u8 dw_pcie_readb_dbi(struct dw_pcie *pci, u32 reg)
261{
262 return __dw_pcie_read_dbi(pci, pci->dbi_base, reg, 0x1);
263}
264
265static inline void dw_pcie_writel_dbi2(struct dw_pcie *pci, u32 reg, u32 val)
266{
267 __dw_pcie_write_dbi(pci, pci->dbi_base2, reg, 0x4, val);
268}
269
270static inline u32 dw_pcie_readl_dbi2(struct dw_pcie *pci, u32 reg)
271{
272 return __dw_pcie_read_dbi(pci, pci->dbi_base2, reg, 0x4);
273}
274
a0560209
KVA
275#ifdef CONFIG_PCIE_DW_HOST
276irqreturn_t dw_handle_msi_irq(struct pcie_port *pp);
277void dw_pcie_msi_init(struct pcie_port *pp);
278void dw_pcie_setup_rc(struct pcie_port *pp);
279int dw_pcie_host_init(struct pcie_port *pp);
280#else
281static inline irqreturn_t dw_handle_msi_irq(struct pcie_port *pp)
282{
283 return IRQ_NONE;
284}
285
286static inline void dw_pcie_msi_init(struct pcie_port *pp)
287{
288}
289
290static inline void dw_pcie_setup_rc(struct pcie_port *pp)
291{
292}
293
294static inline int dw_pcie_host_init(struct pcie_port *pp)
295{
296 return 0;
297}
298#endif
f8aed6ec
KVA
299
300#ifdef CONFIG_PCIE_DW_EP
301void dw_pcie_ep_linkup(struct dw_pcie_ep *ep);
302int dw_pcie_ep_init(struct dw_pcie_ep *ep);
303void dw_pcie_ep_exit(struct dw_pcie_ep *ep);
304#else
305static inline void dw_pcie_ep_linkup(struct dw_pcie_ep *ep)
306{
307}
308
309static inline int dw_pcie_ep_init(struct dw_pcie_ep *ep)
310{
311 return 0;
312}
313
314static inline void dw_pcie_ep_exit(struct dw_pcie_ep *ep)
315{
316}
317#endif
18edf451 318#endif /* _PCIE_DESIGNWARE_H */