usr/src/man/man9f/scsi_hba_lookup_capstr.9f

   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_LOOKUP_CAPSTR 9F "May 13, 2006"
   7 .SH NAME
   8 scsi_hba_lookup_capstr \- return index matching capability string
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/scsi/scsi.h>
  13
  14
  15
  16 \fBint\fR \fBscsi_hba_lookup_capstr\fR(\fBchar *\fR\fIcapstr\fR);
  17 .fi
  18
  19 .SH INTERFACE LEVEL
  20 .sp
  21 .LP
  22 Solaris architecture specific (Solaris DDI).
  23 .SH PARAMETERS
  24 .sp
  25 .ne 2
  26 .na
  27 \fB\fIcapstr\fR\fR
  28 .ad
  29 .RS 10n
  30 Pointer to a string
  31 .RE
  32
  33 .SH DESCRIPTION
  34 .sp
  35 .LP
  36 The \fBscsi_hba_lookup_capstr()\fR function attempts to match \fIcapstr\fR
  37 against a known set of capability strings. If found, the defined index for the
  38 matched capability is returned.
  39 .sp
  40 .LP
  41 The following indices are defined for the capability strings listed below.
  42 .sp
  43 .ne 2
  44 .na
  45 \fB\fBSCSI_CAP_DMA_MAX\fR\fR
  46 .ad
  47 .sp .6
  48 .RS 4n
  49 "\fBdma-max\fR" or "\fBdma_max\fR"
  50 .RE
  51
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fBSCSI_CAP_MSG_OUT\fR\fR
  56 .ad
  57 .sp .6
  58 .RS 4n
  59 "\fBmsg-out\fR" or "\fBmsg_out\fR"
  60 .RE
  61
  62 .sp
  63 .ne 2
  64 .na
  65 \fB\fBSCSI_CAP_DISCONNECT\fR\fR
  66 .ad
  67 .sp .6
  68 .RS 4n
  69 "\fBdisconnect\fR"
  70 .RE
  71
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fBSCSI_CAP_SYNCHRONOUS\fR\fR
  76 .ad
  77 .sp .6
  78 .RS 4n
  79 "\fBsynchronous\fR"
  80 .RE
  81
  82 .sp
  83 .ne 2
  84 .na
  85 \fB\fBSCSI_CAP_WIDE_XFER\fR\fR
  86 .ad
  87 .sp .6
  88 .RS 4n
  89 "\fBwide-xfer\fR" or "\fBwide_xfer\fR"
  90 .RE
  91
  92 .sp
  93 .ne 2
  94 .na
  95 \fB\fBSCSI_CAP_PARITY\fR\fR
  96 .ad
  97 .sp .6
  98 .RS 4n
  99 "\fBparity\fR"
 100 .RE
 101
 102 .sp
 103 .ne 2
 104 .na
 105 \fB\fBSCSI_CAP_INITIATOR_ID\fR\fR
 106 .ad
 107 .sp .6
 108 .RS 4n
 109 "\fBinitiator-id\fR"
 110 .RE
 111
 112 .sp
 113 .ne 2
 114 .na
 115 \fB\fBSCSI_CAP_UNTAGGED_QING\fR\fR
 116 .ad
 117 .sp .6
 118 .RS 4n
 119 "\fBuntagged-qing\fR"
 120 .RE
 121
 122 .sp
 123 .ne 2
 124 .na
 125 \fB\fBSCSI_CAP_TAGGED_QING\fR\fR
 126 .ad
 127 .sp .6
 128 .RS 4n
 129 "\fBtagged-qing\fR"
 130 .RE
 131
 132 .sp
 133 .ne 2
 134 .na
 135 \fB\fBSCSI_CAP_ARQ\fR\fR
 136 .ad
 137 .sp .6
 138 .RS 4n
 139 "\fBauto-rqsense\fR"
 140 .RE
 141
 142 .sp
 143 .ne 2
 144 .na
 145 \fB\fBSCSI_CAP_LINKED_CMDS\fR\fR
 146 .ad
 147 .sp .6
 148 .RS 4n
 149 "\fBlinked-cmds\fR"
 150 .RE
 151
 152 .sp
 153 .ne 2
 154 .na
 155 \fB\fBSCSI_CAP_SECTOR_SIZE\fR\fR
 156 .ad
 157 .sp .6
 158 .RS 4n
 159 "\fBsector-size\fR"
 160 .RE
 161
 162 .sp
 163 .ne 2
 164 .na
 165 \fB\fBSCSI_CAP_TOTAL_SECTORS\fR\fR
 166 .ad
 167 .sp .6
 168 .RS 4n
 169 "\fBtotal-sectors\fR"
 170 .RE
 171
 172 .sp
 173 .ne 2
 174 .na
 175 \fB\fBSCSI_CAP_GEOMETRY\fR\fR
 176 .ad
 177 .sp .6
 178 .RS 4n
 179 "\fBgeometry\fR"
 180 .RE
 181
 182 .sp
 183 .ne 2
 184 .na
 185 \fB\fBSCSI_CAP_RESET_NOTIFICATION\fR\fR
 186 .ad
 187 .sp .6
 188 .RS 4n
 189 "\fBreset-notification\fR"
 190 .RE
 191
 192 .sp
 193 .ne 2
 194 .na
 195 \fB\fBSCSI_CAP_QFULL_RETRIES\fR\fR
 196 .ad
 197 .sp .6
 198 .RS 4n
 199 "\fBqfull-retries\fR"
 200 .RE
 201
 202 .sp
 203 .ne 2
 204 .na
 205 \fB\fBSCSI_CAP_QFULL_RETRY_INTERVAL\fR\fR
 206 .ad
 207 .sp .6
 208 .RS 4n
 209 "\fBqfull-retry-interval\fR"
 210 .RE
 211
 212 .sp
 213 .ne 2
 214 .na
 215 \fB\fBSCSI_CAP_LUN_RESET\fR\fR
 216 .ad
 217 .sp .6
 218 .RS 4n
 219 "\fBlun-reset\fR"
 220 .RE
 221
 222 .sp
 223 .ne 2
 224 .na
 225 \fB\fBSCSI_CAP_CDB_LEN\fR\fR
 226 .ad
 227 .sp .6
 228 .RS 4n
 229 "\fBmax-cdb-length\fR"
 230 .RE
 231
 232 .SH RETURN VALUES
 233 .sp
 234 .LP
 235 The \fBscsi_hba_lookup_capstr()\fR function returns a non-negative index value
 236 that corresponds to the capability string. If the string does not match a known
 237 capability, \fB-1\fR is returned.
 238 .SH CONTEXT
 239 .sp
 240 .LP
 241 The \fBscsi_hba_lookup_capstr()\fR function can be called from user, interrupt,
 242 or kernel context.
 243 .SH ATTRIBUTES
 244 .sp
 245 .LP
 246 See \fBattributes\fR(5) for descriptions of the following attributes:
 247 .sp
 248
 249 .sp
 250 .TS
 251 box;
 252 c | c
 253 l | l .
 254 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 255 _
 256 Interface Stability     Committed
 257 .TE
 258
 259 .SH SEE ALSO
 260 .sp
 261 .LP
 262 \fBtran_getcap\fR(9E), \fBtran_setcap\fR(9E), \fBscsi_ifgetcap\fR(9F),
 263 \fBscsi_ifsetcap\fR(9F), \fBscsi_reset_notify\fR(9F)
 264 .sp
 265 .LP
 266 \fIWriting Device Drivers\fR