[thirdparty/u-boot.git] / common / usb_hub.c

/*
 *
 * Most of this source has been derived from the Linux USB
 * project:
 * (C) Copyright Linus Torvalds 1999
 * (C) Copyright Johannes Erdfelt 1999-2001
 * (C) Copyright Andreas Gal 1999
 * (C) Copyright Gregory P. Smith 1999
 * (C) Copyright Deti Fliegl 1999 (new USB architecture)
 * (C) Copyright Randy Dunlap 2000
 * (C) Copyright David Brownell 2000 (kernel hotplug, usb_device_id)
 * (C) Copyright Yggdrasil Computing, Inc. 2000
 *     (usb_device_id matching changes by Adam J. Richter)
 *
 * Adapted for U-Boot:
 * (C) Copyright 2001 Denis Peter, MPL AG Switzerland
 *
 * See file CREDITS for list of people who contributed to this
 * project.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of
 * the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 * MA 02111-1307 USA
 *
 */

/****************************************************************************
 * HUB "Driver"
 * Probes device for being a hub and configurate it
 */

#include <common.h>
#include <command.h>
#include <asm/processor.h>
#include <asm/unaligned.h>
#include <linux/ctype.h>
#include <asm/byteorder.h>
#include <asm/unaligned.h>

#include <usb.h>
#ifdef CONFIG_4xx
#include <asm/4xx_pci.h>
#endif

#ifdef DEBUG
#define USB_DEBUG	1
#define USB_HUB_DEBUG	1
#else
#define USB_DEBUG	0
#define USB_HUB_DEBUG	0
#endif

#define USB_PRINTF(fmt, args...)	debug_cond(USB_DEBUG, fmt, ##args)
#define USB_HUB_PRINTF(fmt, args...)	debug_cond(USB_HUB_DEBUG, fmt, ##args)

#define USB_BUFSIZ	512

static struct usb_hub_device hub_dev[USB_MAX_HUB];
static int usb_hub_index;


static int usb_get_hub_descriptor(struct usb_device *dev, void *data, int size)
{
	return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
		USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
		USB_DT_HUB << 8, 0, data, size, USB_CNTL_TIMEOUT);
}

static int usb_clear_port_feature(struct usb_device *dev, int port, int feature)
{
	return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
				USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature,
				port, NULL, 0, USB_CNTL_TIMEOUT);
}

static int usb_set_port_feature(struct usb_device *dev, int port, int feature)
{
	return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
				USB_REQ_SET_FEATURE, USB_RT_PORT, feature,
				port, NULL, 0, USB_CNTL_TIMEOUT);
}

static int usb_get_hub_status(struct usb_device *dev, void *data)
{
	return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
			USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
			data, sizeof(struct usb_hub_status), USB_CNTL_TIMEOUT);
}

static int usb_get_port_status(struct usb_device *dev, int port, void *data)
{
	return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
			USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port,
			data, sizeof(struct usb_hub_status), USB_CNTL_TIMEOUT);
}


static void usb_hub_power_on(struct usb_hub_device *hub)
{
	int i;
	struct usb_device *dev;
	unsigned pgood_delay = hub->desc.bPwrOn2PwrGood * 2;

	dev = hub->pusb_dev;
	/* Enable power to the ports */
	USB_HUB_PRINTF("enabling power on all ports\n");
	for (i = 0; i < dev->maxchild; i++) {
		usb_set_port_feature(dev, i + 1, USB_PORT_FEAT_POWER);
		USB_HUB_PRINTF("port %d returns %lX\n", i + 1, dev->status);
	}

	/* Wait at least 100 msec for power to become stable */
	mdelay(max(pgood_delay, (unsigned)100));
}

void usb_hub_reset(void)
{
	usb_hub_index = 0;
}

static struct usb_hub_device *usb_hub_allocate(void)
{
	if (usb_hub_index < USB_MAX_HUB)
		return &hub_dev[usb_hub_index++];

	printf("ERROR: USB_MAX_HUB (%d) reached\n", USB_MAX_HUB);
	return NULL;
}

#define MAX_TRIES 5

static inline char *portspeed(int portstatus)
{
	if (portstatus & (1 << USB_PORT_FEAT_HIGHSPEED))
		return "480 Mb/s";
	else if (portstatus & (1 << USB_PORT_FEAT_LOWSPEED))
		return "1.5 Mb/s";
	else
		return "12 Mb/s";
}

