mirrors/Bochs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
93523a657d
Bochs/bochs/iodev/usb_hub.cc
Volker Ruppert c2d0c207f7 - preparing Bochs for experimental USB xHCI support (written by Ben Lunt) TODO list: 
- add sources (update in progress)
  - update configure script
  - initialize new USB devices member 'max_packet_size' (need help from Ben)
2011-07-04 19:42:47 +00:00

690 lines
21 KiB
C++
Raw Blame History

/////////////////////////////////////////////////////////////////////////
// $Id$
/////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 2009-2011 The Bochs Project
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2 of the License, or (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
//
/////////////////////////////////////////////////////////////////////////
// USB hub emulation support ported from the Qemu project
// Define BX_PLUGGABLE in files that can be compiled into plugins. For
// platforms that require a special tag on exported symbols, BX_PLUGGABLE
// is used to know when we are exporting symbols and when we are importing.
#define BX_PLUGGABLE
#include "iodev.h"
#if BX_SUPPORT_PCI && BX_SUPPORT_PCIUSB
#include "usb_common.h"
#include "usb_hub.h"
#define LOG_THIS
#define ClearHubFeature (0x2000 | USB_REQ_CLEAR_FEATURE)
#define ClearPortFeature (0x2300 | USB_REQ_CLEAR_FEATURE)
#define GetHubDescriptor (0xa000 | USB_REQ_GET_DESCRIPTOR)
#define GetHubStatus (0xa000 | USB_REQ_GET_STATUS)
#define GetPortStatus (0xa300 | USB_REQ_GET_STATUS)
#define SetHubFeature (0x2000 | USB_REQ_SET_FEATURE)
#define SetPortFeature (0x2300 | USB_REQ_SET_FEATURE)
#define PORT_STAT_CONNECTION 0x0001
#define PORT_STAT_ENABLE 0x0002
#define PORT_STAT_SUSPEND 0x0004
#define PORT_STAT_OVERCURRENT 0x0008
#define PORT_STAT_RESET 0x0010
#define PORT_STAT_POWER 0x0100
#define PORT_STAT_LOW_SPEED 0x0200
#define PORT_STAT_HIGH_SPEED 0x0400
#define PORT_STAT_TEST 0x0800
#define PORT_STAT_INDICATOR 0x1000
#define PORT_STAT_C_CONNECTION 0x0001
#define PORT_STAT_C_ENABLE 0x0002
#define PORT_STAT_C_SUSPEND 0x0004
#define PORT_STAT_C_OVERCURRENT 0x0008
#define PORT_STAT_C_RESET 0x0010
#define PORT_CONNECTION 0
#define PORT_ENABLE 1
#define PORT_SUSPEND 2
#define PORT_OVERCURRENT 3
#define PORT_RESET 4
#define PORT_POWER 8
#define PORT_LOWSPEED 9
#define PORT_HIGHSPEED 10
#define PORT_C_CONNECTION 16
#define PORT_C_ENABLE 17
#define PORT_C_SUSPEND 18
#define PORT_C_OVERCURRENT 19
#define PORT_C_RESET 20
#define PORT_TEST 21
#define PORT_INDICATOR 22
static Bit32u serial_number = 1234;
static const Bit8u bx_hub_dev_descriptor[] = {
0x12, /* u8 bLength; */
0x01, /* u8 bDescriptorType; Device */
0x00, 0x02, /* u16 bcdUSB; v2.0 */
0x09, /* u8 bDeviceClass; HUB_CLASSCODE */
0x00, /* u8 bDeviceSubClass; */
0x00, /* u8 bDeviceProtocol; [ low/full speeds only ] */
0x40, /* u8 bMaxPacketSize0; 64 Bytes */
0x09, 0x04, /* u16 idVendor; */
0x5A, 0x00, /* u16 idProduct; */
0x00, 0x01, /* u16 bcdDevice */
0x00, /* u8 iManufacturer; */
0x00, /* u8 iProduct; */
0x00, /* u8 iSerialNumber; */
0x01 /* u8 bNumConfigurations; */
};
/* XXX: patch interrupt size */
static const Bit8u bx_hub_config_descriptor[] = {
/* one configuration */
0x09, /* u8 bLength; */
0x02, /* u8 bDescriptorType; Configuration */
0x19, 0x00, /* u16 wTotalLength; */
0x01, /* u8 bNumInterfaces; (1) */
0x01, /* u8 bConfigurationValue; */
0x00, /* u8 iConfiguration; */
0xE0, /* u8 bmAttributes;
Bit 7: must be set,
6: Self-powered,
5: Remote wakeup,
4..0: resvd */
0x32, /* u8 MaxPower; */
/* USB 1.1:
* USB 2.0, single TT organization (mandatory):
* one interface, protocol 0
*
* USB 2.0, multiple TT organization (optional):
* two interfaces, protocols 1 (like single TT)
* and 2 (multiple TT mode) ... config is
* sometimes settable
* NOT IMPLEMENTED
*/
/* one interface */
0x09, /* u8 if_bLength; */
0x04, /* u8 if_bDescriptorType; Interface */
0x00, /* u8 if_bInterfaceNumber; */
0x00, /* u8 if_bAlternateSetting; */
0x01, /* u8 if_bNumEndpoints; */
0x09, /* u8 if_bInterfaceClass; HUB_CLASSCODE */
0x00, /* u8 if_bInterfaceSubClass; */
0x00, /* u8 if_bInterfaceProtocol; [usb1.1 or single tt] */
0x00, /* u8 if_iInterface; */
/* one endpoint (status change endpoint) */
0x07, /* u8 ep_bLength; */
0x05, /* u8 ep_bDescriptorType; Endpoint */
0x81, /* u8 ep_bEndpointAddress; IN Endpoint 1 */
0x03, /* u8 ep_bmAttributes; Interrupt */
0x02, 0x00, /* u16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8) */
0xff /* u8 ep_bInterval; (255ms -- usb 2.0 spec) */
};
static const Bit8u bx_hub_hub_descriptor[] =
{
0x00, /* u8 bLength; patched in later */
0x29, /* u8 bDescriptorType; Hub-descriptor */
0x00, /* u8 bNbrPorts; (patched later) */
0xa9, /* u16 wHubCharacteristics; */
0x00, /* (per-port OC, no power switching) */
0x32, /* u8 bPwrOn2pwrGood; 2ms */
0x64 /* u8 bHubContrCurrent; 0 mA */
/* DeviceRemovable and PortPwrCtrlMask patched in later */
};
static int hub_count = 0;
usb_hub_device_c::usb_hub_device_c(Bit8u ports)
{
int i;
char pname[10];
char label[32];
bx_list_c *port;
bx_param_string_c *device, *options;
d.type = USB_DEV_TYPE_HUB;
d.maxspeed = USB_SPEED_FULL;
d.speed = d.maxspeed;
// TODO: d.max_packet_size = ???
strcpy(d.devname, "Bochs USB HUB");
d.connected = 1;
memset((void*)&hub, 0, sizeof(hub));
hub.n_ports = ports;
sprintf(hub.serial_number, "%d", serial_number++);
for(i = 0; i < hub.n_ports; i++) {
hub.usb_port[i].PortStatus = PORT_STAT_POWER;
hub.usb_port[i].PortChange = 0;
}
hub.device_change = 0;
// config options
bx_list_c *usb_rt = (bx_list_c*)SIM->get_param(BXPN_MENU_RUNTIME_USB);
sprintf(pname, "exthub%d", ++hub_count);
sprintf(label, "External Hub #%d Configuration", hub_count);
hub.config = new bx_list_c(usb_rt, pname, label, hub.n_ports);
hub.config->set_options(bx_list_c::SHOW_PARENT);
hub.config->set_runtime_param(1);
hub.config->set_device_param(this);
for(i = 0; i < hub.n_ports; i++) {
sprintf(pname, "port%d", i+1);
sprintf(label, "Port #%d Configuration", i+1);
port = new bx_list_c(hub.config, pname, label);
port->set_options(port->SERIES_ASK | port->USE_BOX_TITLE);
port->set_runtime_param(1);
device = new bx_param_string_c(port, "device", "Device", "", "", BX_PATHNAME_LEN);
device->set_handler(hub_param_handler);
device->set_runtime_param(1);
options = new bx_param_string_c(port, "options", "Options", "", "", BX_PATHNAME_LEN);
options->set_runtime_param(1);
}
#if BX_WITH_WX
bx_list_c *usb = (bx_list_c*)SIM->get_param("ports.usb");
usb->add(hub.config);
#endif
put("USBHB");
}
usb_hub_device_c::~usb_hub_device_c(void)
{
for (int i=0; i<hub.n_ports; i++) {
remove_device(i);
}
#if BX_WITH_WX
bx_list_c *usb = (bx_list_c*)SIM->get_param("ports.usb");
usb->remove(hub.config->get_name());
#endif
bx_list_c *usb_rt = (bx_list_c*)SIM->get_param(BXPN_MENU_RUNTIME_USB);
usb_rt->remove(hub.config->get_name());
}
void usb_hub_device_c::register_state_specific(bx_list_c *parent)
{
Bit8u i;
char portnum[6];
bx_list_c *port;
hub.state = new bx_list_c(parent, "hub", "USB HUB Device State", hub.n_ports);
for (i=0; i<hub.n_ports; i++) {
sprintf(portnum, "port%d", i+1);
port = new bx_list_c(hub.state, portnum, 3);
new bx_shadow_num_c(port, "PortStatus", &hub.usb_port[i].PortStatus, BASE_HEX);
new bx_shadow_num_c(port, "PortChange", &hub.usb_port[i].PortChange, BASE_HEX);
// empty list for USB device state
new bx_list_c(port, "device", 20);
}
}
void usb_hub_device_c::after_restore_state()
{
for (int i=0; i<hub.n_ports; i++) {
if (hub.usb_port[i].device != NULL) {
hub.usb_port[i].device->after_restore_state();
}
}
}
void usb_hub_device_c::handle_reset()
{
// TODO
BX_DEBUG(("Reset"));
}
int usb_hub_device_c::handle_control(int request, int value, int index, int length, Bit8u *data)
{
int ret = 0;
unsigned int n;
switch(request) {
case DeviceRequest | USB_REQ_GET_STATUS:
if (d.state == USB_STATE_DEFAULT)
goto fail;
else {
data[0] = (1 << USB_DEVICE_SELF_POWERED) |
(d.remote_wakeup << USB_DEVICE_REMOTE_WAKEUP);
data[1] = 0x00;
ret = 2;
}
break;
case DeviceOutRequest | USB_REQ_CLEAR_FEATURE:
if (value == USB_DEVICE_REMOTE_WAKEUP) {
d.remote_wakeup = 0;
} else {
goto fail;
}
ret = 0;
break;
case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
if (value == 0 && index != 0x81) { /* clear ep halt */
goto fail;
}
ret = 0;
break;
case DeviceOutRequest | USB_REQ_SET_FEATURE:
if (value == USB_DEVICE_REMOTE_WAKEUP) {
d.remote_wakeup = 1;
} else {
goto fail;
}
ret = 0;
break;
case DeviceOutRequest | USB_REQ_SET_ADDRESS:
d.state = USB_STATE_ADDRESS;
d.addr = value;
ret = 0;
break;
case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
switch(value >> 8) {
case USB_DT_DEVICE:
memcpy(data, bx_hub_dev_descriptor,
sizeof(bx_hub_dev_descriptor));
ret = sizeof(bx_hub_dev_descriptor);
break;
case USB_DT_CONFIG:
memcpy(data, bx_hub_config_descriptor,
sizeof(bx_hub_config_descriptor));
/* status change endpoint size based on number
* of ports */
data[22] = (hub.n_ports + 1 + 7) / 8;
ret = sizeof(bx_hub_config_descriptor);
break;
case USB_DT_STRING:
switch(value & 0xff) {
case 0:
/* language ids */
data[0] = 4;
data[1] = 3;
data[2] = 0x09;
data[3] = 0x04;
ret = 4;
break;
case 1:
/* serial number */
ret = set_usb_string(data, hub.serial_number);
break;
case 2:
/* product description */
ret = set_usb_string(data, "Bochs USB HUB");
break;
case 3:
/* vendor description */
ret = set_usb_string(data, "Bochs");
break;
default:
BX_ERROR(("unknown string descriptor type %i", value & 0xff));
goto fail;
}
break;
default:
BX_ERROR(("unknown descriptor type: 0x%02x", (value >> 8)));
goto fail;
}
break;
case DeviceRequest | USB_REQ_GET_CONFIGURATION:
data[0] = 1;
ret = 1;
break;
case DeviceOutRequest | USB_REQ_SET_CONFIGURATION:
d.state = USB_STATE_CONFIGURED;
ret = 0;
break;
case DeviceRequest | USB_REQ_GET_INTERFACE:
data[0] = 0;
ret = 1;
break;
case DeviceOutRequest | USB_REQ_SET_INTERFACE:
ret = 0;
break;
/* usb specific requests */
case GetHubStatus:
if (d.state == USB_STATE_CONFIGURED) {
data[0] = 0;
data[1] = 0;
data[2] = 0;
data[3] = 0;
ret = 4;
} else
goto fail;
break;
case GetPortStatus:
n = index - 1;
if (n >= hub.n_ports)
goto fail;
data[0] = (hub.usb_port[n].PortStatus & 0xff);
data[1] = (hub.usb_port[n].PortStatus >> 8);
data[2] = (hub.usb_port[n].PortChange & 0xff);
data[3] = (hub.usb_port[n].PortChange >> 8);
ret = 4;
break;
case SetHubFeature:
case ClearHubFeature:
if (value == 0 || value == 1) {
} else {
goto fail;
}
ret = 0;
break;
case SetPortFeature:
n = index - 1;
if (n >= hub.n_ports)
goto fail;
switch(value) {
case PORT_SUSPEND:
hub.usb_port[n].PortStatus |= PORT_STAT_SUSPEND;
break;
case PORT_RESET:
if (hub.usb_port[n].device != NULL) {
DEV_usb_send_msg(hub.usb_port[n].device, USB_MSG_RESET);
hub.usb_port[n].PortChange |= PORT_STAT_C_RESET;
/* set enable bit */
hub.usb_port[n].PortStatus |= PORT_STAT_ENABLE;
}
break;
case PORT_POWER:
break;
default:
BX_ERROR(("Unknown SetPortFeature: %i", value));
goto fail;
}
ret = 0;
break;
case ClearPortFeature:
n = index - 1;
if (n >= hub.n_ports)
goto fail;
switch(value) {
case PORT_ENABLE:
hub.usb_port[n].PortStatus &= ~PORT_STAT_ENABLE;
break;
case PORT_C_ENABLE:
hub.usb_port[n].PortChange &= ~PORT_STAT_C_ENABLE;
break;
case PORT_SUSPEND:
hub.usb_port[n].PortStatus &= ~PORT_STAT_SUSPEND;
break;
case PORT_C_SUSPEND:
hub.usb_port[n].PortChange &= ~PORT_STAT_C_SUSPEND;
break;
case PORT_C_CONNECTION:
hub.usb_port[n].PortChange &= ~PORT_STAT_C_CONNECTION;
break;
case PORT_C_OVERCURRENT:
hub.usb_port[n].PortChange &= ~PORT_STAT_C_OVERCURRENT;
break;
case PORT_C_RESET:
hub.usb_port[n].PortChange &= ~PORT_STAT_C_RESET;
break;
default:
BX_ERROR(("Unknown ClearPortFeature: %i", value));
goto fail;
}
ret = 0;
break;
case GetHubDescriptor:
{
unsigned int limit, var_hub_size = 0;
memcpy(data, bx_hub_hub_descriptor,
sizeof(bx_hub_hub_descriptor));
data[2] = hub.n_ports;
/* fill DeviceRemovable bits */
limit = ((hub.n_ports + 1 + 7) / 8) + 7;
for (n = 7; n < limit; n++) {
data[n] = 0x00;
var_hub_size++;
}
/* fill PortPwrCtrlMask bits */
limit = limit + ((hub.n_ports + 7) / 8);
for (;n < limit; n++) {
data[n] = 0xff;
var_hub_size++;
}
ret = sizeof(bx_hub_hub_descriptor) + var_hub_size;
data[0] = ret;
break;
}
default:
BX_ERROR(("handle_control: unknown request: 0x%04x", request));
fail:
d.stall = 1;
ret = USB_RET_STALL;
break;
}
return ret;
}
int usb_hub_device_c::handle_data(USBPacket *p)
{
int ret = 0;
switch(p->pid) {
case USB_TOKEN_IN:
if (p->devep == 1) {
unsigned int status;
int i, n;
n = (hub.n_ports + 1 + 7) / 8;
if (p->len == 1) { /* FreeBSD workaround */
n = 1;
} else if (n > p->len) {
return USB_RET_BABBLE;
}
status = 0;
for(i = 0; i < hub.n_ports; i++) {
if (hub.usb_port[i].PortChange)
status |= (1 << (i + 1));
}
if (status != 0) {
for(i = 0; i < n; i++) {
p->data[i] = status >> (8 * i);
}
ret = n;
} else {
ret = USB_RET_NAK; /* usb11 11.13.1 */
}
} else {
goto fail;
}
break;
case USB_TOKEN_OUT:
default:
fail:
d.stall = 1;
ret = USB_RET_STALL;
break;
}
return ret;
}
int usb_hub_device_c::broadcast_packet(USBPacket *p)
{
int i, ret;
usb_device_c *dev;
for(i = 0; i < hub.n_ports; i++) {
dev = hub.usb_port[i].device;
if ((dev != NULL) && (hub.usb_port[i].PortStatus & PORT_STAT_ENABLE)) {
ret = dev->handle_packet(p);
if (ret != USB_RET_NODEV) {
return ret;
}
}
}
return USB_RET_NODEV;
}
int usb_hub_device_c::handle_packet(USBPacket *p)
{
if ((d.state >= USB_STATE_DEFAULT) &&
(d.addr != 0) &&
(p->devaddr != d.addr) &&
((p->pid == USB_TOKEN_SETUP) ||
(p->pid == USB_TOKEN_OUT) ||
(p->pid == USB_TOKEN_IN))) {
/* broadcast the packet to the devices */
return broadcast_packet(p);
}
return usb_device_c::handle_packet(p);
}
void usb_hub_device_c::init_device(Bit8u port, bx_list_c *portconf)
{
usbdev_type type;
char pname[BX_PATHNAME_LEN];
const char *devname = NULL;
devname = ((bx_param_string_c*)portconf->get_by_name("device"))->getptr();
if (devname == NULL) return;
if (!strlen(devname) || !strcmp(devname, "none")) return;
if (hub.usb_port[port].device != NULL) {
BX_ERROR(("init_device(): port%d already in use", port+1));
return;
}
sprintf(pname, "port%d.device", port+1);
bx_list_c *sr_list = (bx_list_c*)SIM->get_param(pname, hub.state);
type = DEV_usb_init_device(portconf, this, &hub.usb_port[port].device, sr_list);
if (hub.usb_port[port].device != NULL) {
usb_set_connect_status(port, type, 1);
}
}
void usb_hub_device_c::remove_device(Bit8u port)
{
char pname[BX_PATHNAME_LEN];
if (hub.usb_port[port].device != NULL) {
delete hub.usb_port[port].device;
hub.usb_port[port].device = NULL;
sprintf(pname, "port%d.device", port+1);
bx_list_c *devlist = (bx_list_c*)SIM->get_param(pname, hub.state);
devlist->clear();
}
}
void usb_hub_device_c::usb_set_connect_status(Bit8u port, int type, bx_bool connected)
{
usb_device_c *device = hub.usb_port[port].device;
if (device != NULL) {
if (device->get_type() == type) {
if (connected) {
hub.usb_port[port].PortStatus |= PORT_STAT_CONNECTION;
hub.usb_port[port].PortChange |= PORT_STAT_C_CONNECTION;
if (device->get_speed() == USB_SPEED_LOW)
hub.usb_port[port].PortStatus |= PORT_STAT_LOW_SPEED;
else
hub.usb_port[port].PortStatus &= ~PORT_STAT_LOW_SPEED;
if (!device->get_connected()) {
if (!device->init()) {
usb_set_connect_status(port, type, 0);
BX_ERROR(("port #%d: connect failed", port+1));
} else {
BX_INFO(("port #%d: connect: %s", port+1, device->get_info()));
}
}
} else {
hub.usb_port[port].PortStatus &= ~PORT_STAT_CONNECTION;
hub.usb_port[port].PortChange |= PORT_STAT_C_CONNECTION;
if (hub.usb_port[port].PortStatus & PORT_STAT_ENABLE) {
hub.usb_port[port].PortStatus &= ~PORT_STAT_ENABLE;
hub.usb_port[port].PortChange |= PORT_STAT_C_ENABLE;
}
remove_device(port);
}
}
}
}
void usb_hub_device_c::runtime_config()
{
int i, hubnum;
char pname[6];
for (i = 0; i < hub.n_ports; i++) {
// device change support
if ((hub.device_change & (1 << i)) != 0) {
hubnum = atoi(hub.config->get_name()+6);
BX_INFO(("USB hub #%d, port #%d: device connect", hubnum, i+1));
sprintf(pname, "port%d", i + 1);
init_device(i, (bx_list_c*)SIM->get_param(pname, hub.config));
hub.device_change &= ~(1 << i);
}
// forward to connected device
if (hub.usb_port[i].device != NULL) {
hub.usb_port[i].device->runtime_config();
}
}
}
#undef LOG_THIS
#define LOG_THIS hub->
// USB hub runtime parameter handler
const char *usb_hub_device_c::hub_param_handler(bx_param_string_c *param, int set,
const char *oldval, const char *val, int maxlen)
{
usbdev_type type = USB_DEV_TYPE_NONE;
int hubnum, portnum;
usb_hub_device_c *hub;
bx_list_c *port;
if (set) {
port = (bx_list_c*)param->get_parent();
hub = (usb_hub_device_c*)(port->get_parent()->get_device_param());
if (hub != NULL) {
hubnum = atoi(port->get_parent()->get_name()+6);
portnum = atoi(port->get_name()+4) - 1;
bx_bool empty = ((strlen(val) == 0) || (!strcmp(val, "none")));
if ((portnum >= 0) && (portnum < hub->hub.n_ports)) {
if (empty && (hub->hub.usb_port[portnum].PortStatus & PORT_STAT_CONNECTION)) {
BX_INFO(("USB hub #%d, port #%d: device disconnect", hubnum, portnum+1));
if (hub->hub.usb_port[portnum].device != NULL) {
type = hub->hub.usb_port[portnum].device->get_type();
}
hub->usb_set_connect_status(portnum, type, 0);
} else if (!empty && !(hub->hub.usb_port[portnum].PortStatus & PORT_STAT_CONNECTION)) {
hub->hub.device_change |= (1 << portnum);
}
} else {
BX_PANIC(("usb_param_handler called with unexpected parameter '%s'", param->get_name()));
}
} else {
BX_PANIC(("hub_param_handler: external hub not found"));
}
}
return val;
}
#endif // BX_SUPPORT_PCI && BX_SUPPORT_PCIUSB
Reference in New Issue View Git Blame Copy Permalink