]> CyberLeo.Net >> Repos - FreeBSD/releng/10.0.git/blob - sys/cam/scsi/scsi_da.h
- Copy stable/10 (r259064) to releng/10.0 as part of the
[FreeBSD/releng/10.0.git] / 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 #define SRDD10_MAX_LENGTH               0xffff
115
116         u_int8_t control;
117 };
118
119 struct scsi_sanitize
120 {
121         u_int8_t opcode;
122         u_int8_t byte2;
123 #define SSZ_SERVICE_ACTION_OVERWRITE         0x01
124 #define SSZ_SERVICE_ACTION_BLOCK_ERASE       0x02
125 #define SSZ_SERVICE_ACTION_CRYPTO_ERASE      0x03
126 #define SSZ_SERVICE_ACTION_EXIT_MODE_FAILURE 0x1F
127 #define SSZ_UNRESTRICTED_EXIT                0x20
128 #define SSZ_IMMED                            0x80
129         u_int8_t reserved[5];
130         u_int8_t length[2];
131         u_int8_t control;
132 };
133
134 struct scsi_sanitize_parameter_list
135 {
136         u_int8_t byte1;
137 #define SSZPL_INVERT 0x80
138         u_int8_t reserved;
139         u_int8_t length[2];
140         /* Variable length initialization pattern. */
141 #define SSZPL_MAX_PATTERN_LENGTH 65535
142 };
143
144 struct scsi_read_defect_data_12
145 {
146         u_int8_t opcode;
147
148         /* 
149          * The most significant 3 bits are the LUN, the other 5 are
150          * reserved.
151          */
152 #define SRDD12_LUN_MASK 0xE0
153         u_int8_t byte2;
154
155 #define SRDD12_GLIST 0x08
156 #define SRDD12_PLIST 0x10
157 #define SRDD12_DLIST_FORMAT_MASK 0x07
158 #define SRDD12_BLOCK_FORMAT            0x00
159 #define SRDD12_BYTES_FROM_INDEX_FORMAT 0x04
160 #define SRDD12_PHYSICAL_SECTOR_FORMAT  0x05
161         u_int8_t format;
162
163         u_int8_t reserved[4];
164
165         u_int8_t alloc_length[4];
166
167         u_int8_t control;
168         
169 };
170
171
172 /*
173  * Opcodes
174  */
175 #define REZERO_UNIT             0x01
176 #define FORMAT_UNIT             0x04
177 #define REASSIGN_BLOCKS         0x07
178 #define MODE_SELECT             0x15
179 #define MODE_SENSE              0x1a
180 #define READ_FORMAT_CAPACITIES  0x23
181 #define WRITE_AND_VERIFY        0x2e
182 #define VERIFY                  0x2f
183 #define READ_DEFECT_DATA_10     0x37
184 #define SANITIZE                0x48
185 #define READ_DEFECT_DATA_12     0xb7
186
187 struct format_defect_list_header
188 {
189         u_int8_t reserved;
190         u_int8_t byte2;
191 #define FU_DLH_VS       0x01
192 #define FU_DLH_IMMED    0x02
193 #define FU_DLH_DSP      0x04
194 #define FU_DLH_IP       0x08
195 #define FU_DLH_STPF     0x10
196 #define FU_DLH_DCRT     0x20
197 #define FU_DLH_DPRY     0x40
198 #define FU_DLH_FOV      0x80
199         u_int8_t defect_list_length[2];
200 };
201
202 struct format_ipat_descriptor
203 {
204         u_int8_t byte1;
205 #define FU_INIT_NO_HDR          0x00
206 #define FU_INIT_LBA_MSB         0x40
207 #define FU_INIT_LBA_EACH        0x80
208 #define FU_INIT_SI              0x20
209         u_int8_t pattern_type;
210 #define FU_INIT_PAT_DEFAULT     0x00
211 #define FU_INIT_PAT_REPEAT      0x01
212         u_int8_t pat_length[2];
213 };
214
215 struct scsi_read_format_capacities
216 {
217         uint8_t opcode;         /* READ_FORMAT_CAPACITIES */
218         uint8_t byte2;
219 #define SRFC_LUN_MASK   0xE0
220         uint8_t reserved0[5];
221         uint8_t alloc_length[2];
222         uint8_t reserved1[3];
223 };
224
225 struct scsi_verify
226 {
227         uint8_t opcode;         /* VERIFY */
228         uint8_t byte2;
229 #define SVFY_LUN_MASK   0xE0
230 #define SVFY_RELADR     0x01
231 #define SVFY_BYTECHK    0x02
232 #define SVFY_DPO        0x10
233         uint8_t addr[4];        /* LBA to begin verification at */
234         uint8_t reserved0[1];
235         uint8_t len[2];         /* number of blocks to verify */
236         uint8_t reserved1[3];
237 };
238
239 struct scsi_write_and_verify
240 {
241         uint8_t opcode;         /* WRITE_AND_VERIFY */
242         uint8_t byte2;
243 #define SWVY_LUN_MASK   0xE0
244 #define SWVY_RELADR     0x01
245 #define SWVY_BYTECHK    0x02
246 #define SWVY_DPO        0x10
247         uint8_t addr[4];        /* LBA to begin verification at */
248         uint8_t reserved0[1];
249         uint8_t len[2];         /* number of blocks to write and verify */
250         uint8_t reserved1[3];
251 };
252
253 /*
254  * Replies to READ_FORMAT_CAPACITIES look like this:
255  *
256  * struct format_capacity_list_header
257  * struct format_capacity_descriptor[1..n]
258  *
259  * These are similar, but not totally identical to, the
260  * defect list used to format a rigid disk.
261  *
262  * The appropriate csio_decode() format string looks like this:
263  * "{} *i3 {Len} i1 {Blocks} i4 {} *b6 {Code} b2 {Blocklen} i3"
264  *
265  * If the capacity_list_length is greater than
266  * sizeof(struct format_capacity_descriptor), then there are
267  * additional format capacity descriptors available which
268  * denote which format(s) the drive can handle.
269  *
270  * (Source: USB Mass Storage UFI Specification)
271  */
272
273 struct format_capacity_list_header {
274         uint8_t unused[3];
275         uint8_t capacity_list_length;
276 };
277
278 struct format_capacity_descriptor {
279         uint8_t nblocks[4];     /* total number of LBAs */
280         uint8_t byte4;          /* only present in max/cur descriptor */
281 #define FCD_CODE_MASK   0x03    /* mask for code field above */
282 #define FCD_UNFORMATTED 0x01    /* unformatted media present,
283                                  * maximum capacity returned */
284 #define FCD_FORMATTED   0x02    /* formatted media present,
285                                  * current capacity returned */
286 #define FCD_NOMEDIA     0x03    /* no media present,
287                                  * maximum device capacity returned */
288         uint8_t block_length[3];        /* length of an LBA in bytes */
289 };
290
291 struct scsi_reassign_blocks_data
292 {
293         u_int8_t reserved[2];
294         u_int8_t length[2];
295         struct {
296                 u_int8_t dlbaddr[4];    /* defect logical block address */
297         } defect_descriptor[1];
298 };
299
300
301 /*
302  * This is the list header for the READ DEFECT DATA(10) command above.
303  * It may be a bit wrong to append the 10 at the end of the data structure,
304  * since it's only 4 bytes but it does tie it to the 10 byte command.
305  */
306 struct scsi_read_defect_data_hdr_10
307 {
308         u_int8_t reserved;
309 #define SRDDH10_GLIST 0x08
310 #define SRDDH10_PLIST 0x10
311 #define SRDDH10_DLIST_FORMAT_MASK 0x07
312 #define SRDDH10_BLOCK_FORMAT            0x00
313 #define SRDDH10_BYTES_FROM_INDEX_FORMAT 0x04
314 #define SRDDH10_PHYSICAL_SECTOR_FORMAT  0x05
315         u_int8_t format;
316         u_int8_t length[2];
317 };
318
319 struct scsi_defect_desc_block
320 {
321         u_int8_t address[4];
322 };
323
324 struct scsi_defect_desc_bytes_from_index
325 {
326         u_int8_t cylinder[3];
327         u_int8_t head;
328         u_int8_t bytes_from_index[4];
329 };
330
331 struct scsi_defect_desc_phys_sector
332 {
333         u_int8_t cylinder[3];
334         u_int8_t head;
335         u_int8_t sector[4];
336 };
337
338 struct scsi_read_defect_data_hdr_12
339 {
340         u_int8_t reserved;
341 #define SRDDH12_GLIST 0x08
342 #define SRDDH12_PLIST 0x10
343 #define SRDDH12_DLIST_FORMAT_MASK 0x07
344 #define SRDDH12_BLOCK_FORMAT            0x00
345 #define SRDDH12_BYTES_FROM_INDEX_FORMAT 0x04
346 #define SRDDH12_PHYSICAL_SECTOR_FORMAT  0x05
347         u_int8_t format;
348         u_int8_t length[4];
349 };
350
351 union   disk_pages /* this is the structure copied from osf */
352 {
353         struct format_device_page {
354                 u_int8_t pg_code;       /* page code (should be 3)            */
355 #define SMS_FORMAT_DEVICE_PAGE  0x03    /* only 6 bits valid */
356                 u_int8_t pg_length;     /* page length (should be 0x16)       */
357 #define SMS_FORMAT_DEVICE_PLEN  0x16
358                 u_int8_t trk_z_1;       /* tracks per zone (MSB)              */
359                 u_int8_t trk_z_0;       /* tracks per zone (LSB)              */
360                 u_int8_t alt_sec_1;     /* alternate sectors per zone (MSB)   */
361                 u_int8_t alt_sec_0;     /* alternate sectors per zone (LSB)   */
362                 u_int8_t alt_trk_z_1;   /* alternate tracks per zone (MSB)    */
363                 u_int8_t alt_trk_z_0;   /* alternate tracks per zone (LSB)    */
364                 u_int8_t alt_trk_v_1;   /* alternate tracks per volume (MSB)  */
365                 u_int8_t alt_trk_v_0;   /* alternate tracks per volume (LSB)  */
366                 u_int8_t ph_sec_t_1;    /* physical sectors per track (MSB)   */
367                 u_int8_t ph_sec_t_0;    /* physical sectors per track (LSB)   */
368                 u_int8_t bytes_s_1;     /* bytes per sector (MSB)             */
369                 u_int8_t bytes_s_0;     /* bytes per sector (LSB)             */
370                 u_int8_t interleave_1;  /* interleave (MSB)                   */
371                 u_int8_t interleave_0;  /* interleave (LSB)                   */
372                 u_int8_t trk_skew_1;    /* track skew factor (MSB)            */
373                 u_int8_t trk_skew_0;    /* track skew factor (LSB)            */
374                 u_int8_t cyl_skew_1;    /* cylinder skew (MSB)                */
375                 u_int8_t cyl_skew_0;    /* cylinder skew (LSB)                */
376                 u_int8_t flags;         /* various */
377 #define                 DISK_FMT_SURF   0x10
378 #define                 DISK_FMT_RMB    0x20
379 #define                 DISK_FMT_HSEC   0x40
380 #define                 DISK_FMT_SSEC   0x80
381                 u_int8_t reserved21;
382                 u_int8_t reserved22;
383                 u_int8_t reserved23;
384         } format_device;
385         struct rigid_geometry_page {
386                 u_int8_t pg_code;       /* page code (should be 4)            */
387 #define SMS_RIGID_GEOMETRY_PAGE 0x04
388                 u_int8_t pg_length;     /* page length (should be 0x16)       */
389 #define SMS_RIGID_GEOMETRY_PLEN 0x16            
390                 u_int8_t ncyl_2;        /* number of cylinders (MSB)          */
391                 u_int8_t ncyl_1;        /* number of cylinders                */
392                 u_int8_t ncyl_0;        /* number of cylinders (LSB)          */
393                 u_int8_t nheads;        /* number of heads                    */
394                 u_int8_t st_cyl_wp_2;   /* starting cyl., write precomp (MSB) */
395                 u_int8_t st_cyl_wp_1;   /* starting cyl., write precomp       */
396                 u_int8_t st_cyl_wp_0;   /* starting cyl., write precomp (LSB) */
397                 u_int8_t st_cyl_rwc_2;  /* starting cyl., red. write cur (MSB)*/
398                 u_int8_t st_cyl_rwc_1;  /* starting cyl., red. write cur      */
399                 u_int8_t st_cyl_rwc_0;  /* starting cyl., red. write cur (LSB)*/
400                 u_int8_t driv_step_1;   /* drive step rate (MSB)              */
401                 u_int8_t driv_step_0;   /* drive step rate (LSB)              */
402                 u_int8_t land_zone_2;   /* landing zone cylinder (MSB)        */
403                 u_int8_t land_zone_1;   /* landing zone cylinder              */
404                 u_int8_t land_zone_0;   /* landing zone cylinder (LSB)        */
405                 u_int8_t rpl;           /* rotational position locking (2 bits) */
406                 u_int8_t rot_offset;    /* rotational offset */
407                 u_int8_t reserved19;
408                 u_int8_t medium_rot_rate_1; /* medium rotation rate (RPM) (MSB) */
409                 u_int8_t medium_rot_rate_0; /* medium rotation rate (RPM) (LSB) */
410                 u_int8_t reserved22;
411                 u_int8_t reserved23;
412         } rigid_geometry;
413         struct flexible_disk_page {
414                 u_int8_t pg_code;       /* page code (should be 5)            */
415 #define SMS_FLEXIBLE_GEOMETRY_PAGE 0x05
416                 u_int8_t pg_length;     /* page length (should be 0x1E)       */
417 #define SMS_FLEXIBLE_GEOMETRY_PLEN 0x1E
418                 u_int8_t xfr_rate_1;    /* transfer rate (MSB)                */
419                 u_int8_t xfr_rate_0;    /* transfer rate (LSB)                */
420                 u_int8_t nheads;        /* number of heads                    */
421                 u_int8_t sec_per_track; /* Sectors per track                  */
422                 u_int8_t bytes_s_1;     /* bytes per sector (MSB)             */
423                 u_int8_t bytes_s_0;     /* bytes per sector (LSB)             */
424                 u_int8_t ncyl_1;        /* number of cylinders (MSB)          */
425                 u_int8_t ncyl_0;        /* number of cylinders (LSB)          */
426                 u_int8_t st_cyl_wp_1;   /* starting cyl., write precomp (MSB) */
427                 u_int8_t st_cyl_wp_0;   /* starting cyl., write precomp (LSB) */
428                 u_int8_t st_cyl_rwc_1;  /* starting cyl., red. write cur (MSB)*/
429                 u_int8_t st_cyl_rwc_0;  /* starting cyl., red. write cur (LSB)*/                
430                 u_int8_t driv_step_1;   /* drive step rate (MSB)              */
431                 u_int8_t driv_step_0;   /* drive step rate (LSB)              */
432                 u_int8_t driv_step_pw;  /* drive step pulse width             */
433                 u_int8_t head_stl_del_1;/* Head settle delay (MSB)            */
434                 u_int8_t head_stl_del_0;/* Head settle delay (LSB)            */
435                 u_int8_t motor_on_del;  /* Motor on delay                     */
436                 u_int8_t motor_off_del; /* Motor off delay                    */
437                 u_int8_t trdy_ssn_mo;   /* XXX ??? */
438                 u_int8_t spc;           /* XXX ??? */
439                 u_int8_t write_comp;    /* Write compensation */
440                 u_int8_t head_load_del; /* Head load delay */
441                 u_int8_t head_uload_del;/* Head un-load delay */
442                 u_int8_t pin32_pin2;
443                 u_int8_t pin4_pint1;
444                 u_int8_t medium_rot_rate_1; /* medium rotation rate (RPM) (MSB) */
445                 u_int8_t medium_rot_rate_0; /* medium rotation rate (RPM) (LSB) */              
446                 u_int8_t reserved30;
447                 u_int8_t reserved31;
448         } flexible_disk;        
449 };
450
451 /*
452  * XXX KDM
453  * Here for CTL compatibility, reconcile this.
454  */
455 struct scsi_format_page {
456         uint8_t page_code;
457         uint8_t page_length;
458         uint8_t tracks_per_zone[2];
459         uint8_t alt_sectors_per_zone[2];
460         uint8_t alt_tracks_per_zone[2];
461         uint8_t alt_tracks_per_lun[2];
462         uint8_t sectors_per_track[2];
463         uint8_t bytes_per_sector[2];
464         uint8_t interleave[2];
465         uint8_t track_skew[2];
466         uint8_t cylinder_skew[2];
467         uint8_t flags;
468 #define SFP_SSEC        0x80
469 #define SFP_HSEC        0x40
470 #define SFP_RMB         0x20
471 #define SFP_SURF        0x10
472         uint8_t reserved[3];
473 };
474
475 /*
476  * XXX KDM
477  * Here for CTL compatibility, reconcile this.
478  */
479 struct scsi_rigid_disk_page {
480         uint8_t page_code;
481 #define SMS_RIGID_DISK_PAGE             0x04
482         uint8_t page_length;
483         uint8_t cylinders[3];
484         uint8_t heads;
485         uint8_t start_write_precomp[3];
486         uint8_t start_reduced_current[3];
487         uint8_t step_rate[2];
488         uint8_t landing_zone_cylinder[3];
489         uint8_t rpl;
490 #define SRDP_RPL_DISABLED       0x00
491 #define SRDP_RPL_SLAVE          0x01
492 #define SRDP_RPL_MASTER         0x02
493 #define SRDP_RPL_MASTER_CONTROL 0x03
494         uint8_t rotational_offset;
495         uint8_t reserved1;
496         uint8_t rotation_rate[2];
497         uint8_t reserved2[2];
498 };
499
500
501 struct scsi_da_rw_recovery_page {
502         u_int8_t page_code;
503 #define SMS_RW_ERROR_RECOVERY_PAGE      0x01
504         u_int8_t page_length;
505         u_int8_t byte3;
506 #define SMS_RWER_AWRE                   0x80
507 #define SMS_RWER_ARRE                   0x40
508 #define SMS_RWER_TB                     0x20
509 #define SMS_RWER_RC                     0x10
510 #define SMS_RWER_EER                    0x08
511 #define SMS_RWER_PER                    0x04
512 #define SMS_RWER_DTE                    0x02
513 #define SMS_RWER_DCR                    0x01
514         u_int8_t read_retry_count;
515         u_int8_t correction_span;
516         u_int8_t head_offset_count;
517         u_int8_t data_strobe_offset_cnt;
518         u_int8_t reserved;
519         u_int8_t write_retry_count;
520         u_int8_t reserved2;
521         u_int8_t recovery_time_limit[2];
522 };
523
524 __BEGIN_DECLS
525 /*
526  * XXX This is only left out of the kernel build to silence warnings.  If,
527  * for some reason this function is used in the kernel, the ifdefs should
528  * be moved so it is included both in the kernel and userland.
529  */
530 #ifndef _KERNEL
531 void scsi_format_unit(struct ccb_scsiio *csio, u_int32_t retries,
532                       void (*cbfcnp)(struct cam_periph *, union ccb *),
533                       u_int8_t tag_action, u_int8_t byte2, u_int16_t ileave,
534                       u_int8_t *data_ptr, u_int32_t dxfer_len,
535                       u_int8_t sense_len, u_int32_t timeout);
536
537 void scsi_sanitize(struct ccb_scsiio *csio, u_int32_t retries,
538                    void (*cbfcnp)(struct cam_periph *, union ccb *),
539                    u_int8_t tag_action, u_int8_t byte2, u_int16_t control,
540                    u_int8_t *data_ptr, u_int32_t dxfer_len, u_int8_t sense_len,
541                    u_int32_t timeout);
542
543 #endif /* !_KERNEL */
544 __END_DECLS
545
546 #endif /* _SCSI_SCSI_DA_H */