share/man/man9f/scsi_reset_notify.9f

   1 '\" te
   2 .\" Copyright (c) 2006, Sun Microsystems, Inc.,
   3 .\" All Rights Reserved
   4 .\" 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.
   5 .\" 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.
   6 .\" 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]
   7 .TH SCSI_RESET_NOTIFY 9F "Jan 16, 2006"
   8 .SH NAME
   9 scsi_reset_notify \- notify target driver of bus resets
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/scsi/scsi.h>
  14
  15
  16
  17 \fBvoid\fR \fBscsi_reset_notify\fR(\fBstruct scsi_address *\fR\fIap\fR, \fBint\fR \fIflag\fR,
  18      \fBvoid\fR (*\fIcallback)(caddr_t)\fR, \fBcaddr_t\fR \fIarg\fR);
  19 .fi
  20
  21 .SH INTERFACE LEVEL
  22 .sp
  23 .LP
  24 Solaris DDI specific (Solaris DDI).
  25 .SH PARAMETERS
  26 .sp
  27 .ne 2
  28 .na
  29 \fB\fIap\fR\fR
  30 .ad
  31 .RS 12n
  32 Pointer to the \fBscsi_address\fR structure.
  33 .RE
  34
  35 .sp
  36 .ne 2
  37 .na
  38 \fB\fIflag\fR\fR
  39 .ad
  40 .RS 12n
  41 A flag indicating registration or cancellation of the notification request.
  42 .RE
  43
  44 .sp
  45 .ne 2
  46 .na
  47 \fB\fIcallback\fR\fR
  48 .ad
  49 .RS 12n
  50 A pointer to the target driver's reset notification function.
  51 .RE
  52
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fIarg\fR\fR
  57 .ad
  58 .RS 12n
  59 The callback function argument.
  60 .RE
  61
  62 .SH DESCRIPTION
  63 .sp
  64 .LP
  65 The \fBscsi_reset_notify()\fR function is used by a target driver when it needs
  66 to be notified of a bus reset. The bus reset could be issued by the transport
  67 layer (e.g. the host bus adapter (\fBHBA)\fR driver or controller) or by
  68 another initiator.
  69 .sp
  70 .LP
  71 The  argument \fIflag\fR is used to register or cancel the notification. The
  72 supported values for \fIflag\fR are as follows:
  73 .sp
  74 .ne 2
  75 .na
  76 \fB\fBSCSI_RESET_NOTIFY\fR\fR
  77 .ad
  78 .RS 21n
  79 Register \fIcallback\fR as the reset notification function for the target
  80 driver.
  81 .RE
  82
  83 .sp
  84 .ne 2
  85 .na
  86 \fB\fBSCSI_RESET_CANCEL\fR\fR
  87 .ad
  88 .RS 21n
  89 Cancel the reset notification request.
  90 .RE
  91
  92 .sp
  93 .LP
  94 Target drivers can find out whether the \fBHBA\fR driver and controller support
  95 reset notification by checking the  \fBreset-notification\fR capability using
  96 the \fBscsi_ifgetcap\fR(9F) function.
  97 .SH RETURN VALUES
  98 .sp
  99 .LP
 100 If \fIflag\fR is \fBSCSI_RESET_NOTIFY\fR, \fBscsi_reset_notify()\fR returns:
 101 .sp
 102 .ne 2
 103 .na
 104 \fB\fBDDI_SUCCESS\fR\fR
 105 .ad
 106 .RS 15n
 107 The notification request has been accepted.
 108 .RE
 109
 110 .sp
 111 .ne 2
 112 .na
 113 \fB\fBDDI_FAILURE\fR\fR
 114 .ad
 115 .RS 15n
 116 The transport layer does not support reset notification or could not accept
 117 this request.
 118 .RE
 119
 120 .sp
 121 .LP
 122 If \fIflag\fR is \fBSCSI_RESET_CANCEL\fR, \fBscsi_reset_notify()\fR returns:
 123 .sp
 124 .ne 2
 125 .na
 126 \fB\fBDDI_SUCCESS\fR\fR
 127 .ad
 128 .RS 15n
 129 The notification request has been canceled.
 130 .RE
 131
 132 .sp
 133 .ne 2
 134 .na
 135 \fB\fBDDI_FAILURE\fR\fR
 136 .ad
 137 .RS 15n
 138 No notification request was registered.
 139 .RE
 140
 141 .SH CONTEXT
 142 .sp
 143 .LP
 144 The \fBscsi_reset_notify()\fR function can be called from user, interrupt, or
 145 kernel context.
 146 .SH SEE ALSO
 147 .sp
 148 .LP
 149 \fBscsi_address\fR(9S), \fBscsi_ifgetcap\fR(9F)
 150 .sp
 151 .LP
 152 \fIWriting Device Drivers\fR