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