1// SPDX-License-Identifier: GPL-2.0
2/*
3 * host.c - ChipIdea USB host controller driver
4 *
5 * Copyright (c) 2012 Intel Corporation
6 *
7 * Author: Alexander Shishkin
8 */
9
10#include <linux/kernel.h>
11#include <linux/io.h>
12#include <linux/usb.h>
13#include <linux/usb/hcd.h>
14#include <linux/usb/chipidea.h>
15#include <linux/regulator/consumer.h>
16#include <linux/pinctrl/consumer.h>
17
18#include "../host/ehci.h"
19
20#include "ci.h"
21#include "bits.h"
22#include "host.h"
23
24static struct hc_driver __read_mostly ci_ehci_hc_driver;
25static int (*orig_bus_suspend)(struct usb_hcd *hcd);
26
27struct ehci_ci_priv {
28	struct regulator *reg_vbus;
29	bool enabled;
30};
31
32struct ci_hdrc_dma_aligned_buffer {
33	void *original_buffer;
34	u8 data[];
35};
36
37static int ehci_ci_portpower(struct usb_hcd *hcd, int portnum, bool enable)
38{
39	struct ehci_hcd *ehci = hcd_to_ehci(hcd);
40	struct ehci_ci_priv *priv = (struct ehci_ci_priv *)ehci->priv;
41	struct device *dev = hcd->self.controller;
42	struct ci_hdrc *ci = dev_get_drvdata(dev);
43	int ret = 0;
44	int port = HCS_N_PORTS(ehci->hcs_params);
45
46	if (priv->reg_vbus && enable != priv->enabled) {
47		if (port > 1) {
48			dev_warn(dev,
49				"Not support multi-port regulator control\n");
50			return 0;
51		}
52		if (enable)
53			ret = regulator_enable(priv->reg_vbus);
54		else
55			ret = regulator_disable(priv->reg_vbus);
56		if (ret) {
57			dev_err(dev,
58				"Failed to %s vbus regulator, ret=%d\n",
59				enable ? "enable" : "disable", ret);
60			return ret;
61		}
62		priv->enabled = enable;
63	}
64
65	if (ci->platdata->flags & CI_HDRC_PHY_VBUS_CONTROL) {
66		if (enable)
67			usb_phy_vbus_on(ci->usb_phy);
68		else
69			usb_phy_vbus_off(ci->usb_phy);
70	}
71
72	if (enable && (ci->platdata->phy_mode == USBPHY_INTERFACE_MODE_HSIC)) {
73		/*
74		 * Marvell 28nm HSIC PHY requires forcing the port to HS mode.
75		 * As HSIC is always HS, this should be safe for others.
76		 */
77		hw_port_test_set(ci, 5);
78		hw_port_test_set(ci, 0);
79	}
80	return 0;
81};
82
83static int ehci_ci_reset(struct usb_hcd *hcd)
84{
85	struct device *dev = hcd->self.controller;
86	struct ci_hdrc *ci = dev_get_drvdata(dev);
87	struct ehci_hcd *ehci = hcd_to_ehci(hcd);
88	int ret;
89
90	ret = ehci_setup(hcd);
91	if (ret)
92		return ret;
93
94	ehci->need_io_watchdog = 0;
95
96	if (ci->platdata->notify_event) {
97		ret = ci->platdata->notify_event(ci,
98				CI_HDRC_CONTROLLER_RESET_EVENT);
99		if (ret)
100			return ret;
101	}
102
103	ci_platform_configure(ci);
104
105	return ret;
106}
107
108static const struct ehci_driver_overrides ehci_ci_overrides = {
109	.extra_priv_size = sizeof(struct ehci_ci_priv),
110	.port_power	 = ehci_ci_portpower,
111	.reset		 = ehci_ci_reset,
112};
113
114static irqreturn_t host_irq(struct ci_hdrc *ci)
115{
116	return usb_hcd_irq(ci->irq, ci->hcd);
117}
118
119static int host_start(struct ci_hdrc *ci)
120{
121	struct usb_hcd *hcd;
122	struct ehci_hcd *ehci;
123	struct ehci_ci_priv *priv;
124	int ret;
125
126	if (usb_disabled())
127		return -ENODEV;
128
129	hcd = __usb_create_hcd(&ci_ehci_hc_driver, ci->dev->parent,
130			       ci->dev, dev_name(ci->dev), NULL);
131	if (!hcd)
132		return -ENOMEM;
133
134	dev_set_drvdata(ci->dev, ci);
135	hcd->rsrc_start = ci->hw_bank.phys;
136	hcd->rsrc_len = ci->hw_bank.size;
137	hcd->regs = ci->hw_bank.abs;
138	hcd->has_tt = 1;
139
140	hcd->power_budget = ci->platdata->power_budget;
141	hcd->tpl_support = ci->platdata->tpl_support;
142	if (ci->phy || ci->usb_phy) {
143		hcd->skip_phy_initialization = 1;
144		if (ci->usb_phy)
145			hcd->usb_phy = ci->usb_phy;
146	}
147
148	ehci = hcd_to_ehci(hcd);
149	ehci->caps = ci->hw_bank.cap;
150	ehci->has_hostpc = ci->hw_bank.lpm;
151	ehci->has_tdi_phy_lpm = ci->hw_bank.lpm;
152	ehci->imx28_write_fix = ci->imx28_write_fix;
153	ehci->has_ci_pec_bug = ci->has_portsc_pec_bug;
154
155	priv = (struct ehci_ci_priv *)ehci->priv;
156	priv->reg_vbus = NULL;
157
158	if (ci->platdata->reg_vbus && !ci_otg_is_fsm_mode(ci)) {
159		if (ci->platdata->flags & CI_HDRC_TURN_VBUS_EARLY_ON) {
160			ret = regulator_enable(ci->platdata->reg_vbus);
161			if (ret) {
162				dev_err(ci->dev,
163				"Failed to enable vbus regulator, ret=%d\n",
164									ret);
165				goto put_hcd;
166			}
167		} else {
168			priv->reg_vbus = ci->platdata->reg_vbus;
169		}
170	}
171
172	if (ci->platdata->pins_host)
173		pinctrl_select_state(ci->platdata->pctl,
174				     ci->platdata->pins_host);
175
176	ci->hcd = hcd;
177
178	ret = usb_add_hcd(hcd, 0, 0);
179	if (ret) {
180		ci->hcd = NULL;
181		goto disable_reg;
182	} else {
183		struct usb_otg *otg = &ci->otg;
184
185		if (ci_otg_is_fsm_mode(ci)) {
186			otg->host = &hcd->self;
187			hcd->self.otg_port = 1;
188		}
189
190		if (ci->platdata->notify_event &&
191			(ci->platdata->flags & CI_HDRC_IMX_IS_HSIC))
192			ci->platdata->notify_event
193				(ci, CI_HDRC_IMX_HSIC_ACTIVE_EVENT);
194	}
195
196	return ret;
197
198disable_reg:
199	if (ci->platdata->reg_vbus && !ci_otg_is_fsm_mode(ci) &&
200			(ci->platdata->flags & CI_HDRC_TURN_VBUS_EARLY_ON))
201		regulator_disable(ci->platdata->reg_vbus);
202put_hcd:
203	usb_put_hcd(hcd);
204
205	return ret;
206}
207
208static void host_stop(struct ci_hdrc *ci)
209{
210	struct usb_hcd *hcd = ci->hcd;
211
212	if (hcd) {
213		if (ci->platdata->notify_event)
214			ci->platdata->notify_event(ci,
215				CI_HDRC_CONTROLLER_STOPPED_EVENT);
216		usb_remove_hcd(hcd);
217		ci->role = CI_ROLE_END;
218		synchronize_irq(ci->irq);
219		usb_put_hcd(hcd);
220		if (ci->platdata->reg_vbus && !ci_otg_is_fsm_mode(ci) &&
221			(ci->platdata->flags & CI_HDRC_TURN_VBUS_EARLY_ON))
222				regulator_disable(ci->platdata->reg_vbus);
223	}
224	ci->hcd = NULL;
225	ci->otg.host = NULL;
226
227	if (ci->platdata->pins_host && ci->platdata->pins_default)
228		pinctrl_select_state(ci->platdata->pctl,
229				     ci->platdata->pins_default);
230}
231
232
233void ci_hdrc_host_destroy(struct ci_hdrc *ci)
234{
235	if (ci->role == CI_ROLE_HOST && ci->hcd)
236		host_stop(ci);
237}
238
239/* The below code is based on tegra ehci driver */
240static int ci_ehci_hub_control(
241	struct usb_hcd	*hcd,
242	u16		typeReq,
243	u16		wValue,
244	u16		wIndex,
245	char		*buf,
246	u16		wLength
247)
248{
249	struct ehci_hcd	*ehci = hcd_to_ehci(hcd);
250	unsigned int	ports = HCS_N_PORTS(ehci->hcs_params);
251	u32 __iomem	*status_reg;
252	u32		temp, port_index;
253	unsigned long	flags;
254	int		retval = 0;
255	bool		done = false;
256	struct device *dev = hcd->self.controller;
257	struct ci_hdrc *ci = dev_get_drvdata(dev);
258
259	port_index = wIndex & 0xff;
260	port_index -= (port_index > 0);
261	status_reg = &ehci->regs->port_status[port_index];
262
263	spin_lock_irqsave(&ehci->lock, flags);
264
265	if (ci->platdata->hub_control) {
266		retval = ci->platdata->hub_control(ci, typeReq, wValue, wIndex,
267						   buf, wLength, &done, &flags);
268		if (done)
269			goto done;
270	}
271
272	if (typeReq == SetPortFeature && wValue == USB_PORT_FEAT_SUSPEND) {
273		if (!wIndex || wIndex > ports) {
274			retval = -EPIPE;
275			goto done;
276		}
277
278		temp = ehci_readl(ehci, status_reg);
279		if ((temp & PORT_PE) == 0 || (temp & PORT_RESET) != 0) {
280			retval = -EPIPE;
281			goto done;
282		}
283
284		temp &= ~(PORT_RWC_BITS | PORT_WKCONN_E);
285		temp |= PORT_WKDISC_E | PORT_WKOC_E;
286		ehci_writel(ehci, temp | PORT_SUSPEND, status_reg);
287
288		/*
289		 * If a transaction is in progress, there may be a delay in
290		 * suspending the port. Poll until the port is suspended.
291		 */
292		if (ehci_handshake(ehci, status_reg, PORT_SUSPEND,
293			PORT_SUSPEND, 5000))
294			ehci_err(ehci, "timeout waiting for SUSPEND\n");
295
296		if (ci->platdata->flags & CI_HDRC_IMX_IS_HSIC) {
297			if (ci->platdata->notify_event)
298				ci->platdata->notify_event(ci,
299					CI_HDRC_IMX_HSIC_SUSPEND_EVENT);
300
301			temp = ehci_readl(ehci, status_reg);
302			temp &= ~(PORT_WKDISC_E | PORT_WKCONN_E);
303			ehci_writel(ehci, temp, status_reg);
304		}
305
306		set_bit(port_index, &ehci->suspended_ports);
307		goto done;
308	}
309
310	/*
311	 * After resume has finished, it needs do some post resume
312	 * operation for some SoCs.
313	 */
314	else if (typeReq == ClearPortFeature &&
315		wValue == USB_PORT_FEAT_C_SUSPEND) {
316		/* Make sure the resume has finished, it should be finished */
317		if (ehci_handshake(ehci, status_reg, PORT_RESUME, 0, 25000))
318			ehci_err(ehci, "timeout waiting for resume\n");
319	}
320
321	spin_unlock_irqrestore(&ehci->lock, flags);
322
323	/* Handle the hub control events here */
324	return ehci_hub_control(hcd, typeReq, wValue, wIndex, buf, wLength);
325done:
326	spin_unlock_irqrestore(&ehci->lock, flags);
327	return retval;
328}
329static int ci_ehci_bus_suspend(struct usb_hcd *hcd)
330{
331	struct ehci_hcd *ehci = hcd_to_ehci(hcd);
332	struct device *dev = hcd->self.controller;
333	struct ci_hdrc *ci = dev_get_drvdata(dev);
334	int port;
335	u32 tmp;
336
337	int ret = orig_bus_suspend(hcd);
338
339	if (ret)
340		return ret;
341
342	port = HCS_N_PORTS(ehci->hcs_params);
343	while (port--) {
344		u32 __iomem *reg = &ehci->regs->port_status[port];
345		u32 portsc = ehci_readl(ehci, reg);
346
347		if (portsc & PORT_CONNECT) {
348			/*
349			 * For chipidea, the resume signal will be ended
350			 * automatically, so for remote wakeup case, the
351			 * usbcmd.rs may not be set before the resume has
352			 * ended if other resume paths consumes too much
353			 * time (~24ms), in that case, the SOF will not
354			 * send out within 3ms after resume ends, then the
355			 * high speed device will enter full speed mode.
356			 */
357
358			tmp = ehci_readl(ehci, &ehci->regs->command);
359			tmp |= CMD_RUN;
360			ehci_writel(ehci, tmp, &ehci->regs->command);
361			/*
362			 * It needs a short delay between set RS bit and PHCD.
363			 */
364			usleep_range(150, 200);
365			/*
366			 * Need to clear WKCN and WKOC for imx HSIC,
367			 * otherwise, there will be wakeup event.
368			 */
369			if (ci->platdata->flags & CI_HDRC_IMX_IS_HSIC) {
370				tmp = ehci_readl(ehci, reg);
371				tmp &= ~(PORT_WKDISC_E | PORT_WKCONN_E);
372				ehci_writel(ehci, tmp, reg);
373			}
374
375			break;
376		}
377	}
378
379	return 0;
380}
381
382static void ci_hdrc_free_dma_aligned_buffer(struct urb *urb, bool copy_back)
383{
384	struct ci_hdrc_dma_aligned_buffer *temp;
385
386	if (!(urb->transfer_flags & URB_ALIGNED_TEMP_BUFFER))
387		return;
388	urb->transfer_flags &= ~URB_ALIGNED_TEMP_BUFFER;
389
390	temp = container_of(urb->transfer_buffer,
391			    struct ci_hdrc_dma_aligned_buffer, data);
392	urb->transfer_buffer = temp->original_buffer;
393
394	if (copy_back && usb_urb_dir_in(urb)) {
395		size_t length;
396
397		if (usb_pipeisoc(urb->pipe))
398			length = urb->transfer_buffer_length;
399		else
400			length = urb->actual_length;
401
402		memcpy(temp->original_buffer, temp->data, length);
403	}
404
405	kfree(temp);
406}
407
408static int ci_hdrc_alloc_dma_aligned_buffer(struct urb *urb, gfp_t mem_flags)
409{
410	struct ci_hdrc_dma_aligned_buffer *temp;
411
412	if (urb->num_sgs || urb->sg || urb->transfer_buffer_length == 0)
413		return 0;
414	if (IS_ALIGNED((uintptr_t)urb->transfer_buffer, 4)
415	    && IS_ALIGNED(urb->transfer_buffer_length, 4))
416		return 0;
417
418	temp = kmalloc(sizeof(*temp) + ALIGN(urb->transfer_buffer_length, 4), mem_flags);
419	if (!temp)
420		return -ENOMEM;
421
422	if (usb_urb_dir_out(urb))
423		memcpy(temp->data, urb->transfer_buffer,
424		       urb->transfer_buffer_length);
425
426	temp->original_buffer = urb->transfer_buffer;
427	urb->transfer_buffer = temp->data;
428	urb->transfer_flags |= URB_ALIGNED_TEMP_BUFFER;
429
430	return 0;
431}
432
433static int ci_hdrc_map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb,
434				   gfp_t mem_flags)
435{
436	int ret;
437
438	ret = ci_hdrc_alloc_dma_aligned_buffer(urb, mem_flags);
439	if (ret)
440		return ret;
441
442	ret = usb_hcd_map_urb_for_dma(hcd, urb, mem_flags);
443	if (ret)
444		ci_hdrc_free_dma_aligned_buffer(urb, false);
445
446	return ret;
447}
448
449static void ci_hdrc_unmap_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
450{
451	usb_hcd_unmap_urb_for_dma(hcd, urb);
452	ci_hdrc_free_dma_aligned_buffer(urb, true);
453}
454
455#ifdef CONFIG_PM_SLEEP
456static void ci_hdrc_host_suspend(struct ci_hdrc *ci)
457{
458	ehci_suspend(ci->hcd, device_may_wakeup(ci->dev));
459}
460
461static void ci_hdrc_host_resume(struct ci_hdrc *ci, bool power_lost)
462{
463	ehci_resume(ci->hcd, power_lost);
464}
465#endif
466
467int ci_hdrc_host_init(struct ci_hdrc *ci)
468{
469	struct ci_role_driver *rdrv;
470
471	if (!hw_read(ci, CAP_DCCPARAMS, DCCPARAMS_HC))
472		return -ENXIO;
473
474	rdrv = devm_kzalloc(ci->dev, sizeof(struct ci_role_driver), GFP_KERNEL);
475	if (!rdrv)
476		return -ENOMEM;
477
478	rdrv->start	= host_start;
479	rdrv->stop	= host_stop;
480#ifdef CONFIG_PM_SLEEP
481	rdrv->suspend	= ci_hdrc_host_suspend;
482	rdrv->resume	= ci_hdrc_host_resume;
483#endif
484	rdrv->irq	= host_irq;
485	rdrv->name	= "host";
486	ci->roles[CI_ROLE_HOST] = rdrv;
487
488	if (ci->platdata->flags & CI_HDRC_REQUIRES_ALIGNED_DMA) {
489		ci_ehci_hc_driver.map_urb_for_dma = ci_hdrc_map_urb_for_dma;
490		ci_ehci_hc_driver.unmap_urb_for_dma = ci_hdrc_unmap_urb_for_dma;
491	}
492
493	return 0;
494}
495
496void ci_hdrc_host_driver_init(void)
497{
498	ehci_init_driver(&ci_ehci_hc_driver, &ehci_ci_overrides);
499	orig_bus_suspend = ci_ehci_hc_driver.bus_suspend;
500	ci_ehci_hc_driver.bus_suspend = ci_ehci_bus_suspend;
501	ci_ehci_hc_driver.hub_control = ci_ehci_hub_control;
502}
503