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

   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 TRAN_BUS_RESET 9E "Mar 17, 1999"
   7 .SH NAME
   8 tran_bus_reset \- reset a SCSI bus
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/scsi/scsi.h> int \fIprefix\fR
  13
  14 \fB\fR\fBtran_bus_reset\fR(\fBdev_info_t\fR \fI*hba_dip\fR, \fBint\fR \fIlevel\fR);
  15 .fi
  16
  17 .SH INTERFACE LEVEL
  18 .sp
  19 .LP
  20 Solaris DDI
  21 .SH PARAMETERS
  22 .sp
  23 .ne 2
  24 .na
  25 \fB\fIhba_dip\fR\fR
  26 .ad
  27 .RS 11n
  28 The  \fBdev_info_t\fR pointer associated with the SCSI HBA.
  29 .RE
  30
  31 .sp
  32 .ne 2
  33 .na
  34 \fB\fIlevel\fR\fR
  35 .ad
  36 .RS 11n
  37 The level of reset required.
  38 .RE
  39
  40 .SH DESCRIPTION
  41 .sp
  42 .LP
  43 The  \fBtran_bus_reset()\fR vector in the \fBscsi_hba_tran\fR(9S) structure
  44 should be initialized during the HBA driver's \fBattach\fR(9E). It is an HBA
  45 entry point to be called when a user initiates a bus reset through device
  46 control interfaces.
  47 .sp
  48 .LP
  49 \fBtran_bus_reset()\fR must reset the SCSI bus without resetting targets.
  50 .sp
  51 .LP
  52 \fIlevel\fR will be one of the following:
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fBRESET_BUS\fR\fR
  57 .ad
  58 .RS 13n
  59 Reset the SCSI bus only, not the targets.
  60 .RE
  61
  62 .sp
  63 .LP
  64 Implementation is hardware specific. If it is not possible to reset the SCSI
  65 bus without changing the state and operating mode of the targets, the HBA
  66 driver should not initialize this vector or return failure.
  67 .SH RETURN VALUES
  68 .sp
  69 .LP
  70 \fBtran_bus_reset()\fR should return:
  71 .sp
  72 .ne 2
  73 .na
  74 \fB\fB1\fR\fR
  75 .ad
  76 .RS 5n
  77 on success.
  78 .RE
  79
  80 .sp
  81 .ne 2
  82 .na
  83 \fB\fB0\fR\fR
  84 .ad
  85 .RS 5n
  86 on failure.
  87 .RE
  88
  89 .SH ATTRIBUTES
  90 .sp
  91 .LP
  92 See \fBattributes\fR(5) for a description of the following attributes:
  93 .sp
  94
  95 .sp
  96 .TS
  97 box;
  98 c | c
  99 l | l .
 100 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 101 _
 102 Interface Stability     Committed
 103 .TE
 104
 105 .SH SEE ALSO
 106 .sp
 107 .LP
 108 \fBattributes\fR(5), \fBtran_quiesce\fR(9E), \fBscsi_hba_tran\fR(9S)