share/man/man9f/bp_copyout.9f

   1 '\" te
   2 .\"  Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH BP_COPYOUT 9F "Oct 16, 2007"
   7 .SH NAME
   8 bp_copyout \- copy from a driver buffer into a buf(9S)
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/types.h>
  13 #include <sys/buf.h>
  14
  15
  16
  17
  18 \fBint\fR \fBbp_copyout\fR(\fBvoid *\fR\fIdriverbuf\fR, \fBstruct buf *\fR\fIbp\fR, \fBoffset_t\fR \fIoffset\fR,
  19      \fBsize_t\fR \fIsize\fR);
  20 .fi
  21
  22 .SH INTERFACE LEVEL
  23 .sp
  24 .LP
  25 Architecture independent level 1 (DDI/DKI).
  26 .SH PARAMETERS
  27 .sp
  28 .ne 2
  29 .na
  30 \fB\fIbp\fR\fR
  31 .ad
  32 .RS 13n
  33 Pointer to the buffer header structure to copy to.
  34 .RE
  35
  36 .sp
  37 .ne 2
  38 .na
  39 \fB\fIdriverbuf\fR\fR
  40 .ad
  41 .RS 13n
  42 Driver buffer to copy from.
  43 .RE
  44
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fIoffset\fR\fR
  49 .ad
  50 .RS 13n
  51 Offset into \fIbp\fR where to start copying.
  52 .RE
  53
  54 .sp
  55 .ne 2
  56 .na
  57 \fB\fIsize\fR\fR
  58 .ad
  59 .RS 13n
  60 Size of copy.
  61 .RE
  62
  63 .SH DESCRIPTION
  64 .sp
  65 .LP
  66 The \fBbp_copyout()\fR function copies \fIsize\fR bytes starting from the
  67 driver buffer \fIdriverbuf\fR to \fIoffset\fR bytes into the memory associated
  68 with \fIbp\fR. The \fIoffset\fR only applies to \fIbp\fR.
  69 .SH RETURN VALUES
  70 .sp
  71 .LP
  72 Under normal conditions, 0 is returned to indicate a successful copy.
  73 Otherwise, -1 is returned if \fIbp\fR references invalid pages.
  74 .SH CONTEXT
  75 .sp
  76 .LP
  77 The \fBbp_copyout()\fR function can be called from user or kernel context only.
  78 .SH SEE ALSO
  79 .sp
  80 .LP
  81 \fBbp_copyin\fR(9F), \fBbp_mapin\fR(9F), \fBbp_mapout\fR(9F),
  82 \fBddi_copyout\fR(9F), \fBbuf\fR(9S)