int hub_port_reset(struct usb_device *dev, int port,
			unsigned short *portstat)
{
	int tries;
	ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
	unsigned short portstatus, portchange;

	USB_HUB_PRINTF("hub_port_reset: resetting port %d...\n", port);
	for (tries = 0; tries < MAX_TRIES; tries++) {

		usb_set_port_feature(dev, port + 1, USB_PORT_FEAT_RESET);
		mdelay(200);

		if (usb_get_port_status(dev, port + 1, portsts) < 0) {
			USB_HUB_PRINTF("get_port_status failed status %lX\n",
					dev->status);
			return -1;
		}
		portstatus = le16_to_cpu(portsts->wPortStatus);
		portchange = le16_to_cpu(portsts->wPortChange);

		USB_HUB_PRINTF("portstatus %x, change %x, %s\n",
				portstatus, portchange,
				portspeed(portstatus));

		USB_HUB_PRINTF("STAT_C_CONNECTION = %d STAT_CONNECTION = %d" \
			       "  USB_PORT_STAT_ENABLE %d\n",
			(portchange & USB_PORT_STAT_C_CONNECTION) ? 1 : 0,
			(portstatus & USB_PORT_STAT_CONNECTION) ? 1 : 0,
			(portstatus & USB_PORT_STAT_ENABLE) ? 1 : 0);

		if ((portchange & USB_PORT_STAT_C_CONNECTION) ||
		    !(portstatus & USB_PORT_STAT_CONNECTION))
			return -1;

		if (portstatus & USB_PORT_STAT_ENABLE)
			break;

		mdelay(200);
	}

	if (tries == MAX_TRIES) {
		USB_HUB_PRINTF("Cannot enable port %i after %i retries, " \
				"disabling port.\n", port + 1, MAX_TRIES);
		USB_HUB_PRINTF("Maybe the USB cable is bad?\n");
		return -1;
	}

	usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_RESET);
	*portstat = portstatus;
	return 0;
}


void usb_hub_port_connect_change(struct usb_device *dev, int port)
{
	struct usb_device *usb;
	ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
	unsigned short portstatus;

	/* Check status */
	if (usb_get_port_status(dev, port + 1, portsts) < 0) {
		USB_HUB_PRINTF("get_port_status failed\n");
		return;
	}

	portstatus = le16_to_cpu(portsts->wPortStatus);
	USB_HUB_PRINTF("portstatus %x, change %x, %s\n",
			portstatus,
			le16_to_cpu(portsts->wPortChange),
			portspeed(portstatus));

	/* Clear the connection change status */
	usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_CONNECTION);

	/* Disconnect any existing devices under this port */
	if (((!(portstatus & USB_PORT_STAT_CONNECTION)) &&
	     (!(portstatus & USB_PORT_STAT_ENABLE))) || (dev->children[port])) {
		USB_HUB_PRINTF("usb_disconnect(&hub->children[port]);\n");
		/* Return now if nothing is connected */
		if (!(portstatus & USB_PORT_STAT_CONNECTION))
			return;
	}
	mdelay(200);

	/* Reset the port */
	if (hub_port_reset(dev, port, &portstatus) < 0) {
		printf("cannot reset port %i!?\n", port + 1);
		return;
	}

	mdelay(200);

	/* Allocate a new device struct for it */
	usb = usb_alloc_new_device(dev->controller);

	if (portstatus & USB_PORT_STAT_HIGH_SPEED)
		usb->speed = USB_SPEED_HIGH;
	else if (portstatus & USB_PORT_STAT_LOW_SPEED)
		usb->speed = USB_SPEED_LOW;
	else
		usb->speed = USB_SPEED_FULL;

	dev->children[port] = usb;
	usb->parent = dev;
	usb->portnr = port + 1;
	/* Run it through the hoops (find a driver, etc) */
	if (usb_new_device(usb)) {
		/* Woops, disable the port */
		USB_HUB_PRINTF("hub: disabling port %d\n", port + 1);
		usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_ENABLE);
	}
}


