317 lines
9.9 KiB
C++
317 lines
9.9 KiB
C++
/////////////////////////////////////////////////////////////////////////
|
|
// $Id: usb_common.cc,v 1.12 2009-04-12 07:26:58 vruppert Exp $
|
|
/////////////////////////////////////////////////////////////////////////
|
|
//
|
|
// Copyright (C) 2009 Benjamin D Lunt (fys at frontiernet net)
|
|
//
|
|
// 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
|
|
|
|
// Experimental PCI USB adapter
|
|
|
|
/* Notes:
|
|
- Currently, this code is quite messy. This is for all of the debugging
|
|
I have been doing. Many BX_INFO()'s here and there.
|
|
- My purpose of coding this emulation was/is to learn about the USB.
|
|
It has been a challenge, but I have learned a lot.
|
|
- If I forget, there are a lot of BX_INFO's that can be changed to BX_DEBUG's.
|
|
- 31 July 2006:
|
|
I now have a Beagle USB Protocol Analyzer from Total Phase for my research.
|
|
(http://www.totalphase.com/products/beagle/usb/)
|
|
With this device, I plan on doing a lot of research and development to get this
|
|
code to a state where it is actually very useful. I plan on adding support
|
|
of many "plug-in" type modules so that you can simply add a plug-in for your
|
|
specific device without having to modify the root code.
|
|
I hope to have some working code to upload to the CVS as soon as possible.
|
|
Thanks to Total Phase for their help in my research and the development of
|
|
this 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_hid.h"
|
|
#include "usb_hub.h"
|
|
#include "usb_msd.h"
|
|
|
|
#define LOG_THIS
|
|
|
|
usbdev_type usb_init_device(const char *devname, logfunctions *hub, usb_device_c **device)
|
|
{
|
|
usbdev_type type = USB_DEV_TYPE_NONE;
|
|
int ports;
|
|
|
|
if (!strcmp(devname, "mouse")) {
|
|
type = USB_DEV_TYPE_MOUSE;
|
|
*device = new usb_hid_device_c(type);
|
|
} else if (!strcmp(devname, "tablet")) {
|
|
type = USB_DEV_TYPE_TABLET;
|
|
*device = new usb_hid_device_c(type);
|
|
} else if (!strcmp(devname, "keypad")) {
|
|
type = USB_DEV_TYPE_KEYPAD;
|
|
*device = new usb_hid_device_c(type);
|
|
} else if (!strncmp(devname, "disk", 4)) {
|
|
if ((strlen(devname) > 5) && (devname[4] == ':')) {
|
|
type = USB_DEV_TYPE_DISK;
|
|
*device = new usb_msd_device_c(type, devname+5);
|
|
} else {
|
|
hub->panic("USB device 'disk' needs a filename separated with a colon");
|
|
return type;
|
|
}
|
|
} else if (!strncmp(devname, "cdrom", 5)) {
|
|
if ((strlen(devname) > 6) && (devname[5] == ':')) {
|
|
type = USB_DEV_TYPE_CDROM;
|
|
*device = new usb_msd_device_c(type, devname+6);
|
|
} else {
|
|
hub->panic("USB device 'cdrom' needs a filename separated with a colon");
|
|
return type;
|
|
}
|
|
} else if (!strncmp(devname, "hub", 3)) {
|
|
type = USB_DEV_TYPE_HUB;
|
|
ports = 4;
|
|
if (strlen(devname) > 3) {
|
|
if (devname[3] == ':') {
|
|
ports = atoi(&devname[4]);
|
|
if ((ports < 2) || (ports > BX_N_USB_HUB_PORTS)) {
|
|
hub->panic("USB device 'hub': invalid number of ports");
|
|
}
|
|
} else {
|
|
hub->panic("USB device 'hub' needs the port count separated with a colon");
|
|
}
|
|
}
|
|
*device = new usb_hub_device_c(ports);
|
|
} else {
|
|
hub->panic("unknown USB device: %s", devname);
|
|
return type;
|
|
}
|
|
return type;
|
|
}
|
|
|
|
// Dumps the contents of a buffer to the log file
|
|
void usb_device_c::usb_dump_packet(Bit8u *data, unsigned size)
|
|
{
|
|
char the_packet[256], str[16];
|
|
strcpy(the_packet, "Packet contents (in hex):");
|
|
unsigned offset = 0;
|
|
for (unsigned p=0; p<size; p++) {
|
|
if (!(p & 0x0F)) {
|
|
BX_DEBUG(("%s", the_packet));
|
|
sprintf(the_packet, " 0x%04X ", offset);
|
|
offset += 16;
|
|
}
|
|
sprintf(str, " %02X", data[p]);
|
|
strcat(the_packet, str);
|
|
}
|
|
if (strlen(the_packet))
|
|
BX_DEBUG(("%s", the_packet));
|
|
}
|
|
|
|
int usb_device_c::set_usb_string(Bit8u *buf, const char *str)
|
|
{
|
|
size_t len, i;
|
|
Bit8u *q;
|
|
|
|
q = buf;
|
|
len = strlen(str);
|
|
if (len > 32) {
|
|
*q = 0;
|
|
return 0;
|
|
}
|
|
*q++ = 2 * len + 2;
|
|
*q++ = 3;
|
|
for(i = 0; i < len; i++) {
|
|
*q++ = str[i];
|
|
*q++ = 0;
|
|
}
|
|
return q - buf;
|
|
}
|
|
|
|
// generic USB packet handler
|
|
|
|
#define SETUP_STATE_IDLE 0
|
|
#define SETUP_STATE_DATA 1
|
|
#define SETUP_STATE_ACK 2
|
|
|
|
int usb_device_c::handle_packet(USBPacket *p)
|
|
{
|
|
int l, ret = 0;
|
|
int len = p->len;
|
|
Bit8u *data = p->data;
|
|
|
|
switch(p->pid) {
|
|
case USB_MSG_ATTACH:
|
|
d.state = USB_STATE_ATTACHED;
|
|
break;
|
|
case USB_MSG_DETACH:
|
|
d.state = USB_STATE_NOTATTACHED;
|
|
break;
|
|
case USB_MSG_RESET:
|
|
d.remote_wakeup = 0;
|
|
d.addr = 0;
|
|
d.state = USB_STATE_DEFAULT;
|
|
handle_reset();
|
|
break;
|
|
case USB_TOKEN_SETUP:
|
|
if (d.state < USB_STATE_DEFAULT || p->devaddr != d.addr)
|
|
return USB_RET_NODEV;
|
|
if (len != 8)
|
|
goto fail;
|
|
d.stall = 0;
|
|
memcpy(d.setup_buf, data, 8);
|
|
d.setup_len = (d.setup_buf[7] << 8) | d.setup_buf[6];
|
|
d.setup_index = 0;
|
|
if (d.setup_buf[0] & USB_DIR_IN) {
|
|
ret = handle_control((d.setup_buf[0] << 8) | d.setup_buf[1],
|
|
(d.setup_buf[3] << 8) | d.setup_buf[2],
|
|
(d.setup_buf[5] << 8) | d.setup_buf[4],
|
|
d.setup_len, d.data_buf);
|
|
if (ret < 0)
|
|
return ret;
|
|
if (ret < d.setup_len)
|
|
d.setup_len = ret;
|
|
d.setup_state = SETUP_STATE_DATA;
|
|
} else {
|
|
if (d.setup_len == 0)
|
|
d.setup_state = SETUP_STATE_ACK;
|
|
else
|
|
d.setup_state = SETUP_STATE_DATA;
|
|
}
|
|
break;
|
|
case USB_TOKEN_IN:
|
|
if (d.state < USB_STATE_DEFAULT || p->devaddr != d.addr)
|
|
return USB_RET_NODEV;
|
|
if (d.stall) goto fail;
|
|
switch(p->devep) {
|
|
case 0:
|
|
switch(d.setup_state) {
|
|
case SETUP_STATE_ACK:
|
|
if (!(d.setup_buf[0] & USB_DIR_IN)) {
|
|
d.setup_state = SETUP_STATE_IDLE;
|
|
ret = handle_control((d.setup_buf[0] << 8) | d.setup_buf[1],
|
|
(d.setup_buf[3] << 8) | d.setup_buf[2],
|
|
(d.setup_buf[5] << 8) | d.setup_buf[4],
|
|
d.setup_len, d.data_buf);
|
|
if (ret > 0)
|
|
ret = 0;
|
|
} else {
|
|
// return 0 byte
|
|
}
|
|
break;
|
|
case SETUP_STATE_DATA:
|
|
if (d.setup_buf[0] & USB_DIR_IN) {
|
|
l = d.setup_len - d.setup_index;
|
|
if (l > len)
|
|
l = len;
|
|
memcpy(data, d.data_buf + d.setup_index, l);
|
|
d.setup_index += l;
|
|
if (d.setup_index >= d.setup_len)
|
|
d.setup_state = SETUP_STATE_ACK;
|
|
ret = l;
|
|
} else {
|
|
d.setup_state = SETUP_STATE_IDLE;
|
|
goto fail;
|
|
}
|
|
break;
|
|
default:
|
|
goto fail;
|
|
}
|
|
break;
|
|
default:
|
|
ret = handle_data(p);
|
|
break;
|
|
}
|
|
break;
|
|
case USB_TOKEN_OUT:
|
|
if (d.state < USB_STATE_DEFAULT || p->devaddr != d.addr)
|
|
return USB_RET_NODEV;
|
|
if (d.stall) goto fail;
|
|
switch(p->devep) {
|
|
case 0:
|
|
switch(d.setup_state) {
|
|
case SETUP_STATE_ACK:
|
|
if (d.setup_buf[0] & USB_DIR_IN) {
|
|
d.setup_state = SETUP_STATE_IDLE;
|
|
// transfer OK
|
|
} else {
|
|
// ignore additionnal output
|
|
}
|
|
break;
|
|
case SETUP_STATE_DATA:
|
|
if (!(d.setup_buf[0] & USB_DIR_IN)) {
|
|
l = d.setup_len - d.setup_index;
|
|
if (l > len)
|
|
l = len;
|
|
memcpy(d.data_buf + d.setup_index, data, l);
|
|
d.setup_index += l;
|
|
if (d.setup_index >= d.setup_len)
|
|
d.setup_state = SETUP_STATE_ACK;
|
|
ret = l;
|
|
} else {
|
|
// it is okay for a host to send an OUT before it reads
|
|
// all of the expected IN. It is telling the controller
|
|
// that it doesn't want any more from that particular call.
|
|
ret = 0;
|
|
d.setup_state = SETUP_STATE_IDLE;
|
|
}
|
|
break;
|
|
default:
|
|
goto fail;
|
|
}
|
|
break;
|
|
default:
|
|
ret = handle_data(p);
|
|
break;
|
|
}
|
|
break;
|
|
default:
|
|
fail:
|
|
d.stall = 1;
|
|
ret = USB_RET_STALL;
|
|
break;
|
|
}
|
|
return ret;
|
|
}
|
|
|
|
void usb_device_c::register_state(bx_list_c *parent)
|
|
{
|
|
bx_list_c *list = new bx_list_c(parent, "d", "Common USB Device State");
|
|
new bx_shadow_num_c(list, "addr", &d.addr);
|
|
new bx_shadow_num_c(list, "state", &d.state);
|
|
new bx_shadow_num_c(list, "remote_wakeup", &d.remote_wakeup);
|
|
register_state_specific(parent);
|
|
}
|
|
|
|
// base class for USB devices
|
|
usb_device_c::usb_device_c(void) {
|
|
memset((void*)&d, 0, sizeof(d));
|
|
}
|
|
|
|
// Send an internal message to a USB device
|
|
void usb_device_c::usb_send_msg(int msg)
|
|
{
|
|
USBPacket p;
|
|
memset(&p, 0, sizeof(p));
|
|
p.pid = msg;
|
|
handle_packet(&p);
|
|
}
|
|
|
|
#endif // BX_SUPPORT_PCI && BX_SUPPORT_PCIUSB
|