xref: /freebsd/sys/cam/scsi/scsi_da.h (revision 6990ffd8a95caaba6858ad44ff1b3157d1efba8f)
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_DEFECT_DATA_10	0x37
155 #define READ_DEFECT_DATA_12	0xb7
156 
157 struct format_defect_list_header
158 {
159 	u_int8_t reserved;
160 	u_int8_t byte2;
161 #define FU_DLH_VS	0x01
162 #define FU_DLH_IMMED	0x02
163 #define FU_DLH_DSP	0x04
164 #define FU_DLH_IP	0x08
165 #define FU_DLH_STPF	0x10
166 #define FU_DLH_DCRT	0x20
167 #define FU_DLH_DPRY	0x40
168 #define FU_DLH_FOV	0x80
169 	u_int8_t defect_list_length[2];
170 };
171 
172 struct format_ipat_descriptor
173 {
174 	u_int8_t byte1;
175 #define	FU_INIT_NO_HDR		0x00
176 #define FU_INIT_LBA_MSB		0x40
177 #define FU_INIT_LBA_EACH	0x80
178 #define FU_INIT_SI		0x20
179 	u_int8_t pattern_type;
180 #define FU_INIT_PAT_DEFAULT	0x00
181 #define FU_INIT_PAT_REPEAT	0x01
182 	u_int8_t pat_length[2];
183 };
184 
185 struct scsi_reassign_blocks_data
186 {
187 	u_int8_t reserved[2];
188 	u_int8_t length[2];
189 	struct {
190 		u_int8_t dlbaddr[4];	/* defect logical block address */
191 	} defect_descriptor[1];
192 };
193 
194 
195 /*
196  * This is the list header for the READ DEFECT DATA(10) command above.
197  * It may be a bit wrong to append the 10 at the end of the data structure,
198  * since it's only 4 bytes but it does tie it to the 10 byte command.
199  */
200 struct scsi_read_defect_data_hdr_10
201 {
202 	u_int8_t reserved;
203 #define SRDDH10_GLIST 0x08
204 #define SRDDH10_PLIST 0x10
205 #define SRDDH10_DLIST_FORMAT_MASK 0x07
206 #define SRDDH10_BLOCK_FORMAT            0x00
207 #define SRDDH10_BYTES_FROM_INDEX_FORMAT 0x04
208 #define SRDDH10_PHYSICAL_SECTOR_FORMAT  0x05
209 	u_int8_t format;
210 	u_int8_t length[2];
211 };
212 
213 struct scsi_defect_desc_block
214 {
215 	u_int8_t address[4];
216 };
217 
218 struct scsi_defect_desc_bytes_from_index
219 {
220 	u_int8_t cylinder[3];
221 	u_int8_t head;
222 	u_int8_t bytes_from_index[4];
223 };
224 
225 struct scsi_defect_desc_phys_sector
226 {
227 	u_int8_t cylinder[3];
228 	u_int8_t head;
229 	u_int8_t sector[4];
230 };
231 
232 struct scsi_read_defect_data_hdr_12
233 {
234 	u_int8_t reserved;
235 #define SRDDH12_GLIST 0x08
236 #define SRDDH12_PLIST 0x10
237 #define SRDDH12_DLIST_FORMAT_MASK 0x07
238 #define SRDDH12_BLOCK_FORMAT            0x00
239 #define SRDDH12_BYTES_FROM_INDEX_FORMAT 0x04
240 #define SRDDH12_PHYSICAL_SECTOR_FORMAT  0x05
241 	u_int8_t format;
242 	u_int8_t length[4];
243 };
244 
245 union	disk_pages /* this is the structure copied from osf */
246 {
247 	struct format_device_page {
248 		u_int8_t pg_code;	/* page code (should be 3)	      */
249 #define	SMS_FORMAT_DEVICE_PAGE	0x03	/* only 6 bits valid */
250 		u_int8_t pg_length;	/* page length (should be 0x16)	      */
251 #define	SMS_FORMAT_DEVICE_PLEN	0x16
252 		u_int8_t trk_z_1;	/* tracks per zone (MSB)	      */
253 		u_int8_t trk_z_0;	/* tracks per zone (LSB)	      */
254 		u_int8_t alt_sec_1;	/* alternate sectors per zone (MSB)   */
255 		u_int8_t alt_sec_0;	/* alternate sectors per zone (LSB)   */
256 		u_int8_t alt_trk_z_1;	/* alternate tracks per zone (MSB)    */
257 		u_int8_t alt_trk_z_0;	/* alternate tracks per zone (LSB)    */
258 		u_int8_t alt_trk_v_1;	/* alternate tracks per volume (MSB)  */
259 		u_int8_t alt_trk_v_0;	/* alternate tracks per volume (LSB)  */
260 		u_int8_t ph_sec_t_1;	/* physical sectors per track (MSB)   */
261 		u_int8_t ph_sec_t_0;	/* physical sectors per track (LSB)   */
262 		u_int8_t bytes_s_1;	/* bytes per sector (MSB)	      */
263 		u_int8_t bytes_s_0;	/* bytes per sector (LSB)	      */
264 		u_int8_t interleave_1;	/* interleave (MSB)		      */
265 		u_int8_t interleave_0;	/* interleave (LSB)		      */
266 		u_int8_t trk_skew_1;	/* track skew factor (MSB)	      */
267 		u_int8_t trk_skew_0;	/* track skew factor (LSB)	      */
268 		u_int8_t cyl_skew_1;	/* cylinder skew (MSB)		      */
269 		u_int8_t cyl_skew_0;	/* cylinder skew (LSB)		      */
270 		u_int8_t flags;		/* various */
271 #define			DISK_FMT_SURF	0x10
272 #define	       		DISK_FMT_RMB	0x20
273 #define			DISK_FMT_HSEC	0x40
274 #define			DISK_FMT_SSEC	0x80
275 		u_int8_t reserved21;
276 		u_int8_t reserved22;
277 		u_int8_t reserved23;
278 	} format_device;
279 	struct rigid_geometry_page {
280 		u_int8_t pg_code;	/* page code (should be 4)	      */
281 #define SMS_RIGID_GEOMETRY_PAGE 0x04
282 		u_int8_t pg_length;	/* page length (should be 0x16)	      */
283 #define SMS_RIGID_GEOMETRY_PLEN 0x16
284 		u_int8_t ncyl_2;	/* number of cylinders (MSB)	      */
285 		u_int8_t ncyl_1;	/* number of cylinders 		      */
286 		u_int8_t ncyl_0;	/* number of cylinders (LSB)	      */
287 		u_int8_t nheads;	/* number of heads 		      */
288 		u_int8_t st_cyl_wp_2;	/* starting cyl., write precomp (MSB) */
289 		u_int8_t st_cyl_wp_1;	/* starting cyl., write precomp	      */
290 		u_int8_t st_cyl_wp_0;	/* starting cyl., write precomp (LSB) */
291 		u_int8_t st_cyl_rwc_2;	/* starting cyl., red. write cur (MSB)*/
292 		u_int8_t st_cyl_rwc_1;	/* starting cyl., red. write cur      */
293 		u_int8_t st_cyl_rwc_0;	/* starting cyl., red. write cur (LSB)*/
294 		u_int8_t driv_step_1;	/* drive step rate (MSB)	      */
295 		u_int8_t driv_step_0;	/* drive step rate (LSB)	      */
296 		u_int8_t land_zone_2;	/* landing zone cylinder (MSB)	      */
297 		u_int8_t land_zone_1;	/* landing zone cylinder 	      */
298 		u_int8_t land_zone_0;	/* landing zone cylinder (LSB)	      */
299 		u_int8_t rpl;		/* rotational position locking (2 bits) */
300 		u_int8_t rot_offset;	/* rotational offset */
301 		u_int8_t reserved19;
302 		u_int8_t medium_rot_rate_1; /* medium rotation rate (RPM) (MSB) */
303 		u_int8_t medium_rot_rate_0; /* medium rotation rate (RPM) (LSB) */
304 		u_int8_t reserved22;
305 		u_int8_t reserved23;
306     	} rigid_geometry;
307 	struct flexible_disk_page {
308 		u_int8_t pg_code;	/* page code (should be 5)	      */
309 #define SMS_FLEXIBLE_GEOMETRY_PAGE 0x05
310 		u_int8_t pg_length;	/* page length (should be 0x1E)	      */
311 #define SMS_FLEXIBLE_GEOMETRY_PLEN 0x1E
312 		u_int8_t xfr_rate_1;	/* transfer rate (MSB)		      */
313 		u_int8_t xfr_rate_0;	/* transfer rate (LSB)		      */
314 		u_int8_t nheads;	/* number of heads 		      */
315 		u_int8_t sec_per_track;	/* Sectors per track		      */
316 		u_int8_t bytes_s_1;	/* bytes per sector (MSB)	      */
317 		u_int8_t bytes_s_0;	/* bytes per sector (LSB)	      */
318 		u_int8_t ncyl_1;	/* number of cylinders (MSB)	      */
319 		u_int8_t ncyl_0;	/* number of cylinders (LSB)	      */
320 		u_int8_t st_cyl_wp_1;	/* starting cyl., write precomp (MSB) */
321 		u_int8_t st_cyl_wp_0;	/* starting cyl., write precomp (LSB) */
322 		u_int8_t st_cyl_rwc_1;	/* starting cyl., red. write cur (MSB)*/
323 		u_int8_t st_cyl_rwc_0;	/* starting cyl., red. write cur (LSB)*/
324 		u_int8_t driv_step_1;	/* drive step rate (MSB)	      */
325 		u_int8_t driv_step_0;	/* drive step rate (LSB)	      */
326 		u_int8_t driv_step_pw;	/* drive step pulse width	      */
327 		u_int8_t head_stl_del_1;/* Head settle delay (MSB)	      */
328 		u_int8_t head_stl_del_0;/* Head settle delay (LSB)	      */
329 		u_int8_t motor_on_del;	/* Motor on delay		      */
330 		u_int8_t motor_off_del;	/* Motor off delay		      */
331 		u_int8_t trdy_ssn_mo;	/* XXX ??? */
332 		u_int8_t spc;		/* XXX ??? */
333 		u_int8_t write_comp;	/* Write compensation */
334 		u_int8_t head_load_del; /* Head load delay */
335 		u_int8_t head_uload_del;/* Head un-load delay */
336 		u_int8_t pin32_pin2;
337 		u_int8_t pin4_pint1;
338 		u_int8_t medium_rot_rate_1; /* medium rotation rate (RPM) (MSB) */
339 		u_int8_t medium_rot_rate_0; /* medium rotation rate (RPM) (LSB) */
340 		u_int8_t reserved30;
341 		u_int8_t reserved31;
342     	} flexible_disk;
343 };
344 
345 struct scsi_da_rw_recovery_page {
346 	u_int8_t page_code;
347 #define SMS_RW_ERROR_RECOVERY_PAGE	0x01
348 	u_int8_t page_length;
349 	u_int8_t byte3;
350 #define SMS_RWER_AWRE			0x80
351 #define SMS_RWER_ARRE			0x40
352 #define SMS_RWER_TB			0x20
353 #define SMS_RWER_RC			0x10
354 #define SMS_RWER_EER			0x08
355 #define SMS_RWER_PER			0x04
356 #define SMS_RWER_DTE			0x02
357 #define SMS_RWER_DCR			0x01
358 	u_int8_t read_retry_count;
359 	u_int8_t correction_span;
360 	u_int8_t head_offset_count;
361 	u_int8_t data_strobe_offset_cnt;
362 	u_int8_t reserved;
363 	u_int8_t write_retry_count;
364 	u_int8_t reserved2;
365 	u_int8_t recovery_time_limit[2];
366 };
367 
368 __BEGIN_DECLS
369 /*
370  * XXX This is only left out of the kernel build to silence warnings.  If,
371  * for some reason this function is used in the kernel, the ifdefs should
372  * be moved so it is included both in the kernel and userland.
373  */
374 #ifndef _KERNEL
375 void scsi_format_unit(struct ccb_scsiio *csio, u_int32_t retries,
376 		      void (*cbfcnp)(struct cam_periph *, union ccb *),
377 		      u_int8_t tag_action, u_int8_t byte2, u_int16_t ileave,
378 		      u_int8_t *data_ptr, u_int32_t dxfer_len,
379 		      u_int8_t sense_len, u_int32_t timeout);
380 
381 #endif /* !_KERNEL */
382 __END_DECLS
383 
384 #endif /* _SCSI_SCSI_DA_H */
385