static int usb_hub_configure(struct usb_device *dev)
{
	int i;
	ALLOC_CACHE_ALIGN_BUFFER(unsigned char, buffer, USB_BUFSIZ);
	unsigned char *bitmap;
	short hubCharacteristics;
	struct usb_hub_descriptor *descriptor;
	struct usb_hub_device *hub;
#ifdef USB_HUB_DEBUG
	struct usb_hub_status *hubsts;
#endif

	/* "allocate" Hub device */
	hub = usb_hub_allocate();
	if (hub == NULL)
		return -1;
	hub->pusb_dev = dev;
	/* Get the the hub descriptor */
	if (usb_get_hub_descriptor(dev, buffer, 4) < 0) {
		USB_HUB_PRINTF("usb_hub_configure: failed to get hub " \
				   "descriptor, giving up %lX\n", dev->status);
		return -1;
	}
	descriptor = (struct usb_hub_descriptor *)buffer;

	/* silence compiler warning if USB_BUFSIZ is > 256 [= sizeof(char)] */
	i = descriptor->bLength;
	if (i > USB_BUFSIZ) {
		USB_HUB_PRINTF("usb_hub_configure: failed to get hub " \
				"descriptor - too long: %d\n",
				descriptor->bLength);
		return -1;
	}

	if (usb_get_hub_descriptor(dev, buffer, descriptor->bLength) < 0) {
		USB_HUB_PRINTF("usb_hub_configure: failed to get hub " \
				"descriptor 2nd giving up %lX\n", dev->status);
		return -1;
	}
	memcpy((unsigned char *)&hub->desc, buffer, descriptor->bLength);
	/* adjust 16bit values */
	put_unaligned(le16_to_cpu(get_unaligned(
			&descriptor->wHubCharacteristics)),
			&hub->desc.wHubCharacteristics);
	/* set the bitmap */
	bitmap = (unsigned char *)&hub->desc.DeviceRemovable[0];
	/* devices not removable by default */
	memset(bitmap, 0xff, (USB_MAXCHILDREN+1+7)/8);
	bitmap = (unsigned char *)&hub->desc.PortPowerCtrlMask[0];
	memset(bitmap, 0xff, (USB_MAXCHILDREN+1+7)/8); /* PowerMask = 1B */

	for (i = 0; i < ((hub->desc.bNbrPorts + 1 + 7)/8); i++)
		hub->desc.DeviceRemovable[i] = descriptor->DeviceRemovable[i];

	for (i = 0; i < ((hub->desc.bNbrPorts + 1 + 7)/8); i++)
		hub->desc.PortPowerCtrlMask[i] = descriptor->PortPowerCtrlMask[i];

	dev->maxchild = descriptor->bNbrPorts;
	USB_HUB_PRINTF("%d ports detected\n", dev->maxchild);

	hubCharacteristics = get_unaligned(&hub->desc.wHubCharacteristics);
	switch (hubCharacteristics & HUB_CHAR_LPSM) {
	case 0x00:
		USB_HUB_PRINTF("ganged power switching\n");
		break;
	case 0x01:
		USB_HUB_PRINTF("individual port power switching\n");
		break;
	case 0x02:
	case 0x03:
		USB_HUB_PRINTF("unknown reserved power switching mode\n");
		break;
	}

	if (hubCharacteristics & HUB_CHAR_COMPOUND)
		USB_HUB_PRINTF("part of a compound device\n");
	else
		USB_HUB_PRINTF("standalone hub\n");

	switch (hubCharacteristics & HUB_CHAR_OCPM) {
	case 0x00:
		USB_HUB_PRINTF("global over-current protection\n");
		break;
	case 0x08:
		USB_HUB_PRINTF("individual port over-current protection\n");
		break;
	case 0x10:
	case 0x18:
		USB_HUB_PRINTF("no over-current protection\n");
		break;
	}

	USB_HUB_PRINTF("power on to power good time: %dms\n",
			descriptor->bPwrOn2PwrGood * 2);
	USB_HUB_PRINTF("hub controller current requirement: %dmA\n",
			descriptor->bHubContrCurrent);

	for (i = 0; i < dev->maxchild; i++)
		USB_HUB_PRINTF("port %d is%s removable\n", i + 1,
			hub->desc.DeviceRemovable[(i + 1) / 8] & \
					   (1 << ((i + 1) % 8)) ? " not" : "");

	if (sizeof(struct usb_hub_status) > USB_BUFSIZ) {
		USB_HUB_PRINTF("usb_hub_configure: failed to get Status - " \
				"too long: %d\n", descriptor->bLength);
		return -1;
	}

	if (usb_get_hub_status(dev, buffer) < 0) {
		USB_HUB_PRINTF("usb_hub_configure: failed to get Status %lX\n",
				dev->status);
		return -1;
	}

#ifdef USB_HUB_DEBUG
	hubsts = (struct usb_hub_status *)buffer;
#endif
	USB_HUB_PRINTF("get_hub_status returned status %X, change %X\n",
			le16_to_cpu(hubsts->wHubStatus),
			le16_to_cpu(hubsts->wHubChange));
	USB_HUB_PRINTF("local power source is %s\n",
		(le16_to_cpu(hubsts->wHubStatus) & HUB_STATUS_LOCAL_POWER) ? \
		"lost (inactive)" : "good");
	USB_HUB_PRINTF("%sover-current condition exists\n",
		(le16_to_cpu(hubsts->wHubStatus) & HUB_STATUS_OVERCURRENT) ? \
		"" : "no ");
	usb_hub_power_on(hub);

	for (i = 0; i < dev->maxchild; i++) {
		ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
		unsigned short portstatus, portchange;
		int ret;
		ulong start = get_timer(0);

		/*
		 * Wait for (whichever finishes first)
		 *  - A maximum of 10 seconds
		 *    This is a purely observational value driven by connecting
		 *    a few broken pen drives and taking the max * 1.5 approach
		 *  - connection_change and connection state to report same
		 *    state
		 */
		do {
			ret = usb_get_port_status(dev, i + 1, portsts);
			if (ret < 0) {
				USB_HUB_PRINTF("get_port_status failed\n");
				break;
			}

			portstatus = le16_to_cpu(portsts->wPortStatus);
			portchange = le16_to_cpu(portsts->wPortChange);

			if ((portchange & USB_PORT_STAT_C_CONNECTION) ==
				(portstatus & USB_PORT_STAT_CONNECTION))
				break;

			mdelay(100);
		} while (get_timer(start) < CONFIG_SYS_HZ * 10);

		if (ret < 0)
			continue;

		USB_HUB_PRINTF("Port %d Status %X Change %X\n",
				i + 1, portstatus, portchange);

		if (portchange & USB_PORT_STAT_C_CONNECTION) {
			USB_HUB_PRINTF("port %d connection change\n", i + 1);
			usb_hub_port_connect_change(dev, i);
		}
		if (portchange & USB_PORT_STAT_C_ENABLE) {
			USB_HUB_PRINTF("port %d enable change, status %x\n",
					i + 1, portstatus);
			usb_clear_port_feature(dev, i + 1,
						USB_PORT_FEAT_C_ENABLE);

			/* EM interference sometimes causes bad shielded USB
			 * devices to be shutdown by the hub, this hack enables
			 * them again. Works at least with mouse driver */
			if (!(portstatus & USB_PORT_STAT_ENABLE) &&
			     (portstatus & USB_PORT_STAT_CONNECTION) &&
			     ((dev->children[i]))) {
				USB_HUB_PRINTF("already running port %i "  \
						"disabled by hub (EMI?), " \
						"re-enabling...\n", i + 1);
					usb_hub_port_connect_change(dev, i);
			}
		}
		if (portstatus & USB_PORT_STAT_SUSPEND) {
			USB_HUB_PRINTF("port %d suspend change\n", i + 1);
			usb_clear_port_feature(dev, i + 1,
						USB_PORT_FEAT_SUSPEND);
		}

		if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
			USB_HUB_PRINTF("port %d over-current change\n", i + 1);
			usb_clear_port_feature(dev, i + 1,
						USB_PORT_FEAT_C_OVER_CURRENT);
			usb_hub_power_on(hub);
		}

		if (portchange & USB_PORT_STAT_C_RESET) {
			USB_HUB_PRINTF("port %d reset change\n", i + 1);
			usb_clear_port_feature(dev, i + 1,
						USB_PORT_FEAT_C_RESET);
		}
	} /* end for i all ports */

	return 0;
}

