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

   1 '\" te
   2 .\"  Copyright (c) 2000, 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_EXTENDED_SENSE 9S "Aug 30, 1995"
   7 .SH NAME
   8 scsi_extended_sense \- SCSI extended sense 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 DDI specific (Solaris DDI).
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The \fBscsi_extended_sense\fR structure for error codes \fB0x70\fR (current
  23 errors) and \fB0x71\fR (deferred errors) is returned on a successful \fBREQUEST
  24 SENSE\fR command. \fBSCSI-2 \fRcompliant targets are required to return at
  25 least the first 18 bytes of this structure. This structure is part of
  26 \fBscsi_device\fR(9S) structure.
  27 .SH STRUCTURE MEMBERS
  28 .sp
  29 .in +2
  30 .nf
  31 uchar_t  es_valid   :1;     /* Sense data is valid */
  32 uchar_t  es_class   :3;     /* Error Class- fixed at 0x7 */
  33 uchar_t  es_code    :4;     /* Vendor Unique error code */
  34 uchar_t  es_segnum;         /* Segment number: for COPY cmd only */
  35 uchar_t  es_filmk   :1;     /* File Mark Detected */
  36 uchar_t  es_eom     :1;     /* End of Media */
  37 uchar_t  es_ili     :1;     /* Incorrect Length Indicator */
  38 uchar_t  es_key     :4;     /* Sense key */
  39 uchar_t  es_info_1;         /* Information byte 1 */
  40 uchar_t  es_info_2;         /* Information byte 2 */
  41 uchar_t  es_info_3;         /* Information byte 3 */
  42 uchar_t  es_info_4;         /* Information byte 4 */
  43 uchar_t  es_add_len;        /* Number of additional bytes */
  44 uchar_t  es_cmd_info[4];    /* Command specific information */
  45 uchar_t  es_add_code;       /* Additional Sense Code */
  46 uchar_t  es_qual_code;      /* Additional Sense Code Qualifier */
  47 uchar_t  es_fru_code;       /* Field Replaceable Unit Code */
  48 uchar_t  es_skey_specific[3]; /* Sense Key Specific information */
  49 .fi
  50 .in -2
  51
  52 .sp
  53 .LP
  54 \fBes_valid\fR, if set, indicates that the information field contains valid
  55 information.
  56 .sp
  57 .LP
  58 \fBes_class\fR should be  \fB0x7\fR.
  59 .sp
  60 .LP
  61 \fBes_code\fR is either  \fB0x0\fR or \fB0x1\fR.
  62 .sp
  63 .LP
  64 \fBes_segnum\fR contains the number of the current segment descriptor if the
  65 \fBREQUEST SENSE \fRcommand is in response to a \fBCOPY\fR, \fBCOMPARE\fR, and
  66 \fBCOPY AND VERIFY\fR command.
  67 .sp
  68 .LP
  69 \fBes_filmk\fR, if set, indicates that the current command had read a file mark
  70 or set mark (sequential access devices only).
  71 .sp
  72 .LP
  73 \fBes_eom\fR, if set, indicates that an end-of-medium condition exists
  74 (sequential access and printer devices only).
  75 .sp
  76 .LP
  77 \fBes_ili\fR, if set, indicates that the requested logical block length did not
  78 match the logical block length of the data on the medium.
  79 .sp
  80 .LP
  81 \fBes_key\fR indicates generic information describing an error or exception
  82 condition. The following sense keys are defined:
  83 .sp
  84 .ne 2
  85 .na
  86 \fB\fBKEY_NO_SENSE\fR \fR
  87 .ad
  88 .sp .6
  89 .RS 4n
  90 Indicates that there is no specific sense key information to be reported.
  91 .RE
  92
  93 .sp
  94 .ne 2
  95 .na
  96 \fB\fBKEY_RECOVERABLE_ERROR\fR \fR
  97 .ad
  98 .sp .6
  99 .RS 4n
 100 Indicates that the last command completed successfully with some recovery
 101 action performed by the target.
 102 .RE
 103
 104 .sp
 105 .ne 2
 106 .na
 107 \fB\fBKEY_NOT_READY\fR \fR
 108 .ad
 109 .sp .6
 110 .RS 4n
 111 Indicates that the logical unit addressed cannot be accessed.
 112 .RE
 113
 114 .sp
 115 .ne 2
 116 .na
 117 \fB\fBKEY_MEDIUM_ERROR\fR \fR
 118 .ad
 119 .sp .6
 120 .RS 4n
 121 Indicates that the command terminated with a non-recovered error condition that
 122 was probably caused by a flaw on the medium or an error in the recorded data.
 123 .RE
 124
 125 .sp
 126 .ne 2
 127 .na
 128 \fB\fBKEY_HARDWARE_ERROR\fR \fR
 129 .ad
 130 .sp .6
 131 .RS 4n
 132 Indicates that the target detected a non-recoverable hardware failure while
 133 performing the command or during a self test.
 134 .RE
 135
 136 .sp
 137 .ne 2
 138 .na
 139 \fB\fBKEY_ILLEGAL_REQUEST\fR \fR
 140 .ad
 141 .sp .6
 142 .RS 4n
 143 Indicates that there was an illegal parameter in the \fBCDB\fR or in the
 144 additional parameters supplied as data for some commands.
 145 .RE
 146
 147 .sp
 148 .ne 2
 149 .na
 150 \fB\fBKEY_UNIT_ATTENTION\fR \fR
 151 .ad
 152 .sp .6
 153 .RS 4n
 154 Indicates that the removable medium might have been changed or the target has
 155 been reset.
 156 .RE
 157
 158 .sp
 159 .ne 2
 160 .na
 161 \fB\fBKEY_WRITE_PROTECT/KEY_DATA_PROTECT\fR \fR
 162 .ad
 163 .sp .6
 164 .RS 4n
 165 Indicates that a command that reads or writes the medium was attempted on a
 166 block that is protected from this operation.
 167 .RE
 168
 169 .sp
 170 .ne 2
 171 .na
 172 \fB\fBKEY_BLANK_CHECK\fR \fR
 173 .ad
 174 .sp .6
 175 .RS 4n
 176 Indicates that a write-once device or a sequential access device encountered
 177 blank medium or format-defined end-of-data indication while reading or a
 178 write-once device encountered a non-blank medium while writing.
 179 .RE
 180
 181 .sp
 182 .ne 2
 183 .na
 184 \fB\fBKEY_VENDOR_UNIQUE\fR \fR
 185 .ad
 186 .sp .6
 187 .RS 4n
 188 This sense key is available for reporting vendor-specific conditions.
 189 .RE
 190
 191 .sp
 192 .ne 2
 193 .na
 194 \fB\fBKEY_COPY_ABORTED\fR \fR
 195 .ad
 196 .sp .6
 197 .RS 4n
 198 Indicates that a \fBCOPY\fR, \fBCOMPARE\fR, and \fBCOPY AND VERIFY\fR  command
 199 was aborted.
 200 .RE
 201
 202 .sp
 203 .ne 2
 204 .na
 205 \fB\fBKEY_ABORTED_COMMAND\fR \fR
 206 .ad
 207 .sp .6
 208 .RS 4n
 209 Indicates that the target aborted the command.
 210 .RE
 211
 212 .sp
 213 .ne 2
 214 .na
 215 \fB\fBKEY_EQUAL\fR \fR
 216 .ad
 217 .sp .6
 218 .RS 4n
 219 Indicates that a  \fBSEARCH\fR \fBDATA\fR command has satisfied an equal
 220 comparison.
 221 .RE
 222
 223 .sp
 224 .ne 2
 225 .na
 226 \fB\fBKEY_VOLUME_OVERFLOW\fR \fR
 227 .ad
 228 .sp .6
 229 .RS 4n
 230 Indicates that a buffered peripheral device has reached the end-of-partition
 231 and data might remain in the buffer that has not been written to the medium.
 232 .RE
 233
 234 .sp
 235 .ne 2
 236 .na
 237 \fB\fBKEY_MISCOMPARE\fR \fR
 238 .ad
 239 .sp .6
 240 .RS 4n
 241 Indicates that the source data did not match the data read from the medium.
 242 .RE
 243
 244 .sp
 245 .ne 2
 246 .na
 247 \fB\fBKEY_RESERVE\fR \fR
 248 .ad
 249 .sp .6
 250 .RS 4n
 251 Indicates that the target is currently reserved by a different initiator.
 252 .RE
 253
 254 .sp
 255 .LP
 256 \fBes_info_{1,2,3,4}\fR is device-type or command specific.
 257 .sp
 258 .LP
 259 \fBes_add_len\fR indicates the number of additional sense bytes to follow.
 260 .sp
 261 .LP
 262 \fBes_cmd_info\fR contains information that depends on the command that was
 263 executed.
 264 .sp
 265 .LP
 266 \fBes_add_code\fR (\fBASC\fR) indicates further information related to the
 267 error or exception condition reported in the sense key field.
 268 .sp
 269 .LP
 270 \fBes_qual_code\fR (\fBASCQ)\fR indicates detailed information related to the
 271 additional sense code.
 272 .sp
 273 .LP
 274 \fBes_fru_code\fR (\fBFRU\fR) indicates a device-specific mechanism to unit
 275 that has failed.
 276 .sp
 277 .LP
 278 \fBes_skey_specific\fR is defined when the value of the sense-key specific
 279 valid bit (bit 7) is \fB1\fR. This field is reserved for sense keys not defined
 280 above.
 281 .SH SEE ALSO
 282 .sp
 283 .LP
 284 \fBscsi_device\fR(9S)
 285 .sp
 286 .LP
 287 \fIANSI Small Computer System Interface-2 (SCSI-2)\fR
 288 .sp
 289 .LP
 290 \fIWriting Device Drivers\fR