x86/topology: Fix function name in documentation
[cris-mirror.git] / drivers / usb / mtu3 / mtu3_core.c
blobb1b99a8f6a7a01f54d4bbfb5f4edee060b411a32
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3 * mtu3_core.c - hardware access layer and gadget init/exit of
4 * MediaTek usb3 Dual-Role Controller Driver
6 * Copyright (C) 2016 MediaTek Inc.
8 * Author: Chunfeng Yun <chunfeng.yun@mediatek.com>
9 */
11 #include <linux/dma-mapping.h>
12 #include <linux/kernel.h>
13 #include <linux/module.h>
14 #include <linux/of_address.h>
15 #include <linux/of_irq.h>
16 #include <linux/platform_device.h>
18 #include "mtu3.h"
20 static int ep_fifo_alloc(struct mtu3_ep *mep, u32 seg_size)
22 struct mtu3_fifo_info *fifo = mep->fifo;
23 u32 num_bits = DIV_ROUND_UP(seg_size, MTU3_EP_FIFO_UNIT);
24 u32 start_bit;
26 /* ensure that @mep->fifo_seg_size is power of two */
27 num_bits = roundup_pow_of_two(num_bits);
28 if (num_bits > fifo->limit)
29 return -EINVAL;
31 mep->fifo_seg_size = num_bits * MTU3_EP_FIFO_UNIT;
32 num_bits = num_bits * (mep->slot + 1);
33 start_bit = bitmap_find_next_zero_area(fifo->bitmap,
34 fifo->limit, 0, num_bits, 0);
35 if (start_bit >= fifo->limit)
36 return -EOVERFLOW;
38 bitmap_set(fifo->bitmap, start_bit, num_bits);
39 mep->fifo_size = num_bits * MTU3_EP_FIFO_UNIT;
40 mep->fifo_addr = fifo->base + MTU3_EP_FIFO_UNIT * start_bit;
42 dev_dbg(mep->mtu->dev, "%s fifo:%#x/%#x, start_bit: %d\n",
43 __func__, mep->fifo_seg_size, mep->fifo_size, start_bit);
45 return mep->fifo_addr;
48 static void ep_fifo_free(struct mtu3_ep *mep)
50 struct mtu3_fifo_info *fifo = mep->fifo;
51 u32 addr = mep->fifo_addr;
52 u32 bits = mep->fifo_size / MTU3_EP_FIFO_UNIT;
53 u32 start_bit;
55 if (unlikely(addr < fifo->base || bits > fifo->limit))
56 return;
58 start_bit = (addr - fifo->base) / MTU3_EP_FIFO_UNIT;
59 bitmap_clear(fifo->bitmap, start_bit, bits);
60 mep->fifo_size = 0;
61 mep->fifo_seg_size = 0;
63 dev_dbg(mep->mtu->dev, "%s size:%#x/%#x, start_bit: %d\n",
64 __func__, mep->fifo_seg_size, mep->fifo_size, start_bit);
67 /* enable/disable U3D SS function */
68 static inline void mtu3_ss_func_set(struct mtu3 *mtu, bool enable)
70 /* If usb3_en==0, LTSSM will go to SS.Disable state */
71 if (enable)
72 mtu3_setbits(mtu->mac_base, U3D_USB3_CONFIG, USB3_EN);
73 else
74 mtu3_clrbits(mtu->mac_base, U3D_USB3_CONFIG, USB3_EN);
76 dev_dbg(mtu->dev, "USB3_EN = %d\n", !!enable);
79 /* set/clear U3D HS device soft connect */
80 static inline void mtu3_hs_softconn_set(struct mtu3 *mtu, bool enable)
82 if (enable) {
83 mtu3_setbits(mtu->mac_base, U3D_POWER_MANAGEMENT,
84 SOFT_CONN | SUSPENDM_ENABLE);
85 } else {
86 mtu3_clrbits(mtu->mac_base, U3D_POWER_MANAGEMENT,
87 SOFT_CONN | SUSPENDM_ENABLE);
89 dev_dbg(mtu->dev, "SOFTCONN = %d\n", !!enable);
92 /* only port0 of U2/U3 supports device mode */
93 static int mtu3_device_enable(struct mtu3 *mtu)
95 void __iomem *ibase = mtu->ippc_base;
96 u32 check_clk = 0;
98 mtu3_clrbits(ibase, U3D_SSUSB_IP_PW_CTRL2, SSUSB_IP_DEV_PDN);
100 if (mtu->is_u3_ip) {
101 check_clk = SSUSB_U3_MAC_RST_B_STS;
102 mtu3_clrbits(ibase, SSUSB_U3_CTRL(0),
103 (SSUSB_U3_PORT_DIS | SSUSB_U3_PORT_PDN |
104 SSUSB_U3_PORT_HOST_SEL));
106 mtu3_clrbits(ibase, SSUSB_U2_CTRL(0),
107 (SSUSB_U2_PORT_DIS | SSUSB_U2_PORT_PDN |
108 SSUSB_U2_PORT_HOST_SEL));
110 if (mtu->ssusb->dr_mode == USB_DR_MODE_OTG)
111 mtu3_setbits(ibase, SSUSB_U2_CTRL(0), SSUSB_U2_PORT_OTG_SEL);
113 return ssusb_check_clocks(mtu->ssusb, check_clk);
116 static void mtu3_device_disable(struct mtu3 *mtu)
118 void __iomem *ibase = mtu->ippc_base;
120 if (mtu->is_u3_ip)
121 mtu3_setbits(ibase, SSUSB_U3_CTRL(0),
122 (SSUSB_U3_PORT_DIS | SSUSB_U3_PORT_PDN));
124 mtu3_setbits(ibase, SSUSB_U2_CTRL(0),
125 SSUSB_U2_PORT_DIS | SSUSB_U2_PORT_PDN);
127 if (mtu->ssusb->dr_mode == USB_DR_MODE_OTG)
128 mtu3_clrbits(ibase, SSUSB_U2_CTRL(0), SSUSB_U2_PORT_OTG_SEL);
130 mtu3_setbits(ibase, U3D_SSUSB_IP_PW_CTRL2, SSUSB_IP_DEV_PDN);
133 /* reset U3D's device module. */
134 static void mtu3_device_reset(struct mtu3 *mtu)
136 void __iomem *ibase = mtu->ippc_base;
138 mtu3_setbits(ibase, U3D_SSUSB_DEV_RST_CTRL, SSUSB_DEV_SW_RST);
139 udelay(1);
140 mtu3_clrbits(ibase, U3D_SSUSB_DEV_RST_CTRL, SSUSB_DEV_SW_RST);
143 /* disable all interrupts */
144 static void mtu3_intr_disable(struct mtu3 *mtu)
146 void __iomem *mbase = mtu->mac_base;
148 /* Disable level 1 interrupts */
149 mtu3_writel(mbase, U3D_LV1IECR, ~0x0);
150 /* Disable endpoint interrupts */
151 mtu3_writel(mbase, U3D_EPIECR, ~0x0);
154 static void mtu3_intr_status_clear(struct mtu3 *mtu)
156 void __iomem *mbase = mtu->mac_base;
158 /* Clear EP0 and Tx/Rx EPn interrupts status */
159 mtu3_writel(mbase, U3D_EPISR, ~0x0);
160 /* Clear U2 USB common interrupts status */
161 mtu3_writel(mbase, U3D_COMMON_USB_INTR, ~0x0);
162 /* Clear U3 LTSSM interrupts status */
163 mtu3_writel(mbase, U3D_LTSSM_INTR, ~0x0);
164 /* Clear speed change interrupt status */
165 mtu3_writel(mbase, U3D_DEV_LINK_INTR, ~0x0);
168 /* enable system global interrupt */
169 static void mtu3_intr_enable(struct mtu3 *mtu)
171 void __iomem *mbase = mtu->mac_base;
172 u32 value;
174 /*Enable level 1 interrupts (BMU, QMU, MAC3, DMA, MAC2, EPCTL) */
175 value = BMU_INTR | QMU_INTR | MAC3_INTR | MAC2_INTR | EP_CTRL_INTR;
176 mtu3_writel(mbase, U3D_LV1IESR, value);
178 /* Enable U2 common USB interrupts */
179 value = SUSPEND_INTR | RESUME_INTR | RESET_INTR;
180 mtu3_writel(mbase, U3D_COMMON_USB_INTR_ENABLE, value);
182 if (mtu->is_u3_ip) {
183 /* Enable U3 LTSSM interrupts */
184 value = HOT_RST_INTR | WARM_RST_INTR | VBUS_RISE_INTR |
185 VBUS_FALL_INTR | ENTER_U3_INTR | EXIT_U3_INTR;
186 mtu3_writel(mbase, U3D_LTSSM_INTR_ENABLE, value);
189 /* Enable QMU interrupts. */
190 value = TXQ_CSERR_INT | TXQ_LENERR_INT | RXQ_CSERR_INT |
191 RXQ_LENERR_INT | RXQ_ZLPERR_INT;
192 mtu3_writel(mbase, U3D_QIESR1, value);
194 /* Enable speed change interrupt */
195 mtu3_writel(mbase, U3D_DEV_LINK_INTR_ENABLE, SSUSB_DEV_SPEED_CHG_INTR);
198 /* set/clear the stall and toggle bits for non-ep0 */
199 void mtu3_ep_stall_set(struct mtu3_ep *mep, bool set)
201 struct mtu3 *mtu = mep->mtu;
202 void __iomem *mbase = mtu->mac_base;
203 u8 epnum = mep->epnum;
204 u32 csr;
206 if (mep->is_in) { /* TX */
207 csr = mtu3_readl(mbase, MU3D_EP_TXCR0(epnum)) & TX_W1C_BITS;
208 if (set)
209 csr |= TX_SENDSTALL;
210 else
211 csr = (csr & (~TX_SENDSTALL)) | TX_SENTSTALL;
212 mtu3_writel(mbase, MU3D_EP_TXCR0(epnum), csr);
213 } else { /* RX */
214 csr = mtu3_readl(mbase, MU3D_EP_RXCR0(epnum)) & RX_W1C_BITS;
215 if (set)
216 csr |= RX_SENDSTALL;
217 else
218 csr = (csr & (~RX_SENDSTALL)) | RX_SENTSTALL;
219 mtu3_writel(mbase, MU3D_EP_RXCR0(epnum), csr);
222 if (!set) {
223 mtu3_setbits(mbase, U3D_EP_RST, EP_RST(mep->is_in, epnum));
224 mtu3_clrbits(mbase, U3D_EP_RST, EP_RST(mep->is_in, epnum));
225 mep->flags &= ~MTU3_EP_STALL;
226 } else {
227 mep->flags |= MTU3_EP_STALL;
230 dev_dbg(mtu->dev, "%s: %s\n", mep->name,
231 set ? "SEND STALL" : "CLEAR STALL, with EP RESET");
234 void mtu3_dev_on_off(struct mtu3 *mtu, int is_on)
236 if (mtu->is_u3_ip && mtu->max_speed >= USB_SPEED_SUPER)
237 mtu3_ss_func_set(mtu, is_on);
238 else
239 mtu3_hs_softconn_set(mtu, is_on);
241 dev_info(mtu->dev, "gadget (%s) pullup D%s\n",
242 usb_speed_string(mtu->max_speed), is_on ? "+" : "-");
245 void mtu3_start(struct mtu3 *mtu)
247 void __iomem *mbase = mtu->mac_base;
249 dev_dbg(mtu->dev, "%s devctl 0x%x\n", __func__,
250 mtu3_readl(mbase, U3D_DEVICE_CONTROL));
252 mtu3_clrbits(mtu->ippc_base, U3D_SSUSB_IP_PW_CTRL2, SSUSB_IP_DEV_PDN);
255 * When disable U2 port, USB2_CSR's register will be reset to
256 * default value after re-enable it again(HS is enabled by default).
257 * So if force mac to work as FS, disable HS function.
259 if (mtu->max_speed == USB_SPEED_FULL)
260 mtu3_clrbits(mbase, U3D_POWER_MANAGEMENT, HS_ENABLE);
262 /* Initialize the default interrupts */
263 mtu3_intr_enable(mtu);
264 mtu->is_active = 1;
266 if (mtu->softconnect)
267 mtu3_dev_on_off(mtu, 1);
270 void mtu3_stop(struct mtu3 *mtu)
272 dev_dbg(mtu->dev, "%s\n", __func__);
274 mtu3_intr_disable(mtu);
275 mtu3_intr_status_clear(mtu);
277 if (mtu->softconnect)
278 mtu3_dev_on_off(mtu, 0);
280 mtu->is_active = 0;
281 mtu3_setbits(mtu->ippc_base, U3D_SSUSB_IP_PW_CTRL2, SSUSB_IP_DEV_PDN);
284 /* for non-ep0 */
285 int mtu3_config_ep(struct mtu3 *mtu, struct mtu3_ep *mep,
286 int interval, int burst, int mult)
288 void __iomem *mbase = mtu->mac_base;
289 int epnum = mep->epnum;
290 u32 csr0, csr1, csr2;
291 int fifo_sgsz, fifo_addr;
292 int num_pkts;
294 fifo_addr = ep_fifo_alloc(mep, mep->maxp);
295 if (fifo_addr < 0) {
296 dev_err(mtu->dev, "alloc ep fifo failed(%d)\n", mep->maxp);
297 return -ENOMEM;
299 fifo_sgsz = ilog2(mep->fifo_seg_size);
300 dev_dbg(mtu->dev, "%s fifosz: %x(%x/%x)\n", __func__, fifo_sgsz,
301 mep->fifo_seg_size, mep->fifo_size);
303 if (mep->is_in) {
304 csr0 = TX_TXMAXPKTSZ(mep->maxp);
305 csr0 |= TX_DMAREQEN;
307 num_pkts = (burst + 1) * (mult + 1) - 1;
308 csr1 = TX_SS_BURST(burst) | TX_SLOT(mep->slot);
309 csr1 |= TX_MAX_PKT(num_pkts) | TX_MULT(mult);
311 csr2 = TX_FIFOADDR(fifo_addr >> 4);
312 csr2 |= TX_FIFOSEGSIZE(fifo_sgsz);
314 switch (mep->type) {
315 case USB_ENDPOINT_XFER_BULK:
316 csr1 |= TX_TYPE(TYPE_BULK);
317 break;
318 case USB_ENDPOINT_XFER_ISOC:
319 csr1 |= TX_TYPE(TYPE_ISO);
320 csr2 |= TX_BINTERVAL(interval);
321 break;
322 case USB_ENDPOINT_XFER_INT:
323 csr1 |= TX_TYPE(TYPE_INT);
324 csr2 |= TX_BINTERVAL(interval);
325 break;
328 /* Enable QMU Done interrupt */
329 mtu3_setbits(mbase, U3D_QIESR0, QMU_TX_DONE_INT(epnum));
331 mtu3_writel(mbase, MU3D_EP_TXCR0(epnum), csr0);
332 mtu3_writel(mbase, MU3D_EP_TXCR1(epnum), csr1);
333 mtu3_writel(mbase, MU3D_EP_TXCR2(epnum), csr2);
335 dev_dbg(mtu->dev, "U3D_TX%d CSR0:%#x, CSR1:%#x, CSR2:%#x\n",
336 epnum, mtu3_readl(mbase, MU3D_EP_TXCR0(epnum)),
337 mtu3_readl(mbase, MU3D_EP_TXCR1(epnum)),
338 mtu3_readl(mbase, MU3D_EP_TXCR2(epnum)));
339 } else {
340 csr0 = RX_RXMAXPKTSZ(mep->maxp);
341 csr0 |= RX_DMAREQEN;
343 num_pkts = (burst + 1) * (mult + 1) - 1;
344 csr1 = RX_SS_BURST(burst) | RX_SLOT(mep->slot);
345 csr1 |= RX_MAX_PKT(num_pkts) | RX_MULT(mult);
347 csr2 = RX_FIFOADDR(fifo_addr >> 4);
348 csr2 |= RX_FIFOSEGSIZE(fifo_sgsz);
350 switch (mep->type) {
351 case USB_ENDPOINT_XFER_BULK:
352 csr1 |= RX_TYPE(TYPE_BULK);
353 break;
354 case USB_ENDPOINT_XFER_ISOC:
355 csr1 |= RX_TYPE(TYPE_ISO);
356 csr2 |= RX_BINTERVAL(interval);
357 break;
358 case USB_ENDPOINT_XFER_INT:
359 csr1 |= RX_TYPE(TYPE_INT);
360 csr2 |= RX_BINTERVAL(interval);
361 break;
364 /*Enable QMU Done interrupt */
365 mtu3_setbits(mbase, U3D_QIESR0, QMU_RX_DONE_INT(epnum));
367 mtu3_writel(mbase, MU3D_EP_RXCR0(epnum), csr0);
368 mtu3_writel(mbase, MU3D_EP_RXCR1(epnum), csr1);
369 mtu3_writel(mbase, MU3D_EP_RXCR2(epnum), csr2);
371 dev_dbg(mtu->dev, "U3D_RX%d CSR0:%#x, CSR1:%#x, CSR2:%#x\n",
372 epnum, mtu3_readl(mbase, MU3D_EP_RXCR0(epnum)),
373 mtu3_readl(mbase, MU3D_EP_RXCR1(epnum)),
374 mtu3_readl(mbase, MU3D_EP_RXCR2(epnum)));
377 dev_dbg(mtu->dev, "csr0:%#x, csr1:%#x, csr2:%#x\n", csr0, csr1, csr2);
378 dev_dbg(mtu->dev, "%s: %s, fifo-addr:%#x, fifo-size:%#x(%#x/%#x)\n",
379 __func__, mep->name, mep->fifo_addr, mep->fifo_size,
380 fifo_sgsz, mep->fifo_seg_size);
382 return 0;
385 /* for non-ep0 */
386 void mtu3_deconfig_ep(struct mtu3 *mtu, struct mtu3_ep *mep)
388 void __iomem *mbase = mtu->mac_base;
389 int epnum = mep->epnum;
391 if (mep->is_in) {
392 mtu3_writel(mbase, MU3D_EP_TXCR0(epnum), 0);
393 mtu3_writel(mbase, MU3D_EP_TXCR1(epnum), 0);
394 mtu3_writel(mbase, MU3D_EP_TXCR2(epnum), 0);
395 mtu3_setbits(mbase, U3D_QIECR0, QMU_TX_DONE_INT(epnum));
396 } else {
397 mtu3_writel(mbase, MU3D_EP_RXCR0(epnum), 0);
398 mtu3_writel(mbase, MU3D_EP_RXCR1(epnum), 0);
399 mtu3_writel(mbase, MU3D_EP_RXCR2(epnum), 0);
400 mtu3_setbits(mbase, U3D_QIECR0, QMU_RX_DONE_INT(epnum));
403 ep_fifo_free(mep);
405 dev_dbg(mtu->dev, "%s: %s\n", __func__, mep->name);
409 * Two scenarios:
410 * 1. when device IP supports SS, the fifo of EP0, TX EPs, RX EPs
411 * are separated;
412 * 2. when supports only HS, the fifo is shared for all EPs, and
413 * the capability registers of @EPNTXFFSZ or @EPNRXFFSZ indicate
414 * the total fifo size of non-ep0, and ep0's is fixed to 64B,
415 * so the total fifo size is 64B + @EPNTXFFSZ;
416 * Due to the first 64B should be reserved for EP0, non-ep0's fifo
417 * starts from offset 64 and are divided into two equal parts for
418 * TX or RX EPs for simplification.
420 static void get_ep_fifo_config(struct mtu3 *mtu)
422 struct mtu3_fifo_info *tx_fifo;
423 struct mtu3_fifo_info *rx_fifo;
424 u32 fifosize;
426 if (mtu->is_u3_ip) {
427 fifosize = mtu3_readl(mtu->mac_base, U3D_CAP_EPNTXFFSZ);
428 tx_fifo = &mtu->tx_fifo;
429 tx_fifo->base = 0;
430 tx_fifo->limit = fifosize / MTU3_EP_FIFO_UNIT;
431 bitmap_zero(tx_fifo->bitmap, MTU3_FIFO_BIT_SIZE);
433 fifosize = mtu3_readl(mtu->mac_base, U3D_CAP_EPNRXFFSZ);
434 rx_fifo = &mtu->rx_fifo;
435 rx_fifo->base = 0;
436 rx_fifo->limit = fifosize / MTU3_EP_FIFO_UNIT;
437 bitmap_zero(rx_fifo->bitmap, MTU3_FIFO_BIT_SIZE);
438 mtu->slot = MTU3_U3_IP_SLOT_DEFAULT;
439 } else {
440 fifosize = mtu3_readl(mtu->mac_base, U3D_CAP_EPNTXFFSZ);
441 tx_fifo = &mtu->tx_fifo;
442 tx_fifo->base = MTU3_U2_IP_EP0_FIFO_SIZE;
443 tx_fifo->limit = (fifosize / MTU3_EP_FIFO_UNIT) >> 1;
444 bitmap_zero(tx_fifo->bitmap, MTU3_FIFO_BIT_SIZE);
446 rx_fifo = &mtu->rx_fifo;
447 rx_fifo->base =
448 tx_fifo->base + tx_fifo->limit * MTU3_EP_FIFO_UNIT;
449 rx_fifo->limit = tx_fifo->limit;
450 bitmap_zero(rx_fifo->bitmap, MTU3_FIFO_BIT_SIZE);
451 mtu->slot = MTU3_U2_IP_SLOT_DEFAULT;
454 dev_dbg(mtu->dev, "%s, TX: base-%d, limit-%d; RX: base-%d, limit-%d\n",
455 __func__, tx_fifo->base, tx_fifo->limit,
456 rx_fifo->base, rx_fifo->limit);
459 void mtu3_ep0_setup(struct mtu3 *mtu)
461 u32 maxpacket = mtu->g.ep0->maxpacket;
462 u32 csr;
464 dev_dbg(mtu->dev, "%s maxpacket: %d\n", __func__, maxpacket);
466 csr = mtu3_readl(mtu->mac_base, U3D_EP0CSR);
467 csr &= ~EP0_MAXPKTSZ_MSK;
468 csr |= EP0_MAXPKTSZ(maxpacket);
469 csr &= EP0_W1C_BITS;
470 mtu3_writel(mtu->mac_base, U3D_EP0CSR, csr);
472 /* Enable EP0 interrupt */
473 mtu3_writel(mtu->mac_base, U3D_EPIESR, EP0ISR);
476 static int mtu3_mem_alloc(struct mtu3 *mtu)
478 void __iomem *mbase = mtu->mac_base;
479 struct mtu3_ep *ep_array;
480 int in_ep_num, out_ep_num;
481 u32 cap_epinfo;
482 int ret;
483 int i;
485 cap_epinfo = mtu3_readl(mbase, U3D_CAP_EPINFO);
486 in_ep_num = CAP_TX_EP_NUM(cap_epinfo);
487 out_ep_num = CAP_RX_EP_NUM(cap_epinfo);
489 dev_info(mtu->dev, "fifosz/epnum: Tx=%#x/%d, Rx=%#x/%d\n",
490 mtu3_readl(mbase, U3D_CAP_EPNTXFFSZ), in_ep_num,
491 mtu3_readl(mbase, U3D_CAP_EPNRXFFSZ), out_ep_num);
493 /* one for ep0, another is reserved */
494 mtu->num_eps = min(in_ep_num, out_ep_num) + 1;
495 ep_array = kcalloc(mtu->num_eps * 2, sizeof(*ep_array), GFP_KERNEL);
496 if (ep_array == NULL)
497 return -ENOMEM;
499 mtu->ep_array = ep_array;
500 mtu->in_eps = ep_array;
501 mtu->out_eps = &ep_array[mtu->num_eps];
502 /* ep0 uses in_eps[0], out_eps[0] is reserved */
503 mtu->ep0 = mtu->in_eps;
504 mtu->ep0->mtu = mtu;
505 mtu->ep0->epnum = 0;
507 for (i = 1; i < mtu->num_eps; i++) {
508 struct mtu3_ep *mep = mtu->in_eps + i;
510 mep->fifo = &mtu->tx_fifo;
511 mep = mtu->out_eps + i;
512 mep->fifo = &mtu->rx_fifo;
515 get_ep_fifo_config(mtu);
517 ret = mtu3_qmu_init(mtu);
518 if (ret)
519 kfree(mtu->ep_array);
521 return ret;
524 static void mtu3_mem_free(struct mtu3 *mtu)
526 mtu3_qmu_exit(mtu);
527 kfree(mtu->ep_array);
530 static void mtu3_set_speed(struct mtu3 *mtu)
532 void __iomem *mbase = mtu->mac_base;
534 if (!mtu->is_u3_ip && (mtu->max_speed > USB_SPEED_HIGH))
535 mtu->max_speed = USB_SPEED_HIGH;
537 if (mtu->max_speed == USB_SPEED_FULL) {
538 /* disable U3 SS function */
539 mtu3_clrbits(mbase, U3D_USB3_CONFIG, USB3_EN);
540 /* disable HS function */
541 mtu3_clrbits(mbase, U3D_POWER_MANAGEMENT, HS_ENABLE);
542 } else if (mtu->max_speed == USB_SPEED_HIGH) {
543 mtu3_clrbits(mbase, U3D_USB3_CONFIG, USB3_EN);
544 /* HS/FS detected by HW */
545 mtu3_setbits(mbase, U3D_POWER_MANAGEMENT, HS_ENABLE);
546 } else if (mtu->max_speed == USB_SPEED_SUPER) {
547 mtu3_clrbits(mtu->ippc_base, SSUSB_U3_CTRL(0),
548 SSUSB_U3_PORT_SSP_SPEED);
551 dev_info(mtu->dev, "max_speed: %s\n",
552 usb_speed_string(mtu->max_speed));
555 static void mtu3_regs_init(struct mtu3 *mtu)
558 void __iomem *mbase = mtu->mac_base;
560 /* be sure interrupts are disabled before registration of ISR */
561 mtu3_intr_disable(mtu);
562 mtu3_intr_status_clear(mtu);
564 if (mtu->is_u3_ip) {
565 /* disable LGO_U1/U2 by default */
566 mtu3_clrbits(mbase, U3D_LINK_POWER_CONTROL,
567 SW_U1_ACCEPT_ENABLE | SW_U2_ACCEPT_ENABLE |
568 SW_U1_REQUEST_ENABLE | SW_U2_REQUEST_ENABLE);
569 /* device responses to u3_exit from host automatically */
570 mtu3_clrbits(mbase, U3D_LTSSM_CTRL, SOFT_U3_EXIT_EN);
571 /* automatically build U2 link when U3 detect fail */
572 mtu3_setbits(mbase, U3D_USB2_TEST_MODE, U2U3_AUTO_SWITCH);
575 mtu3_set_speed(mtu);
577 /* delay about 0.1us from detecting reset to send chirp-K */
578 mtu3_clrbits(mbase, U3D_LINK_RESET_INFO, WTCHRP_MSK);
579 /* U2/U3 detected by HW */
580 mtu3_writel(mbase, U3D_DEVICE_CONF, 0);
581 /* enable QMU 16B checksum */
582 mtu3_setbits(mbase, U3D_QCR0, QMU_CS16B_EN);
583 /* vbus detected by HW */
584 mtu3_clrbits(mbase, U3D_MISC_CTRL, VBUS_FRC_EN | VBUS_ON);
587 static irqreturn_t mtu3_link_isr(struct mtu3 *mtu)
589 void __iomem *mbase = mtu->mac_base;
590 enum usb_device_speed udev_speed;
591 u32 maxpkt = 64;
592 u32 link;
593 u32 speed;
595 link = mtu3_readl(mbase, U3D_DEV_LINK_INTR);
596 link &= mtu3_readl(mbase, U3D_DEV_LINK_INTR_ENABLE);
597 mtu3_writel(mbase, U3D_DEV_LINK_INTR, link); /* W1C */
598 dev_dbg(mtu->dev, "=== LINK[%x] ===\n", link);
600 if (!(link & SSUSB_DEV_SPEED_CHG_INTR))
601 return IRQ_NONE;
603 speed = SSUSB_DEV_SPEED(mtu3_readl(mbase, U3D_DEVICE_CONF));
605 switch (speed) {
606 case MTU3_SPEED_FULL:
607 udev_speed = USB_SPEED_FULL;
608 /*BESLCK = 4 < BESLCK_U3 = 10 < BESLDCK = 15 */
609 mtu3_writel(mbase, U3D_USB20_LPM_PARAMETER, LPM_BESLDCK(0xf)
610 | LPM_BESLCK(4) | LPM_BESLCK_U3(0xa));
611 mtu3_setbits(mbase, U3D_POWER_MANAGEMENT,
612 LPM_BESL_STALL | LPM_BESLD_STALL);
613 break;
614 case MTU3_SPEED_HIGH:
615 udev_speed = USB_SPEED_HIGH;
616 /*BESLCK = 4 < BESLCK_U3 = 10 < BESLDCK = 15 */
617 mtu3_writel(mbase, U3D_USB20_LPM_PARAMETER, LPM_BESLDCK(0xf)
618 | LPM_BESLCK(4) | LPM_BESLCK_U3(0xa));
619 mtu3_setbits(mbase, U3D_POWER_MANAGEMENT,
620 LPM_BESL_STALL | LPM_BESLD_STALL);
621 break;
622 case MTU3_SPEED_SUPER:
623 udev_speed = USB_SPEED_SUPER;
624 maxpkt = 512;
625 break;
626 case MTU3_SPEED_SUPER_PLUS:
627 udev_speed = USB_SPEED_SUPER_PLUS;
628 maxpkt = 512;
629 break;
630 default:
631 udev_speed = USB_SPEED_UNKNOWN;
632 break;
634 dev_dbg(mtu->dev, "%s: %s\n", __func__, usb_speed_string(udev_speed));
636 mtu->g.speed = udev_speed;
637 mtu->g.ep0->maxpacket = maxpkt;
638 mtu->ep0_state = MU3D_EP0_STATE_SETUP;
640 if (udev_speed == USB_SPEED_UNKNOWN)
641 mtu3_gadget_disconnect(mtu);
642 else
643 mtu3_ep0_setup(mtu);
645 return IRQ_HANDLED;
648 static irqreturn_t mtu3_u3_ltssm_isr(struct mtu3 *mtu)
650 void __iomem *mbase = mtu->mac_base;
651 u32 ltssm;
653 ltssm = mtu3_readl(mbase, U3D_LTSSM_INTR);
654 ltssm &= mtu3_readl(mbase, U3D_LTSSM_INTR_ENABLE);
655 mtu3_writel(mbase, U3D_LTSSM_INTR, ltssm); /* W1C */
656 dev_dbg(mtu->dev, "=== LTSSM[%x] ===\n", ltssm);
658 if (ltssm & (HOT_RST_INTR | WARM_RST_INTR))
659 mtu3_gadget_reset(mtu);
661 if (ltssm & VBUS_FALL_INTR)
662 mtu3_ss_func_set(mtu, false);
664 if (ltssm & VBUS_RISE_INTR)
665 mtu3_ss_func_set(mtu, true);
667 if (ltssm & EXIT_U3_INTR)
668 mtu3_gadget_resume(mtu);
670 if (ltssm & ENTER_U3_INTR)
671 mtu3_gadget_suspend(mtu);
673 return IRQ_HANDLED;
676 static irqreturn_t mtu3_u2_common_isr(struct mtu3 *mtu)
678 void __iomem *mbase = mtu->mac_base;
679 u32 u2comm;
681 u2comm = mtu3_readl(mbase, U3D_COMMON_USB_INTR);
682 u2comm &= mtu3_readl(mbase, U3D_COMMON_USB_INTR_ENABLE);
683 mtu3_writel(mbase, U3D_COMMON_USB_INTR, u2comm); /* W1C */
684 dev_dbg(mtu->dev, "=== U2COMM[%x] ===\n", u2comm);
686 if (u2comm & SUSPEND_INTR)
687 mtu3_gadget_suspend(mtu);
689 if (u2comm & RESUME_INTR)
690 mtu3_gadget_resume(mtu);
692 if (u2comm & RESET_INTR)
693 mtu3_gadget_reset(mtu);
695 return IRQ_HANDLED;
698 static irqreturn_t mtu3_irq(int irq, void *data)
700 struct mtu3 *mtu = (struct mtu3 *)data;
701 unsigned long flags;
702 u32 level1;
704 spin_lock_irqsave(&mtu->lock, flags);
706 /* U3D_LV1ISR is RU */
707 level1 = mtu3_readl(mtu->mac_base, U3D_LV1ISR);
708 level1 &= mtu3_readl(mtu->mac_base, U3D_LV1IER);
710 if (level1 & EP_CTRL_INTR)
711 mtu3_link_isr(mtu);
713 if (level1 & MAC2_INTR)
714 mtu3_u2_common_isr(mtu);
716 if (level1 & MAC3_INTR)
717 mtu3_u3_ltssm_isr(mtu);
719 if (level1 & BMU_INTR)
720 mtu3_ep0_isr(mtu);
722 if (level1 & QMU_INTR)
723 mtu3_qmu_isr(mtu);
725 spin_unlock_irqrestore(&mtu->lock, flags);
727 return IRQ_HANDLED;
730 static int mtu3_hw_init(struct mtu3 *mtu)
732 u32 cap_dev;
733 int ret;
735 mtu->hw_version = mtu3_readl(mtu->ippc_base, U3D_SSUSB_HW_ID);
737 cap_dev = mtu3_readl(mtu->ippc_base, U3D_SSUSB_IP_DEV_CAP);
738 mtu->is_u3_ip = !!SSUSB_IP_DEV_U3_PORT_NUM(cap_dev);
740 dev_info(mtu->dev, "IP version 0x%x(%s IP)\n", mtu->hw_version,
741 mtu->is_u3_ip ? "U3" : "U2");
743 mtu3_device_reset(mtu);
745 ret = mtu3_device_enable(mtu);
746 if (ret) {
747 dev_err(mtu->dev, "device enable failed %d\n", ret);
748 return ret;
751 ret = mtu3_mem_alloc(mtu);
752 if (ret)
753 return -ENOMEM;
755 mtu3_regs_init(mtu);
757 return 0;
760 static void mtu3_hw_exit(struct mtu3 *mtu)
762 mtu3_device_disable(mtu);
763 mtu3_mem_free(mtu);
767 * we set 32-bit DMA mask by default, here check whether the controller
768 * supports 36-bit DMA or not, if it does, set 36-bit DMA mask.
770 static int mtu3_set_dma_mask(struct mtu3 *mtu)
772 struct device *dev = mtu->dev;
773 bool is_36bit = false;
774 int ret = 0;
775 u32 value;
777 value = mtu3_readl(mtu->mac_base, U3D_MISC_CTRL);
778 if (value & DMA_ADDR_36BIT) {
779 is_36bit = true;
780 ret = dma_set_mask_and_coherent(dev, DMA_BIT_MASK(36));
781 /* If set 36-bit DMA mask fails, fall back to 32-bit DMA mask */
782 if (ret) {
783 is_36bit = false;
784 ret = dma_set_mask_and_coherent(dev, DMA_BIT_MASK(32));
787 dev_info(dev, "dma mask: %s bits\n", is_36bit ? "36" : "32");
789 return ret;
792 int ssusb_gadget_init(struct ssusb_mtk *ssusb)
794 struct device *dev = ssusb->dev;
795 struct platform_device *pdev = to_platform_device(dev);
796 struct mtu3 *mtu = NULL;
797 struct resource *res;
798 int ret = -ENOMEM;
800 mtu = devm_kzalloc(dev, sizeof(struct mtu3), GFP_KERNEL);
801 if (mtu == NULL)
802 return -ENOMEM;
804 mtu->irq = platform_get_irq(pdev, 0);
805 if (mtu->irq < 0) {
806 dev_err(dev, "fail to get irq number\n");
807 return mtu->irq;
809 dev_info(dev, "irq %d\n", mtu->irq);
811 res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "mac");
812 mtu->mac_base = devm_ioremap_resource(dev, res);
813 if (IS_ERR(mtu->mac_base)) {
814 dev_err(dev, "error mapping memory for dev mac\n");
815 return PTR_ERR(mtu->mac_base);
818 spin_lock_init(&mtu->lock);
819 mtu->dev = dev;
820 mtu->ippc_base = ssusb->ippc_base;
821 ssusb->mac_base = mtu->mac_base;
822 ssusb->u3d = mtu;
823 mtu->ssusb = ssusb;
824 mtu->max_speed = usb_get_maximum_speed(dev);
826 /* check the max_speed parameter */
827 switch (mtu->max_speed) {
828 case USB_SPEED_FULL:
829 case USB_SPEED_HIGH:
830 case USB_SPEED_SUPER:
831 case USB_SPEED_SUPER_PLUS:
832 break;
833 default:
834 dev_err(dev, "invalid max_speed: %s\n",
835 usb_speed_string(mtu->max_speed));
836 /* fall through */
837 case USB_SPEED_UNKNOWN:
838 /* default as SSP */
839 mtu->max_speed = USB_SPEED_SUPER_PLUS;
840 break;
843 dev_dbg(dev, "mac_base=0x%p, ippc_base=0x%p\n",
844 mtu->mac_base, mtu->ippc_base);
846 ret = mtu3_hw_init(mtu);
847 if (ret) {
848 dev_err(dev, "mtu3 hw init failed:%d\n", ret);
849 return ret;
852 ret = mtu3_set_dma_mask(mtu);
853 if (ret) {
854 dev_err(dev, "mtu3 set dma_mask failed:%d\n", ret);
855 goto dma_mask_err;
858 ret = devm_request_irq(dev, mtu->irq, mtu3_irq, 0, dev_name(dev), mtu);
859 if (ret) {
860 dev_err(dev, "request irq %d failed!\n", mtu->irq);
861 goto irq_err;
864 device_init_wakeup(dev, true);
866 ret = mtu3_gadget_setup(mtu);
867 if (ret) {
868 dev_err(dev, "mtu3 gadget init failed:%d\n", ret);
869 goto gadget_err;
872 /* init as host mode, power down device IP for power saving */
873 if (mtu->ssusb->dr_mode == USB_DR_MODE_OTG)
874 mtu3_stop(mtu);
876 dev_dbg(dev, " %s() done...\n", __func__);
878 return 0;
880 gadget_err:
881 device_init_wakeup(dev, false);
883 dma_mask_err:
884 irq_err:
885 mtu3_hw_exit(mtu);
886 ssusb->u3d = NULL;
887 dev_err(dev, " %s() fail...\n", __func__);
889 return ret;
892 void ssusb_gadget_exit(struct ssusb_mtk *ssusb)
894 struct mtu3 *mtu = ssusb->u3d;
896 mtu3_gadget_cleanup(mtu);
897 device_init_wakeup(ssusb->dev, false);
898 mtu3_hw_exit(mtu);