|
|
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"
! 26:
1.1 root 27: #define USB_TOKEN_SETUP 0x2d
28: #define USB_TOKEN_IN 0x69 /* device -> host */
29: #define USB_TOKEN_OUT 0xe1 /* host -> device */
30:
31: /* specific usb messages, also sent in the 'pid' parameter */
32: #define USB_MSG_ATTACH 0x100
33: #define USB_MSG_DETACH 0x101
34: #define USB_MSG_RESET 0x102
35:
1.1.1.5 root 36: #define USB_RET_NODEV (-1)
1.1 root 37: #define USB_RET_NAK (-2)
38: #define USB_RET_STALL (-3)
39: #define USB_RET_BABBLE (-4)
1.1.1.4 root 40: #define USB_RET_ASYNC (-5)
1.1 root 41:
42: #define USB_SPEED_LOW 0
43: #define USB_SPEED_FULL 1
44: #define USB_SPEED_HIGH 2
45:
46: #define USB_STATE_NOTATTACHED 0
47: #define USB_STATE_ATTACHED 1
48: //#define USB_STATE_POWERED 2
49: #define USB_STATE_DEFAULT 3
50: //#define USB_STATE_ADDRESS 4
51: //#define USB_STATE_CONFIGURED 5
52: #define USB_STATE_SUSPENDED 6
53:
54: #define USB_CLASS_AUDIO 1
55: #define USB_CLASS_COMM 2
56: #define USB_CLASS_HID 3
57: #define USB_CLASS_PHYSICAL 5
58: #define USB_CLASS_STILL_IMAGE 6
59: #define USB_CLASS_PRINTER 7
60: #define USB_CLASS_MASS_STORAGE 8
61: #define USB_CLASS_HUB 9
62: #define USB_CLASS_CDC_DATA 0x0a
63: #define USB_CLASS_CSCID 0x0b
64: #define USB_CLASS_CONTENT_SEC 0x0d
65: #define USB_CLASS_APP_SPEC 0xfe
66: #define USB_CLASS_VENDOR_SPEC 0xff
67:
68: #define USB_DIR_OUT 0
69: #define USB_DIR_IN 0x80
70:
71: #define USB_TYPE_MASK (0x03 << 5)
72: #define USB_TYPE_STANDARD (0x00 << 5)
73: #define USB_TYPE_CLASS (0x01 << 5)
74: #define USB_TYPE_VENDOR (0x02 << 5)
75: #define USB_TYPE_RESERVED (0x03 << 5)
76:
77: #define USB_RECIP_MASK 0x1f
78: #define USB_RECIP_DEVICE 0x00
79: #define USB_RECIP_INTERFACE 0x01
80: #define USB_RECIP_ENDPOINT 0x02
81: #define USB_RECIP_OTHER 0x03
82:
83: #define DeviceRequest ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
84: #define DeviceOutRequest ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
85: #define InterfaceRequest \
86: ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
87: #define InterfaceOutRequest \
88: ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
89: #define EndpointRequest ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8)
90: #define EndpointOutRequest \
91: ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8)
92:
93: #define USB_REQ_GET_STATUS 0x00
94: #define USB_REQ_CLEAR_FEATURE 0x01
95: #define USB_REQ_SET_FEATURE 0x03
96: #define USB_REQ_SET_ADDRESS 0x05
97: #define USB_REQ_GET_DESCRIPTOR 0x06
98: #define USB_REQ_SET_DESCRIPTOR 0x07
99: #define USB_REQ_GET_CONFIGURATION 0x08
100: #define USB_REQ_SET_CONFIGURATION 0x09
101: #define USB_REQ_GET_INTERFACE 0x0A
102: #define USB_REQ_SET_INTERFACE 0x0B
103: #define USB_REQ_SYNCH_FRAME 0x0C
104:
105: #define USB_DEVICE_SELF_POWERED 0
106: #define USB_DEVICE_REMOTE_WAKEUP 1
107:
108: #define USB_DT_DEVICE 0x01
109: #define USB_DT_CONFIG 0x02
110: #define USB_DT_STRING 0x03
111: #define USB_DT_INTERFACE 0x04
112: #define USB_DT_ENDPOINT 0x05
113:
1.1.1.6 root 114: #define USB_ENDPOINT_XFER_CONTROL 0
115: #define USB_ENDPOINT_XFER_ISOC 1
116: #define USB_ENDPOINT_XFER_BULK 2
117: #define USB_ENDPOINT_XFER_INT 3
118:
1.1 root 119: typedef struct USBPort USBPort;
120: typedef struct USBDevice USBDevice;
1.1.1.4 root 121: typedef struct USBPacket USBPacket;
1.1 root 122:
123: /* definition of a USB device */
124: struct USBDevice {
125: void *opaque;
1.1.1.6 root 126:
127: /*
128: * Process USB packet.
129: * Called by the HC (Host Controller).
130: *
131: * Returns length of the transaction
132: * or one of the USB_RET_XXX codes.
133: */
1.1.1.4 root 134: int (*handle_packet)(USBDevice *dev, USBPacket *p);
1.1.1.6 root 135:
136: /*
137: * Called when device is destroyed.
138: */
1.1.1.3 root 139: void (*handle_destroy)(USBDevice *dev);
140:
1.1 root 141: int speed;
1.1.1.5 root 142:
1.1 root 143: /* The following fields are used by the generic USB device
1.1.1.6 root 144: layer. They are here just to avoid creating a new structure
145: for them. */
146:
147: /*
148: * Reset the device
149: */
1.1 root 150: void (*handle_reset)(USBDevice *dev);
1.1.1.6 root 151:
152: /*
153: * Process control request.
154: * Called from handle_packet().
155: *
156: * Returns length or one of the USB_RET_ codes.
157: */
1.1 root 158: int (*handle_control)(USBDevice *dev, int request, int value,
159: int index, int length, uint8_t *data);
1.1.1.6 root 160:
161: /*
162: * Process data transfers (both BULK and ISOC).
163: * Called from handle_packet().
164: *
165: * Returns length or one of the USB_RET_ codes.
166: */
1.1.1.4 root 167: int (*handle_data)(USBDevice *dev, USBPacket *p);
1.1.1.6 root 168:
1.1 root 169: uint8_t addr;
1.1.1.3 root 170: char devname[32];
1.1.1.5 root 171:
1.1 root 172: int state;
173: uint8_t setup_buf[8];
174: uint8_t data_buf[1024];
175: int remote_wakeup;
176: int setup_state;
177: int setup_len;
178: int setup_index;
179: };
180:
1.1.1.3 root 181: typedef void (*usb_attachfn)(USBPort *port, USBDevice *dev);
182:
1.1 root 183: /* USB port on which a device can be connected */
184: struct USBPort {
185: USBDevice *dev;
1.1.1.3 root 186: usb_attachfn attach;
1.1 root 187: void *opaque;
188: int index; /* internal port index, may be used with the opaque */
1.1.1.3 root 189: struct USBPort *next; /* Used internally by qemu. */
1.1 root 190: };
191:
1.1.1.4 root 192: typedef void USBCallback(USBPacket * packet, void *opaque);
193:
194: /* Structure used to hold information about an active USB packet. */
195: struct USBPacket {
196: /* Data fields for use by the driver. */
197: int pid;
198: uint8_t devaddr;
199: uint8_t devep;
200: uint8_t *data;
201: int len;
202: /* Internal use by the USB layer. */
203: USBCallback *complete_cb;
204: void *complete_opaque;
205: USBCallback *cancel_cb;
1.1.1.5 root 206: void *cancel_opaque;
1.1.1.4 root 207: };
208:
209: /* Defer completion of a USB packet. The hadle_packet routine should then
210: return USB_RET_ASYNC. Packets that complete immediately (before
211: handle_packet returns) should not call this method. */
212: static inline void usb_defer_packet(USBPacket *p, USBCallback *cancel,
213: void * opaque)
214: {
215: p->cancel_cb = cancel;
216: p->cancel_opaque = opaque;
217: }
218:
219: /* Notify the controller that an async packet is complete. This should only
220: be called for packets previously deferred with usb_defer_packet, and
221: should never be called from within handle_packet. */
222: static inline void usb_packet_complete(USBPacket *p)
223: {
224: p->complete_cb(p, p->complete_opaque);
225: }
226:
227: /* Cancel an active packet. The packed must have been deferred with
228: usb_defer_packet, and not yet completed. */
229: static inline void usb_cancel_packet(USBPacket * p)
230: {
231: p->cancel_cb(p, p->cancel_opaque);
232: }
233:
1.1.1.6 root 234: int usb_device_add_dev(USBDevice *dev);
235: int usb_device_del_addr(int bus_num, int addr);
1.1 root 236: void usb_attach(USBPort *port, USBDevice *dev);
1.1.1.4 root 237: int usb_generic_handle_packet(USBDevice *s, USBPacket *p);
1.1 root 238: int set_usb_string(uint8_t *buf, const char *str);
1.1.1.4 root 239: void usb_send_msg(USBDevice *dev, int msg);
240:
1.1 root 241: /* usb hub */
1.1.1.3 root 242: USBDevice *usb_hub_init(int nb_ports);
1.1 root 243:
244: /* usb-linux.c */
245: USBDevice *usb_host_device_open(const char *devname);
1.1.1.6 root 246: int usb_host_device_close(const char *devname);
1.1 root 247: void usb_host_info(void);
248:
249: /* usb-hid.c */
250: USBDevice *usb_mouse_init(void);
1.1.1.2 root 251: USBDevice *usb_tablet_init(void);
1.1.1.5 root 252: USBDevice *usb_keyboard_init(void);
1.1.1.6 root 253: void usb_hid_datain_cb(USBDevice *dev, void *opaque, void (*datain)(void *));
1.1.1.3 root 254:
255: /* usb-msd.c */
1.1.1.7 ! root 256: USBDevice *usb_msd_init(const char *filename, BlockDriverState **pbs);
1.1.1.5 root 257:
1.1.1.6 root 258: /* usb-net.c */
259: USBDevice *usb_net_init(NICInfo *nd);
260:
261: /* usb-bt.c */
262: USBDevice *usb_bt_init(HCIInfo *hci);
263:
1.1.1.5 root 264: /* usb-wacom.c */
265: USBDevice *usb_wacom_init(void);
266:
1.1.1.6 root 267: /* usb-serial.c */
268: USBDevice *usb_serial_init(const char *filename);
269:
1.1.1.5 root 270: /* usb ports of the VM */
271:
272: void qemu_register_usb_port(USBPort *port, void *opaque, int index,
273: usb_attachfn attach);
274:
275: #define VM_USB_HUB_SIZE 8
276:
1.1.1.6 root 277: /* usb-musb.c */
278: enum musb_irq_source_e {
279: musb_irq_suspend = 0,
280: musb_irq_resume,
281: musb_irq_rst_babble,
282: musb_irq_sof,
283: musb_irq_connect,
284: musb_irq_disconnect,
285: musb_irq_vbus_request,
286: musb_irq_vbus_error,
287: musb_irq_rx,
288: musb_irq_tx,
289: musb_set_vbus,
290: musb_set_session,
291: __musb_irq_max,
292: };
293:
294: struct musb_s;
295: struct musb_s *musb_init(qemu_irq *irqs);
296: uint32_t musb_core_intr_get(struct musb_s *s);
297: void musb_core_intr_clear(struct musb_s *s, uint32_t mask);
298: void musb_set_size(struct musb_s *s, int epnum, int size, int is_tx);
This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.