.\" This manpage has been automatically generated by docbook2man 
.\" from a DocBook document.  This tool can be found at:
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
.\" Please send any bug reports, improvements, comments, patches, 
.\" etc. to Steve Cheng <steve@ggi-project.org>.
.TH "USB_CLAIM_BANDWIDTH" "9" "09 October 2005" "" ""

.SH NAME
usb_claim_bandwidth \- records bandwidth for a periodic transfer
.SH SYNOPSIS
"SYNOPSIS"
.sp
\fB
.sp
void usb_claim_bandwidth  (struct usb_device * \fIdev\fB, struct urb * \fIurb\fB, int \fIbustime\fB, int \fIisoc\fB);
\fR
.SH "ARGUMENTS"
.TP
\fB\fIdev\fB\fR
source/target of request
.TP
\fB\fIurb\fB\fR
request (urb->dev == dev)
.TP
\fB\fIbustime\fB\fR
bandwidth consumed, in (average) microseconds per frame
.TP
\fB\fIisoc\fB\fR
true iff the request is isochronous
.SH "DESCRIPTION"
.PP
Bus bandwidth reservations are recorded purely for diagnostic purposes.
HCDs are expected not to overcommit periodic bandwidth, and to record such
reservations whenever endpoints are added to the periodic schedule.
.PP
FIXME averaging per-frame is suboptimal.  Better to sum over the HCD's
entire periodic schedule ... 32 frames for OHCI, 1024 for UHCI, settable
for EHCI (256/512/1024 frames, default 1024) and have the bus expose how
large its periodic schedule is.