xref: /openbmc/qemu/hw/usb/hcd-ehci-pci.c (revision dc5bd18f)
1 /*
2  * QEMU USB EHCI Emulation
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or(at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, see <http://www.gnu.org/licenses/>.
16  */
17 
18 #include "qemu/osdep.h"
19 #include "hw/usb/hcd-ehci.h"
20 #include "qemu/range.h"
21 
22 typedef struct EHCIPCIInfo {
23     const char *name;
24     uint16_t vendor_id;
25     uint16_t device_id;
26     uint8_t  revision;
27     bool companion;
28 } EHCIPCIInfo;
29 
30 static void usb_ehci_pci_realize(PCIDevice *dev, Error **errp)
31 {
32     EHCIPCIState *i = PCI_EHCI(dev);
33     EHCIState *s = &i->ehci;
34     uint8_t *pci_conf = dev->config;
35 
36     pci_set_byte(&pci_conf[PCI_CLASS_PROG], 0x20);
37 
38     /* capabilities pointer */
39     pci_set_byte(&pci_conf[PCI_CAPABILITY_LIST], 0x00);
40     /* pci_set_byte(&pci_conf[PCI_CAPABILITY_LIST], 0x50); */
41 
42     pci_set_byte(&pci_conf[PCI_INTERRUPT_PIN], 4); /* interrupt pin D */
43     pci_set_byte(&pci_conf[PCI_MIN_GNT], 0);
44     pci_set_byte(&pci_conf[PCI_MAX_LAT], 0);
45 
46     /* pci_conf[0x50] = 0x01; *//* power management caps */
47 
48     pci_set_byte(&pci_conf[USB_SBRN], USB_RELEASE_2); /* release # (2.1.4) */
49     pci_set_byte(&pci_conf[0x61], 0x20);  /* frame length adjustment (2.1.5) */
50     pci_set_word(&pci_conf[0x62], 0x00);  /* port wake up capability (2.1.6) */
51 
52     pci_conf[0x64] = 0x00;
53     pci_conf[0x65] = 0x00;
54     pci_conf[0x66] = 0x00;
55     pci_conf[0x67] = 0x00;
56     pci_conf[0x68] = 0x01;
57     pci_conf[0x69] = 0x00;
58     pci_conf[0x6a] = 0x00;
59     pci_conf[0x6b] = 0x00;  /* USBLEGSUP */
60     pci_conf[0x6c] = 0x00;
61     pci_conf[0x6d] = 0x00;
62     pci_conf[0x6e] = 0x00;
63     pci_conf[0x6f] = 0xc0;  /* USBLEFCTLSTS */
64 
65     s->irq = pci_allocate_irq(dev);
66     s->as = pci_get_address_space(dev);
67 
68     usb_ehci_realize(s, DEVICE(dev), NULL);
69     pci_register_bar(dev, 0, PCI_BASE_ADDRESS_SPACE_MEMORY, &s->mem);
70 }
71 
72 static void usb_ehci_pci_init(Object *obj)
73 {
74     DeviceClass *dc = OBJECT_GET_CLASS(DeviceClass, obj, TYPE_DEVICE);
75     EHCIPCIState *i = PCI_EHCI(obj);
76     EHCIState *s = &i->ehci;
77 
78     s->caps[0x09] = 0x68;        /* EECP */
79 
80     s->capsbase = 0x00;
81     s->opregbase = 0x20;
82     s->portscbase = 0x44;
83     s->portnr = NB_PORTS;
84 
85     if (!dc->hotpluggable) {
86         s->companion_enable = true;
87     }
88 
89     usb_ehci_init(s, DEVICE(obj));
90 }
91 
92 static void usb_ehci_pci_finalize(Object *obj)
93 {
94     EHCIPCIState *i = PCI_EHCI(obj);
95     EHCIState *s = &i->ehci;
96 
97     usb_ehci_finalize(s);
98 }
99 
100 static void usb_ehci_pci_exit(PCIDevice *dev)
101 {
102     EHCIPCIState *i = PCI_EHCI(dev);
103     EHCIState *s = &i->ehci;
104 
105     usb_ehci_unrealize(s, DEVICE(dev), NULL);
106 
107     g_free(s->irq);
108     s->irq = NULL;
109 }
110 
111 static void usb_ehci_pci_reset(DeviceState *dev)
112 {
113     PCIDevice *pci_dev = PCI_DEVICE(dev);
114     EHCIPCIState *i = PCI_EHCI(pci_dev);
115     EHCIState *s = &i->ehci;
116 
117     ehci_reset(s);
118 }
119 
120 static void usb_ehci_pci_write_config(PCIDevice *dev, uint32_t addr,
121                                       uint32_t val, int l)
122 {
123     EHCIPCIState *i = PCI_EHCI(dev);
124     bool busmaster;
125 
126     pci_default_write_config(dev, addr, val, l);
127 
128     if (!range_covers_byte(addr, l, PCI_COMMAND)) {
129         return;
130     }
131     busmaster = pci_get_word(dev->config + PCI_COMMAND) & PCI_COMMAND_MASTER;
132     i->ehci.as = busmaster ? pci_get_address_space(dev) : &address_space_memory;
133 }
134 
135 static Property ehci_pci_properties[] = {
136     DEFINE_PROP_UINT32("maxframes", EHCIPCIState, ehci.maxframes, 128),
137     DEFINE_PROP_END_OF_LIST(),
138 };
139 
140 static const VMStateDescription vmstate_ehci_pci = {
141     .name        = "ehci",
142     .version_id  = 2,
143     .minimum_version_id  = 1,
144     .fields = (VMStateField[]) {
145         VMSTATE_PCI_DEVICE(pcidev, EHCIPCIState),
146         VMSTATE_STRUCT(ehci, EHCIPCIState, 2, vmstate_ehci, EHCIState),
147         VMSTATE_END_OF_LIST()
148     }
149 };
150 
151 static void ehci_class_init(ObjectClass *klass, void *data)
152 {
153     DeviceClass *dc = DEVICE_CLASS(klass);
154     PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
155 
156     k->realize = usb_ehci_pci_realize;
157     k->exit = usb_ehci_pci_exit;
158     k->class_id = PCI_CLASS_SERIAL_USB;
159     k->config_write = usb_ehci_pci_write_config;
160     dc->vmsd = &vmstate_ehci_pci;
161     dc->props = ehci_pci_properties;
162     dc->reset = usb_ehci_pci_reset;
163 }
164 
165 static const TypeInfo ehci_pci_type_info = {
166     .name = TYPE_PCI_EHCI,
167     .parent = TYPE_PCI_DEVICE,
168     .instance_size = sizeof(EHCIPCIState),
169     .instance_init = usb_ehci_pci_init,
170     .instance_finalize = usb_ehci_pci_finalize,
171     .abstract = true,
172     .class_init = ehci_class_init,
173     .interfaces = (InterfaceInfo[]) {
174         { INTERFACE_CONVENTIONAL_PCI_DEVICE },
175         { },
176     },
177 };
178 
179 static void ehci_data_class_init(ObjectClass *klass, void *data)
180 {
181     PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
182     DeviceClass *dc = DEVICE_CLASS(klass);
183     EHCIPCIInfo *i = data;
184 
185     k->vendor_id = i->vendor_id;
186     k->device_id = i->device_id;
187     k->revision = i->revision;
188     set_bit(DEVICE_CATEGORY_USB, dc->categories);
189     if (i->companion) {
190         dc->hotpluggable = false;
191     }
192 }
193 
194 static struct EHCIPCIInfo ehci_pci_info[] = {
195     {
196         .name      = "usb-ehci",
197         .vendor_id = PCI_VENDOR_ID_INTEL,
198         .device_id = PCI_DEVICE_ID_INTEL_82801D, /* ich4 */
199         .revision  = 0x10,
200     },{
201         .name      = "ich9-usb-ehci1", /* 00:1d.7 */
202         .vendor_id = PCI_VENDOR_ID_INTEL,
203         .device_id = PCI_DEVICE_ID_INTEL_82801I_EHCI1,
204         .revision  = 0x03,
205         .companion = true,
206     },{
207         .name      = "ich9-usb-ehci2", /* 00:1a.7 */
208         .vendor_id = PCI_VENDOR_ID_INTEL,
209         .device_id = PCI_DEVICE_ID_INTEL_82801I_EHCI2,
210         .revision  = 0x03,
211         .companion = true,
212     }
213 };
214 
215 static void ehci_pci_register_types(void)
216 {
217     TypeInfo ehci_type_info = {
218         .parent        = TYPE_PCI_EHCI,
219         .class_init    = ehci_data_class_init,
220     };
221     int i;
222 
223     type_register_static(&ehci_pci_type_info);
224 
225     for (i = 0; i < ARRAY_SIZE(ehci_pci_info); i++) {
226         ehci_type_info.name = ehci_pci_info[i].name;
227         ehci_type_info.class_data = ehci_pci_info + i;
228         type_register(&ehci_type_info);
229     }
230 }
231 
232 type_init(ehci_pci_register_types)
233 
234 struct ehci_companions {
235     const char *name;
236     int func;
237     int port;
238 };
239 
240 static const struct ehci_companions ich9_1d[] = {
241     { .name = "ich9-usb-uhci1", .func = 0, .port = 0 },
242     { .name = "ich9-usb-uhci2", .func = 1, .port = 2 },
243     { .name = "ich9-usb-uhci3", .func = 2, .port = 4 },
244 };
245 
246 static const struct ehci_companions ich9_1a[] = {
247     { .name = "ich9-usb-uhci4", .func = 0, .port = 0 },
248     { .name = "ich9-usb-uhci5", .func = 1, .port = 2 },
249     { .name = "ich9-usb-uhci6", .func = 2, .port = 4 },
250 };
251 
252 int ehci_create_ich9_with_companions(PCIBus *bus, int slot)
253 {
254     const struct ehci_companions *comp;
255     PCIDevice *ehci, *uhci;
256     BusState *usbbus;
257     const char *name;
258     int i;
259 
260     switch (slot) {
261     case 0x1d:
262         name = "ich9-usb-ehci1";
263         comp = ich9_1d;
264         break;
265     case 0x1a:
266         name = "ich9-usb-ehci2";
267         comp = ich9_1a;
268         break;
269     default:
270         return -1;
271     }
272 
273     ehci = pci_create_multifunction(bus, PCI_DEVFN(slot, 7), true, name);
274     qdev_init_nofail(&ehci->qdev);
275     usbbus = QLIST_FIRST(&ehci->qdev.child_bus);
276 
277     for (i = 0; i < 3; i++) {
278         uhci = pci_create_multifunction(bus, PCI_DEVFN(slot, comp[i].func),
279                                         true, comp[i].name);
280         qdev_prop_set_string(&uhci->qdev, "masterbus", usbbus->name);
281         qdev_prop_set_uint32(&uhci->qdev, "firstport", comp[i].port);
282         qdev_init_nofail(&uhci->qdev);
283     }
284     return 0;
285 }
286