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