int usb_hub_probe(struct usb_device *dev, int ifnum)
{
	struct usb_interface *iface;
	struct usb_endpoint_descriptor *ep;
	int ret;

	iface = &dev->config.if_desc[ifnum];
	/* Is it a hub? */
	if (iface->desc.bInterfaceClass != USB_CLASS_HUB)
		return 0;
	/* Some hubs have a subclass of 1, which AFAICT according to the */
	/*  specs is not defined, but it works */
	if ((iface->desc.bInterfaceSubClass != 0) &&
	    (iface->desc.bInterfaceSubClass != 1))
		return 0;
	/* Multiple endpoints? What kind of mutant ninja-hub is this? */
	if (iface->desc.bNumEndpoints != 1)
		return 0;
	ep = &iface->ep_desc[0];
	/* Output endpoint? Curiousier and curiousier.. */
	if (!(ep->bEndpointAddress & USB_DIR_IN))
		return 0;
	/* If it's not an interrupt endpoint, we'd better punt! */
	if ((ep->bmAttributes & 3) != 3)
		return 0;
	/* We found a hub */
	USB_HUB_PRINTF("USB hub found\n");
	ret = usb_hub_configure(dev);
	return ret;
}
Commit	Line	Data
23faf2bc MV	1	/*
	2	*
	3	* Most of this source has been derived from the Linux USB
	4	* project:
	5	* (C) Copyright Linus Torvalds 1999
	6	* (C) Copyright Johannes Erdfelt 1999-2001
	7	* (C) Copyright Andreas Gal 1999
	8	* (C) Copyright Gregory P. Smith 1999
	9	* (C) Copyright Deti Fliegl 1999 (new USB architecture)
	10	* (C) Copyright Randy Dunlap 2000
	11	* (C) Copyright David Brownell 2000 (kernel hotplug, usb_device_id)
	12	* (C) Copyright Yggdrasil Computing, Inc. 2000
	13	* (usb_device_id matching changes by Adam J. Richter)
	14	*
	15	* Adapted for U-Boot:
	16	* (C) Copyright 2001 Denis Peter, MPL AG Switzerland
	17	*
	18	* See file CREDITS for list of people who contributed to this
	19	* project.
	20	*
	21	* This program is free software; you can redistribute it and/or
	22	* modify it under the terms of the GNU General Public License as
	23	* published by the Free Software Foundation; either version 2 of
	24	* the License, or (at your option) any later version.
	25	*
	26	* This program is distributed in the hope that it will be useful,
	27	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	28	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	29	* GNU General Public License for more details.
	30	*
	31	* You should have received a copy of the GNU General Public License
	32	* along with this program; if not, write to the Free Software
	33	* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
	34	* MA 02111-1307 USA
	35	*
	36	*/
	37
	38	/****************************************************************************
	39	* HUB "Driver"
	40	* Probes device for being a hub and configurate it
	41	*/
	42
	43	#include <common.h>
	44	#include <command.h>
	45	#include <asm/processor.h>
