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

   1 '\" te
   2 .\" Copyright (c) 2009, 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_HBA_PKT_COMP 9F "Jan 29, 2009"
   7 .SH NAME
   8 scsi_hba_pkt_comp \- scsi_pkt completion routine
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/scsi/scsi.h>
  13
  14 \fBvoid\fR \fBscsi_hba_pkt_comp\fR(\fBstruct scsi_pkt *\fR\fIpkt\fR);
  15 .fi
  16
  17 .SH PARAMETERS
  18 .sp
  19 .ne 2
  20 .na
  21 \fB\fIpkt\fR\fR
  22 .ad
  23 .RS 7n
  24 Pointer to a \fBscsi_pkt\fR(9S) structure.
  25 .RE
  26
  27 .SH INTERFACE LEVEL
  28 .sp
  29 .LP
  30 Solaris DDI specific (Solaris DDI).
  31 .SH DESCRIPTION
  32 .sp
  33 .LP
  34 After filling in \fBscsi_pkt\fR(9S) fields with packet completion information,
  35 an HBA driver should call the \fBscsi_hba_pkt_comp()\fR function. This function
  36 is the recommended way for an HBA driver to signal completion of a
  37 \fBscsi_pkt\fR structure.  Use is mandatory for HBA drivers that use
  38 \fBtran_setup_pkt\fR(9E).
  39 .sp
  40 .LP
  41 Calling the \fBscsi_hba_pkt_comp()\fR function allows SCSA to observe, and
  42 possibly react to, the completion of a \fBscsi_pkt\fR request.
  43 .sp
  44 .LP
  45 A call to the \fBscsi_hba_pkt_comp()\fR function will always result in a call
  46 to the \fIpkt_comp\fR() callback function defined in \fBscsi_pkt\fR(9S). This
  47 \fIpkt_comp\fR() callback may, however, occur after return from
  48 \fBscsi_hba_pkt_comp()\fR, and may occur from a different thread executing on a
  49 different CPU.
  50 .SH CONTEXT
  51 .sp
  52 .LP
  53 The \fBscsi_hba_pkt_comp()\fR function can be called from user, interrupt, or
  54 kernel context.
  55 .SH ATTRIBUTES
  56 .sp
  57 .LP
  58 See \fBattributes\fR(5) for descriptions of the following attributes:
  59 .sp
  60
  61 .sp
  62 .TS
  63 box;
  64 c | c
  65 l | l .
  66 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  67 _
  68 Interface Stability     Committed
  69 .TE
  70
  71 .SH SEE ALSO
  72 .sp
  73 .LP
  74 \fBattributes\fR(5), \fBtran_setup_pkt\fR(9E), \fBscsi_pkt\fR(9S)
  75 .SH NOTES
  76 .sp
  77 .LP
  78 HBA driver calls \fBscsi_hba_pkt_comp()\fR instead of calling
  79 \fBscsi_pkt\fR(9S) \fIpkt_comp\fR directly.