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

.SH NAME
usb_buffer_map \- create DMA mapping(s) for an urb
.SH SYNOPSIS
.sp
\fB
.sp
struct urb * usb_buffer_map  (struct urb * \fIurb\fB);
\fR
.SH "ARGUMENTS"
.TP
\fB\fIurb\fB\fR
urb whose transfer_buffer/setup_packet will be mapped
.SH "DESCRIPTION"
.PP
Return value is either null (indicating no buffer could be mapped), or
the parameter.  URB_NO_TRANSFER_DMA_MAP and URB_NO_SETUP_DMA_MAP are
added to urb->transfer_flags if the operation succeeds.  If the device
is connected to this system through a non-DMA controller, this operation
always succeeds.
.PP
This call would normally be used for an urb which is reused, perhaps
as the target of a large periodic transfer, with \fBusb_buffer_dmasync\fR
calls to synchronize memory and dma state.
.PP
Reverse the effect of this call with \fBusb_buffer_unmap\fR.
.SH "ABOUT THIS DOCUMENT"
.PP
This documentation was generated with kernel version 2.6.0.