4 * Copyright (C) 2011 Renesas Solutions Corp.
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 * GNU General Public License for more details.
12 * You should have received a copy of the GNU General Public License
13 * along with this program; if not, write to the Free Software
14 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18 #include <linux/list.h>
19 #include <linux/module.h>
20 #include <linux/platform_device.h>
21 #include <linux/slab.h>
22 #include <linux/usb.h>
23 #include <linux/usb/hcd.h>
27 *** HARDWARE LIMITATION ***
29 * 1) renesas_usbhs has a limited number of controllable devices.
30 * it can control only 9 devices in generally.
31 * see DEVADDn / DCPMAXP / PIPEMAXP.
33 * 2) renesas_usbhs pipe number is limited.
34 * the pipe will be re-used for each devices.
35 * so, software should control DATA0/1 sequence of each devices.
43 * | udev 0 | --> it is used when set address
46 * +--------+ pipes are reused for each uep.
47 * | udev 1 |-+- [uep 0 (dcp) ] --+ pipe will be switched when
48 * +--------+ | | other device requested
49 * +- [uep 1 (bulk)] --|---+ +--------------+
50 * | +--------------> | pipe0 (dcp) |
51 * +- [uep 2 (bulk)] -@ | +--------------+
53 * +--------+ | +--------------+
54 * | udev 2 |-+- [uep 0 (dcp) ] -@ +----------> | pipe2 (bulk) |
55 * +--------+ | +--------------+
56 * +- [uep 1 (int) ] ----+ +------> | pipe3 (bulk) |
57 * | | +--------------+
58 * +--------+ +-----|------> | pipe4 (int) |
59 * | udev 3 |-+- [uep 0 (dcp) ] -@ | +--------------+
60 * +--------+ | | | .... |
61 * +- [uep 1 (bulk)] -@ | | .... |
63 * +- [uep 2 (bulk)]-----------+
65 * @ : uep requested free pipe, but all have been used.
66 * now it is waiting for free pipe
73 struct usbhsh_request {
78 struct usbhsh_device {
79 struct usb_device *usbv;
80 struct list_head ep_list_head; /* list of usbhsh_ep */
84 struct usbhs_pipe *pipe; /* attached pipe */
85 struct usbhsh_device *udev; /* attached udev */
86 struct usb_host_endpoint *ep;
87 struct list_head ep_list; /* list to usbhsh_device */
88 unsigned int counter; /* pipe attach counter */
91 #define USBHSH_DEVICE_MAX 10 /* see DEVADDn / DCPMAXP / PIPEMAXP */
92 #define USBHSH_PORT_MAX 7 /* see DEVADDn :: HUBPORT */
95 struct usbhs_pipe *dcp;
97 struct usbhsh_device udev[USBHSH_DEVICE_MAX];
99 u32 port_stat; /* USB_PORT_STAT_xxx */
101 struct completion setup_ack_done;
105 static const char usbhsh_hcd_name[] = "renesas_usbhs host";
110 #define usbhsh_priv_to_hpriv(priv) \
111 container_of(usbhs_mod_get(priv, USBHS_HOST), struct usbhsh_hpriv, mod)
113 #define __usbhsh_for_each_udev(start, pos, h, i) \
115 ((i) < USBHSH_DEVICE_MAX) && ((pos) = (h)->udev + (i)); \
118 #define usbhsh_for_each_udev(pos, hpriv, i) \
119 __usbhsh_for_each_udev(1, pos, hpriv, i)
121 #define usbhsh_for_each_udev_with_dev0(pos, hpriv, i) \
122 __usbhsh_for_each_udev(0, pos, hpriv, i)
124 #define usbhsh_hcd_to_hpriv(h) (struct usbhsh_hpriv *)((h)->hcd_priv)
125 #define usbhsh_hcd_to_dev(h) ((h)->self.controller)
127 #define usbhsh_hpriv_to_priv(h) ((h)->mod.priv)
128 #define usbhsh_hpriv_to_dcp(h) ((h)->dcp)
129 #define usbhsh_hpriv_to_hcd(h) \
130 container_of((void *)h, struct usb_hcd, hcd_priv)
132 #define usbhsh_ep_to_uep(u) ((u)->hcpriv)
133 #define usbhsh_uep_to_pipe(u) ((u)->pipe)
134 #define usbhsh_uep_to_udev(u) ((u)->udev)
135 #define usbhsh_uep_to_ep(u) ((u)->ep)
137 #define usbhsh_urb_to_ureq(u) ((u)->hcpriv)
138 #define usbhsh_urb_to_usbv(u) ((u)->dev)
140 #define usbhsh_usbv_to_udev(d) dev_get_drvdata(&(d)->dev)
142 #define usbhsh_udev_to_usbv(h) ((h)->usbv)
143 #define usbhsh_udev_is_used(h) usbhsh_udev_to_usbv(h)
145 #define usbhsh_pipe_to_uep(p) ((p)->mod_private)
147 #define usbhsh_device_parent(d) (usbhsh_usbv_to_udev((d)->usbv->parent))
148 #define usbhsh_device_hubport(d) ((d)->usbv->portnum)
149 #define usbhsh_device_number(h, d) ((int)((d) - (h)->udev))
150 #define usbhsh_device_nth(h, d) ((h)->udev + d)
151 #define usbhsh_device0(h) usbhsh_device_nth(h, 0)
153 #define usbhsh_port_stat_init(h) ((h)->port_stat = 0)
154 #define usbhsh_port_stat_set(h, s) ((h)->port_stat |= (s))
155 #define usbhsh_port_stat_clear(h, s) ((h)->port_stat &= ~(s))
156 #define usbhsh_port_stat_get(h) ((h)->port_stat)
158 #define usbhsh_pkt_to_ureq(p) \
159 container_of((void *)p, struct usbhsh_request, pkt)
164 static struct usbhsh_request *usbhsh_ureq_alloc(struct usbhsh_hpriv *hpriv,
168 struct usbhsh_request *ureq;
170 ureq = kzalloc(sizeof(struct usbhsh_request), mem_flags);
174 usbhs_pkt_init(&ureq->pkt);
176 usbhsh_urb_to_ureq(urb) = ureq;
181 static void usbhsh_ureq_free(struct usbhsh_hpriv *hpriv,
182 struct usbhsh_request *ureq)
184 usbhsh_urb_to_ureq(ureq->urb) = NULL;
193 static int usbhsh_is_running(struct usbhsh_hpriv *hpriv)
196 * we can decide some device is attached or not
197 * by checking mod.irq_attch
202 return (hpriv->mod.irq_attch == NULL);
208 static void usbhsh_endpoint_sequence_save(struct usbhsh_hpriv *hpriv,
210 struct usbhs_pkt *pkt)
212 int len = urb->actual_length;
213 int maxp = usb_endpoint_maxp(&urb->ep->desc);
216 /* DCP is out of sequence control */
217 if (usb_pipecontrol(urb->pipe))
221 * renesas_usbhs pipe has a limitation in a number.
222 * So, driver should re-use the limited pipe for each device/endpoint.
223 * DATA0/1 sequence should be saved for it.
224 * see [image of mod_host]
225 * [HARDWARE LIMITATION]
229 * next sequence depends on actual_length
231 * ex) actual_length = 1147, maxp = 512
235 * data1 is the next sequence
245 usb_dotoggle(urb->dev,
246 usb_pipeendpoint(urb->pipe),
247 usb_pipeout(urb->pipe));
250 static struct usbhsh_device *usbhsh_device_get(struct usbhsh_hpriv *hpriv,
253 static int usbhsh_pipe_attach(struct usbhsh_hpriv *hpriv,
256 struct usbhs_priv *priv = usbhsh_hpriv_to_priv(hpriv);
257 struct usbhsh_ep *uep = usbhsh_ep_to_uep(urb->ep);
258 struct usbhsh_device *udev = usbhsh_device_get(hpriv, urb);
259 struct usbhs_pipe *pipe;
260 struct usb_endpoint_descriptor *desc = &urb->ep->desc;
261 struct device *dev = usbhs_priv_to_dev(priv);
263 int dir_in_req = !!usb_pipein(urb->pipe);
264 int is_dcp = usb_endpoint_xfer_control(desc);
268 /******************** spin lock ********************/
269 usbhs_lock(priv, flags);
272 * if uep has been attached to pipe,
275 if (usbhsh_uep_to_pipe(uep)) {
277 goto usbhsh_pipe_attach_done;
280 usbhs_for_each_pipe_with_dcp(pipe, priv, i) {
282 /* check pipe type */
283 if (!usbhs_pipe_type_is(pipe, usb_endpoint_type(desc)))
286 /* check pipe direction if normal pipe */
288 dir_in = !!usbhs_pipe_is_dir_in(pipe);
289 if (0 != (dir_in - dir_in_req))
293 /* check pipe is free */
294 if (usbhsh_pipe_to_uep(pipe))
300 * usbhs_pipe_config_update() should be called after
301 * usbhs_set_device_config()
305 usbhsh_uep_to_pipe(uep) = pipe;
306 usbhsh_pipe_to_uep(pipe) = uep;
308 usbhs_pipe_config_update(pipe,
309 usbhsh_device_number(hpriv, udev),
310 usb_endpoint_num(desc),
311 usb_endpoint_maxp(desc));
313 dev_dbg(dev, "%s [%d-%d(%s:%s)]\n", __func__,
314 usbhsh_device_number(hpriv, udev),
315 usb_endpoint_num(desc),
316 usbhs_pipe_name(pipe),
317 dir_in_req ? "in" : "out");
323 usbhsh_pipe_attach_done:
327 usbhs_unlock(priv, flags);
328 /******************** spin unlock ******************/
333 static void usbhsh_pipe_detach(struct usbhsh_hpriv *hpriv,
334 struct usbhsh_ep *uep)
336 struct usbhs_priv *priv = usbhsh_hpriv_to_priv(hpriv);
337 struct usbhs_pipe *pipe;
338 struct device *dev = usbhs_priv_to_dev(priv);
341 if (unlikely(!uep)) {
342 dev_err(dev, "no uep\n");
346 /******************** spin lock ********************/
347 usbhs_lock(priv, flags);
349 pipe = usbhsh_uep_to_pipe(uep);
351 if (unlikely(!pipe)) {
352 dev_err(dev, "uep doens't have pipe\n");
353 } else if (1 == uep->counter--) { /* last user */
354 struct usb_host_endpoint *ep = usbhsh_uep_to_ep(uep);
355 struct usbhsh_device *udev = usbhsh_uep_to_udev(uep);
357 /* detach pipe from uep */
358 usbhsh_uep_to_pipe(uep) = NULL;
359 usbhsh_pipe_to_uep(pipe) = NULL;
361 dev_dbg(dev, "%s [%d-%d(%s)]\n", __func__,
362 usbhsh_device_number(hpriv, udev),
363 usb_endpoint_num(&ep->desc),
364 usbhs_pipe_name(pipe));
367 usbhs_unlock(priv, flags);
368 /******************** spin unlock ******************/
374 static int usbhsh_endpoint_attach(struct usbhsh_hpriv *hpriv,
378 struct usbhs_priv *priv = usbhsh_hpriv_to_priv(hpriv);
379 struct usbhsh_device *udev = usbhsh_device_get(hpriv, urb);
380 struct usb_host_endpoint *ep = urb->ep;
381 struct usbhsh_ep *uep;
382 struct device *dev = usbhs_priv_to_dev(priv);
383 struct usb_endpoint_descriptor *desc = &ep->desc;
386 uep = kzalloc(sizeof(struct usbhsh_ep), mem_flags);
390 /******************** spin lock ********************/
391 usbhs_lock(priv, flags);
397 INIT_LIST_HEAD(&uep->ep_list);
398 list_add_tail(&uep->ep_list, &udev->ep_list_head);
400 usbhsh_uep_to_udev(uep) = udev;
401 usbhsh_uep_to_ep(uep) = ep;
402 usbhsh_ep_to_uep(ep) = uep;
404 usbhs_unlock(priv, flags);
405 /******************** spin unlock ******************/
407 dev_dbg(dev, "%s [%d-%d]\n", __func__,
408 usbhsh_device_number(hpriv, udev),
409 usb_endpoint_num(desc));
414 static void usbhsh_endpoint_detach(struct usbhsh_hpriv *hpriv,
415 struct usb_host_endpoint *ep)
417 struct usbhs_priv *priv = usbhsh_hpriv_to_priv(hpriv);
418 struct device *dev = usbhs_priv_to_dev(priv);
419 struct usbhsh_ep *uep = usbhsh_ep_to_uep(ep);
425 dev_dbg(dev, "%s [%d-%d]\n", __func__,
426 usbhsh_device_number(hpriv, usbhsh_uep_to_udev(uep)),
427 usb_endpoint_num(&ep->desc));
429 if (usbhsh_uep_to_pipe(uep))
430 usbhsh_pipe_detach(hpriv, uep);
432 /******************** spin lock ********************/
433 usbhs_lock(priv, flags);
435 /* remove this endpoint from udev */
436 list_del_init(&uep->ep_list);
438 usbhsh_uep_to_udev(uep) = NULL;
439 usbhsh_uep_to_ep(uep) = NULL;
440 usbhsh_ep_to_uep(ep) = NULL;
442 usbhs_unlock(priv, flags);
443 /******************** spin unlock ******************/
448 static void usbhsh_endpoint_detach_all(struct usbhsh_hpriv *hpriv,
449 struct usbhsh_device *udev)
451 struct usbhsh_ep *uep, *next;
453 list_for_each_entry_safe(uep, next, &udev->ep_list_head, ep_list)
454 usbhsh_endpoint_detach(hpriv, usbhsh_uep_to_ep(uep));
460 static int usbhsh_connected_to_rhdev(struct usb_hcd *hcd,
461 struct usbhsh_device *udev)
463 struct usb_device *usbv = usbhsh_udev_to_usbv(udev);
465 return hcd->self.root_hub == usbv->parent;
468 static int usbhsh_device_has_endpoint(struct usbhsh_device *udev)
470 return !list_empty(&udev->ep_list_head);
473 static struct usbhsh_device *usbhsh_device_get(struct usbhsh_hpriv *hpriv,
476 struct usb_device *usbv = usbhsh_urb_to_usbv(urb);
477 struct usbhsh_device *udev = usbhsh_usbv_to_udev(usbv);
479 /* usbhsh_device_attach() is still not called */
483 /* if it is device0, return it */
484 if (0 == usb_pipedevice(urb->pipe))
485 return usbhsh_device0(hpriv);
487 /* return attached device */
491 static struct usbhsh_device *usbhsh_device_attach(struct usbhsh_hpriv *hpriv,
494 struct usbhsh_device *udev = NULL;
495 struct usbhsh_device *udev0 = usbhsh_device0(hpriv);
496 struct usbhsh_device *pos;
497 struct usb_hcd *hcd = usbhsh_hpriv_to_hcd(hpriv);
498 struct device *dev = usbhsh_hcd_to_dev(hcd);
499 struct usb_device *usbv = usbhsh_urb_to_usbv(urb);
500 struct usbhs_priv *priv = usbhsh_hpriv_to_priv(hpriv);
506 * This function should be called only while urb is pointing to device0.
507 * It will attach unused usbhsh_device to urb (usbv),
508 * and initialize device0.
509 * You can use usbhsh_device_get() to get "current" udev,
510 * and usbhsh_usbv_to_udev() is for "attached" udev.
512 if (0 != usb_pipedevice(urb->pipe)) {
513 dev_err(dev, "%s fail: urb isn't pointing device0\n", __func__);
517 /******************** spin lock ********************/
518 usbhs_lock(priv, flags);
523 usbhsh_for_each_udev(pos, hpriv, i) {
524 if (usbhsh_udev_is_used(pos))
532 * usbhsh_usbv_to_udev()
533 * usbhsh_udev_to_usbv()
536 dev_set_drvdata(&usbv->dev, udev);
540 usbhs_unlock(priv, flags);
541 /******************** spin unlock ******************/
544 dev_err(dev, "no free usbhsh_device\n");
548 if (usbhsh_device_has_endpoint(udev)) {
549 dev_warn(dev, "udev have old endpoint\n");
550 usbhsh_endpoint_detach_all(hpriv, udev);
553 if (usbhsh_device_has_endpoint(udev0)) {
554 dev_warn(dev, "udev0 have old endpoint\n");
555 usbhsh_endpoint_detach_all(hpriv, udev0);
558 /* uep will be attached */
559 INIT_LIST_HEAD(&udev0->ep_list_head);
560 INIT_LIST_HEAD(&udev->ep_list_head);
565 usbhs_set_device_config(priv,
566 0, 0, 0, usbv->speed);
569 * set new device config
573 if (!usbhsh_connected_to_rhdev(hcd, udev)) {
574 /* if udev is not connected to rhdev, it means parent is Hub */
575 struct usbhsh_device *parent = usbhsh_device_parent(udev);
577 upphub = usbhsh_device_number(hpriv, parent);
578 hubport = usbhsh_device_hubport(udev);
580 dev_dbg(dev, "%s connecte to Hub [%d:%d](%p)\n", __func__,
581 upphub, hubport, parent);
584 usbhs_set_device_config(priv,
585 usbhsh_device_number(hpriv, udev),
586 upphub, hubport, usbv->speed);
588 dev_dbg(dev, "%s [%d](%p)\n", __func__,
589 usbhsh_device_number(hpriv, udev), udev);
594 static void usbhsh_device_detach(struct usbhsh_hpriv *hpriv,
595 struct usbhsh_device *udev)
597 struct usb_hcd *hcd = usbhsh_hpriv_to_hcd(hpriv);
598 struct usbhs_priv *priv = usbhsh_hpriv_to_priv(hpriv);
599 struct device *dev = usbhsh_hcd_to_dev(hcd);
600 struct usb_device *usbv = usbhsh_udev_to_usbv(udev);
603 dev_dbg(dev, "%s [%d](%p)\n", __func__,
604 usbhsh_device_number(hpriv, udev), udev);
606 if (usbhsh_device_has_endpoint(udev)) {
607 dev_warn(dev, "udev still have endpoint\n");
608 usbhsh_endpoint_detach_all(hpriv, udev);
612 * There is nothing to do if it is device0.
614 * usbhsh_device_attach()
615 * usbhsh_device_get()
617 if (0 == usbhsh_device_number(hpriv, udev))
620 /******************** spin lock ********************/
621 usbhs_lock(priv, flags);
624 * usbhsh_usbv_to_udev()
625 * usbhsh_udev_to_usbv()
628 dev_set_drvdata(&usbv->dev, NULL);
631 usbhs_unlock(priv, flags);
632 /******************** spin unlock ******************/
638 static void usbhsh_queue_done(struct usbhs_priv *priv, struct usbhs_pkt *pkt)
640 struct usbhsh_request *ureq = usbhsh_pkt_to_ureq(pkt);
641 struct usbhsh_hpriv *hpriv = usbhsh_priv_to_hpriv(priv);
642 struct usb_hcd *hcd = usbhsh_hpriv_to_hcd(hpriv);
643 struct urb *urb = ureq->urb;
644 struct device *dev = usbhs_priv_to_dev(priv);
647 dev_dbg(dev, "%s\n", __func__);
650 dev_warn(dev, "pkt doesn't have urb\n");
654 if (!usbhsh_is_running(hpriv))
657 urb->actual_length = pkt->actual;
659 usbhsh_endpoint_sequence_save(hpriv, urb, pkt);
660 usbhsh_ureq_free(hpriv, ureq);
662 usbhsh_pipe_detach(hpriv, usbhsh_ep_to_uep(urb->ep));
664 usb_hcd_unlink_urb_from_ep(hcd, urb);
665 usb_hcd_giveback_urb(hcd, urb, status);
668 static int usbhsh_queue_push(struct usb_hcd *hcd,
672 struct usbhsh_hpriv *hpriv = usbhsh_hcd_to_hpriv(hcd);
673 struct usbhsh_ep *uep = usbhsh_ep_to_uep(urb->ep);
674 struct usbhs_pipe *pipe = usbhsh_uep_to_pipe(uep);
675 struct device *dev = usbhsh_hcd_to_dev(hcd);
676 struct usbhsh_request *ureq;
680 if (usb_pipeisoc(urb->pipe)) {
681 dev_err(dev, "pipe iso is not supported now\n");
685 /* this ureq will be freed on usbhsh_queue_done() */
686 ureq = usbhsh_ureq_alloc(hpriv, urb, mem_flags);
687 if (unlikely(!ureq)) {
688 dev_err(dev, "ureq alloc fail\n");
692 if (usb_pipein(urb->pipe))
693 pipe->handler = &usbhs_fifo_dma_pop_handler;
695 pipe->handler = &usbhs_fifo_dma_push_handler;
697 buf = (void *)(urb->transfer_buffer + urb->actual_length);
698 len = urb->transfer_buffer_length - urb->actual_length;
700 sequence = usb_gettoggle(urb->dev,
701 usb_pipeendpoint(urb->pipe),
702 usb_pipeout(urb->pipe));
704 dev_dbg(dev, "%s\n", __func__);
705 usbhs_pkt_push(pipe, &ureq->pkt, usbhsh_queue_done,
706 buf, len, (urb->transfer_flags & URB_ZERO_PACKET),
709 usbhs_pkt_start(pipe);
714 static void usbhsh_queue_force_pop(struct usbhs_priv *priv,
715 struct usbhs_pipe *pipe)
717 struct usbhs_pkt *pkt;
720 pkt = usbhs_pkt_pop(pipe, NULL);
725 * if all packet are gone, usbhsh_endpoint_disable()
727 * then, attached device/endpoint/pipe will be detached
729 usbhsh_queue_done(priv, pkt);
733 static void usbhsh_queue_force_pop_all(struct usbhs_priv *priv)
735 struct usbhs_pipe *pos;
738 usbhs_for_each_pipe_with_dcp(pos, priv, i)
739 usbhsh_queue_force_pop(priv, pos);
745 static int usbhsh_is_request_address(struct urb *urb)
747 struct usb_ctrlrequest *req;
749 req = (struct usb_ctrlrequest *)urb->setup_packet;
751 if ((DeviceOutRequest == req->bRequestType << 8) &&
752 (USB_REQ_SET_ADDRESS == req->bRequest))
758 static void usbhsh_setup_stage_packet_push(struct usbhsh_hpriv *hpriv,
760 struct usbhs_pipe *pipe)
762 struct usbhs_priv *priv = usbhsh_hpriv_to_priv(hpriv);
763 struct usb_ctrlrequest req;
764 struct device *dev = usbhs_priv_to_dev(priv);
767 * wait setup packet ACK
769 * usbhsh_irq_setup_ack()
770 * usbhsh_irq_setup_err()
772 init_completion(&hpriv->setup_ack_done);
774 /* copy original request */
775 memcpy(&req, urb->setup_packet, sizeof(struct usb_ctrlrequest));
778 * renesas_usbhs can not use original usb address.
779 * see HARDWARE LIMITATION.
780 * modify usb address here to use attached device.
781 * see usbhsh_device_attach()
783 if (usbhsh_is_request_address(urb)) {
784 struct usb_device *usbv = usbhsh_urb_to_usbv(urb);
785 struct usbhsh_device *udev = usbhsh_usbv_to_udev(usbv);
787 /* udev is a attached device */
788 req.wValue = usbhsh_device_number(hpriv, udev);
789 dev_dbg(dev, "create new address - %d\n", req.wValue);
793 usbhs_usbreq_set_val(priv, &req);
796 * wait setup packet ACK
798 wait_for_completion(&hpriv->setup_ack_done);
800 dev_dbg(dev, "%s done\n", __func__);
806 static void usbhsh_data_stage_packet_done(struct usbhs_priv *priv,
807 struct usbhs_pkt *pkt)
809 struct usbhsh_request *ureq = usbhsh_pkt_to_ureq(pkt);
810 struct usbhsh_hpriv *hpriv = usbhsh_priv_to_hpriv(priv);
812 /* this ureq was connected to urb when usbhsh_urb_enqueue() */
814 usbhsh_ureq_free(hpriv, ureq);
817 static int usbhsh_data_stage_packet_push(struct usbhsh_hpriv *hpriv,
819 struct usbhs_pipe *pipe,
823 struct usbhsh_request *ureq;
825 /* this ureq will be freed on usbhsh_data_stage_packet_done() */
826 ureq = usbhsh_ureq_alloc(hpriv, urb, mem_flags);
830 if (usb_pipein(urb->pipe))
831 pipe->handler = &usbhs_dcp_data_stage_in_handler;
833 pipe->handler = &usbhs_dcp_data_stage_out_handler;
835 usbhs_pkt_push(pipe, &ureq->pkt,
836 usbhsh_data_stage_packet_done,
837 urb->transfer_buffer,
838 urb->transfer_buffer_length,
839 (urb->transfer_flags & URB_ZERO_PACKET),
848 static int usbhsh_status_stage_packet_push(struct usbhsh_hpriv *hpriv,
850 struct usbhs_pipe *pipe,
853 struct usbhsh_request *ureq;
855 /* This ureq will be freed on usbhsh_queue_done() */
856 ureq = usbhsh_ureq_alloc(hpriv, urb, mem_flags);
860 if (usb_pipein(urb->pipe))
861 pipe->handler = &usbhs_dcp_status_stage_in_handler;
863 pipe->handler = &usbhs_dcp_status_stage_out_handler;
865 usbhs_pkt_push(pipe, &ureq->pkt,
868 urb->transfer_buffer_length,
874 static int usbhsh_dcp_queue_push(struct usb_hcd *hcd,
878 struct usbhsh_hpriv *hpriv = usbhsh_hcd_to_hpriv(hcd);
879 struct usbhsh_ep *uep = usbhsh_ep_to_uep(urb->ep);
880 struct usbhs_pipe *pipe = usbhsh_uep_to_pipe(uep);
881 struct device *dev = usbhsh_hcd_to_dev(hcd);
884 dev_dbg(dev, "%s\n", __func__);
889 * usbhsh_send_setup_stage_packet() wait SACK/SIGN
891 usbhsh_setup_stage_packet_push(hpriv, urb, pipe);
896 * It is pushed only when urb has buffer.
898 if (urb->transfer_buffer_length) {
899 ret = usbhsh_data_stage_packet_push(hpriv, urb, pipe, mflags);
901 dev_err(dev, "data stage failed\n");
909 ret = usbhsh_status_stage_packet_push(hpriv, urb, pipe, mflags);
911 dev_err(dev, "status stage failed\n");
916 * start pushed packets
918 usbhs_pkt_start(pipe);
926 static int usbhsh_dma_map_ctrl(struct device *dma_dev, struct usbhs_pkt *pkt,
930 struct usbhsh_request *ureq = usbhsh_pkt_to_ureq(pkt);
931 struct urb *urb = ureq->urb;
933 /* it can not use scatter/gather */
937 pkt->dma = urb->transfer_dma;
948 static int usbhsh_host_start(struct usb_hcd *hcd)
953 static void usbhsh_host_stop(struct usb_hcd *hcd)
957 static int usbhsh_urb_enqueue(struct usb_hcd *hcd,
961 struct usbhsh_hpriv *hpriv = usbhsh_hcd_to_hpriv(hcd);
962 struct usbhs_priv *priv = usbhsh_hpriv_to_priv(hpriv);
963 struct device *dev = usbhs_priv_to_dev(priv);
964 struct usb_host_endpoint *ep = urb->ep;
965 struct usbhsh_device *new_udev = NULL;
966 int is_dir_in = usb_pipein(urb->pipe);
969 dev_dbg(dev, "%s (%s)\n", __func__, is_dir_in ? "in" : "out");
971 if (!usbhsh_is_running(hpriv)) {
973 dev_err(dev, "host is not running\n");
974 goto usbhsh_urb_enqueue_error_not_linked;
977 ret = usb_hcd_link_urb_to_ep(hcd, urb);
979 dev_err(dev, "urb link failed\n");
980 goto usbhsh_urb_enqueue_error_not_linked;
984 * attach udev if needed
985 * see [image of mod_host]
987 if (!usbhsh_device_get(hpriv, urb)) {
988 new_udev = usbhsh_device_attach(hpriv, urb);
991 dev_err(dev, "device attach failed\n");
992 goto usbhsh_urb_enqueue_error_not_linked;
997 * attach endpoint if needed
998 * see [image of mod_host]
1000 if (!usbhsh_ep_to_uep(ep)) {
1001 ret = usbhsh_endpoint_attach(hpriv, urb, mem_flags);
1003 dev_err(dev, "endpoint attach failed\n");
1004 goto usbhsh_urb_enqueue_error_free_device;
1009 * attach pipe to endpoint
1010 * see [image of mod_host]
1012 ret = usbhsh_pipe_attach(hpriv, urb);
1014 dev_err(dev, "pipe attach failed\n");
1015 goto usbhsh_urb_enqueue_error_free_endpoint;
1021 if (usb_pipecontrol(urb->pipe))
1022 ret = usbhsh_dcp_queue_push(hcd, urb, mem_flags);
1024 ret = usbhsh_queue_push(hcd, urb, mem_flags);
1028 usbhsh_urb_enqueue_error_free_endpoint:
1029 usbhsh_endpoint_detach(hpriv, ep);
1030 usbhsh_urb_enqueue_error_free_device:
1032 usbhsh_device_detach(hpriv, new_udev);
1033 usbhsh_urb_enqueue_error_not_linked:
1035 dev_dbg(dev, "%s error\n", __func__);
1040 static int usbhsh_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
1042 struct usbhsh_hpriv *hpriv = usbhsh_hcd_to_hpriv(hcd);
1043 struct usbhsh_request *ureq = usbhsh_urb_to_ureq(urb);
1046 struct usbhs_priv *priv = usbhsh_hpriv_to_priv(hpriv);
1047 struct usbhs_pkt *pkt = &ureq->pkt;
1049 usbhs_pkt_pop(pkt->pipe, pkt);
1050 usbhsh_queue_done(priv, pkt);
1056 static void usbhsh_endpoint_disable(struct usb_hcd *hcd,
1057 struct usb_host_endpoint *ep)
1059 struct usbhsh_ep *uep = usbhsh_ep_to_uep(ep);
1060 struct usbhsh_device *udev;
1061 struct usbhsh_hpriv *hpriv;
1064 * this function might be called manytimes by same hcd/ep
1065 * in-endpoint == out-endpoint if ep == dcp.
1070 udev = usbhsh_uep_to_udev(uep);
1071 hpriv = usbhsh_hcd_to_hpriv(hcd);
1073 usbhsh_endpoint_detach(hpriv, ep);
1076 * if there is no endpoint,
1079 if (!usbhsh_device_has_endpoint(udev))
1080 usbhsh_device_detach(hpriv, udev);
1083 static int usbhsh_hub_status_data(struct usb_hcd *hcd, char *buf)
1085 struct usbhsh_hpriv *hpriv = usbhsh_hcd_to_hpriv(hcd);
1086 int roothub_id = 1; /* only 1 root hub */
1089 * does port stat was changed ?
1090 * check USB_PORT_STAT_C_xxx << 16
1092 if (usbhsh_port_stat_get(hpriv) & 0xFFFF0000)
1093 *buf = (1 << roothub_id);
1100 static int __usbhsh_hub_hub_feature(struct usbhsh_hpriv *hpriv,
1101 u16 typeReq, u16 wValue,
1102 u16 wIndex, char *buf, u16 wLength)
1104 struct usbhs_priv *priv = usbhsh_hpriv_to_priv(hpriv);
1105 struct device *dev = usbhs_priv_to_dev(priv);
1108 case C_HUB_OVER_CURRENT:
1109 case C_HUB_LOCAL_POWER:
1110 dev_dbg(dev, "%s :: C_HUB_xx\n", __func__);
1117 static int __usbhsh_hub_port_feature(struct usbhsh_hpriv *hpriv,
1118 u16 typeReq, u16 wValue,
1119 u16 wIndex, char *buf, u16 wLength)
1121 struct usbhs_priv *priv = usbhsh_hpriv_to_priv(hpriv);
1122 struct device *dev = usbhs_priv_to_dev(priv);
1123 int enable = (typeReq == SetPortFeature);
1124 int speed, i, timeout = 128;
1125 int roothub_id = 1; /* only 1 root hub */
1128 if (wIndex > roothub_id || wLength != 0)
1133 case USB_PORT_FEAT_POWER:
1134 usbhs_vbus_ctrl(priv, enable);
1135 dev_dbg(dev, "%s :: USB_PORT_FEAT_POWER\n", __func__);
1138 case USB_PORT_FEAT_ENABLE:
1139 case USB_PORT_FEAT_SUSPEND:
1140 case USB_PORT_FEAT_C_ENABLE:
1141 case USB_PORT_FEAT_C_SUSPEND:
1142 case USB_PORT_FEAT_C_CONNECTION:
1143 case USB_PORT_FEAT_C_OVER_CURRENT:
1144 case USB_PORT_FEAT_C_RESET:
1145 dev_dbg(dev, "%s :: USB_PORT_FEAT_xxx\n", __func__);
1148 case USB_PORT_FEAT_RESET:
1152 usbhsh_port_stat_clear(hpriv,
1153 USB_PORT_STAT_HIGH_SPEED |
1154 USB_PORT_STAT_LOW_SPEED);
1156 usbhsh_queue_force_pop_all(priv);
1158 usbhs_bus_send_reset(priv);
1160 usbhs_bus_send_sof_enable(priv);
1162 for (i = 0; i < timeout ; i++) {
1163 switch (usbhs_bus_get_speed(priv)) {
1165 speed = USB_PORT_STAT_LOW_SPEED;
1166 goto got_usb_bus_speed;
1167 case USB_SPEED_HIGH:
1168 speed = USB_PORT_STAT_HIGH_SPEED;
1169 goto got_usb_bus_speed;
1170 case USB_SPEED_FULL:
1172 goto got_usb_bus_speed;
1180 usbhsh_port_stat_set(hpriv, speed);
1181 usbhsh_port_stat_set(hpriv, USB_PORT_STAT_ENABLE);
1183 dev_dbg(dev, "%s :: USB_PORT_FEAT_RESET (speed = %d)\n",
1186 /* status change is not needed */
1193 /* set/clear status */
1195 usbhsh_port_stat_set(hpriv, (1 << wValue));
1197 usbhsh_port_stat_clear(hpriv, (1 << wValue));
1202 static int __usbhsh_hub_get_status(struct usbhsh_hpriv *hpriv,
1203 u16 typeReq, u16 wValue,
1204 u16 wIndex, char *buf, u16 wLength)
1206 struct usbhs_priv *priv = usbhsh_hpriv_to_priv(hpriv);
1207 struct usb_hub_descriptor *desc = (struct usb_hub_descriptor *)buf;
1208 struct device *dev = usbhs_priv_to_dev(priv);
1209 int roothub_id = 1; /* only 1 root hub */
1213 dev_dbg(dev, "%s :: GetHubStatus\n", __func__);
1219 if (wIndex != roothub_id)
1222 dev_dbg(dev, "%s :: GetPortStatus\n", __func__);
1223 *(__le32 *)buf = cpu_to_le32(usbhsh_port_stat_get(hpriv));
1226 case GetHubDescriptor:
1227 desc->bDescriptorType = USB_DT_HUB;
1228 desc->bHubContrCurrent = 0;
1229 desc->bNbrPorts = roothub_id;
1230 desc->bDescLength = 9;
1231 desc->bPwrOn2PwrGood = 0;
1232 desc->wHubCharacteristics =
1233 cpu_to_le16(HUB_CHAR_INDV_PORT_LPSM | HUB_CHAR_NO_OCPM);
1234 desc->u.hs.DeviceRemovable[0] = (roothub_id << 1);
1235 desc->u.hs.DeviceRemovable[1] = ~0;
1236 dev_dbg(dev, "%s :: GetHubDescriptor\n", __func__);
1243 static int usbhsh_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue,
1244 u16 wIndex, char *buf, u16 wLength)
1246 struct usbhsh_hpriv *hpriv = usbhsh_hcd_to_hpriv(hcd);
1247 struct usbhs_priv *priv = usbhsh_hpriv_to_priv(hpriv);
1248 struct device *dev = usbhs_priv_to_dev(priv);
1254 case ClearHubFeature:
1256 ret = __usbhsh_hub_hub_feature(hpriv, typeReq,
1257 wValue, wIndex, buf, wLength);
1261 case SetPortFeature:
1262 case ClearPortFeature:
1263 ret = __usbhsh_hub_port_feature(hpriv, typeReq,
1264 wValue, wIndex, buf, wLength);
1270 case GetHubDescriptor:
1271 ret = __usbhsh_hub_get_status(hpriv, typeReq,
1272 wValue, wIndex, buf, wLength);
1276 dev_dbg(dev, "typeReq = %x, ret = %d, port_stat = %x\n",
1277 typeReq, ret, usbhsh_port_stat_get(hpriv));
1282 static int usbhsh_bus_nop(struct usb_hcd *hcd)
1288 static struct hc_driver usbhsh_driver = {
1289 .description = usbhsh_hcd_name,
1290 .hcd_priv_size = sizeof(struct usbhsh_hpriv),
1293 * generic hardware linkage
1297 .start = usbhsh_host_start,
1298 .stop = usbhsh_host_stop,
1301 * managing i/o requests and associated device resources
1303 .urb_enqueue = usbhsh_urb_enqueue,
1304 .urb_dequeue = usbhsh_urb_dequeue,
1305 .endpoint_disable = usbhsh_endpoint_disable,
1310 .hub_status_data = usbhsh_hub_status_data,
1311 .hub_control = usbhsh_hub_control,
1312 .bus_suspend = usbhsh_bus_nop,
1313 .bus_resume = usbhsh_bus_nop,
1317 * interrupt functions
1319 static int usbhsh_irq_attch(struct usbhs_priv *priv,
1320 struct usbhs_irq_state *irq_state)
1322 struct usbhsh_hpriv *hpriv = usbhsh_priv_to_hpriv(priv);
1323 struct device *dev = usbhs_priv_to_dev(priv);
1325 dev_dbg(dev, "device attached\n");
1327 usbhsh_port_stat_set(hpriv, USB_PORT_STAT_CONNECTION);
1328 usbhsh_port_stat_set(hpriv, USB_PORT_STAT_C_CONNECTION << 16);
1331 * attch interrupt might happen infinitely on some device
1332 * (on self power USB hub ?)
1335 * usbhsh_is_running() becomes effective
1336 * according to this process.
1338 * usbhsh_is_running()
1339 * usbhsh_urb_enqueue()
1341 hpriv->mod.irq_attch = NULL;
1342 usbhs_irq_callback_update(priv, &hpriv->mod);
1347 static int usbhsh_irq_dtch(struct usbhs_priv *priv,
1348 struct usbhs_irq_state *irq_state)
1350 struct usbhsh_hpriv *hpriv = usbhsh_priv_to_hpriv(priv);
1351 struct device *dev = usbhs_priv_to_dev(priv);
1353 dev_dbg(dev, "device detached\n");
1355 usbhsh_port_stat_clear(hpriv, USB_PORT_STAT_CONNECTION);
1356 usbhsh_port_stat_set(hpriv, USB_PORT_STAT_C_CONNECTION << 16);
1359 * enable attch interrupt again
1361 * usbhsh_is_running() becomes invalid
1362 * according to this process.
1364 * usbhsh_is_running()
1365 * usbhsh_urb_enqueue()
1367 hpriv->mod.irq_attch = usbhsh_irq_attch;
1368 usbhs_irq_callback_update(priv, &hpriv->mod);
1371 * usbhsh_queue_force_pop_all() should be called
1372 * after usbhsh_is_running() becomes invalid.
1374 usbhsh_queue_force_pop_all(priv);
1379 static int usbhsh_irq_setup_ack(struct usbhs_priv *priv,
1380 struct usbhs_irq_state *irq_state)
1382 struct usbhsh_hpriv *hpriv = usbhsh_priv_to_hpriv(priv);
1383 struct device *dev = usbhs_priv_to_dev(priv);
1385 dev_dbg(dev, "setup packet OK\n");
1387 complete(&hpriv->setup_ack_done); /* see usbhsh_urb_enqueue() */
1392 static int usbhsh_irq_setup_err(struct usbhs_priv *priv,
1393 struct usbhs_irq_state *irq_state)
1395 struct usbhsh_hpriv *hpriv = usbhsh_priv_to_hpriv(priv);
1396 struct device *dev = usbhs_priv_to_dev(priv);
1398 dev_dbg(dev, "setup packet Err\n");
1400 complete(&hpriv->setup_ack_done); /* see usbhsh_urb_enqueue() */
1408 static void usbhsh_pipe_init_for_host(struct usbhs_priv *priv)
1410 struct usbhsh_hpriv *hpriv = usbhsh_priv_to_hpriv(priv);
1411 struct usbhs_pipe *pipe;
1412 struct renesas_usbhs_driver_pipe_config *pipe_configs =
1413 usbhs_get_dparam(priv, pipe_configs);
1414 int pipe_size = usbhs_get_dparam(priv, pipe_size);
1415 int old_type, dir_in, i;
1418 old_type = USB_ENDPOINT_XFER_CONTROL;
1419 for (i = 0; i < pipe_size; i++) {
1422 * data "output" will be finished as soon as possible,
1423 * but there is no guaranty at data "input" case.
1425 * "input" needs "standby" pipe.
1426 * So, "input" direction pipe > "output" direction pipe
1429 * 1st USB_ENDPOINT_XFER_xxx will be output direction,
1430 * and the other will be input direction here.
1434 * USB_ENDPOINT_XFER_ISOC -> dir out
1435 * USB_ENDPOINT_XFER_ISOC -> dir in
1436 * USB_ENDPOINT_XFER_BULK -> dir out
1437 * USB_ENDPOINT_XFER_BULK -> dir in
1438 * USB_ENDPOINT_XFER_BULK -> dir in
1441 dir_in = (pipe_configs[i].type == old_type);
1442 old_type = pipe_configs[i].type;
1444 if (USB_ENDPOINT_XFER_CONTROL == pipe_configs[i].type) {
1445 pipe = usbhs_dcp_malloc(priv);
1446 usbhsh_hpriv_to_dcp(hpriv) = pipe;
1448 pipe = usbhs_pipe_malloc(priv,
1449 pipe_configs[i].type,
1453 pipe->mod_private = NULL;
1457 static int usbhsh_start(struct usbhs_priv *priv)
1459 struct usbhsh_hpriv *hpriv = usbhsh_priv_to_hpriv(priv);
1460 struct usb_hcd *hcd = usbhsh_hpriv_to_hcd(hpriv);
1461 struct usbhs_mod *mod = usbhs_mod_get_current(priv);
1462 struct device *dev = usbhs_priv_to_dev(priv);
1466 ret = usb_add_hcd(hcd, 0, 0);
1469 device_wakeup_enable(hcd->self.controller);
1472 * pipe initialize and enable DCP
1474 usbhs_fifo_init(priv);
1475 usbhs_pipe_init(priv,
1476 usbhsh_dma_map_ctrl);
1477 usbhsh_pipe_init_for_host(priv);
1480 * system config enble
1485 usbhs_sys_host_ctrl(priv, 1);
1488 * enable irq callback
1490 mod->irq_attch = usbhsh_irq_attch;
1491 mod->irq_dtch = usbhsh_irq_dtch;
1492 mod->irq_sack = usbhsh_irq_setup_ack;
1493 mod->irq_sign = usbhsh_irq_setup_err;
1494 usbhs_irq_callback_update(priv, mod);
1496 dev_dbg(dev, "start host\n");
1501 static int usbhsh_stop(struct usbhs_priv *priv)
1503 struct usbhsh_hpriv *hpriv = usbhsh_priv_to_hpriv(priv);
1504 struct usb_hcd *hcd = usbhsh_hpriv_to_hcd(hpriv);
1505 struct usbhs_mod *mod = usbhs_mod_get_current(priv);
1506 struct device *dev = usbhs_priv_to_dev(priv);
1509 * disable irq callback
1511 mod->irq_attch = NULL;
1512 mod->irq_dtch = NULL;
1513 mod->irq_sack = NULL;
1514 mod->irq_sign = NULL;
1515 usbhs_irq_callback_update(priv, mod);
1517 usb_remove_hcd(hcd);
1520 usbhs_sys_host_ctrl(priv, 0);
1522 dev_dbg(dev, "quit host\n");
1527 int usbhs_mod_host_probe(struct usbhs_priv *priv)
1529 struct usbhsh_hpriv *hpriv;
1530 struct usb_hcd *hcd;
1531 struct usbhsh_device *udev;
1532 struct device *dev = usbhs_priv_to_dev(priv);
1535 /* initialize hcd */
1536 hcd = usb_create_hcd(&usbhsh_driver, dev, usbhsh_hcd_name);
1538 dev_err(dev, "Failed to create hcd\n");
1541 hcd->has_tt = 1; /* for low/full speed */
1546 * There is no guarantee that it is possible to access usb module here.
1547 * Don't accesses to it.
1548 * The accesse will be enable after "usbhsh_start"
1551 hpriv = usbhsh_hcd_to_hpriv(hcd);
1556 usbhs_mod_register(priv, &hpriv->mod, USBHS_HOST);
1559 hpriv->mod.name = "host";
1560 hpriv->mod.start = usbhsh_start;
1561 hpriv->mod.stop = usbhsh_stop;
1562 usbhsh_port_stat_init(hpriv);
1564 /* init all device */
1565 usbhsh_for_each_udev_with_dev0(udev, hpriv, i) {
1567 INIT_LIST_HEAD(&udev->ep_list_head);
1570 dev_info(dev, "host probed\n");
1575 int usbhs_mod_host_remove(struct usbhs_priv *priv)
1577 struct usbhsh_hpriv *hpriv = usbhsh_priv_to_hpriv(priv);
1578 struct usb_hcd *hcd = usbhsh_hpriv_to_hcd(hpriv);