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/>.
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
25 * o BIOS work to boot from USB storage
29 #include "qemu/timer.h"
31 #include "hw/pci/pci.h"
32 #include "hw/sysbus.h"
33 #include "hw/qdev-dma.h"
36 /* This causes frames to occur 1000x slower */
37 //#define OHCI_TIME_WARP 1
39 /* Number of Downstream Ports on the root hub. */
41 #define OHCI_MAX_PORTS 15
43 static int64_t usb_frame_time
;
44 static int64_t usb_bit_time
;
46 typedef struct OHCIPort
{
63 /* Control partition */
68 /* memory pointer partition */
70 uint32_t ctrl_head
, ctrl_cur
;
71 uint32_t bulk_head
, bulk_cur
;
76 /* Frame counter partition */
81 uint16_t frame_number
;
86 /* Root Hub partition */
87 uint32_t rhdesc_a
, rhdesc_b
;
89 OHCIPort rhport
[OHCI_MAX_PORTS
];
91 /* PXA27x Non-OHCI events */
97 /* SM501 local memory offset */
98 dma_addr_t localmem_base
;
100 /* Active packets. */
102 USBPacket usb_packet
;
103 uint8_t usb_buf
[8192];
109 /* Host Controller Communications Area */
115 #define HCCA_WRITEBACK_OFFSET offsetof(struct ohci_hcca, frame)
116 #define HCCA_WRITEBACK_SIZE 8 /* frame, pad, done */
118 #define ED_WBACK_OFFSET offsetof(struct ohci_ed, head)
119 #define ED_WBACK_SIZE 4
121 static void ohci_bus_stop(OHCIState
*ohci
);
122 static void ohci_async_cancel_device(OHCIState
*ohci
, USBDevice
*dev
);
124 /* Bitfields for the first word of an Endpoint Desciptor. */
125 #define OHCI_ED_FA_SHIFT 0
126 #define OHCI_ED_FA_MASK (0x7f<<OHCI_ED_FA_SHIFT)
127 #define OHCI_ED_EN_SHIFT 7
128 #define OHCI_ED_EN_MASK (0xf<<OHCI_ED_EN_SHIFT)
129 #define OHCI_ED_D_SHIFT 11
130 #define OHCI_ED_D_MASK (3<<OHCI_ED_D_SHIFT)
131 #define OHCI_ED_S (1<<13)
132 #define OHCI_ED_K (1<<14)
133 #define OHCI_ED_F (1<<15)
134 #define OHCI_ED_MPS_SHIFT 16
135 #define OHCI_ED_MPS_MASK (0x7ff<<OHCI_ED_MPS_SHIFT)
137 /* Flags in the head field of an Endpoint Desciptor. */
141 /* Bitfields for the first word of a Transfer Desciptor. */
142 #define OHCI_TD_R (1<<18)
143 #define OHCI_TD_DP_SHIFT 19
144 #define OHCI_TD_DP_MASK (3<<OHCI_TD_DP_SHIFT)
145 #define OHCI_TD_DI_SHIFT 21
146 #define OHCI_TD_DI_MASK (7<<OHCI_TD_DI_SHIFT)
147 #define OHCI_TD_T0 (1<<24)
148 #define OHCI_TD_T1 (1<<25)
149 #define OHCI_TD_EC_SHIFT 26
150 #define OHCI_TD_EC_MASK (3<<OHCI_TD_EC_SHIFT)
151 #define OHCI_TD_CC_SHIFT 28
152 #define OHCI_TD_CC_MASK (0xf<<OHCI_TD_CC_SHIFT)
154 /* Bitfields for the first word of an Isochronous Transfer Desciptor. */
155 /* CC & DI - same as in the General Transfer Desciptor */
156 #define OHCI_TD_SF_SHIFT 0
157 #define OHCI_TD_SF_MASK (0xffff<<OHCI_TD_SF_SHIFT)
158 #define OHCI_TD_FC_SHIFT 24
159 #define OHCI_TD_FC_MASK (7<<OHCI_TD_FC_SHIFT)
161 /* Isochronous Transfer Desciptor - Offset / PacketStatusWord */
162 #define OHCI_TD_PSW_CC_SHIFT 12
163 #define OHCI_TD_PSW_CC_MASK (0xf<<OHCI_TD_PSW_CC_SHIFT)
164 #define OHCI_TD_PSW_SIZE_SHIFT 0
165 #define OHCI_TD_PSW_SIZE_MASK (0xfff<<OHCI_TD_PSW_SIZE_SHIFT)
167 #define OHCI_PAGE_MASK 0xfffff000
168 #define OHCI_OFFSET_MASK 0xfff
170 #define OHCI_DPTR_MASK 0xfffffff0
172 #define OHCI_BM(val, field) \
173 (((val) & OHCI_##field##_MASK) >> OHCI_##field##_SHIFT)
175 #define OHCI_SET_BM(val, field, newval) do { \
176 val &= ~OHCI_##field##_MASK; \
177 val |= ((newval) << OHCI_##field##_SHIFT) & OHCI_##field##_MASK; \
180 /* endpoint descriptor */
188 /* General transfer descriptor */
196 /* Isochronous transfer descriptor */
205 #define USB_HZ 12000000
207 /* OHCI Local stuff */
208 #define OHCI_CTL_CBSR ((1<<0)|(1<<1))
209 #define OHCI_CTL_PLE (1<<2)
210 #define OHCI_CTL_IE (1<<3)
211 #define OHCI_CTL_CLE (1<<4)
212 #define OHCI_CTL_BLE (1<<5)
213 #define OHCI_CTL_HCFS ((1<<6)|(1<<7))
214 #define OHCI_USB_RESET 0x00
215 #define OHCI_USB_RESUME 0x40
216 #define OHCI_USB_OPERATIONAL 0x80
217 #define OHCI_USB_SUSPEND 0xc0
218 #define OHCI_CTL_IR (1<<8)
219 #define OHCI_CTL_RWC (1<<9)
220 #define OHCI_CTL_RWE (1<<10)
222 #define OHCI_STATUS_HCR (1<<0)
223 #define OHCI_STATUS_CLF (1<<1)
224 #define OHCI_STATUS_BLF (1<<2)
225 #define OHCI_STATUS_OCR (1<<3)
226 #define OHCI_STATUS_SOC ((1<<6)|(1<<7))
228 #define OHCI_INTR_SO (1U<<0) /* Scheduling overrun */
229 #define OHCI_INTR_WD (1U<<1) /* HcDoneHead writeback */
230 #define OHCI_INTR_SF (1U<<2) /* Start of frame */
231 #define OHCI_INTR_RD (1U<<3) /* Resume detect */
232 #define OHCI_INTR_UE (1U<<4) /* Unrecoverable error */
233 #define OHCI_INTR_FNO (1U<<5) /* Frame number overflow */
234 #define OHCI_INTR_RHSC (1U<<6) /* Root hub status change */
235 #define OHCI_INTR_OC (1U<<30) /* Ownership change */
236 #define OHCI_INTR_MIE (1U<<31) /* Master Interrupt Enable */
238 #define OHCI_HCCA_SIZE 0x100
239 #define OHCI_HCCA_MASK 0xffffff00
241 #define OHCI_EDPTR_MASK 0xfffffff0
243 #define OHCI_FMI_FI 0x00003fff
244 #define OHCI_FMI_FSMPS 0xffff0000
245 #define OHCI_FMI_FIT 0x80000000
247 #define OHCI_FR_RT (1U<<31)
249 #define OHCI_LS_THRESH 0x628
251 #define OHCI_RHA_RW_MASK 0x00000000 /* Mask of supported features. */
252 #define OHCI_RHA_PSM (1<<8)
253 #define OHCI_RHA_NPS (1<<9)
254 #define OHCI_RHA_DT (1<<10)
255 #define OHCI_RHA_OCPM (1<<11)
256 #define OHCI_RHA_NOCP (1<<12)
257 #define OHCI_RHA_POTPGT_MASK 0xff000000
259 #define OHCI_RHS_LPS (1U<<0)
260 #define OHCI_RHS_OCI (1U<<1)
261 #define OHCI_RHS_DRWE (1U<<15)
262 #define OHCI_RHS_LPSC (1U<<16)
263 #define OHCI_RHS_OCIC (1U<<17)
264 #define OHCI_RHS_CRWE (1U<<31)
266 #define OHCI_PORT_CCS (1<<0)
267 #define OHCI_PORT_PES (1<<1)
268 #define OHCI_PORT_PSS (1<<2)
269 #define OHCI_PORT_POCI (1<<3)
270 #define OHCI_PORT_PRS (1<<4)
271 #define OHCI_PORT_PPS (1<<8)
272 #define OHCI_PORT_LSDA (1<<9)
273 #define OHCI_PORT_CSC (1<<16)
274 #define OHCI_PORT_PESC (1<<17)
275 #define OHCI_PORT_PSSC (1<<18)
276 #define OHCI_PORT_OCIC (1<<19)
277 #define OHCI_PORT_PRSC (1<<20)
278 #define OHCI_PORT_WTC (OHCI_PORT_CSC|OHCI_PORT_PESC|OHCI_PORT_PSSC \
279 |OHCI_PORT_OCIC|OHCI_PORT_PRSC)
281 #define OHCI_TD_DIR_SETUP 0x0
282 #define OHCI_TD_DIR_OUT 0x1
283 #define OHCI_TD_DIR_IN 0x2
284 #define OHCI_TD_DIR_RESERVED 0x3
286 #define OHCI_CC_NOERROR 0x0
287 #define OHCI_CC_CRC 0x1
288 #define OHCI_CC_BITSTUFFING 0x2
289 #define OHCI_CC_DATATOGGLEMISMATCH 0x3
290 #define OHCI_CC_STALL 0x4
291 #define OHCI_CC_DEVICENOTRESPONDING 0x5
292 #define OHCI_CC_PIDCHECKFAILURE 0x6
293 #define OHCI_CC_UNDEXPETEDPID 0x7
294 #define OHCI_CC_DATAOVERRUN 0x8
295 #define OHCI_CC_DATAUNDERRUN 0x9
296 #define OHCI_CC_BUFFEROVERRUN 0xc
297 #define OHCI_CC_BUFFERUNDERRUN 0xd
299 #define OHCI_HRESET_FSBIR (1 << 0)
301 static void ohci_die(OHCIState
*ohci
);
303 /* Update IRQ levels */
304 static inline void ohci_intr_update(OHCIState
*ohci
)
308 if ((ohci
->intr
& OHCI_INTR_MIE
) &&
309 (ohci
->intr_status
& ohci
->intr
))
312 qemu_set_irq(ohci
->irq
, level
);
315 /* Set an interrupt */
316 static inline void ohci_set_interrupt(OHCIState
*ohci
, uint32_t intr
)
318 ohci
->intr_status
|= intr
;
319 ohci_intr_update(ohci
);
322 /* Attach or detach a device on a root hub port. */
323 static void ohci_attach(USBPort
*port1
)
325 OHCIState
*s
= port1
->opaque
;
326 OHCIPort
*port
= &s
->rhport
[port1
->index
];
327 uint32_t old_state
= port
->ctrl
;
329 /* set connect status */
330 port
->ctrl
|= OHCI_PORT_CCS
| OHCI_PORT_CSC
;
333 if (port
->port
.dev
->speed
== USB_SPEED_LOW
) {
334 port
->ctrl
|= OHCI_PORT_LSDA
;
336 port
->ctrl
&= ~OHCI_PORT_LSDA
;
339 /* notify of remote-wakeup */
340 if ((s
->ctl
& OHCI_CTL_HCFS
) == OHCI_USB_SUSPEND
) {
341 ohci_set_interrupt(s
, OHCI_INTR_RD
);
344 trace_usb_ohci_port_attach(port1
->index
);
346 if (old_state
!= port
->ctrl
) {
347 ohci_set_interrupt(s
, OHCI_INTR_RHSC
);
351 static void ohci_detach(USBPort
*port1
)
353 OHCIState
*s
= port1
->opaque
;
354 OHCIPort
*port
= &s
->rhport
[port1
->index
];
355 uint32_t old_state
= port
->ctrl
;
357 ohci_async_cancel_device(s
, port1
->dev
);
359 /* set connect status */
360 if (port
->ctrl
& OHCI_PORT_CCS
) {
361 port
->ctrl
&= ~OHCI_PORT_CCS
;
362 port
->ctrl
|= OHCI_PORT_CSC
;
365 if (port
->ctrl
& OHCI_PORT_PES
) {
366 port
->ctrl
&= ~OHCI_PORT_PES
;
367 port
->ctrl
|= OHCI_PORT_PESC
;
369 trace_usb_ohci_port_detach(port1
->index
);
371 if (old_state
!= port
->ctrl
) {
372 ohci_set_interrupt(s
, OHCI_INTR_RHSC
);
376 static void ohci_wakeup(USBPort
*port1
)
378 OHCIState
*s
= port1
->opaque
;
379 OHCIPort
*port
= &s
->rhport
[port1
->index
];
381 if (port
->ctrl
& OHCI_PORT_PSS
) {
382 trace_usb_ohci_port_wakeup(port1
->index
);
383 port
->ctrl
|= OHCI_PORT_PSSC
;
384 port
->ctrl
&= ~OHCI_PORT_PSS
;
385 intr
= OHCI_INTR_RHSC
;
387 /* Note that the controller can be suspended even if this port is not */
388 if ((s
->ctl
& OHCI_CTL_HCFS
) == OHCI_USB_SUSPEND
) {
389 trace_usb_ohci_remote_wakeup(s
->name
);
390 /* This is the one state transition the controller can do by itself */
391 s
->ctl
&= ~OHCI_CTL_HCFS
;
392 s
->ctl
|= OHCI_USB_RESUME
;
393 /* In suspend mode only ResumeDetected is possible, not RHSC:
394 * see the OHCI spec 5.1.2.3.
398 ohci_set_interrupt(s
, intr
);
401 static void ohci_child_detach(USBPort
*port1
, USBDevice
*child
)
403 OHCIState
*s
= port1
->opaque
;
405 ohci_async_cancel_device(s
, child
);
408 static USBDevice
*ohci_find_device(OHCIState
*ohci
, uint8_t addr
)
413 for (i
= 0; i
< ohci
->num_ports
; i
++) {
414 if ((ohci
->rhport
[i
].ctrl
& OHCI_PORT_PES
) == 0) {
417 dev
= usb_find_device(&ohci
->rhport
[i
].port
, addr
);
425 static void ohci_stop_endpoints(OHCIState
*ohci
)
430 for (i
= 0; i
< ohci
->num_ports
; i
++) {
431 dev
= ohci
->rhport
[i
].port
.dev
;
432 if (dev
&& dev
->attached
) {
433 usb_device_ep_stopped(dev
, &dev
->ep_ctl
);
434 for (j
= 0; j
< USB_MAX_ENDPOINTS
; j
++) {
435 usb_device_ep_stopped(dev
, &dev
->ep_in
[j
]);
436 usb_device_ep_stopped(dev
, &dev
->ep_out
[j
]);
442 /* Reset the controller */
443 static void ohci_reset(void *opaque
)
445 OHCIState
*ohci
= opaque
;
453 ohci
->intr_status
= 0;
454 ohci
->intr
= OHCI_INTR_MIE
;
457 ohci
->ctrl_head
= ohci
->ctrl_cur
= 0;
458 ohci
->bulk_head
= ohci
->bulk_cur
= 0;
461 ohci
->done_count
= 7;
463 /* FSMPS is marked TBD in OCHI 1.0, what gives ffs?
464 * I took the value linux sets ...
466 ohci
->fsmps
= 0x2778;
470 ohci
->frame_number
= 0;
472 ohci
->lst
= OHCI_LS_THRESH
;
474 ohci
->rhdesc_a
= OHCI_RHA_NPS
| ohci
->num_ports
;
475 ohci
->rhdesc_b
= 0x0; /* Impl. specific */
478 for (i
= 0; i
< ohci
->num_ports
; i
++)
480 port
= &ohci
->rhport
[i
];
482 if (port
->port
.dev
&& port
->port
.dev
->attached
) {
483 usb_port_reset(&port
->port
);
486 if (ohci
->async_td
) {
487 usb_cancel_packet(&ohci
->usb_packet
);
490 ohci_stop_endpoints(ohci
);
491 trace_usb_ohci_reset(ohci
->name
);
494 /* Get an array of dwords from main memory */
495 static inline int get_dwords(OHCIState
*ohci
,
496 dma_addr_t addr
, uint32_t *buf
, int num
)
500 addr
+= ohci
->localmem_base
;
502 for (i
= 0; i
< num
; i
++, buf
++, addr
+= sizeof(*buf
)) {
503 if (dma_memory_read(ohci
->as
, addr
, buf
, sizeof(*buf
))) {
506 *buf
= le32_to_cpu(*buf
);
512 /* Put an array of dwords in to main memory */
513 static inline int put_dwords(OHCIState
*ohci
,
514 dma_addr_t addr
, uint32_t *buf
, int num
)
518 addr
+= ohci
->localmem_base
;
520 for (i
= 0; i
< num
; i
++, buf
++, addr
+= sizeof(*buf
)) {
521 uint32_t tmp
= cpu_to_le32(*buf
);
522 if (dma_memory_write(ohci
->as
, addr
, &tmp
, sizeof(tmp
))) {
530 /* Get an array of words from main memory */
531 static inline int get_words(OHCIState
*ohci
,
532 dma_addr_t addr
, uint16_t *buf
, int num
)
536 addr
+= ohci
->localmem_base
;
538 for (i
= 0; i
< num
; i
++, buf
++, addr
+= sizeof(*buf
)) {
539 if (dma_memory_read(ohci
->as
, addr
, buf
, sizeof(*buf
))) {
542 *buf
= le16_to_cpu(*buf
);
548 /* Put an array of words in to main memory */
549 static inline int put_words(OHCIState
*ohci
,
550 dma_addr_t addr
, uint16_t *buf
, int num
)
554 addr
+= ohci
->localmem_base
;
556 for (i
= 0; i
< num
; i
++, buf
++, addr
+= sizeof(*buf
)) {
557 uint16_t tmp
= cpu_to_le16(*buf
);
558 if (dma_memory_write(ohci
->as
, addr
, &tmp
, sizeof(tmp
))) {
566 static inline int ohci_read_ed(OHCIState
*ohci
,
567 dma_addr_t addr
, struct ohci_ed
*ed
)
569 return get_dwords(ohci
, addr
, (uint32_t *)ed
, sizeof(*ed
) >> 2);
572 static inline int ohci_read_td(OHCIState
*ohci
,
573 dma_addr_t addr
, struct ohci_td
*td
)
575 return get_dwords(ohci
, addr
, (uint32_t *)td
, sizeof(*td
) >> 2);
578 static inline int ohci_read_iso_td(OHCIState
*ohci
,
579 dma_addr_t addr
, struct ohci_iso_td
*td
)
581 return get_dwords(ohci
, addr
, (uint32_t *)td
, 4) ||
582 get_words(ohci
, addr
+ 16, td
->offset
, 8);
585 static inline int ohci_read_hcca(OHCIState
*ohci
,
586 dma_addr_t addr
, struct ohci_hcca
*hcca
)
588 return dma_memory_read(ohci
->as
, addr
+ ohci
->localmem_base
,
589 hcca
, sizeof(*hcca
));
592 static inline int ohci_put_ed(OHCIState
*ohci
,
593 dma_addr_t addr
, struct ohci_ed
*ed
)
595 /* ed->tail is under control of the HCD.
596 * Since just ed->head is changed by HC, just write back this
599 return put_dwords(ohci
, addr
+ ED_WBACK_OFFSET
,
600 (uint32_t *)((char *)ed
+ ED_WBACK_OFFSET
),
604 static inline int ohci_put_td(OHCIState
*ohci
,
605 dma_addr_t addr
, struct ohci_td
*td
)
607 return put_dwords(ohci
, addr
, (uint32_t *)td
, sizeof(*td
) >> 2);
610 static inline int ohci_put_iso_td(OHCIState
*ohci
,
611 dma_addr_t addr
, struct ohci_iso_td
*td
)
613 return put_dwords(ohci
, addr
, (uint32_t *)td
, 4) ||
614 put_words(ohci
, addr
+ 16, td
->offset
, 8);
617 static inline int ohci_put_hcca(OHCIState
*ohci
,
618 dma_addr_t addr
, struct ohci_hcca
*hcca
)
620 return dma_memory_write(ohci
->as
,
621 addr
+ ohci
->localmem_base
+ HCCA_WRITEBACK_OFFSET
,
622 (char *)hcca
+ HCCA_WRITEBACK_OFFSET
,
623 HCCA_WRITEBACK_SIZE
);
626 /* Read/Write the contents of a TD from/to main memory. */
627 static int ohci_copy_td(OHCIState
*ohci
, struct ohci_td
*td
,
628 uint8_t *buf
, int len
, DMADirection dir
)
633 n
= 0x1000 - (ptr
& 0xfff);
637 if (dma_memory_rw(ohci
->as
, ptr
+ ohci
->localmem_base
, buf
, n
, dir
)) {
643 ptr
= td
->be
& ~0xfffu
;
645 if (dma_memory_rw(ohci
->as
, ptr
+ ohci
->localmem_base
, buf
,
652 /* Read/Write the contents of an ISO TD from/to main memory. */
653 static int ohci_copy_iso_td(OHCIState
*ohci
,
654 uint32_t start_addr
, uint32_t end_addr
,
655 uint8_t *buf
, int len
, DMADirection dir
)
660 n
= 0x1000 - (ptr
& 0xfff);
664 if (dma_memory_rw(ohci
->as
, ptr
+ ohci
->localmem_base
, buf
, n
, dir
)) {
670 ptr
= end_addr
& ~0xfffu
;
672 if (dma_memory_rw(ohci
->as
, ptr
+ ohci
->localmem_base
, buf
,
679 static void ohci_process_lists(OHCIState
*ohci
, int completion
);
681 static void ohci_async_complete_packet(USBPort
*port
, USBPacket
*packet
)
683 OHCIState
*ohci
= container_of(packet
, OHCIState
, usb_packet
);
685 trace_usb_ohci_async_complete();
686 ohci
->async_complete
= true;
687 ohci_process_lists(ohci
, 1);
690 #define USUB(a, b) ((int16_t)((uint16_t)(a) - (uint16_t)(b)))
692 static int ohci_service_iso_td(OHCIState
*ohci
, struct ohci_ed
*ed
,
697 const char *str
= NULL
;
703 struct ohci_iso_td iso_td
;
705 uint16_t starting_frame
;
706 int16_t relative_frame_number
;
708 uint32_t start_offset
, next_offset
, end_offset
= 0;
709 uint32_t start_addr
, end_addr
;
711 addr
= ed
->head
& OHCI_DPTR_MASK
;
713 if (ohci_read_iso_td(ohci
, addr
, &iso_td
)) {
714 trace_usb_ohci_iso_td_read_failed(addr
);
719 starting_frame
= OHCI_BM(iso_td
.flags
, TD_SF
);
720 frame_count
= OHCI_BM(iso_td
.flags
, TD_FC
);
721 relative_frame_number
= USUB(ohci
->frame_number
, starting_frame
);
723 trace_usb_ohci_iso_td_head(
724 ed
->head
& OHCI_DPTR_MASK
, ed
->tail
& OHCI_DPTR_MASK
,
725 iso_td
.flags
, iso_td
.bp
, iso_td
.next
, iso_td
.be
,
726 ohci
->frame_number
, starting_frame
,
727 frame_count
, relative_frame_number
);
728 trace_usb_ohci_iso_td_head_offset(
729 iso_td
.offset
[0], iso_td
.offset
[1],
730 iso_td
.offset
[2], iso_td
.offset
[3],
731 iso_td
.offset
[4], iso_td
.offset
[5],
732 iso_td
.offset
[6], iso_td
.offset
[7]);
734 if (relative_frame_number
< 0) {
735 trace_usb_ohci_iso_td_relative_frame_number_neg(relative_frame_number
);
737 } else if (relative_frame_number
> frame_count
) {
738 /* ISO TD expired - retire the TD to the Done Queue and continue with
739 the next ISO TD of the same ED */
740 trace_usb_ohci_iso_td_relative_frame_number_big(relative_frame_number
,
742 OHCI_SET_BM(iso_td
.flags
, TD_CC
, OHCI_CC_DATAOVERRUN
);
743 ed
->head
&= ~OHCI_DPTR_MASK
;
744 ed
->head
|= (iso_td
.next
& OHCI_DPTR_MASK
);
745 iso_td
.next
= ohci
->done
;
747 i
= OHCI_BM(iso_td
.flags
, TD_DI
);
748 if (i
< ohci
->done_count
)
749 ohci
->done_count
= i
;
750 if (ohci_put_iso_td(ohci
, addr
, &iso_td
)) {
757 dir
= OHCI_BM(ed
->flags
, ED_D
);
763 case OHCI_TD_DIR_OUT
:
767 case OHCI_TD_DIR_SETUP
:
769 pid
= USB_TOKEN_SETUP
;
772 trace_usb_ohci_iso_td_bad_direction(dir
);
776 if (!iso_td
.bp
|| !iso_td
.be
) {
777 trace_usb_ohci_iso_td_bad_bp_be(iso_td
.bp
, iso_td
.be
);
781 start_offset
= iso_td
.offset
[relative_frame_number
];
782 next_offset
= iso_td
.offset
[relative_frame_number
+ 1];
784 if (!(OHCI_BM(start_offset
, TD_PSW_CC
) & 0xe) ||
785 ((relative_frame_number
< frame_count
) &&
786 !(OHCI_BM(next_offset
, TD_PSW_CC
) & 0xe))) {
787 trace_usb_ohci_iso_td_bad_cc_not_accessed(start_offset
, next_offset
);
791 if ((relative_frame_number
< frame_count
) && (start_offset
> next_offset
)) {
792 trace_usb_ohci_iso_td_bad_cc_overrun(start_offset
, next_offset
);
796 if ((start_offset
& 0x1000) == 0) {
797 start_addr
= (iso_td
.bp
& OHCI_PAGE_MASK
) |
798 (start_offset
& OHCI_OFFSET_MASK
);
800 start_addr
= (iso_td
.be
& OHCI_PAGE_MASK
) |
801 (start_offset
& OHCI_OFFSET_MASK
);
804 if (relative_frame_number
< frame_count
) {
805 end_offset
= next_offset
- 1;
806 if ((end_offset
& 0x1000) == 0) {
807 end_addr
= (iso_td
.bp
& OHCI_PAGE_MASK
) |
808 (end_offset
& OHCI_OFFSET_MASK
);
810 end_addr
= (iso_td
.be
& OHCI_PAGE_MASK
) |
811 (end_offset
& OHCI_OFFSET_MASK
);
814 /* Last packet in the ISO TD */
815 end_addr
= iso_td
.be
;
818 if ((start_addr
& OHCI_PAGE_MASK
) != (end_addr
& OHCI_PAGE_MASK
)) {
819 len
= (end_addr
& OHCI_OFFSET_MASK
) + 0x1001
820 - (start_addr
& OHCI_OFFSET_MASK
);
822 len
= end_addr
- start_addr
+ 1;
825 if (len
&& dir
!= OHCI_TD_DIR_IN
) {
826 if (ohci_copy_iso_td(ohci
, start_addr
, end_addr
, ohci
->usb_buf
, len
,
827 DMA_DIRECTION_TO_DEVICE
)) {
834 bool int_req
= relative_frame_number
== frame_count
&&
835 OHCI_BM(iso_td
.flags
, TD_DI
) == 0;
836 dev
= ohci_find_device(ohci
, OHCI_BM(ed
->flags
, ED_FA
));
837 ep
= usb_ep_get(dev
, pid
, OHCI_BM(ed
->flags
, ED_EN
));
838 usb_packet_setup(&ohci
->usb_packet
, pid
, ep
, 0, addr
, false, int_req
);
839 usb_packet_addbuf(&ohci
->usb_packet
, ohci
->usb_buf
, len
);
840 usb_handle_packet(dev
, &ohci
->usb_packet
);
841 if (ohci
->usb_packet
.status
== USB_RET_ASYNC
) {
842 usb_device_flush_ep_queue(dev
, ep
);
846 if (ohci
->usb_packet
.status
== USB_RET_SUCCESS
) {
847 ret
= ohci
->usb_packet
.actual_length
;
849 ret
= ohci
->usb_packet
.status
;
852 trace_usb_ohci_iso_td_so(start_offset
, end_offset
, start_addr
, end_addr
,
856 if (dir
== OHCI_TD_DIR_IN
&& ret
>= 0 && ret
<= len
) {
857 /* IN transfer succeeded */
858 if (ohci_copy_iso_td(ohci
, start_addr
, end_addr
, ohci
->usb_buf
, ret
,
859 DMA_DIRECTION_FROM_DEVICE
)) {
863 OHCI_SET_BM(iso_td
.offset
[relative_frame_number
], TD_PSW_CC
,
865 OHCI_SET_BM(iso_td
.offset
[relative_frame_number
], TD_PSW_SIZE
, ret
);
866 } else if (dir
== OHCI_TD_DIR_OUT
&& ret
== len
) {
867 /* OUT transfer succeeded */
868 OHCI_SET_BM(iso_td
.offset
[relative_frame_number
], TD_PSW_CC
,
870 OHCI_SET_BM(iso_td
.offset
[relative_frame_number
], TD_PSW_SIZE
, 0);
872 if (ret
> (ssize_t
) len
) {
873 trace_usb_ohci_iso_td_data_overrun(ret
, len
);
874 OHCI_SET_BM(iso_td
.offset
[relative_frame_number
], TD_PSW_CC
,
875 OHCI_CC_DATAOVERRUN
);
876 OHCI_SET_BM(iso_td
.offset
[relative_frame_number
], TD_PSW_SIZE
,
878 } else if (ret
>= 0) {
879 trace_usb_ohci_iso_td_data_underrun(ret
);
880 OHCI_SET_BM(iso_td
.offset
[relative_frame_number
], TD_PSW_CC
,
881 OHCI_CC_DATAUNDERRUN
);
884 case USB_RET_IOERROR
:
886 OHCI_SET_BM(iso_td
.offset
[relative_frame_number
], TD_PSW_CC
,
887 OHCI_CC_DEVICENOTRESPONDING
);
888 OHCI_SET_BM(iso_td
.offset
[relative_frame_number
], TD_PSW_SIZE
,
893 trace_usb_ohci_iso_td_nak(ret
);
894 OHCI_SET_BM(iso_td
.offset
[relative_frame_number
], TD_PSW_CC
,
896 OHCI_SET_BM(iso_td
.offset
[relative_frame_number
], TD_PSW_SIZE
,
900 trace_usb_ohci_iso_td_bad_response(ret
);
901 OHCI_SET_BM(iso_td
.offset
[relative_frame_number
], TD_PSW_CC
,
902 OHCI_CC_UNDEXPETEDPID
);
908 if (relative_frame_number
== frame_count
) {
909 /* Last data packet of ISO TD - retire the TD to the Done Queue */
910 OHCI_SET_BM(iso_td
.flags
, TD_CC
, OHCI_CC_NOERROR
);
911 ed
->head
&= ~OHCI_DPTR_MASK
;
912 ed
->head
|= (iso_td
.next
& OHCI_DPTR_MASK
);
913 iso_td
.next
= ohci
->done
;
915 i
= OHCI_BM(iso_td
.flags
, TD_DI
);
916 if (i
< ohci
->done_count
)
917 ohci
->done_count
= i
;
919 if (ohci_put_iso_td(ohci
, addr
, &iso_td
)) {
925 #ifdef trace_event_get_state
926 static void ohci_td_pkt(const char *msg
, const uint8_t *buf
, size_t len
)
928 bool print16
= !!trace_event_get_state(TRACE_USB_OHCI_TD_PKT_SHORT
);
929 bool printall
= !!trace_event_get_state(TRACE_USB_OHCI_TD_PKT_FULL
);
930 const int width
= 16;
932 char tmp
[3 * width
+ 1];
935 if (!printall
&& !print16
) {
940 if (i
&& (!(i
% width
) || (i
== len
))) {
942 trace_usb_ohci_td_pkt_short(msg
, tmp
);
945 trace_usb_ohci_td_pkt_full(msg
, tmp
);
953 p
+= sprintf(p
, " %.2x", buf
[i
]);
957 static void ohci_td_pkt(const char *msg
, const uint8_t *buf
, size_t len
)
962 /* Service a transport descriptor.
963 Returns nonzero to terminate processing of this endpoint. */
965 static int ohci_service_td(OHCIState
*ohci
, struct ohci_ed
*ed
)
968 size_t len
= 0, pktlen
= 0;
969 const char *str
= NULL
;
980 addr
= ed
->head
& OHCI_DPTR_MASK
;
981 /* See if this TD has already been submitted to the device. */
982 completion
= (addr
== ohci
->async_td
);
983 if (completion
&& !ohci
->async_complete
) {
984 trace_usb_ohci_td_skip_async();
987 if (ohci_read_td(ohci
, addr
, &td
)) {
988 trace_usb_ohci_td_read_error(addr
);
993 dir
= OHCI_BM(ed
->flags
, ED_D
);
995 case OHCI_TD_DIR_OUT
:
1000 dir
= OHCI_BM(td
.flags
, TD_DP
);
1005 case OHCI_TD_DIR_IN
:
1009 case OHCI_TD_DIR_OUT
:
1011 pid
= USB_TOKEN_OUT
;
1013 case OHCI_TD_DIR_SETUP
:
1015 pid
= USB_TOKEN_SETUP
;
1018 trace_usb_ohci_td_bad_direction(dir
);
1021 if (td
.cbp
&& td
.be
) {
1022 if ((td
.cbp
& 0xfffff000) != (td
.be
& 0xfffff000)) {
1023 len
= (td
.be
& 0xfff) + 0x1001 - (td
.cbp
& 0xfff);
1025 len
= (td
.be
- td
.cbp
) + 1;
1029 if (len
&& dir
!= OHCI_TD_DIR_IN
) {
1030 /* The endpoint may not allow us to transfer it all now */
1031 pktlen
= (ed
->flags
& OHCI_ED_MPS_MASK
) >> OHCI_ED_MPS_SHIFT
;
1036 if (ohci_copy_td(ohci
, &td
, ohci
->usb_buf
, pktlen
,
1037 DMA_DIRECTION_TO_DEVICE
)) {
1044 flag_r
= (td
.flags
& OHCI_TD_R
) != 0;
1045 trace_usb_ohci_td_pkt_hdr(addr
, (int64_t)pktlen
, (int64_t)len
, str
,
1046 flag_r
, td
.cbp
, td
.be
);
1047 ohci_td_pkt("OUT", ohci
->usb_buf
, pktlen
);
1051 ohci
->async_complete
= false;
1053 if (ohci
->async_td
) {
1054 /* ??? The hardware should allow one active packet per
1055 endpoint. We only allow one active packet per controller.
1056 This should be sufficient as long as devices respond in a
1059 trace_usb_ohci_td_too_many_pending();
1062 dev
= ohci_find_device(ohci
, OHCI_BM(ed
->flags
, ED_FA
));
1063 ep
= usb_ep_get(dev
, pid
, OHCI_BM(ed
->flags
, ED_EN
));
1064 usb_packet_setup(&ohci
->usb_packet
, pid
, ep
, 0, addr
, !flag_r
,
1065 OHCI_BM(td
.flags
, TD_DI
) == 0);
1066 usb_packet_addbuf(&ohci
->usb_packet
, ohci
->usb_buf
, pktlen
);
1067 usb_handle_packet(dev
, &ohci
->usb_packet
);
1068 trace_usb_ohci_td_packet_status(ohci
->usb_packet
.status
);
1070 if (ohci
->usb_packet
.status
== USB_RET_ASYNC
) {
1071 usb_device_flush_ep_queue(dev
, ep
);
1072 ohci
->async_td
= addr
;
1076 if (ohci
->usb_packet
.status
== USB_RET_SUCCESS
) {
1077 ret
= ohci
->usb_packet
.actual_length
;
1079 ret
= ohci
->usb_packet
.status
;
1083 if (dir
== OHCI_TD_DIR_IN
) {
1084 if (ohci_copy_td(ohci
, &td
, ohci
->usb_buf
, ret
,
1085 DMA_DIRECTION_FROM_DEVICE
)) {
1088 ohci_td_pkt("IN", ohci
->usb_buf
, pktlen
);
1095 if (ret
== pktlen
|| (dir
== OHCI_TD_DIR_IN
&& ret
>= 0 && flag_r
)) {
1096 /* Transmission succeeded. */
1100 if ((td
.cbp
& 0xfff) + ret
> 0xfff) {
1101 td
.cbp
= (td
.be
& ~0xfff) + ((td
.cbp
+ ret
) & 0xfff);
1106 td
.flags
|= OHCI_TD_T1
;
1107 td
.flags
^= OHCI_TD_T0
;
1108 OHCI_SET_BM(td
.flags
, TD_CC
, OHCI_CC_NOERROR
);
1109 OHCI_SET_BM(td
.flags
, TD_EC
, 0);
1111 if ((dir
!= OHCI_TD_DIR_IN
) && (ret
!= len
)) {
1112 /* Partial packet transfer: TD not ready to retire yet */
1113 goto exit_no_retire
;
1116 /* Setting ED_C is part of the TD retirement process */
1117 ed
->head
&= ~OHCI_ED_C
;
1118 if (td
.flags
& OHCI_TD_T0
)
1119 ed
->head
|= OHCI_ED_C
;
1122 trace_usb_ohci_td_underrun();
1123 OHCI_SET_BM(td
.flags
, TD_CC
, OHCI_CC_DATAUNDERRUN
);
1126 case USB_RET_IOERROR
:
1128 trace_usb_ohci_td_dev_error();
1129 OHCI_SET_BM(td
.flags
, TD_CC
, OHCI_CC_DEVICENOTRESPONDING
);
1132 trace_usb_ohci_td_nak();
1135 trace_usb_ohci_td_stall();
1136 OHCI_SET_BM(td
.flags
, TD_CC
, OHCI_CC_STALL
);
1138 case USB_RET_BABBLE
:
1139 trace_usb_ohci_td_babble();
1140 OHCI_SET_BM(td
.flags
, TD_CC
, OHCI_CC_DATAOVERRUN
);
1143 trace_usb_ohci_td_bad_device_response(ret
);
1144 OHCI_SET_BM(td
.flags
, TD_CC
, OHCI_CC_UNDEXPETEDPID
);
1145 OHCI_SET_BM(td
.flags
, TD_EC
, 3);
1149 ed
->head
|= OHCI_ED_H
;
1152 /* Retire this TD */
1153 ed
->head
&= ~OHCI_DPTR_MASK
;
1154 ed
->head
|= td
.next
& OHCI_DPTR_MASK
;
1155 td
.next
= ohci
->done
;
1157 i
= OHCI_BM(td
.flags
, TD_DI
);
1158 if (i
< ohci
->done_count
)
1159 ohci
->done_count
= i
;
1161 if (ohci_put_td(ohci
, addr
, &td
)) {
1165 return OHCI_BM(td
.flags
, TD_CC
) != OHCI_CC_NOERROR
;
1168 /* Service an endpoint list. Returns nonzero if active TD were found. */
1169 static int ohci_service_ed_list(OHCIState
*ohci
, uint32_t head
, int completion
)
1181 for (cur
= head
; cur
; cur
= next_ed
) {
1182 if (ohci_read_ed(ohci
, cur
, &ed
)) {
1183 trace_usb_ohci_ed_read_error(cur
);
1188 next_ed
= ed
.next
& OHCI_DPTR_MASK
;
1190 if ((ed
.head
& OHCI_ED_H
) || (ed
.flags
& OHCI_ED_K
)) {
1192 /* Cancel pending packets for ED that have been paused. */
1193 addr
= ed
.head
& OHCI_DPTR_MASK
;
1194 if (ohci
->async_td
&& addr
== ohci
->async_td
) {
1195 usb_cancel_packet(&ohci
->usb_packet
);
1197 usb_device_ep_stopped(ohci
->usb_packet
.ep
->dev
,
1198 ohci
->usb_packet
.ep
);
1203 while ((ed
.head
& OHCI_DPTR_MASK
) != ed
.tail
) {
1204 trace_usb_ohci_ed_pkt(cur
, (ed
.head
& OHCI_ED_H
) != 0,
1205 (ed
.head
& OHCI_ED_C
) != 0, ed
.head
& OHCI_DPTR_MASK
,
1206 ed
.tail
& OHCI_DPTR_MASK
, ed
.next
& OHCI_DPTR_MASK
);
1207 trace_usb_ohci_ed_pkt_flags(
1208 OHCI_BM(ed
.flags
, ED_FA
), OHCI_BM(ed
.flags
, ED_EN
),
1209 OHCI_BM(ed
.flags
, ED_D
), (ed
.flags
& OHCI_ED_S
)!= 0,
1210 (ed
.flags
& OHCI_ED_K
) != 0, (ed
.flags
& OHCI_ED_F
) != 0,
1211 OHCI_BM(ed
.flags
, ED_MPS
));
1215 if ((ed
.flags
& OHCI_ED_F
) == 0) {
1216 if (ohci_service_td(ohci
, &ed
))
1219 /* Handle isochronous endpoints */
1220 if (ohci_service_iso_td(ohci
, &ed
, completion
))
1225 if (ohci_put_ed(ohci
, cur
, &ed
)) {
1234 /* Generate a SOF event, and set a timer for EOF */
1235 static void ohci_sof(OHCIState
*ohci
)
1237 ohci
->sof_time
= qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL
);
1238 timer_mod(ohci
->eof_timer
, ohci
->sof_time
+ usb_frame_time
);
1239 ohci_set_interrupt(ohci
, OHCI_INTR_SF
);
1242 /* Process Control and Bulk lists. */
1243 static void ohci_process_lists(OHCIState
*ohci
, int completion
)
1245 if ((ohci
->ctl
& OHCI_CTL_CLE
) && (ohci
->status
& OHCI_STATUS_CLF
)) {
1246 if (ohci
->ctrl_cur
&& ohci
->ctrl_cur
!= ohci
->ctrl_head
) {
1247 trace_usb_ohci_process_lists(ohci
->ctrl_head
, ohci
->ctrl_cur
);
1249 if (!ohci_service_ed_list(ohci
, ohci
->ctrl_head
, completion
)) {
1251 ohci
->status
&= ~OHCI_STATUS_CLF
;
1255 if ((ohci
->ctl
& OHCI_CTL_BLE
) && (ohci
->status
& OHCI_STATUS_BLF
)) {
1256 if (!ohci_service_ed_list(ohci
, ohci
->bulk_head
, completion
)) {
1258 ohci
->status
&= ~OHCI_STATUS_BLF
;
1263 /* Do frame processing on frame boundary */
1264 static void ohci_frame_boundary(void *opaque
)
1266 OHCIState
*ohci
= opaque
;
1267 struct ohci_hcca hcca
;
1269 if (ohci_read_hcca(ohci
, ohci
->hcca
, &hcca
)) {
1270 trace_usb_ohci_hcca_read_error(ohci
->hcca
);
1275 /* Process all the lists at the end of the frame */
1276 if (ohci
->ctl
& OHCI_CTL_PLE
) {
1279 n
= ohci
->frame_number
& 0x1f;
1280 ohci_service_ed_list(ohci
, le32_to_cpu(hcca
.intr
[n
]), 0);
1283 /* Cancel all pending packets if either of the lists has been disabled. */
1284 if (ohci
->old_ctl
& (~ohci
->ctl
) & (OHCI_CTL_BLE
| OHCI_CTL_CLE
)) {
1285 if (ohci
->async_td
) {
1286 usb_cancel_packet(&ohci
->usb_packet
);
1289 ohci_stop_endpoints(ohci
);
1291 ohci
->old_ctl
= ohci
->ctl
;
1292 ohci_process_lists(ohci
, 0);
1294 /* Stop if UnrecoverableError happened or ohci_sof will crash */
1295 if (ohci
->intr_status
& OHCI_INTR_UE
) {
1299 /* Frame boundary, so do EOF stuf here */
1300 ohci
->frt
= ohci
->fit
;
1302 /* Increment frame number and take care of endianness. */
1303 ohci
->frame_number
= (ohci
->frame_number
+ 1) & 0xffff;
1304 hcca
.frame
= cpu_to_le16(ohci
->frame_number
);
1306 if (ohci
->done_count
== 0 && !(ohci
->intr_status
& OHCI_INTR_WD
)) {
1309 if (ohci
->intr
& ohci
->intr_status
)
1311 hcca
.done
= cpu_to_le32(ohci
->done
);
1313 ohci
->done_count
= 7;
1314 ohci_set_interrupt(ohci
, OHCI_INTR_WD
);
1317 if (ohci
->done_count
!= 7 && ohci
->done_count
!= 0)
1320 /* Do SOF stuff here */
1323 /* Writeback HCCA */
1324 if (ohci_put_hcca(ohci
, ohci
->hcca
, &hcca
)) {
1329 /* Start sending SOF tokens across the USB bus, lists are processed in
1332 static int ohci_bus_start(OHCIState
*ohci
)
1334 ohci
->eof_timer
= timer_new_ns(QEMU_CLOCK_VIRTUAL
,
1335 ohci_frame_boundary
,
1338 if (ohci
->eof_timer
== NULL
) {
1339 trace_usb_ohci_bus_eof_timer_failed(ohci
->name
);
1344 trace_usb_ohci_start(ohci
->name
);
1351 /* Stop sending SOF tokens on the bus */
1352 static void ohci_bus_stop(OHCIState
*ohci
)
1354 trace_usb_ohci_stop(ohci
->name
);
1355 if (ohci
->eof_timer
) {
1356 timer_del(ohci
->eof_timer
);
1357 timer_free(ohci
->eof_timer
);
1359 ohci
->eof_timer
= NULL
;
1362 /* Sets a flag in a port status register but only set it if the port is
1363 * connected, if not set ConnectStatusChange flag. If flag is enabled
1366 static int ohci_port_set_if_connected(OHCIState
*ohci
, int i
, uint32_t val
)
1370 /* writing a 0 has no effect */
1374 /* If CurrentConnectStatus is cleared we set
1375 * ConnectStatusChange
1377 if (!(ohci
->rhport
[i
].ctrl
& OHCI_PORT_CCS
)) {
1378 ohci
->rhport
[i
].ctrl
|= OHCI_PORT_CSC
;
1379 if (ohci
->rhstatus
& OHCI_RHS_DRWE
) {
1380 /* TODO: CSC is a wakeup event */
1385 if (ohci
->rhport
[i
].ctrl
& val
)
1389 ohci
->rhport
[i
].ctrl
|= val
;
1394 /* Set the frame interval - frame interval toggle is manipulated by the hcd only */
1395 static void ohci_set_frame_interval(OHCIState
*ohci
, uint16_t val
)
1399 if (val
!= ohci
->fi
) {
1400 trace_usb_ohci_set_frame_interval(ohci
->name
, ohci
->fi
, ohci
->fi
);
1406 static void ohci_port_power(OHCIState
*ohci
, int i
, int p
)
1409 ohci
->rhport
[i
].ctrl
|= OHCI_PORT_PPS
;
1411 ohci
->rhport
[i
].ctrl
&= ~(OHCI_PORT_PPS
|
1418 /* Set HcControlRegister */
1419 static void ohci_set_ctl(OHCIState
*ohci
, uint32_t val
)
1424 old_state
= ohci
->ctl
& OHCI_CTL_HCFS
;
1426 new_state
= ohci
->ctl
& OHCI_CTL_HCFS
;
1428 /* no state change */
1429 if (old_state
== new_state
)
1432 trace_usb_ohci_set_ctl(ohci
->name
, new_state
);
1433 switch (new_state
) {
1434 case OHCI_USB_OPERATIONAL
:
1435 ohci_bus_start(ohci
);
1437 case OHCI_USB_SUSPEND
:
1438 ohci_bus_stop(ohci
);
1440 case OHCI_USB_RESUME
:
1441 trace_usb_ohci_resume(ohci
->name
);
1443 case OHCI_USB_RESET
:
1449 static uint32_t ohci_get_frame_remaining(OHCIState
*ohci
)
1454 if ((ohci
->ctl
& OHCI_CTL_HCFS
) != OHCI_USB_OPERATIONAL
)
1455 return (ohci
->frt
<< 31);
1457 /* Being in USB operational state guarnatees sof_time was
1460 tks
= qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL
) - ohci
->sof_time
;
1462 /* avoid muldiv if possible */
1463 if (tks
>= usb_frame_time
)
1464 return (ohci
->frt
<< 31);
1466 tks
= muldiv64(1, tks
, usb_bit_time
);
1467 fr
= (uint16_t)(ohci
->fi
- tks
);
1469 return (ohci
->frt
<< 31) | fr
;
1473 /* Set root hub status */
1474 static void ohci_set_hub_status(OHCIState
*ohci
, uint32_t val
)
1478 old_state
= ohci
->rhstatus
;
1480 /* write 1 to clear OCIC */
1481 if (val
& OHCI_RHS_OCIC
)
1482 ohci
->rhstatus
&= ~OHCI_RHS_OCIC
;
1484 if (val
& OHCI_RHS_LPS
) {
1487 for (i
= 0; i
< ohci
->num_ports
; i
++)
1488 ohci_port_power(ohci
, i
, 0);
1489 trace_usb_ohci_hub_power_down();
1492 if (val
& OHCI_RHS_LPSC
) {
1495 for (i
= 0; i
< ohci
->num_ports
; i
++)
1496 ohci_port_power(ohci
, i
, 1);
1497 trace_usb_ohci_hub_power_up();
1500 if (val
& OHCI_RHS_DRWE
)
1501 ohci
->rhstatus
|= OHCI_RHS_DRWE
;
1503 if (val
& OHCI_RHS_CRWE
)
1504 ohci
->rhstatus
&= ~OHCI_RHS_DRWE
;
1506 if (old_state
!= ohci
->rhstatus
)
1507 ohci_set_interrupt(ohci
, OHCI_INTR_RHSC
);
1510 /* Set root hub port status */
1511 static void ohci_port_set_status(OHCIState
*ohci
, int portnum
, uint32_t val
)
1516 port
= &ohci
->rhport
[portnum
];
1517 old_state
= port
->ctrl
;
1519 /* Write to clear CSC, PESC, PSSC, OCIC, PRSC */
1520 if (val
& OHCI_PORT_WTC
)
1521 port
->ctrl
&= ~(val
& OHCI_PORT_WTC
);
1523 if (val
& OHCI_PORT_CCS
)
1524 port
->ctrl
&= ~OHCI_PORT_PES
;
1526 ohci_port_set_if_connected(ohci
, portnum
, val
& OHCI_PORT_PES
);
1528 if (ohci_port_set_if_connected(ohci
, portnum
, val
& OHCI_PORT_PSS
)) {
1529 trace_usb_ohci_port_suspend(portnum
);
1532 if (ohci_port_set_if_connected(ohci
, portnum
, val
& OHCI_PORT_PRS
)) {
1533 trace_usb_ohci_port_reset(portnum
);
1534 usb_device_reset(port
->port
.dev
);
1535 port
->ctrl
&= ~OHCI_PORT_PRS
;
1536 /* ??? Should this also set OHCI_PORT_PESC. */
1537 port
->ctrl
|= OHCI_PORT_PES
| OHCI_PORT_PRSC
;
1540 /* Invert order here to ensure in ambiguous case, device is
1543 if (val
& OHCI_PORT_LSDA
)
1544 ohci_port_power(ohci
, portnum
, 0);
1545 if (val
& OHCI_PORT_PPS
)
1546 ohci_port_power(ohci
, portnum
, 1);
1548 if (old_state
!= port
->ctrl
)
1549 ohci_set_interrupt(ohci
, OHCI_INTR_RHSC
);
1552 static uint64_t ohci_mem_read(void *opaque
,
1556 OHCIState
*ohci
= opaque
;
1559 /* Only aligned reads are allowed on OHCI */
1561 trace_usb_ohci_mem_read_unaligned(addr
);
1563 } else if (addr
>= 0x54 && addr
< 0x54 + ohci
->num_ports
* 4) {
1564 /* HcRhPortStatus */
1565 retval
= ohci
->rhport
[(addr
- 0x54) >> 2].ctrl
| OHCI_PORT_PPS
;
1567 switch (addr
>> 2) {
1568 case 0: /* HcRevision */
1572 case 1: /* HcControl */
1576 case 2: /* HcCommandStatus */
1577 retval
= ohci
->status
;
1580 case 3: /* HcInterruptStatus */
1581 retval
= ohci
->intr_status
;
1584 case 4: /* HcInterruptEnable */
1585 case 5: /* HcInterruptDisable */
1586 retval
= ohci
->intr
;
1589 case 6: /* HcHCCA */
1590 retval
= ohci
->hcca
;
1593 case 7: /* HcPeriodCurrentED */
1594 retval
= ohci
->per_cur
;
1597 case 8: /* HcControlHeadED */
1598 retval
= ohci
->ctrl_head
;
1601 case 9: /* HcControlCurrentED */
1602 retval
= ohci
->ctrl_cur
;
1605 case 10: /* HcBulkHeadED */
1606 retval
= ohci
->bulk_head
;
1609 case 11: /* HcBulkCurrentED */
1610 retval
= ohci
->bulk_cur
;
1613 case 12: /* HcDoneHead */
1614 retval
= ohci
->done
;
1617 case 13: /* HcFmInterretval */
1618 retval
= (ohci
->fit
<< 31) | (ohci
->fsmps
<< 16) | (ohci
->fi
);
1621 case 14: /* HcFmRemaining */
1622 retval
= ohci_get_frame_remaining(ohci
);
1625 case 15: /* HcFmNumber */
1626 retval
= ohci
->frame_number
;
1629 case 16: /* HcPeriodicStart */
1630 retval
= ohci
->pstart
;
1633 case 17: /* HcLSThreshold */
1637 case 18: /* HcRhDescriptorA */
1638 retval
= ohci
->rhdesc_a
;
1641 case 19: /* HcRhDescriptorB */
1642 retval
= ohci
->rhdesc_b
;
1645 case 20: /* HcRhStatus */
1646 retval
= ohci
->rhstatus
;
1649 /* PXA27x specific registers */
1650 case 24: /* HcStatus */
1651 retval
= ohci
->hstatus
& ohci
->hmask
;
1654 case 25: /* HcHReset */
1655 retval
= ohci
->hreset
;
1658 case 26: /* HcHInterruptEnable */
1659 retval
= ohci
->hmask
;
1662 case 27: /* HcHInterruptTest */
1663 retval
= ohci
->htest
;
1667 trace_usb_ohci_mem_read_bad_offset(addr
);
1668 retval
= 0xffffffff;
1675 static void ohci_mem_write(void *opaque
,
1680 OHCIState
*ohci
= opaque
;
1682 /* Only aligned reads are allowed on OHCI */
1684 trace_usb_ohci_mem_write_unaligned(addr
);
1688 if (addr
>= 0x54 && addr
< 0x54 + ohci
->num_ports
* 4) {
1689 /* HcRhPortStatus */
1690 ohci_port_set_status(ohci
, (addr
- 0x54) >> 2, val
);
1694 switch (addr
>> 2) {
1695 case 1: /* HcControl */
1696 ohci_set_ctl(ohci
, val
);
1699 case 2: /* HcCommandStatus */
1700 /* SOC is read-only */
1701 val
= (val
& ~OHCI_STATUS_SOC
);
1703 /* Bits written as '0' remain unchanged in the register */
1704 ohci
->status
|= val
;
1706 if (ohci
->status
& OHCI_STATUS_HCR
)
1710 case 3: /* HcInterruptStatus */
1711 ohci
->intr_status
&= ~val
;
1712 ohci_intr_update(ohci
);
1715 case 4: /* HcInterruptEnable */
1717 ohci_intr_update(ohci
);
1720 case 5: /* HcInterruptDisable */
1722 ohci_intr_update(ohci
);
1725 case 6: /* HcHCCA */
1726 ohci
->hcca
= val
& OHCI_HCCA_MASK
;
1729 case 7: /* HcPeriodCurrentED */
1730 /* Ignore writes to this read-only register, Linux does them */
1733 case 8: /* HcControlHeadED */
1734 ohci
->ctrl_head
= val
& OHCI_EDPTR_MASK
;
1737 case 9: /* HcControlCurrentED */
1738 ohci
->ctrl_cur
= val
& OHCI_EDPTR_MASK
;
1741 case 10: /* HcBulkHeadED */
1742 ohci
->bulk_head
= val
& OHCI_EDPTR_MASK
;
1745 case 11: /* HcBulkCurrentED */
1746 ohci
->bulk_cur
= val
& OHCI_EDPTR_MASK
;
1749 case 13: /* HcFmInterval */
1750 ohci
->fsmps
= (val
& OHCI_FMI_FSMPS
) >> 16;
1751 ohci
->fit
= (val
& OHCI_FMI_FIT
) >> 31;
1752 ohci_set_frame_interval(ohci
, val
);
1755 case 15: /* HcFmNumber */
1758 case 16: /* HcPeriodicStart */
1759 ohci
->pstart
= val
& 0xffff;
1762 case 17: /* HcLSThreshold */
1763 ohci
->lst
= val
& 0xffff;
1766 case 18: /* HcRhDescriptorA */
1767 ohci
->rhdesc_a
&= ~OHCI_RHA_RW_MASK
;
1768 ohci
->rhdesc_a
|= val
& OHCI_RHA_RW_MASK
;
1771 case 19: /* HcRhDescriptorB */
1774 case 20: /* HcRhStatus */
1775 ohci_set_hub_status(ohci
, val
);
1778 /* PXA27x specific registers */
1779 case 24: /* HcStatus */
1780 ohci
->hstatus
&= ~(val
& ohci
->hmask
);
1783 case 25: /* HcHReset */
1784 ohci
->hreset
= val
& ~OHCI_HRESET_FSBIR
;
1785 if (val
& OHCI_HRESET_FSBIR
)
1789 case 26: /* HcHInterruptEnable */
1793 case 27: /* HcHInterruptTest */
1798 trace_usb_ohci_mem_write_bad_offset(addr
);
1803 static void ohci_async_cancel_device(OHCIState
*ohci
, USBDevice
*dev
)
1805 if (ohci
->async_td
&&
1806 usb_packet_is_inflight(&ohci
->usb_packet
) &&
1807 ohci
->usb_packet
.ep
->dev
== dev
) {
1808 usb_cancel_packet(&ohci
->usb_packet
);
1813 static const MemoryRegionOps ohci_mem_ops
= {
1814 .read
= ohci_mem_read
,
1815 .write
= ohci_mem_write
,
1816 .endianness
= DEVICE_LITTLE_ENDIAN
,
1819 static USBPortOps ohci_port_ops
= {
1820 .attach
= ohci_attach
,
1821 .detach
= ohci_detach
,
1822 .child_detach
= ohci_child_detach
,
1823 .wakeup
= ohci_wakeup
,
1824 .complete
= ohci_async_complete_packet
,
1827 static USBBusOps ohci_bus_ops
= {
1830 static void usb_ohci_init(OHCIState
*ohci
, DeviceState
*dev
,
1831 int num_ports
, dma_addr_t localmem_base
,
1832 char *masterbus
, uint32_t firstport
,
1833 AddressSpace
*as
, Error
**errp
)
1840 if (usb_frame_time
== 0) {
1841 #ifdef OHCI_TIME_WARP
1842 usb_frame_time
= get_ticks_per_sec();
1843 usb_bit_time
= muldiv64(1, get_ticks_per_sec(), USB_HZ
/1000);
1845 usb_frame_time
= muldiv64(1, get_ticks_per_sec(), 1000);
1846 if (get_ticks_per_sec() >= USB_HZ
) {
1847 usb_bit_time
= muldiv64(1, get_ticks_per_sec(), USB_HZ
);
1852 trace_usb_ohci_init_time(usb_frame_time
, usb_bit_time
);
1855 ohci
->num_ports
= num_ports
;
1857 USBPort
*ports
[OHCI_MAX_PORTS
];
1858 for(i
= 0; i
< num_ports
; i
++) {
1859 ports
[i
] = &ohci
->rhport
[i
].port
;
1861 usb_register_companion(masterbus
, ports
, num_ports
,
1862 firstport
, ohci
, &ohci_port_ops
,
1863 USB_SPEED_MASK_LOW
| USB_SPEED_MASK_FULL
,
1866 error_propagate(errp
, err
);
1870 usb_bus_new(&ohci
->bus
, sizeof(ohci
->bus
), &ohci_bus_ops
, dev
);
1871 for (i
= 0; i
< num_ports
; i
++) {
1872 usb_register_port(&ohci
->bus
, &ohci
->rhport
[i
].port
,
1873 ohci
, i
, &ohci_port_ops
,
1874 USB_SPEED_MASK_LOW
| USB_SPEED_MASK_FULL
);
1878 memory_region_init_io(&ohci
->mem
, OBJECT(dev
), &ohci_mem_ops
,
1880 ohci
->localmem_base
= localmem_base
;
1882 ohci
->name
= object_get_typename(OBJECT(dev
));
1883 usb_packet_init(&ohci
->usb_packet
);
1888 #define TYPE_PCI_OHCI "pci-ohci"
1889 #define PCI_OHCI(obj) OBJECT_CHECK(OHCIPCIState, (obj), TYPE_PCI_OHCI)
1893 PCIDevice parent_obj
;
1902 /** A typical O/EHCI will stop operating, set itself into error state
1903 * (which can be queried by MMIO) and will set PERR in its config
1904 * space to signal that it got an error
1906 static void ohci_die(OHCIState
*ohci
)
1908 OHCIPCIState
*dev
= container_of(ohci
, OHCIPCIState
, state
);
1910 trace_usb_ohci_die();
1912 ohci_set_interrupt(ohci
, OHCI_INTR_UE
);
1913 ohci_bus_stop(ohci
);
1914 pci_set_word(dev
->parent_obj
.config
+ PCI_STATUS
,
1915 PCI_STATUS_DETECTED_PARITY
);
1918 static void usb_ohci_realize_pci(PCIDevice
*dev
, Error
**errp
)
1921 OHCIPCIState
*ohci
= PCI_OHCI(dev
);
1923 dev
->config
[PCI_CLASS_PROG
] = 0x10; /* OHCI */
1924 dev
->config
[PCI_INTERRUPT_PIN
] = 0x01; /* interrupt pin A */
1926 usb_ohci_init(&ohci
->state
, DEVICE(dev
), ohci
->num_ports
, 0,
1927 ohci
->masterbus
, ohci
->firstport
,
1928 pci_get_address_space(dev
), &err
);
1930 error_propagate(errp
, err
);
1934 ohci
->state
.irq
= pci_allocate_irq(dev
);
1935 pci_register_bar(dev
, 0, 0, &ohci
->state
.mem
);
1938 static void usb_ohci_exit(PCIDevice
*dev
)
1940 OHCIPCIState
*ohci
= PCI_OHCI(dev
);
1941 OHCIState
*s
= &ohci
->state
;
1943 trace_usb_ohci_exit(s
->name
);
1947 usb_cancel_packet(&s
->usb_packet
);
1950 ohci_stop_endpoints(s
);
1952 if (!ohci
->masterbus
) {
1953 usb_bus_release(&s
->bus
);
1957 static void usb_ohci_reset_pci(DeviceState
*d
)
1959 PCIDevice
*dev
= PCI_DEVICE(d
);
1960 OHCIPCIState
*ohci
= PCI_OHCI(dev
);
1961 OHCIState
*s
= &ohci
->state
;
1966 #define TYPE_SYSBUS_OHCI "sysbus-ohci"
1967 #define SYSBUS_OHCI(obj) OBJECT_CHECK(OHCISysBusState, (obj), TYPE_SYSBUS_OHCI)
1971 SysBusDevice parent_obj
;
1976 dma_addr_t dma_offset
;
1979 static void ohci_realize_pxa(DeviceState
*dev
, Error
**errp
)
1981 OHCISysBusState
*s
= SYSBUS_OHCI(dev
);
1982 SysBusDevice
*sbd
= SYS_BUS_DEVICE(dev
);
1984 /* Cannot fail as we pass NULL for masterbus */
1985 usb_ohci_init(&s
->ohci
, dev
, s
->num_ports
, s
->dma_offset
, NULL
, 0,
1986 &address_space_memory
, &error_abort
);
1987 sysbus_init_irq(sbd
, &s
->ohci
.irq
);
1988 sysbus_init_mmio(sbd
, &s
->ohci
.mem
);
1991 static void usb_ohci_reset_sysbus(DeviceState
*dev
)
1993 OHCISysBusState
*s
= SYSBUS_OHCI(dev
);
1994 OHCIState
*ohci
= &s
->ohci
;
1999 static Property ohci_pci_properties
[] = {
2000 DEFINE_PROP_STRING("masterbus", OHCIPCIState
, masterbus
),
2001 DEFINE_PROP_UINT32("num-ports", OHCIPCIState
, num_ports
, 3),
2002 DEFINE_PROP_UINT32("firstport", OHCIPCIState
, firstport
, 0),
2003 DEFINE_PROP_END_OF_LIST(),
2006 static const VMStateDescription vmstate_ohci_state_port
= {
2007 .name
= "ohci-core/port",
2009 .minimum_version_id
= 1,
2010 .fields
= (VMStateField
[]) {
2011 VMSTATE_UINT32(ctrl
, OHCIPort
),
2012 VMSTATE_END_OF_LIST()
2016 static bool ohci_eof_timer_needed(void *opaque
)
2018 OHCIState
*ohci
= opaque
;
2020 return ohci
->eof_timer
!= NULL
;
2023 static int ohci_eof_timer_pre_load(void *opaque
)
2025 OHCIState
*ohci
= opaque
;
2027 ohci_bus_start(ohci
);
2032 static const VMStateDescription vmstate_ohci_eof_timer
= {
2033 .name
= "ohci-core/eof-timer",
2035 .minimum_version_id
= 1,
2036 .pre_load
= ohci_eof_timer_pre_load
,
2037 .fields
= (VMStateField
[]) {
2038 VMSTATE_TIMER_PTR(eof_timer
, OHCIState
),
2039 VMSTATE_END_OF_LIST()
2043 static const VMStateDescription vmstate_ohci_state
= {
2044 .name
= "ohci-core",
2046 .minimum_version_id
= 1,
2047 .fields
= (VMStateField
[]) {
2048 VMSTATE_INT64(sof_time
, OHCIState
),
2049 VMSTATE_UINT32(ctl
, OHCIState
),
2050 VMSTATE_UINT32(status
, OHCIState
),
2051 VMSTATE_UINT32(intr_status
, OHCIState
),
2052 VMSTATE_UINT32(intr
, OHCIState
),
2053 VMSTATE_UINT32(hcca
, OHCIState
),
2054 VMSTATE_UINT32(ctrl_head
, OHCIState
),
2055 VMSTATE_UINT32(ctrl_cur
, OHCIState
),
2056 VMSTATE_UINT32(bulk_head
, OHCIState
),
2057 VMSTATE_UINT32(bulk_cur
, OHCIState
),
2058 VMSTATE_UINT32(per_cur
, OHCIState
),
2059 VMSTATE_UINT32(done
, OHCIState
),
2060 VMSTATE_INT32(done_count
, OHCIState
),
2061 VMSTATE_UINT16(fsmps
, OHCIState
),
2062 VMSTATE_UINT8(fit
, OHCIState
),
2063 VMSTATE_UINT16(fi
, OHCIState
),
2064 VMSTATE_UINT8(frt
, OHCIState
),
2065 VMSTATE_UINT16(frame_number
, OHCIState
),
2066 VMSTATE_UINT16(padding
, OHCIState
),
2067 VMSTATE_UINT32(pstart
, OHCIState
),
2068 VMSTATE_UINT32(lst
, OHCIState
),
2069 VMSTATE_UINT32(rhdesc_a
, OHCIState
),
2070 VMSTATE_UINT32(rhdesc_b
, OHCIState
),
2071 VMSTATE_UINT32(rhstatus
, OHCIState
),
2072 VMSTATE_STRUCT_ARRAY(rhport
, OHCIState
, OHCI_MAX_PORTS
, 0,
2073 vmstate_ohci_state_port
, OHCIPort
),
2074 VMSTATE_UINT32(hstatus
, OHCIState
),
2075 VMSTATE_UINT32(hmask
, OHCIState
),
2076 VMSTATE_UINT32(hreset
, OHCIState
),
2077 VMSTATE_UINT32(htest
, OHCIState
),
2078 VMSTATE_UINT32(old_ctl
, OHCIState
),
2079 VMSTATE_UINT8_ARRAY(usb_buf
, OHCIState
, 8192),
2080 VMSTATE_UINT32(async_td
, OHCIState
),
2081 VMSTATE_BOOL(async_complete
, OHCIState
),
2082 VMSTATE_END_OF_LIST()
2084 .subsections
= (VMStateSubsection
[]) {
2086 .vmsd
= &vmstate_ohci_eof_timer
,
2087 .needed
= ohci_eof_timer_needed
,
2094 static const VMStateDescription vmstate_ohci
= {
2097 .minimum_version_id
= 1,
2098 .fields
= (VMStateField
[]) {
2099 VMSTATE_PCI_DEVICE(parent_obj
, OHCIPCIState
),
2100 VMSTATE_STRUCT(state
, OHCIPCIState
, 1, vmstate_ohci_state
, OHCIState
),
2101 VMSTATE_END_OF_LIST()
2105 static void ohci_pci_class_init(ObjectClass
*klass
, void *data
)
2107 DeviceClass
*dc
= DEVICE_CLASS(klass
);
2108 PCIDeviceClass
*k
= PCI_DEVICE_CLASS(klass
);
2110 k
->realize
= usb_ohci_realize_pci
;
2111 k
->exit
= usb_ohci_exit
;
2112 k
->vendor_id
= PCI_VENDOR_ID_APPLE
;
2113 k
->device_id
= PCI_DEVICE_ID_APPLE_IPID_USB
;
2114 k
->class_id
= PCI_CLASS_SERIAL_USB
;
2115 set_bit(DEVICE_CATEGORY_USB
, dc
->categories
);
2116 dc
->desc
= "Apple USB Controller";
2117 dc
->props
= ohci_pci_properties
;
2118 dc
->hotpluggable
= false;
2119 dc
->vmsd
= &vmstate_ohci
;
2120 dc
->reset
= usb_ohci_reset_pci
;
2123 static const TypeInfo ohci_pci_info
= {
2124 .name
= TYPE_PCI_OHCI
,
2125 .parent
= TYPE_PCI_DEVICE
,
2126 .instance_size
= sizeof(OHCIPCIState
),
2127 .class_init
= ohci_pci_class_init
,
2130 static Property ohci_sysbus_properties
[] = {
2131 DEFINE_PROP_UINT32("num-ports", OHCISysBusState
, num_ports
, 3),
2132 DEFINE_PROP_DMAADDR("dma-offset", OHCISysBusState
, dma_offset
, 3),
2133 DEFINE_PROP_END_OF_LIST(),
2136 static void ohci_sysbus_class_init(ObjectClass
*klass
, void *data
)
2138 DeviceClass
*dc
= DEVICE_CLASS(klass
);
2140 dc
->realize
= ohci_realize_pxa
;
2141 set_bit(DEVICE_CATEGORY_USB
, dc
->categories
);
2142 dc
->desc
= "OHCI USB Controller";
2143 dc
->props
= ohci_sysbus_properties
;
2144 dc
->reset
= usb_ohci_reset_sysbus
;
2147 static const TypeInfo ohci_sysbus_info
= {
2148 .name
= TYPE_SYSBUS_OHCI
,
2149 .parent
= TYPE_SYS_BUS_DEVICE
,
2150 .instance_size
= sizeof(OHCISysBusState
),
2151 .class_init
= ohci_sysbus_class_init
,
2154 static void ohci_register_types(void)
2156 type_register_static(&ohci_pci_info
);
2157 type_register_static(&ohci_sysbus_info
);
2160 type_init(ohci_register_types
)