![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to usb.h CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [Qemu by Fabrice Bellard] / qemu / hw|
Return to usb.h CVS log | Up to [Qemu by Fabrice Bellard] / qemu / hw |
1.1 root 1: /*
2: * QEMU USB API
1.1.1.5 root 3: *
1.1 root 4: * Copyright (c) 2005 Fabrice Bellard
1.1.1.5 root 5: *
1.1 root 6: * Permission is hereby granted, free of charge, to any person obtaining a copy
7: * of this software and associated documentation files (the "Software"), to deal
8: * in the Software without restriction, including without limitation the rights
9: * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10: * copies of the Software, and to permit persons to whom the Software is
11: * furnished to do so, subject to the following conditions:
12: *
13: * The above copyright notice and this permission notice shall be included in
14: * all copies or substantial portions of the Software.
15: *
16: * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17: * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18: * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19: * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20: * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21: * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22: * THE SOFTWARE.
23: */
1.1.1.7 root 24:
25: #include "block.h"
1.1.1.9 ! root 26: #include "qdev.h"
! 27: #include "qemu-queue.h"
1.1.1.7 root 28:
1.1 root 29: #define USB_TOKEN_SETUP 0x2d
30: #define USB_TOKEN_IN 0x69 /* device -> host */
31: #define USB_TOKEN_OUT 0xe1 /* host -> device */
32:
33: /* specific usb messages, also sent in the 'pid' parameter */
34: #define USB_MSG_ATTACH 0x100
35: #define USB_MSG_DETACH 0x101
36: #define USB_MSG_RESET 0x102
37:
1.1.1.5 root 38: #define USB_RET_NODEV (-1)
1.1 root 39: #define USB_RET_NAK (-2)
40: #define USB_RET_STALL (-3)
41: #define USB_RET_BABBLE (-4)
1.1.1.4 root 42: #define USB_RET_ASYNC (-5)
1.1 root 43:
44: #define USB_SPEED_LOW 0
45: #define USB_SPEED_FULL 1
46: #define USB_SPEED_HIGH 2
47:
48: #define USB_STATE_NOTATTACHED 0
49: #define USB_STATE_ATTACHED 1
50: //#define USB_STATE_POWERED 2
51: #define USB_STATE_DEFAULT 3
52: //#define USB_STATE_ADDRESS 4
53: //#define USB_STATE_CONFIGURED 5
54: #define USB_STATE_SUSPENDED 6
55:
56: #define USB_CLASS_AUDIO 1
57: #define USB_CLASS_COMM 2
58: #define USB_CLASS_HID 3
59: #define USB_CLASS_PHYSICAL 5
60: #define USB_CLASS_STILL_IMAGE 6
61: #define USB_CLASS_PRINTER 7
62: #define USB_CLASS_MASS_STORAGE 8
63: #define USB_CLASS_HUB 9
64: #define USB_CLASS_CDC_DATA 0x0a
65: #define USB_CLASS_CSCID 0x0b
66: #define USB_CLASS_CONTENT_SEC 0x0d
67: #define USB_CLASS_APP_SPEC 0xfe
68: #define USB_CLASS_VENDOR_SPEC 0xff
69:
70: #define USB_DIR_OUT 0
71: #define USB_DIR_IN 0x80
72:
73: #define USB_TYPE_MASK (0x03 << 5)
74: #define USB_TYPE_STANDARD (0x00 << 5)
75: #define USB_TYPE_CLASS (0x01 << 5)
76: #define USB_TYPE_VENDOR (0x02 << 5)
77: #define USB_TYPE_RESERVED (0x03 << 5)
78:
79: #define USB_RECIP_MASK 0x1f
80: #define USB_RECIP_DEVICE 0x00
81: #define USB_RECIP_INTERFACE 0x01
82: #define USB_RECIP_ENDPOINT 0x02
83: #define USB_RECIP_OTHER 0x03
84:
85: #define DeviceRequest ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
86: #define DeviceOutRequest ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
87: #define InterfaceRequest \
88: ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
89: #define InterfaceOutRequest \
90: ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
91: #define EndpointRequest ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8)
92: #define EndpointOutRequest \
93: ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8)
94:
95: #define USB_REQ_GET_STATUS 0x00
96: #define USB_REQ_CLEAR_FEATURE 0x01
97: #define USB_REQ_SET_FEATURE 0x03
98: #define USB_REQ_SET_ADDRESS 0x05
99: #define USB_REQ_GET_DESCRIPTOR 0x06
100: #define USB_REQ_SET_DESCRIPTOR 0x07
101: #define USB_REQ_GET_CONFIGURATION 0x08
102: #define USB_REQ_SET_CONFIGURATION 0x09
103: #define USB_REQ_GET_INTERFACE 0x0A
104: #define USB_REQ_SET_INTERFACE 0x0B
105: #define USB_REQ_SYNCH_FRAME 0x0C
106:
107: #define USB_DEVICE_SELF_POWERED 0
108: #define USB_DEVICE_REMOTE_WAKEUP 1
109:
110: #define USB_DT_DEVICE 0x01
111: #define USB_DT_CONFIG 0x02
112: #define USB_DT_STRING 0x03
113: #define USB_DT_INTERFACE 0x04
114: #define USB_DT_ENDPOINT 0x05
115:
1.1.1.6 root 116: #define USB_ENDPOINT_XFER_CONTROL 0
117: #define USB_ENDPOINT_XFER_ISOC 1
118: #define USB_ENDPOINT_XFER_BULK 2
119: #define USB_ENDPOINT_XFER_INT 3
120:
1.1.1.9 ! root 121: typedef struct USBBus USBBus;
1.1 root 122: typedef struct USBPort USBPort;
123: typedef struct USBDevice USBDevice;
1.1.1.9 ! root 124: typedef struct USBDeviceInfo USBDeviceInfo;
1.1.1.4 root 125: typedef struct USBPacket USBPacket;
1.1 root 126:
127: /* definition of a USB device */
128: struct USBDevice {
1.1.1.9 ! root 129: DeviceState qdev;
! 130: USBDeviceInfo *info;
1.1 root 131: void *opaque;
1.1.1.6 root 132:
1.1.1.9 ! root 133: int speed;
! 134: uint8_t addr;
! 135: char product_desc[32];
! 136: int auto_attach;
! 137: int attached;
! 138:
! 139: int state;
! 140: uint8_t setup_buf[8];
! 141: uint8_t data_buf[1024];
! 142: int remote_wakeup;
! 143: int setup_state;
! 144: int setup_len;
! 145: int setup_index;
! 146: };
! 147:
! 148: struct USBDeviceInfo {
! 149: DeviceInfo qdev;
! 150: int (*init)(USBDevice *dev);
! 151:
! 152: /*
! 153: * Process USB packet.
1.1.1.6 root 154: * Called by the HC (Host Controller).
155: *
1.1.1.9 ! root 156: * Returns length of the transaction
1.1.1.6 root 157: * or one of the USB_RET_XXX codes.
1.1.1.9 ! root 158: */
1.1.1.4 root 159: int (*handle_packet)(USBDevice *dev, USBPacket *p);
1.1.1.6 root 160:
1.1.1.9 ! root 161: /*
1.1.1.6 root 162: * Called when device is destroyed.
163: */
1.1.1.3 root 164: void (*handle_destroy)(USBDevice *dev);
165:
1.1.1.6 root 166: /*
167: * Reset the device
1.1.1.9 ! root 168: */
1.1 root 169: void (*handle_reset)(USBDevice *dev);
1.1.1.6 root 170:
171: /*
172: * Process control request.
173: * Called from handle_packet().
174: *
175: * Returns length or one of the USB_RET_ codes.
176: */
1.1 root 177: int (*handle_control)(USBDevice *dev, int request, int value,
178: int index, int length, uint8_t *data);
1.1.1.6 root 179:
180: /*
181: * Process data transfers (both BULK and ISOC).
182: * Called from handle_packet().
183: *
184: * Returns length or one of the USB_RET_ codes.
185: */
1.1.1.4 root 186: int (*handle_data)(USBDevice *dev, USBPacket *p);
1.1.1.6 root 187:
1.1.1.9 ! root 188: const char *product_desc;
1.1.1.5 root 189:
1.1.1.9 ! root 190: /* handle legacy -usbdevice command line options */
! 191: const char *usbdevice_name;
! 192: USBDevice *(*usbdevice_init)(const char *params);
1.1 root 193: };
194:
1.1.1.3 root 195: typedef void (*usb_attachfn)(USBPort *port, USBDevice *dev);
196:
1.1 root 197: /* USB port on which a device can be connected */
198: struct USBPort {
199: USBDevice *dev;
1.1.1.3 root 200: usb_attachfn attach;
1.1 root 201: void *opaque;
202: int index; /* internal port index, may be used with the opaque */
1.1.1.9 ! root 203: QTAILQ_ENTRY(USBPort) next;
1.1 root 204: };
205:
1.1.1.4 root 206: typedef void USBCallback(USBPacket * packet, void *opaque);
207:
208: /* Structure used to hold information about an active USB packet. */
209: struct USBPacket {
210: /* Data fields for use by the driver. */
211: int pid;
212: uint8_t devaddr;
213: uint8_t devep;
214: uint8_t *data;
215: int len;
216: /* Internal use by the USB layer. */
217: USBCallback *complete_cb;
218: void *complete_opaque;
219: USBCallback *cancel_cb;
1.1.1.5 root 220: void *cancel_opaque;
1.1.1.4 root 221: };
222:
223: /* Defer completion of a USB packet. The hadle_packet routine should then
224: return USB_RET_ASYNC. Packets that complete immediately (before
225: handle_packet returns) should not call this method. */
226: static inline void usb_defer_packet(USBPacket *p, USBCallback *cancel,
227: void * opaque)
228: {
229: p->cancel_cb = cancel;
230: p->cancel_opaque = opaque;
231: }
232:
233: /* Notify the controller that an async packet is complete. This should only
234: be called for packets previously deferred with usb_defer_packet, and
235: should never be called from within handle_packet. */
236: static inline void usb_packet_complete(USBPacket *p)
237: {
238: p->complete_cb(p, p->complete_opaque);
239: }
240:
241: /* Cancel an active packet. The packed must have been deferred with
242: usb_defer_packet, and not yet completed. */
243: static inline void usb_cancel_packet(USBPacket * p)
244: {
245: p->cancel_cb(p, p->cancel_opaque);
246: }
247:
1.1 root 248: void usb_attach(USBPort *port, USBDevice *dev);
1.1.1.4 root 249: int usb_generic_handle_packet(USBDevice *s, USBPacket *p);
1.1 root 250: int set_usb_string(uint8_t *buf, const char *str);
1.1.1.4 root 251: void usb_send_msg(USBDevice *dev, int msg);
252:
1.1 root 253: /* usb-linux.c */
254: USBDevice *usb_host_device_open(const char *devname);
1.1.1.6 root 255: int usb_host_device_close(const char *devname);
1.1.1.8 root 256: void usb_host_info(Monitor *mon);
1.1 root 257:
258: /* usb-hid.c */
1.1.1.6 root 259: void usb_hid_datain_cb(USBDevice *dev, void *opaque, void (*datain)(void *));
1.1.1.3 root 260:
1.1.1.6 root 261: /* usb-bt.c */
262: USBDevice *usb_bt_init(HCIInfo *hci);
263:
1.1.1.5 root 264: /* usb ports of the VM */
265:
266: #define VM_USB_HUB_SIZE 8
267:
1.1.1.6 root 268: /* usb-musb.c */
269: enum musb_irq_source_e {
270: musb_irq_suspend = 0,
271: musb_irq_resume,
272: musb_irq_rst_babble,
273: musb_irq_sof,
274: musb_irq_connect,
275: musb_irq_disconnect,
276: musb_irq_vbus_request,
277: musb_irq_vbus_error,
278: musb_irq_rx,
279: musb_irq_tx,
280: musb_set_vbus,
281: musb_set_session,
282: __musb_irq_max,
283: };
284:
1.1.1.8 root 285: typedef struct MUSBState MUSBState;
286: MUSBState *musb_init(qemu_irq *irqs);
287: uint32_t musb_core_intr_get(MUSBState *s);
288: void musb_core_intr_clear(MUSBState *s, uint32_t mask);
289: void musb_set_size(MUSBState *s, int epnum, int size, int is_tx);
1.1.1.9 ! root 290:
! 291: /* usb-bus.c */
! 292:
! 293: struct USBBus {
! 294: BusState qbus;
! 295: int busnr;
! 296: int nfree;
! 297: int nused;
! 298: QTAILQ_HEAD(, USBPort) free;
! 299: QTAILQ_HEAD(, USBPort) used;
! 300: QTAILQ_ENTRY(USBBus) next;
! 301: };
! 302:
! 303: void usb_bus_new(USBBus *bus, DeviceState *host);
! 304: USBBus *usb_bus_find(int busnr);
! 305: void usb_qdev_register(USBDeviceInfo *info);
! 306: void usb_qdev_register_many(USBDeviceInfo *info);
! 307: USBDevice *usb_create(USBBus *bus, const char *name);
! 308: USBDevice *usb_create_simple(USBBus *bus, const char *name);
! 309: USBDevice *usbdevice_create(const char *cmdline);
! 310: void usb_register_port(USBBus *bus, USBPort *port, void *opaque, int index,
! 311: usb_attachfn attach);
! 312: void usb_unregister_port(USBBus *bus, USBPort *port);
! 313: int usb_device_attach(USBDevice *dev);
! 314: int usb_device_detach(USBDevice *dev);
! 315: int usb_device_delete_addr(int busnr, int addr);
! 316:
! 317: static inline USBBus *usb_bus_from_device(USBDevice *d)
! 318: {
! 319: return DO_UPCAST(USBBus, qbus, d->qdev.parent_bus);
! 320: }
This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.