File:  [DragonFly] / src / sys / bus / cam / cam_ccb.h
Revision 1.5: download - view: text, annotated - select for diffs
Mon Dec 29 23:09:30 2003 UTC (10 years, 8 months ago) by dillon
Branches: MAIN
CVS tags: HEAD
Add missing prototypes in last commit, other minor adjustments.

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