share/man/man9e/tran_reset_notify.9e

   1 '\" te
   2 .\"  Copyright (c) 1997, 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_RESET_NOTIFY 9E "Aug 30, 1995"
   7 .SH NAME
   8 tran_reset_notify \- request to notify SCSI target of bus reset
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/scsi/scsi.h>
  13
  14
  15
  16 \fBint prefix\fR\fBtran_reset_notify\fR(\fBstruct scsi_address *\fR\fIap\fR, \fBint\fR \fIflag\fR,
  17      \fBvoid (*\fR\fIcallback\fR, \fBcaddr_t),caddr_t\fR \fIarg\fR);
  18 .fi
  19
  20 .SH INTERFACE LEVEL
  21 .sp
  22 .LP
  23 Solaris architecture specific (Solaris DDI).
  24 .SH PARAMETERS
  25 .sp
  26 .ne 2
  27 .na
  28 \fB\fIap\fR \fR
  29 .ad
  30 .RS 13n
  31 Pointer to the \fBscsi_address\fR(9S) structure.
  32 .RE
  33
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fIflag\fR \fR
  38 .ad
  39 .RS 13n
  40 A flag indicating registration or cancellation of a notification request.
  41 .RE
  42
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fIcallback\fR \fR
  47 .ad
  48 .RS 13n
  49 A pointer to the target driver's reset notification function.
  50 .RE
  51
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fIarg\fR \fR
  56 .ad
  57 .RS 13n
  58 The callback function argument.
  59 .RE
  60
  61 .SH DESCRIPTION
  62 .sp
  63 .LP
  64 The \fBtran_reset_notify()\fR entry point is called when a target driver
  65 requests notification of a bus reset.
  66 .sp
  67 .LP
  68 The \fBtran_reset_notify()\fR vector in the \fBscsi_hba_tran\fR(9S) structure
  69 may be initialized in the  \fBHBA \fRdriver's \fBattach\fR(9E) routine to point
  70 to the \fBHBA \fRentry point to be called when a target driver calls
  71 \fBscsi_reset_notify\fR(9F).
  72 .sp
  73 .LP
  74 The argument  \fIflag\fR is used to register or cancel the notification.  The
  75 supported values for  \fIflag\fR are as follows:
  76 .sp
  77 .ne 2
  78 .na
  79 \fB\fBSCSI_RESET_NOTIFY\fR \fR
  80 .ad
  81 .RS 22n
  82 Register \fIcallback\fR as the reset notification function for the target.
  83 .RE
  84
  85 .sp
  86 .ne 2
  87 .na
  88 \fB\fBSCSI_RESET_CANCEL\fR \fR
  89 .ad
  90 .RS 22n
  91 Cancel the reset notification request for the target.
  92 .RE
  93
  94 .sp
  95 .LP
  96 The  \fBHBA \fRdriver maintains a list of reset notification requests
  97 registered by the target drivers.   When a bus reset occurs, the  \fBHBA
  98 \fRdriver notifies registered target drivers by calling the callback routine,
  99 \fIcallback\fR, with the argument, \fIarg\fR, for each registered target.
 100 .SH RETURN VALUES
 101 .sp
 102 .LP
 103 For \fBSCSI_RESET_NOTIFY\fR requests,  \fBtran_reset_notify()\fR must return
 104 \fBDDI_SUCCESS\fR if the notification request has been accepted, and
 105 \fBDDI_FAILURE\fR otherwise.
 106 .sp
 107 .LP
 108 For \fBSCSI_RESET_CANCEL\fR requests,  \fBtran_reset_notify()\fR must return
 109 \fBDDI_SUCCESS\fR if the notification request has been canceled, and
 110 \fBDDI_FAILURE\fR otherwise.
 111 .SH SEE ALSO
 112 .sp
 113 .LP
 114 \fBattach\fR(9E), \fBscsi_ifgetcap\fR(9F), \fBscsi_reset_notify\fR(9F),
 115 \fBscsi_address\fR(9S), \fBscsi_hba_tran\fR(9S)
 116 .sp
 117 .LP
 118 \fIWriting Device Drivers\fR