coreboot-kgpe-d16/payloads/libpayload/drivers/usb/usbhub.c

/*
 * This file is part of the libpayload project.
 *
 * Copyright (C) 2008 coresystems GmbH
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#include "usb.h"

// assume that host_to_device is overwritten if necessary
#define DR_PORT gen_bmRequestType(host_to_device, class_type, other_recp)
#define PORT_RESET 0x4
#define PORT_POWER 0x8

typedef struct {
	int num_ports;
	int *ports;
	hub_descriptor_t *descriptor;
} usbhub_inst_t;

#define HUB_INST(dev) ((usbhub_inst_t*)(dev)->data)

static void
usb_hub_destroy (usbdev_t *dev)
{
	free (HUB_INST (dev)->ports);
	free (HUB_INST (dev)->descriptor);
	free (HUB_INST (dev));
}

static void
usb_hub_scanport (usbdev_t *dev, int port)
{
	int newdev;
	unsigned short buf[2];
	usbdev_t *newdev_t;

	get_status (dev, port, DR_PORT, 4, buf);
	int portstatus = ((buf[0] & 1) == 0);
	int datastatus = (HUB_INST (dev)->ports[port] == -1);
	if (portstatus == datastatus)
		return;		// no change - FIXME: read right fields for that test

	if (!datastatus) {
		int devno = HUB_INST (dev)->ports[port];
		if (devno == -1)
			fatal ("FATAL: illegal devno!\n");
		dev->controller->devices[devno].destroy (&dev->controller->
							 devices[devno]);
		init_device_entry (dev->controller, devno);
		HUB_INST (dev)->ports[port] = -1;
		return;
	}

	set_feature (dev, port, PORT_RESET, DR_PORT);
	mdelay (20);

	get_status (dev, port, DR_PORT, 4, buf);
	int lowspeed = (buf[0] >> 9) & 1;

	newdev = set_address (dev->controller, lowspeed);
	if (newdev == -1)
		return;
	newdev_t = &dev->controller->devices[newdev];

	HUB_INST (dev)->ports[port] = newdev;
	newdev_t->address = newdev;
	newdev_t->hub = dev->address;
	newdev_t->port = port;
	// determine responsible driver
	newdev_t->init (newdev_t);
}

static int
usb_hub_report_port_changes (usbdev_t *dev)
{
	int port;
	unsigned short buf[2];
	for (port = 1; port <= HUB_INST (dev)->num_ports; port++) {
		get_status (dev, port, DR_PORT, 4, buf);
		// FIXME: proper change detection
		int portstatus = ((buf[0] & 1) == 0);
		int datastatus = (HUB_INST (dev)->ports[port] == -1);
		if (portstatus != datastatus)
			return port;
	}

// no change
	return -1;
}

static void
usb_hub_enable_port (usbdev_t *dev, int port)
{
	set_feature (dev, port, PORT_POWER, DR_PORT);
	mdelay (20);
}

#if 0
static void
usb_hub_disable_port (usbdev_t *dev, int port)
{
}
#endif

static void
usb_hub_poll (usbdev_t *dev)
{
	int port;
	while ((port = usb_hub_report_port_changes (dev)) != -1)
		usb_hub_scanport (dev, port);
}

void
usb_hub_init (usbdev_t *dev)
{
	int i;
	dev->destroy = usb_hub_destroy;
	dev->poll = usb_hub_poll;

	dev->data = malloc (sizeof (usbhub_inst_t));

	HUB_INST (dev)->descriptor =
		(hub_descriptor_t *) get_descriptor (dev,
						     gen_bmRequestType
						     (device_to_host,
						      class_type, dev_recp),
						     0x29, 0, 0);
	HUB_INST (dev)->num_ports = HUB_INST (dev)->descriptor->bNbrPorts;
	HUB_INST (dev)->ports =
		malloc (sizeof (int) * (HUB_INST (dev)->num_ports + 1));
	for (i = 1; i <= HUB_INST (dev)->num_ports; i++)
		HUB_INST (dev)->ports[i] = -1;
	for (i = 1; i <= HUB_INST (dev)->num_ports; i++)
		usb_hub_enable_port (dev, i);
}