.\" This documentation was generated from the book titled "The Linux-USB Host Side API", which is part of the Linux kernel source.
.\" 
.\" This documentation comes with the following legal notice:
.\" 
.\"     This documentation is free software; you can redistribute
.\"     it and/or modify it under the terms of the GNU General Public
.\"     License as published by the Free Software Foundation; either
.\"     version 2 of the License, or (at your option) any later
.\"     version.
.\" 
.\"     This program is distributed in the hope that it will be
.\"     useful, but WITHOUT ANY WARRANTY; without even the implied
.\"     warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
.\"     See the GNU General Public License for more details.
.\" 
.\"     You should have received a copy of the GNU General Public
.\"     License along with this program; if not, write to the Free
.\"     Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
.\"     MA 02111-1307 USA
.\" 
.\"     For more details see the file COPYING in the source
.\"     distribution of Linux.
.\" 
.\" For comments on the formatting of this manpage, please contact Michael Still <mikal@stillhq.com>

.\" 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" "13 April 2004" "" ""

.SH NAME
usb_claim_bandwidth \- records bandwidth for a periodic transfer
.SH 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.
.SH "ABOUT THIS DOCUMENT"
.PP
This documentation was generated with kernel version 2.6.1.