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

   1 '\" te
   2 .\"  Copyright (c) 2006, 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 SCSI_DESTROY_PKT 9F "Jan 16, 2006"
   7 .SH NAME
   8 scsi_destroy_pkt \- free an allocated SCSI packet and its DMA resource
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/scsi/scsi.h>
  13
  14
  15
  16 \fBvoid\fR \fBscsi_destroy_pkt\fR(\fBstruct scsi_pkt *\fR\fIpktp\fR);
  17 .fi
  18
  19 .SH INTERFACE LEVEL
  20 .sp
  21 .LP
  22 Solaris DDI specific (Solaris DDI).
  23 .SH PARAMETERS
  24 .sp
  25 .ne 2
  26 .na
  27 \fB\fIpktp\fR\fR
  28 .ad
  29 .RS 8n
  30 Pointer to a \fBscsi_pkt\fR(9S) structure.
  31 .RE
  32
  33 .SH DESCRIPTION
  34 .sp
  35 .LP
  36 The \fBscsi_destroy_pkt()\fR function releases all necessary resources,
  37 typically at the end of an I/O transfer. The data is synchronized to memory,
  38 then the \fBDMA\fR resources are deallocated and \fIpktp\fR is freed.
  39 .SH CONTEXT
  40 .sp
  41 .LP
  42 The \fBscsi_destroy_pkt()\fR function may be called from user, interrupt, or
  43 kernel context.
  44 .SH EXAMPLES
  45 .LP
  46 \fBExample 1 \fRReleasing resources
  47 .sp
  48 .in +2
  49 .nf
  50 scsi_destroy_pkt(un->un_rqs);
  51 .fi
  52 .in -2
  53
  54 .SH SEE ALSO
  55 .sp
  56 .LP
  57 \fBtran_destroy_pkt\fR(9E), \fBscsi_init_pkt\fR(9F), \fBscsi_pkt\fR(9S)
  58 .sp
  59 .LP
  60 \fIWriting Device Drivers\fR