]> git.proxmox.com Git - qemu.git/blame - hw/usb-bus.c
usb: Add a usb_fill_port helper function
[qemu.git] / hw / usb-bus.c
CommitLineData
806b6024
GH
1#include "hw.h"
2#include "usb.h"
3#include "qdev.h"
a5d2f727
GH
4#include "sysemu.h"
5#include "monitor.h"
6
7static void usb_bus_dev_print(Monitor *mon, DeviceState *qdev, int indent);
c7a2196a
GH
8
9static char *usb_get_dev_path(DeviceState *dev);
70d31cb2 10static char *usb_get_fw_dev_path(DeviceState *qdev);
806b6024
GH
11
12static struct BusInfo usb_bus_info = {
a5d2f727
GH
13 .name = "USB",
14 .size = sizeof(USBBus),
15 .print_dev = usb_bus_dev_print,
c7a2196a 16 .get_dev_path = usb_get_dev_path,
70d31cb2 17 .get_fw_dev_path = usb_get_fw_dev_path,
5f69076b
GH
18 .props = (Property[]) {
19 DEFINE_PROP_STRING("port", USBDevice, port_path),
20 DEFINE_PROP_END_OF_LIST()
21 },
806b6024
GH
22};
23static int next_usb_bus = 0;
72cf2d4f 24static QTAILQ_HEAD(, USBBus) busses = QTAILQ_HEAD_INITIALIZER(busses);
806b6024 25
c1ecb40a
GH
26const VMStateDescription vmstate_usb_device = {
27 .name = "USBDevice",
28 .version_id = 1,
29 .minimum_version_id = 1,
30 .fields = (VMStateField []) {
31 VMSTATE_UINT8(addr, USBDevice),
32 VMSTATE_INT32(state, USBDevice),
33 VMSTATE_INT32(remote_wakeup, USBDevice),
34 VMSTATE_INT32(setup_state, USBDevice),
35 VMSTATE_INT32(setup_len, USBDevice),
36 VMSTATE_INT32(setup_index, USBDevice),
37 VMSTATE_UINT8_ARRAY(setup_buf, USBDevice, 8),
38 VMSTATE_END_OF_LIST(),
39 }
40};
41
07771f6f 42void usb_bus_new(USBBus *bus, USBBusOps *ops, DeviceState *host)
806b6024 43{
b2317837 44 qbus_create_inplace(&bus->qbus, &usb_bus_info, host, NULL);
07771f6f 45 bus->ops = ops;
806b6024 46 bus->busnr = next_usb_bus++;
ef816d83 47 bus->qbus.allow_hotplug = 1; /* Yes, we can */
72cf2d4f
BS
48 QTAILQ_INIT(&bus->free);
49 QTAILQ_INIT(&bus->used);
50 QTAILQ_INSERT_TAIL(&busses, bus, next);
806b6024
GH
51}
52
53USBBus *usb_bus_find(int busnr)
54{
55 USBBus *bus;
56
57 if (-1 == busnr)
72cf2d4f
BS
58 return QTAILQ_FIRST(&busses);
59 QTAILQ_FOREACH(bus, &busses, next) {
806b6024
GH
60 if (bus->busnr == busnr)
61 return bus;
62 }
63 return NULL;
64}
65
66static int usb_qdev_init(DeviceState *qdev, DeviceInfo *base)
67{
68 USBDevice *dev = DO_UPCAST(USBDevice, qdev, qdev);
69 USBDeviceInfo *info = DO_UPCAST(USBDeviceInfo, qdev, base);
70 int rc;
71
06384698 72 pstrcpy(dev->product_desc, sizeof(dev->product_desc), info->product_desc);
806b6024 73 dev->info = info;
61e094c0 74 dev->auto_attach = 1;
132a3f55 75 QLIST_INIT(&dev->strings);
806b6024 76 rc = dev->info->init(dev);
61e094c0 77 if (rc == 0 && dev->auto_attach)
fa19bf83 78 rc = usb_device_attach(dev);
806b6024
GH
79 return rc;
80}
81
a8e662b5
GH
82static int usb_qdev_exit(DeviceState *qdev)
83{
84 USBDevice *dev = DO_UPCAST(USBDevice, qdev, qdev);
07771f6f 85 USBBus *bus = usb_bus_from_device(dev);
a8e662b5 86
290a5c60
HG
87 if (dev->attached) {
88 usb_device_detach(dev);
89 }
07771f6f 90 bus->ops->device_destroy(bus, dev);
a8e662b5
GH
91 if (dev->info->handle_destroy) {
92 dev->info->handle_destroy(dev);
93 }
94 return 0;
95}
96
806b6024
GH
97void usb_qdev_register(USBDeviceInfo *info)
98{
99 info->qdev.bus_info = &usb_bus_info;
100 info->qdev.init = usb_qdev_init;
ef816d83 101 info->qdev.unplug = qdev_simple_unplug_cb;
a8e662b5 102 info->qdev.exit = usb_qdev_exit;
806b6024
GH
103 qdev_register(&info->qdev);
104}
105
106void usb_qdev_register_many(USBDeviceInfo *info)
107{
108 while (info->qdev.name) {
109 usb_qdev_register(info);
110 info++;
111 }
112}
113
a5d2f727 114USBDevice *usb_create(USBBus *bus, const char *name)
806b6024
GH
115{
116 DeviceState *dev;
117
118#if 1
119 /* temporary stopgap until all usb is properly qdev-ified */
120 if (!bus) {
121 bus = usb_bus_find(-1);
122 if (!bus)
123 return NULL;
fa19bf83 124 error_report("%s: no bus specified, using \"%s\" for \"%s\"\n",
806b6024
GH
125 __FUNCTION__, bus->qbus.name, name);
126 }
127#endif
128
129 dev = qdev_create(&bus->qbus, name);
806b6024
GH
130 return DO_UPCAST(USBDevice, qdev, dev);
131}
a5d2f727
GH
132
133USBDevice *usb_create_simple(USBBus *bus, const char *name)
134{
135 USBDevice *dev = usb_create(bus, name);
d44168ff
PB
136 if (!dev) {
137 hw_error("Failed to create USB device '%s'\n", name);
138 }
e23a1b33 139 qdev_init_nofail(&dev->qdev);
a5d2f727
GH
140 return dev;
141}
142
090ac642
HG
143static void usb_fill_port(USBPort *port, void *opaque, int index,
144 USBPortOps *ops, int speedmask)
a5d2f727
GH
145{
146 port->opaque = opaque;
147 port->index = index;
0d86d2be
GH
148 port->opaque = opaque;
149 port->index = index;
150 port->ops = ops;
843d4e0c 151 port->speedmask = speedmask;
090ac642
HG
152}
153
154void usb_register_port(USBBus *bus, USBPort *port, void *opaque, int index,
155 USBPortOps *ops, int speedmask)
156{
157 usb_fill_port(port, opaque, index, ops, speedmask);
72cf2d4f 158 QTAILQ_INSERT_TAIL(&bus->free, port, next);
a5d2f727
GH
159 bus->nfree++;
160}
161
c7a2196a
GH
162void usb_port_location(USBPort *downstream, USBPort *upstream, int portnr)
163{
164 if (upstream) {
165 snprintf(downstream->path, sizeof(downstream->path), "%s.%d",
166 upstream->path, portnr);
167 } else {
168 snprintf(downstream->path, sizeof(downstream->path), "%d", portnr);
169 }
170}
171
a8e662b5
GH
172void usb_unregister_port(USBBus *bus, USBPort *port)
173{
174 if (port->dev)
175 qdev_free(&port->dev->qdev);
176 QTAILQ_REMOVE(&bus->free, port, next);
177 bus->nfree--;
178}
179
fa19bf83 180static int do_attach(USBDevice *dev)
a5d2f727
GH
181{
182 USBBus *bus = usb_bus_from_device(dev);
183 USBPort *port;
184
185 if (dev->attached) {
fa19bf83 186 error_report("Error: tried to attach usb device %s twice\n",
0fe6d12e 187 dev->product_desc);
fa19bf83 188 return -1;
a5d2f727 189 }
ee210d63 190 if (bus->nfree == 0) {
fa19bf83 191 error_report("Error: tried to attach usb device %s to a bus with no free ports\n",
ee210d63 192 dev->product_desc);
fa19bf83 193 return -1;
ee210d63 194 }
5f69076b
GH
195 if (dev->port_path) {
196 QTAILQ_FOREACH(port, &bus->free, next) {
197 if (strcmp(port->path, dev->port_path) == 0) {
198 break;
199 }
200 }
201 if (port == NULL) {
fa19bf83 202 error_report("Error: usb port %s (bus %s) not found\n",
5f69076b 203 dev->port_path, bus->qbus.name);
fa19bf83 204 return -1;
5f69076b
GH
205 }
206 } else {
207 port = QTAILQ_FIRST(&bus->free);
208 }
bf5547f5
HG
209 if (!(port->speedmask & dev->speedmask)) {
210 error_report("Warning: speed mismatch trying to attach usb device %s to bus %s\n",
211 dev->product_desc, bus->qbus.name);
212 return -1;
213 }
a5d2f727 214
5f69076b 215 dev->attached++;
72cf2d4f 216 QTAILQ_REMOVE(&bus->free, port, next);
a5d2f727
GH
217 bus->nfree--;
218
219 usb_attach(port, dev);
220
72cf2d4f 221 QTAILQ_INSERT_TAIL(&bus->used, port, next);
a5d2f727 222 bus->nused++;
fa19bf83
HG
223
224 return 0;
a5d2f727
GH
225}
226
227int usb_device_attach(USBDevice *dev)
228{
229 USBBus *bus = usb_bus_from_device(dev);
a5d2f727 230
5f69076b
GH
231 if (bus->nfree == 1 && dev->port_path == NULL) {
232 /* Create a new hub and chain it on
233 (unless a physical port location is specified). */
d4c4e6fd 234 usb_create_simple(bus, "usb-hub");
a5d2f727 235 }
fa19bf83 236 return do_attach(dev);
a5d2f727
GH
237}
238
a8e662b5
GH
239int usb_device_detach(USBDevice *dev)
240{
241 USBBus *bus = usb_bus_from_device(dev);
242 USBPort *port;
243
244 if (!dev->attached) {
fa19bf83 245 error_report("Error: tried to detach unattached usb device %s\n",
0fe6d12e 246 dev->product_desc);
a8e662b5
GH
247 return -1;
248 }
249 dev->attached--;
250
251 QTAILQ_FOREACH(port, &bus->used, next) {
252 if (port->dev == dev)
253 break;
254 }
255 assert(port != NULL);
256
257 QTAILQ_REMOVE(&bus->used, port, next);
258 bus->nused--;
259
260 usb_attach(port, NULL);
261
262 QTAILQ_INSERT_TAIL(&bus->free, port, next);
263 bus->nfree++;
264 return 0;
265}
266
a5d2f727
GH
267int usb_device_delete_addr(int busnr, int addr)
268{
269 USBBus *bus;
270 USBPort *port;
271 USBDevice *dev;
272
273 bus = usb_bus_find(busnr);
274 if (!bus)
275 return -1;
276
72cf2d4f 277 QTAILQ_FOREACH(port, &bus->used, next) {
a5d2f727
GH
278 if (port->dev->addr == addr)
279 break;
280 }
281 if (!port)
282 return -1;
a5d2f727 283 dev = port->dev;
a5d2f727 284
a8e662b5 285 qdev_free(&dev->qdev);
a5d2f727
GH
286 return 0;
287}
288
289static const char *usb_speed(unsigned int speed)
290{
291 static const char *txt[] = {
292 [ USB_SPEED_LOW ] = "1.5",
293 [ USB_SPEED_FULL ] = "12",
294 [ USB_SPEED_HIGH ] = "480",
290d26d2 295 [ USB_SPEED_SUPER ] = "5000",
a5d2f727
GH
296 };
297 if (speed >= ARRAY_SIZE(txt))
298 return "?";
299 return txt[speed];
300}
301
302static void usb_bus_dev_print(Monitor *mon, DeviceState *qdev, int indent)
303{
304 USBDevice *dev = DO_UPCAST(USBDevice, qdev, qdev);
305 USBBus *bus = usb_bus_from_device(dev);
306
c7a2196a 307 monitor_printf(mon, "%*saddr %d.%d, port %s, speed %s, name %s%s\n",
66a6593a 308 indent, "", bus->busnr, dev->addr,
c7a2196a 309 dev->port ? dev->port->path : "-",
0fe6d12e 310 usb_speed(dev->speed), dev->product_desc,
66a6593a 311 dev->attached ? ", attached" : "");
a5d2f727
GH
312}
313
c7a2196a
GH
314static char *usb_get_dev_path(DeviceState *qdev)
315{
316 USBDevice *dev = DO_UPCAST(USBDevice, qdev, qdev);
317 return qemu_strdup(dev->port->path);
318}
319
70d31cb2
GH
320static char *usb_get_fw_dev_path(DeviceState *qdev)
321{
322 USBDevice *dev = DO_UPCAST(USBDevice, qdev, qdev);
323 char *fw_path, *in;
ea87e95f 324 ssize_t pos = 0, fw_len;
70d31cb2
GH
325 long nr;
326
ea87e95f
BS
327 fw_len = 32 + strlen(dev->port->path) * 6;
328 fw_path = qemu_malloc(fw_len);
70d31cb2 329 in = dev->port->path;
ea87e95f 330 while (fw_len - pos > 0) {
70d31cb2
GH
331 nr = strtol(in, &in, 10);
332 if (in[0] == '.') {
333 /* some hub between root port and device */
ea87e95f 334 pos += snprintf(fw_path + pos, fw_len - pos, "hub@%ld/", nr);
70d31cb2
GH
335 in++;
336 } else {
337 /* the device itself */
ea87e95f
BS
338 pos += snprintf(fw_path + pos, fw_len - pos, "%s@%ld",
339 qdev_fw_name(qdev), nr);
70d31cb2
GH
340 break;
341 }
342 }
343 return fw_path;
344}
345
a5d2f727
GH
346void usb_info(Monitor *mon)
347{
348 USBBus *bus;
349 USBDevice *dev;
350 USBPort *port;
351
72cf2d4f 352 if (QTAILQ_EMPTY(&busses)) {
a5d2f727
GH
353 monitor_printf(mon, "USB support not enabled\n");
354 return;
355 }
356
72cf2d4f
BS
357 QTAILQ_FOREACH(bus, &busses, next) {
358 QTAILQ_FOREACH(port, &bus->used, next) {
a5d2f727
GH
359 dev = port->dev;
360 if (!dev)
361 continue;
c7a2196a
GH
362 monitor_printf(mon, " Device %d.%d, Port %s, Speed %s Mb/s, Product %s\n",
363 bus->busnr, dev->addr, port->path, usb_speed(dev->speed),
0fe6d12e 364 dev->product_desc);
a5d2f727
GH
365 }
366 }
367}
368
0958b4cc
GH
369/* handle legacy -usbdevice cmd line option */
370USBDevice *usbdevice_create(const char *cmdline)
371{
372 USBBus *bus = usb_bus_find(-1 /* any */);
373 DeviceInfo *info;
374 USBDeviceInfo *usb;
702f3e0f
JK
375 char driver[32];
376 const char *params;
0958b4cc
GH
377 int len;
378
379 params = strchr(cmdline,':');
380 if (params) {
381 params++;
382 len = params - cmdline;
383 if (len > sizeof(driver))
384 len = sizeof(driver);
385 pstrcpy(driver, len, cmdline);
386 } else {
702f3e0f 387 params = "";
0958b4cc
GH
388 pstrcpy(driver, sizeof(driver), cmdline);
389 }
390
391 for (info = device_info_list; info != NULL; info = info->next) {
392 if (info->bus_info != &usb_bus_info)
393 continue;
394 usb = DO_UPCAST(USBDeviceInfo, qdev, info);
395 if (usb->usbdevice_name == NULL)
396 continue;
397 if (strcmp(usb->usbdevice_name, driver) != 0)
398 continue;
399 break;
400 }
401 if (info == NULL) {
402#if 0
403 /* no error because some drivers are not converted (yet) */
1ecda02b 404 error_report("usbdevice %s not found", driver);
0958b4cc
GH
405#endif
406 return NULL;
407 }
408
409 if (!usb->usbdevice_init) {
98f22dc1 410 if (*params) {
1ecda02b 411 error_report("usbdevice %s accepts no params", driver);
0958b4cc
GH
412 return NULL;
413 }
414 return usb_create_simple(bus, usb->qdev.name);
415 }
416 return usb->usbdevice_init(params);
417}