93ad908c	46	#include <asm/unaligned.h>
23faf2bc MV	47	#include <linux/ctype.h>
	48	#include <asm/byteorder.h>
	49	#include <asm/unaligned.h>
	50
	51	#include <usb.h>
	52	#ifdef CONFIG_4xx
	53	#include <asm/4xx_pci.h>
	54	#endif
	55
	56	#ifdef DEBUG
	57	#define USB_DEBUG 1
	58	#define USB_HUB_DEBUG 1
	59	#else
	60	#define USB_DEBUG 0
	61	#define USB_HUB_DEBUG 0
	62	#endif
	63
	64	#define USB_PRINTF(fmt, args...) debug_cond(USB_DEBUG, fmt, ##args)
	65	#define USB_HUB_PRINTF(fmt, args...) debug_cond(USB_HUB_DEBUG, fmt, ##args)
	66
	67	#define USB_BUFSIZ 512
	68
	69	static struct usb_hub_device hub_dev[USB_MAX_HUB];
	70	static int usb_hub_index;
	71
	72
	73	static int usb_get_hub_descriptor(struct usb_device dev, void data, int size)
	74	{
	75	return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
	76	USB_REQ_GET_DESCRIPTOR, USB_DIR_IN \| USB_RT_HUB,
	77	USB_DT_HUB << 8, 0, data, size, USB_CNTL_TIMEOUT);
	78	}
	79
	80	static int usb_clear_port_feature(struct usb_device *dev, int port, int feature)
	81	{
	82	return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
	83	USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature,
	84	port, NULL, 0, USB_CNTL_TIMEOUT);
	85	}
	86
	87	static int usb_set_port_feature(struct usb_device *dev, int port, int feature)
	88	{
	89	return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
	90	USB_REQ_SET_FEATURE, USB_RT_PORT, feature,
	91	port, NULL, 0, USB_CNTL_TIMEOUT);
	92	}
	93
	94	static int usb_get_hub_status(struct usb_device dev, void data)
	95	{
	96	return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
	97	USB_REQ_GET_STATUS, USB_DIR_IN \| USB_RT_HUB, 0, 0,
	98	data, sizeof(struct usb_hub_status), USB_CNTL_TIMEOUT);
	99	}
	100
	101	static int usb_get_port_status(struct usb_device dev, int port, void data)
	102	{
	103	return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
	104	USB_REQ_GET_STATUS, USB_DIR_IN \| USB_RT_PORT, 0, port,
	105	data, sizeof(struct usb_hub_status), USB_CNTL_TIMEOUT);
	106	}
	107
	108
	109	static void usb_hub_power_on(struct usb_hub_device *hub)
	110	{
111	int i;
112	struct usb_device *dev;
a1a28c6e	113	unsigned pgood_delay = hub->desc.bPwrOn2PwrGood * 2;
23faf2bc MV	114
	115	dev = hub->pusb_dev;
	116	/* Enable power to the ports */
	117	USB_HUB_PRINTF("enabling power on all ports\n");
	118	for (i = 0; i < dev->maxchild; i++) {
	119	usb_set_port_feature(dev, i + 1, USB_PORT_FEAT_POWER);
	120	USB_HUB_PRINTF("port %d returns %lX\n", i + 1, dev->status);
23faf2bc	121	}
a1a28c6e WG	122
a1a28c6e WG	123	/* Wait at least 100 msec for power to become stable */
5b84dd67	124	mdelay(max(pgood_delay, (unsigned)100));
23faf2bc MV	125	}
	126
	127	void usb_hub_reset(void)
	128	{
	129	usb_hub_index = 0;
	130	}
	131
	132	static struct usb_hub_device *usb_hub_allocate(void)
	133	{
	134	if (usb_hub_index < USB_MAX_HUB)
	135	return &hub_dev[usb_hub_index++];
	136
	137	printf("ERROR: USB_MAX_HUB (%d) reached\n", USB_MAX_HUB);
	138	return NULL;
	139	}
	140
	141	#define MAX_TRIES 5
	142
	143	static inline char *portspeed(int portstatus)
	144	{
	145	if (portstatus & (1 << USB_PORT_FEAT_HIGHSPEED))
	146	return "480 Mb/s";
	147	else if (portstatus & (1 << USB_PORT_FEAT_LOWSPEED))
	148	return "1.5 Mb/s";
	149	else
	150	return "12 Mb/s";
	151	}
	152
	153	int hub_port_reset(struct usb_device *dev, int port,
	154	unsigned short *portstat)
	155	{
	156	int tries;
f5766139	157	ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
23faf2bc MV	158	unsigned short portstatus, portchange;
	159
	160	USB_HUB_PRINTF("hub_port_reset: resetting port %d...\n", port);
	161	for (tries = 0; tries < MAX_TRIES; tries++) {
	162
	163	usb_set_port_feature(dev, port + 1, USB_PORT_FEAT_RESET);
5b84dd67	164	mdelay(200);
23faf2bc	165
f5766139	166	if (usb_get_port_status(dev, port + 1, portsts) < 0) {
23faf2bc MV	167	USB_HUB_PRINTF("get_port_status failed status %lX\n",
	168	dev->status);
	169	return -1;
	170	}
f5766139 PS	171	portstatus = le16_to_cpu(portsts->wPortStatus);
f5766139 PS	172	portchange = le16_to_cpu(portsts->wPortChange);
23faf2bc MV	173
	174	USB_HUB_PRINTF("portstatus %x, change %x, %s\n",
	175	portstatus, portchange,
	176	portspeed(portstatus));
	177
	178	USB_HUB_PRINTF("STAT_C_CONNECTION = %d STAT_CONNECTION = %d" \
	179	" USB_PORT_STAT_ENABLE %d\n",
	180	(portchange & USB_PORT_STAT_C_CONNECTION) ? 1 : 0,
	181	(portstatus & USB_PORT_STAT_CONNECTION) ? 1 : 0,
	182	(portstatus & USB_PORT_STAT_ENABLE) ? 1 : 0);
	183
	184	if ((portchange & USB_PORT_STAT_C_CONNECTION) \|\|
	185	!(portstatus & USB_PORT_STAT_CONNECTION))
	186	return -1;
	187
	188	if (portstatus & USB_PORT_STAT_ENABLE)
	189	break;
	190
5b84dd67	191	mdelay(200);
23faf2bc MV	192	}
	193
	194	if (tries == MAX_TRIES) {
	195	USB_HUB_PRINTF("Cannot enable port %i after %i retries, " \
	196	"disabling port.\n", port + 1, MAX_TRIES);
	197	USB_HUB_PRINTF("Maybe the USB cable is bad?\n");
	198	return -1;
	199	}
	200
	201	usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_RESET);
	202	*portstat = portstatus;
	203	return 0;
	204	}
	205
	206
	207	void usb_hub_port_connect_change(struct usb_device *dev, int port)
	208	{
	209	struct usb_device *usb;
f5766139	210	ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
23faf2bc MV	211	unsigned short portstatus;
	212
	213	/* Check status */
f5766139	214	if (usb_get_port_status(dev, port + 1, portsts) < 0) {
23faf2bc MV	215	USB_HUB_PRINTF("get_port_status failed\n");
	216	return;
	217	}
	218
f5766139	219	portstatus = le16_to_cpu(portsts->wPortStatus);
23faf2bc MV	220	USB_HUB_PRINTF("portstatus %x, change %x, %s\n",
23faf2bc MV	221	portstatus,
f5766139	222	le16_to_cpu(portsts->wPortChange),
23faf2bc MV	223	portspeed(portstatus));
	224
	225	/* Clear the connection change status */
	226	usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_CONNECTION);
	227
	228	/* Disconnect any existing devices under this port */
	229	if (((!(portstatus & USB_PORT_STAT_CONNECTION)) &&
	230	(!(portstatus & USB_PORT_STAT_ENABLE))) \|\| (dev->children[port])) {
	231	USB_HUB_PRINTF("usb_disconnect(&hub->children[port]);\n");
	232	/* Return now if nothing is connected */
	233	if (!(portstatus & USB_PORT_STAT_CONNECTION))
	234	return;
	235	}
