teensy-usbhost/hub.cpp

/* USB EHCI Host for Teensy 3.6
 * Copyright 2017 Paul Stoffregen (paul@pjrc.com)
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#include <Arduino.h>
#include "USBHost.h"

USBHub::USBHub()
{
	// TODO: free Device_t, Pipe_t & Transfer_t we will need
	driver_ready_for_device(this);
}

bool USBHub::claim(Device_t *dev, int type, const uint8_t *descriptors, uint32_t len)
{
	// only claim entire device, never at interface level
	if (type != 0) return false;

	println("USBHub claim_device this=", (uint32_t)this, HEX);

	// check for HUB type
	if (dev->bDeviceClass != 9 || dev->bDeviceSubClass != 0) return false;
	// protocol must be 0=FS, 1=HS Single-TT, or 2=HS Multi-TT
	if (dev->bDeviceProtocol > 2) return false;
	// check for endpoint descriptor
	if (descriptors[9] != 7 || descriptors[10] != 5) return false;
	// endpoint must be IN direction
	if ((descriptors[11] & 0xF0) != 0x80) return false;
	// endpoint type must be interrupt
	if (descriptors[12] != 3) return false;
	// get the endpoint number, must not be zero
	endpoint = descriptors[11] & 0x0F;
	if (endpoint == 0) return false;
	// get the maximum packet size
	uint32_t maxsize = descriptors[13] | (descriptors[14] << 8);
	if (maxsize == 0) return false;
	if (maxsize > 1) return false; // do hub chips with > 7 ports exist?

	println(descriptors[9]);
	println(descriptors[10]);
	println(descriptors[11], HEX);
	println(maxsize);
	// bDeviceProtocol = 0 is full speed
	// bDeviceProtocol = 1 is high speed single TT
	// bDeviceProtocol = 2 is high speed multiple TT

	println("bDeviceClass = ", dev->bDeviceClass);
	println("bDeviceSubClass = ", dev->bDeviceSubClass);
	println("bDeviceProtocol = ", dev->bDeviceProtocol);

	changepipe = NULL;
	changebits = 0;
	state = 0;
	memset(portstatus, 0, sizeof(portstatus));
	memset(portstate, 0, sizeof(portstate));

	mk_setup(setup, 0xA0, 6, 0x2900, 0, sizeof(hub_desc));
	queue_Control_Transfer(dev, &setup, hub_desc, this);

	return true;
}

void USBHub::poweron(uint32_t port)
{
	mk_setup(setup, 0x23, 3, 8, port, 0);
	queue_Control_Transfer(device, &setup, NULL, this);
}

void USBHub::getstatus(uint32_t port)
{
	if (port == 0) {
		mk_setup(setup, 0xA0, 0, 0, port, 4); // get hub status
	} else {
		mk_setup(setup, 0xA3, 0, 0, port, 4); // get port status
	}
	queue_Control_Transfer(device, &setup, &statusbits, this);
}

void USBHub::clearstatus(uint32_t port)
{
	if (port == 0) {
		mk_setup(setup, 0x20, 1, 0x10, port, 0); // clear hub status
	} else {
		mk_setup(setup, 0x23, 1, 0x10, port, 0); // clear port status
	}
	queue_Control_Transfer(device, &setup, NULL, this);
}

void USBHub::reset(uint32_t port)
{
	mk_setup(setup, 0x23, 3, 4, port, 0); // set feature PORT_RESET
	queue_Control_Transfer(device, &setup, NULL, this);
}


void USBHub::control(const Transfer_t *transfer)
{
	println("USBHub control callback");
	print_hexbytes(transfer->buffer, transfer->length);

	if (state == 0) {
		// read hub descriptor to learn hub's capabilities
		// Hub Descriptor, USB 2.0, 11.23.2.1 page 417
		if (hub_desc[0] == 9 && hub_desc[1] == 0x29) {
			numports = hub_desc[2];
			characteristics = hub_desc[3];
			powertime = hub_desc[5];
			// TODO: do we need to use the DeviceRemovable
			// bits to mke synthetic device connect events?
			print("Hub has ");
			print(numports);
			println(" ports");
			state = 1;
			poweron(1);
		}
	} else if (state < numports) {
		// turn on power to all ports
		poweron(++state);
	} else if (state == numports) {
		println("power turned on to all ports");
		println("device addr = ", device->address);
		changepipe = new_Pipe(device, 3, endpoint, 1, 1, 512);
		println("pipe cap1 = ", changepipe->qh.capabilities[0], HEX);
		changepipe->callback_function = callback;
		queue_Data_Transfer(changepipe, &changebits, 1, this);
		state = 255;
	} else if (state == 255) {
		// up and running...
		switch (setup.word1) {
		  case 0x000000A0: // get hub status
			println("New Hub Status");
			clearstatus(0);
			return;
		  case 0x000000A3: // get port status
			new_port_status(setup.wIndex, statusbits);
			clearstatus(setup.wIndex);
			return;
		  case 0x00100120: // clear hub status
			println("Hub Status Cleared");
			changebits &= ~1;
			break;
		  case 0x00100123: // clear port status
			println("Port Status Cleared, port=", setup.wIndex);
			changebits &= ~(1 << setup.wIndex);
			break;
		}
		update_status();
	}
}

void USBHub::callback(const Transfer_t *transfer)
{
	println("HUB Callback (static)");
	if (transfer->driver) ((USBHub *)(transfer->driver))->status_change(transfer);
}

void USBHub::status_change(const Transfer_t *transfer)
{
	println("HUB Callback (member)");
	println("status = ", changebits, HEX);
	// TODO: do something with the status change info
	update_status();
	queue_Data_Transfer(changepipe, &changebits, 1, this);
}

void USBHub::update_status()
{
	uint32_t i, mask;

	for (i=0, mask=1; i <= numports; i++, mask <<= 1) {
		if (changebits & mask) {
			getstatus(i);
			return;
		}
	}
}

void USBHub::new_port_status(uint32_t port, uint32_t status)
{
	if (port < 1 || port > 7) return;
	uint32_t priorstatus = portstatus[port - 1];
	portstatus[port] = status;

	print("New Port Status, port=");
	print(port);
	print(", status=");
	println(status, HEX);

	// status bits, USB 2.0: 11.24.2.7.1 page 427
	if (status & 0x0001) println("  Device is present: ");
	if (status & 0x0002) {
		println("  Enabled, speed = ");
		if (status & 0x0200) {
			print("1.5");
		} else {
			if (status & 0x0400) {
				print("480");
			} else {
				print("12");
			}
		}
		println(" Mbit/sec");
	}
	if (status & 0x0004) println("  Suspended");
	if (status & 0x0008) println("  Over-current");
	if (status & 0x0010) println("  Reset");
	if (status & 0x0100) println("  Has Power");
	if (status & 0x0800) println("  Test Mode");
	if (status & 0x1000) println("  Software Controls LEDs");

	if ((status & 0x0001) && !(priorstatus & 0x0001)) {
		println("    connect");
		// 100 ms debounce (USB 2.0: TATTDB, page 150 & 188)
		delay(100);  // TODO: horribly bad... need timing events
		reset(port);
		// TODO... reset timer?

	} else if (!(status & 0x0001) && (priorstatus & 0x0001)) {
		println("    disconnect");


	}

}


void USBHub::disconnect()
{
	// TODO: free resources
}


/*
config descriptor from a Multi-TT hub
09 02 29 00 01 01 00 E0 32
09 04 00 00 01 09 00 01 00
07 05 81 03 01 00 0C
09 04 00 01 01 09 00 02 00
07 05 81 03 01 00 0C
*/