.\" 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_SG_REQUEST" "9" "09 April 2004" "" ""

.SH NAME
struct usb_sg_request \- support for scatter/gather I/O
.SH SYNOPSIS

.nf
struct usb_sg_request {
  int status;
  size_t bytes;
};  
.fi
.SH "MEMBERS"
.TP
\fBstatus\fR
zero indicates success, else negative errno
.TP
\fBbytes\fR
counts bytes transferred.
.SH "DESCRIPTION"
.PP
These requests are initialized using \fBusb_sg_init\fR, and then are used
as request handles passed to \fBusb_sg_wait\fR or \fBusb_sg_cancel\fR.  Most
members of the request object aren't for driver access.
.PP
The status and bytecount values are valid only after \fBusb_sg_wait\fR
returns.  If the status is zero, then the bytecount matches the total
from the request.
.PP
After an error completion, drivers may need to clear a halt condition
on the endpoint.
.SH "ABOUT THIS DOCUMENT"
.PP
This documentation was generated with kernel version 2.6.0.