5b84dd67	236	mdelay(200);
23faf2bc MV	237
	238	/* Reset the port */
	239	if (hub_port_reset(dev, port, &portstatus) < 0) {
	240	printf("cannot reset port %i!?\n", port + 1);
	241	return;
	242	}
	243
5b84dd67	244	mdelay(200);
23faf2bc MV	245
23faf2bc MV	246	/* Allocate a new device struct for it */
c7e3b2b5	247	usb = usb_alloc_new_device(dev->controller);
23faf2bc MV	248
	249	if (portstatus & USB_PORT_STAT_HIGH_SPEED)
	250	usb->speed = USB_SPEED_HIGH;
	251	else if (portstatus & USB_PORT_STAT_LOW_SPEED)
	252	usb->speed = USB_SPEED_LOW;
	253	else
	254	usb->speed = USB_SPEED_FULL;
	255
	256	dev->children[port] = usb;
	257	usb->parent = dev;
	258	usb->portnr = port + 1;
	259	/* Run it through the hoops (find a driver, etc) */
	260	if (usb_new_device(usb)) {
	261	/* Woops, disable the port */
	262	USB_HUB_PRINTF("hub: disabling port %d\n", port + 1);
	263	usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_ENABLE);
	264	}
	265	}
	266
	267
	268	static int usb_hub_configure(struct usb_device *dev)
	269	{
	270	int i;
f5766139 PS	271	ALLOC_CACHE_ALIGN_BUFFER(unsigned char, buffer, USB_BUFSIZ);
f5766139 PS	272	unsigned char *bitmap;
93ad908c	273	short hubCharacteristics;
23faf2bc MV	274	struct usb_hub_descriptor *descriptor;
	275	struct usb_hub_device *hub;
	276	#ifdef USB_HUB_DEBUG
	277	struct usb_hub_status *hubsts;
	278	#endif
	279
	280	/* "allocate" Hub device */
	281	hub = usb_hub_allocate();
	282	if (hub == NULL)
	283	return -1;
	284	hub->pusb_dev = dev;
	285	/* Get the the hub descriptor */
	286	if (usb_get_hub_descriptor(dev, buffer, 4) < 0) {
	287	USB_HUB_PRINTF("usb_hub_configure: failed to get hub " \
	288	"descriptor, giving up %lX\n", dev->status);
	289	return -1;
	290	}
	291	descriptor = (struct usb_hub_descriptor *)buffer;
	292
	293	/* silence compiler warning if USB_BUFSIZ is > 256 [= sizeof(char)] */
	294	i = descriptor->bLength;
	295	if (i > USB_BUFSIZ) {
	296	USB_HUB_PRINTF("usb_hub_configure: failed to get hub " \
	297	"descriptor - too long: %d\n",
	298	descriptor->bLength);
	299	return -1;
	300	}
	301
	302	if (usb_get_hub_descriptor(dev, buffer, descriptor->bLength) < 0) {
	303	USB_HUB_PRINTF("usb_hub_configure: failed to get hub " \
	304	"descriptor 2nd giving up %lX\n", dev->status);
	305	return -1;
	306	}
	307	memcpy((unsigned char *)&hub->desc, buffer, descriptor->bLength);
	308	/* adjust 16bit values */
93ad908c LS	309	put_unaligned(le16_to_cpu(get_unaligned(
	310	&descriptor->wHubCharacteristics)),
	311	&hub->desc.wHubCharacteristics);
23faf2bc MV	312	/* set the bitmap */
	313	bitmap = (unsigned char *)&hub->desc.DeviceRemovable[0];
	314	/* devices not removable by default */
	315	memset(bitmap, 0xff, (USB_MAXCHILDREN+1+7)/8);
	316	bitmap = (unsigned char *)&hub->desc.PortPowerCtrlMask[0];
	317	memset(bitmap, 0xff, (USB_MAXCHILDREN+1+7)/8); /* PowerMask = 1B */
	318
	319	for (i = 0; i < ((hub->desc.bNbrPorts + 1 + 7)/8); i++)
	320	hub->desc.DeviceRemovable[i] = descriptor->DeviceRemovable[i];
	321
	322	for (i = 0; i < ((hub->desc.bNbrPorts + 1 + 7)/8); i++)
	323	hub->desc.PortPowerCtrlMask[i] = descriptor->PortPowerCtrlMask[i];
	324
	325	dev->maxchild = descriptor->bNbrPorts;
	326	USB_HUB_PRINTF("%d ports detected\n", dev->maxchild);
	327
93ad908c LS	328	hubCharacteristics = get_unaligned(&hub->desc.wHubCharacteristics);
93ad908c LS	329	switch (hubCharacteristics & HUB_CHAR_LPSM) {
23faf2bc MV	330	case 0x00:
	331	USB_HUB_PRINTF("ganged power switching\n");
	332	break;
	333	case 0x01:
	334	USB_HUB_PRINTF("individual port power switching\n");
	335	break;
	336	case 0x02:
	337	case 0x03:
	338	USB_HUB_PRINTF("unknown reserved power switching mode\n");
	339	break;
	340	}
	341
93ad908c	342	if (hubCharacteristics & HUB_CHAR_COMPOUND)
23faf2bc MV	343	USB_HUB_PRINTF("part of a compound device\n");
	344	else
	345	USB_HUB_PRINTF("standalone hub\n");
	346
93ad908c	347	switch (hubCharacteristics & HUB_CHAR_OCPM) {
23faf2bc MV	348	case 0x00:
	349	USB_HUB_PRINTF("global over-current protection\n");
	350	break;
	351	case 0x08:
	352	USB_HUB_PRINTF("individual port over-current protection\n");
	353	break;
	354	case 0x10:
	355	case 0x18:
	356	USB_HUB_PRINTF("no over-current protection\n");
	357	break;
	358	}
	359
	360	USB_HUB_PRINTF("power on to power good time: %dms\n",
	361	descriptor->bPwrOn2PwrGood * 2);
	362	USB_HUB_PRINTF("hub controller current requirement: %dmA\n",
	363	descriptor->bHubContrCurrent);
	364
	365	for (i = 0; i < dev->maxchild; i++)
	366	USB_HUB_PRINTF("port %d is%s removable\n", i + 1,
	367	hub->desc.DeviceRemovable[(i + 1) / 8] & \
	368	(1 << ((i + 1) % 8)) ? " not" : "");
	369
	370	if (sizeof(struct usb_hub_status) > USB_BUFSIZ) {
	371	USB_HUB_PRINTF("usb_hub_configure: failed to get Status - " \
	372	"too long: %d\n", descriptor->bLength);
	373	return -1;
	374	}
	375
	376	if (usb_get_hub_status(dev, buffer) < 0) {
	377	USB_HUB_PRINTF("usb_hub_configure: failed to get Status %lX\n",
	378	dev->status);
	379	return -1;
	380	}
	381
	382	#ifdef USB_HUB_DEBUG
	383	hubsts = (struct usb_hub_status *)buffer;
	384	#endif
	385	USB_HUB_PRINTF("get_hub_status returned status %X, change %X\n",
	386	le16_to_cpu(hubsts->wHubStatus),
	387	le16_to_cpu(hubsts->wHubChange));
	388	USB_HUB_PRINTF("local power source is %s\n",
	389	(le16_to_cpu(hubsts->wHubStatus) & HUB_STATUS_LOCAL_POWER) ? \
	390	"lost (inactive)" : "good");
	391	USB_HUB_PRINTF("%sover-current condition exists\n",
	392	(le16_to_cpu(hubsts->wHubStatus) & HUB_STATUS_OVERCURRENT) ? \
	393	"" : "no ");
	394	usb_hub_power_on(hub);
	395
	396	for (i = 0; i < dev->maxchild; i++) {
f5766139	397	ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
23faf2bc	398	unsigned short portstatus, portchange;
b6d7852c VK	399	int ret;
	400	ulong start = get_timer(0);
	401
	402	/*
	403	* Wait for (whichever finishes first)
	404	* - A maximum of 10 seconds
	405	* This is a purely observational value driven by connecting
	406	* a few broken pen drives and taking the max * 1.5 approach
	407	* - connection_change and connection state to report same
	408	* state
	409	*/
	410	do {
	411	ret = usb_get_port_status(dev, i + 1, portsts);
	412	if (ret < 0) {
	413	USB_HUB_PRINTF("get_port_status failed\n");
	414	break;
	415	}
	416
	417	portstatus = le16_to_cpu(portsts->wPortStatus);
	418	portchange = le16_to_cpu(portsts->wPortChange);
	419
	420	if ((portchange & USB_PORT_STAT_C_CONNECTION) ==
	421	(portstatus & USB_PORT_STAT_CONNECTION))
	422	break;
	423
	424	mdelay(100);
	425	} while (get_timer(start) < CONFIG_SYS_HZ * 10);
	426
	427	if (ret < 0)
23faf2bc	428	continue;
23faf2bc	429
23faf2bc MV	430	USB_HUB_PRINTF("Port %d Status %X Change %X\n",
	431	i + 1, portstatus, portchange);
	432
	433	if (portchange & USB_PORT_STAT_C_CONNECTION) {
	434	USB_HUB_PRINTF("port %d connection change\n", i + 1);
	435	usb_hub_port_connect_change(dev, i);
	436	}
	437	if (portchange & USB_PORT_STAT_C_ENABLE) {
	438	USB_HUB_PRINTF("port %d enable change, status %x\n",
	439	i + 1, portstatus);
	440	usb_clear_port_feature(dev, i + 1,
	441	USB_PORT_FEAT_C_ENABLE);
	442
	443	/* EM interference sometimes causes bad shielded USB
	444	* devices to be shutdown by the hub, this hack enables
	445	* them again. Works at least with mouse driver */
	446	if (!(portstatus & USB_PORT_STAT_ENABLE) &&
	447	(portstatus & USB_PORT_STAT_CONNECTION) &&
	448	((dev->children[i]))) {
	449	USB_HUB_PRINTF("already running port %i " \
	450	"disabled by hub (EMI?), " \
	451	"re-enabling...\n", i + 1);
	452	usb_hub_port_connect_change(dev, i);
	453	}
	454	}
	455	if (portstatus & USB_PORT_STAT_SUSPEND) {
	456	USB_HUB_PRINTF("port %d suspend change\n", i + 1);
	457	usb_clear_port_feature(dev, i + 1,
	458	USB_PORT_FEAT_SUSPEND);
	459	}
	460
	461	if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
	462	USB_HUB_PRINTF("port %d over-current change\n", i + 1);
	463	usb_clear_port_feature(dev, i + 1,
	464	USB_PORT_FEAT_C_OVER_CURRENT);
	465	usb_hub_power_on(hub);
	466	}
	467
	468	if (portchange & USB_PORT_STAT_C_RESET) {
	469	USB_HUB_PRINTF("port %d reset change\n", i + 1);
	470	usb_clear_port_feature(dev, i + 1,
	471	USB_PORT_FEAT_C_RESET);
	472	}
	473	} /* end for i all ports */
	474
	475	return 0;
	476	}
	477
	478	int usb_hub_probe(struct usb_device *dev, int ifnum)
	479	{
	480	struct usb_interface *iface;
	481	struct usb_endpoint_descriptor *ep;
	482	int ret;
	483
	484	iface = &dev->config.if_desc[ifnum];
	485	/* Is it a hub? */
	486	if (iface->desc.bInterfaceClass != USB_CLASS_HUB)
	487	return 0;
	488	/* Some hubs have a subclass of 1, which AFAICT according to the */
	489	/* specs is not defined, but it works */
	490	if ((iface->desc.bInterfaceSubClass != 0) &&
	491	(iface->desc.bInterfaceSubClass != 1))
	492	return 0;
	493	/* Multiple endpoints? What kind of mutant ninja-hub is this? */
494	if (iface->desc.bNumEndpoints != 1)
495	return 0;
496	ep = &iface->ep_desc[0];
497	/* Output endpoint? Curiousier and curiousier.. */
498	if (!(ep->bEndpointAddress & USB_DIR_IN))
499	return 0;
500	/* If it's not an interrupt endpoint, we'd better punt! */
501	if ((ep->bmAttributes & 3) != 3)
502	return 0;
503	/* We found a hub */
504	USB_HUB_PRINTF("USB hub found\n");
505	ret = usb_hub_configure(dev);
506	return ret;
507	}