sys/cam/scsi/scsi_da.h

   1 /*
   2  * Structures and definitions for SCSI commands to Direct Access Devices
   3  */
   4
   5 /*-
   6  * Some lines of this file come from a file of the name "scsi.h"
   7  * distributed by OSF as part of mach2.5,
   8  *  so the following disclaimer has been kept.
   9  *
  10  * Copyright 1990 by Open Software Foundation,
  11  * Grenoble, FRANCE
  12  *
  13  *              All Rights Reserved
  14  *
  15  *   Permission to use, copy, modify, and distribute this software and
  16  * its documentation for any purpose and without fee is hereby granted,
  17  * provided that the above copyright notice appears in all copies and
  18  * that both the copyright notice and this permission notice appear in
  19  * supporting documentation, and that the name of OSF or Open Software
  20  * Foundation not be used in advertising or publicity pertaining to
  21  * distribution of the software without specific, written prior
  22  * permission.
  23  *
  24  *   OSF DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE
  25  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS,
  26  * IN NO EVENT SHALL OSF BE LIABLE FOR ANY SPECIAL, INDIRECT, OR
  27  * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  28  * LOSS OF USE, DATA OR PROFITS, WHETHER IN ACTION OF CONTRACT,
  29  * NEGLIGENCE, OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
  30  * WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  31  */
  32
  33 /*-
  34  * Largely written by Julian Elischer (julian@tfs.com)
  35  * for TRW Financial Systems.
  36  *
  37  * TRW Financial Systems, in accordance with their agreement with Carnegie
  38  * Mellon University, makes this software available to CMU to distribute
  39  * or use in any manner that they see fit as long as this message is kept with
  40  * the software. For this reason TFS also grants any other persons or
  41  * organisations permission to use or modify this software.
  42  *
  43  * TFS supplies this software to be publicly redistributed
  44  * on the understanding that TFS is not responsible for the correct
  45  * functioning of this software in any circumstances.
  46  *
  47  * Ported to run under 386BSD by Julian Elischer (julian@tfs.com) Sept 1992
  48  *
  49  * $FreeBSD$
  50  */
  51
  52 #ifndef _SCSI_SCSI_DA_H
  53 #define _SCSI_SCSI_DA_H 1
  54
  55 #include <sys/cdefs.h>
  56
  57 struct scsi_rezero_unit
  58 {
  59         u_int8_t opcode;
  60 #define SRZU_LUN_MASK 0xE0
  61         u_int8_t byte2;
  62         u_int8_t reserved[3];
  63         u_int8_t control;
  64 };
  65
  66 /*
  67  * NOTE:  The lower three bits of byte2 of the format CDB are the same as
  68  * the lower three bits of byte2 of the read defect data CDB, below.
  69  */
  70 struct scsi_format_unit
  71 {
  72         u_int8_t opcode;
  73         u_int8_t byte2;
  74 #define FU_FORMAT_MASK  SRDD10_DLIST_FORMAT_MASK
  75 #define FU_BLOCK_FORMAT SRDD10_BLOCK_FORMAT
  76 #define FU_BFI_FORMAT   SRDD10_BYTES_FROM_INDEX_FORMAT
  77 #define FU_PHYS_FORMAT  SRDD10_PHYSICAL_SECTOR_FORMAT
  78 #define FU_CMPLST       0x08
  79 #define FU_FMT_DATA     0x10
  80         u_int8_t vendor_specific;
  81         u_int8_t interleave[2];
  82         u_int8_t control;
  83 };
  84
  85 struct scsi_reassign_blocks
  86 {
  87         u_int8_t opcode;
  88         u_int8_t byte2;
  89         u_int8_t unused[3];
  90         u_int8_t control;
  91 };
  92
  93 struct scsi_read_defect_data_10
  94 {
  95         u_int8_t opcode;
  96
  97         /*
  98          * The most significant 3 bits are the LUN, the other 5 are
  99          * reserved.
 100          */
 101 #define SRDD10_LUN_MASK 0xE0
 102         u_int8_t byte2;
 103 #define SRDD10_GLIST 0x08
 104 #define SRDD10_PLIST 0x10
 105 #define SRDD10_DLIST_FORMAT_MASK 0x07
 106 #define SRDD10_BLOCK_FORMAT            0x00
 107 #define SRDD10_BYTES_FROM_INDEX_FORMAT 0x04
 108 #define SRDD10_PHYSICAL_SECTOR_FORMAT  0x05
 109         u_int8_t format;
 110
 111         u_int8_t reserved[4];
 112
 113         u_int8_t alloc_length[2];
 114
 115         u_int8_t control;
 116 };
 117
 118 struct scsi_read_defect_data_12
 119 {
 120         u_int8_t opcode;
 121
 122         /*
 123          * The most significant 3 bits are the LUN, the other 5 are
 124          * reserved.
 125          */
 126 #define SRDD12_LUN_MASK 0xE0
 127         u_int8_t byte2;
 128
 129 #define SRDD12_GLIST 0x08
 130 #define SRDD12_PLIST 0x10
 131 #define SRDD12_DLIST_FORMAT_MASK 0x07
 132 #define SRDD12_BLOCK_FORMAT            0x00
 133 #define SRDD12_BYTES_FROM_INDEX_FORMAT 0x04
 134 #define SRDD12_PHYSICAL_SECTOR_FORMAT  0x05
 135         u_int8_t format;
 136
 137         u_int8_t reserved[4];
 138
 139         u_int8_t alloc_length[4];
 140
 141         u_int8_t control;
 142
 143 };
 144
 145
 146 /*
 147  * Opcodes
 148  */
 149 #define REZERO_UNIT             0x01
 150 #define FORMAT_UNIT             0x04
 151 #define REASSIGN_BLOCKS         0x07
 152 #define MODE_SELECT             0x15
 153 #define MODE_SENSE              0x1a
 154 #define READ_FORMAT_CAPACITIES  0x23
 155 #define WRITE_AND_VERIFY        0x2e
 156 #define VERIFY                  0x2f
 157 #define READ_DEFECT_DATA_10     0x37
 158 #define READ_DEFECT_DATA_12     0xb7
 159
 160 struct format_defect_list_header
 161 {
 162         u_int8_t reserved;
 163         u_int8_t byte2;
 164 #define FU_DLH_VS       0x01
 165 #define FU_DLH_IMMED    0x02
 166 #define FU_DLH_DSP      0x04
 167 #define FU_DLH_IP       0x08
 168 #define FU_DLH_STPF     0x10
 169 #define FU_DLH_DCRT     0x20
 170 #define FU_DLH_DPRY     0x40
 171 #define FU_DLH_FOV      0x80
 172         u_int8_t defect_list_length[2];
 173 };
 174
 175 struct format_ipat_descriptor
 176 {
 177         u_int8_t byte1;
 178 #define FU_INIT_NO_HDR          0x00
 179 #define FU_INIT_LBA_MSB         0x40
 180 #define FU_INIT_LBA_EACH        0x80
 181 #define FU_INIT_SI              0x20
 182         u_int8_t pattern_type;
 183 #define FU_INIT_PAT_DEFAULT     0x00
 184 #define FU_INIT_PAT_REPEAT      0x01
 185         u_int8_t pat_length[2];
 186 };
 187
 188 struct scsi_read_format_capacities
 189 {
 190         uint8_t opcode;         /* READ_FORMAT_CAPACITIES */
 191         uint8_t byte2;
 192 #define SRFC_LUN_MASK   0xE0
 193         uint8_t reserved0[5];
 194         uint8_t alloc_length[2];
 195         uint8_t reserved1[3];
 196 };
 197
 198 struct scsi_verify
 199 {
 200         uint8_t opcode;         /* VERIFY */
 201         uint8_t byte2;
 202 #define SVFY_LUN_MASK   0xE0
 203 #define SVFY_RELADR     0x01
 204 #define SVFY_BYTECHK    0x02
 205 #define SVFY_DPO        0x10
 206         uint8_t addr[4];        /* LBA to begin verification at */
 207         uint8_t reserved0[1];
 208         uint8_t len[2];         /* number of blocks to verify */
 209         uint8_t reserved1[3];
 210 };
 211
 212 struct scsi_write_and_verify
 213 {
 214         uint8_t opcode;         /* WRITE_AND_VERIFY */
 215         uint8_t byte2;
 216 #define SWVY_LUN_MASK   0xE0
 217 #define SWVY_RELADR     0x01
 218 #define SWVY_BYTECHK    0x02
 219 #define SWVY_DPO        0x10
 220         uint8_t addr[4];        /* LBA to begin verification at */
 221         uint8_t reserved0[1];
 222         uint8_t len[2];         /* number of blocks to write and verify */
 223         uint8_t reserved1[3];
 224 };
 225
 226 /*
 227  * Replies to READ_FORMAT_CAPACITIES look like this:
 228  *
 229  * struct format_capacity_list_header
 230  * struct format_capacity_descriptor[1..n]
 231  *
 232  * These are similar, but not totally identical to, the
 233  * defect list used to format a rigid disk.
 234  *
 235  * The appropriate csio_decode() format string looks like this:
 236  * "{} *i3 {Len} i1 {Blocks} i4 {} *b6 {Code} b2 {Blocklen} i3"
 237  *
 238  * If the capacity_list_length is greater than
 239  * sizeof(struct format_capacity_descriptor), then there are
 240  * additional format capacity descriptors available which
 241  * denote which format(s) the drive can handle.
 242  *
 243  * (Source: USB Mass Storage UFI Specification)
 244  */
 245
 246 struct format_capacity_list_header {
 247         uint8_t unused[3];
 248         uint8_t capacity_list_length;
 249 };
 250
 251 struct format_capacity_descriptor {
 252         uint8_t nblocks[4];     /* total number of LBAs */
 253         uint8_t byte4;          /* only present in max/cur descriptor */
 254 #define FCD_CODE_MASK   0x03    /* mask for code field above */
 255 #define FCD_UNFORMATTED 0x01    /* unformatted media present,
 256                                  * maximum capacity returned */
 257 #define FCD_FORMATTED   0x02    /* formatted media present,
 258                                  * current capacity returned */
 259 #define FCD_NOMEDIA     0x03    /* no media present,
 260                                  * maximum device capacity returned */
 261         uint8_t block_length[3];        /* length of an LBA in bytes */
 262 };
 263
 264 struct scsi_reassign_blocks_data
 265 {
 266         u_int8_t reserved[2];
 267         u_int8_t length[2];
 268         struct {
 269                 u_int8_t dlbaddr[4];    /* defect logical block address */
 270         } defect_descriptor[1];
 271 };
 272
 273
 274 /*
 275  * This is the list header for the READ DEFECT DATA(10) command above.
 276  * It may be a bit wrong to append the 10 at the end of the data structure,
 277  * since it's only 4 bytes but it does tie it to the 10 byte command.
 278  */
 279 struct scsi_read_defect_data_hdr_10
 280 {
 281         u_int8_t reserved;
 282 #define SRDDH10_GLIST 0x08
 283 #define SRDDH10_PLIST 0x10
 284 #define SRDDH10_DLIST_FORMAT_MASK 0x07
 285 #define SRDDH10_BLOCK_FORMAT            0x00
 286 #define SRDDH10_BYTES_FROM_INDEX_FORMAT 0x04
 287 #define SRDDH10_PHYSICAL_SECTOR_FORMAT  0x05
 288         u_int8_t format;
 289         u_int8_t length[2];
 290 };
 291
 292 struct scsi_defect_desc_block
 293 {
 294         u_int8_t address[4];
 295 };
 296
 297 struct scsi_defect_desc_bytes_from_index
 298 {
 299         u_int8_t cylinder[3];
 300         u_int8_t head;
 301         u_int8_t bytes_from_index[4];
 302 };
 303
 304 struct scsi_defect_desc_phys_sector
 305 {
 306         u_int8_t cylinder[3];
 307         u_int8_t head;
 308         u_int8_t sector[4];
 309 };
 310
 311 struct scsi_read_defect_data_hdr_12
 312 {
 313         u_int8_t reserved;
 314 #define SRDDH12_GLIST 0x08
 315 #define SRDDH12_PLIST 0x10
 316 #define SRDDH12_DLIST_FORMAT_MASK 0x07
 317 #define SRDDH12_BLOCK_FORMAT            0x00
 318 #define SRDDH12_BYTES_FROM_INDEX_FORMAT 0x04
 319 #define SRDDH12_PHYSICAL_SECTOR_FORMAT  0x05
 320         u_int8_t format;
 321         u_int8_t length[4];
 322 };
 323
 324 union   disk_pages /* this is the structure copied from osf */
 325 {
 326         struct format_device_page {
 327                 u_int8_t pg_code;       /* page code (should be 3)            */
 328 #define SMS_FORMAT_DEVICE_PAGE  0x03    /* only 6 bits valid */
 329                 u_int8_t pg_length;     /* page length (should be 0x16)       */
 330 #define SMS_FORMAT_DEVICE_PLEN  0x16
 331                 u_int8_t trk_z_1;       /* tracks per zone (MSB)              */
 332                 u_int8_t trk_z_0;       /* tracks per zone (LSB)              */
 333                 u_int8_t alt_sec_1;     /* alternate sectors per zone (MSB)   */
 334                 u_int8_t alt_sec_0;     /* alternate sectors per zone (LSB)   */
 335                 u_int8_t alt_trk_z_1;   /* alternate tracks per zone (MSB)    */
 336                 u_int8_t alt_trk_z_0;   /* alternate tracks per zone (LSB)    */
 337                 u_int8_t alt_trk_v_1;   /* alternate tracks per volume (MSB)  */
 338                 u_int8_t alt_trk_v_0;   /* alternate tracks per volume (LSB)  */
 339                 u_int8_t ph_sec_t_1;    /* physical sectors per track (MSB)   */
 340                 u_int8_t ph_sec_t_0;    /* physical sectors per track (LSB)   */
 341                 u_int8_t bytes_s_1;     /* bytes per sector (MSB)             */
 342                 u_int8_t bytes_s_0;     /* bytes per sector (LSB)             */
 343                 u_int8_t interleave_1;  /* interleave (MSB)                   */
 344                 u_int8_t interleave_0;  /* interleave (LSB)                   */
 345                 u_int8_t trk_skew_1;    /* track skew factor (MSB)            */
 346                 u_int8_t trk_skew_0;    /* track skew factor (LSB)            */
 347                 u_int8_t cyl_skew_1;    /* cylinder skew (MSB)                */
 348                 u_int8_t cyl_skew_0;    /* cylinder skew (LSB)                */
 349                 u_int8_t flags;         /* various */
 350 #define                 DISK_FMT_SURF   0x10
 351 #define                 DISK_FMT_RMB    0x20
 352 #define                 DISK_FMT_HSEC   0x40
 353 #define                 DISK_FMT_SSEC   0x80
 354                 u_int8_t reserved21;
 355                 u_int8_t reserved22;
 356                 u_int8_t reserved23;
 357         } format_device;
 358         struct rigid_geometry_page {
 359                 u_int8_t pg_code;       /* page code (should be 4)            */
 360 #define SMS_RIGID_GEOMETRY_PAGE 0x04
 361                 u_int8_t pg_length;     /* page length (should be 0x16)       */
 362 #define SMS_RIGID_GEOMETRY_PLEN 0x16
 363                 u_int8_t ncyl_2;        /* number of cylinders (MSB)          */
 364                 u_int8_t ncyl_1;        /* number of cylinders                */
 365                 u_int8_t ncyl_0;        /* number of cylinders (LSB)          */
 366                 u_int8_t nheads;        /* number of heads                    */
 367                 u_int8_t st_cyl_wp_2;   /* starting cyl., write precomp (MSB) */
 368                 u_int8_t st_cyl_wp_1;   /* starting cyl., write precomp       */
 369                 u_int8_t st_cyl_wp_0;   /* starting cyl., write precomp (LSB) */
 370                 u_int8_t st_cyl_rwc_2;  /* starting cyl., red. write cur (MSB)*/
 371                 u_int8_t st_cyl_rwc_1;  /* starting cyl., red. write cur      */
 372                 u_int8_t st_cyl_rwc_0;  /* starting cyl., red. write cur (LSB)*/
 373                 u_int8_t driv_step_1;   /* drive step rate (MSB)              */
 374                 u_int8_t driv_step_0;   /* drive step rate (LSB)              */
 375                 u_int8_t land_zone_2;   /* landing zone cylinder (MSB)        */
 376                 u_int8_t land_zone_1;   /* landing zone cylinder              */
 377                 u_int8_t land_zone_0;   /* landing zone cylinder (LSB)        */
 378                 u_int8_t rpl;           /* rotational position locking (2 bits) */
 379                 u_int8_t rot_offset;    /* rotational offset */
 380                 u_int8_t reserved19;
 381                 u_int8_t medium_rot_rate_1; /* medium rotation rate (RPM) (MSB) */
 382                 u_int8_t medium_rot_rate_0; /* medium rotation rate (RPM) (LSB) */
 383                 u_int8_t reserved22;
 384                 u_int8_t reserved23;
 385         } rigid_geometry;
 386         struct flexible_disk_page {
 387                 u_int8_t pg_code;       /* page code (should be 5)            */
 388 #define SMS_FLEXIBLE_GEOMETRY_PAGE 0x05
 389                 u_int8_t pg_length;     /* page length (should be 0x1E)       */
 390 #define SMS_FLEXIBLE_GEOMETRY_PLEN 0x1E
 391                 u_int8_t xfr_rate_1;    /* transfer rate (MSB)                */
 392                 u_int8_t xfr_rate_0;    /* transfer rate (LSB)                */
 393                 u_int8_t nheads;        /* number of heads                    */
 394                 u_int8_t sec_per_track; /* Sectors per track                  */
 395                 u_int8_t bytes_s_1;     /* bytes per sector (MSB)             */
 396                 u_int8_t bytes_s_0;     /* bytes per sector (LSB)             */
 397                 u_int8_t ncyl_1;        /* number of cylinders (MSB)          */
 398                 u_int8_t ncyl_0;        /* number of cylinders (LSB)          */
 399                 u_int8_t st_cyl_wp_1;   /* starting cyl., write precomp (MSB) */
 400                 u_int8_t st_cyl_wp_0;   /* starting cyl., write precomp (LSB) */
 401                 u_int8_t st_cyl_rwc_1;  /* starting cyl., red. write cur (MSB)*/
 402                 u_int8_t st_cyl_rwc_0;  /* starting cyl., red. write cur (LSB)*/
 403                 u_int8_t driv_step_1;   /* drive step rate (MSB)              */
 404                 u_int8_t driv_step_0;   /* drive step rate (LSB)              */
 405                 u_int8_t driv_step_pw;  /* drive step pulse width             */
 406                 u_int8_t head_stl_del_1;/* Head settle delay (MSB)            */
 407                 u_int8_t head_stl_del_0;/* Head settle delay (LSB)            */
 408                 u_int8_t motor_on_del;  /* Motor on delay                     */
 409                 u_int8_t motor_off_del; /* Motor off delay                    */
 410                 u_int8_t trdy_ssn_mo;   /* XXX ??? */
 411                 u_int8_t spc;           /* XXX ??? */
 412                 u_int8_t write_comp;    /* Write compensation */
 413                 u_int8_t head_load_del; /* Head load delay */
 414                 u_int8_t head_uload_del;/* Head un-load delay */
 415                 u_int8_t pin32_pin2;
 416                 u_int8_t pin4_pint1;
 417                 u_int8_t medium_rot_rate_1; /* medium rotation rate (RPM) (MSB) */
 418                 u_int8_t medium_rot_rate_0; /* medium rotation rate (RPM) (LSB) */
 419                 u_int8_t reserved30;
 420                 u_int8_t reserved31;
 421         } flexible_disk;
 422 };
 423
 424 struct scsi_da_rw_recovery_page {
 425         u_int8_t page_code;
 426 #define SMS_RW_ERROR_RECOVERY_PAGE      0x01
 427         u_int8_t page_length;
 428         u_int8_t byte3;
 429 #define SMS_RWER_AWRE                   0x80
 430 #define SMS_RWER_ARRE                   0x40
 431 #define SMS_RWER_TB                     0x20
 432 #define SMS_RWER_RC                     0x10
 433 #define SMS_RWER_EER                    0x08
 434 #define SMS_RWER_PER                    0x04
 435 #define SMS_RWER_DTE                    0x02
 436 #define SMS_RWER_DCR                    0x01
 437         u_int8_t read_retry_count;
 438         u_int8_t correction_span;
 439         u_int8_t head_offset_count;
 440         u_int8_t data_strobe_offset_cnt;
 441         u_int8_t reserved;
 442         u_int8_t write_retry_count;
 443         u_int8_t reserved2;
 444         u_int8_t recovery_time_limit[2];
 445 };
 446
 447 __BEGIN_DECLS
 448 /*
 449  * XXX This is only left out of the kernel build to silence warnings.  If,
 450  * for some reason this function is used in the kernel, the ifdefs should
 451  * be moved so it is included both in the kernel and userland.
 452  */
 453 #ifndef _KERNEL
 454 void scsi_format_unit(struct ccb_scsiio *csio, u_int32_t retries,
 455                       void (*cbfcnp)(struct cam_periph *, union ccb *),
 456                       u_int8_t tag_action, u_int8_t byte2, u_int16_t ileave,
 457                       u_int8_t *data_ptr, u_int32_t dxfer_len,
 458                       u_int8_t sense_len, u_int32_t timeout);
 459
 460 #endif /* !_KERNEL */
 461 __END_DECLS
 462
 463 #endif /* _SCSI_SCSI_DA_H */