man/man9e/tran_abort.9e

         te
 Copyright (c) 2005, Sun Microsystems, Inc. All Rights Reserved
 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.
 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.
 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]
 TRAN_ABORT 9E "Aug 17, 2005"
 NAME
tran_abort - abort a SCSI command
 SYNOPSIS

#include <sys/scsi/scsi.h>


 int prefixtran_abort(struct scsi_address *ap,
 struct scsi_pkt *pkt);


 INTERFACE LEVEL

Solaris architecture specific (Solaris DDI).
 ARGUMENTS
ap

Pointer to a scsi_address(9S) structure.


pkt

Pointer to a scsi_pkt(9S) structure.


 DESCRIPTION

The tran_abort() vector in the scsi_hba_tran(9S) structure must be
initialized during the HBA driver's attach(9E) to point to an HBA entry
point to be called when a target driver calls scsi_abort(9F).

tran_abort() should attempt to abort the command pkt that has been
transported to the HBA. If pkt is NULL, the HBA driver should
attempt to abort all outstanding packets for the target/logical unit addressed
by ap.

Depending on the state of a particular command in the transport layer, the HBA
driver may not be able to abort the command.

While the abort is taking place, packets issued to the transported layer may or
may not be aborted.

For each packet successfully aborted, tran_abort() must set the
pkt_reason to CMD_ABORTED, and pkt_statistics must be
OR'ed with STAT_ABORTED .
 RETURN VALUES

tran_abort() must return:
1

upon success or partial success.


0

upon failure.


 CONTEXT

The tran_abort() function can be called from user or interrupt context.
This requirement comes from scsi_abort().
 SEE ALSO

attach(9E), scsi_abort(9F), scsi_hba_attach(9F),
scsi_address(9S), scsi_hba_tran(9S), scsi_pkt(9S)

Writing Device Drivers
 NOTES

If pkt_reason already indicates that an earlier error had occurred,
tran_abort() should not overwrite pkt_reason with
CMD_ABORTED.