xref: /openbmc/qemu/hw/usb/dev-hub.c (revision 22d7aa885bb09c6ec35840e7bc286c306b6b15dd)
1f1ae32a1SGerd Hoffmann /*
2f1ae32a1SGerd Hoffmann  * QEMU USB HUB emulation
3f1ae32a1SGerd Hoffmann  *
4f1ae32a1SGerd Hoffmann  * Copyright (c) 2005 Fabrice Bellard
5f1ae32a1SGerd Hoffmann  *
6f1ae32a1SGerd Hoffmann  * Permission is hereby granted, free of charge, to any person obtaining a copy
7f1ae32a1SGerd Hoffmann  * of this software and associated documentation files (the "Software"), to deal
8f1ae32a1SGerd Hoffmann  * in the Software without restriction, including without limitation the rights
9f1ae32a1SGerd Hoffmann  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10f1ae32a1SGerd Hoffmann  * copies of the Software, and to permit persons to whom the Software is
11f1ae32a1SGerd Hoffmann  * furnished to do so, subject to the following conditions:
12f1ae32a1SGerd Hoffmann  *
13f1ae32a1SGerd Hoffmann  * The above copyright notice and this permission notice shall be included in
14f1ae32a1SGerd Hoffmann  * all copies or substantial portions of the Software.
15f1ae32a1SGerd Hoffmann  *
16f1ae32a1SGerd Hoffmann  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17f1ae32a1SGerd Hoffmann  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18f1ae32a1SGerd Hoffmann  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19f1ae32a1SGerd Hoffmann  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20f1ae32a1SGerd Hoffmann  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21f1ae32a1SGerd Hoffmann  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22f1ae32a1SGerd Hoffmann  * THE SOFTWARE.
23f1ae32a1SGerd Hoffmann  */
240b8fa32fSMarkus Armbruster 
25e532b2e0SPeter Maydell #include "qemu/osdep.h"
26da34e65cSMarkus Armbruster #include "qapi/error.h"
271cc403ebSGerd Hoffmann #include "qemu/timer.h"
28529f8f9fSGerd Hoffmann #include "trace.h"
29a27bd6c7SMarkus Armbruster #include "hw/qdev-properties.h"
30f1ae32a1SGerd Hoffmann #include "hw/usb.h"
31d6454270SMarkus Armbruster #include "migration/vmstate.h"
32463581a8SMichael S. Tsirkin #include "desc.h"
33c24e4aacSGerd Hoffmann #include "qemu/error-report.h"
340b8fa32fSMarkus Armbruster #include "qemu/module.h"
35db1015e9SEduardo Habkost #include "qom/object.h"
36f1ae32a1SGerd Hoffmann 
379d84bb00SGerd Hoffmann #define MAX_PORTS 8
38f1ae32a1SGerd Hoffmann 
39f1ae32a1SGerd Hoffmann typedef struct USBHubPort {
40f1ae32a1SGerd Hoffmann     USBPort port;
41f1ae32a1SGerd Hoffmann     uint16_t wPortStatus;
42f1ae32a1SGerd Hoffmann     uint16_t wPortChange;
43f1ae32a1SGerd Hoffmann } USBHubPort;
44f1ae32a1SGerd Hoffmann 
45db1015e9SEduardo Habkost struct USBHubState {
46f1ae32a1SGerd Hoffmann     USBDevice dev;
47f1ae32a1SGerd Hoffmann     USBEndpoint *intr;
489d84bb00SGerd Hoffmann     uint32_t num_ports;
49*22d7aa88SGuenter Roeck     uint32_t usb_version;
501cc403ebSGerd Hoffmann     bool port_power;
511cc403ebSGerd Hoffmann     QEMUTimer *port_timer;
529d84bb00SGerd Hoffmann     USBHubPort ports[MAX_PORTS];
53db1015e9SEduardo Habkost };
54f1ae32a1SGerd Hoffmann 
55e81b13adSGonglei #define TYPE_USB_HUB "usb-hub"
568063396bSEduardo Habkost OBJECT_DECLARE_SIMPLE_TYPE(USBHubState, USB_HUB)
57e81b13adSGonglei 
58f1ae32a1SGerd Hoffmann #define ClearHubFeature         (0x2000 | USB_REQ_CLEAR_FEATURE)
59f1ae32a1SGerd Hoffmann #define ClearPortFeature        (0x2300 | USB_REQ_CLEAR_FEATURE)
60f1ae32a1SGerd Hoffmann #define GetHubDescriptor        (0xa000 | USB_REQ_GET_DESCRIPTOR)
61f1ae32a1SGerd Hoffmann #define GetHubStatus            (0xa000 | USB_REQ_GET_STATUS)
62f1ae32a1SGerd Hoffmann #define GetPortStatus           (0xa300 | USB_REQ_GET_STATUS)
63f1ae32a1SGerd Hoffmann #define SetHubFeature           (0x2000 | USB_REQ_SET_FEATURE)
64f1ae32a1SGerd Hoffmann #define SetPortFeature          (0x2300 | USB_REQ_SET_FEATURE)
65f1ae32a1SGerd Hoffmann 
66f1ae32a1SGerd Hoffmann #define PORT_STAT_CONNECTION    0x0001
67f1ae32a1SGerd Hoffmann #define PORT_STAT_ENABLE        0x0002
68f1ae32a1SGerd Hoffmann #define PORT_STAT_SUSPEND       0x0004
69f1ae32a1SGerd Hoffmann #define PORT_STAT_OVERCURRENT   0x0008
70f1ae32a1SGerd Hoffmann #define PORT_STAT_RESET         0x0010
71f1ae32a1SGerd Hoffmann #define PORT_STAT_POWER         0x0100
72f1ae32a1SGerd Hoffmann #define PORT_STAT_LOW_SPEED     0x0200
73f1ae32a1SGerd Hoffmann #define PORT_STAT_HIGH_SPEED    0x0400
74f1ae32a1SGerd Hoffmann #define PORT_STAT_TEST          0x0800
75f1ae32a1SGerd Hoffmann #define PORT_STAT_INDICATOR     0x1000
76f1ae32a1SGerd Hoffmann 
77f1ae32a1SGerd Hoffmann #define PORT_STAT_C_CONNECTION  0x0001
78f1ae32a1SGerd Hoffmann #define PORT_STAT_C_ENABLE      0x0002
79f1ae32a1SGerd Hoffmann #define PORT_STAT_C_SUSPEND     0x0004
80f1ae32a1SGerd Hoffmann #define PORT_STAT_C_OVERCURRENT 0x0008
81f1ae32a1SGerd Hoffmann #define PORT_STAT_C_RESET       0x0010
82f1ae32a1SGerd Hoffmann 
83f1ae32a1SGerd Hoffmann #define PORT_CONNECTION         0
84f1ae32a1SGerd Hoffmann #define PORT_ENABLE             1
85f1ae32a1SGerd Hoffmann #define PORT_SUSPEND            2
86f1ae32a1SGerd Hoffmann #define PORT_OVERCURRENT        3
87f1ae32a1SGerd Hoffmann #define PORT_RESET              4
88f1ae32a1SGerd Hoffmann #define PORT_POWER              8
89f1ae32a1SGerd Hoffmann #define PORT_LOWSPEED           9
90f1ae32a1SGerd Hoffmann #define PORT_HIGHSPEED          10
91f1ae32a1SGerd Hoffmann #define PORT_C_CONNECTION       16
92f1ae32a1SGerd Hoffmann #define PORT_C_ENABLE           17
93f1ae32a1SGerd Hoffmann #define PORT_C_SUSPEND          18
94f1ae32a1SGerd Hoffmann #define PORT_C_OVERCURRENT      19
95f1ae32a1SGerd Hoffmann #define PORT_C_RESET            20
96f1ae32a1SGerd Hoffmann #define PORT_TEST               21
97f1ae32a1SGerd Hoffmann #define PORT_INDICATOR          22
98f1ae32a1SGerd Hoffmann 
99f1ae32a1SGerd Hoffmann /* same as Linux kernel root hubs */
100f1ae32a1SGerd Hoffmann 
101f1ae32a1SGerd Hoffmann enum {
102f1ae32a1SGerd Hoffmann     STR_MANUFACTURER = 1,
103f1ae32a1SGerd Hoffmann     STR_PRODUCT,
104*22d7aa88SGuenter Roeck     STR_PRODUCT_V2,
105f1ae32a1SGerd Hoffmann     STR_SERIALNUMBER,
106f1ae32a1SGerd Hoffmann };
107f1ae32a1SGerd Hoffmann 
108f1ae32a1SGerd Hoffmann static const USBDescStrings desc_strings = {
10993bfef4cSCrístian Viana     [STR_MANUFACTURER] = "QEMU",
110f1ae32a1SGerd Hoffmann     [STR_PRODUCT]      = "QEMU USB Hub",
111*22d7aa88SGuenter Roeck     [STR_PRODUCT_V2]   = "QEMU USB v2.0 Hub",
112f1ae32a1SGerd Hoffmann     [STR_SERIALNUMBER] = "314159",
113f1ae32a1SGerd Hoffmann };
114f1ae32a1SGerd Hoffmann 
115f1ae32a1SGerd Hoffmann static const USBDescIface desc_iface_hub = {
116f1ae32a1SGerd Hoffmann     .bInterfaceNumber              = 0,
117f1ae32a1SGerd Hoffmann     .bNumEndpoints                 = 1,
118f1ae32a1SGerd Hoffmann     .bInterfaceClass               = USB_CLASS_HUB,
119f1ae32a1SGerd Hoffmann     .eps = (USBDescEndpoint[]) {
120f1ae32a1SGerd Hoffmann         {
121f1ae32a1SGerd Hoffmann             .bEndpointAddress      = USB_DIR_IN | 0x01,
122f1ae32a1SGerd Hoffmann             .bmAttributes          = USB_ENDPOINT_XFER_INT,
1239d84bb00SGerd Hoffmann             .wMaxPacketSize        = 1 + DIV_ROUND_UP(MAX_PORTS, 8),
124f1ae32a1SGerd Hoffmann             .bInterval             = 0xff,
125f1ae32a1SGerd Hoffmann         },
126f1ae32a1SGerd Hoffmann     }
127f1ae32a1SGerd Hoffmann };
128f1ae32a1SGerd Hoffmann 
129*22d7aa88SGuenter Roeck static const USBDescIface desc_iface_hub_v2 = {
130*22d7aa88SGuenter Roeck     .bInterfaceNumber              = 0,
131*22d7aa88SGuenter Roeck     .bNumEndpoints                 = 1,
132*22d7aa88SGuenter Roeck     .bInterfaceClass               = USB_CLASS_HUB,
133*22d7aa88SGuenter Roeck     .eps = (USBDescEndpoint[]) {
134*22d7aa88SGuenter Roeck         {
135*22d7aa88SGuenter Roeck             .bEndpointAddress      = USB_DIR_IN | 0x01,
136*22d7aa88SGuenter Roeck             .bmAttributes          = USB_ENDPOINT_XFER_INT,
137*22d7aa88SGuenter Roeck             .wMaxPacketSize        = 512,
138*22d7aa88SGuenter Roeck             .bInterval             = 10,
139*22d7aa88SGuenter Roeck         },
140*22d7aa88SGuenter Roeck     }
141*22d7aa88SGuenter Roeck };
142*22d7aa88SGuenter Roeck 
143f1ae32a1SGerd Hoffmann static const USBDescDevice desc_device_hub = {
144f1ae32a1SGerd Hoffmann     .bcdUSB                        = 0x0110,
145f1ae32a1SGerd Hoffmann     .bDeviceClass                  = USB_CLASS_HUB,
146f1ae32a1SGerd Hoffmann     .bMaxPacketSize0               = 8,
147f1ae32a1SGerd Hoffmann     .bNumConfigurations            = 1,
148f1ae32a1SGerd Hoffmann     .confs = (USBDescConfig[]) {
149f1ae32a1SGerd Hoffmann         {
150f1ae32a1SGerd Hoffmann             .bNumInterfaces        = 1,
151f1ae32a1SGerd Hoffmann             .bConfigurationValue   = 1,
152bd93976aSPantelis Koukousoulas             .bmAttributes          = USB_CFG_ATT_ONE | USB_CFG_ATT_SELFPOWER |
153bd93976aSPantelis Koukousoulas                                      USB_CFG_ATT_WAKEUP,
154f1ae32a1SGerd Hoffmann             .nif = 1,
155f1ae32a1SGerd Hoffmann             .ifs = &desc_iface_hub,
156f1ae32a1SGerd Hoffmann         },
157f1ae32a1SGerd Hoffmann     },
158f1ae32a1SGerd Hoffmann };
159f1ae32a1SGerd Hoffmann 
160*22d7aa88SGuenter Roeck static const USBDescDevice desc_device_hub_v2 = {
161*22d7aa88SGuenter Roeck     .bcdUSB                        = 0x0200,
162*22d7aa88SGuenter Roeck     .bDeviceClass                  = USB_CLASS_HUB,
163*22d7aa88SGuenter Roeck     .bMaxPacketSize0               = 64,
164*22d7aa88SGuenter Roeck     .bNumConfigurations            = 1,
165*22d7aa88SGuenter Roeck     .confs = (USBDescConfig[]) {
166*22d7aa88SGuenter Roeck         {
167*22d7aa88SGuenter Roeck             .bNumInterfaces        = 1,
168*22d7aa88SGuenter Roeck             .bConfigurationValue   = 1,
169*22d7aa88SGuenter Roeck             .bmAttributes          = USB_CFG_ATT_ONE | USB_CFG_ATT_SELFPOWER |
170*22d7aa88SGuenter Roeck                                      USB_CFG_ATT_WAKEUP,
171*22d7aa88SGuenter Roeck             .nif = 1,
172*22d7aa88SGuenter Roeck             .ifs = &desc_iface_hub_v2,
173*22d7aa88SGuenter Roeck         },
174*22d7aa88SGuenter Roeck     },
175*22d7aa88SGuenter Roeck };
176*22d7aa88SGuenter Roeck 
177f1ae32a1SGerd Hoffmann static const USBDesc desc_hub = {
178f1ae32a1SGerd Hoffmann     .id = {
179f1ae32a1SGerd Hoffmann         .idVendor          = 0x0409,
180f1ae32a1SGerd Hoffmann         .idProduct         = 0x55aa,
181f1ae32a1SGerd Hoffmann         .bcdDevice         = 0x0101,
182f1ae32a1SGerd Hoffmann         .iManufacturer     = STR_MANUFACTURER,
183f1ae32a1SGerd Hoffmann         .iProduct          = STR_PRODUCT,
184f1ae32a1SGerd Hoffmann         .iSerialNumber     = STR_SERIALNUMBER,
185f1ae32a1SGerd Hoffmann     },
186f1ae32a1SGerd Hoffmann     .full = &desc_device_hub,
187f1ae32a1SGerd Hoffmann     .str  = desc_strings,
188f1ae32a1SGerd Hoffmann };
189f1ae32a1SGerd Hoffmann 
190*22d7aa88SGuenter Roeck static const USBDesc desc_hub_v2 = {
191*22d7aa88SGuenter Roeck     .id = {
192*22d7aa88SGuenter Roeck         .idVendor          = 0x0409,
193*22d7aa88SGuenter Roeck         .idProduct         = 0x55aa,
194*22d7aa88SGuenter Roeck         .bcdDevice         = 0x0201,
195*22d7aa88SGuenter Roeck         .iManufacturer     = STR_MANUFACTURER,
196*22d7aa88SGuenter Roeck         .iProduct          = STR_PRODUCT_V2,
197*22d7aa88SGuenter Roeck         .iSerialNumber     = STR_SERIALNUMBER,
198*22d7aa88SGuenter Roeck     },
199*22d7aa88SGuenter Roeck     .full = &desc_device_hub,
200*22d7aa88SGuenter Roeck     .high = &desc_device_hub_v2,
201*22d7aa88SGuenter Roeck     .str  = desc_strings,
202*22d7aa88SGuenter Roeck };
203*22d7aa88SGuenter Roeck 
204f1ae32a1SGerd Hoffmann static const uint8_t qemu_hub_hub_descriptor[] =
205f1ae32a1SGerd Hoffmann {
206f1ae32a1SGerd Hoffmann         0x00,                   /*  u8  bLength; patched in later */
207f1ae32a1SGerd Hoffmann         0x29,                   /*  u8  bDescriptorType; Hub-descriptor */
208f1ae32a1SGerd Hoffmann         0x00,                   /*  u8  bNbrPorts; (patched later) */
209f1ae32a1SGerd Hoffmann         0x0a,                   /* u16  wHubCharacteristics; */
210f1ae32a1SGerd Hoffmann         0x00,                   /*   (per-port OC, no power switching) */
211f1ae32a1SGerd Hoffmann         0x01,                   /*  u8  bPwrOn2pwrGood; 2ms */
212f1ae32a1SGerd Hoffmann         0x00                    /*  u8  bHubContrCurrent; 0 mA */
213f1ae32a1SGerd Hoffmann 
214f1ae32a1SGerd Hoffmann         /* DeviceRemovable and PortPwrCtrlMask patched in later */
215f1ae32a1SGerd Hoffmann };
216f1ae32a1SGerd Hoffmann 
usb_hub_port_change(USBHubPort * port,uint16_t status)217868a4203SGerd Hoffmann static bool usb_hub_port_change(USBHubPort *port, uint16_t status)
218868a4203SGerd Hoffmann {
219868a4203SGerd Hoffmann     bool notify = false;
220868a4203SGerd Hoffmann 
221868a4203SGerd Hoffmann     if (status & 0x1f) {
222868a4203SGerd Hoffmann         port->wPortChange |= status;
223868a4203SGerd Hoffmann         notify = true;
224868a4203SGerd Hoffmann     }
225868a4203SGerd Hoffmann     return notify;
226868a4203SGerd Hoffmann }
227868a4203SGerd Hoffmann 
usb_hub_port_set(USBHubPort * port,uint16_t status)228868a4203SGerd Hoffmann static bool usb_hub_port_set(USBHubPort *port, uint16_t status)
229868a4203SGerd Hoffmann {
230868a4203SGerd Hoffmann     if (port->wPortStatus & status) {
231868a4203SGerd Hoffmann         return false;
232868a4203SGerd Hoffmann     }
233868a4203SGerd Hoffmann     port->wPortStatus |= status;
234868a4203SGerd Hoffmann     return usb_hub_port_change(port, status);
235868a4203SGerd Hoffmann }
236868a4203SGerd Hoffmann 
usb_hub_port_clear(USBHubPort * port,uint16_t status)237868a4203SGerd Hoffmann static bool usb_hub_port_clear(USBHubPort *port, uint16_t status)
238868a4203SGerd Hoffmann {
239868a4203SGerd Hoffmann     if (!(port->wPortStatus & status)) {
240868a4203SGerd Hoffmann         return false;
241868a4203SGerd Hoffmann     }
242868a4203SGerd Hoffmann     port->wPortStatus &= ~status;
243868a4203SGerd Hoffmann     return usb_hub_port_change(port, status);
244868a4203SGerd Hoffmann }
245868a4203SGerd Hoffmann 
usb_hub_port_update(USBHubState * s,USBHubPort * port)246*22d7aa88SGuenter Roeck static bool usb_hub_port_update(USBHubState *s, USBHubPort *port)
247638ac2d8SGerd Hoffmann {
248638ac2d8SGerd Hoffmann     bool notify = false;
249638ac2d8SGerd Hoffmann 
250638ac2d8SGerd Hoffmann     if (port->port.dev && port->port.dev->attached) {
251638ac2d8SGerd Hoffmann         notify = usb_hub_port_set(port, PORT_STAT_CONNECTION);
252*22d7aa88SGuenter Roeck         if (s->usb_version == 2 && port->port.dev->speed == USB_SPEED_HIGH) {
253*22d7aa88SGuenter Roeck             usb_hub_port_clear(port, PORT_STAT_LOW_SPEED);
254*22d7aa88SGuenter Roeck             usb_hub_port_set(port, PORT_STAT_HIGH_SPEED);
255*22d7aa88SGuenter Roeck         } else if (port->port.dev->speed == USB_SPEED_LOW) {
256*22d7aa88SGuenter Roeck             usb_hub_port_clear(port, PORT_STAT_HIGH_SPEED);
257638ac2d8SGerd Hoffmann             usb_hub_port_set(port, PORT_STAT_LOW_SPEED);
258638ac2d8SGerd Hoffmann         } else {
259*22d7aa88SGuenter Roeck             usb_hub_port_clear(port, PORT_STAT_HIGH_SPEED);
260638ac2d8SGerd Hoffmann             usb_hub_port_clear(port, PORT_STAT_LOW_SPEED);
261638ac2d8SGerd Hoffmann         }
262638ac2d8SGerd Hoffmann     }
263638ac2d8SGerd Hoffmann     return notify;
264638ac2d8SGerd Hoffmann }
265638ac2d8SGerd Hoffmann 
usb_hub_port_update_timer(void * opaque)2661cc403ebSGerd Hoffmann static void usb_hub_port_update_timer(void *opaque)
2671cc403ebSGerd Hoffmann {
2681cc403ebSGerd Hoffmann     USBHubState *s = opaque;
2691cc403ebSGerd Hoffmann     bool notify = false;
2701cc403ebSGerd Hoffmann     int i;
2711cc403ebSGerd Hoffmann 
2721cc403ebSGerd Hoffmann     for (i = 0; i < s->num_ports; i++) {
273*22d7aa88SGuenter Roeck         notify |= usb_hub_port_update(s, &s->ports[i]);
2741cc403ebSGerd Hoffmann     }
2751cc403ebSGerd Hoffmann     if (notify) {
2761cc403ebSGerd Hoffmann         usb_wakeup(s->intr, 0);
2771cc403ebSGerd Hoffmann     }
2781cc403ebSGerd Hoffmann }
2791cc403ebSGerd Hoffmann 
usb_hub_attach(USBPort * port1)280f1ae32a1SGerd Hoffmann static void usb_hub_attach(USBPort *port1)
281f1ae32a1SGerd Hoffmann {
282f1ae32a1SGerd Hoffmann     USBHubState *s = port1->opaque;
283f1ae32a1SGerd Hoffmann     USBHubPort *port = &s->ports[port1->index];
284f1ae32a1SGerd Hoffmann 
285529f8f9fSGerd Hoffmann     trace_usb_hub_attach(s->dev.addr, port1->index + 1);
286*22d7aa88SGuenter Roeck     usb_hub_port_update(s, port);
2878550a02dSGerd Hoffmann     usb_wakeup(s->intr, 0);
288f1ae32a1SGerd Hoffmann }
289f1ae32a1SGerd Hoffmann 
usb_hub_detach(USBPort * port1)290f1ae32a1SGerd Hoffmann static void usb_hub_detach(USBPort *port1)
291f1ae32a1SGerd Hoffmann {
292f1ae32a1SGerd Hoffmann     USBHubState *s = port1->opaque;
293f1ae32a1SGerd Hoffmann     USBHubPort *port = &s->ports[port1->index];
294f1ae32a1SGerd Hoffmann 
295529f8f9fSGerd Hoffmann     trace_usb_hub_detach(s->dev.addr, port1->index + 1);
2968550a02dSGerd Hoffmann     usb_wakeup(s->intr, 0);
297f1ae32a1SGerd Hoffmann 
298f1ae32a1SGerd Hoffmann     /* Let upstream know the device on this port is gone */
299f1ae32a1SGerd Hoffmann     s->dev.port->ops->child_detach(s->dev.port, port1->dev);
300f1ae32a1SGerd Hoffmann 
301868a4203SGerd Hoffmann     usb_hub_port_clear(port, PORT_STAT_CONNECTION);
302868a4203SGerd Hoffmann     usb_hub_port_clear(port, PORT_STAT_ENABLE);
303868a4203SGerd Hoffmann     usb_hub_port_clear(port, PORT_STAT_SUSPEND);
3048550a02dSGerd Hoffmann     usb_wakeup(s->intr, 0);
305f1ae32a1SGerd Hoffmann }
306f1ae32a1SGerd Hoffmann 
usb_hub_child_detach(USBPort * port1,USBDevice * child)307f1ae32a1SGerd Hoffmann static void usb_hub_child_detach(USBPort *port1, USBDevice *child)
308f1ae32a1SGerd Hoffmann {
309f1ae32a1SGerd Hoffmann     USBHubState *s = port1->opaque;
310f1ae32a1SGerd Hoffmann 
311f1ae32a1SGerd Hoffmann     /* Pass along upstream */
312f1ae32a1SGerd Hoffmann     s->dev.port->ops->child_detach(s->dev.port, child);
313f1ae32a1SGerd Hoffmann }
314f1ae32a1SGerd Hoffmann 
usb_hub_wakeup(USBPort * port1)315f1ae32a1SGerd Hoffmann static void usb_hub_wakeup(USBPort *port1)
316f1ae32a1SGerd Hoffmann {
317f1ae32a1SGerd Hoffmann     USBHubState *s = port1->opaque;
318f1ae32a1SGerd Hoffmann     USBHubPort *port = &s->ports[port1->index];
319f1ae32a1SGerd Hoffmann 
320868a4203SGerd Hoffmann     if (usb_hub_port_clear(port, PORT_STAT_SUSPEND)) {
3218550a02dSGerd Hoffmann         usb_wakeup(s->intr, 0);
322f1ae32a1SGerd Hoffmann     }
323f1ae32a1SGerd Hoffmann }
324f1ae32a1SGerd Hoffmann 
usb_hub_complete(USBPort * port,USBPacket * packet)325f1ae32a1SGerd Hoffmann static void usb_hub_complete(USBPort *port, USBPacket *packet)
326f1ae32a1SGerd Hoffmann {
327f1ae32a1SGerd Hoffmann     USBHubState *s = port->opaque;
328f1ae32a1SGerd Hoffmann 
329f1ae32a1SGerd Hoffmann     /*
330f1ae32a1SGerd Hoffmann      * Just pass it along upstream for now.
331f1ae32a1SGerd Hoffmann      *
332f1ae32a1SGerd Hoffmann      * If we ever implement usb 2.0 split transactions this will
333f1ae32a1SGerd Hoffmann      * become a little more complicated ...
334f1ae32a1SGerd Hoffmann      *
335f1ae32a1SGerd Hoffmann      * Can't use usb_packet_complete() here because packet->owner is
336f1ae32a1SGerd Hoffmann      * cleared already, go call the ->complete() callback directly
337f1ae32a1SGerd Hoffmann      * instead.
338f1ae32a1SGerd Hoffmann      */
339f1ae32a1SGerd Hoffmann     s->dev.port->ops->complete(s->dev.port, packet);
340f1ae32a1SGerd Hoffmann }
341f1ae32a1SGerd Hoffmann 
usb_hub_find_device(USBDevice * dev,uint8_t addr)342f1ae32a1SGerd Hoffmann static USBDevice *usb_hub_find_device(USBDevice *dev, uint8_t addr)
343f1ae32a1SGerd Hoffmann {
344e81b13adSGonglei     USBHubState *s = USB_HUB(dev);
345f1ae32a1SGerd Hoffmann     USBHubPort *port;
346f1ae32a1SGerd Hoffmann     USBDevice *downstream;
347f1ae32a1SGerd Hoffmann     int i;
348f1ae32a1SGerd Hoffmann 
3499d84bb00SGerd Hoffmann     for (i = 0; i < s->num_ports; i++) {
350f1ae32a1SGerd Hoffmann         port = &s->ports[i];
351f1ae32a1SGerd Hoffmann         if (!(port->wPortStatus & PORT_STAT_ENABLE)) {
352f1ae32a1SGerd Hoffmann             continue;
353f1ae32a1SGerd Hoffmann         }
354f1ae32a1SGerd Hoffmann         downstream = usb_find_device(&port->port, addr);
355f1ae32a1SGerd Hoffmann         if (downstream != NULL) {
356f1ae32a1SGerd Hoffmann             return downstream;
357f1ae32a1SGerd Hoffmann         }
358f1ae32a1SGerd Hoffmann     }
359f1ae32a1SGerd Hoffmann     return NULL;
360f1ae32a1SGerd Hoffmann }
361f1ae32a1SGerd Hoffmann 
usb_hub_handle_reset(USBDevice * dev)362f1ae32a1SGerd Hoffmann static void usb_hub_handle_reset(USBDevice *dev)
363f1ae32a1SGerd Hoffmann {
364e81b13adSGonglei     USBHubState *s = USB_HUB(dev);
365f1ae32a1SGerd Hoffmann     USBHubPort *port;
366f1ae32a1SGerd Hoffmann     int i;
367f1ae32a1SGerd Hoffmann 
368529f8f9fSGerd Hoffmann     trace_usb_hub_reset(s->dev.addr);
3699d84bb00SGerd Hoffmann     for (i = 0; i < s->num_ports; i++) {
370f1ae32a1SGerd Hoffmann         port = s->ports + i;
371868a4203SGerd Hoffmann         port->wPortStatus = 0;
372f1ae32a1SGerd Hoffmann         port->wPortChange = 0;
373868a4203SGerd Hoffmann         usb_hub_port_set(port, PORT_STAT_POWER);
374*22d7aa88SGuenter Roeck         usb_hub_port_update(s, port);
375f1ae32a1SGerd Hoffmann     }
376f1ae32a1SGerd Hoffmann }
377f1ae32a1SGerd Hoffmann 
feature_name(int feature)378529f8f9fSGerd Hoffmann static const char *feature_name(int feature)
379529f8f9fSGerd Hoffmann {
380529f8f9fSGerd Hoffmann     static const char *name[] = {
381529f8f9fSGerd Hoffmann         [PORT_CONNECTION]    = "connection",
382529f8f9fSGerd Hoffmann         [PORT_ENABLE]        = "enable",
383529f8f9fSGerd Hoffmann         [PORT_SUSPEND]       = "suspend",
384529f8f9fSGerd Hoffmann         [PORT_OVERCURRENT]   = "overcurrent",
385529f8f9fSGerd Hoffmann         [PORT_RESET]         = "reset",
386529f8f9fSGerd Hoffmann         [PORT_POWER]         = "power",
387529f8f9fSGerd Hoffmann         [PORT_LOWSPEED]      = "lowspeed",
388529f8f9fSGerd Hoffmann         [PORT_HIGHSPEED]     = "highspeed",
389bdb88a8eSGerd Hoffmann         [PORT_C_CONNECTION]  = "change-connection",
390bdb88a8eSGerd Hoffmann         [PORT_C_ENABLE]      = "change-enable",
391bdb88a8eSGerd Hoffmann         [PORT_C_SUSPEND]     = "change-suspend",
392bdb88a8eSGerd Hoffmann         [PORT_C_OVERCURRENT] = "change-overcurrent",
393bdb88a8eSGerd Hoffmann         [PORT_C_RESET]       = "change-reset",
394529f8f9fSGerd Hoffmann         [PORT_TEST]          = "test",
395529f8f9fSGerd Hoffmann         [PORT_INDICATOR]     = "indicator",
396529f8f9fSGerd Hoffmann     };
397529f8f9fSGerd Hoffmann     if (feature < 0 || feature >= ARRAY_SIZE(name)) {
398529f8f9fSGerd Hoffmann         return "?";
399529f8f9fSGerd Hoffmann     }
400529f8f9fSGerd Hoffmann     return name[feature] ?: "?";
401529f8f9fSGerd Hoffmann }
402529f8f9fSGerd Hoffmann 
usb_hub_handle_control(USBDevice * dev,USBPacket * p,int request,int value,int index,int length,uint8_t * data)4039a77a0f5SHans de Goede static void usb_hub_handle_control(USBDevice *dev, USBPacket *p,
404f1ae32a1SGerd Hoffmann                int request, int value, int index, int length, uint8_t *data)
405f1ae32a1SGerd Hoffmann {
406f1ae32a1SGerd Hoffmann     USBHubState *s = (USBHubState *)dev;
407f1ae32a1SGerd Hoffmann     int ret;
408f1ae32a1SGerd Hoffmann 
409529f8f9fSGerd Hoffmann     trace_usb_hub_control(s->dev.addr, request, value, index, length);
410529f8f9fSGerd Hoffmann 
411f1ae32a1SGerd Hoffmann     ret = usb_desc_handle_control(dev, p, request, value, index, length, data);
412f1ae32a1SGerd Hoffmann     if (ret >= 0) {
4139a77a0f5SHans de Goede         return;
414f1ae32a1SGerd Hoffmann     }
415f1ae32a1SGerd Hoffmann 
416f1ae32a1SGerd Hoffmann     switch(request) {
417f1ae32a1SGerd Hoffmann     case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
418f1ae32a1SGerd Hoffmann         if (value == 0 && index != 0x81) { /* clear ep halt */
419f1ae32a1SGerd Hoffmann             goto fail;
420f1ae32a1SGerd Hoffmann         }
421f1ae32a1SGerd Hoffmann         break;
422f1ae32a1SGerd Hoffmann         /* usb specific requests */
423f1ae32a1SGerd Hoffmann     case GetHubStatus:
424f1ae32a1SGerd Hoffmann         data[0] = 0;
425f1ae32a1SGerd Hoffmann         data[1] = 0;
426f1ae32a1SGerd Hoffmann         data[2] = 0;
427f1ae32a1SGerd Hoffmann         data[3] = 0;
4289a77a0f5SHans de Goede         p->actual_length = 4;
429f1ae32a1SGerd Hoffmann         break;
430f1ae32a1SGerd Hoffmann     case GetPortStatus:
431f1ae32a1SGerd Hoffmann         {
432f1ae32a1SGerd Hoffmann             unsigned int n = index - 1;
433f1ae32a1SGerd Hoffmann             USBHubPort *port;
4349d84bb00SGerd Hoffmann             if (n >= s->num_ports) {
435f1ae32a1SGerd Hoffmann                 goto fail;
436f1ae32a1SGerd Hoffmann             }
437f1ae32a1SGerd Hoffmann             port = &s->ports[n];
438529f8f9fSGerd Hoffmann             trace_usb_hub_get_port_status(s->dev.addr, index,
439529f8f9fSGerd Hoffmann                                           port->wPortStatus,
440529f8f9fSGerd Hoffmann                                           port->wPortChange);
441f1ae32a1SGerd Hoffmann             data[0] = port->wPortStatus;
442f1ae32a1SGerd Hoffmann             data[1] = port->wPortStatus >> 8;
443f1ae32a1SGerd Hoffmann             data[2] = port->wPortChange;
444f1ae32a1SGerd Hoffmann             data[3] = port->wPortChange >> 8;
4459a77a0f5SHans de Goede             p->actual_length = 4;
446f1ae32a1SGerd Hoffmann         }
447f1ae32a1SGerd Hoffmann         break;
448f1ae32a1SGerd Hoffmann     case SetHubFeature:
449f1ae32a1SGerd Hoffmann     case ClearHubFeature:
4509a77a0f5SHans de Goede         if (value != 0 && value != 1) {
451f1ae32a1SGerd Hoffmann             goto fail;
452f1ae32a1SGerd Hoffmann         }
453f1ae32a1SGerd Hoffmann         break;
454f1ae32a1SGerd Hoffmann     case SetPortFeature:
455f1ae32a1SGerd Hoffmann         {
456f1ae32a1SGerd Hoffmann             unsigned int n = index - 1;
457f1ae32a1SGerd Hoffmann             USBHubPort *port;
458e7121b15SThomas Huth             USBDevice *pdev;
459529f8f9fSGerd Hoffmann 
460529f8f9fSGerd Hoffmann             trace_usb_hub_set_port_feature(s->dev.addr, index,
461529f8f9fSGerd Hoffmann                                            feature_name(value));
462529f8f9fSGerd Hoffmann 
4639d84bb00SGerd Hoffmann             if (n >= s->num_ports) {
464f1ae32a1SGerd Hoffmann                 goto fail;
465f1ae32a1SGerd Hoffmann             }
466f1ae32a1SGerd Hoffmann             port = &s->ports[n];
467e7121b15SThomas Huth             pdev = port->port.dev;
468f1ae32a1SGerd Hoffmann             switch(value) {
469f1ae32a1SGerd Hoffmann             case PORT_SUSPEND:
470f1ae32a1SGerd Hoffmann                 port->wPortStatus |= PORT_STAT_SUSPEND;
471f1ae32a1SGerd Hoffmann                 break;
472f1ae32a1SGerd Hoffmann             case PORT_RESET:
473868a4203SGerd Hoffmann                 usb_hub_port_set(port, PORT_STAT_RESET);
474868a4203SGerd Hoffmann                 usb_hub_port_clear(port, PORT_STAT_RESET);
475e7121b15SThomas Huth                 if (pdev && pdev->attached) {
476e7121b15SThomas Huth                     usb_device_reset(pdev);
477868a4203SGerd Hoffmann                     usb_hub_port_set(port, PORT_STAT_ENABLE);
478f1ae32a1SGerd Hoffmann                 }
479868a4203SGerd Hoffmann                 usb_wakeup(s->intr, 0);
480f1ae32a1SGerd Hoffmann                 break;
481f1ae32a1SGerd Hoffmann             case PORT_POWER:
4821cc403ebSGerd Hoffmann                 if (s->port_power) {
4831cc403ebSGerd Hoffmann                     int64_t now = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
4841cc403ebSGerd Hoffmann                     usb_hub_port_set(port, PORT_STAT_POWER);
4851cc403ebSGerd Hoffmann                     timer_mod(s->port_timer, now + 5000000); /* 5 ms */
4861cc403ebSGerd Hoffmann                 }
487f1ae32a1SGerd Hoffmann                 break;
488f1ae32a1SGerd Hoffmann             default:
489f1ae32a1SGerd Hoffmann                 goto fail;
490f1ae32a1SGerd Hoffmann             }
491f1ae32a1SGerd Hoffmann         }
492f1ae32a1SGerd Hoffmann         break;
493f1ae32a1SGerd Hoffmann     case ClearPortFeature:
494f1ae32a1SGerd Hoffmann         {
495f1ae32a1SGerd Hoffmann             unsigned int n = index - 1;
496f1ae32a1SGerd Hoffmann             USBHubPort *port;
497f1ae32a1SGerd Hoffmann 
498529f8f9fSGerd Hoffmann             trace_usb_hub_clear_port_feature(s->dev.addr, index,
499529f8f9fSGerd Hoffmann                                              feature_name(value));
500529f8f9fSGerd Hoffmann 
5019d84bb00SGerd Hoffmann             if (n >= s->num_ports) {
502f1ae32a1SGerd Hoffmann                 goto fail;
503f1ae32a1SGerd Hoffmann             }
504f1ae32a1SGerd Hoffmann             port = &s->ports[n];
505f1ae32a1SGerd Hoffmann             switch(value) {
506f1ae32a1SGerd Hoffmann             case PORT_ENABLE:
507f1ae32a1SGerd Hoffmann                 port->wPortStatus &= ~PORT_STAT_ENABLE;
508f1ae32a1SGerd Hoffmann                 break;
509f1ae32a1SGerd Hoffmann             case PORT_C_ENABLE:
510f1ae32a1SGerd Hoffmann                 port->wPortChange &= ~PORT_STAT_C_ENABLE;
511f1ae32a1SGerd Hoffmann                 break;
512f1ae32a1SGerd Hoffmann             case PORT_SUSPEND:
513868a4203SGerd Hoffmann                 usb_hub_port_clear(port, PORT_STAT_SUSPEND);
514f1ae32a1SGerd Hoffmann                 break;
515f1ae32a1SGerd Hoffmann             case PORT_C_SUSPEND:
516f1ae32a1SGerd Hoffmann                 port->wPortChange &= ~PORT_STAT_C_SUSPEND;
517f1ae32a1SGerd Hoffmann                 break;
518f1ae32a1SGerd Hoffmann             case PORT_C_CONNECTION:
519f1ae32a1SGerd Hoffmann                 port->wPortChange &= ~PORT_STAT_C_CONNECTION;
520f1ae32a1SGerd Hoffmann                 break;
521f1ae32a1SGerd Hoffmann             case PORT_C_OVERCURRENT:
522f1ae32a1SGerd Hoffmann                 port->wPortChange &= ~PORT_STAT_C_OVERCURRENT;
523f1ae32a1SGerd Hoffmann                 break;
524f1ae32a1SGerd Hoffmann             case PORT_C_RESET:
525f1ae32a1SGerd Hoffmann                 port->wPortChange &= ~PORT_STAT_C_RESET;
526f1ae32a1SGerd Hoffmann                 break;
5271cc403ebSGerd Hoffmann             case PORT_POWER:
5281cc403ebSGerd Hoffmann                 if (s->port_power) {
5291cc403ebSGerd Hoffmann                     usb_hub_port_clear(port, PORT_STAT_POWER);
5301cc403ebSGerd Hoffmann                     usb_hub_port_clear(port, PORT_STAT_CONNECTION);
5311cc403ebSGerd Hoffmann                     usb_hub_port_clear(port, PORT_STAT_ENABLE);
5321cc403ebSGerd Hoffmann                     usb_hub_port_clear(port, PORT_STAT_SUSPEND);
5331cc403ebSGerd Hoffmann                     port->wPortChange = 0;
5341cc403ebSGerd Hoffmann                 }
535b2cc6999SGuenter Roeck                 break;
536f1ae32a1SGerd Hoffmann             default:
537f1ae32a1SGerd Hoffmann                 goto fail;
538f1ae32a1SGerd Hoffmann             }
539f1ae32a1SGerd Hoffmann         }
540f1ae32a1SGerd Hoffmann         break;
541f1ae32a1SGerd Hoffmann     case GetHubDescriptor:
542f1ae32a1SGerd Hoffmann         {
543f1ae32a1SGerd Hoffmann             unsigned int n, limit, var_hub_size = 0;
544f1ae32a1SGerd Hoffmann             memcpy(data, qemu_hub_hub_descriptor,
545f1ae32a1SGerd Hoffmann                    sizeof(qemu_hub_hub_descriptor));
5469d84bb00SGerd Hoffmann             data[2] = s->num_ports;
547f1ae32a1SGerd Hoffmann 
5481cc403ebSGerd Hoffmann             if (s->port_power) {
5491cc403ebSGerd Hoffmann                 data[3] &= ~0x03;
5501cc403ebSGerd Hoffmann                 data[3] |= 0x01;
5511cc403ebSGerd Hoffmann             }
5521cc403ebSGerd Hoffmann 
553f1ae32a1SGerd Hoffmann             /* fill DeviceRemovable bits */
5549d84bb00SGerd Hoffmann             limit = DIV_ROUND_UP(s->num_ports + 1, 8) + 7;
555f1ae32a1SGerd Hoffmann             for (n = 7; n < limit; n++) {
556f1ae32a1SGerd Hoffmann                 data[n] = 0x00;
557f1ae32a1SGerd Hoffmann                 var_hub_size++;
558f1ae32a1SGerd Hoffmann             }
559f1ae32a1SGerd Hoffmann 
560f1ae32a1SGerd Hoffmann             /* fill PortPwrCtrlMask bits */
5619d84bb00SGerd Hoffmann             limit = limit + DIV_ROUND_UP(s->num_ports, 8);
562f1ae32a1SGerd Hoffmann             for (;n < limit; n++) {
563f1ae32a1SGerd Hoffmann                 data[n] = 0xff;
564f1ae32a1SGerd Hoffmann                 var_hub_size++;
565f1ae32a1SGerd Hoffmann             }
566f1ae32a1SGerd Hoffmann 
5679a77a0f5SHans de Goede             p->actual_length = sizeof(qemu_hub_hub_descriptor) + var_hub_size;
5689a77a0f5SHans de Goede             data[0] = p->actual_length;
569f1ae32a1SGerd Hoffmann             break;
570f1ae32a1SGerd Hoffmann         }
571f1ae32a1SGerd Hoffmann     default:
572f1ae32a1SGerd Hoffmann     fail:
5739a77a0f5SHans de Goede         p->status = USB_RET_STALL;
574f1ae32a1SGerd Hoffmann         break;
575f1ae32a1SGerd Hoffmann     }
576f1ae32a1SGerd Hoffmann }
577f1ae32a1SGerd Hoffmann 
usb_hub_handle_data(USBDevice * dev,USBPacket * p)5789a77a0f5SHans de Goede static void usb_hub_handle_data(USBDevice *dev, USBPacket *p)
579f1ae32a1SGerd Hoffmann {
580f1ae32a1SGerd Hoffmann     USBHubState *s = (USBHubState *)dev;
581f1ae32a1SGerd Hoffmann 
582f1ae32a1SGerd Hoffmann     switch(p->pid) {
583f1ae32a1SGerd Hoffmann     case USB_TOKEN_IN:
584f1ae32a1SGerd Hoffmann         if (p->ep->nr == 1) {
585f1ae32a1SGerd Hoffmann             USBHubPort *port;
586f1ae32a1SGerd Hoffmann             unsigned int status;
587f1ae32a1SGerd Hoffmann             uint8_t buf[4];
588f1ae32a1SGerd Hoffmann             int i, n;
5899d84bb00SGerd Hoffmann             n = DIV_ROUND_UP(s->num_ports + 1, 8);
590f1ae32a1SGerd Hoffmann             if (p->iov.size == 1) { /* FreeBSD workaround */
591f1ae32a1SGerd Hoffmann                 n = 1;
592f1ae32a1SGerd Hoffmann             } else if (n > p->iov.size) {
5939a77a0f5SHans de Goede                 p->status = USB_RET_BABBLE;
5949a77a0f5SHans de Goede                 return;
595f1ae32a1SGerd Hoffmann             }
596f1ae32a1SGerd Hoffmann             status = 0;
5979d84bb00SGerd Hoffmann             for (i = 0; i < s->num_ports; i++) {
598f1ae32a1SGerd Hoffmann                 port = &s->ports[i];
599bdebd6eeSGerd Hoffmann                 if (port->wPortChange)
600f1ae32a1SGerd Hoffmann                     status |= (1 << (i + 1));
601f1ae32a1SGerd Hoffmann             }
602f1ae32a1SGerd Hoffmann             if (status != 0) {
603b8cbc137SGerd Hoffmann                 trace_usb_hub_status_report(s->dev.addr, status);
604f1ae32a1SGerd Hoffmann                 for(i = 0; i < n; i++) {
605f1ae32a1SGerd Hoffmann                     buf[i] = status >> (8 * i);
606f1ae32a1SGerd Hoffmann                 }
607f1ae32a1SGerd Hoffmann                 usb_packet_copy(p, buf, n);
608f1ae32a1SGerd Hoffmann             } else {
6099a77a0f5SHans de Goede                 p->status = USB_RET_NAK; /* usb11 11.13.1 */
610f1ae32a1SGerd Hoffmann             }
611f1ae32a1SGerd Hoffmann         } else {
612f1ae32a1SGerd Hoffmann             goto fail;
613f1ae32a1SGerd Hoffmann         }
614f1ae32a1SGerd Hoffmann         break;
615f1ae32a1SGerd Hoffmann     case USB_TOKEN_OUT:
616f1ae32a1SGerd Hoffmann     default:
617f1ae32a1SGerd Hoffmann     fail:
6189a77a0f5SHans de Goede         p->status = USB_RET_STALL;
619f1ae32a1SGerd Hoffmann         break;
620f1ae32a1SGerd Hoffmann     }
621f1ae32a1SGerd Hoffmann }
622f1ae32a1SGerd Hoffmann 
usb_hub_unrealize(USBDevice * dev)623b69c3c21SMarkus Armbruster static void usb_hub_unrealize(USBDevice *dev)
624f1ae32a1SGerd Hoffmann {
625f1ae32a1SGerd Hoffmann     USBHubState *s = (USBHubState *)dev;
626f1ae32a1SGerd Hoffmann     int i;
627f1ae32a1SGerd Hoffmann 
6289d84bb00SGerd Hoffmann     for (i = 0; i < s->num_ports; i++) {
629f1ae32a1SGerd Hoffmann         usb_unregister_port(usb_bus_from_device(dev),
630f1ae32a1SGerd Hoffmann                             &s->ports[i].port);
631f1ae32a1SGerd Hoffmann     }
6321cc403ebSGerd Hoffmann 
6331cc403ebSGerd Hoffmann     timer_free(s->port_timer);
634f1ae32a1SGerd Hoffmann }
635f1ae32a1SGerd Hoffmann 
636f1ae32a1SGerd Hoffmann static USBPortOps usb_hub_port_ops = {
637f1ae32a1SGerd Hoffmann     .attach = usb_hub_attach,
638f1ae32a1SGerd Hoffmann     .detach = usb_hub_detach,
639f1ae32a1SGerd Hoffmann     .child_detach = usb_hub_child_detach,
640f1ae32a1SGerd Hoffmann     .wakeup = usb_hub_wakeup,
641f1ae32a1SGerd Hoffmann     .complete = usb_hub_complete,
642f1ae32a1SGerd Hoffmann };
643f1ae32a1SGerd Hoffmann 
usb_hub_realize(USBDevice * dev,Error ** errp)644f3f8c459SGonglei static void usb_hub_realize(USBDevice *dev, Error **errp)
645f1ae32a1SGerd Hoffmann {
646e81b13adSGonglei     USBHubState *s = USB_HUB(dev);
647f1ae32a1SGerd Hoffmann     USBHubPort *port;
648f1ae32a1SGerd Hoffmann     int i;
649f1ae32a1SGerd Hoffmann 
650*22d7aa88SGuenter Roeck     switch (s->usb_version) {
651*22d7aa88SGuenter Roeck     case 1:
652*22d7aa88SGuenter Roeck         dev->usb_desc = &desc_hub;
653*22d7aa88SGuenter Roeck         break;
654*22d7aa88SGuenter Roeck     case 2:
655*22d7aa88SGuenter Roeck         dev->usb_desc = &desc_hub_v2;
656*22d7aa88SGuenter Roeck         break;
657*22d7aa88SGuenter Roeck     default:
658*22d7aa88SGuenter Roeck         error_setg(errp, "Unsupported usb version %d for usb hub",
659*22d7aa88SGuenter Roeck                    s->usb_version);
660*22d7aa88SGuenter Roeck         return;
661*22d7aa88SGuenter Roeck     }
662*22d7aa88SGuenter Roeck 
6639d84bb00SGerd Hoffmann     if (s->num_ports < 1 || s->num_ports > MAX_PORTS) {
6649d84bb00SGerd Hoffmann         error_setg(errp, "num_ports (%d) out of range (1..%d)",
6659d84bb00SGerd Hoffmann                    s->num_ports, MAX_PORTS);
6669d84bb00SGerd Hoffmann         return;
6679d84bb00SGerd Hoffmann     }
6689d84bb00SGerd Hoffmann 
669c24e4aacSGerd Hoffmann     if (dev->port->hubcount == 5) {
670f3f8c459SGonglei         error_setg(errp, "usb hub chain too deep");
671f3f8c459SGonglei         return;
672c24e4aacSGerd Hoffmann     }
673c24e4aacSGerd Hoffmann 
6749d55d1adSGerd Hoffmann     usb_desc_create_serial(dev);
675f1ae32a1SGerd Hoffmann     usb_desc_init(dev);
6761cc403ebSGerd Hoffmann     s->port_timer = timer_new_ns(QEMU_CLOCK_VIRTUAL,
6771cc403ebSGerd Hoffmann                                  usb_hub_port_update_timer, s);
678f1ae32a1SGerd Hoffmann     s->intr = usb_ep_get(dev, USB_TOKEN_IN, 1);
6799d84bb00SGerd Hoffmann     for (i = 0; i < s->num_ports; i++) {
680f1ae32a1SGerd Hoffmann         port = &s->ports[i];
681f1ae32a1SGerd Hoffmann         usb_register_port(usb_bus_from_device(dev),
682f1ae32a1SGerd Hoffmann                           &port->port, s, i, &usb_hub_port_ops,
683*22d7aa88SGuenter Roeck                           USB_SPEED_MASK_LOW | USB_SPEED_MASK_FULL |
684*22d7aa88SGuenter Roeck                           ((s->usb_version == 2) ? USB_SPEED_MASK_HIGH : 0));
685f1ae32a1SGerd Hoffmann         usb_port_location(&port->port, dev->port, i+1);
686f1ae32a1SGerd Hoffmann     }
687f1ae32a1SGerd Hoffmann     usb_hub_handle_reset(dev);
688f1ae32a1SGerd Hoffmann }
689f1ae32a1SGerd Hoffmann 
690f1ae32a1SGerd Hoffmann static const VMStateDescription vmstate_usb_hub_port = {
691f1ae32a1SGerd Hoffmann     .name = "usb-hub-port",
692f1ae32a1SGerd Hoffmann     .version_id = 1,
693f1ae32a1SGerd Hoffmann     .minimum_version_id = 1,
6943abedf29SRichard Henderson     .fields = (const VMStateField[]) {
695f1ae32a1SGerd Hoffmann         VMSTATE_UINT16(wPortStatus, USBHubPort),
696f1ae32a1SGerd Hoffmann         VMSTATE_UINT16(wPortChange, USBHubPort),
697f1ae32a1SGerd Hoffmann         VMSTATE_END_OF_LIST()
698f1ae32a1SGerd Hoffmann     }
699f1ae32a1SGerd Hoffmann };
700f1ae32a1SGerd Hoffmann 
usb_hub_port_timer_needed(void * opaque)7011cc403ebSGerd Hoffmann static bool usb_hub_port_timer_needed(void *opaque)
7021cc403ebSGerd Hoffmann {
7031cc403ebSGerd Hoffmann     USBHubState *s = opaque;
7041cc403ebSGerd Hoffmann 
7051cc403ebSGerd Hoffmann     return s->port_power;
7061cc403ebSGerd Hoffmann }
7071cc403ebSGerd Hoffmann 
7081cc403ebSGerd Hoffmann static const VMStateDescription vmstate_usb_hub_port_timer = {
7091cc403ebSGerd Hoffmann     .name = "usb-hub/port-timer",
7101cc403ebSGerd Hoffmann     .version_id = 1,
7111cc403ebSGerd Hoffmann     .minimum_version_id = 1,
7121cc403ebSGerd Hoffmann     .needed = usb_hub_port_timer_needed,
7133abedf29SRichard Henderson     .fields = (const VMStateField[]) {
7141cc403ebSGerd Hoffmann         VMSTATE_TIMER_PTR(port_timer, USBHubState),
7151cc403ebSGerd Hoffmann         VMSTATE_END_OF_LIST()
7161cc403ebSGerd Hoffmann     },
7171cc403ebSGerd Hoffmann };
7181cc403ebSGerd Hoffmann 
719f1ae32a1SGerd Hoffmann static const VMStateDescription vmstate_usb_hub = {
720f1ae32a1SGerd Hoffmann     .name = "usb-hub",
721*22d7aa88SGuenter Roeck     .version_id = 2,
722f1ae32a1SGerd Hoffmann     .minimum_version_id = 1,
7233abedf29SRichard Henderson     .fields = (const VMStateField[]) {
724f1ae32a1SGerd Hoffmann         VMSTATE_USB_DEVICE(dev, USBHubState),
7259d84bb00SGerd Hoffmann         VMSTATE_STRUCT_ARRAY(ports, USBHubState, MAX_PORTS, 0,
726f1ae32a1SGerd Hoffmann                              vmstate_usb_hub_port, USBHubPort),
727f1ae32a1SGerd Hoffmann         VMSTATE_END_OF_LIST()
7281cc403ebSGerd Hoffmann     },
7293abedf29SRichard Henderson     .subsections = (const VMStateDescription * const []) {
7301cc403ebSGerd Hoffmann         &vmstate_usb_hub_port_timer,
7311cc403ebSGerd Hoffmann         NULL
732f1ae32a1SGerd Hoffmann     }
733f1ae32a1SGerd Hoffmann };
734f1ae32a1SGerd Hoffmann 
7359d84bb00SGerd Hoffmann static Property usb_hub_properties[] = {
7369d84bb00SGerd Hoffmann     DEFINE_PROP_UINT32("ports", USBHubState, num_ports, 8),
7371cc403ebSGerd Hoffmann     DEFINE_PROP_BOOL("port-power", USBHubState, port_power, false),
738*22d7aa88SGuenter Roeck     DEFINE_PROP_UINT32("usb_version", USBHubState, usb_version, 1),
7399d84bb00SGerd Hoffmann     DEFINE_PROP_END_OF_LIST(),
7409d84bb00SGerd Hoffmann };
7419d84bb00SGerd Hoffmann 
usb_hub_class_initfn(ObjectClass * klass,void * data)742f1ae32a1SGerd Hoffmann static void usb_hub_class_initfn(ObjectClass *klass, void *data)
743f1ae32a1SGerd Hoffmann {
744f1ae32a1SGerd Hoffmann     DeviceClass *dc = DEVICE_CLASS(klass);
745f1ae32a1SGerd Hoffmann     USBDeviceClass *uc = USB_DEVICE_CLASS(klass);
746f1ae32a1SGerd Hoffmann 
747f3f8c459SGonglei     uc->realize        = usb_hub_realize;
748f1ae32a1SGerd Hoffmann     uc->product_desc   = "QEMU USB Hub";
749f1ae32a1SGerd Hoffmann     uc->find_device    = usb_hub_find_device;
750f1ae32a1SGerd Hoffmann     uc->handle_reset   = usb_hub_handle_reset;
751f1ae32a1SGerd Hoffmann     uc->handle_control = usb_hub_handle_control;
752f1ae32a1SGerd Hoffmann     uc->handle_data    = usb_hub_handle_data;
753c4fe9700SMarc-André Lureau     uc->unrealize      = usb_hub_unrealize;
754*22d7aa88SGuenter Roeck     uc->handle_attach  = usb_desc_attach;
755125ee0edSMarcel Apfelbaum     set_bit(DEVICE_CATEGORY_BRIDGE, dc->categories);
756f1ae32a1SGerd Hoffmann     dc->fw_name = "hub";
757f1ae32a1SGerd Hoffmann     dc->vmsd = &vmstate_usb_hub;
7584f67d30bSMarc-André Lureau     device_class_set_props(dc, usb_hub_properties);
759f1ae32a1SGerd Hoffmann }
760f1ae32a1SGerd Hoffmann 
7618c43a6f0SAndreas Färber static const TypeInfo hub_info = {
762e81b13adSGonglei     .name          = TYPE_USB_HUB,
763f1ae32a1SGerd Hoffmann     .parent        = TYPE_USB_DEVICE,
764f1ae32a1SGerd Hoffmann     .instance_size = sizeof(USBHubState),
765f1ae32a1SGerd Hoffmann     .class_init    = usb_hub_class_initfn,
766f1ae32a1SGerd Hoffmann };
767f1ae32a1SGerd Hoffmann 
usb_hub_register_types(void)768f1ae32a1SGerd Hoffmann static void usb_hub_register_types(void)
769f1ae32a1SGerd Hoffmann {
770f1ae32a1SGerd Hoffmann     type_register_static(&hub_info);
771f1ae32a1SGerd Hoffmann }
772f1ae32a1SGerd Hoffmann 
773f1ae32a1SGerd Hoffmann type_init(usb_hub_register_types)
774