usr/src/man/man9e/tran_abort.9e

   1 '\" te
   2 .\" Copyright (c) 2005, 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 TRAN_ABORT 9E "Aug 17, 2005"
   7 .SH NAME
   8 tran_abort \- abort a SCSI command
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/scsi/scsi.h>
  13
  14
  15
  16 \fB int prefix\fR\fBtran_abort\fR(\fBstruct scsi_address *\fR\fIap\fR,
  17      \fBstruct scsi_pkt *\fR\fIpkt\fR);
  18 .fi
  19
  20 .SH INTERFACE LEVEL
  21 .sp
  22 .LP
  23 Solaris architecture specific (Solaris DDI).
  24 .SH ARGUMENTS
  25 .sp
  26 .ne 2
  27 .na
  28 \fB\fIap\fR \fR
  29 .ad
  30 .RS 8n
  31 Pointer to a \fBscsi_address\fR(9S) structure.
  32 .RE
  33
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fIpkt\fR \fR
  38 .ad
  39 .RS 8n
  40 Pointer to a \fBscsi_pkt\fR(9S) structure.
  41 .RE
  42
  43 .SH DESCRIPTION
  44 .sp
  45 .LP
  46 The \fBtran_abort()\fR vector in the \fBscsi_hba_tran\fR(9S) structure must be
  47 initialized during the HBA driver's \fBattach\fR(9E) to point to an HBA entry
  48 point to be called when a target driver calls \fBscsi_abort\fR(9F).
  49 .sp
  50 .LP
  51 \fBtran_abort()\fR should attempt to abort the command \fIpkt\fR that has been
  52 transported to the HBA.  If \fIpkt\fR is \fBNULL\fR, the HBA driver should
  53 attempt to abort all outstanding packets for the target/logical unit addressed
  54 by \fIap\fR.
  55 .sp
  56 .LP
  57 Depending on the state of a particular command in the transport layer, the HBA
  58 driver may not be able to abort the command.
  59 .sp
  60 .LP
  61 While the abort is taking place, packets issued to the transported layer may or
  62 may not be aborted.
  63 .sp
  64 .LP
  65 For each packet successfully aborted, \fBtran_abort()\fR must set the
  66 \fBpkt_reason\fR to \fBCMD_ABORTED\fR, and \fBpkt_statistics\fR must be
  67 \fBOR'ed\fR with \fBSTAT_ABORTED\fR .
  68 .SH RETURN VALUES
  69 .sp
  70 .LP
  71 \fBtran_abort()\fR must return:
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fB1\fR \fR
  76 .ad
  77 .RS 6n
  78 upon success or partial success.
  79 .RE
  80
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fB0\fR \fR
  85 .ad
  86 .RS 6n
  87 upon failure.
  88 .RE
  89
  90 .SH CONTEXT
  91 .sp
  92 .LP
  93 The \fBtran_abort()\fR function can be called from user or interrupt context.
  94 This requirement comes from \fBscsi_abort()\fR.
  95 .SH SEE ALSO
  96 .sp
  97 .LP
  98 \fBattach\fR(9E), \fBscsi_abort\fR(9F), \fBscsi_hba_attach\fR(9F),
  99 \fBscsi_address\fR(9S), \fBscsi_hba_tran\fR(9S), \fBscsi_pkt\fR(9S)
 100 .sp
 101 .LP
 102 \fIWriting Device Drivers\fR
 103 .SH NOTES
 104 .sp
 105 .LP
 106 If \fBpkt_reason\fR already indicates that an earlier error had occurred,
 107 \fBtran_abort()\fR should not overwrite \fBpkt_reason\fR with
 108 \fBCMD_ABORTED\fR.