usr/src/man/man9f/bioreset.9f

   1 '\" te
   2 .\"  Copyright (c) 1996, 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 BIORESET 9F "Nov 15, 1996"
   7 .SH NAME
   8 bioreset \- reuse a private buffer header after I/O is complete
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/buf.h>
  13 #include <sys/ddi.h>
  14
  15
  16
  17 \fBvoid\fR \fBbioreset\fR(\fBstruct buf *\fR\fIbp\fR);
  18 .fi
  19
  20 .SH INTERFACE LEVEL
  21 .sp
  22 .LP
  23 Solaris DDI specific (Solaris DDI)
  24 .SH PARAMETERS
  25 .sp
  26 .ne 2
  27 .na
  28 \fB\fIbp\fR \fR
  29 .ad
  30 .RS 7n
  31 Pointer to the \fBbuf\fR(9S) structure.
  32 .RE
  33
  34 .SH DESCRIPTION
  35 .sp
  36 .LP
  37 \fBbioreset()\fR is used by drivers that allocate private buffers with
  38 \fBgetrbuf\fR(9F) or \fBkmem_alloc\fR(9F) and want to reuse them in multiple
  39 transfers before freeing them with \fBfreerbuf\fR(9F) or \fBkmem_free\fR(9F).
  40 \fBbioreset()\fR resets the buffer header to the state it had when initially
  41 allocated by \fBgetrbuf()\fR or initialized by \fBbioinit\fR(9F).
  42 .SH CONTEXT
  43 .sp
  44 .LP
  45 \fBbioreset()\fR can be called from any context.
  46 .SH SEE ALSO
  47 .sp
  48 .LP
  49 \fBstrategy\fR(9E), \fBbioinit\fR(9F), \fBbiofini\fR(9F), \fBfreerbuf\fR(9F),
  50 \fBgetrbuf\fR(9F), \fBkmem_alloc\fR(9F), \fBkmem_free\fR(9F), \fBbuf\fR(9S)
  51 .SH NOTES
  52 .sp
  53 .LP
  54 \fIbp\fR must not describe a transfer in progress.