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

   1 '\" te
   2 .\"  Copyright (c) 2000 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_QUIESCE 9E "Jan 31, 1999"
   7 .SH NAME
   8 tran_quiesce, tran_unquiesce \- quiesce and unquiesce a SCSI bus
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/scsi/scsi.h>
  13
  14 \fBint prefix\fR\fBtran_quiesce\fR(\fBdev_info_t\fR \fI*hba_dip\fR);
  15 .fi
  16
  17 .LP
  18 .nf
  19 \fBint prefix\fR\fBtran_unquiesce\fR(\fBdev_info_t\fR \fI*hba_dip\fR);
  20 .fi
  21
  22 .SH INTERFACE LEVEL
  23 .sp
  24 .LP
  25 Solaris DDI
  26 .SH PARAMETERS
  27 .sp
  28 .ne 2
  29 .na
  30 \fB\fIhba_dip\fR\fR
  31 .ad
  32 .RS 11n
  33 The \fBdev_info_t\fR pointer associated with the SCSI HBA.
  34 .RE
  35
  36 .SH DESCRIPTION
  37 .sp
  38 .LP
  39 The  \fBtran_quiesce()\fR and  \fBtran_unquiesce()\fR vectors in the
  40 \fBscsi_hba_tran\fR(9S) structure should be initialized during the HBA driver's
  41 \fBattach\fR(9E). They are HBA entry points to be called when a user initiates
  42 quiesce and unquiesce operations through device control interfaces.
  43 .sp
  44 .LP
  45 \fBtran_quiesce()\fR should wait for all outstanding commands to complete and
  46 blocks (or queues) any I/O requests issued. \fBtran_unquiesce()\fR should allow
  47 I/O activities to resume on the SCSI bus.
  48 .sp
  49 .LP
  50 Implementation is hardware specific.
  51 .SH RETURN VALUES
  52 .sp
  53 .LP
  54 \fBtran_quiesce()\fR and \fBtran_unquiesce()\fR should return:
  55 .sp
  56 .ne 2
  57 .na
  58 \fB\fB0\fR\fR
  59 .ad
  60 .RS 12n
  61 Successful completion.
  62 .RE
  63
  64 .sp
  65 .ne 2
  66 .na
  67 \fB\fBNon-zero\fR\fR
  68 .ad
  69 .RS 12n
  70 An error occurred.
  71 .RE
  72
  73 .SH ATTRIBUTES
  74 .sp
  75 .LP
  76 See \fBattributes\fR(5) for a description of the following attributes:
  77 .sp
  78
  79 .sp
  80 .TS
  81 box;
  82 c | c
  83 l | l .
  84 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  85 _
  86 Interface Stability     Committed
  87 .TE
  88
  89 .SH SEE ALSO
  90 .sp
  91 .LP
  92 \fBattributes\fR(5), \fBtran_bus_reset\fR(9E), \fBscsi_hba_tran\fR(9S)