usr/src/man/man9s/scsi_hba_tran.9s

   1 '\" te
   2 .\"  Copyright (c) 2006 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 SCSI_HBA_TRAN 9S "May 30, 2006"
   7 .SH NAME
   8 scsi_hba_tran \- SCSI Host Bus Adapter (HBA) driver transport vector structure
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/scsi/scsi.h>
  13 .fi
  14
  15 .SH INTERFACE LEVEL
  16 .sp
  17 .LP
  18 Solaris architecture specific (Solaris DDI).
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 A \fBscsi_hba_tran_t\fR structure defines vectors that an \fBHBA\fR driver
  23 exports to \fBSCSA\fR interfaces so that \fBHBA\fR specific functions can be
  24 executed.
  25 .SH STRUCTURE MEMBERS
  26 .sp
  27 .in +2
  28 .nf
  29 dev_info_t          *tran_hba_dip;          /* HBAs dev_info
  30                                                 pointer */
  31 void                *tran_hba_private;      /* HBA softstate */
  32 void                *tran_tgt_private;      /* HBA target private
  33                                                 pointer */
  34 struct scsi_device  *tran_sd;               /* scsi_device */
  35 int                 (*tran_tgt_init)( );    /* Transport target */
  36                                                 Initialization */
  37 int                 (*tran_tgt_probe)( );   /* Transport target
  38                                                 probe */
  39 void                (*tran_tgt_free)( );    /* Transport target
  40                                                 free */
  41 int                 (*tran_start)( );       /* Transport start */
  42 int                 (*tran_reset)( );       /* Transport reset */
  43 int                 (*tran_abort)( );       /* Transport abort */
  44 int                 (*tran_getcap)( );      /* Capability
  45                                                 retrieval */
  46 int                 (*tran_setcap)( );      /* Capability
  47                                                 establishment */
  48 struct scsi_pkt     *(*tran_init_pkt)( );   /* Packet and DMA
  49                                                 allocation */
  50 void                (*tran_destroy_pkt)( ); /* Packet and DMA */
  51                                                 deallocation */
  52 void                (*tran_dmafree)( );     /* DMA deallocation */
  53 void                (*tran_sync_pkt)( );    /* Sync DMA */
  54 void                (*tran_reset_notify)( );/* Bus reset
  55                                                 notification */
  56 int                 (*tran_bus_reset)( );   /* Reset bus only */
  57 int                 (*tran_quiesce)( );     /* Quiesce a bus */
  58 int                 (*tran_unquiesce)( );   /* Unquiesce a bus */
  59 int                 (*tran_setup_pkt)( );   /* Initialization
  60                                                 for pkt */
  61 int                 (*tran_teardown_pkt)( );/* Deallocation */
  62 int                 (*tran_pkt_constructor) ( );
  63                                                /* Constructor */
  64 int                 (*tran_pkt_destructor) ( );
  65                                               /* Destructor */
  66 int                 tran_hba_len;            /* # bytes for
  67                                                  pkt_ha_private */
  68 int                 tran_interconnect_type;  /* transport
  69                                                  interconnect */
  70 .fi
  71 .in -2
  72
  73 .sp
  74 .ne 2
  75 .na
  76 \fB\fBtran_hba_dip\fR\fR
  77 .ad
  78 .RS 26n
  79 \fBdev_info\fR pointer to the \fBHBA\fR that supplies the \fBscsi_hba_tran\fR
  80 structure.
  81 .RE
  82
  83 .sp
  84 .ne 2
  85 .na
  86 \fB\fBtran_hba_private\fR\fR
  87 .ad
  88 .RS 26n
  89 Private pointer that the \fBHBA\fR driver can use to refer to the device's soft
  90 state structure.
  91 .RE
  92
  93 .sp
  94 .ne 2
  95 .na
  96 \fB\fBtran_tgt_private\fR\fR
  97 .ad
  98 .RS 26n
  99 Private pointer that the \fBHBA\fR can use to refer to per-target specific
 100 data. This field can only be used when the \fBSCSI_HBA_TRAN_CLONE\fR flag is
 101 specified in \fBscsi_hba_attach\fR(9F). In this case, the \fBHBA\fR driver must
 102 initialize this field in its \fBtran_tgt_init\fR(9E) entry point.
 103 .RE
 104
 105 .sp
 106 .ne 2
 107 .na
 108 \fB\fBtran_sd\fR\fR
 109 .ad
 110 .RS 26n
 111 Pointer to \fBscsi_device\fR(9S) structure if cloning; otherwise \fINULL\fR.
 112 .RE
 113
 114 .sp
 115 .ne 2
 116 .na
 117 \fB\fBtran_tgt_init\fR\fR
 118 .ad
 119 .RS 26n
 120 Function entry that allows per-target \fBHBA\fR initialization, if necessary.
 121 .RE
 122
 123 .sp
 124 .ne 2
 125 .na
 126 \fB\fBtran_tgt_probe\fR\fR
 127 .ad
 128 .RS 26n
 129 Function entry that allows per-target \fBscsi_probe\fR(9F) customization, if
 130 necessary.
 131 .RE
 132
 133 .sp
 134 .ne 2
 135 .na
 136 \fB\fBtran_tgt_free\fR\fR
 137 .ad
 138 .RS 26n
 139 Function entry that allows per-target \fBHBA\fR deallocation, if necessary.
 140 .RE
 141
 142 .sp
 143 .ne 2
 144 .na
 145 \fB\fBtran_start\fR\fR
 146 .ad
 147 .RS 26n
 148 Function entry that starts a \fBSCSI\fR command execution on the \fBHBA\fR
 149 hardware.
 150 .RE
 151
 152 .sp
 153 .ne 2
 154 .na
 155 \fB\fBtran_reset\fR\fR
 156 .ad
 157 .RS 26n
 158 Function entry that resets a \fBSCSI\fR bus or target device.
 159 .RE
 160
 161 .sp
 162 .ne 2
 163 .na
 164 \fB\fBtran_abort\fR\fR
 165 .ad
 166 .RS 26n
 167 Function entry that aborts one \fBSCSI\fR command, or all pending \fBSCSI\fR
 168 commands.
 169 .RE
 170
 171 .sp
 172 .ne 2
 173 .na
 174 \fB\fBtran_getcap\fR\fR
 175 .ad
 176 .RS 26n
 177 Function entry that retrieves a \fBSCSI\fR capability.
 178 .RE
 179
 180 .sp
 181 .ne 2
 182 .na
 183 \fB\fBtran_setcap\fR\fR
 184 .ad
 185 .RS 26n
 186 Function entry that sets a \fBSCSI\fR capability.
 187 .RE
 188
 189 .sp
 190 .ne 2
 191 .na
 192 \fB\fBtran_init_pkt\fR\fR
 193 .ad
 194 .RS 26n
 195 Function entry that allocates a \fBscsi_pkt\fR structure.
 196 .RE
 197
 198 .sp
 199 .ne 2
 200 .na
 201 \fB\fBtran_destroy_pkt\fR\fR
 202 .ad
 203 .RS 26n
 204 Function entry that frees a \fBscsi_pkt\fR structure allocated by
 205 \fBtran_init_pkt\fR.
 206 .RE
 207
 208 .sp
 209 .ne 2
 210 .na
 211 \fB\fBtran_dmafree\fR\fR
 212 .ad
 213 .RS 26n
 214 Function entry that frees \fBDMA\fR resources that were previously allocated by
 215 \fBtran_init_pkt\fR. Not called for \fBHBA\fR drivers that provide a
 216 \fBtran_setup_pkt\fR entry point.
 217 .RE
 218
 219 .sp
 220 .ne 2
 221 .na
 222 \fB\fBtran_sync_pkt\fR\fR
 223 .ad
 224 .RS 26n
 225 Synchronizes data in \fIpkt\fR after a data transfer has been completed. Not
 226 called for \fBHBA\fR drivers that provide a \fBtran_setup_pkt\fR entry point.
 227 .RE
 228
 229 .sp
 230 .ne 2
 231 .na
 232 \fB\fBtran_reset_notify\fR\fR
 233 .ad
 234 .RS 26n
 235 Function entry that allows a target to register a bus reset notification
 236 request with the \fBHBA\fR driver.
 237 .RE
 238
 239 .sp
 240 .ne 2
 241 .na
 242 \fB\fBtran_bus_reset\fR\fR
 243 .ad
 244 .RS 26n
 245 Function entry that resets the \fBSCSI\fR bus without resetting targets.
 246 .RE
 247
 248 .sp
 249 .ne 2
 250 .na
 251 \fB\fBtran_quiesce\fR\fR
 252 .ad
 253 .RS 26n
 254 Function entry that waits for all outstanding commands to complete and blocks
 255 (or queues) any \fBI/O\fR requests issued.
 256 .RE
 257
 258 .sp
 259 .ne 2
 260 .na
 261 \fB\fBtran_unquiesce\fR\fR
 262 .ad
 263 .RS 26n
 264 Function entry that allows \fBI/O\fR activities to resume on the \fBSCSI\fR
 265 bus.
 266 .RE
 267
 268 .sp
 269 .ne 2
 270 .na
 271 \fB\fBtran_setup_pkt\fR\fR
 272 .ad
 273 .RS 26n
 274 Optional entry point that initializes a \fBscsi_pkt\fR structure. See
 275 \fBtran_setup_pkt\fR(9E).
 276 .RE
 277
 278 .sp
 279 .ne 2
 280 .na
 281 \fB\fBtran_teardown_pkt\fR\fR
 282 .ad
 283 .RS 26n
 284 Entry point that releases resources allocated by \fBtran_setup_pkt\fR.
 285 .RE
 286
 287 .sp
 288 .ne 2
 289 .na
 290 \fB\fBtran_pkt_constructor\fR\fR
 291 .ad
 292 .RS 26n
 293 Additional optional entry point that performs the actions of a constructor. See
 294 \fBtran_setup_pkt\fR(9E).
 295 .RE
 296
 297 .sp
 298 .ne 2
 299 .na
 300 \fB\fBtran_pkt_destructor\fR\fR
 301 .ad
 302 .RS 26n
 303 Additional optional entry point that performs the actions of a destructor. See
 304 \fBtran_setup_pkt\fR(9E).
 305 .RE
 306
 307 .sp
 308 .ne 2
 309 .na
 310 \fB\fBtran_hba_len\fR\fR
 311 .ad
 312 .RS 26n
 313 Size of \fBpkt_ha_private\fR. See \fBtran_setup_pkt\fR(9E).
 314 .RE
 315
 316 .sp
 317 .ne 2
 318 .na
 319 \fB\fBtran_interconnect_type\fR\fR
 320 .ad
 321 .RS 26n
 322 Integer value that denotes the interconnect type of the transport as defined in
 323 the \fBservices.h\fR header file.
 324 .RE
 325
 326 .SH SEE ALSO
 327 .sp
 328 .LP
 329 \fBtran_abort\fR(9E), \fBtran_bus_reset\fR(9E), \fBtran_destroy_pkt\fR(9E),
 330 \fBtran_dmafree\fR(9E), \fBtran_getcap\fR(9E), \fBtran_init_pkt\fR(9E),
 331 \fBtran_quiesce\fR(9E), \fBtran_reset\fR(9E), \fBtran_reset_notify\fR(9E),
 332 \fBtran_setcap\fR(9E), \fBtran_setup_pkt\fR(9E), \fBtran_start\fR(9E),
 333 \fBtran_sync_pkt\fR(9E), \fBtran_tgt_free\fR(9E), \fBtran_tgt_init\fR(9E),
 334 \fBtran_tgt_probe\fR(9E), \fBtran_unquiesce\fR(9E), \fBddi_dma_sync\fR(9F),
 335 \fBscsi_hba_attach\fR(9F), \fBscsi_hba_pkt_alloc\fR(9F),
 336 \fBscsi_hba_pkt_free\fR(9F), \fBscsi_probe\fR(9F), \fBscsi_device\fR(9S),
 337 \fBscsi_pkt\fR(9S)
 338 .sp
 339 .LP
 340 \fIWriting Device Drivers\fR