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