exec: Only count mapped memory backends for qemu_getrampagesize()
[qemu/ar7.git] / hw / usb / hcd-ohci.c
blob81cf5ab7a5a76c12aef357107fd084abe99c6989
1 /*
2 * QEMU USB OHCI Emulation
3 * Copyright (c) 2004 Gianni Tedesco
4 * Copyright (c) 2006 CodeSourcery
5 * Copyright (c) 2006 Openedhand Ltd.
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
20 * TODO:
21 * o Isochronous transfers
22 * o Allocate bandwidth in frames properly
23 * o Disable timers when nothing needs to be done, or remove timer usage
24 * all together.
25 * o BIOS work to boot from USB storage
28 #include "qemu/osdep.h"
29 #include "hw/hw.h"
30 #include "qapi/error.h"
31 #include "qemu/timer.h"
32 #include "hw/usb.h"
33 #include "hw/pci/pci.h"
34 #include "hw/sysbus.h"
35 #include "hw/qdev-dma.h"
36 #include "trace.h"
38 /* This causes frames to occur 1000x slower */
39 //#define OHCI_TIME_WARP 1
41 /* Number of Downstream Ports on the root hub. */
43 #define OHCI_MAX_PORTS 15
45 #define ED_LINK_LIMIT 32
47 static int64_t usb_frame_time;
48 static int64_t usb_bit_time;
50 typedef struct OHCIPort {
51 USBPort port;
52 uint32_t ctrl;
53 } OHCIPort;
55 typedef struct {
56 USBBus bus;
57 qemu_irq irq;
58 MemoryRegion mem;
59 AddressSpace *as;
60 uint32_t num_ports;
61 const char *name;
63 QEMUTimer *eof_timer;
64 int64_t sof_time;
66 /* OHCI state */
67 /* Control partition */
68 uint32_t ctl, status;
69 uint32_t intr_status;
70 uint32_t intr;
72 /* memory pointer partition */
73 uint32_t hcca;
74 uint32_t ctrl_head, ctrl_cur;
75 uint32_t bulk_head, bulk_cur;
76 uint32_t per_cur;
77 uint32_t done;
78 int32_t done_count;
80 /* Frame counter partition */
81 uint16_t fsmps;
82 uint8_t fit;
83 uint16_t fi;
84 uint8_t frt;
85 uint16_t frame_number;
86 uint16_t padding;
87 uint32_t pstart;
88 uint32_t lst;
90 /* Root Hub partition */
91 uint32_t rhdesc_a, rhdesc_b;
92 uint32_t rhstatus;
93 OHCIPort rhport[OHCI_MAX_PORTS];
95 /* PXA27x Non-OHCI events */
96 uint32_t hstatus;
97 uint32_t hmask;
98 uint32_t hreset;
99 uint32_t htest;
101 /* SM501 local memory offset */
102 dma_addr_t localmem_base;
104 /* Active packets. */
105 uint32_t old_ctl;
106 USBPacket usb_packet;
107 uint8_t usb_buf[8192];
108 uint32_t async_td;
109 bool async_complete;
111 } OHCIState;
113 /* Host Controller Communications Area */
114 struct ohci_hcca {
115 uint32_t intr[32];
116 uint16_t frame, pad;
117 uint32_t done;
119 #define HCCA_WRITEBACK_OFFSET offsetof(struct ohci_hcca, frame)
120 #define HCCA_WRITEBACK_SIZE 8 /* frame, pad, done */
122 #define ED_WBACK_OFFSET offsetof(struct ohci_ed, head)
123 #define ED_WBACK_SIZE 4
125 static void ohci_bus_stop(OHCIState *ohci);
126 static void ohci_async_cancel_device(OHCIState *ohci, USBDevice *dev);
128 /* Bitfields for the first word of an Endpoint Desciptor. */
129 #define OHCI_ED_FA_SHIFT 0
130 #define OHCI_ED_FA_MASK (0x7f<<OHCI_ED_FA_SHIFT)
131 #define OHCI_ED_EN_SHIFT 7
132 #define OHCI_ED_EN_MASK (0xf<<OHCI_ED_EN_SHIFT)
133 #define OHCI_ED_D_SHIFT 11
134 #define OHCI_ED_D_MASK (3<<OHCI_ED_D_SHIFT)
135 #define OHCI_ED_S (1<<13)
136 #define OHCI_ED_K (1<<14)
137 #define OHCI_ED_F (1<<15)
138 #define OHCI_ED_MPS_SHIFT 16
139 #define OHCI_ED_MPS_MASK (0x7ff<<OHCI_ED_MPS_SHIFT)
141 /* Flags in the head field of an Endpoint Desciptor. */
142 #define OHCI_ED_H 1
143 #define OHCI_ED_C 2
145 /* Bitfields for the first word of a Transfer Desciptor. */
146 #define OHCI_TD_R (1<<18)
147 #define OHCI_TD_DP_SHIFT 19
148 #define OHCI_TD_DP_MASK (3<<OHCI_TD_DP_SHIFT)
149 #define OHCI_TD_DI_SHIFT 21
150 #define OHCI_TD_DI_MASK (7<<OHCI_TD_DI_SHIFT)
151 #define OHCI_TD_T0 (1<<24)
152 #define OHCI_TD_T1 (1<<25)
153 #define OHCI_TD_EC_SHIFT 26
154 #define OHCI_TD_EC_MASK (3<<OHCI_TD_EC_SHIFT)
155 #define OHCI_TD_CC_SHIFT 28
156 #define OHCI_TD_CC_MASK (0xf<<OHCI_TD_CC_SHIFT)
158 /* Bitfields for the first word of an Isochronous Transfer Desciptor. */
159 /* CC & DI - same as in the General Transfer Desciptor */
160 #define OHCI_TD_SF_SHIFT 0
161 #define OHCI_TD_SF_MASK (0xffff<<OHCI_TD_SF_SHIFT)
162 #define OHCI_TD_FC_SHIFT 24
163 #define OHCI_TD_FC_MASK (7<<OHCI_TD_FC_SHIFT)
165 /* Isochronous Transfer Desciptor - Offset / PacketStatusWord */
166 #define OHCI_TD_PSW_CC_SHIFT 12
167 #define OHCI_TD_PSW_CC_MASK (0xf<<OHCI_TD_PSW_CC_SHIFT)
168 #define OHCI_TD_PSW_SIZE_SHIFT 0
169 #define OHCI_TD_PSW_SIZE_MASK (0xfff<<OHCI_TD_PSW_SIZE_SHIFT)
171 #define OHCI_PAGE_MASK 0xfffff000
172 #define OHCI_OFFSET_MASK 0xfff
174 #define OHCI_DPTR_MASK 0xfffffff0
176 #define OHCI_BM(val, field) \
177 (((val) & OHCI_##field##_MASK) >> OHCI_##field##_SHIFT)
179 #define OHCI_SET_BM(val, field, newval) do { \
180 val &= ~OHCI_##field##_MASK; \
181 val |= ((newval) << OHCI_##field##_SHIFT) & OHCI_##field##_MASK; \
182 } while(0)
184 /* endpoint descriptor */
185 struct ohci_ed {
186 uint32_t flags;
187 uint32_t tail;
188 uint32_t head;
189 uint32_t next;
192 /* General transfer descriptor */
193 struct ohci_td {
194 uint32_t flags;
195 uint32_t cbp;
196 uint32_t next;
197 uint32_t be;
200 /* Isochronous transfer descriptor */
201 struct ohci_iso_td {
202 uint32_t flags;
203 uint32_t bp;
204 uint32_t next;
205 uint32_t be;
206 uint16_t offset[8];
209 #define USB_HZ 12000000
211 /* OHCI Local stuff */
212 #define OHCI_CTL_CBSR ((1<<0)|(1<<1))
213 #define OHCI_CTL_PLE (1<<2)
214 #define OHCI_CTL_IE (1<<3)
215 #define OHCI_CTL_CLE (1<<4)
216 #define OHCI_CTL_BLE (1<<5)
217 #define OHCI_CTL_HCFS ((1<<6)|(1<<7))
218 #define OHCI_USB_RESET 0x00
219 #define OHCI_USB_RESUME 0x40
220 #define OHCI_USB_OPERATIONAL 0x80
221 #define OHCI_USB_SUSPEND 0xc0
222 #define OHCI_CTL_IR (1<<8)
223 #define OHCI_CTL_RWC (1<<9)
224 #define OHCI_CTL_RWE (1<<10)
226 #define OHCI_STATUS_HCR (1<<0)
227 #define OHCI_STATUS_CLF (1<<1)
228 #define OHCI_STATUS_BLF (1<<2)
229 #define OHCI_STATUS_OCR (1<<3)
230 #define OHCI_STATUS_SOC ((1<<6)|(1<<7))
232 #define OHCI_INTR_SO (1U<<0) /* Scheduling overrun */
233 #define OHCI_INTR_WD (1U<<1) /* HcDoneHead writeback */
234 #define OHCI_INTR_SF (1U<<2) /* Start of frame */
235 #define OHCI_INTR_RD (1U<<3) /* Resume detect */
236 #define OHCI_INTR_UE (1U<<4) /* Unrecoverable error */
237 #define OHCI_INTR_FNO (1U<<5) /* Frame number overflow */
238 #define OHCI_INTR_RHSC (1U<<6) /* Root hub status change */
239 #define OHCI_INTR_OC (1U<<30) /* Ownership change */
240 #define OHCI_INTR_MIE (1U<<31) /* Master Interrupt Enable */
242 #define OHCI_HCCA_SIZE 0x100
243 #define OHCI_HCCA_MASK 0xffffff00
245 #define OHCI_EDPTR_MASK 0xfffffff0
247 #define OHCI_FMI_FI 0x00003fff
248 #define OHCI_FMI_FSMPS 0xffff0000
249 #define OHCI_FMI_FIT 0x80000000
251 #define OHCI_FR_RT (1U<<31)
253 #define OHCI_LS_THRESH 0x628
255 #define OHCI_RHA_RW_MASK 0x00000000 /* Mask of supported features. */
256 #define OHCI_RHA_PSM (1<<8)
257 #define OHCI_RHA_NPS (1<<9)
258 #define OHCI_RHA_DT (1<<10)
259 #define OHCI_RHA_OCPM (1<<11)
260 #define OHCI_RHA_NOCP (1<<12)
261 #define OHCI_RHA_POTPGT_MASK 0xff000000
263 #define OHCI_RHS_LPS (1U<<0)
264 #define OHCI_RHS_OCI (1U<<1)
265 #define OHCI_RHS_DRWE (1U<<15)
266 #define OHCI_RHS_LPSC (1U<<16)
267 #define OHCI_RHS_OCIC (1U<<17)
268 #define OHCI_RHS_CRWE (1U<<31)
270 #define OHCI_PORT_CCS (1<<0)
271 #define OHCI_PORT_PES (1<<1)
272 #define OHCI_PORT_PSS (1<<2)
273 #define OHCI_PORT_POCI (1<<3)
274 #define OHCI_PORT_PRS (1<<4)
275 #define OHCI_PORT_PPS (1<<8)
276 #define OHCI_PORT_LSDA (1<<9)
277 #define OHCI_PORT_CSC (1<<16)
278 #define OHCI_PORT_PESC (1<<17)
279 #define OHCI_PORT_PSSC (1<<18)
280 #define OHCI_PORT_OCIC (1<<19)
281 #define OHCI_PORT_PRSC (1<<20)
282 #define OHCI_PORT_WTC (OHCI_PORT_CSC|OHCI_PORT_PESC|OHCI_PORT_PSSC \
283 |OHCI_PORT_OCIC|OHCI_PORT_PRSC)
285 #define OHCI_TD_DIR_SETUP 0x0
286 #define OHCI_TD_DIR_OUT 0x1
287 #define OHCI_TD_DIR_IN 0x2
288 #define OHCI_TD_DIR_RESERVED 0x3
290 #define OHCI_CC_NOERROR 0x0
291 #define OHCI_CC_CRC 0x1
292 #define OHCI_CC_BITSTUFFING 0x2
293 #define OHCI_CC_DATATOGGLEMISMATCH 0x3
294 #define OHCI_CC_STALL 0x4
295 #define OHCI_CC_DEVICENOTRESPONDING 0x5
296 #define OHCI_CC_PIDCHECKFAILURE 0x6
297 #define OHCI_CC_UNDEXPETEDPID 0x7
298 #define OHCI_CC_DATAOVERRUN 0x8
299 #define OHCI_CC_DATAUNDERRUN 0x9
300 #define OHCI_CC_BUFFEROVERRUN 0xc
301 #define OHCI_CC_BUFFERUNDERRUN 0xd
303 #define OHCI_HRESET_FSBIR (1 << 0)
305 static void ohci_die(OHCIState *ohci);
307 /* Update IRQ levels */
308 static inline void ohci_intr_update(OHCIState *ohci)
310 int level = 0;
312 if ((ohci->intr & OHCI_INTR_MIE) &&
313 (ohci->intr_status & ohci->intr))
314 level = 1;
316 qemu_set_irq(ohci->irq, level);
319 /* Set an interrupt */
320 static inline void ohci_set_interrupt(OHCIState *ohci, uint32_t intr)
322 ohci->intr_status |= intr;
323 ohci_intr_update(ohci);
326 /* Attach or detach a device on a root hub port. */
327 static void ohci_attach(USBPort *port1)
329 OHCIState *s = port1->opaque;
330 OHCIPort *port = &s->rhport[port1->index];
331 uint32_t old_state = port->ctrl;
333 /* set connect status */
334 port->ctrl |= OHCI_PORT_CCS | OHCI_PORT_CSC;
336 /* update speed */
337 if (port->port.dev->speed == USB_SPEED_LOW) {
338 port->ctrl |= OHCI_PORT_LSDA;
339 } else {
340 port->ctrl &= ~OHCI_PORT_LSDA;
343 /* notify of remote-wakeup */
344 if ((s->ctl & OHCI_CTL_HCFS) == OHCI_USB_SUSPEND) {
345 ohci_set_interrupt(s, OHCI_INTR_RD);
348 trace_usb_ohci_port_attach(port1->index);
350 if (old_state != port->ctrl) {
351 ohci_set_interrupt(s, OHCI_INTR_RHSC);
355 static void ohci_detach(USBPort *port1)
357 OHCIState *s = port1->opaque;
358 OHCIPort *port = &s->rhport[port1->index];
359 uint32_t old_state = port->ctrl;
361 ohci_async_cancel_device(s, port1->dev);
363 /* set connect status */
364 if (port->ctrl & OHCI_PORT_CCS) {
365 port->ctrl &= ~OHCI_PORT_CCS;
366 port->ctrl |= OHCI_PORT_CSC;
368 /* disable port */
369 if (port->ctrl & OHCI_PORT_PES) {
370 port->ctrl &= ~OHCI_PORT_PES;
371 port->ctrl |= OHCI_PORT_PESC;
373 trace_usb_ohci_port_detach(port1->index);
375 if (old_state != port->ctrl) {
376 ohci_set_interrupt(s, OHCI_INTR_RHSC);
380 static void ohci_wakeup(USBPort *port1)
382 OHCIState *s = port1->opaque;
383 OHCIPort *port = &s->rhport[port1->index];
384 uint32_t intr = 0;
385 if (port->ctrl & OHCI_PORT_PSS) {
386 trace_usb_ohci_port_wakeup(port1->index);
387 port->ctrl |= OHCI_PORT_PSSC;
388 port->ctrl &= ~OHCI_PORT_PSS;
389 intr = OHCI_INTR_RHSC;
391 /* Note that the controller can be suspended even if this port is not */
392 if ((s->ctl & OHCI_CTL_HCFS) == OHCI_USB_SUSPEND) {
393 trace_usb_ohci_remote_wakeup(s->name);
394 /* This is the one state transition the controller can do by itself */
395 s->ctl &= ~OHCI_CTL_HCFS;
396 s->ctl |= OHCI_USB_RESUME;
397 /* In suspend mode only ResumeDetected is possible, not RHSC:
398 * see the OHCI spec 5.1.2.3.
400 intr = OHCI_INTR_RD;
402 ohci_set_interrupt(s, intr);
405 static void ohci_child_detach(USBPort *port1, USBDevice *child)
407 OHCIState *s = port1->opaque;
409 ohci_async_cancel_device(s, child);
412 static USBDevice *ohci_find_device(OHCIState *ohci, uint8_t addr)
414 USBDevice *dev;
415 int i;
417 for (i = 0; i < ohci->num_ports; i++) {
418 if ((ohci->rhport[i].ctrl & OHCI_PORT_PES) == 0) {
419 continue;
421 dev = usb_find_device(&ohci->rhport[i].port, addr);
422 if (dev != NULL) {
423 return dev;
426 return NULL;
429 static void ohci_stop_endpoints(OHCIState *ohci)
431 USBDevice *dev;
432 int i, j;
434 for (i = 0; i < ohci->num_ports; i++) {
435 dev = ohci->rhport[i].port.dev;
436 if (dev && dev->attached) {
437 usb_device_ep_stopped(dev, &dev->ep_ctl);
438 for (j = 0; j < USB_MAX_ENDPOINTS; j++) {
439 usb_device_ep_stopped(dev, &dev->ep_in[j]);
440 usb_device_ep_stopped(dev, &dev->ep_out[j]);
446 static void ohci_roothub_reset(OHCIState *ohci)
448 OHCIPort *port;
449 int i;
451 ohci_bus_stop(ohci);
452 ohci->rhdesc_a = OHCI_RHA_NPS | ohci->num_ports;
453 ohci->rhdesc_b = 0x0; /* Impl. specific */
454 ohci->rhstatus = 0;
456 for (i = 0; i < ohci->num_ports; i++) {
457 port = &ohci->rhport[i];
458 port->ctrl = 0;
459 if (port->port.dev && port->port.dev->attached) {
460 usb_port_reset(&port->port);
463 if (ohci->async_td) {
464 usb_cancel_packet(&ohci->usb_packet);
465 ohci->async_td = 0;
467 ohci_stop_endpoints(ohci);
470 /* Reset the controller */
471 static void ohci_soft_reset(OHCIState *ohci)
473 trace_usb_ohci_reset(ohci->name);
475 ohci_bus_stop(ohci);
476 ohci->ctl = (ohci->ctl & OHCI_CTL_IR) | OHCI_USB_SUSPEND;
477 ohci->old_ctl = 0;
478 ohci->status = 0;
479 ohci->intr_status = 0;
480 ohci->intr = OHCI_INTR_MIE;
482 ohci->hcca = 0;
483 ohci->ctrl_head = ohci->ctrl_cur = 0;
484 ohci->bulk_head = ohci->bulk_cur = 0;
485 ohci->per_cur = 0;
486 ohci->done = 0;
487 ohci->done_count = 7;
489 /* FSMPS is marked TBD in OCHI 1.0, what gives ffs?
490 * I took the value linux sets ...
492 ohci->fsmps = 0x2778;
493 ohci->fi = 0x2edf;
494 ohci->fit = 0;
495 ohci->frt = 0;
496 ohci->frame_number = 0;
497 ohci->pstart = 0;
498 ohci->lst = OHCI_LS_THRESH;
501 static void ohci_hard_reset(OHCIState *ohci)
503 ohci_soft_reset(ohci);
504 ohci->ctl = 0;
505 ohci_roothub_reset(ohci);
508 /* Get an array of dwords from main memory */
509 static inline int get_dwords(OHCIState *ohci,
510 dma_addr_t addr, uint32_t *buf, int num)
512 int i;
514 addr += ohci->localmem_base;
516 for (i = 0; i < num; i++, buf++, addr += sizeof(*buf)) {
517 if (dma_memory_read(ohci->as, addr, buf, sizeof(*buf))) {
518 return -1;
520 *buf = le32_to_cpu(*buf);
523 return 0;
526 /* Put an array of dwords in to main memory */
527 static inline int put_dwords(OHCIState *ohci,
528 dma_addr_t addr, uint32_t *buf, int num)
530 int i;
532 addr += ohci->localmem_base;
534 for (i = 0; i < num; i++, buf++, addr += sizeof(*buf)) {
535 uint32_t tmp = cpu_to_le32(*buf);
536 if (dma_memory_write(ohci->as, addr, &tmp, sizeof(tmp))) {
537 return -1;
541 return 0;
544 /* Get an array of words from main memory */
545 static inline int get_words(OHCIState *ohci,
546 dma_addr_t addr, uint16_t *buf, int num)
548 int i;
550 addr += ohci->localmem_base;
552 for (i = 0; i < num; i++, buf++, addr += sizeof(*buf)) {
553 if (dma_memory_read(ohci->as, addr, buf, sizeof(*buf))) {
554 return -1;
556 *buf = le16_to_cpu(*buf);
559 return 0;
562 /* Put an array of words in to main memory */
563 static inline int put_words(OHCIState *ohci,
564 dma_addr_t addr, uint16_t *buf, int num)
566 int i;
568 addr += ohci->localmem_base;
570 for (i = 0; i < num; i++, buf++, addr += sizeof(*buf)) {
571 uint16_t tmp = cpu_to_le16(*buf);
572 if (dma_memory_write(ohci->as, addr, &tmp, sizeof(tmp))) {
573 return -1;
577 return 0;
580 static inline int ohci_read_ed(OHCIState *ohci,
581 dma_addr_t addr, struct ohci_ed *ed)
583 return get_dwords(ohci, addr, (uint32_t *)ed, sizeof(*ed) >> 2);
586 static inline int ohci_read_td(OHCIState *ohci,
587 dma_addr_t addr, struct ohci_td *td)
589 return get_dwords(ohci, addr, (uint32_t *)td, sizeof(*td) >> 2);
592 static inline int ohci_read_iso_td(OHCIState *ohci,
593 dma_addr_t addr, struct ohci_iso_td *td)
595 return get_dwords(ohci, addr, (uint32_t *)td, 4) ||
596 get_words(ohci, addr + 16, td->offset, 8);
599 static inline int ohci_read_hcca(OHCIState *ohci,
600 dma_addr_t addr, struct ohci_hcca *hcca)
602 return dma_memory_read(ohci->as, addr + ohci->localmem_base,
603 hcca, sizeof(*hcca));
606 static inline int ohci_put_ed(OHCIState *ohci,
607 dma_addr_t addr, struct ohci_ed *ed)
609 /* ed->tail is under control of the HCD.
610 * Since just ed->head is changed by HC, just write back this
613 return put_dwords(ohci, addr + ED_WBACK_OFFSET,
614 (uint32_t *)((char *)ed + ED_WBACK_OFFSET),
615 ED_WBACK_SIZE >> 2);
618 static inline int ohci_put_td(OHCIState *ohci,
619 dma_addr_t addr, struct ohci_td *td)
621 return put_dwords(ohci, addr, (uint32_t *)td, sizeof(*td) >> 2);
624 static inline int ohci_put_iso_td(OHCIState *ohci,
625 dma_addr_t addr, struct ohci_iso_td *td)
627 return put_dwords(ohci, addr, (uint32_t *)td, 4) ||
628 put_words(ohci, addr + 16, td->offset, 8);
631 static inline int ohci_put_hcca(OHCIState *ohci,
632 dma_addr_t addr, struct ohci_hcca *hcca)
634 return dma_memory_write(ohci->as,
635 addr + ohci->localmem_base + HCCA_WRITEBACK_OFFSET,
636 (char *)hcca + HCCA_WRITEBACK_OFFSET,
637 HCCA_WRITEBACK_SIZE);
640 /* Read/Write the contents of a TD from/to main memory. */
641 static int ohci_copy_td(OHCIState *ohci, struct ohci_td *td,
642 uint8_t *buf, int len, DMADirection dir)
644 dma_addr_t ptr, n;
646 ptr = td->cbp;
647 n = 0x1000 - (ptr & 0xfff);
648 if (n > len)
649 n = len;
651 if (dma_memory_rw(ohci->as, ptr + ohci->localmem_base, buf, n, dir)) {
652 return -1;
654 if (n == len) {
655 return 0;
657 ptr = td->be & ~0xfffu;
658 buf += n;
659 if (dma_memory_rw(ohci->as, ptr + ohci->localmem_base, buf,
660 len - n, dir)) {
661 return -1;
663 return 0;
666 /* Read/Write the contents of an ISO TD from/to main memory. */
667 static int ohci_copy_iso_td(OHCIState *ohci,
668 uint32_t start_addr, uint32_t end_addr,
669 uint8_t *buf, int len, DMADirection dir)
671 dma_addr_t ptr, n;
673 ptr = start_addr;
674 n = 0x1000 - (ptr & 0xfff);
675 if (n > len)
676 n = len;
678 if (dma_memory_rw(ohci->as, ptr + ohci->localmem_base, buf, n, dir)) {
679 return -1;
681 if (n == len) {
682 return 0;
684 ptr = end_addr & ~0xfffu;
685 buf += n;
686 if (dma_memory_rw(ohci->as, ptr + ohci->localmem_base, buf,
687 len - n, dir)) {
688 return -1;
690 return 0;
693 static void ohci_process_lists(OHCIState *ohci, int completion);
695 static void ohci_async_complete_packet(USBPort *port, USBPacket *packet)
697 OHCIState *ohci = container_of(packet, OHCIState, usb_packet);
699 trace_usb_ohci_async_complete();
700 ohci->async_complete = true;
701 ohci_process_lists(ohci, 1);
704 #define USUB(a, b) ((int16_t)((uint16_t)(a) - (uint16_t)(b)))
706 static int ohci_service_iso_td(OHCIState *ohci, struct ohci_ed *ed,
707 int completion)
709 int dir;
710 size_t len = 0;
711 const char *str = NULL;
712 int pid;
713 int ret;
714 int i;
715 USBDevice *dev;
716 USBEndpoint *ep;
717 struct ohci_iso_td iso_td;
718 uint32_t addr;
719 uint16_t starting_frame;
720 int16_t relative_frame_number;
721 int frame_count;
722 uint32_t start_offset, next_offset, end_offset = 0;
723 uint32_t start_addr, end_addr;
725 addr = ed->head & OHCI_DPTR_MASK;
727 if (ohci_read_iso_td(ohci, addr, &iso_td)) {
728 trace_usb_ohci_iso_td_read_failed(addr);
729 ohci_die(ohci);
730 return 1;
733 starting_frame = OHCI_BM(iso_td.flags, TD_SF);
734 frame_count = OHCI_BM(iso_td.flags, TD_FC);
735 relative_frame_number = USUB(ohci->frame_number, starting_frame);
737 trace_usb_ohci_iso_td_head(
738 ed->head & OHCI_DPTR_MASK, ed->tail & OHCI_DPTR_MASK,
739 iso_td.flags, iso_td.bp, iso_td.next, iso_td.be,
740 ohci->frame_number, starting_frame,
741 frame_count, relative_frame_number);
742 trace_usb_ohci_iso_td_head_offset(
743 iso_td.offset[0], iso_td.offset[1],
744 iso_td.offset[2], iso_td.offset[3],
745 iso_td.offset[4], iso_td.offset[5],
746 iso_td.offset[6], iso_td.offset[7]);
748 if (relative_frame_number < 0) {
749 trace_usb_ohci_iso_td_relative_frame_number_neg(relative_frame_number);
750 return 1;
751 } else if (relative_frame_number > frame_count) {
752 /* ISO TD expired - retire the TD to the Done Queue and continue with
753 the next ISO TD of the same ED */
754 trace_usb_ohci_iso_td_relative_frame_number_big(relative_frame_number,
755 frame_count);
756 OHCI_SET_BM(iso_td.flags, TD_CC, OHCI_CC_DATAOVERRUN);
757 ed->head &= ~OHCI_DPTR_MASK;
758 ed->head |= (iso_td.next & OHCI_DPTR_MASK);
759 iso_td.next = ohci->done;
760 ohci->done = addr;
761 i = OHCI_BM(iso_td.flags, TD_DI);
762 if (i < ohci->done_count)
763 ohci->done_count = i;
764 if (ohci_put_iso_td(ohci, addr, &iso_td)) {
765 ohci_die(ohci);
766 return 1;
768 return 0;
771 dir = OHCI_BM(ed->flags, ED_D);
772 switch (dir) {
773 case OHCI_TD_DIR_IN:
774 str = "in";
775 pid = USB_TOKEN_IN;
776 break;
777 case OHCI_TD_DIR_OUT:
778 str = "out";
779 pid = USB_TOKEN_OUT;
780 break;
781 case OHCI_TD_DIR_SETUP:
782 str = "setup";
783 pid = USB_TOKEN_SETUP;
784 break;
785 default:
786 trace_usb_ohci_iso_td_bad_direction(dir);
787 return 1;
790 if (!iso_td.bp || !iso_td.be) {
791 trace_usb_ohci_iso_td_bad_bp_be(iso_td.bp, iso_td.be);
792 return 1;
795 start_offset = iso_td.offset[relative_frame_number];
796 next_offset = iso_td.offset[relative_frame_number + 1];
798 if (!(OHCI_BM(start_offset, TD_PSW_CC) & 0xe) ||
799 ((relative_frame_number < frame_count) &&
800 !(OHCI_BM(next_offset, TD_PSW_CC) & 0xe))) {
801 trace_usb_ohci_iso_td_bad_cc_not_accessed(start_offset, next_offset);
802 return 1;
805 if ((relative_frame_number < frame_count) && (start_offset > next_offset)) {
806 trace_usb_ohci_iso_td_bad_cc_overrun(start_offset, next_offset);
807 return 1;
810 if ((start_offset & 0x1000) == 0) {
811 start_addr = (iso_td.bp & OHCI_PAGE_MASK) |
812 (start_offset & OHCI_OFFSET_MASK);
813 } else {
814 start_addr = (iso_td.be & OHCI_PAGE_MASK) |
815 (start_offset & OHCI_OFFSET_MASK);
818 if (relative_frame_number < frame_count) {
819 end_offset = next_offset - 1;
820 if ((end_offset & 0x1000) == 0) {
821 end_addr = (iso_td.bp & OHCI_PAGE_MASK) |
822 (end_offset & OHCI_OFFSET_MASK);
823 } else {
824 end_addr = (iso_td.be & OHCI_PAGE_MASK) |
825 (end_offset & OHCI_OFFSET_MASK);
827 } else {
828 /* Last packet in the ISO TD */
829 end_addr = iso_td.be;
832 if ((start_addr & OHCI_PAGE_MASK) != (end_addr & OHCI_PAGE_MASK)) {
833 len = (end_addr & OHCI_OFFSET_MASK) + 0x1001
834 - (start_addr & OHCI_OFFSET_MASK);
835 } else {
836 len = end_addr - start_addr + 1;
839 if (len && dir != OHCI_TD_DIR_IN) {
840 if (ohci_copy_iso_td(ohci, start_addr, end_addr, ohci->usb_buf, len,
841 DMA_DIRECTION_TO_DEVICE)) {
842 ohci_die(ohci);
843 return 1;
847 if (!completion) {
848 bool int_req = relative_frame_number == frame_count &&
849 OHCI_BM(iso_td.flags, TD_DI) == 0;
850 dev = ohci_find_device(ohci, OHCI_BM(ed->flags, ED_FA));
851 if (dev == NULL) {
852 trace_usb_ohci_td_dev_error();
853 return 1;
855 ep = usb_ep_get(dev, pid, OHCI_BM(ed->flags, ED_EN));
856 usb_packet_setup(&ohci->usb_packet, pid, ep, 0, addr, false, int_req);
857 usb_packet_addbuf(&ohci->usb_packet, ohci->usb_buf, len);
858 usb_handle_packet(dev, &ohci->usb_packet);
859 if (ohci->usb_packet.status == USB_RET_ASYNC) {
860 usb_device_flush_ep_queue(dev, ep);
861 return 1;
864 if (ohci->usb_packet.status == USB_RET_SUCCESS) {
865 ret = ohci->usb_packet.actual_length;
866 } else {
867 ret = ohci->usb_packet.status;
870 trace_usb_ohci_iso_td_so(start_offset, end_offset, start_addr, end_addr,
871 str, len, ret);
873 /* Writeback */
874 if (dir == OHCI_TD_DIR_IN && ret >= 0 && ret <= len) {
875 /* IN transfer succeeded */
876 if (ohci_copy_iso_td(ohci, start_addr, end_addr, ohci->usb_buf, ret,
877 DMA_DIRECTION_FROM_DEVICE)) {
878 ohci_die(ohci);
879 return 1;
881 OHCI_SET_BM(iso_td.offset[relative_frame_number], TD_PSW_CC,
882 OHCI_CC_NOERROR);
883 OHCI_SET_BM(iso_td.offset[relative_frame_number], TD_PSW_SIZE, ret);
884 } else if (dir == OHCI_TD_DIR_OUT && ret == len) {
885 /* OUT transfer succeeded */
886 OHCI_SET_BM(iso_td.offset[relative_frame_number], TD_PSW_CC,
887 OHCI_CC_NOERROR);
888 OHCI_SET_BM(iso_td.offset[relative_frame_number], TD_PSW_SIZE, 0);
889 } else {
890 if (ret > (ssize_t) len) {
891 trace_usb_ohci_iso_td_data_overrun(ret, len);
892 OHCI_SET_BM(iso_td.offset[relative_frame_number], TD_PSW_CC,
893 OHCI_CC_DATAOVERRUN);
894 OHCI_SET_BM(iso_td.offset[relative_frame_number], TD_PSW_SIZE,
895 len);
896 } else if (ret >= 0) {
897 trace_usb_ohci_iso_td_data_underrun(ret);
898 OHCI_SET_BM(iso_td.offset[relative_frame_number], TD_PSW_CC,
899 OHCI_CC_DATAUNDERRUN);
900 } else {
901 switch (ret) {
902 case USB_RET_IOERROR:
903 case USB_RET_NODEV:
904 OHCI_SET_BM(iso_td.offset[relative_frame_number], TD_PSW_CC,
905 OHCI_CC_DEVICENOTRESPONDING);
906 OHCI_SET_BM(iso_td.offset[relative_frame_number], TD_PSW_SIZE,
908 break;
909 case USB_RET_NAK:
910 case USB_RET_STALL:
911 trace_usb_ohci_iso_td_nak(ret);
912 OHCI_SET_BM(iso_td.offset[relative_frame_number], TD_PSW_CC,
913 OHCI_CC_STALL);
914 OHCI_SET_BM(iso_td.offset[relative_frame_number], TD_PSW_SIZE,
916 break;
917 default:
918 trace_usb_ohci_iso_td_bad_response(ret);
919 OHCI_SET_BM(iso_td.offset[relative_frame_number], TD_PSW_CC,
920 OHCI_CC_UNDEXPETEDPID);
921 break;
926 if (relative_frame_number == frame_count) {
927 /* Last data packet of ISO TD - retire the TD to the Done Queue */
928 OHCI_SET_BM(iso_td.flags, TD_CC, OHCI_CC_NOERROR);
929 ed->head &= ~OHCI_DPTR_MASK;
930 ed->head |= (iso_td.next & OHCI_DPTR_MASK);
931 iso_td.next = ohci->done;
932 ohci->done = addr;
933 i = OHCI_BM(iso_td.flags, TD_DI);
934 if (i < ohci->done_count)
935 ohci->done_count = i;
937 if (ohci_put_iso_td(ohci, addr, &iso_td)) {
938 ohci_die(ohci);
940 return 1;
943 static void ohci_td_pkt(const char *msg, const uint8_t *buf, size_t len)
945 bool print16;
946 bool printall;
947 const int width = 16;
948 int i;
949 char tmp[3 * width + 1];
950 char *p = tmp;
952 print16 = !!trace_event_get_state_backends(TRACE_USB_OHCI_TD_PKT_SHORT);
953 printall = !!trace_event_get_state_backends(TRACE_USB_OHCI_TD_PKT_FULL);
955 if (!printall && !print16) {
956 return;
959 for (i = 0; ; i++) {
960 if (i && (!(i % width) || (i == len))) {
961 if (!printall) {
962 trace_usb_ohci_td_pkt_short(msg, tmp);
963 break;
965 trace_usb_ohci_td_pkt_full(msg, tmp);
966 p = tmp;
967 *p = 0;
969 if (i == len) {
970 break;
973 p += sprintf(p, " %.2x", buf[i]);
977 /* Service a transport descriptor.
978 Returns nonzero to terminate processing of this endpoint. */
980 static int ohci_service_td(OHCIState *ohci, struct ohci_ed *ed)
982 int dir;
983 size_t len = 0, pktlen = 0;
984 const char *str = NULL;
985 int pid;
986 int ret;
987 int i;
988 USBDevice *dev;
989 USBEndpoint *ep;
990 struct ohci_td td;
991 uint32_t addr;
992 int flag_r;
993 int completion;
995 addr = ed->head & OHCI_DPTR_MASK;
996 /* See if this TD has already been submitted to the device. */
997 completion = (addr == ohci->async_td);
998 if (completion && !ohci->async_complete) {
999 trace_usb_ohci_td_skip_async();
1000 return 1;
1002 if (ohci_read_td(ohci, addr, &td)) {
1003 trace_usb_ohci_td_read_error(addr);
1004 ohci_die(ohci);
1005 return 1;
1008 dir = OHCI_BM(ed->flags, ED_D);
1009 switch (dir) {
1010 case OHCI_TD_DIR_OUT:
1011 case OHCI_TD_DIR_IN:
1012 /* Same value. */
1013 break;
1014 default:
1015 dir = OHCI_BM(td.flags, TD_DP);
1016 break;
1019 switch (dir) {
1020 case OHCI_TD_DIR_IN:
1021 str = "in";
1022 pid = USB_TOKEN_IN;
1023 break;
1024 case OHCI_TD_DIR_OUT:
1025 str = "out";
1026 pid = USB_TOKEN_OUT;
1027 break;
1028 case OHCI_TD_DIR_SETUP:
1029 str = "setup";
1030 pid = USB_TOKEN_SETUP;
1031 break;
1032 default:
1033 trace_usb_ohci_td_bad_direction(dir);
1034 return 1;
1036 if (td.cbp && td.be) {
1037 if ((td.cbp & 0xfffff000) != (td.be & 0xfffff000)) {
1038 len = (td.be & 0xfff) + 0x1001 - (td.cbp & 0xfff);
1039 } else {
1040 len = (td.be - td.cbp) + 1;
1043 pktlen = len;
1044 if (len && dir != OHCI_TD_DIR_IN) {
1045 /* The endpoint may not allow us to transfer it all now */
1046 pktlen = (ed->flags & OHCI_ED_MPS_MASK) >> OHCI_ED_MPS_SHIFT;
1047 if (pktlen > len) {
1048 pktlen = len;
1050 if (!completion) {
1051 if (ohci_copy_td(ohci, &td, ohci->usb_buf, pktlen,
1052 DMA_DIRECTION_TO_DEVICE)) {
1053 ohci_die(ohci);
1059 flag_r = (td.flags & OHCI_TD_R) != 0;
1060 trace_usb_ohci_td_pkt_hdr(addr, (int64_t)pktlen, (int64_t)len, str,
1061 flag_r, td.cbp, td.be);
1062 ohci_td_pkt("OUT", ohci->usb_buf, pktlen);
1064 if (completion) {
1065 ohci->async_td = 0;
1066 ohci->async_complete = false;
1067 } else {
1068 if (ohci->async_td) {
1069 /* ??? The hardware should allow one active packet per
1070 endpoint. We only allow one active packet per controller.
1071 This should be sufficient as long as devices respond in a
1072 timely manner.
1074 trace_usb_ohci_td_too_many_pending();
1075 return 1;
1077 dev = ohci_find_device(ohci, OHCI_BM(ed->flags, ED_FA));
1078 if (dev == NULL) {
1079 trace_usb_ohci_td_dev_error();
1080 return 1;
1082 ep = usb_ep_get(dev, pid, OHCI_BM(ed->flags, ED_EN));
1083 usb_packet_setup(&ohci->usb_packet, pid, ep, 0, addr, !flag_r,
1084 OHCI_BM(td.flags, TD_DI) == 0);
1085 usb_packet_addbuf(&ohci->usb_packet, ohci->usb_buf, pktlen);
1086 usb_handle_packet(dev, &ohci->usb_packet);
1087 trace_usb_ohci_td_packet_status(ohci->usb_packet.status);
1089 if (ohci->usb_packet.status == USB_RET_ASYNC) {
1090 usb_device_flush_ep_queue(dev, ep);
1091 ohci->async_td = addr;
1092 return 1;
1095 if (ohci->usb_packet.status == USB_RET_SUCCESS) {
1096 ret = ohci->usb_packet.actual_length;
1097 } else {
1098 ret = ohci->usb_packet.status;
1101 if (ret >= 0) {
1102 if (dir == OHCI_TD_DIR_IN) {
1103 if (ohci_copy_td(ohci, &td, ohci->usb_buf, ret,
1104 DMA_DIRECTION_FROM_DEVICE)) {
1105 ohci_die(ohci);
1107 ohci_td_pkt("IN", ohci->usb_buf, pktlen);
1108 } else {
1109 ret = pktlen;
1113 /* Writeback */
1114 if (ret == pktlen || (dir == OHCI_TD_DIR_IN && ret >= 0 && flag_r)) {
1115 /* Transmission succeeded. */
1116 if (ret == len) {
1117 td.cbp = 0;
1118 } else {
1119 if ((td.cbp & 0xfff) + ret > 0xfff) {
1120 td.cbp = (td.be & ~0xfff) + ((td.cbp + ret) & 0xfff);
1121 } else {
1122 td.cbp += ret;
1125 td.flags |= OHCI_TD_T1;
1126 td.flags ^= OHCI_TD_T0;
1127 OHCI_SET_BM(td.flags, TD_CC, OHCI_CC_NOERROR);
1128 OHCI_SET_BM(td.flags, TD_EC, 0);
1130 if ((dir != OHCI_TD_DIR_IN) && (ret != len)) {
1131 /* Partial packet transfer: TD not ready to retire yet */
1132 goto exit_no_retire;
1135 /* Setting ED_C is part of the TD retirement process */
1136 ed->head &= ~OHCI_ED_C;
1137 if (td.flags & OHCI_TD_T0)
1138 ed->head |= OHCI_ED_C;
1139 } else {
1140 if (ret >= 0) {
1141 trace_usb_ohci_td_underrun();
1142 OHCI_SET_BM(td.flags, TD_CC, OHCI_CC_DATAUNDERRUN);
1143 } else {
1144 switch (ret) {
1145 case USB_RET_IOERROR:
1146 case USB_RET_NODEV:
1147 trace_usb_ohci_td_dev_error();
1148 OHCI_SET_BM(td.flags, TD_CC, OHCI_CC_DEVICENOTRESPONDING);
1149 break;
1150 case USB_RET_NAK:
1151 trace_usb_ohci_td_nak();
1152 return 1;
1153 case USB_RET_STALL:
1154 trace_usb_ohci_td_stall();
1155 OHCI_SET_BM(td.flags, TD_CC, OHCI_CC_STALL);
1156 break;
1157 case USB_RET_BABBLE:
1158 trace_usb_ohci_td_babble();
1159 OHCI_SET_BM(td.flags, TD_CC, OHCI_CC_DATAOVERRUN);
1160 break;
1161 default:
1162 trace_usb_ohci_td_bad_device_response(ret);
1163 OHCI_SET_BM(td.flags, TD_CC, OHCI_CC_UNDEXPETEDPID);
1164 OHCI_SET_BM(td.flags, TD_EC, 3);
1165 break;
1167 /* An error occured so we have to clear the interrupt counter. See
1168 * spec at 6.4.4 on page 104 */
1169 ohci->done_count = 0;
1171 ed->head |= OHCI_ED_H;
1174 /* Retire this TD */
1175 ed->head &= ~OHCI_DPTR_MASK;
1176 ed->head |= td.next & OHCI_DPTR_MASK;
1177 td.next = ohci->done;
1178 ohci->done = addr;
1179 i = OHCI_BM(td.flags, TD_DI);
1180 if (i < ohci->done_count)
1181 ohci->done_count = i;
1182 exit_no_retire:
1183 if (ohci_put_td(ohci, addr, &td)) {
1184 ohci_die(ohci);
1185 return 1;
1187 return OHCI_BM(td.flags, TD_CC) != OHCI_CC_NOERROR;
1190 /* Service an endpoint list. Returns nonzero if active TD were found. */
1191 static int ohci_service_ed_list(OHCIState *ohci, uint32_t head, int completion)
1193 struct ohci_ed ed;
1194 uint32_t next_ed;
1195 uint32_t cur;
1196 int active;
1197 uint32_t link_cnt = 0;
1198 active = 0;
1200 if (head == 0)
1201 return 0;
1203 for (cur = head; cur && link_cnt++ < ED_LINK_LIMIT; cur = next_ed) {
1204 if (ohci_read_ed(ohci, cur, &ed)) {
1205 trace_usb_ohci_ed_read_error(cur);
1206 ohci_die(ohci);
1207 return 0;
1210 next_ed = ed.next & OHCI_DPTR_MASK;
1212 if ((ed.head & OHCI_ED_H) || (ed.flags & OHCI_ED_K)) {
1213 uint32_t addr;
1214 /* Cancel pending packets for ED that have been paused. */
1215 addr = ed.head & OHCI_DPTR_MASK;
1216 if (ohci->async_td && addr == ohci->async_td) {
1217 usb_cancel_packet(&ohci->usb_packet);
1218 ohci->async_td = 0;
1219 usb_device_ep_stopped(ohci->usb_packet.ep->dev,
1220 ohci->usb_packet.ep);
1222 continue;
1225 while ((ed.head & OHCI_DPTR_MASK) != ed.tail) {
1226 trace_usb_ohci_ed_pkt(cur, (ed.head & OHCI_ED_H) != 0,
1227 (ed.head & OHCI_ED_C) != 0, ed.head & OHCI_DPTR_MASK,
1228 ed.tail & OHCI_DPTR_MASK, ed.next & OHCI_DPTR_MASK);
1229 trace_usb_ohci_ed_pkt_flags(
1230 OHCI_BM(ed.flags, ED_FA), OHCI_BM(ed.flags, ED_EN),
1231 OHCI_BM(ed.flags, ED_D), (ed.flags & OHCI_ED_S)!= 0,
1232 (ed.flags & OHCI_ED_K) != 0, (ed.flags & OHCI_ED_F) != 0,
1233 OHCI_BM(ed.flags, ED_MPS));
1235 active = 1;
1237 if ((ed.flags & OHCI_ED_F) == 0) {
1238 if (ohci_service_td(ohci, &ed))
1239 break;
1240 } else {
1241 /* Handle isochronous endpoints */
1242 if (ohci_service_iso_td(ohci, &ed, completion))
1243 break;
1247 if (ohci_put_ed(ohci, cur, &ed)) {
1248 ohci_die(ohci);
1249 return 0;
1253 return active;
1256 /* set a timer for EOF */
1257 static void ohci_eof_timer(OHCIState *ohci)
1259 timer_mod(ohci->eof_timer, ohci->sof_time + usb_frame_time);
1261 /* Set a timer for EOF and generate a SOF event */
1262 static void ohci_sof(OHCIState *ohci)
1264 ohci->sof_time += usb_frame_time;
1265 ohci_eof_timer(ohci);
1266 ohci_set_interrupt(ohci, OHCI_INTR_SF);
1269 /* Process Control and Bulk lists. */
1270 static void ohci_process_lists(OHCIState *ohci, int completion)
1272 if ((ohci->ctl & OHCI_CTL_CLE) && (ohci->status & OHCI_STATUS_CLF)) {
1273 if (ohci->ctrl_cur && ohci->ctrl_cur != ohci->ctrl_head) {
1274 trace_usb_ohci_process_lists(ohci->ctrl_head, ohci->ctrl_cur);
1276 if (!ohci_service_ed_list(ohci, ohci->ctrl_head, completion)) {
1277 ohci->ctrl_cur = 0;
1278 ohci->status &= ~OHCI_STATUS_CLF;
1282 if ((ohci->ctl & OHCI_CTL_BLE) && (ohci->status & OHCI_STATUS_BLF)) {
1283 if (!ohci_service_ed_list(ohci, ohci->bulk_head, completion)) {
1284 ohci->bulk_cur = 0;
1285 ohci->status &= ~OHCI_STATUS_BLF;
1290 /* Do frame processing on frame boundary */
1291 static void ohci_frame_boundary(void *opaque)
1293 OHCIState *ohci = opaque;
1294 struct ohci_hcca hcca;
1296 if (ohci_read_hcca(ohci, ohci->hcca, &hcca)) {
1297 trace_usb_ohci_hcca_read_error(ohci->hcca);
1298 ohci_die(ohci);
1299 return;
1302 /* Process all the lists at the end of the frame */
1303 if (ohci->ctl & OHCI_CTL_PLE) {
1304 int n;
1306 n = ohci->frame_number & 0x1f;
1307 ohci_service_ed_list(ohci, le32_to_cpu(hcca.intr[n]), 0);
1310 /* Cancel all pending packets if either of the lists has been disabled. */
1311 if (ohci->old_ctl & (~ohci->ctl) & (OHCI_CTL_BLE | OHCI_CTL_CLE)) {
1312 if (ohci->async_td) {
1313 usb_cancel_packet(&ohci->usb_packet);
1314 ohci->async_td = 0;
1316 ohci_stop_endpoints(ohci);
1318 ohci->old_ctl = ohci->ctl;
1319 ohci_process_lists(ohci, 0);
1321 /* Stop if UnrecoverableError happened or ohci_sof will crash */
1322 if (ohci->intr_status & OHCI_INTR_UE) {
1323 return;
1326 /* Frame boundary, so do EOF stuf here */
1327 ohci->frt = ohci->fit;
1329 /* Increment frame number and take care of endianness. */
1330 ohci->frame_number = (ohci->frame_number + 1) & 0xffff;
1331 hcca.frame = cpu_to_le16(ohci->frame_number);
1333 if (ohci->done_count == 0 && !(ohci->intr_status & OHCI_INTR_WD)) {
1334 if (!ohci->done)
1335 abort();
1336 if (ohci->intr & ohci->intr_status)
1337 ohci->done |= 1;
1338 hcca.done = cpu_to_le32(ohci->done);
1339 ohci->done = 0;
1340 ohci->done_count = 7;
1341 ohci_set_interrupt(ohci, OHCI_INTR_WD);
1344 if (ohci->done_count != 7 && ohci->done_count != 0)
1345 ohci->done_count--;
1347 /* Do SOF stuff here */
1348 ohci_sof(ohci);
1350 /* Writeback HCCA */
1351 if (ohci_put_hcca(ohci, ohci->hcca, &hcca)) {
1352 ohci_die(ohci);
1356 /* Start sending SOF tokens across the USB bus, lists are processed in
1357 * next frame
1359 static int ohci_bus_start(OHCIState *ohci)
1361 trace_usb_ohci_start(ohci->name);
1363 /* Delay the first SOF event by one frame time as
1364 * linux driver is not ready to receive it and
1365 * can meet some race conditions
1368 ohci->sof_time = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
1369 ohci_eof_timer(ohci);
1371 return 1;
1374 /* Stop sending SOF tokens on the bus */
1375 static void ohci_bus_stop(OHCIState *ohci)
1377 trace_usb_ohci_stop(ohci->name);
1378 timer_del(ohci->eof_timer);
1381 /* Sets a flag in a port status register but only set it if the port is
1382 * connected, if not set ConnectStatusChange flag. If flag is enabled
1383 * return 1.
1385 static int ohci_port_set_if_connected(OHCIState *ohci, int i, uint32_t val)
1387 int ret = 1;
1389 /* writing a 0 has no effect */
1390 if (val == 0)
1391 return 0;
1393 /* If CurrentConnectStatus is cleared we set
1394 * ConnectStatusChange
1396 if (!(ohci->rhport[i].ctrl & OHCI_PORT_CCS)) {
1397 ohci->rhport[i].ctrl |= OHCI_PORT_CSC;
1398 if (ohci->rhstatus & OHCI_RHS_DRWE) {
1399 /* TODO: CSC is a wakeup event */
1401 return 0;
1404 if (ohci->rhport[i].ctrl & val)
1405 ret = 0;
1407 /* set the bit */
1408 ohci->rhport[i].ctrl |= val;
1410 return ret;
1413 /* Set the frame interval - frame interval toggle is manipulated by the hcd only */
1414 static void ohci_set_frame_interval(OHCIState *ohci, uint16_t val)
1416 val &= OHCI_FMI_FI;
1418 if (val != ohci->fi) {
1419 trace_usb_ohci_set_frame_interval(ohci->name, ohci->fi, ohci->fi);
1422 ohci->fi = val;
1425 static void ohci_port_power(OHCIState *ohci, int i, int p)
1427 if (p) {
1428 ohci->rhport[i].ctrl |= OHCI_PORT_PPS;
1429 } else {
1430 ohci->rhport[i].ctrl &= ~(OHCI_PORT_PPS|
1431 OHCI_PORT_CCS|
1432 OHCI_PORT_PSS|
1433 OHCI_PORT_PRS);
1437 /* Set HcControlRegister */
1438 static void ohci_set_ctl(OHCIState *ohci, uint32_t val)
1440 uint32_t old_state;
1441 uint32_t new_state;
1443 old_state = ohci->ctl & OHCI_CTL_HCFS;
1444 ohci->ctl = val;
1445 new_state = ohci->ctl & OHCI_CTL_HCFS;
1447 /* no state change */
1448 if (old_state == new_state)
1449 return;
1451 trace_usb_ohci_set_ctl(ohci->name, new_state);
1452 switch (new_state) {
1453 case OHCI_USB_OPERATIONAL:
1454 ohci_bus_start(ohci);
1455 break;
1456 case OHCI_USB_SUSPEND:
1457 ohci_bus_stop(ohci);
1458 /* clear pending SF otherwise linux driver loops in ohci_irq() */
1459 ohci->intr_status &= ~OHCI_INTR_SF;
1460 ohci_intr_update(ohci);
1461 break;
1462 case OHCI_USB_RESUME:
1463 trace_usb_ohci_resume(ohci->name);
1464 break;
1465 case OHCI_USB_RESET:
1466 ohci_roothub_reset(ohci);
1467 break;
1471 static uint32_t ohci_get_frame_remaining(OHCIState *ohci)
1473 uint16_t fr;
1474 int64_t tks;
1476 if ((ohci->ctl & OHCI_CTL_HCFS) != OHCI_USB_OPERATIONAL)
1477 return (ohci->frt << 31);
1479 /* Being in USB operational state guarnatees sof_time was
1480 * set already.
1482 tks = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL) - ohci->sof_time;
1483 if (tks < 0) {
1484 tks = 0;
1487 /* avoid muldiv if possible */
1488 if (tks >= usb_frame_time)
1489 return (ohci->frt << 31);
1491 tks = tks / usb_bit_time;
1492 fr = (uint16_t)(ohci->fi - tks);
1494 return (ohci->frt << 31) | fr;
1498 /* Set root hub status */
1499 static void ohci_set_hub_status(OHCIState *ohci, uint32_t val)
1501 uint32_t old_state;
1503 old_state = ohci->rhstatus;
1505 /* write 1 to clear OCIC */
1506 if (val & OHCI_RHS_OCIC)
1507 ohci->rhstatus &= ~OHCI_RHS_OCIC;
1509 if (val & OHCI_RHS_LPS) {
1510 int i;
1512 for (i = 0; i < ohci->num_ports; i++)
1513 ohci_port_power(ohci, i, 0);
1514 trace_usb_ohci_hub_power_down();
1517 if (val & OHCI_RHS_LPSC) {
1518 int i;
1520 for (i = 0; i < ohci->num_ports; i++)
1521 ohci_port_power(ohci, i, 1);
1522 trace_usb_ohci_hub_power_up();
1525 if (val & OHCI_RHS_DRWE)
1526 ohci->rhstatus |= OHCI_RHS_DRWE;
1528 if (val & OHCI_RHS_CRWE)
1529 ohci->rhstatus &= ~OHCI_RHS_DRWE;
1531 if (old_state != ohci->rhstatus)
1532 ohci_set_interrupt(ohci, OHCI_INTR_RHSC);
1535 /* Set root hub port status */
1536 static void ohci_port_set_status(OHCIState *ohci, int portnum, uint32_t val)
1538 uint32_t old_state;
1539 OHCIPort *port;
1541 port = &ohci->rhport[portnum];
1542 old_state = port->ctrl;
1544 /* Write to clear CSC, PESC, PSSC, OCIC, PRSC */
1545 if (val & OHCI_PORT_WTC)
1546 port->ctrl &= ~(val & OHCI_PORT_WTC);
1548 if (val & OHCI_PORT_CCS)
1549 port->ctrl &= ~OHCI_PORT_PES;
1551 ohci_port_set_if_connected(ohci, portnum, val & OHCI_PORT_PES);
1553 if (ohci_port_set_if_connected(ohci, portnum, val & OHCI_PORT_PSS)) {
1554 trace_usb_ohci_port_suspend(portnum);
1557 if (ohci_port_set_if_connected(ohci, portnum, val & OHCI_PORT_PRS)) {
1558 trace_usb_ohci_port_reset(portnum);
1559 usb_device_reset(port->port.dev);
1560 port->ctrl &= ~OHCI_PORT_PRS;
1561 /* ??? Should this also set OHCI_PORT_PESC. */
1562 port->ctrl |= OHCI_PORT_PES | OHCI_PORT_PRSC;
1565 /* Invert order here to ensure in ambiguous case, device is
1566 * powered up...
1568 if (val & OHCI_PORT_LSDA)
1569 ohci_port_power(ohci, portnum, 0);
1570 if (val & OHCI_PORT_PPS)
1571 ohci_port_power(ohci, portnum, 1);
1573 if (old_state != port->ctrl)
1574 ohci_set_interrupt(ohci, OHCI_INTR_RHSC);
1577 static uint64_t ohci_mem_read(void *opaque,
1578 hwaddr addr,
1579 unsigned size)
1581 OHCIState *ohci = opaque;
1582 uint32_t retval;
1584 /* Only aligned reads are allowed on OHCI */
1585 if (addr & 3) {
1586 trace_usb_ohci_mem_read_unaligned(addr);
1587 return 0xffffffff;
1588 } else if (addr >= 0x54 && addr < 0x54 + ohci->num_ports * 4) {
1589 /* HcRhPortStatus */
1590 retval = ohci->rhport[(addr - 0x54) >> 2].ctrl | OHCI_PORT_PPS;
1591 } else {
1592 switch (addr >> 2) {
1593 case 0: /* HcRevision */
1594 retval = 0x10;
1595 break;
1597 case 1: /* HcControl */
1598 retval = ohci->ctl;
1599 break;
1601 case 2: /* HcCommandStatus */
1602 retval = ohci->status;
1603 break;
1605 case 3: /* HcInterruptStatus */
1606 retval = ohci->intr_status;
1607 break;
1609 case 4: /* HcInterruptEnable */
1610 case 5: /* HcInterruptDisable */
1611 retval = ohci->intr;
1612 break;
1614 case 6: /* HcHCCA */
1615 retval = ohci->hcca;
1616 break;
1618 case 7: /* HcPeriodCurrentED */
1619 retval = ohci->per_cur;
1620 break;
1622 case 8: /* HcControlHeadED */
1623 retval = ohci->ctrl_head;
1624 break;
1626 case 9: /* HcControlCurrentED */
1627 retval = ohci->ctrl_cur;
1628 break;
1630 case 10: /* HcBulkHeadED */
1631 retval = ohci->bulk_head;
1632 break;
1634 case 11: /* HcBulkCurrentED */
1635 retval = ohci->bulk_cur;
1636 break;
1638 case 12: /* HcDoneHead */
1639 retval = ohci->done;
1640 break;
1642 case 13: /* HcFmInterretval */
1643 retval = (ohci->fit << 31) | (ohci->fsmps << 16) | (ohci->fi);
1644 break;
1646 case 14: /* HcFmRemaining */
1647 retval = ohci_get_frame_remaining(ohci);
1648 break;
1650 case 15: /* HcFmNumber */
1651 retval = ohci->frame_number;
1652 break;
1654 case 16: /* HcPeriodicStart */
1655 retval = ohci->pstart;
1656 break;
1658 case 17: /* HcLSThreshold */
1659 retval = ohci->lst;
1660 break;
1662 case 18: /* HcRhDescriptorA */
1663 retval = ohci->rhdesc_a;
1664 break;
1666 case 19: /* HcRhDescriptorB */
1667 retval = ohci->rhdesc_b;
1668 break;
1670 case 20: /* HcRhStatus */
1671 retval = ohci->rhstatus;
1672 break;
1674 /* PXA27x specific registers */
1675 case 24: /* HcStatus */
1676 retval = ohci->hstatus & ohci->hmask;
1677 break;
1679 case 25: /* HcHReset */
1680 retval = ohci->hreset;
1681 break;
1683 case 26: /* HcHInterruptEnable */
1684 retval = ohci->hmask;
1685 break;
1687 case 27: /* HcHInterruptTest */
1688 retval = ohci->htest;
1689 break;
1691 default:
1692 trace_usb_ohci_mem_read_bad_offset(addr);
1693 retval = 0xffffffff;
1697 return retval;
1700 static void ohci_mem_write(void *opaque,
1701 hwaddr addr,
1702 uint64_t val,
1703 unsigned size)
1705 OHCIState *ohci = opaque;
1707 /* Only aligned reads are allowed on OHCI */
1708 if (addr & 3) {
1709 trace_usb_ohci_mem_write_unaligned(addr);
1710 return;
1713 if (addr >= 0x54 && addr < 0x54 + ohci->num_ports * 4) {
1714 /* HcRhPortStatus */
1715 ohci_port_set_status(ohci, (addr - 0x54) >> 2, val);
1716 return;
1719 switch (addr >> 2) {
1720 case 1: /* HcControl */
1721 ohci_set_ctl(ohci, val);
1722 break;
1724 case 2: /* HcCommandStatus */
1725 /* SOC is read-only */
1726 val = (val & ~OHCI_STATUS_SOC);
1728 /* Bits written as '0' remain unchanged in the register */
1729 ohci->status |= val;
1731 if (ohci->status & OHCI_STATUS_HCR)
1732 ohci_soft_reset(ohci);
1733 break;
1735 case 3: /* HcInterruptStatus */
1736 ohci->intr_status &= ~val;
1737 ohci_intr_update(ohci);
1738 break;
1740 case 4: /* HcInterruptEnable */
1741 ohci->intr |= val;
1742 ohci_intr_update(ohci);
1743 break;
1745 case 5: /* HcInterruptDisable */
1746 ohci->intr &= ~val;
1747 ohci_intr_update(ohci);
1748 break;
1750 case 6: /* HcHCCA */
1751 ohci->hcca = val & OHCI_HCCA_MASK;
1752 break;
1754 case 7: /* HcPeriodCurrentED */
1755 /* Ignore writes to this read-only register, Linux does them */
1756 break;
1758 case 8: /* HcControlHeadED */
1759 ohci->ctrl_head = val & OHCI_EDPTR_MASK;
1760 break;
1762 case 9: /* HcControlCurrentED */
1763 ohci->ctrl_cur = val & OHCI_EDPTR_MASK;
1764 break;
1766 case 10: /* HcBulkHeadED */
1767 ohci->bulk_head = val & OHCI_EDPTR_MASK;
1768 break;
1770 case 11: /* HcBulkCurrentED */
1771 ohci->bulk_cur = val & OHCI_EDPTR_MASK;
1772 break;
1774 case 13: /* HcFmInterval */
1775 ohci->fsmps = (val & OHCI_FMI_FSMPS) >> 16;
1776 ohci->fit = (val & OHCI_FMI_FIT) >> 31;
1777 ohci_set_frame_interval(ohci, val);
1778 break;
1780 case 15: /* HcFmNumber */
1781 break;
1783 case 16: /* HcPeriodicStart */
1784 ohci->pstart = val & 0xffff;
1785 break;
1787 case 17: /* HcLSThreshold */
1788 ohci->lst = val & 0xffff;
1789 break;
1791 case 18: /* HcRhDescriptorA */
1792 ohci->rhdesc_a &= ~OHCI_RHA_RW_MASK;
1793 ohci->rhdesc_a |= val & OHCI_RHA_RW_MASK;
1794 break;
1796 case 19: /* HcRhDescriptorB */
1797 break;
1799 case 20: /* HcRhStatus */
1800 ohci_set_hub_status(ohci, val);
1801 break;
1803 /* PXA27x specific registers */
1804 case 24: /* HcStatus */
1805 ohci->hstatus &= ~(val & ohci->hmask);
1806 break;
1808 case 25: /* HcHReset */
1809 ohci->hreset = val & ~OHCI_HRESET_FSBIR;
1810 if (val & OHCI_HRESET_FSBIR)
1811 ohci_hard_reset(ohci);
1812 break;
1814 case 26: /* HcHInterruptEnable */
1815 ohci->hmask = val;
1816 break;
1818 case 27: /* HcHInterruptTest */
1819 ohci->htest = val;
1820 break;
1822 default:
1823 trace_usb_ohci_mem_write_bad_offset(addr);
1824 break;
1828 static void ohci_async_cancel_device(OHCIState *ohci, USBDevice *dev)
1830 if (ohci->async_td &&
1831 usb_packet_is_inflight(&ohci->usb_packet) &&
1832 ohci->usb_packet.ep->dev == dev) {
1833 usb_cancel_packet(&ohci->usb_packet);
1834 ohci->async_td = 0;
1838 static const MemoryRegionOps ohci_mem_ops = {
1839 .read = ohci_mem_read,
1840 .write = ohci_mem_write,
1841 .endianness = DEVICE_LITTLE_ENDIAN,
1844 static USBPortOps ohci_port_ops = {
1845 .attach = ohci_attach,
1846 .detach = ohci_detach,
1847 .child_detach = ohci_child_detach,
1848 .wakeup = ohci_wakeup,
1849 .complete = ohci_async_complete_packet,
1852 static USBBusOps ohci_bus_ops = {
1855 static void usb_ohci_init(OHCIState *ohci, DeviceState *dev,
1856 uint32_t num_ports, dma_addr_t localmem_base,
1857 char *masterbus, uint32_t firstport,
1858 AddressSpace *as, Error **errp)
1860 Error *err = NULL;
1861 int i;
1863 ohci->as = as;
1865 if (num_ports > OHCI_MAX_PORTS) {
1866 error_setg(errp, "OHCI num-ports=%u is too big (limit is %u ports)",
1867 num_ports, OHCI_MAX_PORTS);
1868 return;
1871 if (usb_frame_time == 0) {
1872 #ifdef OHCI_TIME_WARP
1873 usb_frame_time = NANOSECONDS_PER_SECOND;
1874 usb_bit_time = NANOSECONDS_PER_SECOND / (USB_HZ / 1000);
1875 #else
1876 usb_frame_time = NANOSECONDS_PER_SECOND / 1000;
1877 if (NANOSECONDS_PER_SECOND >= USB_HZ) {
1878 usb_bit_time = NANOSECONDS_PER_SECOND / USB_HZ;
1879 } else {
1880 usb_bit_time = 1;
1882 #endif
1883 trace_usb_ohci_init_time(usb_frame_time, usb_bit_time);
1886 ohci->num_ports = num_ports;
1887 if (masterbus) {
1888 USBPort *ports[OHCI_MAX_PORTS];
1889 for(i = 0; i < num_ports; i++) {
1890 ports[i] = &ohci->rhport[i].port;
1892 usb_register_companion(masterbus, ports, num_ports,
1893 firstport, ohci, &ohci_port_ops,
1894 USB_SPEED_MASK_LOW | USB_SPEED_MASK_FULL,
1895 &err);
1896 if (err) {
1897 error_propagate(errp, err);
1898 return;
1900 } else {
1901 usb_bus_new(&ohci->bus, sizeof(ohci->bus), &ohci_bus_ops, dev);
1902 for (i = 0; i < num_ports; i++) {
1903 usb_register_port(&ohci->bus, &ohci->rhport[i].port,
1904 ohci, i, &ohci_port_ops,
1905 USB_SPEED_MASK_LOW | USB_SPEED_MASK_FULL);
1909 memory_region_init_io(&ohci->mem, OBJECT(dev), &ohci_mem_ops,
1910 ohci, "ohci", 256);
1911 ohci->localmem_base = localmem_base;
1913 ohci->name = object_get_typename(OBJECT(dev));
1914 usb_packet_init(&ohci->usb_packet);
1916 ohci->async_td = 0;
1918 ohci->eof_timer = timer_new_ns(QEMU_CLOCK_VIRTUAL,
1919 ohci_frame_boundary, ohci);
1922 #define TYPE_PCI_OHCI "pci-ohci"
1923 #define PCI_OHCI(obj) OBJECT_CHECK(OHCIPCIState, (obj), TYPE_PCI_OHCI)
1925 typedef struct {
1926 /*< private >*/
1927 PCIDevice parent_obj;
1928 /*< public >*/
1930 OHCIState state;
1931 char *masterbus;
1932 uint32_t num_ports;
1933 uint32_t firstport;
1934 } OHCIPCIState;
1936 /** A typical O/EHCI will stop operating, set itself into error state
1937 * (which can be queried by MMIO) and will set PERR in its config
1938 * space to signal that it got an error
1940 static void ohci_die(OHCIState *ohci)
1942 OHCIPCIState *dev = container_of(ohci, OHCIPCIState, state);
1944 trace_usb_ohci_die();
1946 ohci_set_interrupt(ohci, OHCI_INTR_UE);
1947 ohci_bus_stop(ohci);
1948 pci_set_word(dev->parent_obj.config + PCI_STATUS,
1949 PCI_STATUS_DETECTED_PARITY);
1952 static void usb_ohci_realize_pci(PCIDevice *dev, Error **errp)
1954 Error *err = NULL;
1955 OHCIPCIState *ohci = PCI_OHCI(dev);
1957 dev->config[PCI_CLASS_PROG] = 0x10; /* OHCI */
1958 dev->config[PCI_INTERRUPT_PIN] = 0x01; /* interrupt pin A */
1960 usb_ohci_init(&ohci->state, DEVICE(dev), ohci->num_ports, 0,
1961 ohci->masterbus, ohci->firstport,
1962 pci_get_address_space(dev), &err);
1963 if (err) {
1964 error_propagate(errp, err);
1965 return;
1968 ohci->state.irq = pci_allocate_irq(dev);
1969 pci_register_bar(dev, 0, 0, &ohci->state.mem);
1972 static void usb_ohci_exit(PCIDevice *dev)
1974 OHCIPCIState *ohci = PCI_OHCI(dev);
1975 OHCIState *s = &ohci->state;
1977 trace_usb_ohci_exit(s->name);
1978 ohci_bus_stop(s);
1980 if (s->async_td) {
1981 usb_cancel_packet(&s->usb_packet);
1982 s->async_td = 0;
1984 ohci_stop_endpoints(s);
1986 if (!ohci->masterbus) {
1987 usb_bus_release(&s->bus);
1990 timer_del(s->eof_timer);
1991 timer_free(s->eof_timer);
1994 static void usb_ohci_reset_pci(DeviceState *d)
1996 PCIDevice *dev = PCI_DEVICE(d);
1997 OHCIPCIState *ohci = PCI_OHCI(dev);
1998 OHCIState *s = &ohci->state;
2000 ohci_hard_reset(s);
2003 #define TYPE_SYSBUS_OHCI "sysbus-ohci"
2004 #define SYSBUS_OHCI(obj) OBJECT_CHECK(OHCISysBusState, (obj), TYPE_SYSBUS_OHCI)
2006 typedef struct {
2007 /*< private >*/
2008 SysBusDevice parent_obj;
2009 /*< public >*/
2011 OHCIState ohci;
2012 char *masterbus;
2013 uint32_t num_ports;
2014 uint32_t firstport;
2015 dma_addr_t dma_offset;
2016 } OHCISysBusState;
2018 static void ohci_realize_pxa(DeviceState *dev, Error **errp)
2020 OHCISysBusState *s = SYSBUS_OHCI(dev);
2021 SysBusDevice *sbd = SYS_BUS_DEVICE(dev);
2022 Error *err = NULL;
2024 usb_ohci_init(&s->ohci, dev, s->num_ports, s->dma_offset,
2025 s->masterbus, s->firstport,
2026 &address_space_memory, &err);
2027 if (err) {
2028 error_propagate(errp, err);
2029 return;
2031 sysbus_init_irq(sbd, &s->ohci.irq);
2032 sysbus_init_mmio(sbd, &s->ohci.mem);
2035 static void usb_ohci_reset_sysbus(DeviceState *dev)
2037 OHCISysBusState *s = SYSBUS_OHCI(dev);
2038 OHCIState *ohci = &s->ohci;
2040 ohci_hard_reset(ohci);
2043 static Property ohci_pci_properties[] = {
2044 DEFINE_PROP_STRING("masterbus", OHCIPCIState, masterbus),
2045 DEFINE_PROP_UINT32("num-ports", OHCIPCIState, num_ports, 3),
2046 DEFINE_PROP_UINT32("firstport", OHCIPCIState, firstport, 0),
2047 DEFINE_PROP_END_OF_LIST(),
2050 static const VMStateDescription vmstate_ohci_state_port = {
2051 .name = "ohci-core/port",
2052 .version_id = 1,
2053 .minimum_version_id = 1,
2054 .fields = (VMStateField[]) {
2055 VMSTATE_UINT32(ctrl, OHCIPort),
2056 VMSTATE_END_OF_LIST()
2060 static bool ohci_eof_timer_needed(void *opaque)
2062 OHCIState *ohci = opaque;
2064 return timer_pending(ohci->eof_timer);
2067 static const VMStateDescription vmstate_ohci_eof_timer = {
2068 .name = "ohci-core/eof-timer",
2069 .version_id = 1,
2070 .minimum_version_id = 1,
2071 .needed = ohci_eof_timer_needed,
2072 .fields = (VMStateField[]) {
2073 VMSTATE_TIMER_PTR(eof_timer, OHCIState),
2074 VMSTATE_END_OF_LIST()
2078 static const VMStateDescription vmstate_ohci_state = {
2079 .name = "ohci-core",
2080 .version_id = 1,
2081 .minimum_version_id = 1,
2082 .fields = (VMStateField[]) {
2083 VMSTATE_INT64(sof_time, OHCIState),
2084 VMSTATE_UINT32(ctl, OHCIState),
2085 VMSTATE_UINT32(status, OHCIState),
2086 VMSTATE_UINT32(intr_status, OHCIState),
2087 VMSTATE_UINT32(intr, OHCIState),
2088 VMSTATE_UINT32(hcca, OHCIState),
2089 VMSTATE_UINT32(ctrl_head, OHCIState),
2090 VMSTATE_UINT32(ctrl_cur, OHCIState),
2091 VMSTATE_UINT32(bulk_head, OHCIState),
2092 VMSTATE_UINT32(bulk_cur, OHCIState),
2093 VMSTATE_UINT32(per_cur, OHCIState),
2094 VMSTATE_UINT32(done, OHCIState),
2095 VMSTATE_INT32(done_count, OHCIState),
2096 VMSTATE_UINT16(fsmps, OHCIState),
2097 VMSTATE_UINT8(fit, OHCIState),
2098 VMSTATE_UINT16(fi, OHCIState),
2099 VMSTATE_UINT8(frt, OHCIState),
2100 VMSTATE_UINT16(frame_number, OHCIState),
2101 VMSTATE_UINT16(padding, OHCIState),
2102 VMSTATE_UINT32(pstart, OHCIState),
2103 VMSTATE_UINT32(lst, OHCIState),
2104 VMSTATE_UINT32(rhdesc_a, OHCIState),
2105 VMSTATE_UINT32(rhdesc_b, OHCIState),
2106 VMSTATE_UINT32(rhstatus, OHCIState),
2107 VMSTATE_STRUCT_ARRAY(rhport, OHCIState, OHCI_MAX_PORTS, 0,
2108 vmstate_ohci_state_port, OHCIPort),
2109 VMSTATE_UINT32(hstatus, OHCIState),
2110 VMSTATE_UINT32(hmask, OHCIState),
2111 VMSTATE_UINT32(hreset, OHCIState),
2112 VMSTATE_UINT32(htest, OHCIState),
2113 VMSTATE_UINT32(old_ctl, OHCIState),
2114 VMSTATE_UINT8_ARRAY(usb_buf, OHCIState, 8192),
2115 VMSTATE_UINT32(async_td, OHCIState),
2116 VMSTATE_BOOL(async_complete, OHCIState),
2117 VMSTATE_END_OF_LIST()
2119 .subsections = (const VMStateDescription*[]) {
2120 &vmstate_ohci_eof_timer,
2121 NULL
2125 static const VMStateDescription vmstate_ohci = {
2126 .name = "ohci",
2127 .version_id = 1,
2128 .minimum_version_id = 1,
2129 .fields = (VMStateField[]) {
2130 VMSTATE_PCI_DEVICE(parent_obj, OHCIPCIState),
2131 VMSTATE_STRUCT(state, OHCIPCIState, 1, vmstate_ohci_state, OHCIState),
2132 VMSTATE_END_OF_LIST()
2136 static void ohci_pci_class_init(ObjectClass *klass, void *data)
2138 DeviceClass *dc = DEVICE_CLASS(klass);
2139 PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
2141 k->realize = usb_ohci_realize_pci;
2142 k->exit = usb_ohci_exit;
2143 k->vendor_id = PCI_VENDOR_ID_APPLE;
2144 k->device_id = PCI_DEVICE_ID_APPLE_IPID_USB;
2145 k->class_id = PCI_CLASS_SERIAL_USB;
2146 set_bit(DEVICE_CATEGORY_USB, dc->categories);
2147 dc->desc = "Apple USB Controller";
2148 dc->props = ohci_pci_properties;
2149 dc->hotpluggable = false;
2150 dc->vmsd = &vmstate_ohci;
2151 dc->reset = usb_ohci_reset_pci;
2154 static const TypeInfo ohci_pci_info = {
2155 .name = TYPE_PCI_OHCI,
2156 .parent = TYPE_PCI_DEVICE,
2157 .instance_size = sizeof(OHCIPCIState),
2158 .class_init = ohci_pci_class_init,
2159 .interfaces = (InterfaceInfo[]) {
2160 { INTERFACE_CONVENTIONAL_PCI_DEVICE },
2161 { },
2165 static Property ohci_sysbus_properties[] = {
2166 DEFINE_PROP_STRING("masterbus", OHCISysBusState, masterbus),
2167 DEFINE_PROP_UINT32("num-ports", OHCISysBusState, num_ports, 3),
2168 DEFINE_PROP_UINT32("firstport", OHCISysBusState, firstport, 0),
2169 DEFINE_PROP_DMAADDR("dma-offset", OHCISysBusState, dma_offset, 0),
2170 DEFINE_PROP_END_OF_LIST(),
2173 static void ohci_sysbus_class_init(ObjectClass *klass, void *data)
2175 DeviceClass *dc = DEVICE_CLASS(klass);
2177 dc->realize = ohci_realize_pxa;
2178 set_bit(DEVICE_CATEGORY_USB, dc->categories);
2179 dc->desc = "OHCI USB Controller";
2180 dc->props = ohci_sysbus_properties;
2181 dc->reset = usb_ohci_reset_sysbus;
2184 static const TypeInfo ohci_sysbus_info = {
2185 .name = TYPE_SYSBUS_OHCI,
2186 .parent = TYPE_SYS_BUS_DEVICE,
2187 .instance_size = sizeof(OHCISysBusState),
2188 .class_init = ohci_sysbus_class_init,
2191 static void ohci_register_types(void)
2193 type_register_static(&ohci_pci_info);
2194 type_register_static(&ohci_sysbus_info);
2197 type_init(ohci_register_types)