xref: /freebsd/sys/cam/cam_ccb.h (revision 3642298923e528d795e3a30ec165d2b469e28b40)
1 /*-
2  * Data structures and definitions for CAM Control Blocks (CCBs).
3  *
4  * Copyright (c) 1997, 1998 Justin T. Gibbs.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions, and the following disclaimer,
12  *    without modification, immediately at the beginning of the file.
13  * 2. The name of the author may not be used to endorse or promote products
14  *    derived from this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
20  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  *
28  * $FreeBSD$
29  */
30 
31 #ifndef _CAM_CAM_CCB_H
32 #define _CAM_CAM_CCB_H 1
33 
34 #include <sys/queue.h>
35 #include <sys/cdefs.h>
36 #include <sys/time.h>
37 #ifdef CAM_NEW_TRAN_CODE
38 #include <sys/limits.h>
39 #endif /* CAM_NEW_TRAN_CODE */
40 #ifndef _KERNEL
41 #include <sys/callout.h>
42 #endif
43 #include <cam/cam_debug.h>
44 #include <cam/scsi/scsi_all.h>
45 
46 
47 /* General allocation length definitions for CCB structures */
48 #define	IOCDBLEN	CAM_MAX_CDBLEN	/* Space for CDB bytes/pointer */
49 #define	VUHBALEN	14		/* Vendor Unique HBA length */
50 #define	SIM_IDLEN	16		/* ASCII string len for SIM ID */
51 #define	HBA_IDLEN	16		/* ASCII string len for HBA ID */
52 #define	DEV_IDLEN	16		/* ASCII string len for device names */
53 #define CCB_PERIPH_PRIV_SIZE 	2	/* size of peripheral private area */
54 #define CCB_SIM_PRIV_SIZE 	2	/* size of sim private area */
55 
56 /* Struct definitions for CAM control blocks */
57 
58 /* Common CCB header */
59 /* CAM CCB flags */
60 typedef enum {
61 	CAM_CDB_POINTER		= 0x00000001,/* The CDB field is a pointer    */
62 	CAM_QUEUE_ENABLE	= 0x00000002,/* SIM queue actions are enabled */
63 	CAM_CDB_LINKED		= 0x00000004,/* CCB contains a linked CDB     */
64 	CAM_NEGOTIATE		= 0x00000008,/*
65 					      * Perform transport negotiation
66 					      * with this command.
67 					      */
68 	CAM_SCATTER_VALID	= 0x00000010,/* Scatter/gather list is valid  */
69 	CAM_DIS_AUTOSENSE	= 0x00000020,/* Disable autosense feature     */
70 	CAM_DIR_RESV		= 0x00000000,/* Data direction (00:reserved)  */
71 	CAM_DIR_IN		= 0x00000040,/* Data direction (01:DATA IN)   */
72 	CAM_DIR_OUT		= 0x00000080,/* Data direction (10:DATA OUT)  */
73 	CAM_DIR_NONE		= 0x000000C0,/* Data direction (11:no data)   */
74 	CAM_DIR_MASK		= 0x000000C0,/* Data direction Mask	      */
75 	CAM_SOFT_RST_OP		= 0x00000100,/* Use Soft reset alternative    */
76 	CAM_ENG_SYNC		= 0x00000200,/* Flush resid bytes on complete */
77 	CAM_DEV_QFRZDIS		= 0x00000400,/* Disable DEV Q freezing	      */
78 	CAM_DEV_QFREEZE		= 0x00000800,/* Freeze DEV Q on execution     */
79 	CAM_HIGH_POWER		= 0x00001000,/* Command takes a lot of power  */
80 	CAM_SENSE_PTR		= 0x00002000,/* Sense data is a pointer	      */
81 	CAM_SENSE_PHYS		= 0x00004000,/* Sense pointer is physical addr*/
82 	CAM_TAG_ACTION_VALID	= 0x00008000,/* Use the tag action in this ccb*/
83 	CAM_PASS_ERR_RECOVER	= 0x00010000,/* Pass driver does err. recovery*/
84 	CAM_DIS_DISCONNECT	= 0x00020000,/* Disable disconnect	      */
85 	CAM_SG_LIST_PHYS	= 0x00040000,/* SG list has physical addrs.   */
86 	CAM_MSG_BUF_PHYS	= 0x00080000,/* Message buffer ptr is physical*/
87 	CAM_SNS_BUF_PHYS	= 0x00100000,/* Autosense data ptr is physical*/
88 	CAM_DATA_PHYS		= 0x00200000,/* SG/Buffer data ptrs are phys. */
89 	CAM_CDB_PHYS		= 0x00400000,/* CDB poiner is physical	      */
90 	CAM_ENG_SGLIST		= 0x00800000,/* SG list is for the HBA engine */
91 
92 /* Phase cognizant mode flags */
93 	CAM_DIS_AUTOSRP		= 0x01000000,/* Disable autosave/restore ptrs */
94 	CAM_DIS_AUTODISC	= 0x02000000,/* Disable auto disconnect	      */
95 	CAM_TGT_CCB_AVAIL	= 0x04000000,/* Target CCB available	      */
96 	CAM_TGT_PHASE_MODE	= 0x08000000,/* The SIM runs in phase mode    */
97 	CAM_MSGB_VALID		= 0x10000000,/* Message buffer valid	      */
98 	CAM_STATUS_VALID	= 0x20000000,/* Status buffer valid	      */
99 	CAM_DATAB_VALID		= 0x40000000,/* Data buffer valid	      */
100 
101 /* Host target Mode flags */
102 	CAM_SEND_SENSE		= 0x08000000,/* Send sense data with status   */
103 	CAM_TERM_IO		= 0x10000000,/* Terminate I/O Message sup.    */
104 	CAM_DISCONNECT		= 0x20000000,/* Disconnects are mandatory     */
105 	CAM_SEND_STATUS		= 0x40000000 /* Send status after data phase  */
106 } ccb_flags;
107 
108 /* XPT Opcodes for xpt_action */
109 typedef enum {
110 /* Function code flags are bits greater than 0xff */
111 	XPT_FC_QUEUED		= 0x100,
112 				/* Non-immediate function code */
113 	XPT_FC_USER_CCB		= 0x200,
114 	XPT_FC_XPT_ONLY		= 0x400,
115 				/* Only for the transport layer device */
116 	XPT_FC_DEV_QUEUED	= 0x800 | XPT_FC_QUEUED,
117 				/* Passes through the device queues */
118 /* Common function commands: 0x00->0x0F */
119 	XPT_NOOP 		= 0x00,
120 				/* Execute Nothing */
121 	XPT_SCSI_IO		= 0x01 | XPT_FC_DEV_QUEUED,
122 				/* Execute the requested I/O operation */
123 	XPT_GDEV_TYPE		= 0x02,
124 				/* Get type information for specified device */
125 	XPT_GDEVLIST		= 0x03,
126 				/* Get a list of peripheral devices */
127 	XPT_PATH_INQ		= 0x04,
128 				/* Path routing inquiry */
129 	XPT_REL_SIMQ		= 0x05,
130 				/* Release a frozen SIM queue */
131 	XPT_SASYNC_CB		= 0x06,
132 				/* Set Asynchronous Callback Parameters */
133 	XPT_SDEV_TYPE		= 0x07,
134 				/* Set device type information */
135 	XPT_SCAN_BUS		= 0x08 | XPT_FC_QUEUED | XPT_FC_USER_CCB
136 				       | XPT_FC_XPT_ONLY,
137 				/* (Re)Scan the SCSI Bus */
138 	XPT_DEV_MATCH		= 0x09 | XPT_FC_XPT_ONLY,
139 				/* Get EDT entries matching the given pattern */
140 	XPT_DEBUG		= 0x0a,
141 				/* Turn on debugging for a bus, target or lun */
142 	XPT_PATH_STATS		= 0x0b,
143 				/* Path statistics (error counts, etc.) */
144 	XPT_GDEV_STATS		= 0x0c,
145 				/* Device statistics (error counts, etc.) */
146 /* SCSI Control Functions: 0x10->0x1F */
147 	XPT_ABORT		= 0x10,
148 				/* Abort the specified CCB */
149 	XPT_RESET_BUS		= 0x11 | XPT_FC_XPT_ONLY,
150 				/* Reset the specified SCSI bus */
151 	XPT_RESET_DEV		= 0x12 | XPT_FC_DEV_QUEUED,
152 				/* Bus Device Reset the specified SCSI device */
153 	XPT_TERM_IO		= 0x13,
154 				/* Terminate the I/O process */
155 	XPT_SCAN_LUN		= 0x14 | XPT_FC_QUEUED | XPT_FC_USER_CCB
156 				       | XPT_FC_XPT_ONLY,
157 				/* Scan Logical Unit */
158 	XPT_GET_TRAN_SETTINGS	= 0x15,
159 				/*
160 				 * Get default/user transfer settings
161 				 * for the target
162 				 */
163 	XPT_SET_TRAN_SETTINGS	= 0x16,
164 				/*
165 				 * Set transfer rate/width
166 				 * negotiation settings
167 				 */
168 	XPT_CALC_GEOMETRY	= 0x17,
169 				/*
170 				 * Calculate the geometry parameters for
171 				 * a device give the sector size and
172 				 * volume size.
173 				 */
174 
175 /* HBA engine commands 0x20->0x2F */
176 	XPT_ENG_INQ		= 0x20 | XPT_FC_XPT_ONLY,
177 				/* HBA engine feature inquiry */
178 	XPT_ENG_EXEC		= 0x21 | XPT_FC_DEV_QUEUED,
179 				/* HBA execute engine request */
180 
181 /* Target mode commands: 0x30->0x3F */
182 	XPT_EN_LUN		= 0x30,
183 				/* Enable LUN as a target */
184 	XPT_TARGET_IO		= 0x31 | XPT_FC_DEV_QUEUED,
185 				/* Execute target I/O request */
186 	XPT_ACCEPT_TARGET_IO	= 0x32 | XPT_FC_QUEUED | XPT_FC_USER_CCB,
187 				/* Accept Host Target Mode CDB */
188 	XPT_CONT_TARGET_IO	= 0x33 | XPT_FC_DEV_QUEUED,
189 				/* Continue Host Target I/O Connection */
190 	XPT_IMMED_NOTIFY	= 0x34 | XPT_FC_QUEUED | XPT_FC_USER_CCB,
191 				/* Notify Host Target driver of event */
192 	XPT_NOTIFY_ACK		= 0x35,
193 				/* Acknowledgement of event */
194 
195 /* Vendor Unique codes: 0x80->0x8F */
196 	XPT_VUNIQUE		= 0x80
197 } xpt_opcode;
198 
199 #define XPT_FC_GROUP_MASK		0xF0
200 #define XPT_FC_GROUP(op) ((op) & XPT_FC_GROUP_MASK)
201 #define XPT_FC_GROUP_COMMON		0x00
202 #define XPT_FC_GROUP_SCSI_CONTROL	0x10
203 #define XPT_FC_GROUP_HBA_ENGINE		0x20
204 #define XPT_FC_GROUP_TMODE		0x30
205 #define XPT_FC_GROUP_VENDOR_UNIQUE	0x80
206 
207 #define XPT_FC_IS_DEV_QUEUED(ccb) 	\
208     (((ccb)->ccb_h.func_code & XPT_FC_DEV_QUEUED) == XPT_FC_DEV_QUEUED)
209 #define XPT_FC_IS_QUEUED(ccb) 	\
210     (((ccb)->ccb_h.func_code & XPT_FC_QUEUED) != 0)
211 
212 #ifdef CAM_NEW_TRAN_CODE
213 typedef enum {
214 	PROTO_UNKNOWN,
215 	PROTO_UNSPECIFIED,
216 	PROTO_SCSI,	/* Small Computer System Interface */
217 	PROTO_ATA,	/* AT Attachment */
218 	PROTO_ATAPI,	/* AT Attachment Packetized Interface */
219 } cam_proto;
220 
221 typedef enum {
222 	XPORT_UNKNOWN,
223 	XPORT_UNSPECIFIED,
224 	XPORT_SPI,	/* SCSI Parallel Interface */
225 	XPORT_FC,	/* Fiber Channel */
226 	XPORT_SSA,	/* Serial Storage Architecture */
227 	XPORT_USB,	/* Universal Serial Bus */
228 	XPORT_PPB,	/* Parallel Port Bus */
229 	XPORT_ATA	/* AT Attachment */
230 } cam_xport;
231 
232 #define PROTO_VERSION_UNKNOWN (UINT_MAX - 1)
233 #define PROTO_VERSION_UNSPECIFIED UINT_MAX
234 #define XPORT_VERSION_UNKNOWN (UINT_MAX - 1)
235 #define XPORT_VERSION_UNSPECIFIED UINT_MAX
236 #endif /* CAM_NEW_TRAN_CODE */
237 
238 typedef union {
239 	LIST_ENTRY(ccb_hdr) le;
240 	SLIST_ENTRY(ccb_hdr) sle;
241 	TAILQ_ENTRY(ccb_hdr) tqe;
242 	STAILQ_ENTRY(ccb_hdr) stqe;
243 } camq_entry;
244 
245 typedef union {
246 	void		*ptr;
247 	u_long		field;
248 	u_int8_t	bytes[sizeof(void *) > sizeof(u_long)
249 			      ? sizeof(void *) : sizeof(u_long)];
250 } ccb_priv_entry;
251 
252 typedef union {
253 	ccb_priv_entry	entries[CCB_PERIPH_PRIV_SIZE];
254 	u_int8_t	bytes[CCB_PERIPH_PRIV_SIZE * sizeof(ccb_priv_entry)];
255 } ccb_ppriv_area;
256 
257 typedef union {
258 	ccb_priv_entry	entries[CCB_SIM_PRIV_SIZE];
259 	u_int8_t	bytes[CCB_SIM_PRIV_SIZE * sizeof(ccb_priv_entry)];
260 } ccb_spriv_area;
261 
262 struct ccb_hdr {
263 	cam_pinfo	pinfo;		/* Info for priority scheduling */
264 	camq_entry	xpt_links;	/* For chaining in the XPT layer */
265 	camq_entry	sim_links;	/* For chaining in the SIM layer */
266 	camq_entry	periph_links;	/* For chaining in the type driver */
267 	u_int32_t	retry_count;
268 	void		(*cbfcnp)(struct cam_periph *, union ccb *);
269 					/* Callback on completion function */
270 	xpt_opcode	func_code;	/* XPT function code */
271 	u_int32_t	status;		/* Status returned by CAM subsystem */
272 	struct		cam_path *path;	/* Compiled path for this ccb */
273 	path_id_t	path_id;	/* Path ID for the request */
274 	target_id_t	target_id;	/* Target device ID */
275 	lun_id_t	target_lun;	/* Target LUN number */
276 	u_int32_t	flags;		/* ccb_flags */
277 	ccb_ppriv_area	periph_priv;
278 	ccb_spriv_area	sim_priv;
279 	u_int32_t	timeout;	/* Timeout value */
280 	struct		callout_handle timeout_ch;
281 					/* Callout handle used for timeouts */
282 };
283 
284 /* Get Device Information CCB */
285 struct ccb_getdev {
286 	struct	  ccb_hdr ccb_h;
287 	struct scsi_inquiry_data inq_data;
288 	u_int8_t  serial_num[252];
289 	u_int8_t  reserved;
290 	u_int8_t  serial_num_len;
291 };
292 
293 /* Device Statistics CCB */
294 struct ccb_getdevstats {
295 	struct	ccb_hdr	ccb_h;
296 	int	dev_openings;	/* Space left for more work on device*/
297 	int	dev_active;	/* Transactions running on the device */
298 	int	devq_openings;	/* Space left for more queued work */
299 	int	devq_queued;	/* Transactions queued to be sent */
300 	int	held;		/*
301 				 * CCBs held by peripheral drivers
302 				 * for this device
303 				 */
304 	int	maxtags;	/*
305 				 * Boundary conditions for number of
306 				 * tagged operations
307 				 */
308 	int	mintags;
309 	struct	timeval last_reset;	/* Time of last bus reset/loop init */
310 };
311 
312 typedef enum {
313 	CAM_GDEVLIST_LAST_DEVICE,
314 	CAM_GDEVLIST_LIST_CHANGED,
315 	CAM_GDEVLIST_MORE_DEVS,
316 	CAM_GDEVLIST_ERROR
317 } ccb_getdevlist_status_e;
318 
319 struct ccb_getdevlist {
320 	struct ccb_hdr		ccb_h;
321 	char 			periph_name[DEV_IDLEN];
322 	u_int32_t		unit_number;
323 	unsigned int		generation;
324 	u_int32_t		index;
325 	ccb_getdevlist_status_e	status;
326 };
327 
328 typedef enum {
329 	PERIPH_MATCH_NONE	= 0x000,
330 	PERIPH_MATCH_PATH	= 0x001,
331 	PERIPH_MATCH_TARGET	= 0x002,
332 	PERIPH_MATCH_LUN	= 0x004,
333 	PERIPH_MATCH_NAME	= 0x008,
334 	PERIPH_MATCH_UNIT	= 0x010,
335 	PERIPH_MATCH_ANY	= 0x01f
336 } periph_pattern_flags;
337 
338 struct periph_match_pattern {
339 	char			periph_name[DEV_IDLEN];
340 	u_int32_t		unit_number;
341 	path_id_t		path_id;
342 	target_id_t		target_id;
343 	lun_id_t		target_lun;
344 	periph_pattern_flags	flags;
345 };
346 
347 typedef enum {
348 	DEV_MATCH_NONE		= 0x000,
349 	DEV_MATCH_PATH		= 0x001,
350 	DEV_MATCH_TARGET	= 0x002,
351 	DEV_MATCH_LUN		= 0x004,
352 	DEV_MATCH_INQUIRY	= 0x008,
353 	DEV_MATCH_ANY		= 0x00f
354 } dev_pattern_flags;
355 
356 struct device_match_pattern {
357 	path_id_t				path_id;
358 	target_id_t				target_id;
359 	lun_id_t				target_lun;
360 	struct scsi_static_inquiry_pattern	inq_pat;
361 	dev_pattern_flags			flags;
362 };
363 
364 typedef enum {
365 	BUS_MATCH_NONE		= 0x000,
366 	BUS_MATCH_PATH		= 0x001,
367 	BUS_MATCH_NAME		= 0x002,
368 	BUS_MATCH_UNIT		= 0x004,
369 	BUS_MATCH_BUS_ID	= 0x008,
370 	BUS_MATCH_ANY		= 0x00f
371 } bus_pattern_flags;
372 
373 struct bus_match_pattern {
374 	path_id_t		path_id;
375 	char			dev_name[DEV_IDLEN];
376 	u_int32_t		unit_number;
377 	u_int32_t		bus_id;
378 	bus_pattern_flags	flags;
379 };
380 
381 union match_pattern {
382 	struct periph_match_pattern	periph_pattern;
383 	struct device_match_pattern	device_pattern;
384 	struct bus_match_pattern	bus_pattern;
385 };
386 
387 typedef enum {
388 	DEV_MATCH_PERIPH,
389 	DEV_MATCH_DEVICE,
390 	DEV_MATCH_BUS
391 } dev_match_type;
392 
393 struct dev_match_pattern {
394 	dev_match_type		type;
395 	union match_pattern	pattern;
396 };
397 
398 struct periph_match_result {
399 	char			periph_name[DEV_IDLEN];
400 	u_int32_t		unit_number;
401 	path_id_t		path_id;
402 	target_id_t		target_id;
403 	lun_id_t		target_lun;
404 };
405 
406 typedef enum {
407 	DEV_RESULT_NOFLAG		= 0x00,
408 	DEV_RESULT_UNCONFIGURED		= 0x01
409 } dev_result_flags;
410 
411 struct device_match_result {
412 	path_id_t			path_id;
413 	target_id_t			target_id;
414 	lun_id_t			target_lun;
415 	struct scsi_inquiry_data	inq_data;
416 	dev_result_flags		flags;
417 };
418 
419 struct bus_match_result {
420 	path_id_t	path_id;
421 	char		dev_name[DEV_IDLEN];
422 	u_int32_t	unit_number;
423 	u_int32_t	bus_id;
424 };
425 
426 union match_result {
427 	struct periph_match_result	periph_result;
428 	struct device_match_result	device_result;
429 	struct bus_match_result		bus_result;
430 };
431 
432 struct dev_match_result {
433 	dev_match_type		type;
434 	union match_result	result;
435 };
436 
437 typedef enum {
438 	CAM_DEV_MATCH_LAST,
439 	CAM_DEV_MATCH_MORE,
440 	CAM_DEV_MATCH_LIST_CHANGED,
441 	CAM_DEV_MATCH_SIZE_ERROR,
442 	CAM_DEV_MATCH_ERROR
443 } ccb_dev_match_status;
444 
445 typedef enum {
446 	CAM_DEV_POS_NONE	= 0x000,
447 	CAM_DEV_POS_BUS		= 0x001,
448 	CAM_DEV_POS_TARGET	= 0x002,
449 	CAM_DEV_POS_DEVICE	= 0x004,
450 	CAM_DEV_POS_PERIPH	= 0x008,
451 	CAM_DEV_POS_PDPTR	= 0x010,
452 	CAM_DEV_POS_TYPEMASK	= 0xf00,
453 	CAM_DEV_POS_EDT		= 0x100,
454 	CAM_DEV_POS_PDRV	= 0x200
455 } dev_pos_type;
456 
457 struct ccb_dm_cookie {
458 	void 	*bus;
459 	void	*target;
460 	void	*device;
461 	void	*periph;
462 	void	*pdrv;
463 };
464 
465 struct ccb_dev_position {
466 	u_int			generations[4];
467 #define	CAM_BUS_GENERATION	0x00
468 #define CAM_TARGET_GENERATION	0x01
469 #define CAM_DEV_GENERATION	0x02
470 #define CAM_PERIPH_GENERATION	0x03
471 	dev_pos_type		position_type;
472 	struct ccb_dm_cookie	cookie;
473 };
474 
475 struct ccb_dev_match {
476 	struct ccb_hdr			ccb_h;
477 	ccb_dev_match_status		status;
478 	u_int32_t			num_patterns;
479 	u_int32_t			pattern_buf_len;
480 	struct dev_match_pattern	*patterns;
481 	u_int32_t			num_matches;
482 	u_int32_t			match_buf_len;
483 	struct dev_match_result		*matches;
484 	struct ccb_dev_position		pos;
485 };
486 
487 /*
488  * Definitions for the path inquiry CCB fields.
489  */
490 #define CAM_VERSION	0x15	/* Hex value for current version */
491 
492 typedef enum {
493 	PI_MDP_ABLE	= 0x80,	/* Supports MDP message */
494 	PI_WIDE_32	= 0x40,	/* Supports 32 bit wide SCSI */
495 	PI_WIDE_16	= 0x20, /* Supports 16 bit wide SCSI */
496 	PI_SDTR_ABLE	= 0x10,	/* Supports SDTR message */
497 	PI_LINKED_CDB	= 0x08, /* Supports linked CDBs */
498 	PI_TAG_ABLE	= 0x02,	/* Supports tag queue messages */
499 	PI_SOFT_RST	= 0x01	/* Supports soft reset alternative */
500 } pi_inqflag;
501 
502 typedef enum {
503 	PIT_PROCESSOR	= 0x80,	/* Target mode processor mode */
504 	PIT_PHASE	= 0x40,	/* Target mode phase cog. mode */
505 	PIT_DISCONNECT	= 0x20,	/* Disconnects supported in target mode */
506 	PIT_TERM_IO	= 0x10,	/* Terminate I/O message supported in TM */
507 	PIT_GRP_6	= 0x08,	/* Group 6 commands supported */
508 	PIT_GRP_7	= 0x04	/* Group 7 commands supported */
509 } pi_tmflag;
510 
511 typedef enum {
512 	PIM_SCANHILO	= 0x80,	/* Bus scans from high ID to low ID */
513 	PIM_NOREMOVE	= 0x40,	/* Removeable devices not included in scan */
514 	PIM_NOINITIATOR	= 0x20,	/* Initiator role not supported. */
515 	PIM_NOBUSRESET	= 0x10,	/* User has disabled initial BUS RESET */
516 	PIM_NO_6_BYTE	= 0x08	/* Do not send 6-byte commands */
517 } pi_miscflag;
518 
519 #ifdef CAM_NEW_TRAN_CODE
520 /* Path Inquiry CCB */
521 struct ccb_pathinq_settings_spi {
522 	u_int8_t ppr_options;
523 };
524 struct ccb_pathinq_settings_fc {
525 	u_int64_t wwnn;		/* world wide node name */
526 	u_int64_t wwpn;		/* world wide port name */
527 	u_int32_t port;		/* 24 bit port id, if known */
528 	u_int32_t bitrate;	/* Mbps */
529 };
530 #define	PATHINQ_SETTINGS_SIZE	128
531 #endif /* CAM_NEW_TRAN_CODE */
532 
533 struct ccb_pathinq {
534 	struct 	    ccb_hdr ccb_h;
535 	u_int8_t    version_num;	/* Version number for the SIM/HBA */
536 	u_int8_t    hba_inquiry;	/* Mimic of INQ byte 7 for the HBA */
537 	u_int8_t    target_sprt;	/* Flags for target mode support */
538 	u_int8_t    hba_misc;		/* Misc HBA features */
539 	u_int16_t   hba_eng_cnt;	/* HBA engine count */
540 					/* Vendor Unique capabilities */
541 	u_int8_t    vuhba_flags[VUHBALEN];
542 	u_int32_t   max_target;		/* Maximum supported Target */
543 	u_int32_t   max_lun;		/* Maximum supported Lun */
544 	u_int32_t   async_flags;	/* Installed Async handlers */
545 	path_id_t   hpath_id;		/* Highest Path ID in the subsystem */
546 	target_id_t initiator_id;	/* ID of the HBA on the SCSI bus */
547 	char	    sim_vid[SIM_IDLEN];	/* Vendor ID of the SIM */
548 	char	    hba_vid[HBA_IDLEN];	/* Vendor ID of the HBA */
549 	char 	    dev_name[DEV_IDLEN];/* Device name for SIM */
550 	u_int32_t   unit_number;	/* Unit number for SIM */
551 	u_int32_t   bus_id;		/* Bus ID for SIM */
552 	u_int32_t   base_transfer_speed;/* Base bus speed in KB/sec */
553 #ifdef CAM_NEW_TRAN_CODE
554 	cam_proto   protocol;
555 	u_int	    protocol_version;
556 	cam_xport   transport;
557 	u_int	    transport_version;
558 	union {
559 		struct ccb_pathinq_settings_spi spi;
560 		struct ccb_pathinq_settings_fc fc;
561 		char ccb_pathinq_settings_opaque[PATHINQ_SETTINGS_SIZE];
562 	} xport_specific;
563 #endif /* CAM_NEW_TRAN_CODE */
564 };
565 
566 /* Path Statistics CCB */
567 struct ccb_pathstats {
568 	struct	ccb_hdr	ccb_h;
569 	struct	timeval last_reset;	/* Time of last bus reset/loop init */
570 };
571 
572 typedef union {
573 	u_int8_t *sense_ptr;		/*
574 					 * Pointer to storage
575 					 * for sense information
576 					 */
577 	                                /* Storage Area for sense information */
578 	struct	 scsi_sense_data sense_buf;
579 } sense_t;
580 
581 typedef union {
582 	u_int8_t  *cdb_ptr;		/* Pointer to the CDB bytes to send */
583 					/* Area for the CDB send */
584 	u_int8_t  cdb_bytes[IOCDBLEN];
585 } cdb_t;
586 
587 /*
588  * SCSI I/O Request CCB used for the XPT_SCSI_IO and XPT_CONT_TARGET_IO
589  * function codes.
590  */
591 struct ccb_scsiio {
592 	struct	   ccb_hdr ccb_h;
593 	union	   ccb *next_ccb;	/* Ptr for next CCB for action */
594 	u_int8_t   *req_map;		/* Ptr to mapping info */
595 	u_int8_t   *data_ptr;		/* Ptr to the data buf/SG list */
596 	u_int32_t  dxfer_len;		/* Data transfer length */
597 					/* Autosense storage */
598 	struct     scsi_sense_data sense_data;
599 	u_int8_t   sense_len;		/* Number of bytes to autosense */
600 	u_int8_t   cdb_len;		/* Number of bytes for the CDB */
601 	u_int16_t  sglist_cnt;		/* Number of SG list entries */
602 	u_int8_t   scsi_status;		/* Returned SCSI status */
603 	u_int8_t   sense_resid;		/* Autosense resid length: 2's comp */
604 	u_int32_t  resid;		/* Transfer residual length: 2's comp */
605 	cdb_t	   cdb_io;		/* Union for CDB bytes/pointer */
606 	u_int8_t   *msg_ptr;		/* Pointer to the message buffer */
607 	u_int16_t  msg_len;		/* Number of bytes for the Message */
608 	u_int8_t   tag_action;		/* What to do for tag queueing */
609 	/*
610 	 * The tag action should be either the define below (to send a
611 	 * non-tagged transaction) or one of the defined scsi tag messages
612 	 * from scsi_message.h.
613 	 */
614 #define		CAM_TAG_ACTION_NONE	0x00
615 	u_int	   tag_id;		/* tag id from initator (target mode) */
616 	u_int	   init_id;		/* initiator id of who selected */
617 };
618 
619 struct ccb_accept_tio {
620 	struct	   ccb_hdr ccb_h;
621 	cdb_t	   cdb_io;		/* Union for CDB bytes/pointer */
622 	u_int8_t   cdb_len;		/* Number of bytes for the CDB */
623 	u_int8_t   tag_action;		/* What to do for tag queueing */
624 	u_int8_t   sense_len;		/* Number of bytes of Sense Data */
625 	u_int      tag_id;		/* tag id from initator (target mode) */
626 	u_int      init_id;		/* initiator id of who selected */
627 	struct     scsi_sense_data sense_data;
628 };
629 
630 /* Release SIM Queue */
631 struct ccb_relsim {
632 	struct ccb_hdr ccb_h;
633 	u_int32_t      release_flags;
634 #define RELSIM_ADJUST_OPENINGS		0x01
635 #define RELSIM_RELEASE_AFTER_TIMEOUT	0x02
636 #define RELSIM_RELEASE_AFTER_CMDCMPLT	0x04
637 #define RELSIM_RELEASE_AFTER_QEMPTY	0x08
638 	u_int32_t      openings;
639 	u_int32_t      release_timeout;
640 	u_int32_t      qfrozen_cnt;
641 };
642 
643 /*
644  * Definitions for the asynchronous callback CCB fields.
645  */
646 typedef enum {
647 	AC_GETDEV_CHANGED	= 0x800,/* Getdev info might have changed */
648 	AC_INQ_CHANGED		= 0x400,/* Inquiry info might have changed */
649 	AC_TRANSFER_NEG		= 0x200,/* New transfer settings in effect */
650 	AC_LOST_DEVICE		= 0x100,/* A device went away */
651 	AC_FOUND_DEVICE		= 0x080,/* A new device was found */
652 	AC_PATH_DEREGISTERED	= 0x040,/* A path has de-registered */
653 	AC_PATH_REGISTERED	= 0x020,/* A new path has been registered */
654 	AC_SENT_BDR		= 0x010,/* A BDR message was sent to target */
655 	AC_SCSI_AEN		= 0x008,/* A SCSI AEN has been received */
656 	AC_UNSOL_RESEL		= 0x002,/* Unsolicited reselection occurred */
657 	AC_BUS_RESET		= 0x001	/* A SCSI bus reset occurred */
658 } ac_code;
659 
660 typedef void ac_callback_t (void *softc, u_int32_t code,
661 			    struct cam_path *path, void *args);
662 
663 /* Set Asynchronous Callback CCB */
664 struct ccb_setasync {
665 	struct ccb_hdr	 ccb_h;
666 	u_int32_t	 event_enable;	/* Async Event enables */
667 	ac_callback_t	*callback;
668 	void		*callback_arg;
669 };
670 
671 /* Set Device Type CCB */
672 struct ccb_setdev {
673 	struct	   ccb_hdr ccb_h;
674 	u_int8_t   dev_type;	/* Value for dev type field in EDT */
675 };
676 
677 /* SCSI Control Functions */
678 
679 /* Abort XPT request CCB */
680 struct ccb_abort {
681 	struct 	ccb_hdr ccb_h;
682 	union	ccb *abort_ccb;	/* Pointer to CCB to abort */
683 };
684 
685 /* Reset SCSI Bus CCB */
686 struct ccb_resetbus {
687 	struct	ccb_hdr ccb_h;
688 };
689 
690 /* Reset SCSI Device CCB */
691 struct ccb_resetdev {
692 	struct	ccb_hdr ccb_h;
693 };
694 
695 /* Terminate I/O Process Request CCB */
696 struct ccb_termio {
697 	struct	ccb_hdr ccb_h;
698 	union	ccb *termio_ccb;	/* Pointer to CCB to terminate */
699 };
700 
701 #ifndef CAM_NEW_TRAN_CODE
702 /* Get/Set transfer rate/width/disconnection/tag queueing settings */
703 struct ccb_trans_settings {
704 	struct	ccb_hdr ccb_h;
705 	u_int	valid;  /* Which fields to honor */
706 #define		CCB_TRANS_SYNC_RATE_VALID	0x01
707 #define		CCB_TRANS_SYNC_OFFSET_VALID	0x02
708 #define		CCB_TRANS_BUS_WIDTH_VALID	0x04
709 #define		CCB_TRANS_DISC_VALID		0x08
710 #define		CCB_TRANS_TQ_VALID		0x10
711 	u_int	flags;
712 #define		CCB_TRANS_CURRENT_SETTINGS	0x01
713 #define		CCB_TRANS_USER_SETTINGS		0x02
714 #define		CCB_TRANS_DISC_ENB		0x04
715 #define		CCB_TRANS_TAG_ENB		0x08
716 	u_int	sync_period;
717 	u_int	sync_offset;
718 	u_int	bus_width;
719 };
720 
721 #else /* CAM_NEW_TRAN_CODE */
722 typedef enum {
723 	CTS_TYPE_CURRENT_SETTINGS,
724 	CTS_TYPE_USER_SETTINGS
725 } cts_type;
726 
727 struct ccb_trans_settings_scsi
728 {
729 	u_int	valid;	/* Which fields to honor */
730 #define	CTS_SCSI_VALID_TQ		0x01
731 	u_int	flags;
732 #define	CTS_SCSI_FLAGS_TAG_ENB		0x01
733 };
734 
735 struct ccb_trans_settings_spi
736 {
737 	u_int	  valid;	/* Which fields to honor */
738 #define	CTS_SPI_VALID_SYNC_RATE		0x01
739 #define	CTS_SPI_VALID_SYNC_OFFSET	0x02
740 #define	CTS_SPI_VALID_BUS_WIDTH		0x04
741 #define	CTS_SPI_VALID_DISC		0x08
742 #define CTS_SPI_VALID_PPR_OPTIONS	0x10
743 	u_int	flags;
744 #define	CTS_SPI_FLAGS_DISC_ENB		0x01
745 #define	CTS_SPI_FLAGS_TAG_ENB		0x02
746 	u_int	sync_period;
747 	u_int	sync_offset;
748 	u_int	bus_width;
749 	u_int	ppr_options;
750 };
751 
752 struct ccb_trans_settings_fc {
753 	u_int     	valid;		/* Which fields to honor */
754 #define	CTS_FC_VALID_WWNN		0x8000
755 #define	CTS_FC_VALID_WWPN		0x4000
756 #define	CTS_FC_VALID_PORT		0x2000
757 #define	CTS_FC_VALID_SPEED		0x1000
758 	u_int64_t	wwnn;		/* world wide node name */
759 	u_int64_t 	wwpn;		/* world wide port name */
760 	u_int32_t 	port;		/* 24 bit port id, if known */
761 	u_int32_t 	bitrate;	/* Mbps */
762 };
763 
764 /* Get/Set transfer rate/width/disconnection/tag queueing settings */
765 struct ccb_trans_settings {
766 	struct	  ccb_hdr ccb_h;
767 	cts_type  type;		/* Current or User settings */
768 	cam_proto protocol;
769 	u_int	  protocol_version;
770 	cam_xport transport;
771 	u_int	  transport_version;
772 	union {
773 		u_int  valid;	/* Which fields to honor */
774 		struct ccb_trans_settings_scsi scsi;
775 	} proto_specific;
776 	union {
777 		u_int  valid;	/* Which fields to honor */
778 		struct ccb_trans_settings_spi spi;
779 		struct ccb_trans_settings_fc fc;
780 	} xport_specific;
781 };
782 
783 #endif /* CAM_NEW_TRAN_CODE */
784 
785 /*
786  * Calculate the geometry parameters for a device
787  * give the block size and volume size in blocks.
788  */
789 struct ccb_calc_geometry {
790 	struct	  ccb_hdr ccb_h;
791 	u_int32_t block_size;
792 	u_int64_t volume_size;
793 	u_int32_t cylinders;
794 	u_int8_t  heads;
795 	u_int8_t  secs_per_track;
796 };
797 
798 /*
799  * Rescan the given bus, or bus/target/lun
800  */
801 struct ccb_rescan {
802 	struct	ccb_hdr ccb_h;
803 	cam_flags	flags;
804 };
805 
806 /*
807  * Turn on debugging for the given bus, bus/target, or bus/target/lun.
808  */
809 struct ccb_debug {
810 	struct	ccb_hdr ccb_h;
811 	cam_debug_flags flags;
812 };
813 
814 /* Target mode structures. */
815 
816 struct ccb_en_lun {
817 	struct	  ccb_hdr ccb_h;
818 	u_int16_t grp6_len;		/* Group 6 VU CDB length */
819 	u_int16_t grp7_len;		/* Group 7 VU CDB length */
820 	u_int8_t  enable;
821 };
822 
823 struct ccb_immed_notify {
824 	struct	  ccb_hdr ccb_h;
825 	struct    scsi_sense_data sense_data;
826 	u_int8_t  sense_len;		/* Number of bytes in sense buffer */
827 	u_int8_t  initiator_id;		/* Id of initiator that selected */
828 	u_int8_t  message_args[7];	/* Message Arguments */
829 };
830 
831 struct ccb_notify_ack {
832 	struct	  ccb_hdr ccb_h;
833 	u_int16_t seq_id;		/* Sequence identifier */
834 	u_int8_t  event;		/* Event flags */
835 };
836 
837 /* HBA engine structures. */
838 
839 typedef enum {
840 	EIT_BUFFER,	/* Engine type: buffer memory */
841 	EIT_LOSSLESS,	/* Engine type: lossless compression */
842 	EIT_LOSSY,	/* Engine type: lossy compression */
843 	EIT_ENCRYPT	/* Engine type: encryption */
844 } ei_type;
845 
846 typedef enum {
847 	EAD_VUNIQUE,	/* Engine algorithm ID: vendor unique */
848 	EAD_LZ1V1,	/* Engine algorithm ID: LZ1 var.1 */
849 	EAD_LZ2V1,	/* Engine algorithm ID: LZ2 var.1 */
850 	EAD_LZ2V2	/* Engine algorithm ID: LZ2 var.2 */
851 } ei_algo;
852 
853 struct ccb_eng_inq {
854 	struct	  ccb_hdr ccb_h;
855 	u_int16_t eng_num;	/* The engine number for this inquiry */
856 	ei_type   eng_type;	/* Returned engine type */
857 	ei_algo   eng_algo;	/* Returned engine algorithm type */
858 	u_int32_t eng_memeory;	/* Returned engine memory size */
859 };
860 
861 struct ccb_eng_exec {	/* This structure must match SCSIIO size */
862 	struct	  ccb_hdr ccb_h;
863 	u_int8_t  *pdrv_ptr;	/* Ptr used by the peripheral driver */
864 	u_int8_t  *req_map;	/* Ptr for mapping info on the req. */
865 	u_int8_t  *data_ptr;	/* Pointer to the data buf/SG list */
866 	u_int32_t dxfer_len;	/* Data transfer length */
867 	u_int8_t  *engdata_ptr;	/* Pointer to the engine buffer data */
868 	u_int16_t sglist_cnt;	/* Num of scatter gather list entries */
869 	u_int32_t dmax_len;	/* Destination data maximum length */
870 	u_int32_t dest_len;	/* Destination data length */
871 	int32_t	  src_resid;	/* Source residual length: 2's comp */
872 	u_int32_t timeout;	/* Timeout value */
873 	u_int16_t eng_num;	/* Engine number for this request */
874 	u_int16_t vu_flags;	/* Vendor Unique flags */
875 };
876 
877 /*
878  * Definitions for the timeout field in the SCSI I/O CCB.
879  */
880 #define	CAM_TIME_DEFAULT	0x00000000	/* Use SIM default value */
881 #define	CAM_TIME_INFINITY	0xFFFFFFFF	/* Infinite timeout */
882 
883 #define	CAM_SUCCESS	0	/* For signaling general success */
884 #define	CAM_FAILURE	1	/* For signaling general failure */
885 
886 #define CAM_FALSE	0
887 #define CAM_TRUE	1
888 
889 #define XPT_CCB_INVALID	-1	/* for signaling a bad CCB to free */
890 
891 /*
892  * Union of all CCB types for kernel space allocation.  This union should
893  * never be used for manipulating CCBs - its only use is for the allocation
894  * and deallocation of raw CCB space and is the return type of xpt_ccb_alloc
895  * and the argument to xpt_ccb_free.
896  */
897 union ccb {
898 	struct	ccb_hdr			ccb_h;	/* For convenience */
899 	struct	ccb_scsiio		csio;
900 	struct	ccb_getdev		cgd;
901 	struct	ccb_getdevlist		cgdl;
902 	struct	ccb_pathinq		cpi;
903 	struct	ccb_relsim		crs;
904 	struct	ccb_setasync		csa;
905 	struct	ccb_setdev		csd;
906 	struct	ccb_pathstats		cpis;
907 	struct	ccb_getdevstats		cgds;
908 	struct	ccb_dev_match		cdm;
909 	struct	ccb_trans_settings	cts;
910 	struct	ccb_calc_geometry	ccg;
911 	struct	ccb_abort		cab;
912 	struct	ccb_resetbus		crb;
913 	struct	ccb_resetdev		crd;
914 	struct	ccb_termio		tio;
915 	struct	ccb_accept_tio		atio;
916 	struct	ccb_scsiio		ctio;
917 	struct	ccb_en_lun		cel;
918 	struct	ccb_immed_notify	cin;
919 	struct	ccb_notify_ack		cna;
920 	struct	ccb_eng_inq		cei;
921 	struct	ccb_eng_exec		cee;
922 	struct 	ccb_rescan		crcn;
923 	struct  ccb_debug		cdbg;
924 };
925 
926 __BEGIN_DECLS
927 static __inline void
928 cam_fill_csio(struct ccb_scsiio *csio, u_int32_t retries,
929 	      void (*cbfcnp)(struct cam_periph *, union ccb *),
930 	      u_int32_t flags, u_int8_t tag_action,
931 	      u_int8_t *data_ptr, u_int32_t dxfer_len,
932 	      u_int8_t sense_len, u_int8_t cdb_len,
933 	      u_int32_t timeout);
934 
935 static __inline void
936 cam_fill_ctio(struct ccb_scsiio *csio, u_int32_t retries,
937 	      void (*cbfcnp)(struct cam_periph *, union ccb *),
938 	      u_int32_t flags, u_int tag_action, u_int tag_id,
939 	      u_int init_id, u_int scsi_status, u_int8_t *data_ptr,
940 	      u_int32_t dxfer_len, u_int32_t timeout);
941 
942 static __inline void
943 cam_fill_csio(struct ccb_scsiio *csio, u_int32_t retries,
944 	      void (*cbfcnp)(struct cam_periph *, union ccb *),
945 	      u_int32_t flags, u_int8_t tag_action,
946 	      u_int8_t *data_ptr, u_int32_t dxfer_len,
947 	      u_int8_t sense_len, u_int8_t cdb_len,
948 	      u_int32_t timeout)
949 {
950 	csio->ccb_h.func_code = XPT_SCSI_IO;
951 	csio->ccb_h.flags = flags;
952 	csio->ccb_h.retry_count = retries;
953 	csio->ccb_h.cbfcnp = cbfcnp;
954 	csio->ccb_h.timeout = timeout;
955 	csio->data_ptr = data_ptr;
956 	csio->dxfer_len = dxfer_len;
957 	csio->sense_len = sense_len;
958 	csio->cdb_len = cdb_len;
959 	csio->tag_action = tag_action;
960 }
961 
962 static __inline void
963 cam_fill_ctio(struct ccb_scsiio *csio, u_int32_t retries,
964 	      void (*cbfcnp)(struct cam_periph *, union ccb *),
965 	      u_int32_t flags, u_int tag_action, u_int tag_id,
966 	      u_int init_id, u_int scsi_status, u_int8_t *data_ptr,
967 	      u_int32_t dxfer_len, u_int32_t timeout)
968 {
969 	csio->ccb_h.func_code = XPT_CONT_TARGET_IO;
970 	csio->ccb_h.flags = flags;
971 	csio->ccb_h.retry_count = retries;
972 	csio->ccb_h.cbfcnp = cbfcnp;
973 	csio->ccb_h.timeout = timeout;
974 	csio->data_ptr = data_ptr;
975 	csio->dxfer_len = dxfer_len;
976 	csio->scsi_status = scsi_status;
977 	csio->tag_action = tag_action;
978 	csio->tag_id = tag_id;
979 	csio->init_id = init_id;
980 }
981 
982 void cam_calc_geometry(struct ccb_calc_geometry *ccg, int extended);
983 
984 __END_DECLS
985 
986 #endif /* _CAM_CAM_CCB_H */
987