motorhead/qemu
1
0
Fork 0
mirror of https://github.com/Motorhead1991/qemu.git synced 2025-08-10 02:54:58 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions

hw/usb/ohci: Code style fix comments

Browse source 
Signed-off-by: BALATON Zoltan <balaton@eik.bme.hu>
Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
Message-Id: <9b0aadedc7c4780fefdc27f14f72ac9003032fbf.1676916639.git.balaton@eik.bme.hu>
Signed-off-by: Philippe Mathieu-Daudé <philmd@linaro.org>
This commit is contained in:
BALATON Zoltan 2023-02-20 19:15:04 +01:00 • committed by Philippe Mathieu-Daudé
parent 4713720a78
commit 572a673214
1 changed files with 49 additions and 50 deletions
Download patch file Download diff file Expand all files Collapse all files

99
hw/usb/hcd-ohci.c
View file

@ -23,7 +23,7 @@
* o Disable timers when nothing needs to be done, or remove timer usage * o Disable timers when nothing needs to be done, or remove timer usage
* all together. * all together.
* o BIOS work to boot from USB storage * o BIOS work to boot from USB storage
*/ */
#include "qemu/osdep.h" #include "qemu/osdep.h"
#include "hw/irq.h" #include "hw/irq.h"
@ -39,7 +39,7 @@
#include "hcd-ohci.h" #include "hcd-ohci.h"
/* This causes frames to occur 1000x slower */ /* This causes frames to occur 1000x slower */
//#define OHCI_TIME_WARP 1 /*#define OHCI_TIME_WARP 1*/
#define ED_LINK_LIMIT 32 #define ED_LINK_LIMIT 32
@ -58,7 +58,7 @@ struct ohci_hcca {
#define ED_WBACK_OFFSET offsetof(struct ohci_ed, head) #define ED_WBACK_OFFSET offsetof(struct ohci_ed, head)
#define ED_WBACK_SIZE 4 #define ED_WBACK_SIZE 4
/* Bitfields for the first word of an Endpoint Desciptor. */ /* Bitfields for the first word of an Endpoint Desciptor. */
#define OHCI_ED_FA_SHIFT 0 #define OHCI_ED_FA_SHIFT 0
#define OHCI_ED_FA_MASK (0x7f<<OHCI_ED_FA_SHIFT) #define OHCI_ED_FA_MASK (0x7f<<OHCI_ED_FA_SHIFT)
#define OHCI_ED_EN_SHIFT 7 #define OHCI_ED_EN_SHIFT 7
@ -71,11 +71,11 @@ struct ohci_hcca {
#define OHCI_ED_MPS_SHIFT 16 #define OHCI_ED_MPS_SHIFT 16
#define OHCI_ED_MPS_MASK (0x7ff<<OHCI_ED_MPS_SHIFT) #define OHCI_ED_MPS_MASK (0x7ff<<OHCI_ED_MPS_SHIFT)
/* Flags in the head field of an Endpoint Desciptor. */ /* Flags in the head field of an Endpoint Desciptor. */
#define OHCI_ED_H 1 #define OHCI_ED_H 1
#define OHCI_ED_C 2 #define OHCI_ED_C 2
/* Bitfields for the first word of a Transfer Desciptor. */ /* Bitfields for the first word of a Transfer Desciptor. */
#define OHCI_TD_R (1<<18) #define OHCI_TD_R (1<<18)
#define OHCI_TD_DP_SHIFT 19 #define OHCI_TD_DP_SHIFT 19
#define OHCI_TD_DP_MASK (3<<OHCI_TD_DP_SHIFT) #define OHCI_TD_DP_MASK (3<<OHCI_TD_DP_SHIFT)
@ -88,7 +88,7 @@ struct ohci_hcca {
#define OHCI_TD_CC_SHIFT 28 #define OHCI_TD_CC_SHIFT 28
#define OHCI_TD_CC_MASK (0xf<<OHCI_TD_CC_SHIFT) #define OHCI_TD_CC_MASK (0xf<<OHCI_TD_CC_SHIFT)
/* Bitfields for the first word of an Isochronous Transfer Desciptor. */ /* Bitfields for the first word of an Isochronous Transfer Desciptor. */
/* CC & DI - same as in the General Transfer Desciptor */ /* CC & DI - same as in the General Transfer Desciptor */
#define OHCI_TD_SF_SHIFT 0 #define OHCI_TD_SF_SHIFT 0
#define OHCI_TD_SF_MASK (0xffff<<OHCI_TD_SF_SHIFT) #define OHCI_TD_SF_MASK (0xffff<<OHCI_TD_SF_SHIFT)
@ -335,8 +335,8 @@ static void ohci_soft_reset(OHCIState *ohci)
ohci->per_cur = 0; ohci->per_cur = 0;
ohci->done = 0; ohci->done = 0;
ohci->done_count = 7; ohci->done_count = 7;
/*
/* FSMPS is marked TBD in OCHI 1.0, what gives ffs? * FSMPS is marked TBD in OCHI 1.0, what gives ffs?
* I took the value linux sets ... * I took the value linux sets ...
*/ */
ohci->fsmps = 0x2778; ohci->fsmps = 0x2778;
@ -460,10 +460,10 @@ static inline int ohci_read_hcca(OHCIState *ohci,
static inline int ohci_put_ed(OHCIState *ohci, static inline int ohci_put_ed(OHCIState *ohci,
dma_addr_t addr, struct ohci_ed *ed) dma_addr_t addr, struct ohci_ed *ed)
{ {
/* ed->tail is under control of the HCD. /*
* ed->tail is under control of the HCD.
* Since just ed->head is changed by HC, just write back this * Since just ed->head is changed by HC, just write back this
*/ */
return put_dwords(ohci, addr + ED_WBACK_OFFSET, return put_dwords(ohci, addr + ED_WBACK_OFFSET,
(uint32_t *)((char *)ed + ED_WBACK_OFFSET), (uint32_t *)((char *)ed + ED_WBACK_OFFSET),
ED_WBACK_SIZE >> 2); ED_WBACK_SIZE >> 2);
@ -601,8 +601,10 @@ static int ohci_service_iso_td(OHCIState *ohci, struct ohci_ed *ed)
trace_usb_ohci_iso_td_relative_frame_number_neg(relative_frame_number); trace_usb_ohci_iso_td_relative_frame_number_neg(relative_frame_number);
return 1; return 1;
} else if (relative_frame_number > frame_count) { } else if (relative_frame_number > frame_count) {
/* ISO TD expired - retire the TD to the Done Queue and continue with /*
the next ISO TD of the same ED */ * ISO TD expired - retire the TD to the Done Queue and continue with
* the next ISO TD of the same ED
*/
trace_usb_ohci_iso_td_relative_frame_number_big(relative_frame_number, trace_usb_ohci_iso_td_relative_frame_number_big(relative_frame_number,
frame_count); frame_count);
if (OHCI_CC_DATAOVERRUN == OHCI_BM(iso_td.flags, TD_CC)) { if (OHCI_CC_DATAOVERRUN == OHCI_BM(iso_td.flags, TD_CC)) {
@ -845,9 +847,10 @@ static void ohci_td_pkt(const char *msg, const uint8_t *buf, size_t len)
} }
} }
/* Service a transport descriptor. /*
Returns nonzero to terminate processing of this endpoint. */ * Service a transport descriptor.
* Returns nonzero to terminate processing of this endpoint.
*/
static int ohci_service_td(OHCIState *ohci, struct ohci_ed *ed) static int ohci_service_td(OHCIState *ohci, struct ohci_ed *ed)
{ {
int dir; int dir;
@ -869,7 +872,7 @@ static int ohci_service_td(OHCIState *ohci, struct ohci_ed *ed)
return 1; return 1;
} }
/* See if this TD has already been submitted to the device. */ /* See if this TD has already been submitted to the device. */
completion = (addr == ohci->async_td); completion = (addr == ohci->async_td);
if (completion && !ohci->async_complete) { if (completion && !ohci->async_complete) {
trace_usb_ohci_td_skip_async(); trace_usb_ohci_td_skip_async();
@ -885,7 +888,7 @@ static int ohci_service_td(OHCIState *ohci, struct ohci_ed *ed)
switch (dir) { switch (dir) {
case OHCI_TD_DIR_OUT: case OHCI_TD_DIR_OUT:
case OHCI_TD_DIR_IN: case OHCI_TD_DIR_IN:
/* Same value. */ /* Same value. */
break; break;
default: default:
dir = OHCI_BM(td.flags, TD_DP); dir = OHCI_BM(td.flags, TD_DP);
@ -956,11 +959,12 @@ static int ohci_service_td(OHCIState *ohci, struct ohci_ed *ed)
} }
ep = usb_ep_get(dev, pid, OHCI_BM(ed->flags, ED_EN)); ep = usb_ep_get(dev, pid, OHCI_BM(ed->flags, ED_EN));
if (ohci->async_td) { if (ohci->async_td) {
/* ??? The hardware should allow one active packet per /*
endpoint. We only allow one active packet per controller. * ??? The hardware should allow one active packet per
This should be sufficient as long as devices respond in a * endpoint. We only allow one active packet per controller.
timely manner. * This should be sufficient as long as devices respond in a
*/ * timely manner.
*/
trace_usb_ohci_td_too_many_pending(ep->nr); trace_usb_ohci_td_too_many_pending(ep->nr);
return 1; return 1;
} }
@ -996,7 +1000,7 @@ static int ohci_service_td(OHCIState *ohci, struct ohci_ed *ed)
/* Writeback */ /* Writeback */
if (ret == pktlen || (dir == OHCI_TD_DIR_IN && ret >= 0 && flag_r)) { if (ret == pktlen || (dir == OHCI_TD_DIR_IN && ret >= 0 && flag_r)) {
/* Transmission succeeded. */ /* Transmission succeeded. */
if (ret == len) { if (ret == len) {
td.cbp = 0; td.cbp = 0;
} else { } else {
@ -1048,8 +1052,10 @@ static int ohci_service_td(OHCIState *ohci, struct ohci_ed *ed)
OHCI_SET_BM(td.flags, TD_EC, 3); OHCI_SET_BM(td.flags, TD_EC, 3);
break; break;
} }
/* An error occurred so we have to clear the interrupt counter. See /*
* spec at 6.4.4 on page 104 */ * An error occurred so we have to clear the interrupt counter.
* See spec at 6.4.4 on page 104
*/
ohci->done_count = 0; ohci->done_count = 0;
} }
ed->head |= OHCI_ED_H; ed->head |= OHCI_ED_H;
@ -1071,7 +1077,7 @@ exit_no_retire:
return OHCI_BM(td.flags, TD_CC) != OHCI_CC_NOERROR; return OHCI_BM(td.flags, TD_CC) != OHCI_CC_NOERROR;
} }
/* Service an endpoint list. Returns nonzero if active TD were found. */ /* Service an endpoint list. Returns nonzero if active TD were found. */
static int ohci_service_ed_list(OHCIState *ohci, uint32_t head) static int ohci_service_ed_list(OHCIState *ohci, uint32_t head)
{ {
struct ohci_ed ed; struct ohci_ed ed;
@ -1095,7 +1101,7 @@ static int ohci_service_ed_list(OHCIState *ohci, uint32_t head)
if ((ed.head & OHCI_ED_H) || (ed.flags & OHCI_ED_K)) { if ((ed.head & OHCI_ED_H) || (ed.flags & OHCI_ED_K)) {
uint32_t addr; uint32_t addr;
/* Cancel pending packets for ED that have been paused. */ /* Cancel pending packets for ED that have been paused. */
addr = ed.head & OHCI_DPTR_MASK; addr = ed.head & OHCI_DPTR_MASK;
if (ohci->async_td && addr == ohci->async_td) { if (ohci->async_td && addr == ohci->async_td) {
usb_cancel_packet(&ohci->usb_packet); usb_cancel_packet(&ohci->usb_packet);
@ -1151,7 +1157,7 @@ static void ohci_sof(OHCIState *ohci)
ohci_set_interrupt(ohci, OHCI_INTR_SF); ohci_set_interrupt(ohci, OHCI_INTR_SF);
} }
/* Process Control and Bulk lists. */ /* Process Control and Bulk lists. */
static void ohci_process_lists(OHCIState *ohci) static void ohci_process_lists(OHCIState *ohci)
{ {
if ((ohci->ctl & OHCI_CTL_CLE) && (ohci->status & OHCI_STATUS_CLF)) { if ((ohci->ctl & OHCI_CTL_CLE) && (ohci->status & OHCI_STATUS_CLF)) {
@ -1192,7 +1198,7 @@ static void ohci_frame_boundary(void *opaque)
ohci_service_ed_list(ohci, le32_to_cpu(hcca.intr[n])); ohci_service_ed_list(ohci, le32_to_cpu(hcca.intr[n]));
} }
/* Cancel all pending packets if either of the lists has been disabled. */ /* Cancel all pending packets if either of the lists has been disabled. */
if (ohci->old_ctl & (~ohci->ctl) & (OHCI_CTL_BLE | OHCI_CTL_CLE)) { if (ohci->old_ctl & (~ohci->ctl) & (OHCI_CTL_BLE | OHCI_CTL_CLE)) {
ohci_stop_endpoints(ohci); ohci_stop_endpoints(ohci);
} }
@ -1234,18 +1240,17 @@ static void ohci_frame_boundary(void *opaque)
} }
} }
/* Start sending SOF tokens across the USB bus, lists are processed in /*
* Start sending SOF tokens across the USB bus, lists are processed in
* next frame * next frame
*/ */
static int ohci_bus_start(OHCIState *ohci) static int ohci_bus_start(OHCIState *ohci)
{ {
trace_usb_ohci_start(ohci->name); trace_usb_ohci_start(ohci->name);
/*
/* Delay the first SOF event by one frame time as * Delay the first SOF event by one frame time as linux driver is
* linux driver is not ready to receive it and * not ready to receive it and can meet some race conditions
* can meet some race conditions
*/ */
ohci->sof_time = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL); ohci->sof_time = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
ohci_eof_timer(ohci); ohci_eof_timer(ohci);
@ -1259,9 +1264,9 @@ void ohci_bus_stop(OHCIState *ohci)
timer_del(ohci->eof_timer); timer_del(ohci->eof_timer);
} }
/* Sets a flag in a port status register but only set it if the port is /*
* connected, if not set ConnectStatusChange flag. If flag is enabled * Sets a flag in a port status reg but only set it if the port is connected.
* return 1. * If not set ConnectStatusChange flag. If flag is enabled return 1.
*/ */
static int ohci_port_set_if_connected(OHCIState *ohci, int i, uint32_t val) static int ohci_port_set_if_connected(OHCIState *ohci, int i, uint32_t val)
{ {
@ -1271,9 +1276,7 @@ static int ohci_port_set_if_connected(OHCIState *ohci, int i, uint32_t val)
if (val == 0) if (val == 0)
return 0; return 0;
/* If CurrentConnectStatus is cleared we set /* If CurrentConnectStatus is cleared we set ConnectStatusChange */
* ConnectStatusChange
*/
if (!(ohci->rhport[i].ctrl & OHCI_PORT_CCS)) { if (!(ohci->rhport[i].ctrl & OHCI_PORT_CCS)) {
ohci->rhport[i].ctrl |= OHCI_PORT_CSC; ohci->rhport[i].ctrl |= OHCI_PORT_CSC;
if (ohci->rhstatus & OHCI_RHS_DRWE) { if (ohci->rhstatus & OHCI_RHS_DRWE) {
@ -1291,7 +1294,7 @@ static int ohci_port_set_if_connected(OHCIState *ohci, int i, uint32_t val)
return ret; return ret;
} }
/* Set the frame interval - frame interval toggle is manipulated by the hcd only */ /* Frame interval toggle is manipulated by the hcd only */
static void ohci_set_frame_interval(OHCIState *ohci, uint16_t val) static void ohci_set_frame_interval(OHCIState *ohci, uint16_t val)
{ {
val &= OHCI_FMI_FI; val &= OHCI_FMI_FI;
@ -1357,9 +1360,7 @@ static uint32_t ohci_get_frame_remaining(OHCIState *ohci)
if ((ohci->ctl & OHCI_CTL_HCFS) != OHCI_USB_OPERATIONAL) if ((ohci->ctl & OHCI_CTL_HCFS) != OHCI_USB_OPERATIONAL)
return (ohci->frt << 31); return (ohci->frt << 31);
/* Being in USB operational state guarnatees sof_time was /* Being in USB operational state guarnatees sof_time was set already. */
* set already.
*/
tks = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL) - ohci->sof_time; tks = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL) - ohci->sof_time;
if (tks < 0) { if (tks < 0) {
tks = 0; tks = 0;
@ -1439,13 +1440,11 @@ static void ohci_port_set_status(OHCIState *ohci, int portnum, uint32_t val)
trace_usb_ohci_port_reset(portnum); trace_usb_ohci_port_reset(portnum);
usb_device_reset(port->port.dev); usb_device_reset(port->port.dev);
port->ctrl &= ~OHCI_PORT_PRS; port->ctrl &= ~OHCI_PORT_PRS;
/* ??? Should this also set OHCI_PORT_PESC. */ /* ??? Should this also set OHCI_PORT_PESC. */
port->ctrl |= OHCI_PORT_PES | OHCI_PORT_PRSC; port->ctrl |= OHCI_PORT_PES | OHCI_PORT_PRSC;
} }
/* Invert order here to ensure in ambiguous case, device is /* Invert order here to ensure in ambiguous case, device is powered up. */
* powered up...
*/
if (val & OHCI_PORT_LSDA) if (val & OHCI_PORT_LSDA)
ohci_port_power(ohci, portnum, 0); ohci_port_power(ohci, portnum, 0);
if (val & OHCI_PORT_PPS) if (val & OHCI_PORT_PPS)
@ -1892,7 +1891,7 @@ void usb_ohci_init(OHCIState *ohci, DeviceState *dev, uint32_t num_ports,
ohci_frame_boundary, ohci); ohci_frame_boundary, ohci);
} }
/** /*
* A typical OHCI will stop operating and set itself into error state * A typical OHCI will stop operating and set itself into error state
* (which can be queried by MMIO) to signal that it got an error. * (which can be queried by MMIO) to signal that it got an error.
*/ */