xref: /qemu/hw/usb/core.c (revision 26022652)
1f1ae32a1SGerd Hoffmann /*
2f1ae32a1SGerd Hoffmann  * QEMU USB emulation
3f1ae32a1SGerd Hoffmann  *
4f1ae32a1SGerd Hoffmann  * Copyright (c) 2005 Fabrice Bellard
5f1ae32a1SGerd Hoffmann  *
6f1ae32a1SGerd Hoffmann  * 2008 Generic packet handler rewrite by Max Krasnyansky
7f1ae32a1SGerd Hoffmann  *
8f1ae32a1SGerd Hoffmann  * Permission is hereby granted, free of charge, to any person obtaining a copy
9f1ae32a1SGerd Hoffmann  * of this software and associated documentation files (the "Software"), to deal
10f1ae32a1SGerd Hoffmann  * in the Software without restriction, including without limitation the rights
11f1ae32a1SGerd Hoffmann  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12f1ae32a1SGerd Hoffmann  * copies of the Software, and to permit persons to whom the Software is
13f1ae32a1SGerd Hoffmann  * furnished to do so, subject to the following conditions:
14f1ae32a1SGerd Hoffmann  *
15f1ae32a1SGerd Hoffmann  * The above copyright notice and this permission notice shall be included in
16f1ae32a1SGerd Hoffmann  * all copies or substantial portions of the Software.
17f1ae32a1SGerd Hoffmann  *
18f1ae32a1SGerd Hoffmann  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19f1ae32a1SGerd Hoffmann  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20f1ae32a1SGerd Hoffmann  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21f1ae32a1SGerd Hoffmann  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22f1ae32a1SGerd Hoffmann  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23f1ae32a1SGerd Hoffmann  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24f1ae32a1SGerd Hoffmann  * THE SOFTWARE.
25f1ae32a1SGerd Hoffmann  */
26e532b2e0SPeter Maydell #include "qemu/osdep.h"
27f1ae32a1SGerd Hoffmann #include "qemu-common.h"
28f1ae32a1SGerd Hoffmann #include "hw/usb.h"
291de7afc9SPaolo Bonzini #include "qemu/iov.h"
30f1ae32a1SGerd Hoffmann #include "trace.h"
31f1ae32a1SGerd Hoffmann 
32b791c3b3SGerd Hoffmann void usb_pick_speed(USBPort *port)
33b791c3b3SGerd Hoffmann {
34b791c3b3SGerd Hoffmann     static const int speeds[] = {
35b791c3b3SGerd Hoffmann         USB_SPEED_SUPER,
36b791c3b3SGerd Hoffmann         USB_SPEED_HIGH,
37b791c3b3SGerd Hoffmann         USB_SPEED_FULL,
38b791c3b3SGerd Hoffmann         USB_SPEED_LOW,
39b791c3b3SGerd Hoffmann     };
40b791c3b3SGerd Hoffmann     USBDevice *udev = port->dev;
41b791c3b3SGerd Hoffmann     int i;
42b791c3b3SGerd Hoffmann 
43b791c3b3SGerd Hoffmann     for (i = 0; i < ARRAY_SIZE(speeds); i++) {
44b791c3b3SGerd Hoffmann         if ((udev->speedmask & (1 << speeds[i])) &&
45b791c3b3SGerd Hoffmann             (port->speedmask & (1 << speeds[i]))) {
46b791c3b3SGerd Hoffmann             udev->speed = speeds[i];
47b791c3b3SGerd Hoffmann             return;
48b791c3b3SGerd Hoffmann         }
49b791c3b3SGerd Hoffmann     }
50b791c3b3SGerd Hoffmann }
51b791c3b3SGerd Hoffmann 
52f1ae32a1SGerd Hoffmann void usb_attach(USBPort *port)
53f1ae32a1SGerd Hoffmann {
54f1ae32a1SGerd Hoffmann     USBDevice *dev = port->dev;
55f1ae32a1SGerd Hoffmann 
56f1ae32a1SGerd Hoffmann     assert(dev != NULL);
57f1ae32a1SGerd Hoffmann     assert(dev->attached);
58f1ae32a1SGerd Hoffmann     assert(dev->state == USB_STATE_NOTATTACHED);
59b791c3b3SGerd Hoffmann     usb_pick_speed(port);
60f1ae32a1SGerd Hoffmann     port->ops->attach(port);
61f1ae32a1SGerd Hoffmann     dev->state = USB_STATE_ATTACHED;
62f1ae32a1SGerd Hoffmann     usb_device_handle_attach(dev);
63f1ae32a1SGerd Hoffmann }
64f1ae32a1SGerd Hoffmann 
65f1ae32a1SGerd Hoffmann void usb_detach(USBPort *port)
66f1ae32a1SGerd Hoffmann {
67f1ae32a1SGerd Hoffmann     USBDevice *dev = port->dev;
68f1ae32a1SGerd Hoffmann 
69f1ae32a1SGerd Hoffmann     assert(dev != NULL);
70f1ae32a1SGerd Hoffmann     assert(dev->state != USB_STATE_NOTATTACHED);
71f1ae32a1SGerd Hoffmann     port->ops->detach(port);
72f1ae32a1SGerd Hoffmann     dev->state = USB_STATE_NOTATTACHED;
73f1ae32a1SGerd Hoffmann }
74f1ae32a1SGerd Hoffmann 
75f1ae32a1SGerd Hoffmann void usb_port_reset(USBPort *port)
76f1ae32a1SGerd Hoffmann {
77f1ae32a1SGerd Hoffmann     USBDevice *dev = port->dev;
78f1ae32a1SGerd Hoffmann 
79f1ae32a1SGerd Hoffmann     assert(dev != NULL);
80f1ae32a1SGerd Hoffmann     usb_detach(port);
81f1ae32a1SGerd Hoffmann     usb_attach(port);
82f1ae32a1SGerd Hoffmann     usb_device_reset(dev);
83f1ae32a1SGerd Hoffmann }
84f1ae32a1SGerd Hoffmann 
85f1ae32a1SGerd Hoffmann void usb_device_reset(USBDevice *dev)
86f1ae32a1SGerd Hoffmann {
87f1ae32a1SGerd Hoffmann     if (dev == NULL || !dev->attached) {
88f1ae32a1SGerd Hoffmann         return;
89f1ae32a1SGerd Hoffmann     }
90f1ae32a1SGerd Hoffmann     dev->remote_wakeup = 0;
91f1ae32a1SGerd Hoffmann     dev->addr = 0;
92f1ae32a1SGerd Hoffmann     dev->state = USB_STATE_DEFAULT;
93f1ae32a1SGerd Hoffmann     usb_device_handle_reset(dev);
94f1ae32a1SGerd Hoffmann }
95f1ae32a1SGerd Hoffmann 
968550a02dSGerd Hoffmann void usb_wakeup(USBEndpoint *ep, unsigned int stream)
97f1ae32a1SGerd Hoffmann {
98f1ae32a1SGerd Hoffmann     USBDevice *dev = ep->dev;
99f1ae32a1SGerd Hoffmann     USBBus *bus = usb_bus_from_device(dev);
100f1ae32a1SGerd Hoffmann 
101*26022652SGerd Hoffmann     if (!qdev_hotplug) {
102*26022652SGerd Hoffmann         /*
103*26022652SGerd Hoffmann          * This is machine init cold plug.  No need to wakeup anyone,
104*26022652SGerd Hoffmann          * all devices will be reset anyway.  And trying to wakeup can
105*26022652SGerd Hoffmann          * cause problems due to hitting uninitialized devices.
106*26022652SGerd Hoffmann          */
107*26022652SGerd Hoffmann         return;
108*26022652SGerd Hoffmann     }
109f1ae32a1SGerd Hoffmann     if (dev->remote_wakeup && dev->port && dev->port->ops->wakeup) {
110f1ae32a1SGerd Hoffmann         dev->port->ops->wakeup(dev->port);
111f1ae32a1SGerd Hoffmann     }
112f1ae32a1SGerd Hoffmann     if (bus->ops->wakeup_endpoint) {
1138550a02dSGerd Hoffmann         bus->ops->wakeup_endpoint(bus, ep, stream);
114f1ae32a1SGerd Hoffmann     }
115f1ae32a1SGerd Hoffmann }
116f1ae32a1SGerd Hoffmann 
117f1ae32a1SGerd Hoffmann /**********************/
118f1ae32a1SGerd Hoffmann 
119f1ae32a1SGerd Hoffmann /* generic USB device helpers (you are not forced to use them when
120f1ae32a1SGerd Hoffmann    writing your USB device driver, but they help handling the
121f1ae32a1SGerd Hoffmann    protocol)
122f1ae32a1SGerd Hoffmann */
123f1ae32a1SGerd Hoffmann 
124f1ae32a1SGerd Hoffmann #define SETUP_STATE_IDLE  0
125f1ae32a1SGerd Hoffmann #define SETUP_STATE_SETUP 1
126f1ae32a1SGerd Hoffmann #define SETUP_STATE_DATA  2
127f1ae32a1SGerd Hoffmann #define SETUP_STATE_ACK   3
128f1ae32a1SGerd Hoffmann #define SETUP_STATE_PARAM 4
129f1ae32a1SGerd Hoffmann 
1309a77a0f5SHans de Goede static void do_token_setup(USBDevice *s, USBPacket *p)
131f1ae32a1SGerd Hoffmann {
132f1ae32a1SGerd Hoffmann     int request, value, index;
133f1ae32a1SGerd Hoffmann 
134f1ae32a1SGerd Hoffmann     if (p->iov.size != 8) {
1359a77a0f5SHans de Goede         p->status = USB_RET_STALL;
1369a77a0f5SHans de Goede         return;
137f1ae32a1SGerd Hoffmann     }
138f1ae32a1SGerd Hoffmann 
139f1ae32a1SGerd Hoffmann     usb_packet_copy(p, s->setup_buf, p->iov.size);
14064c9bc18SPrasad J Pandit     s->setup_index = 0;
1419a77a0f5SHans de Goede     p->actual_length = 0;
142f1ae32a1SGerd Hoffmann     s->setup_len   = (s->setup_buf[7] << 8) | s->setup_buf[6];
14364c9bc18SPrasad J Pandit     if (s->setup_len > sizeof(s->data_buf)) {
14464c9bc18SPrasad J Pandit         fprintf(stderr,
14564c9bc18SPrasad J Pandit                 "usb_generic_handle_packet: ctrl buffer too small (%d > %zu)\n",
14664c9bc18SPrasad J Pandit                 s->setup_len, sizeof(s->data_buf));
14764c9bc18SPrasad J Pandit         p->status = USB_RET_STALL;
14864c9bc18SPrasad J Pandit         return;
14964c9bc18SPrasad J Pandit     }
150f1ae32a1SGerd Hoffmann 
151f1ae32a1SGerd Hoffmann     request = (s->setup_buf[0] << 8) | s->setup_buf[1];
152f1ae32a1SGerd Hoffmann     value   = (s->setup_buf[3] << 8) | s->setup_buf[2];
153f1ae32a1SGerd Hoffmann     index   = (s->setup_buf[5] << 8) | s->setup_buf[4];
154f1ae32a1SGerd Hoffmann 
155f1ae32a1SGerd Hoffmann     if (s->setup_buf[0] & USB_DIR_IN) {
1569a77a0f5SHans de Goede         usb_device_handle_control(s, p, request, value, index,
157f1ae32a1SGerd Hoffmann                                   s->setup_len, s->data_buf);
1589a77a0f5SHans de Goede         if (p->status == USB_RET_ASYNC) {
159f1ae32a1SGerd Hoffmann             s->setup_state = SETUP_STATE_SETUP;
160f1ae32a1SGerd Hoffmann         }
1619a77a0f5SHans de Goede         if (p->status != USB_RET_SUCCESS) {
1629a77a0f5SHans de Goede             return;
1639a77a0f5SHans de Goede         }
164f1ae32a1SGerd Hoffmann 
1659a77a0f5SHans de Goede         if (p->actual_length < s->setup_len) {
1669a77a0f5SHans de Goede             s->setup_len = p->actual_length;
1679a77a0f5SHans de Goede         }
168f1ae32a1SGerd Hoffmann         s->setup_state = SETUP_STATE_DATA;
169f1ae32a1SGerd Hoffmann     } else {
170f1ae32a1SGerd Hoffmann         if (s->setup_len == 0)
171f1ae32a1SGerd Hoffmann             s->setup_state = SETUP_STATE_ACK;
172f1ae32a1SGerd Hoffmann         else
173f1ae32a1SGerd Hoffmann             s->setup_state = SETUP_STATE_DATA;
174f1ae32a1SGerd Hoffmann     }
175f1ae32a1SGerd Hoffmann 
1769a77a0f5SHans de Goede     p->actual_length = 8;
177f1ae32a1SGerd Hoffmann }
178f1ae32a1SGerd Hoffmann 
1799a77a0f5SHans de Goede static void do_token_in(USBDevice *s, USBPacket *p)
180f1ae32a1SGerd Hoffmann {
181f1ae32a1SGerd Hoffmann     int request, value, index;
182f1ae32a1SGerd Hoffmann 
183f1ae32a1SGerd Hoffmann     assert(p->ep->nr == 0);
184f1ae32a1SGerd Hoffmann 
185f1ae32a1SGerd Hoffmann     request = (s->setup_buf[0] << 8) | s->setup_buf[1];
186f1ae32a1SGerd Hoffmann     value   = (s->setup_buf[3] << 8) | s->setup_buf[2];
187f1ae32a1SGerd Hoffmann     index   = (s->setup_buf[5] << 8) | s->setup_buf[4];
188f1ae32a1SGerd Hoffmann 
189f1ae32a1SGerd Hoffmann     switch(s->setup_state) {
190f1ae32a1SGerd Hoffmann     case SETUP_STATE_ACK:
191f1ae32a1SGerd Hoffmann         if (!(s->setup_buf[0] & USB_DIR_IN)) {
1929a77a0f5SHans de Goede             usb_device_handle_control(s, p, request, value, index,
193f1ae32a1SGerd Hoffmann                                       s->setup_len, s->data_buf);
1949a77a0f5SHans de Goede             if (p->status == USB_RET_ASYNC) {
1959a77a0f5SHans de Goede                 return;
196f1ae32a1SGerd Hoffmann             }
197f1ae32a1SGerd Hoffmann             s->setup_state = SETUP_STATE_IDLE;
1989a77a0f5SHans de Goede             p->actual_length = 0;
199f1ae32a1SGerd Hoffmann         }
2009a77a0f5SHans de Goede         break;
201f1ae32a1SGerd Hoffmann 
202f1ae32a1SGerd Hoffmann     case SETUP_STATE_DATA:
203f1ae32a1SGerd Hoffmann         if (s->setup_buf[0] & USB_DIR_IN) {
204f1ae32a1SGerd Hoffmann             int len = s->setup_len - s->setup_index;
205f1ae32a1SGerd Hoffmann             if (len > p->iov.size) {
206f1ae32a1SGerd Hoffmann                 len = p->iov.size;
207f1ae32a1SGerd Hoffmann             }
208f1ae32a1SGerd Hoffmann             usb_packet_copy(p, s->data_buf + s->setup_index, len);
209f1ae32a1SGerd Hoffmann             s->setup_index += len;
2109a77a0f5SHans de Goede             if (s->setup_index >= s->setup_len) {
211f1ae32a1SGerd Hoffmann                 s->setup_state = SETUP_STATE_ACK;
212f1ae32a1SGerd Hoffmann             }
2139a77a0f5SHans de Goede             return;
2149a77a0f5SHans de Goede         }
215f1ae32a1SGerd Hoffmann         s->setup_state = SETUP_STATE_IDLE;
2169a77a0f5SHans de Goede         p->status = USB_RET_STALL;
2179a77a0f5SHans de Goede         break;
218f1ae32a1SGerd Hoffmann 
219f1ae32a1SGerd Hoffmann     default:
2209a77a0f5SHans de Goede         p->status = USB_RET_STALL;
221f1ae32a1SGerd Hoffmann     }
222f1ae32a1SGerd Hoffmann }
223f1ae32a1SGerd Hoffmann 
2249a77a0f5SHans de Goede static void do_token_out(USBDevice *s, USBPacket *p)
225f1ae32a1SGerd Hoffmann {
226f1ae32a1SGerd Hoffmann     assert(p->ep->nr == 0);
227f1ae32a1SGerd Hoffmann 
228f1ae32a1SGerd Hoffmann     switch(s->setup_state) {
229f1ae32a1SGerd Hoffmann     case SETUP_STATE_ACK:
230f1ae32a1SGerd Hoffmann         if (s->setup_buf[0] & USB_DIR_IN) {
231f1ae32a1SGerd Hoffmann             s->setup_state = SETUP_STATE_IDLE;
232f1ae32a1SGerd Hoffmann             /* transfer OK */
233f1ae32a1SGerd Hoffmann         } else {
234f1ae32a1SGerd Hoffmann             /* ignore additional output */
235f1ae32a1SGerd Hoffmann         }
2369a77a0f5SHans de Goede         break;
237f1ae32a1SGerd Hoffmann 
238f1ae32a1SGerd Hoffmann     case SETUP_STATE_DATA:
239f1ae32a1SGerd Hoffmann         if (!(s->setup_buf[0] & USB_DIR_IN)) {
240f1ae32a1SGerd Hoffmann             int len = s->setup_len - s->setup_index;
241f1ae32a1SGerd Hoffmann             if (len > p->iov.size) {
242f1ae32a1SGerd Hoffmann                 len = p->iov.size;
243f1ae32a1SGerd Hoffmann             }
244f1ae32a1SGerd Hoffmann             usb_packet_copy(p, s->data_buf + s->setup_index, len);
245f1ae32a1SGerd Hoffmann             s->setup_index += len;
2469a77a0f5SHans de Goede             if (s->setup_index >= s->setup_len) {
247f1ae32a1SGerd Hoffmann                 s->setup_state = SETUP_STATE_ACK;
248f1ae32a1SGerd Hoffmann             }
2499a77a0f5SHans de Goede             return;
2509a77a0f5SHans de Goede         }
251f1ae32a1SGerd Hoffmann         s->setup_state = SETUP_STATE_IDLE;
2529a77a0f5SHans de Goede         p->status = USB_RET_STALL;
2539a77a0f5SHans de Goede         break;
254f1ae32a1SGerd Hoffmann 
255f1ae32a1SGerd Hoffmann     default:
2569a77a0f5SHans de Goede         p->status = USB_RET_STALL;
257f1ae32a1SGerd Hoffmann     }
258f1ae32a1SGerd Hoffmann }
259f1ae32a1SGerd Hoffmann 
2609a77a0f5SHans de Goede static void do_parameter(USBDevice *s, USBPacket *p)
261f1ae32a1SGerd Hoffmann {
2629a77a0f5SHans de Goede     int i, request, value, index;
263f1ae32a1SGerd Hoffmann 
264f1ae32a1SGerd Hoffmann     for (i = 0; i < 8; i++) {
265f1ae32a1SGerd Hoffmann         s->setup_buf[i] = p->parameter >> (i*8);
266f1ae32a1SGerd Hoffmann     }
267f1ae32a1SGerd Hoffmann 
268f1ae32a1SGerd Hoffmann     s->setup_state = SETUP_STATE_PARAM;
269f1ae32a1SGerd Hoffmann     s->setup_len   = (s->setup_buf[7] << 8) | s->setup_buf[6];
270f1ae32a1SGerd Hoffmann     s->setup_index = 0;
271f1ae32a1SGerd Hoffmann 
272f1ae32a1SGerd Hoffmann     request = (s->setup_buf[0] << 8) | s->setup_buf[1];
273f1ae32a1SGerd Hoffmann     value   = (s->setup_buf[3] << 8) | s->setup_buf[2];
274f1ae32a1SGerd Hoffmann     index   = (s->setup_buf[5] << 8) | s->setup_buf[4];
275f1ae32a1SGerd Hoffmann 
276f1ae32a1SGerd Hoffmann     if (s->setup_len > sizeof(s->data_buf)) {
277f1ae32a1SGerd Hoffmann         fprintf(stderr,
278f1ae32a1SGerd Hoffmann                 "usb_generic_handle_packet: ctrl buffer too small (%d > %zu)\n",
279f1ae32a1SGerd Hoffmann                 s->setup_len, sizeof(s->data_buf));
2809a77a0f5SHans de Goede         p->status = USB_RET_STALL;
2819a77a0f5SHans de Goede         return;
282f1ae32a1SGerd Hoffmann     }
283f1ae32a1SGerd Hoffmann 
284f1ae32a1SGerd Hoffmann     if (p->pid == USB_TOKEN_OUT) {
285f1ae32a1SGerd Hoffmann         usb_packet_copy(p, s->data_buf, s->setup_len);
286f1ae32a1SGerd Hoffmann     }
287f1ae32a1SGerd Hoffmann 
2889a77a0f5SHans de Goede     usb_device_handle_control(s, p, request, value, index,
289f1ae32a1SGerd Hoffmann                               s->setup_len, s->data_buf);
2909a77a0f5SHans de Goede     if (p->status == USB_RET_ASYNC) {
2919a77a0f5SHans de Goede         return;
292f1ae32a1SGerd Hoffmann     }
293f1ae32a1SGerd Hoffmann 
2949a77a0f5SHans de Goede     if (p->actual_length < s->setup_len) {
2959a77a0f5SHans de Goede         s->setup_len = p->actual_length;
296f1ae32a1SGerd Hoffmann     }
297f1ae32a1SGerd Hoffmann     if (p->pid == USB_TOKEN_IN) {
2989a77a0f5SHans de Goede         p->actual_length = 0;
299f1ae32a1SGerd Hoffmann         usb_packet_copy(p, s->data_buf, s->setup_len);
300f1ae32a1SGerd Hoffmann     }
301f1ae32a1SGerd Hoffmann }
302f1ae32a1SGerd Hoffmann 
303f1ae32a1SGerd Hoffmann /* ctrl complete function for devices which use usb_generic_handle_packet and
304f1ae32a1SGerd Hoffmann    may return USB_RET_ASYNC from their handle_control callback. Device code
305f1ae32a1SGerd Hoffmann    which does this *must* call this function instead of the normal
306f1ae32a1SGerd Hoffmann    usb_packet_complete to complete their async control packets. */
307f1ae32a1SGerd Hoffmann void usb_generic_async_ctrl_complete(USBDevice *s, USBPacket *p)
308f1ae32a1SGerd Hoffmann {
3099a77a0f5SHans de Goede     if (p->status < 0) {
310f1ae32a1SGerd Hoffmann         s->setup_state = SETUP_STATE_IDLE;
311f1ae32a1SGerd Hoffmann     }
312f1ae32a1SGerd Hoffmann 
313f1ae32a1SGerd Hoffmann     switch (s->setup_state) {
314f1ae32a1SGerd Hoffmann     case SETUP_STATE_SETUP:
3159a77a0f5SHans de Goede         if (p->actual_length < s->setup_len) {
3169a77a0f5SHans de Goede             s->setup_len = p->actual_length;
317f1ae32a1SGerd Hoffmann         }
318f1ae32a1SGerd Hoffmann         s->setup_state = SETUP_STATE_DATA;
3199a77a0f5SHans de Goede         p->actual_length = 8;
320f1ae32a1SGerd Hoffmann         break;
321f1ae32a1SGerd Hoffmann 
322f1ae32a1SGerd Hoffmann     case SETUP_STATE_ACK:
323f1ae32a1SGerd Hoffmann         s->setup_state = SETUP_STATE_IDLE;
3249a77a0f5SHans de Goede         p->actual_length = 0;
325f1ae32a1SGerd Hoffmann         break;
326f1ae32a1SGerd Hoffmann 
327f1ae32a1SGerd Hoffmann     case SETUP_STATE_PARAM:
3289a77a0f5SHans de Goede         if (p->actual_length < s->setup_len) {
3299a77a0f5SHans de Goede             s->setup_len = p->actual_length;
330f1ae32a1SGerd Hoffmann         }
331f1ae32a1SGerd Hoffmann         if (p->pid == USB_TOKEN_IN) {
3329a77a0f5SHans de Goede             p->actual_length = 0;
333f1ae32a1SGerd Hoffmann             usb_packet_copy(p, s->data_buf, s->setup_len);
334f1ae32a1SGerd Hoffmann         }
335f1ae32a1SGerd Hoffmann         break;
336f1ae32a1SGerd Hoffmann 
337f1ae32a1SGerd Hoffmann     default:
338f1ae32a1SGerd Hoffmann         break;
339f1ae32a1SGerd Hoffmann     }
340f1ae32a1SGerd Hoffmann     usb_packet_complete(s, p);
341f1ae32a1SGerd Hoffmann }
342f1ae32a1SGerd Hoffmann 
343f1ae32a1SGerd Hoffmann USBDevice *usb_find_device(USBPort *port, uint8_t addr)
344f1ae32a1SGerd Hoffmann {
345f1ae32a1SGerd Hoffmann     USBDevice *dev = port->dev;
346f1ae32a1SGerd Hoffmann 
347f1ae32a1SGerd Hoffmann     if (dev == NULL || !dev->attached || dev->state != USB_STATE_DEFAULT) {
348f1ae32a1SGerd Hoffmann         return NULL;
349f1ae32a1SGerd Hoffmann     }
350f1ae32a1SGerd Hoffmann     if (dev->addr == addr) {
351f1ae32a1SGerd Hoffmann         return dev;
352f1ae32a1SGerd Hoffmann     }
353f1ae32a1SGerd Hoffmann     return usb_device_find_device(dev, addr);
354f1ae32a1SGerd Hoffmann }
355f1ae32a1SGerd Hoffmann 
3569a77a0f5SHans de Goede static void usb_process_one(USBPacket *p)
357f1ae32a1SGerd Hoffmann {
358f1ae32a1SGerd Hoffmann     USBDevice *dev = p->ep->dev;
359f1ae32a1SGerd Hoffmann 
3609a77a0f5SHans de Goede     /*
3619a77a0f5SHans de Goede      * Handlers expect status to be initialized to USB_RET_SUCCESS, but it
3629a77a0f5SHans de Goede      * can be USB_RET_NAK here from a previous usb_process_one() call,
3639a77a0f5SHans de Goede      * or USB_RET_ASYNC from going through usb_queue_one().
3649a77a0f5SHans de Goede      */
3659a77a0f5SHans de Goede     p->status = USB_RET_SUCCESS;
3669a77a0f5SHans de Goede 
367f1ae32a1SGerd Hoffmann     if (p->ep->nr == 0) {
368f1ae32a1SGerd Hoffmann         /* control pipe */
369f1ae32a1SGerd Hoffmann         if (p->parameter) {
3709a77a0f5SHans de Goede             do_parameter(dev, p);
3719a77a0f5SHans de Goede             return;
372f1ae32a1SGerd Hoffmann         }
373f1ae32a1SGerd Hoffmann         switch (p->pid) {
374f1ae32a1SGerd Hoffmann         case USB_TOKEN_SETUP:
3759a77a0f5SHans de Goede             do_token_setup(dev, p);
3769a77a0f5SHans de Goede             break;
377f1ae32a1SGerd Hoffmann         case USB_TOKEN_IN:
3789a77a0f5SHans de Goede             do_token_in(dev, p);
3799a77a0f5SHans de Goede             break;
380f1ae32a1SGerd Hoffmann         case USB_TOKEN_OUT:
3819a77a0f5SHans de Goede             do_token_out(dev, p);
3829a77a0f5SHans de Goede             break;
383f1ae32a1SGerd Hoffmann         default:
3849a77a0f5SHans de Goede             p->status = USB_RET_STALL;
385f1ae32a1SGerd Hoffmann         }
386f1ae32a1SGerd Hoffmann     } else {
387f1ae32a1SGerd Hoffmann         /* data pipe */
3889a77a0f5SHans de Goede         usb_device_handle_data(dev, p);
389f1ae32a1SGerd Hoffmann     }
390f1ae32a1SGerd Hoffmann }
391f1ae32a1SGerd Hoffmann 
3929a77a0f5SHans de Goede static void usb_queue_one(USBPacket *p)
3939a77a0f5SHans de Goede {
3949a77a0f5SHans de Goede     usb_packet_set_state(p, USB_PACKET_QUEUED);
3959a77a0f5SHans de Goede     QTAILQ_INSERT_TAIL(&p->ep->queue, p, queue);
3969a77a0f5SHans de Goede     p->status = USB_RET_ASYNC;
3979a77a0f5SHans de Goede }
3989a77a0f5SHans de Goede 
3999a77a0f5SHans de Goede /* Hand over a packet to a device for processing.  p->status ==
400f1ae32a1SGerd Hoffmann    USB_RET_ASYNC indicates the processing isn't finished yet, the
401f1ae32a1SGerd Hoffmann    driver will call usb_packet_complete() when done processing it. */
4029a77a0f5SHans de Goede void usb_handle_packet(USBDevice *dev, USBPacket *p)
403f1ae32a1SGerd Hoffmann {
404f1ae32a1SGerd Hoffmann     if (dev == NULL) {
4059a77a0f5SHans de Goede         p->status = USB_RET_NODEV;
4069a77a0f5SHans de Goede         return;
407f1ae32a1SGerd Hoffmann     }
408f1ae32a1SGerd Hoffmann     assert(dev == p->ep->dev);
409f1ae32a1SGerd Hoffmann     assert(dev->state == USB_STATE_DEFAULT);
4105ac2731cSGerd Hoffmann     usb_packet_check_state(p, USB_PACKET_SETUP);
411f1ae32a1SGerd Hoffmann     assert(p->ep != NULL);
412f1ae32a1SGerd Hoffmann 
4130132b4b6SHans de Goede     /* Submitting a new packet clears halt */
4140132b4b6SHans de Goede     if (p->ep->halted) {
4150132b4b6SHans de Goede         assert(QTAILQ_EMPTY(&p->ep->queue));
4160132b4b6SHans de Goede         p->ep->halted = false;
4170132b4b6SHans de Goede     }
4180132b4b6SHans de Goede 
419c96c41edSGerd Hoffmann     if (QTAILQ_EMPTY(&p->ep->queue) || p->ep->pipeline || p->stream) {
4209a77a0f5SHans de Goede         usb_process_one(p);
4219a77a0f5SHans de Goede         if (p->status == USB_RET_ASYNC) {
422be41efdeSHans de Goede             /* hcd drivers cannot handle async for isoc */
423aaac7434SHans de Goede             assert(p->ep->type != USB_ENDPOINT_XFER_ISOC);
424be41efdeSHans de Goede             /* using async for interrupt packets breaks migration */
425be41efdeSHans de Goede             assert(p->ep->type != USB_ENDPOINT_XFER_INT ||
42675633529SMichael Marineau                    (dev->flags & (1 << USB_DEV_FLAG_IS_HOST)));
427f1ae32a1SGerd Hoffmann             usb_packet_set_state(p, USB_PACKET_ASYNC);
428f1ae32a1SGerd Hoffmann             QTAILQ_INSERT_TAIL(&p->ep->queue, p, queue);
4299a77a0f5SHans de Goede         } else if (p->status == USB_RET_ADD_TO_QUEUE) {
4309a77a0f5SHans de Goede             usb_queue_one(p);
431f1ae32a1SGerd Hoffmann         } else {
4320132b4b6SHans de Goede             /*
4330132b4b6SHans de Goede              * When pipelining is enabled usb-devices must always return async,
4340132b4b6SHans de Goede              * otherwise packets can complete out of order!
4350132b4b6SHans de Goede              */
436c96c41edSGerd Hoffmann             assert(p->stream || !p->ep->pipeline ||
437c96c41edSGerd Hoffmann                    QTAILQ_EMPTY(&p->ep->queue));
4389a77a0f5SHans de Goede             if (p->status != USB_RET_NAK) {
439f1ae32a1SGerd Hoffmann                 usb_packet_set_state(p, USB_PACKET_COMPLETE);
440f1ae32a1SGerd Hoffmann             }
441cc409974SHans de Goede         }
442f1ae32a1SGerd Hoffmann     } else {
4439a77a0f5SHans de Goede         usb_queue_one(p);
444f1ae32a1SGerd Hoffmann     }
445f1ae32a1SGerd Hoffmann }
446f1ae32a1SGerd Hoffmann 
447d0ff81b8SHans de Goede void usb_packet_complete_one(USBDevice *dev, USBPacket *p)
4480132b4b6SHans de Goede {
4490132b4b6SHans de Goede     USBEndpoint *ep = p->ep;
4500132b4b6SHans de Goede 
451c96c41edSGerd Hoffmann     assert(p->stream || QTAILQ_FIRST(&ep->queue) == p);
4529a77a0f5SHans de Goede     assert(p->status != USB_RET_ASYNC && p->status != USB_RET_NAK);
4530132b4b6SHans de Goede 
4549a77a0f5SHans de Goede     if (p->status != USB_RET_SUCCESS ||
4559a77a0f5SHans de Goede             (p->short_not_ok && (p->actual_length < p->iov.size))) {
4560132b4b6SHans de Goede         ep->halted = true;
4570132b4b6SHans de Goede     }
4580132b4b6SHans de Goede     usb_packet_set_state(p, USB_PACKET_COMPLETE);
4590132b4b6SHans de Goede     QTAILQ_REMOVE(&ep->queue, p, queue);
4600132b4b6SHans de Goede     dev->port->ops->complete(dev->port, p);
4610132b4b6SHans de Goede }
4620132b4b6SHans de Goede 
463f1ae32a1SGerd Hoffmann /* Notify the controller that an async packet is complete.  This should only
464f1ae32a1SGerd Hoffmann    be called for packets previously deferred by returning USB_RET_ASYNC from
465f1ae32a1SGerd Hoffmann    handle_packet. */
466f1ae32a1SGerd Hoffmann void usb_packet_complete(USBDevice *dev, USBPacket *p)
467f1ae32a1SGerd Hoffmann {
468f1ae32a1SGerd Hoffmann     USBEndpoint *ep = p->ep;
469f1ae32a1SGerd Hoffmann 
4705ac2731cSGerd Hoffmann     usb_packet_check_state(p, USB_PACKET_ASYNC);
471d0ff81b8SHans de Goede     usb_packet_complete_one(dev, p);
472f1ae32a1SGerd Hoffmann 
4730cae7b1aSHans de Goede     while (!QTAILQ_EMPTY(&ep->queue)) {
474f1ae32a1SGerd Hoffmann         p = QTAILQ_FIRST(&ep->queue);
4750cae7b1aSHans de Goede         if (ep->halted) {
4760cae7b1aSHans de Goede             /* Empty the queue on a halt */
4779a77a0f5SHans de Goede             p->status = USB_RET_REMOVE_FROM_QUEUE;
4780cae7b1aSHans de Goede             dev->port->ops->complete(dev->port, p);
4790cae7b1aSHans de Goede             continue;
4800cae7b1aSHans de Goede         }
481f1ae32a1SGerd Hoffmann         if (p->state == USB_PACKET_ASYNC) {
482f1ae32a1SGerd Hoffmann             break;
483f1ae32a1SGerd Hoffmann         }
4845ac2731cSGerd Hoffmann         usb_packet_check_state(p, USB_PACKET_QUEUED);
4859a77a0f5SHans de Goede         usb_process_one(p);
4869a77a0f5SHans de Goede         if (p->status == USB_RET_ASYNC) {
487f1ae32a1SGerd Hoffmann             usb_packet_set_state(p, USB_PACKET_ASYNC);
488f1ae32a1SGerd Hoffmann             break;
489f1ae32a1SGerd Hoffmann         }
490d0ff81b8SHans de Goede         usb_packet_complete_one(ep->dev, p);
491f1ae32a1SGerd Hoffmann     }
492f1ae32a1SGerd Hoffmann }
493f1ae32a1SGerd Hoffmann 
494f1ae32a1SGerd Hoffmann /* Cancel an active packet.  The packed must have been deferred by
495f1ae32a1SGerd Hoffmann    returning USB_RET_ASYNC from handle_packet, and not yet
496f1ae32a1SGerd Hoffmann    completed.  */
497f1ae32a1SGerd Hoffmann void usb_cancel_packet(USBPacket * p)
498f1ae32a1SGerd Hoffmann {
499f1ae32a1SGerd Hoffmann     bool callback = (p->state == USB_PACKET_ASYNC);
500f1ae32a1SGerd Hoffmann     assert(usb_packet_is_inflight(p));
501f1ae32a1SGerd Hoffmann     usb_packet_set_state(p, USB_PACKET_CANCELED);
502f1ae32a1SGerd Hoffmann     QTAILQ_REMOVE(&p->ep->queue, p, queue);
503f1ae32a1SGerd Hoffmann     if (callback) {
504f1ae32a1SGerd Hoffmann         usb_device_cancel_packet(p->ep->dev, p);
505f1ae32a1SGerd Hoffmann     }
506f1ae32a1SGerd Hoffmann }
507f1ae32a1SGerd Hoffmann 
508f1ae32a1SGerd Hoffmann 
509f1ae32a1SGerd Hoffmann void usb_packet_init(USBPacket *p)
510f1ae32a1SGerd Hoffmann {
511f1ae32a1SGerd Hoffmann     qemu_iovec_init(&p->iov, 1);
512f1ae32a1SGerd Hoffmann }
513f1ae32a1SGerd Hoffmann 
5145ac2731cSGerd Hoffmann static const char *usb_packet_state_name(USBPacketState state)
515f1ae32a1SGerd Hoffmann {
516f1ae32a1SGerd Hoffmann     static const char *name[] = {
517f1ae32a1SGerd Hoffmann         [USB_PACKET_UNDEFINED] = "undef",
518f1ae32a1SGerd Hoffmann         [USB_PACKET_SETUP]     = "setup",
519f1ae32a1SGerd Hoffmann         [USB_PACKET_QUEUED]    = "queued",
520f1ae32a1SGerd Hoffmann         [USB_PACKET_ASYNC]     = "async",
521f1ae32a1SGerd Hoffmann         [USB_PACKET_COMPLETE]  = "complete",
522f1ae32a1SGerd Hoffmann         [USB_PACKET_CANCELED]  = "canceled",
523f1ae32a1SGerd Hoffmann     };
5245ac2731cSGerd Hoffmann     if (state < ARRAY_SIZE(name)) {
5255ac2731cSGerd Hoffmann         return name[state];
5265ac2731cSGerd Hoffmann     }
5275ac2731cSGerd Hoffmann     return "INVALID";
5285ac2731cSGerd Hoffmann }
5295ac2731cSGerd Hoffmann 
5305ac2731cSGerd Hoffmann void usb_packet_check_state(USBPacket *p, USBPacketState expected)
5315ac2731cSGerd Hoffmann {
5325ac2731cSGerd Hoffmann     USBDevice *dev;
5335ac2731cSGerd Hoffmann     USBBus *bus;
5345ac2731cSGerd Hoffmann 
5355ac2731cSGerd Hoffmann     if (p->state == expected) {
5365ac2731cSGerd Hoffmann         return;
5375ac2731cSGerd Hoffmann     }
5385ac2731cSGerd Hoffmann     dev = p->ep->dev;
5395ac2731cSGerd Hoffmann     bus = usb_bus_from_device(dev);
5405ac2731cSGerd Hoffmann     trace_usb_packet_state_fault(bus->busnr, dev->port->path, p->ep->nr, p,
5415ac2731cSGerd Hoffmann                                  usb_packet_state_name(p->state),
5425ac2731cSGerd Hoffmann                                  usb_packet_state_name(expected));
5435ac2731cSGerd Hoffmann     assert(!"usb packet state check failed");
5445ac2731cSGerd Hoffmann }
5455ac2731cSGerd Hoffmann 
5465ac2731cSGerd Hoffmann void usb_packet_set_state(USBPacket *p, USBPacketState state)
5475ac2731cSGerd Hoffmann {
548f5bf14bfSGerd Hoffmann     if (p->ep) {
549f1ae32a1SGerd Hoffmann         USBDevice *dev = p->ep->dev;
550f1ae32a1SGerd Hoffmann         USBBus *bus = usb_bus_from_device(dev);
5515ac2731cSGerd Hoffmann         trace_usb_packet_state_change(bus->busnr, dev->port->path, p->ep->nr, p,
5525ac2731cSGerd Hoffmann                                       usb_packet_state_name(p->state),
5535ac2731cSGerd Hoffmann                                       usb_packet_state_name(state));
554f5bf14bfSGerd Hoffmann     } else {
555f5bf14bfSGerd Hoffmann         trace_usb_packet_state_change(-1, "", -1, p,
556f5bf14bfSGerd Hoffmann                                       usb_packet_state_name(p->state),
557f5bf14bfSGerd Hoffmann                                       usb_packet_state_name(state));
558f5bf14bfSGerd Hoffmann     }
559f1ae32a1SGerd Hoffmann     p->state = state;
560f1ae32a1SGerd Hoffmann }
561f1ae32a1SGerd Hoffmann 
5628550a02dSGerd Hoffmann void usb_packet_setup(USBPacket *p, int pid,
5638550a02dSGerd Hoffmann                       USBEndpoint *ep, unsigned int stream,
5648550a02dSGerd Hoffmann                       uint64_t id, bool short_not_ok, bool int_req)
565f1ae32a1SGerd Hoffmann {
566f1ae32a1SGerd Hoffmann     assert(!usb_packet_is_inflight(p));
5670cc6a0f1SGerd Hoffmann     assert(p->iov.iov != NULL);
568e983395dSGerd Hoffmann     p->id = id;
569f1ae32a1SGerd Hoffmann     p->pid = pid;
570f1ae32a1SGerd Hoffmann     p->ep = ep;
5718550a02dSGerd Hoffmann     p->stream = stream;
5729a77a0f5SHans de Goede     p->status = USB_RET_SUCCESS;
5739a77a0f5SHans de Goede     p->actual_length = 0;
574f1ae32a1SGerd Hoffmann     p->parameter = 0;
5756ba43f1fSHans de Goede     p->short_not_ok = short_not_ok;
576a6fb2ddbSHans de Goede     p->int_req = int_req;
577a552a966SHans de Goede     p->combined = NULL;
578f1ae32a1SGerd Hoffmann     qemu_iovec_reset(&p->iov);
579f1ae32a1SGerd Hoffmann     usb_packet_set_state(p, USB_PACKET_SETUP);
580f1ae32a1SGerd Hoffmann }
581f1ae32a1SGerd Hoffmann 
582f1ae32a1SGerd Hoffmann void usb_packet_addbuf(USBPacket *p, void *ptr, size_t len)
583f1ae32a1SGerd Hoffmann {
584f1ae32a1SGerd Hoffmann     qemu_iovec_add(&p->iov, ptr, len);
585f1ae32a1SGerd Hoffmann }
586f1ae32a1SGerd Hoffmann 
587f1ae32a1SGerd Hoffmann void usb_packet_copy(USBPacket *p, void *ptr, size_t bytes)
588f1ae32a1SGerd Hoffmann {
5896a98d1c0SGerd Hoffmann     QEMUIOVector *iov = p->combined ? &p->combined->iov : &p->iov;
5906a98d1c0SGerd Hoffmann 
5919a77a0f5SHans de Goede     assert(p->actual_length >= 0);
5926a98d1c0SGerd Hoffmann     assert(p->actual_length + bytes <= iov->size);
593f1ae32a1SGerd Hoffmann     switch (p->pid) {
594f1ae32a1SGerd Hoffmann     case USB_TOKEN_SETUP:
595f1ae32a1SGerd Hoffmann     case USB_TOKEN_OUT:
5966a98d1c0SGerd Hoffmann         iov_to_buf(iov->iov, iov->niov, p->actual_length, ptr, bytes);
597f1ae32a1SGerd Hoffmann         break;
598f1ae32a1SGerd Hoffmann     case USB_TOKEN_IN:
5996a98d1c0SGerd Hoffmann         iov_from_buf(iov->iov, iov->niov, p->actual_length, ptr, bytes);
600f1ae32a1SGerd Hoffmann         break;
601f1ae32a1SGerd Hoffmann     default:
602f1ae32a1SGerd Hoffmann         fprintf(stderr, "%s: invalid pid: %x\n", __func__, p->pid);
603f1ae32a1SGerd Hoffmann         abort();
604f1ae32a1SGerd Hoffmann     }
6059a77a0f5SHans de Goede     p->actual_length += bytes;
606f1ae32a1SGerd Hoffmann }
607f1ae32a1SGerd Hoffmann 
608f1ae32a1SGerd Hoffmann void usb_packet_skip(USBPacket *p, size_t bytes)
609f1ae32a1SGerd Hoffmann {
6106a98d1c0SGerd Hoffmann     QEMUIOVector *iov = p->combined ? &p->combined->iov : &p->iov;
6116a98d1c0SGerd Hoffmann 
6129a77a0f5SHans de Goede     assert(p->actual_length >= 0);
6136a98d1c0SGerd Hoffmann     assert(p->actual_length + bytes <= iov->size);
614f1ae32a1SGerd Hoffmann     if (p->pid == USB_TOKEN_IN) {
6156a98d1c0SGerd Hoffmann         iov_memset(iov->iov, iov->niov, p->actual_length, 0, bytes);
616f1ae32a1SGerd Hoffmann     }
6179a77a0f5SHans de Goede     p->actual_length += bytes;
618f1ae32a1SGerd Hoffmann }
619f1ae32a1SGerd Hoffmann 
6206a98d1c0SGerd Hoffmann size_t usb_packet_size(USBPacket *p)
6216a98d1c0SGerd Hoffmann {
6226a98d1c0SGerd Hoffmann     return p->combined ? p->combined->iov.size : p->iov.size;
6236a98d1c0SGerd Hoffmann }
6246a98d1c0SGerd Hoffmann 
625f1ae32a1SGerd Hoffmann void usb_packet_cleanup(USBPacket *p)
626f1ae32a1SGerd Hoffmann {
627f1ae32a1SGerd Hoffmann     assert(!usb_packet_is_inflight(p));
628f1ae32a1SGerd Hoffmann     qemu_iovec_destroy(&p->iov);
629f1ae32a1SGerd Hoffmann }
630f1ae32a1SGerd Hoffmann 
63119deaa08SGerd Hoffmann void usb_ep_reset(USBDevice *dev)
632f1ae32a1SGerd Hoffmann {
633f1ae32a1SGerd Hoffmann     int ep;
634f1ae32a1SGerd Hoffmann 
635f1ae32a1SGerd Hoffmann     dev->ep_ctl.nr = 0;
636f1ae32a1SGerd Hoffmann     dev->ep_ctl.type = USB_ENDPOINT_XFER_CONTROL;
637f1ae32a1SGerd Hoffmann     dev->ep_ctl.ifnum = 0;
6389adbaad3SHans de Goede     dev->ep_ctl.max_packet_size = 64;
63904b300f8SHans de Goede     dev->ep_ctl.max_streams = 0;
640f1ae32a1SGerd Hoffmann     dev->ep_ctl.dev = dev;
641f1ae32a1SGerd Hoffmann     dev->ep_ctl.pipeline = false;
642f1ae32a1SGerd Hoffmann     for (ep = 0; ep < USB_MAX_ENDPOINTS; ep++) {
643f1ae32a1SGerd Hoffmann         dev->ep_in[ep].nr = ep + 1;
644f1ae32a1SGerd Hoffmann         dev->ep_out[ep].nr = ep + 1;
645f1ae32a1SGerd Hoffmann         dev->ep_in[ep].pid = USB_TOKEN_IN;
646f1ae32a1SGerd Hoffmann         dev->ep_out[ep].pid = USB_TOKEN_OUT;
647f1ae32a1SGerd Hoffmann         dev->ep_in[ep].type = USB_ENDPOINT_XFER_INVALID;
648f1ae32a1SGerd Hoffmann         dev->ep_out[ep].type = USB_ENDPOINT_XFER_INVALID;
6497c37e6a4SGerd Hoffmann         dev->ep_in[ep].ifnum = USB_INTERFACE_INVALID;
6507c37e6a4SGerd Hoffmann         dev->ep_out[ep].ifnum = USB_INTERFACE_INVALID;
6519adbaad3SHans de Goede         dev->ep_in[ep].max_packet_size = 0;
6529adbaad3SHans de Goede         dev->ep_out[ep].max_packet_size = 0;
65304b300f8SHans de Goede         dev->ep_in[ep].max_streams = 0;
65404b300f8SHans de Goede         dev->ep_out[ep].max_streams = 0;
655f1ae32a1SGerd Hoffmann         dev->ep_in[ep].dev = dev;
656f1ae32a1SGerd Hoffmann         dev->ep_out[ep].dev = dev;
657f1ae32a1SGerd Hoffmann         dev->ep_in[ep].pipeline = false;
658f1ae32a1SGerd Hoffmann         dev->ep_out[ep].pipeline = false;
65919deaa08SGerd Hoffmann     }
66019deaa08SGerd Hoffmann }
66119deaa08SGerd Hoffmann 
66219deaa08SGerd Hoffmann void usb_ep_init(USBDevice *dev)
66319deaa08SGerd Hoffmann {
66419deaa08SGerd Hoffmann     int ep;
66519deaa08SGerd Hoffmann 
66619deaa08SGerd Hoffmann     usb_ep_reset(dev);
66719deaa08SGerd Hoffmann     QTAILQ_INIT(&dev->ep_ctl.queue);
66819deaa08SGerd Hoffmann     for (ep = 0; ep < USB_MAX_ENDPOINTS; ep++) {
669f1ae32a1SGerd Hoffmann         QTAILQ_INIT(&dev->ep_in[ep].queue);
670f1ae32a1SGerd Hoffmann         QTAILQ_INIT(&dev->ep_out[ep].queue);
671f1ae32a1SGerd Hoffmann     }
672f1ae32a1SGerd Hoffmann }
673f1ae32a1SGerd Hoffmann 
674f1ae32a1SGerd Hoffmann void usb_ep_dump(USBDevice *dev)
675f1ae32a1SGerd Hoffmann {
676f1ae32a1SGerd Hoffmann     static const char *tname[] = {
677f1ae32a1SGerd Hoffmann         [USB_ENDPOINT_XFER_CONTROL] = "control",
678f1ae32a1SGerd Hoffmann         [USB_ENDPOINT_XFER_ISOC]    = "isoc",
679f1ae32a1SGerd Hoffmann         [USB_ENDPOINT_XFER_BULK]    = "bulk",
680f1ae32a1SGerd Hoffmann         [USB_ENDPOINT_XFER_INT]     = "int",
681f1ae32a1SGerd Hoffmann     };
682f1ae32a1SGerd Hoffmann     int ifnum, ep, first;
683f1ae32a1SGerd Hoffmann 
684f1ae32a1SGerd Hoffmann     fprintf(stderr, "Device \"%s\", config %d\n",
685f1ae32a1SGerd Hoffmann             dev->product_desc, dev->configuration);
686f1ae32a1SGerd Hoffmann     for (ifnum = 0; ifnum < 16; ifnum++) {
687f1ae32a1SGerd Hoffmann         first = 1;
688f1ae32a1SGerd Hoffmann         for (ep = 0; ep < USB_MAX_ENDPOINTS; ep++) {
689f1ae32a1SGerd Hoffmann             if (dev->ep_in[ep].type != USB_ENDPOINT_XFER_INVALID &&
690f1ae32a1SGerd Hoffmann                 dev->ep_in[ep].ifnum == ifnum) {
691f1ae32a1SGerd Hoffmann                 if (first) {
692f1ae32a1SGerd Hoffmann                     first = 0;
693f1ae32a1SGerd Hoffmann                     fprintf(stderr, "  Interface %d, alternative %d\n",
694f1ae32a1SGerd Hoffmann                             ifnum, dev->altsetting[ifnum]);
695f1ae32a1SGerd Hoffmann                 }
696f1ae32a1SGerd Hoffmann                 fprintf(stderr, "    Endpoint %d, IN, %s, %d max\n", ep,
697f1ae32a1SGerd Hoffmann                         tname[dev->ep_in[ep].type],
698f1ae32a1SGerd Hoffmann                         dev->ep_in[ep].max_packet_size);
699f1ae32a1SGerd Hoffmann             }
700f1ae32a1SGerd Hoffmann             if (dev->ep_out[ep].type != USB_ENDPOINT_XFER_INVALID &&
701f1ae32a1SGerd Hoffmann                 dev->ep_out[ep].ifnum == ifnum) {
702f1ae32a1SGerd Hoffmann                 if (first) {
703f1ae32a1SGerd Hoffmann                     first = 0;
704f1ae32a1SGerd Hoffmann                     fprintf(stderr, "  Interface %d, alternative %d\n",
705f1ae32a1SGerd Hoffmann                             ifnum, dev->altsetting[ifnum]);
706f1ae32a1SGerd Hoffmann                 }
707f1ae32a1SGerd Hoffmann                 fprintf(stderr, "    Endpoint %d, OUT, %s, %d max\n", ep,
708f1ae32a1SGerd Hoffmann                         tname[dev->ep_out[ep].type],
709f1ae32a1SGerd Hoffmann                         dev->ep_out[ep].max_packet_size);
710f1ae32a1SGerd Hoffmann             }
711f1ae32a1SGerd Hoffmann         }
712f1ae32a1SGerd Hoffmann     }
713f1ae32a1SGerd Hoffmann     fprintf(stderr, "--\n");
714f1ae32a1SGerd Hoffmann }
715f1ae32a1SGerd Hoffmann 
716f1ae32a1SGerd Hoffmann struct USBEndpoint *usb_ep_get(USBDevice *dev, int pid, int ep)
717f1ae32a1SGerd Hoffmann {
718f1ae32a1SGerd Hoffmann     struct USBEndpoint *eps;
719f1ae32a1SGerd Hoffmann 
720f1ae32a1SGerd Hoffmann     if (dev == NULL) {
721f1ae32a1SGerd Hoffmann         return NULL;
722f1ae32a1SGerd Hoffmann     }
723f1ae32a1SGerd Hoffmann     eps = (pid == USB_TOKEN_IN) ? dev->ep_in : dev->ep_out;
724f1ae32a1SGerd Hoffmann     if (ep == 0) {
725f1ae32a1SGerd Hoffmann         return &dev->ep_ctl;
726f1ae32a1SGerd Hoffmann     }
727f1ae32a1SGerd Hoffmann     assert(pid == USB_TOKEN_IN || pid == USB_TOKEN_OUT);
728f1ae32a1SGerd Hoffmann     assert(ep > 0 && ep <= USB_MAX_ENDPOINTS);
729f1ae32a1SGerd Hoffmann     return eps + ep - 1;
730f1ae32a1SGerd Hoffmann }
731f1ae32a1SGerd Hoffmann 
732f1ae32a1SGerd Hoffmann uint8_t usb_ep_get_type(USBDevice *dev, int pid, int ep)
733f1ae32a1SGerd Hoffmann {
734f1ae32a1SGerd Hoffmann     struct USBEndpoint *uep = usb_ep_get(dev, pid, ep);
735f1ae32a1SGerd Hoffmann     return uep->type;
736f1ae32a1SGerd Hoffmann }
737f1ae32a1SGerd Hoffmann 
738f1ae32a1SGerd Hoffmann void usb_ep_set_type(USBDevice *dev, int pid, int ep, uint8_t type)
739f1ae32a1SGerd Hoffmann {
740f1ae32a1SGerd Hoffmann     struct USBEndpoint *uep = usb_ep_get(dev, pid, ep);
741f1ae32a1SGerd Hoffmann     uep->type = type;
742f1ae32a1SGerd Hoffmann }
743f1ae32a1SGerd Hoffmann 
744f1ae32a1SGerd Hoffmann void usb_ep_set_ifnum(USBDevice *dev, int pid, int ep, uint8_t ifnum)
745f1ae32a1SGerd Hoffmann {
746f1ae32a1SGerd Hoffmann     struct USBEndpoint *uep = usb_ep_get(dev, pid, ep);
747f1ae32a1SGerd Hoffmann     uep->ifnum = ifnum;
748f1ae32a1SGerd Hoffmann }
749f1ae32a1SGerd Hoffmann 
750f1ae32a1SGerd Hoffmann void usb_ep_set_max_packet_size(USBDevice *dev, int pid, int ep,
751f1ae32a1SGerd Hoffmann                                 uint16_t raw)
752f1ae32a1SGerd Hoffmann {
753f1ae32a1SGerd Hoffmann     struct USBEndpoint *uep = usb_ep_get(dev, pid, ep);
754f1ae32a1SGerd Hoffmann     int size, microframes;
755f1ae32a1SGerd Hoffmann 
756f1ae32a1SGerd Hoffmann     size = raw & 0x7ff;
757f1ae32a1SGerd Hoffmann     switch ((raw >> 11) & 3) {
758f1ae32a1SGerd Hoffmann     case 1:
759f1ae32a1SGerd Hoffmann         microframes = 2;
760f1ae32a1SGerd Hoffmann         break;
761f1ae32a1SGerd Hoffmann     case 2:
762f1ae32a1SGerd Hoffmann         microframes = 3;
763f1ae32a1SGerd Hoffmann         break;
764f1ae32a1SGerd Hoffmann     default:
765f1ae32a1SGerd Hoffmann         microframes = 1;
766f1ae32a1SGerd Hoffmann         break;
767f1ae32a1SGerd Hoffmann     }
768f1ae32a1SGerd Hoffmann     uep->max_packet_size = size * microframes;
769f1ae32a1SGerd Hoffmann }
770f1ae32a1SGerd Hoffmann 
77104b300f8SHans de Goede void usb_ep_set_max_streams(USBDevice *dev, int pid, int ep, uint8_t raw)
77204b300f8SHans de Goede {
77304b300f8SHans de Goede     struct USBEndpoint *uep = usb_ep_get(dev, pid, ep);
77404b300f8SHans de Goede     int MaxStreams;
77504b300f8SHans de Goede 
77604b300f8SHans de Goede     MaxStreams = raw & 0x1f;
77704b300f8SHans de Goede     if (MaxStreams) {
77804b300f8SHans de Goede         uep->max_streams = 1 << MaxStreams;
77904b300f8SHans de Goede     } else {
78004b300f8SHans de Goede         uep->max_streams = 0;
78104b300f8SHans de Goede     }
78204b300f8SHans de Goede }
78304b300f8SHans de Goede 
784e382d966SGerd Hoffmann void usb_ep_set_halted(USBDevice *dev, int pid, int ep, bool halted)
785e382d966SGerd Hoffmann {
786e382d966SGerd Hoffmann     struct USBEndpoint *uep = usb_ep_get(dev, pid, ep);
787e382d966SGerd Hoffmann     uep->halted = halted;
788e382d966SGerd Hoffmann }
789e382d966SGerd Hoffmann 
790c13a9e61SHans de Goede USBPacket *usb_ep_find_packet_by_id(USBDevice *dev, int pid, int ep,
791c13a9e61SHans de Goede                                     uint64_t id)
792c13a9e61SHans de Goede {
793c13a9e61SHans de Goede     struct USBEndpoint *uep = usb_ep_get(dev, pid, ep);
794c13a9e61SHans de Goede     USBPacket *p;
795c13a9e61SHans de Goede 
7966735d433SHans de Goede     QTAILQ_FOREACH(p, &uep->queue, queue) {
797c13a9e61SHans de Goede         if (p->id == id) {
798c13a9e61SHans de Goede             return p;
799c13a9e61SHans de Goede         }
800c13a9e61SHans de Goede     }
801c13a9e61SHans de Goede 
802c13a9e61SHans de Goede     return NULL;
803c13a9e61SHans de Goede }
804