.\" 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_BUFFER_MAP_SG" "" "06 October 2005" "" ""

.SH NAME
usb_buffer_map_sg \- create scatterlist DMA mapping(s) for an endpoint
.SH SYNOPSIS
"SYNOPSIS"
.sp
\fB
.sp
int usb_buffer_map_sg  (struct usb_device * \fIdev\fB, unsigned \fIpipe\fB, struct scatterlist * \fIsg\fB, int \fInents\fB);
\fR
.SH "ARGUMENTS"
.TP
\fB\fIdev\fB\fR
device to which the scatterlist will be mapped
.TP
\fB\fIpipe\fB\fR
endpoint defining the mapping direction
.TP
\fB\fIsg\fB\fR
the scatterlist to map
.TP
\fB\fInents\fB\fR
the number of entries in the scatterlist
.SH "DESCRIPTION"
.PP
Return value is either < 0 (indicating no buffers could be mapped), or
the number of DMA mapping array entries in the scatterlist.
.PP
The caller is responsible for placing the resulting DMA addresses from
the scatterlist into URB transfer buffer pointers, and for setting the
URB_NO_TRANSFER_DMA_MAP transfer flag in each of those URBs.
.PP
Top I/O rates come from queuing URBs, instead of waiting for each one
to complete before starting the next I/O.   This is particularly easy
to do with scatterlists.  Just allocate and submit one URB for each DMA
mapping entry returned, stopping on the first error or when all succeed.
Better yet, use the usb_sg_*() calls, which do that (and more) for you.
.PP
This call would normally be used when translating scatterlist requests,
rather than \fBusb_buffer_map\fR, since on some hardware (with IOMMUs) it
may be able to coalesce mappings for improved I/O efficiency.
.PP
Reverse the effect of this call with \fBusb_buffer_unmap_sg\fR\&.