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

   1 '\" te
   2 .\"  Copyright (c) 1993, 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_TGT_PROBE 9E "Nov 1, 1993"
   7 .SH NAME
   8 tran_tgt_probe \- request to probe SCSI bus for a particular target
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/scsi/scsi.h>
  13
  14
  15
  16 \fBint prefix\fR\fBtran_tgt_probe\fR(\fBstruct scsi_device *\fR\fIsd\fR, \fBint (*\fR\fIwaitfunc\fR,
  17      \fBvoid));\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\fIsd\fR \fR
  29 .ad
  30 .RS 13n
  31 Pointer to a  \fBscsi_device\fR(9S) structure.
  32 .RE
  33
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fIwaitfunc\fR \fR
  38 .ad
  39 .RS 13n
  40 Pointer to either  \fBNULL_FUNC\fR or \fBSLEEP_FUNC\fR.
  41 .RE
  42
  43 .SH DESCRIPTION
  44 .sp
  45 .LP
  46 The \fBtran_tgt_probe()\fR vector in the \fBscsi_hba_tran\fR(9S) structure may
  47 be initialized during the \fBHBA \fRdriver's \fBattach\fR(9E) to point to a
  48 function to be called by \fBscsi_probe\fR(9F) when called by a target driver
  49 during \fBprobe\fR(9E) and \fBattach\fR(9E) to probe for a particular \fBSCSI
  50 \fRtarget on the bus. In the absence of an \fBHBA\fR-specific
  51 \fBtran_tgt_probe()\fR function, the default \fBscsi_probe\fR(9F) behavior is
  52 supplied by the function \fBscsi_hba_probe\fR(9F).
  53 .sp
  54 .LP
  55 The possible choices the \fBHBA \fRdriver may make are:
  56 .RS +4
  57 .TP
  58 .ie t \(bu
  59 .el o
  60 Initialize the \fBtran_tgt_probe\fR vector to point to
  61 \fBscsi_hba_probe\fR(9F), which results in the same behavior.
  62 .RE
  63 .RS +4
  64 .TP
  65 .ie t \(bu
  66 .el o
  67 Initialize the \fBtran_tgt_probe\fR vector to point to a private function in
  68 the \fBHBA\fR, which may call \fBscsi_hba_probe\fR(9F) before or after any
  69 necessary processing, as long as all the defined \fBscsi_probe\fR(9F) semantics
  70 are preserved.
  71 .RE
  72 .sp
  73 .LP
  74 \fIwaitfunc\fR indicates what \fBtran_tgt_probe()\fR should do when resources
  75 are not available:
  76 .sp
  77 .ne 2
  78 .na
  79 \fB\fBNULL_FUNC\fR \fR
  80 .ad
  81 .RS 15n
  82 Do not wait for resources.  See  \fBscsi_probe\fR(9F) for defined return values
  83 if no resources are available.
  84 .RE
  85
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fBSLEEP_FUNC\fR \fR
  90 .ad
  91 .RS 15n
  92 Wait indefinitely for resources.
  93 .RE
  94
  95 .SH SEE ALSO
  96 .sp
  97 .LP
  98 \fBattach\fR(9E), \fBprobe\fR(9E), \fBtran_tgt_free\fR(9E),
  99 \fBtran_tgt_init\fR(9E), \fBscsi_hba_probe\fR(9F), \fBscsi_probe\fR(9F),
 100 \fBscsi_device\fR(9S), \fBscsi_hba_tran\fR(9S)
 101 .sp
 102 .LP
 103 \fIWriting Device Drivers\fR