Prepare v2023.10
[platform/kernel/u-boot.git] / drivers / usb / host / ehci-marvell.c
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * (C) Copyright 2009
4  * Marvell Semiconductor <www.marvell.com>
5  * Written-by: Prafulla Wadaskar <prafulla@marvell.com>
6  */
7
8 #include <common.h>
9 #include <log.h>
10 #include <asm/global_data.h>
11 #include <asm/io.h>
12 #include <usb.h>
13 #include <linux/delay.h>
14 #include "ehci.h"
15 #include <linux/mbus.h>
16 #include <asm/arch/cpu.h>
17 #include <dm.h>
18
19 #if defined(CONFIG_ARCH_KIRKWOOD)
20 #include <asm/arch/soc.h>
21 #elif defined(CONFIG_ARCH_ORION5X)
22 #include <asm/arch/orion5x.h>
23 #endif
24
25 DECLARE_GLOBAL_DATA_PTR;
26
27 #define USB_WINDOW_CTRL(i)      (0x320 + ((i) << 4))
28 #define USB_WINDOW_BASE(i)      (0x324 + ((i) << 4))
29 #define USB_TARGET_DRAM         0x0
30
31 #define USB2_SBUSCFG_OFF        0x90
32
33 #define USB_SBUSCFG_BAWR_OFF    0x6
34 #define USB_SBUSCFG_BARD_OFF    0x3
35 #define USB_SBUSCFG_AHBBRST_OFF 0x0
36
37 #define USB_SBUSCFG_BAWR_ALIGN_64B      0x4
38 #define USB_SBUSCFG_BARD_ALIGN_64B      0x4
39 #define USB_SBUSCFG_AHBBRST_INCR16      0x7
40
41 /*
42  * USB 2.0 Bridge Address Decoding registers setup
43  */
44 #if CONFIG_IS_ENABLED(DM_USB)
45
46 struct ehci_mvebu_priv {
47         struct ehci_ctrl ehci;
48         fdt_addr_t hcd_base;
49 };
50
51 #define USB_TO_DRAM_TARGET_ID 0x2
52 #define USB_TO_DRAM_ATTR_ID 0x0
53 #define USB_DRAM_BASE 0x00000000
54 #define USB_DRAM_SIZE 0xfff     /* don't overrun u-boot source (was 0xffff) */
55
56 /*
57  * Once all the older Marvell SoC's (Orion, Kirkwood) are converted
58  * to the common mvebu archticture including the mbus setup, this
59  * will be the only function needed to configure the access windows
60  */
61 static void usb_brg_adrdec_setup(struct udevice *dev, void *base)
62 {
63         const struct mbus_dram_target_info *dram;
64         int i;
65
66         dram = mvebu_mbus_dram_info();
67
68         for (i = 0; i < 4; i++) {
69                 writel(0, base + USB_WINDOW_CTRL(i));
70                 writel(0, base + USB_WINDOW_BASE(i));
71         }
72
73         if (device_is_compatible(dev, "marvell,ac5-ehci")) {
74                 /*
75                  * use decoding window to map dram address seen by usb to 0x0
76                  */
77
78                 /* Write size, attributes and target id to control register */
79                 writel((USB_DRAM_SIZE << 16) | (USB_TO_DRAM_ATTR_ID << 8) |
80                        (USB_TO_DRAM_TARGET_ID << 4) | 1,
81                        base + USB_WINDOW_CTRL(0));
82
83                 /* Write base address to base register */
84                 writel(USB_DRAM_BASE, base + USB_WINDOW_BASE(0));
85
86                 debug("## AC5 decoding windows, ctrl[%p]=0x%x, base[%p]=0x%x\n",
87                       base + USB_WINDOW_CTRL(0), readl(base + USB_WINDOW_CTRL(0)),
88                       base + USB_WINDOW_BASE(0), readl(base + USB_WINDOW_BASE(0)));
89         } else {
90                 for (i = 0; i < dram->num_cs; i++) {
91                         const struct mbus_dram_window *cs = dram->cs + i;
92
93                         /* Write size, attributes and target id to control register */
94                         writel(((cs->size - 1) & 0xffff0000) | (cs->mbus_attr << 8) |
95                                    (dram->mbus_dram_target_id << 4) | 1,
96                                    base + USB_WINDOW_CTRL(i));
97
98                         /* Write base address to base register */
99                         writel(cs->base, base + USB_WINDOW_BASE(i));
100                 }
101         }
102 }
103
104 static void marvell_ehci_powerup_fixup(struct ehci_ctrl *ctrl,
105                                        uint32_t *status_reg, uint32_t *reg)
106 {
107         struct ehci_mvebu_priv *priv = ctrl->priv;
108
109         /*
110          * Set default value for reg SBUSCFG, which is Control for the AMBA
111          * system bus interface:
112          * BAWR = BARD = 4 : Align rd/wr bursts packets larger than 64 bytes
113          * AHBBRST = 7     : Align AHB burst for packets larger than 64 bytes
114          */
115         writel((USB_SBUSCFG_BAWR_ALIGN_64B << USB_SBUSCFG_BAWR_OFF) |
116                (USB_SBUSCFG_BARD_ALIGN_64B << USB_SBUSCFG_BARD_OFF) |
117                (USB_SBUSCFG_AHBBRST_INCR16 << USB_SBUSCFG_AHBBRST_OFF),
118                priv->hcd_base + USB2_SBUSCFG_OFF);
119
120         mdelay(50);
121 }
122
123 static struct ehci_ops marvell_ehci_ops = {
124         .powerup_fixup  = NULL,
125 };
126
127 static int ehci_mvebu_probe(struct udevice *dev)
128 {
129         struct ehci_mvebu_priv *priv = dev_get_priv(dev);
130         struct ehci_hccr *hccr;
131         struct ehci_hcor *hcor;
132
133         /*
134          * Get the base address for EHCI controller from the device node
135          */
136         priv->hcd_base = dev_read_addr(dev);
137         if (priv->hcd_base == FDT_ADDR_T_NONE) {
138                 debug("Can't get the EHCI register base address\n");
139                 return -ENXIO;
140         }
141
142         /*
143          * For SoCs without hlock like Armada3700 we need to program the sbuscfg
144          * reg to guarantee AHB master's burst will not overrun or underrun
145          * the FIFO. Otherwise all USB2 write option will fail.
146          * Also, the address decoder doesn't need to get setup with this
147          * SoC, so don't call usb_brg_adrdec_setup().
148          */
149         if (device_is_compatible(dev, "marvell,armada-3700-ehci"))
150                 marvell_ehci_ops.powerup_fixup = marvell_ehci_powerup_fixup;
151         else
152                 usb_brg_adrdec_setup(dev, (void *)priv->hcd_base);
153
154         hccr = (struct ehci_hccr *)(priv->hcd_base + 0x100);
155         hcor = (struct ehci_hcor *)
156                 ((uintptr_t)hccr + HC_LENGTH(ehci_readl(&hccr->cr_capbase)));
157
158         debug("ehci-marvell: init hccr %lx and hcor %lx hc_length %ld\n",
159               (uintptr_t)hccr, (uintptr_t)hcor,
160               (uintptr_t)HC_LENGTH(ehci_readl(&hccr->cr_capbase)));
161
162 #define PHY_CALIB_OFFSET 0x808
163         /*
164          * Trigger calibration during each usb start/reset:
165          * BIT 13 to 0, and then to 1
166          */
167         if (device_is_compatible(dev, "marvell,ac5-ehci")) {
168                 void *phy_calib_reg = (void *)(priv->hcd_base + PHY_CALIB_OFFSET);
169                 u32 val = readl(phy_calib_reg) & (~BIT(13));
170
171                 writel(val, phy_calib_reg);
172                 writel(val | BIT(13), phy_calib_reg);
173         }
174
175         return ehci_register(dev, hccr, hcor, &marvell_ehci_ops, 0,
176                              USB_INIT_HOST);
177 }
178
179 static const struct udevice_id ehci_usb_ids[] = {
180         { .compatible = "marvell,orion-ehci", },
181         { .compatible = "marvell,armada-3700-ehci", },
182         { .compatible = "marvell,ac5-ehci", },
183         { }
184 };
185
186 U_BOOT_DRIVER(ehci_mvebu) = {
187         .name   = "ehci_mvebu",
188         .id     = UCLASS_USB,
189         .of_match = ehci_usb_ids,
190         .probe = ehci_mvebu_probe,
191         .remove = ehci_deregister,
192         .ops    = &ehci_usb_ops,
193         .plat_auto      = sizeof(struct usb_plat),
194         .priv_auto      = sizeof(struct ehci_mvebu_priv),
195         .flags  = DM_FLAG_ALLOC_PRIV_DMA,
196 };
197
198 #else
199 #define MVUSB_BASE(port)        MVUSB0_BASE
200
201 static void usb_brg_adrdec_setup(int index)
202 {
203         int i;
204         u32 size, base, attrib;
205
206         for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) {
207
208                 /* Enable DRAM bank */
209                 switch (i) {
210                 case 0:
211                         attrib = MVUSB0_CPU_ATTR_DRAM_CS0;
212                         break;
213                 case 1:
214                         attrib = MVUSB0_CPU_ATTR_DRAM_CS1;
215                         break;
216                 case 2:
217                         attrib = MVUSB0_CPU_ATTR_DRAM_CS2;
218                         break;
219                 case 3:
220                         attrib = MVUSB0_CPU_ATTR_DRAM_CS3;
221                         break;
222                 default:
223                         /* invalide bank, disable access */
224                         attrib = 0;
225                         break;
226                 }
227
228                 size = gd->bd->bi_dram[i].size;
229                 base = gd->bd->bi_dram[i].start;
230                 if ((size) && (attrib))
231                         writel(MVCPU_WIN_CTRL_DATA(size, USB_TARGET_DRAM,
232                                                    attrib, MVCPU_WIN_ENABLE),
233                                 MVUSB0_BASE + USB_WINDOW_CTRL(i));
234                 else
235                         writel(MVCPU_WIN_DISABLE,
236                                MVUSB0_BASE + USB_WINDOW_CTRL(i));
237
238                 writel(base, MVUSB0_BASE + USB_WINDOW_BASE(i));
239         }
240 }
241
242 /*
243  * Create the appropriate control structures to manage
244  * a new EHCI host controller.
245  */
246 int ehci_hcd_init(int index, enum usb_init_type init,
247                 struct ehci_hccr **hccr, struct ehci_hcor **hcor)
248 {
249         usb_brg_adrdec_setup(index);
250
251         *hccr = (struct ehci_hccr *)(MVUSB_BASE(index) + 0x100);
252         *hcor = (struct ehci_hcor *)((uint32_t) *hccr
253                         + HC_LENGTH(ehci_readl(&(*hccr)->cr_capbase)));
254
255         debug("ehci-marvell: init hccr %x and hcor %x hc_length %d\n",
256                 (uint32_t)*hccr, (uint32_t)*hcor,
257                 (uint32_t)HC_LENGTH(ehci_readl(&(*hccr)->cr_capbase)));
258
259         return 0;
260 }
261
262 /*
263  * Destroy the appropriate control structures corresponding
264  * the the EHCI host controller.
265  */
266 int ehci_hcd_stop(int index)
267 {
268         return 0;
269 }
270
271 #endif /* CONFIG_IS_ENABLED(DM_USB) */