Whitespace to make comments more legible.
[dragonfly.git] / sys / bus / cam / cam_ccb.h
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.13 2007/11/28 21:20:25 pavalos 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 #ifdef CAM_NEW_TRAN_CODE
39 #include <machine/limits.h>
40 #endif
41 #include <sys/callout.h>
42 #include "cam_debug.h"
43 #include "scsi/scsi_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 SIM 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 /* SCSI Control Functions: 0x10->0x1F */
146         XPT_ABORT               = 0x10,
147                                 /* Abort the specified CCB */
148         XPT_RESET_BUS           = 0x11 | XPT_FC_XPT_ONLY,
149                                 /* Reset the specified SCSI bus */
150         XPT_RESET_DEV           = 0x12 | XPT_FC_DEV_QUEUED,
151                                 /* Bus Device Reset the specified SCSI device */
152         XPT_TERM_IO             = 0x13,
153                                 /* Terminate the I/O process */
154         XPT_SCAN_LUN            = 0x14 | XPT_FC_QUEUED | XPT_FC_USER_CCB
155                                        | XPT_FC_XPT_ONLY,
156                                 /* Scan Logical Unit */
157         XPT_GET_TRAN_SETTINGS   = 0x15,
158                                 /*
159                                  * Get default/user transfer settings
160                                  * for the target
161                                  */
162         XPT_SET_TRAN_SETTINGS   = 0x16,
163                                 /*
164                                  * Set transfer rate/width
165                                  * negotiation settings
166                                  */
167         XPT_CALC_GEOMETRY       = 0x17,
168                                 /*
169                                  * Calculate the geometry parameters for
170                                  * a device give the sector size and
171                                  * volume size.
172                                  */
173
174 /* HBA engine commands 0x20->0x2F */
175         XPT_ENG_INQ             = 0x20 | XPT_FC_XPT_ONLY,
176                                 /* HBA engine feature inquiry */
177         XPT_ENG_EXEC            = 0x21 | XPT_FC_DEV_QUEUED,
178                                 /* HBA execute engine request */
179
180 /* Target mode commands: 0x30->0x3F */
181         XPT_EN_LUN              = 0x30,
182                                 /* Enable LUN as a target */
183         XPT_TARGET_IO           = 0x31 | XPT_FC_DEV_QUEUED,
184                                 /* Execute target I/O request */
185         XPT_ACCEPT_TARGET_IO    = 0x32 | XPT_FC_QUEUED | XPT_FC_USER_CCB,
186                                 /* Accept Host Target Mode CDB */
187         XPT_CONT_TARGET_IO      = 0x33 | XPT_FC_DEV_QUEUED,
188                                 /* Continue Host Target I/O Connection */
189         XPT_IMMED_NOTIFY        = 0x34 | XPT_FC_QUEUED | XPT_FC_USER_CCB,
190                                 /* Notify Host Target driver of event */
191         XPT_NOTIFY_ACK          = 0x35,
192                                 /* Acknowledgement of event */
193
194 /* Vendor Unique codes: 0x80->0x8F */
195         XPT_VUNIQUE             = 0x80
196 } xpt_opcode;
197
198 #define XPT_FC_GROUP_MASK               0xF0
199 #define XPT_FC_GROUP(op) ((op) & XPT_FC_GROUP_MASK)
200 #define XPT_FC_GROUP_COMMON             0x00
201 #define XPT_FC_GROUP_SCSI_CONTROL       0x10
202 #define XPT_FC_GROUP_HBA_ENGINE         0x20
203 #define XPT_FC_GROUP_TMODE              0x30
204 #define XPT_FC_GROUP_VENDOR_UNIQUE      0x80
205
206 #define XPT_FC_IS_DEV_QUEUED(ccb)       \
207     (((ccb)->ccb_h.func_code & XPT_FC_DEV_QUEUED) == XPT_FC_DEV_QUEUED)
208 #define XPT_FC_IS_QUEUED(ccb)   \
209     (((ccb)->ccb_h.func_code & XPT_FC_QUEUED) != 0)
210
211 #ifdef CAM_NEW_TRAN_CODE
212 typedef enum {
213         PROTO_UNKNOWN,
214         PROTO_UNSPECIFIED,
215         PROTO_SCSI,     /* Small Computer System Interface */
216         PROTO_ATA,      /* AT Attachment */
217         PROTO_ATAPI,    /* AT Attachment Packetized Interface */
218 } cam_proto;
219
220 typedef enum {
221         XPORT_UNKNOWN,
222         XPORT_UNSPECIFIED,
223         XPORT_SPI,      /* SCSI Parallel Interface */
224         XPORT_FC,       /* Fiber Channel */
225         XPORT_SSA,      /* Serial Storage Architecture */
226         XPORT_USB,      /* Universal Serial Bus */
227         XPORT_PPB,      /* Parallel Port Bus */
228         XPORT_ATA       /* AT Attachment */
229 } cam_xport;
230
231 #define PROTO_VERSION_UNKNOWN (UINT_MAX - 1)
232 #define PROTO_VERSION_UNSPECIFIED UINT_MAX
233 #define XPORT_VERSION_UNKNOWN (UINT_MAX - 1)
234 #define XPORT_VERSION_UNSPECIFIED UINT_MAX
235 #endif /* CAM_NEW_TRAN_CODE */
236
237 typedef union {
238         LIST_ENTRY(ccb_hdr) le;
239         SLIST_ENTRY(ccb_hdr) sle;
240         TAILQ_ENTRY(ccb_hdr) tqe;
241         STAILQ_ENTRY(ccb_hdr) stqe;
242 } camq_entry;
243
244 typedef union {
245         void            *ptr;
246         u_long          field;
247         u_int8_t        bytes[sizeof(void *) > sizeof(u_long)
248                               ? sizeof(void *) : sizeof(u_long)];
249 } ccb_priv_entry;
250
251 typedef union {
252         ccb_priv_entry  entries[CCB_PERIPH_PRIV_SIZE];
253         u_int8_t        bytes[CCB_PERIPH_PRIV_SIZE * sizeof(ccb_priv_entry)];
254 } ccb_ppriv_area;
255
256 typedef union {
257         ccb_priv_entry  entries[CCB_SIM_PRIV_SIZE];
258         u_int8_t        bytes[CCB_SIM_PRIV_SIZE * sizeof(ccb_priv_entry)];
259 } ccb_spriv_area;
260
261 struct ccb_hdr {
262         cam_pinfo       pinfo;          /* Info for priority scheduling */
263         camq_entry      xpt_links;      /* For chaining in the XPT layer */     
264         camq_entry      sim_links;      /* For chaining in the SIM layer */     
265         camq_entry      periph_links;   /* For chaining in the type driver */
266         u_int32_t       retry_count;
267         void            (*cbfcnp)(struct cam_periph *, union ccb *);
268                                         /* Callback on completion function */
269         xpt_opcode      func_code;      /* XPT function code */
270         u_int32_t       status;         /* Status returned by CAM subsystem */
271         struct          cam_path *path; /* Compiled path for this ccb */
272         path_id_t       path_id;        /* Path ID for the request */
273         target_id_t     target_id;      /* Target device ID */
274         lun_id_t        target_lun;     /* Target LUN number */
275         u_int32_t       flags;          /* ccb_flags */
276         ccb_ppriv_area  periph_priv;
277         ccb_spriv_area  sim_priv;
278         u_int32_t       timeout;        /* Timeout value */
279         struct          callout timeout_ch;
280                                         /* Callout handle used for timeouts */
281 };
282
283 /* Get Device Information CCB */
284 struct ccb_getdev {
285         struct    ccb_hdr ccb_h;
286         struct scsi_inquiry_data inq_data;
287         u_int8_t  serial_num[252];
288         u_int8_t  reserved;
289         u_int8_t  serial_num_len;
290 };
291
292 /* Device Statistics CCB */
293 struct ccb_getdevstats {
294         struct  ccb_hdr ccb_h;
295         int     dev_openings;   /* Space left for more work on device*/ 
296         int     dev_active;     /* Transactions running on the device */
297         int     devq_openings;  /* Space left for more queued work */
298         int     devq_queued;    /* Transactions queued to be sent */
299         int     held;           /*
300                                  * CCBs held by peripheral drivers
301                                  * for this device
302                                  */
303         int     maxtags;        /*
304                                  * Boundary conditions for number of
305                                  * tagged operations
306                                  */
307         int     mintags;
308         struct  timeval last_reset;  /* Uptime of last bus reset/loop init */
309 };
310
311 typedef enum {
312         CAM_GDEVLIST_LAST_DEVICE,
313         CAM_GDEVLIST_LIST_CHANGED,
314         CAM_GDEVLIST_MORE_DEVS,
315         CAM_GDEVLIST_ERROR
316 } ccb_getdevlist_status_e;
317
318 struct ccb_getdevlist {
319         struct ccb_hdr          ccb_h;
320         char                    periph_name[DEV_IDLEN];
321         u_int32_t               unit_number;
322         unsigned int            generation;
323         u_int32_t               index;
324         ccb_getdevlist_status_e status;
325 };
326
327 typedef enum {
328         PERIPH_MATCH_NONE       = 0x000,
329         PERIPH_MATCH_PATH       = 0x001,
330         PERIPH_MATCH_TARGET     = 0x002,
331         PERIPH_MATCH_LUN        = 0x004,
332         PERIPH_MATCH_NAME       = 0x008,
333         PERIPH_MATCH_UNIT       = 0x010,
334         PERIPH_MATCH_ANY        = 0x01f
335 } periph_pattern_flags;
336
337 struct periph_match_pattern {
338         char                    periph_name[DEV_IDLEN];
339         u_int32_t               unit_number;
340         path_id_t               path_id;
341         target_id_t             target_id;
342         lun_id_t                target_lun;
343         periph_pattern_flags    flags;
344 };
345
346 typedef enum {
347         DEV_MATCH_NONE          = 0x000,
348         DEV_MATCH_PATH          = 0x001,
349         DEV_MATCH_TARGET        = 0x002,
350         DEV_MATCH_LUN           = 0x004,
351         DEV_MATCH_INQUIRY       = 0x008,
352         DEV_MATCH_ANY           = 0x00f
353 } dev_pattern_flags;
354
355 struct device_match_pattern {
356         path_id_t                               path_id;
357         target_id_t                             target_id;
358         lun_id_t                                target_lun;
359         struct scsi_static_inquiry_pattern      inq_pat;
360         dev_pattern_flags                       flags;
361 };
362
363 typedef enum {
364         BUS_MATCH_NONE          = 0x000,
365         BUS_MATCH_PATH          = 0x001,
366         BUS_MATCH_NAME          = 0x002,
367         BUS_MATCH_UNIT          = 0x004,
368         BUS_MATCH_BUS_ID        = 0x008,
369         BUS_MATCH_ANY           = 0x00f
370 } bus_pattern_flags;
371
372 struct bus_match_pattern {
373         path_id_t               path_id;
374         char                    dev_name[DEV_IDLEN];
375         u_int32_t               unit_number;
376         u_int32_t               bus_id;
377         bus_pattern_flags       flags;
378 };
379
380 union match_pattern {
381         struct periph_match_pattern     periph_pattern;
382         struct device_match_pattern     device_pattern;
383         struct bus_match_pattern        bus_pattern;
384 };
385
386 typedef enum {
387         DEV_MATCH_PERIPH,
388         DEV_MATCH_DEVICE,
389         DEV_MATCH_BUS
390 } dev_match_type;
391
392 struct dev_match_pattern {
393         dev_match_type          type;
394         union match_pattern     pattern;
395 };
396
397 struct periph_match_result {
398         char                    periph_name[DEV_IDLEN];
399         u_int32_t               unit_number;
400         path_id_t               path_id;
401         target_id_t             target_id;
402         lun_id_t                target_lun;
403 };
404
405 typedef enum {
406         DEV_RESULT_NOFLAG               = 0x00,
407         DEV_RESULT_UNCONFIGURED         = 0x01
408 } dev_result_flags;
409
410 struct device_match_result {
411         path_id_t                       path_id;
412         target_id_t                     target_id;
413         lun_id_t                        target_lun;
414         struct scsi_inquiry_data        inq_data;
415         dev_result_flags                flags;
416 };
417
418 struct bus_match_result {
419         path_id_t       path_id;
420         char            dev_name[DEV_IDLEN];
421         u_int32_t       unit_number;
422         u_int32_t       bus_id;
423 };
424
425 union match_result {
426         struct periph_match_result      periph_result;
427         struct device_match_result      device_result;
428         struct bus_match_result         bus_result;
429 };
430
431 struct dev_match_result {
432         dev_match_type          type;
433         union match_result      result;
434 };
435
436 typedef enum {
437         CAM_DEV_MATCH_LAST,
438         CAM_DEV_MATCH_MORE,
439         CAM_DEV_MATCH_LIST_CHANGED,
440         CAM_DEV_MATCH_SIZE_ERROR,
441         CAM_DEV_MATCH_ERROR
442 } ccb_dev_match_status;
443
444 typedef enum {
445         CAM_DEV_POS_NONE        = 0x000,
446         CAM_DEV_POS_BUS         = 0x001,
447         CAM_DEV_POS_TARGET      = 0x002,
448         CAM_DEV_POS_DEVICE      = 0x004,
449         CAM_DEV_POS_PERIPH      = 0x008,
450         CAM_DEV_POS_PDPTR       = 0x010,
451         CAM_DEV_POS_TYPEMASK    = 0xf00,
452         CAM_DEV_POS_EDT         = 0x100,
453         CAM_DEV_POS_PDRV        = 0x200
454 } dev_pos_type;
455
456 struct ccb_dm_cookie {
457         void    *bus;
458         void    *target;        
459         void    *device;
460         void    *periph;
461         void    *pdrv;
462 };
463
464 struct ccb_dev_position {
465         u_int                   generations[4];
466 #define CAM_BUS_GENERATION      0x00
467 #define CAM_TARGET_GENERATION   0x01
468 #define CAM_DEV_GENERATION      0x02
469 #define CAM_PERIPH_GENERATION   0x03
470         dev_pos_type            position_type;
471         struct ccb_dm_cookie    cookie;
472 };
473
474 struct ccb_dev_match {
475         struct ccb_hdr                  ccb_h;
476         ccb_dev_match_status            status;
477         u_int32_t                       num_patterns;
478         u_int32_t                       pattern_buf_len;
479         struct dev_match_pattern        *patterns;
480         u_int32_t                       num_matches;
481         u_int32_t                       match_buf_len;
482         struct dev_match_result         *matches;
483         struct ccb_dev_position         pos;
484 };
485
486 /*
487  * Definitions for the path inquiry CCB fields.
488  */
489 #define CAM_VERSION     0x15    /* Hex value for current version */
490
491 typedef enum {
492         PI_MDP_ABLE     = 0x80, /* Supports MDP message */
493         PI_WIDE_32      = 0x40, /* Supports 32 bit wide SCSI */
494         PI_WIDE_16      = 0x20, /* Supports 16 bit wide SCSI */
495         PI_SDTR_ABLE    = 0x10, /* Supports SDTR message */
496         PI_LINKED_CDB   = 0x08, /* Supports linked CDBs */
497         PI_TAG_ABLE     = 0x02, /* Supports tag queue messages */
498         PI_SOFT_RST     = 0x01  /* Supports soft reset alternative */
499 } pi_inqflag;
500
501 typedef enum {
502         PIT_PROCESSOR   = 0x80, /* Target mode processor mode */
503         PIT_PHASE       = 0x40, /* Target mode phase cog. mode */
504         PIT_DISCONNECT  = 0x20, /* Disconnects supported in target mode */
505         PIT_TERM_IO     = 0x10, /* Terminate I/O message supported in TM */
506         PIT_GRP_6       = 0x08, /* Group 6 commands supported */
507         PIT_GRP_7       = 0x04  /* Group 7 commands supported */
508 } pi_tmflag;
509
510 typedef enum {
511         PIM_SCANHILO    = 0x80, /* Bus scans from high ID to low ID */
512         PIM_NOREMOVE    = 0x40, /* Removeable devices not included in scan */
513         PIM_NOINITIATOR = 0x20, /* Initiator role not supported. */
514         PIM_NOBUSRESET  = 0x10, /* User has disabled initial BUS RESET */
515         PIM_NO_6_BYTE   = 0x08  /* Do not send 6-byte commands */
516 } pi_miscflag;
517
518 #ifdef CAM_NEW_TRAN_CODE
519 /* Path Inquiry CCB */
520 struct ccb_pathinq_settings_spi {
521         u_int8_t ppr_options;
522 };
523 struct ccb_pathinq_settings_fc {
524         u_int64_t wwnn;         /* world wide node name */
525         u_int64_t wwpn;         /* world wide port name */
526         u_int32_t port;         /* 24 bit port id, if known */
527         u_int32_t bitrate;      /* Mbps */
528 };
529 #define PATHINQ_SETTINGS_SIZE   128
530 #endif /* CAM_NEW_TRAN_CODE */
531
532 struct ccb_pathinq {
533         struct      ccb_hdr ccb_h;
534         u_int8_t    version_num;        /* Version number for the SIM/HBA */
535         u_int8_t    hba_inquiry;        /* Mimic of INQ byte 7 for the HBA */
536         u_int8_t    target_sprt;        /* Flags for target mode support */
537         u_int8_t    hba_misc;           /* Misc HBA features */
538         u_int16_t   hba_eng_cnt;        /* HBA engine count */
539                                         /* Vendor Unique capabilities */
540         u_int8_t    vuhba_flags[VUHBALEN];
541         u_int32_t   max_target;         /* Maximum supported Target */
542         u_int32_t   max_lun;            /* Maximum supported Lun */
543         u_int32_t   async_flags;        /* Installed Async handlers */
544         path_id_t   hpath_id;           /* Highest Path ID in the subsystem */
545         target_id_t initiator_id;       /* ID of the HBA on the SCSI bus */
546         char        sim_vid[SIM_IDLEN]; /* Vendor ID of the SIM */
547         char        hba_vid[HBA_IDLEN]; /* Vendor ID of the HBA */
548         char        dev_name[DEV_IDLEN];/* Device name for SIM */
549         u_int32_t   unit_number;        /* Unit number for SIM */
550         u_int32_t   bus_id;             /* Bus ID for SIM */
551         u_int32_t   base_transfer_speed;/* Base bus speed in KB/sec */
552 #ifdef CAM_NEW_TRAN_CODE
553         cam_proto   protocol;
554         u_int       protocol_version;
555         cam_xport   transport;
556         u_int       transport_version;
557         union {
558                 struct ccb_pathinq_settings_spi spi;
559                 struct ccb_pathinq_settings_fc fc;
560                 char ccb_pathinq_settings_opaque[PATHINQ_SETTINGS_SIZE];
561         } xport_specific;
562 #endif /* CAM_NEW_TRAN_CODE */
563 };
564
565 /* Path Statistics CCB */
566 struct ccb_pathstats {
567         struct  ccb_hdr ccb_h;
568         struct  timeval last_reset;     /* Uptime of last bus reset/loop init */
569 };
570
571 typedef union {
572         u_int8_t *sense_ptr;            /*
573                                          * Pointer to storage
574                                          * for sense information
575                                          */
576                                         /* Storage Area for sense information */
577         struct   scsi_sense_data sense_buf;
578 } sense_t;
579
580 typedef union {
581         u_int8_t  *cdb_ptr;             /* Pointer to the CDB bytes to send */
582                                         /* Area for the CDB send */
583         u_int8_t  cdb_bytes[IOCDBLEN];
584 } cdb_t;
585
586 /*
587  * SCSI I/O Request CCB used for the XPT_SCSI_IO and XPT_CONT_TARGET_IO
588  * function codes.
589  */
590 struct ccb_scsiio {
591         struct     ccb_hdr ccb_h;
592         union      ccb *next_ccb;       /* Ptr for next CCB for action */
593         u_int8_t   *req_map;            /* Ptr to mapping info */
594         u_int8_t   *data_ptr;           /* Ptr to the data buf/SG list */
595         u_int32_t  dxfer_len;           /* Data transfer length */
596                                         /* Autosense storage */ 
597         struct     scsi_sense_data sense_data;
598         u_int8_t   sense_len;           /* Number of bytes to autosense */
599         u_int8_t   cdb_len;             /* Number of bytes for the CDB */
600         u_int16_t  sglist_cnt;          /* Number of SG list entries */
601         u_int8_t   scsi_status;         /* Returned SCSI status */
602         u_int8_t   sense_resid;         /* Autosense resid length: 2's comp */
603         u_int32_t  resid;               /* Transfer residual length: 2's comp */
604         cdb_t      cdb_io;              /* Union for CDB bytes/pointer */
605         u_int8_t   *msg_ptr;            /* Pointer to the message buffer */
606         u_int16_t  msg_len;             /* Number of bytes for the Message */
607         u_int8_t   tag_action;          /* What to do for tag queueing */
608         /*
609          * The tag action should be either the define below (to send a
610          * non-tagged transaction) or one of the defined scsi tag messages
611          * from scsi_message.h.
612          */
613 #define         CAM_TAG_ACTION_NONE     0x00
614         u_int      tag_id;              /* tag id from initator (target mode) */
615         u_int      init_id;             /* initiator id of who selected */
616 };
617
618 struct ccb_accept_tio {
619         struct     ccb_hdr ccb_h;
620         cdb_t      cdb_io;              /* Union for CDB bytes/pointer */
621         u_int8_t   cdb_len;             /* Number of bytes for the CDB */
622         u_int8_t   tag_action;          /* What to do for tag queueing */
623         u_int8_t   sense_len;           /* Number of bytes of Sense Data */
624         u_int      tag_id;              /* tag id from initator (target mode) */
625         u_int      init_id;             /* initiator id of who selected */
626         struct     scsi_sense_data sense_data;
627 };
628
629 /* Release SIM Queue */
630 struct ccb_relsim {
631         struct ccb_hdr ccb_h;
632         u_int32_t      release_flags;
633 #define RELSIM_ADJUST_OPENINGS          0x01
634 #define RELSIM_RELEASE_AFTER_TIMEOUT    0x02
635 #define RELSIM_RELEASE_AFTER_CMDCMPLT   0x04
636 #define RELSIM_RELEASE_AFTER_QEMPTY     0x08
637         u_int32_t      openings;
638         u_int32_t      release_timeout;
639         u_int32_t      qfrozen_cnt;
640 };
641
642 /*
643  * Definitions for the asynchronous callback CCB fields.
644  */
645 typedef enum {
646         AC_GETDEV_CHANGED       = 0x800,/* Getdev info might have changed */
647         AC_INQ_CHANGED          = 0x400,/* Inquiry info might have changed */
648         AC_TRANSFER_NEG         = 0x200,/* New transfer settings in effect */
649         AC_LOST_DEVICE          = 0x100,/* A device went away */
650         AC_FOUND_DEVICE         = 0x080,/* A new device was found */
651         AC_PATH_DEREGISTERED    = 0x040,/* A path has de-registered */
652         AC_PATH_REGISTERED      = 0x020,/* A new path has been registered */
653         AC_SENT_BDR             = 0x010,/* A BDR message was sent to target */
654         AC_SCSI_AEN             = 0x008,/* A SCSI AEN has been received */
655         AC_UNSOL_RESEL          = 0x002,/* Unsolicited reselection occurred */
656         AC_BUS_RESET            = 0x001 /* A SCSI bus reset occurred */
657 } ac_code;
658
659 typedef void ac_callback_t (void *softc, u_int32_t code,
660                             struct cam_path *path, void *args);
661
662 /* Set Asynchronous Callback CCB */
663 struct ccb_setasync {
664         struct ccb_hdr   ccb_h;
665         u_int32_t        event_enable;  /* Async Event enables */       
666         ac_callback_t   *callback;
667         void            *callback_arg;
668 };
669
670 /* Set Device Type CCB */
671 struct ccb_setdev {
672         struct     ccb_hdr ccb_h;
673         u_int8_t   dev_type;    /* Value for dev type field in EDT */
674 };
675
676 /* SCSI Control Functions */
677
678 /* Abort XPT request CCB */
679 struct ccb_abort {
680         struct  ccb_hdr ccb_h;
681         union   ccb *abort_ccb; /* Pointer to CCB to abort */
682 };
683
684 /* Reset SCSI Bus CCB */
685 struct ccb_resetbus {
686         struct  ccb_hdr ccb_h;
687 };
688
689 /* Reset SCSI Device CCB */
690 struct ccb_resetdev {
691         struct  ccb_hdr ccb_h;
692 };
693
694 /* Terminate I/O Process Request CCB */
695 struct ccb_termio {
696         struct  ccb_hdr ccb_h;
697         union   ccb *termio_ccb;        /* Pointer to CCB to terminate */
698 };
699
700 #ifndef CAM_NEW_TRAN_CODE
701 /* Get/Set transfer rate/width/disconnection/tag queueing settings */
702 struct ccb_trans_settings {
703         struct  ccb_hdr ccb_h;
704         u_int   valid;  /* Which fields to honor */
705 #define         CCB_TRANS_SYNC_RATE_VALID       0x01
706 #define         CCB_TRANS_SYNC_OFFSET_VALID     0x02
707 #define         CCB_TRANS_BUS_WIDTH_VALID       0x04
708 #define         CCB_TRANS_DISC_VALID            0x08
709 #define         CCB_TRANS_TQ_VALID              0x10
710         u_int   flags;
711 #define         CCB_TRANS_CURRENT_SETTINGS      0x01
712 #define         CCB_TRANS_USER_SETTINGS         0x02
713 #define         CCB_TRANS_DISC_ENB              0x04
714 #define         CCB_TRANS_TAG_ENB               0x08
715         u_int   sync_period;
716         u_int   sync_offset;
717         u_int   bus_width;
718 };
719
720 #else /* CAM_NEW_TRAN_CODE */
721 typedef enum {
722         CTS_TYPE_CURRENT_SETTINGS,
723         CTS_TYPE_USER_SETTINGS
724 } cts_type;
725
726 struct ccb_trans_settings_scsi
727 {
728         u_int   valid;  /* Which fields to honor */
729 #define CTS_SCSI_VALID_TQ               0x01
730         u_int   flags;
731 #define CTS_SCSI_FLAGS_TAG_ENB          0x01
732 };
733
734 struct ccb_trans_settings_spi
735 {
736         u_int     valid;        /* Which fields to honor */
737 #define CTS_SPI_VALID_SYNC_RATE         0x01
738 #define CTS_SPI_VALID_SYNC_OFFSET       0x02
739 #define CTS_SPI_VALID_BUS_WIDTH         0x04
740 #define CTS_SPI_VALID_DISC              0x08
741 #define CTS_SPI_VALID_PPR_OPTIONS       0x10
742         u_int   flags;
743 #define CTS_SPI_FLAGS_DISC_ENB          0x01
744 #define CTS_SPI_FLAGS_TAG_ENB           0x02
745         u_int   sync_period;
746         u_int   sync_offset;
747         u_int   bus_width;
748         u_int   ppr_options;
749 };
750
751 struct ccb_trans_settings_fc {
752         u_int           valid;          /* Which fields to honor */
753 #define CTS_FC_VALID_WWNN               0x8000
754 #define CTS_FC_VALID_WWPN               0x4000
755 #define CTS_FC_VALID_PORT               0x2000
756 #define CTS_FC_VALID_SPEED              0x1000
757         u_int64_t       wwnn;           /* world wide node name */
758         u_int64_t       wwpn;           /* world wide port name */
759         u_int32_t       port;           /* 24 bit port id, if known */
760         u_int32_t       bitrate;        /* Mbps */
761 };
762
763 /* Get/Set transfer rate/width/disconnection/tag queueing settings */
764 struct ccb_trans_settings {
765         struct    ccb_hdr ccb_h;
766         cts_type  type;         /* Current or User settings */
767         cam_proto protocol;
768         u_int     protocol_version;
769         cam_xport transport;
770         u_int     transport_version;
771         union {
772                 u_int  valid;   /* Which fields to honor */
773                 struct ccb_trans_settings_scsi scsi;
774         } proto_specific;
775         union {
776                 u_int  valid;   /* Which fields to honor */
777                 struct ccb_trans_settings_spi spi;
778                 struct ccb_trans_settings_fc fc;
779         } xport_specific;
780 };
781
782 #endif /* CAM_NEW_TRAN_CODE */
783
784 /*
785  * Calculate the geometry parameters for a device
786  * give the block size and volume size in blocks.
787  */
788 struct ccb_calc_geometry {
789         struct    ccb_hdr ccb_h;
790         u_int32_t block_size;
791         u_int64_t volume_size;
792         u_int32_t cylinders;            
793         u_int8_t  heads;
794         u_int8_t  secs_per_track;
795 };
796
797 /*
798  * Rescan the given bus, or bus/target/lun
799  */
800 struct ccb_rescan {
801         struct  ccb_hdr ccb_h;
802         cam_flags       flags;
803 };
804
805 /*
806  * Turn on debugging for the given bus, bus/target, or bus/target/lun.
807  */
808 struct ccb_debug {
809         struct  ccb_hdr ccb_h;
810         cam_debug_flags flags;
811 };
812
813 /* Target mode structures. */
814
815 struct ccb_en_lun {
816         struct    ccb_hdr ccb_h;
817         u_int16_t grp6_len;             /* Group 6 VU CDB length */
818         u_int16_t grp7_len;             /* Group 7 VU CDB length */
819         u_int8_t  enable;
820 };
821
822 struct ccb_immed_notify {
823         struct    ccb_hdr ccb_h;
824         struct    scsi_sense_data sense_data;
825         u_int8_t  sense_len;            /* Number of bytes in sense buffer */
826         u_int8_t  initiator_id;         /* Id of initiator that selected */
827         u_int8_t  message_args[7];      /* Message Arguments */
828 };
829
830 struct ccb_notify_ack {
831         struct    ccb_hdr ccb_h;
832         u_int16_t seq_id;               /* Sequence identifier */
833         u_int8_t  event;                /* Event flags */
834 };
835
836 /* HBA engine structures. */
837
838 typedef enum {
839         EIT_BUFFER,     /* Engine type: buffer memory */
840         EIT_LOSSLESS,   /* Engine type: lossless compression */
841         EIT_LOSSY,      /* Engine type: lossy compression */
842         EIT_ENCRYPT     /* Engine type: encryption */
843 } ei_type;
844
845 typedef enum {
846         EAD_VUNIQUE,    /* Engine algorithm ID: vendor unique */
847         EAD_LZ1V1,      /* Engine algorithm ID: LZ1 var.1 */
848         EAD_LZ2V1,      /* Engine algorithm ID: LZ2 var.1 */
849         EAD_LZ2V2       /* Engine algorithm ID: LZ2 var.2 */
850 } ei_algo;
851
852 struct ccb_eng_inq {
853         struct    ccb_hdr ccb_h;
854         u_int16_t eng_num;      /* The engine number for this inquiry */
855         ei_type   eng_type;     /* Returned engine type */
856         ei_algo   eng_algo;     /* Returned engine algorithm type */
857         u_int32_t eng_memeory;  /* Returned engine memory size */
858 };
859
860 struct ccb_eng_exec {   /* This structure must match SCSIIO size */
861         struct    ccb_hdr ccb_h;
862         u_int8_t  *pdrv_ptr;    /* Ptr used by the peripheral driver */
863         u_int8_t  *req_map;     /* Ptr for mapping info on the req. */
864         u_int8_t  *data_ptr;    /* Pointer to the data buf/SG list */
865         u_int32_t dxfer_len;    /* Data transfer length */
866         u_int8_t  *engdata_ptr; /* Pointer to the engine buffer data */
867         u_int16_t sglist_cnt;   /* Num of scatter gather list entries */
868         u_int32_t dmax_len;     /* Destination data maximum length */
869         u_int32_t dest_len;     /* Destination data length */
870         int32_t   src_resid;    /* Source residual length: 2's comp */
871         u_int32_t timeout;      /* Timeout value */
872         u_int16_t eng_num;      /* Engine number for this request */
873         u_int16_t vu_flags;     /* Vendor Unique flags */
874 };
875
876 /*
877  * Definitions for the timeout field in the SCSI I/O CCB.
878  */
879 #define CAM_TIME_DEFAULT        0x00000000      /* Use SIM default value */
880 #define CAM_TIME_INFINITY       0xFFFFFFFF      /* Infinite timeout */
881
882 #define CAM_SUCCESS     0       /* For signaling general success */
883 #define CAM_FAILURE     1       /* For signaling general failure */
884
885 #define CAM_FALSE       0
886 #define CAM_TRUE        1
887
888 #define XPT_CCB_INVALID -1      /* for signaling a bad CCB to free */
889
890 /*
891  * Union of all CCB types for kernel space allocation.  This union should
892  * never be used for manipulating CCBs - its only use is for the allocation
893  * and deallocation of raw CCB space and is the return type of xpt_ccb_alloc
894  * and the argument to xpt_ccb_free.
895  */
896 union ccb {
897         struct  ccb_hdr                 ccb_h;  /* For convenience */
898         struct  ccb_scsiio              csio;
899         struct  ccb_getdev              cgd;
900         struct  ccb_getdevlist          cgdl;
901         struct  ccb_pathinq             cpi;
902         struct  ccb_relsim              crs;
903         struct  ccb_setasync            csa;
904         struct  ccb_setdev              csd;
905         struct  ccb_pathstats           cpis;
906         struct  ccb_getdevstats         cgds;
907         struct  ccb_dev_match           cdm;
908         struct  ccb_trans_settings      cts;
909         struct  ccb_calc_geometry       ccg;    
910         struct  ccb_abort               cab;
911         struct  ccb_resetbus            crb;
912         struct  ccb_resetdev            crd;
913         struct  ccb_termio              tio;
914         struct  ccb_accept_tio          atio;
915         struct  ccb_scsiio              ctio;
916         struct  ccb_en_lun              cel;
917         struct  ccb_immed_notify        cin;
918         struct  ccb_notify_ack          cna;
919         struct  ccb_eng_inq             cei;
920         struct  ccb_eng_exec            cee;
921         struct  ccb_rescan              crcn;
922         struct  ccb_debug               cdbg;
923 };
924
925 __BEGIN_DECLS
926 static __inline void
927 cam_fill_csio(struct ccb_scsiio *csio, u_int32_t retries,
928               void (*cbfcnp)(struct cam_periph *, union ccb *),
929               u_int32_t flags, u_int8_t tag_action,
930               u_int8_t *data_ptr, u_int32_t dxfer_len,
931               u_int8_t sense_len, u_int8_t cdb_len,
932               u_int32_t timeout);
933
934 static __inline void
935 cam_fill_ctio(struct ccb_scsiio *csio, u_int32_t retries,
936               void (*cbfcnp)(struct cam_periph *, union ccb *),
937               u_int32_t flags, u_int tag_action, u_int tag_id,
938               u_int init_id, u_int scsi_status, u_int8_t *data_ptr,
939               u_int32_t dxfer_len, u_int32_t timeout);
940         
941 static __inline void
942 cam_fill_csio(struct ccb_scsiio *csio, u_int32_t retries,
943               void (*cbfcnp)(struct cam_periph *, union ccb *),
944               u_int32_t flags, u_int8_t tag_action,
945               u_int8_t *data_ptr, u_int32_t dxfer_len,
946               u_int8_t sense_len, u_int8_t cdb_len,
947               u_int32_t timeout)
948 {
949         csio->ccb_h.func_code = XPT_SCSI_IO;
950         csio->ccb_h.flags = flags;
951         csio->ccb_h.retry_count = retries;      
952         csio->ccb_h.cbfcnp = cbfcnp;
953         csio->ccb_h.timeout = timeout;
954         csio->data_ptr = data_ptr;
955         csio->dxfer_len = dxfer_len;
956         csio->sense_len = sense_len;
957         csio->cdb_len = cdb_len;
958         csio->tag_action = tag_action;
959 }
960
961 static __inline void
962 cam_fill_ctio(struct ccb_scsiio *csio, u_int32_t retries,
963               void (*cbfcnp)(struct cam_periph *, union ccb *),
964               u_int32_t flags, u_int tag_action, u_int tag_id,
965               u_int init_id, u_int scsi_status, u_int8_t *data_ptr,
966               u_int32_t dxfer_len, u_int32_t timeout)
967 {
968         csio->ccb_h.func_code = XPT_CONT_TARGET_IO;
969         csio->ccb_h.flags = flags;
970         csio->ccb_h.retry_count = retries;      
971         csio->ccb_h.cbfcnp = cbfcnp;
972         csio->ccb_h.timeout = timeout;
973         csio->data_ptr = data_ptr;
974         csio->dxfer_len = dxfer_len;
975         csio->scsi_status = scsi_status;
976         csio->tag_action = tag_action;
977         csio->tag_id = tag_id;
978         csio->init_id = init_id;
979 }
980
981 void cam_calc_geometry(struct ccb_calc_geometry *ccg, int extended);
982
983 __END_DECLS
984
985 #endif /* _CAM_CAM_CCB_H */