1 // SPDX-License-Identifier: GPL-2.0+
4 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
6 * This code is based on linux driver for sl811hs chip, source at
7 * drivers/usb/host/sl811.c:
9 * SL811 Host Controller Interface driver for USB.
11 * Copyright (c) 2003/06, Courage Co., Ltd.
14 * 1.uhci.c by Linus Torvalds, Johannes Erdfelt, Randy Dunlap,
15 * Georg Acher, Deti Fliegl, Thomas Sailer, Roman Weissgaerber,
16 * Adam Richter, Gregory P. Smith;
17 * 2.Original SL811 driver (hc_sl811.o) by Pei Liu <pbl@cypress.com>
18 * 3.Rewrited as sl811.o by Yin Aihua <yinah:couragetech.com.cn>
26 #include "../../../board/kup/common/kup.h"
29 # define EIEIO __asm__ volatile ("eieio")
31 # define EIEIO /* nothing */
34 #define SL811_ADR (0x50000000)
35 #define SL811_DAT (0x50000001)
41 static int root_hub_devnum = 0;
42 static struct usb_port_status rh_status = { 0 };/* root hub port status */
44 static int sl811_rh_submit_urb(struct usb_device *usb_dev, unsigned long pipe,
45 void *data, int buf_len, struct devrequest *cmd);
47 static void sl811_write (__u8 index, __u8 data)
49 *(volatile unsigned char *) (SL811_ADR) = index;
51 *(volatile unsigned char *) (SL811_DAT) = data;
55 static __u8 sl811_read (__u8 index)
59 *(volatile unsigned char *) (SL811_ADR) = index;
61 data = *(volatile unsigned char *) (SL811_DAT);
67 * Read consecutive bytes of data from the SL811H/SL11H buffer
69 static void inline sl811_read_buf(__u8 offset, __u8 *buf, __u8 size)
71 *(volatile unsigned char *) (SL811_ADR) = offset;
74 *buf++ = *(volatile unsigned char *) (SL811_DAT);
80 * Write consecutive bytes of data to the SL811H/SL11H buffer
82 static void inline sl811_write_buf(__u8 offset, __u8 *buf, __u8 size)
84 *(volatile unsigned char *) (SL811_ADR) = offset;
87 *(volatile unsigned char *) (SL811_DAT) = *buf++;
92 int usb_init_kup4x (void)
94 volatile immap_t *immap = (immap_t *) CONFIG_SYS_IMMR;
95 volatile memctl8xx_t *memctl = &immap->im_memctl;
99 memctl = &immap->im_memctl;
100 memctl->memc_or7 = 0xFFFF8726;
101 memctl->memc_br7 = 0x50000401; /* start at 0x50000000 */
102 /* BP 14 low = USB ON */
103 immap->im_cpm.cp_pbdat &= ~(BP_USB_VCC);
104 /* PB 14 nomal port */
105 immap->im_cpm.cp_pbpar &= ~(BP_USB_VCC);
107 immap->im_cpm.cp_pbdir |= (BP_USB_VCC);
111 for (i = 0x10; i < 0xff; i++) {
113 tmp = (sl811_read(i));
115 printf ("SL811 compare error index=0x%02x read=0x%02x\n", i, tmp);
119 printf ("SL811 ready\n");
124 * This function resets SL811HS controller and detects the speed of
125 * the connecting device
127 * Return: 0 = no device attached; 1 = USB device attached
129 static int sl811_hc_reset(void)
133 sl811_write(SL811_CTRL2, SL811_CTL2_HOST | SL811_12M_HI);
134 sl811_write(SL811_CTRL1, SL811_CTRL1_RESET);
138 /* Disable hardware SOF generation, clear all irq status. */
139 sl811_write(SL811_CTRL1, 0);
141 sl811_write(SL811_INTRSTS, 0xff);
142 status = sl811_read(SL811_INTRSTS);
144 if (status & SL811_INTR_NOTPRESENT) {
145 /* Device is not present */
146 PDEBUG(0, "Device not present\n");
147 rh_status.wPortStatus &= ~(USB_PORT_STAT_CONNECTION | USB_PORT_STAT_ENABLE);
148 rh_status.wPortChange |= USB_PORT_STAT_C_CONNECTION;
149 sl811_write(SL811_INTR, SL811_INTR_INSRMV);
153 /* Send SOF to address 0, endpoint 0. */
154 sl811_write(SL811_LEN_B, 0);
155 sl811_write(SL811_PIDEP_B, PIDEP(USB_PID_SOF, 0));
156 sl811_write(SL811_DEV_B, 0x00);
157 sl811_write(SL811_SOFLOW, SL811_12M_LOW);
159 if (status & SL811_INTR_SPEED_FULL) {
160 /* full speed device connect directly to root hub */
161 PDEBUG (0, "Full speed Device attached\n");
163 sl811_write(SL811_CTRL1, SL811_CTRL1_RESET);
165 sl811_write(SL811_CTRL2, SL811_CTL2_HOST | SL811_12M_HI);
166 sl811_write(SL811_CTRL1, SL811_CTRL1_SOF);
168 /* start the SOF or EOP */
169 sl811_write(SL811_CTRL_B, SL811_USB_CTRL_ARM);
170 rh_status.wPortStatus |= USB_PORT_STAT_CONNECTION;
171 rh_status.wPortStatus &= ~USB_PORT_STAT_LOW_SPEED;
173 sl811_write(SL811_INTRSTS, 0xff);
175 /* slow speed device connect directly to root-hub */
176 PDEBUG(0, "Low speed Device attached\n");
178 sl811_write(SL811_CTRL1, SL811_CTRL1_RESET);
180 sl811_write(SL811_CTRL2, SL811_CTL2_HOST | SL811_CTL2_DSWAP | SL811_12M_HI);
181 sl811_write(SL811_CTRL1, SL811_CTRL1_SPEED_LOW | SL811_CTRL1_SOF);
183 /* start the SOF or EOP */
184 sl811_write(SL811_CTRL_B, SL811_USB_CTRL_ARM);
185 rh_status.wPortStatus |= USB_PORT_STAT_CONNECTION | USB_PORT_STAT_LOW_SPEED;
187 sl811_write(SL811_INTRSTS, 0xff);
190 rh_status.wPortChange |= USB_PORT_STAT_C_CONNECTION;
191 sl811_write(SL811_INTR, /*SL811_INTR_INSRMV*/SL811_INTR_DONE_A);
196 int usb_lowlevel_init(int index, enum usb_init_type init, void **controller)
203 int usb_lowlevel_stop(int index)
209 static int calc_needed_buswidth(int bytes, int need_preamble)
211 return !need_preamble ? bytes * 8 + 256 : 8 * 8 * bytes + 2048;
214 static int sl811_send_packet(struct usb_device *dev, unsigned long pipe, __u8 *buffer, int len)
216 __u8 ctrl = SL811_USB_CTRL_ARM | SL811_USB_CTRL_ENABLE;
218 int err = 0, time_start = get_timer(0);
219 int need_preamble = !(rh_status.wPortStatus & USB_PORT_STAT_LOW_SPEED) &&
220 (dev->speed == USB_SPEED_LOW);
225 if (usb_pipeout(pipe))
226 ctrl |= SL811_USB_CTRL_DIR_OUT;
227 if (usb_gettoggle(dev, usb_pipeendpoint(pipe), usb_pipeout(pipe)))
228 ctrl |= SL811_USB_CTRL_TOGGLE_1;
230 ctrl |= SL811_USB_CTRL_PREAMBLE;
232 sl811_write(SL811_INTRSTS, 0xff);
235 sl811_write(SL811_ADDR_A, 0x10);
236 sl811_write(SL811_LEN_A, len);
237 if (usb_pipeout(pipe) && len)
238 sl811_write_buf(0x10, buffer, len);
240 if (!(rh_status.wPortStatus & USB_PORT_STAT_LOW_SPEED) &&
241 sl811_read(SL811_SOFCNTDIV)*64 < calc_needed_buswidth(len, need_preamble))
242 ctrl |= SL811_USB_CTRL_SOF;
244 ctrl &= ~SL811_USB_CTRL_SOF;
246 sl811_write(SL811_CTRL_A, ctrl);
247 while (!(sl811_read(SL811_INTRSTS) & SL811_INTR_DONE_A)) {
248 if (5*CONFIG_SYS_HZ < get_timer(time_start)) {
249 printf("USB transmit timed out\n");
250 return -USB_ST_CRC_ERR;
254 sl811_write(SL811_INTRSTS, 0xff);
255 status = sl811_read(SL811_STS_A);
257 if (status & SL811_USB_STS_ACK) {
258 int remainder = sl811_read(SL811_CNT_A);
260 PDEBUG(0, "usb transfer remainder = %d\n", remainder);
263 if (usb_pipein(pipe) && len)
264 sl811_read_buf(0x10, buffer, len);
268 if ((status & SL811_USB_STS_NAK) == SL811_USB_STS_NAK)
271 PDEBUG(0, "usb transfer error %#x\n", (int)status);
277 if (status & SL811_USB_STS_ERROR)
278 err |= USB_ST_BUF_ERR;
279 if (status & SL811_USB_STS_TIMEOUT)
280 err |= USB_ST_CRC_ERR;
281 if (status & SL811_USB_STS_STALL)
282 err |= USB_ST_STALLED;
287 int submit_bulk_msg(struct usb_device *dev, unsigned long pipe, void *buffer,
290 int dir_out = usb_pipeout(pipe);
291 int ep = usb_pipeendpoint(pipe);
292 int max = usb_maxpacket(dev, pipe);
295 PDEBUG(7, "dev = %ld pipe = %ld buf = %p size = %d dir_out = %d\n",
296 usb_pipedevice(pipe), usb_pipeendpoint(pipe), buffer, len, dir_out);
300 sl811_write(SL811_DEV_A, usb_pipedevice(pipe));
301 sl811_write(SL811_PIDEP_A, PIDEP(!dir_out ? USB_PID_IN : USB_PID_OUT, ep));
303 int res = sl811_send_packet(dev, pipe, (__u8*)buffer+done,
304 max > len - done ? len - done : max);
310 if (!dir_out && res < max) /* short packet */
314 usb_dotoggle(dev, ep, dir_out);
322 int submit_control_msg(struct usb_device *dev, unsigned long pipe, void *buffer,
323 int len,struct devrequest *setup)
326 int devnum = usb_pipedevice(pipe);
327 int ep = usb_pipeendpoint(pipe);
331 if (devnum == root_hub_devnum)
332 return sl811_rh_submit_urb(dev, pipe, buffer, len, setup);
334 PDEBUG(7, "dev = %d pipe = %ld buf = %p size = %d rt = %#x req = %#x bus = %i\n",
335 devnum, ep, buffer, len, (int)setup->requesttype,
336 (int)setup->request, sl811_read(SL811_SOFCNTDIV)*64);
338 sl811_write(SL811_DEV_A, devnum);
339 sl811_write(SL811_PIDEP_A, PIDEP(USB_PID_SETUP, ep));
341 usb_settoggle(dev, ep, 1, 0);
342 if (sl811_send_packet(dev, usb_sndctrlpipe(dev, ep),
343 (__u8*)setup, sizeof(*setup)) == sizeof(*setup)) {
344 int dir_in = usb_pipein(pipe);
345 int max = usb_maxpacket(dev, pipe);
348 sl811_write(SL811_PIDEP_A,
349 PIDEP(dir_in ? USB_PID_IN : USB_PID_OUT, ep));
350 usb_settoggle(dev, ep, usb_pipeout(pipe), 1);
352 int res = sl811_send_packet(dev, pipe, (__u8*)buffer+done,
353 max > len - done ? len - done : max);
355 PDEBUG(0, "status data failed!\n");
360 usb_dotoggle(dev, ep, usb_pipeout(pipe));
361 if (dir_in && res < max) /* short packet */
366 sl811_write(SL811_PIDEP_A,
367 PIDEP(!dir_in ? USB_PID_IN : USB_PID_OUT, ep));
368 usb_settoggle(dev, ep, !usb_pipeout(pipe), 1);
369 if (sl811_send_packet(dev,
370 !dir_in ? usb_rcvctrlpipe(dev, ep) :
371 usb_sndctrlpipe(dev, ep),
373 PDEBUG(0, "status phase failed!\n");
377 PDEBUG(0, "setup phase failed!\n");
386 int submit_int_msg(struct usb_device *dev, unsigned long pipe, void *buffer,
387 int len, int interval, bool nonblock)
389 PDEBUG(0, "dev = %p pipe = %#lx buf = %p size = %d int = %d\n", dev, pipe,
390 buffer, len, interval);
395 * SL811 Virtual Root Hub
398 /* Device descriptor */
399 static __u8 sl811_rh_dev_des[] =
401 0x12, /* __u8 bLength; */
402 0x01, /* __u8 bDescriptorType; Device */
403 0x10, /* __u16 bcdUSB; v1.1 */
405 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
406 0x00, /* __u8 bDeviceSubClass; */
407 0x00, /* __u8 bDeviceProtocol; */
408 0x08, /* __u8 bMaxPacketSize0; 8 Bytes */
409 0x00, /* __u16 idVendor; */
411 0x00, /* __u16 idProduct; */
413 0x00, /* __u16 bcdDevice; */
415 0x00, /* __u8 iManufacturer; */
416 0x02, /* __u8 iProduct; */
417 0x01, /* __u8 iSerialNumber; */
418 0x01 /* __u8 bNumConfigurations; */
421 /* Configuration descriptor */
422 static __u8 sl811_rh_config_des[] =
424 0x09, /* __u8 bLength; */
425 0x02, /* __u8 bDescriptorType; Configuration */
426 0x19, /* __u16 wTotalLength; */
428 0x01, /* __u8 bNumInterfaces; */
429 0x01, /* __u8 bConfigurationValue; */
430 0x00, /* __u8 iConfiguration; */
431 0x40, /* __u8 bmAttributes;
432 Bit 7: Bus-powered, 6: Self-powered, 5 Remote-wakwup,
434 0x00, /* __u8 MaxPower; */
437 0x09, /* __u8 if_bLength; */
438 0x04, /* __u8 if_bDescriptorType; Interface */
439 0x00, /* __u8 if_bInterfaceNumber; */
440 0x00, /* __u8 if_bAlternateSetting; */
441 0x01, /* __u8 if_bNumEndpoints; */
442 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
443 0x00, /* __u8 if_bInterfaceSubClass; */
444 0x00, /* __u8 if_bInterfaceProtocol; */
445 0x00, /* __u8 if_iInterface; */
448 0x07, /* __u8 ep_bLength; */
449 0x05, /* __u8 ep_bDescriptorType; Endpoint */
450 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
451 0x03, /* __u8 ep_bmAttributes; Interrupt */
452 0x08, /* __u16 ep_wMaxPacketSize; */
454 0xff /* __u8 ep_bInterval; 255 ms */
457 /* root hub class descriptor*/
458 static __u8 sl811_rh_hub_des[] =
460 0x09, /* __u8 bLength; */
461 0x29, /* __u8 bDescriptorType; Hub-descriptor */
462 0x01, /* __u8 bNbrPorts; */
463 0x00, /* __u16 wHubCharacteristics; */
465 0x50, /* __u8 bPwrOn2pwrGood; 2ms */
466 0x00, /* __u8 bHubContrCurrent; 0 mA */
467 0xfc, /* __u8 DeviceRemovable; *** 7 Ports max *** */
468 0xff /* __u8 PortPwrCtrlMask; *** 7 ports max *** */
472 * helper routine for returning string descriptors in UTF-16LE
473 * input can actually be ISO-8859-1; ASCII is its 7-bit subset
475 static int ascii2utf (char *s, u8 *utf, int utfmax)
479 for (retval = 0; *s && utfmax > 1; utfmax -= 2, retval += 2) {
487 * root_hub_string is used by each host controller's root hub code,
488 * so that they're identified consistently throughout the system.
490 static int usb_root_hub_string (int id, int serial, char *type, __u8 *data, int len)
494 /* assert (len > (2 * (sizeof (buf) + 1)));
495 assert (strlen (type) <= 8);*/
499 *data++ = 4; *data++ = 3; /* 4 bytes data */
500 *data++ = 0; *data++ = 0; /* some language id */
504 } else if (id == 1) {
505 sprintf (buf, "%#x", serial);
507 /* product description */
508 } else if (id == 2) {
509 sprintf (buf, "USB %s Root Hub", type);
511 /* id 3 == vendor description */
513 /* unsupported IDs --> "stall" */
517 ascii2utf (buf, data + 2, len - 2);
518 data [0] = 2 + strlen(buf) * 2;
524 #define OK(x) len = (x); break
527 * This function handles all USB request to the the virtual root hub
529 static int sl811_rh_submit_urb(struct usb_device *usb_dev, unsigned long pipe,
530 void *data, int buf_len, struct devrequest *cmd)
533 __u8 *bufp = data_buf;
537 __u16 wValue = le16_to_cpu (cmd->value);
538 __u16 wLength = le16_to_cpu (cmd->length);
540 __u16 wIndex = le16_to_cpu (cmd->index);
543 if (usb_pipeint(pipe)) {
544 PDEBUG(0, "interrupt transfer unimplemented!\n");
548 bmRType_bReq = cmd->requesttype | (cmd->request << 8);
550 PDEBUG(5, "submit rh urb, req = %d(%x) val = %#x index = %#x len=%d\n",
551 bmRType_bReq, bmRType_bReq, wValue, wIndex, wLength);
553 /* Request Destination:
554 without flags: Device,
555 USB_RECIP_INTERFACE: interface,
556 USB_RECIP_ENDPOINT: endpoint,
557 USB_TYPE_CLASS means HUB here,
558 USB_RECIP_OTHER | USB_TYPE_CLASS almost ever means HUB_PORT here
560 switch (bmRType_bReq) {
562 *(__u16 *)bufp = cpu_to_le16(1);
565 case RH_GET_STATUS | USB_RECIP_INTERFACE:
566 *(__u16 *)bufp = cpu_to_le16(0);
569 case RH_GET_STATUS | USB_RECIP_ENDPOINT:
570 *(__u16 *)bufp = cpu_to_le16(0);
573 case RH_GET_STATUS | USB_TYPE_CLASS:
574 *(__u32 *)bufp = cpu_to_le32(0);
577 case RH_GET_STATUS | USB_RECIP_OTHER | USB_TYPE_CLASS:
578 *(__u32 *)bufp = cpu_to_le32(rh_status.wPortChange<<16 | rh_status.wPortStatus);
581 case RH_CLEAR_FEATURE | USB_RECIP_ENDPOINT:
588 case RH_CLEAR_FEATURE | USB_TYPE_CLASS:
590 case C_HUB_LOCAL_POWER:
593 case C_HUB_OVER_CURRENT:
598 case RH_CLEAR_FEATURE | USB_RECIP_OTHER | USB_TYPE_CLASS:
600 case USB_PORT_FEAT_ENABLE:
601 rh_status.wPortStatus &= ~USB_PORT_STAT_ENABLE;
604 case USB_PORT_FEAT_SUSPEND:
605 rh_status.wPortStatus &= ~USB_PORT_STAT_SUSPEND;
608 case USB_PORT_FEAT_POWER:
609 rh_status.wPortStatus &= ~USB_PORT_STAT_POWER;
612 case USB_PORT_FEAT_C_CONNECTION:
613 rh_status.wPortChange &= ~USB_PORT_STAT_C_CONNECTION;
616 case USB_PORT_FEAT_C_ENABLE:
617 rh_status.wPortChange &= ~USB_PORT_STAT_C_ENABLE;
620 case USB_PORT_FEAT_C_SUSPEND:
621 rh_status.wPortChange &= ~USB_PORT_STAT_C_SUSPEND;
624 case USB_PORT_FEAT_C_OVER_CURRENT:
625 rh_status.wPortChange &= ~USB_PORT_STAT_C_OVERCURRENT;
628 case USB_PORT_FEAT_C_RESET:
629 rh_status.wPortChange &= ~USB_PORT_STAT_C_RESET;
634 case RH_SET_FEATURE | USB_RECIP_OTHER | USB_TYPE_CLASS:
636 case USB_PORT_FEAT_SUSPEND:
637 rh_status.wPortStatus |= USB_PORT_STAT_SUSPEND;
640 case USB_PORT_FEAT_RESET:
641 rh_status.wPortStatus |= USB_PORT_STAT_RESET;
642 rh_status.wPortChange = 0;
643 rh_status.wPortChange |= USB_PORT_STAT_C_RESET;
644 rh_status.wPortStatus &= ~USB_PORT_STAT_RESET;
645 rh_status.wPortStatus |= USB_PORT_STAT_ENABLE;
648 case USB_PORT_FEAT_POWER:
649 rh_status.wPortStatus |= USB_PORT_STAT_POWER;
652 case USB_PORT_FEAT_ENABLE:
653 rh_status.wPortStatus |= USB_PORT_STAT_ENABLE;
659 root_hub_devnum = wValue;
662 case RH_GET_DESCRIPTOR:
663 switch ((wValue & 0xff00) >> 8) {
665 len = sizeof(sl811_rh_dev_des);
666 bufp = sl811_rh_dev_des;
670 len = sizeof(sl811_rh_config_des);
671 bufp = sl811_rh_config_des;
675 len = usb_root_hub_string(wValue & 0xff, (int)(long)0, "SL811HS", data, wLength);
686 case RH_GET_DESCRIPTOR | USB_TYPE_CLASS:
687 len = sizeof(sl811_rh_hub_des);
688 bufp = sl811_rh_hub_des;
691 case RH_GET_CONFIGURATION:
695 case RH_SET_CONFIGURATION:
699 PDEBUG(1, "unsupported root hub command\n");
703 len = min(len, buf_len);
705 memcpy(data, bufp, len);
707 PDEBUG(5, "len = %d, status = %d\n", len, status);
709 usb_dev->status = status;
710 usb_dev->act_len = len;
712 return status == 0 ? len : status;