1/*-
2 * Copyright (c) 2003 Silicon Graphics International Corp.
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions, and the following disclaimer,
10 * without modification.
11 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
12 * substantially similar to the "NO WARRANTY" disclaimer below
13 * ("Disclaimer") and any redistribution must be conditioned upon
14 * including a substantially similar Disclaimer requirement for further
15 * binary redistribution.
16 *
17 * NO WARRANTY
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
27 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 * POSSIBILITY OF SUCH DAMAGES.
29 *
30 * $Id: //depot/users/kenm/FreeBSD-test2/sys/cam/ctl/ctl_io.h#5 $
31 * $FreeBSD: head/sys/cam/ctl/ctl_io.h 274962 2014-11-24 11:37:27Z mav $
32 */
33/*
34 * CAM Target Layer data movement structures/interface.
35 *
36 * Author: Ken Merry <ken@FreeBSD.org>
37 */
38
39#ifndef _CTL_IO_H_
40#define _CTL_IO_H_
41
42#ifdef _CTL_C
43#define EXTERN(__var,__val) __var = __val
44#else
45#define EXTERN(__var,__val) extern __var
46#endif
47
48#define CTL_MAX_CDBLEN 32
49/*
50 * Uncomment this next line to enable printing out times for I/Os
51 * that take longer than CTL_TIME_IO_SECS seconds to get to the datamove
52 * and/or done stage.
53 */
54#define CTL_TIME_IO
55#ifdef CTL_TIME_IO
56#define CTL_TIME_IO_DEFAULT_SECS 90
57EXTERN(int ctl_time_io_secs, CTL_TIME_IO_DEFAULT_SECS);
58#endif
59
60/*
61 * Uncomment these next two lines to enable the CTL I/O delay feature. You
62 * can delay I/O at two different points -- datamove and done. This is
63 * useful for diagnosing abort conditions (for hosts that send an abort on a
64 * timeout), and for determining how long a host's timeout is.
65 */
66#define CTL_IO_DELAY
67#define CTL_TIMER_BYTES sizeof(struct callout)
68
69typedef enum {
70 CTL_STATUS_NONE, /* No status */
71 CTL_SUCCESS, /* Transaction completed successfully */
72 CTL_CMD_TIMEOUT, /* Command timed out, shouldn't happen here */
73 CTL_SEL_TIMEOUT, /* Selection timeout, shouldn't happen here */
74 CTL_ERROR, /* General CTL error XXX expand on this? */
75 CTL_SCSI_ERROR, /* SCSI error, look at status byte/sense data */
76 CTL_CMD_ABORTED, /* Command aborted, don't return status */
77 CTL_STATUS_MASK = 0xfff,/* Mask off any status flags */
78 CTL_AUTOSENSE = 0x1000 /* Autosense performed */
79} ctl_io_status;
80
81/*
82 * WARNING: Keep the data in/out/none flags where they are. They're used
83 * in conjuction with ctl_cmd_flags. See comment above ctl_cmd_flags
84 * definition in ctl_private.h.
85 */
86typedef enum {
87 CTL_FLAG_NONE = 0x00000000, /* no flags */
88 CTL_FLAG_DATA_IN = 0x00000001, /* DATA IN */
89 CTL_FLAG_DATA_OUT = 0x00000002, /* DATA OUT */
90 CTL_FLAG_DATA_NONE = 0x00000003, /* no data */
91 CTL_FLAG_DATA_MASK = 0x00000003,
92 CTL_FLAG_KDPTR_SGLIST = 0x00000008, /* kern_data_ptr is S/G list*/
93 CTL_FLAG_EDPTR_SGLIST = 0x00000010, /* ext_data_ptr is S/G list */
94 CTL_FLAG_DO_AUTOSENSE = 0x00000020, /* grab sense info */
95 CTL_FLAG_USER_REQ = 0x00000040, /* request came from userland */
96 CTL_FLAG_CONTROL_DEV = 0x00000080, /* processor device */
97 CTL_FLAG_ALLOCATED = 0x00000100, /* data space allocated */
98 CTL_FLAG_BLOCKED = 0x00000200, /* on the blocked queue */
99 CTL_FLAG_ABORT_STATUS = 0x00000400, /* return TASK ABORTED status */
100 CTL_FLAG_ABORT = 0x00000800, /* this I/O should be aborted */
101 CTL_FLAG_DMA_INPROG = 0x00001000, /* DMA in progress */
102 CTL_FLAG_NO_DATASYNC = 0x00002000, /* don't cache flush data */
103 CTL_FLAG_DELAY_DONE = 0x00004000, /* delay injection done */
104 CTL_FLAG_INT_COPY = 0x00008000, /* internal copy, no done call*/
105 CTL_FLAG_SENT_2OTHER_SC = 0x00010000,
106 CTL_FLAG_FROM_OTHER_SC = 0x00020000,
107 CTL_FLAG_IS_WAS_ON_RTR = 0x00040000, /* Don't rerun cmd on failover*/
108 CTL_FLAG_BUS_ADDR = 0x00080000, /* ctl_sglist contains BUS
109 addresses, not virtual ones*/
110 CTL_FLAG_IO_CONT = 0x00100000, /* Continue I/O instead of
111 completing */
112 CTL_FLAG_AUTO_MIRROR = 0x00200000, /* Automatically use memory
113 from the RC cache mirrored
114 address area. */
115#if 0
116 CTL_FLAG_ALREADY_DONE = 0x00200000 /* I/O already completed */
117#endif
118 CTL_FLAG_NO_DATAMOVE = 0x00400000,
119 CTL_FLAG_DMA_QUEUED = 0x00800000, /* DMA queued but not started*/
120 CTL_FLAG_STATUS_QUEUED = 0x01000000, /* Status queued but not sent*/
121
122 CTL_FLAG_REDIR_DONE = 0x02000000, /* Redirection has already
123 been done. */
124 CTL_FLAG_FAILOVER = 0x04000000, /* Killed by a failover */
125 CTL_FLAG_IO_ACTIVE = 0x08000000, /* I/O active on this SC */
126 CTL_FLAG_RDMA_MASK = CTL_FLAG_NO_DATASYNC | CTL_FLAG_BUS_ADDR |
127 CTL_FLAG_AUTO_MIRROR | CTL_FLAG_REDIR_DONE
128 /* Flags we care about for
129 remote DMA */
130} ctl_io_flags;
131
132
133struct ctl_lba_len {
134 uint64_t lba;
135 uint32_t len;
136};
137
138struct ctl_lba_len_flags {
139 uint64_t lba;
140 uint32_t len;
141 uint32_t flags;
142#define CTL_LLF_FUA 0x04000000
143#define CTL_LLF_DPO 0x08000000
144#define CTL_LLF_READ 0x10000000
145#define CTL_LLF_WRITE 0x20000000
146#define CTL_LLF_VERIFY 0x40000000
147#define CTL_LLF_COMPARE 0x80000000
148};
149
150struct ctl_ptr_len_flags {
151 uint8_t *ptr;
152 uint32_t len;
153 uint32_t flags;
154};
155
156union ctl_priv {
157 uint8_t bytes[sizeof(uint64_t) * 2];
158 uint64_t integer;
159 void *ptr;
160};
161
162/*
163 * Number of CTL private areas.
164 */
165#define CTL_NUM_PRIV 6
166
167/*
168 * Which private area are we using for a particular piece of data?
169 */
170#define CTL_PRIV_LUN 0 /* CTL LUN pointer goes here */
171#define CTL_PRIV_LBA_LEN 1 /* Decoded LBA/len for read/write*/
172#define CTL_PRIV_MODEPAGE 1 /* Modepage info for config write */
173#define CTL_PRIV_BACKEND 2 /* Reserved for block, RAIDCore */
174#define CTL_PRIV_BACKEND_LUN 3 /* Backend LUN pointer */
175#define CTL_PRIV_FRONTEND 4 /* LSI driver, ioctl front end */
176#define CTL_PRIV_USER 5 /* Userland use */
177
178#define CTL_INVALID_PORTNAME 0xFF
179#define CTL_UNMAPPED_IID 0xFF
180/*
181 * XXX KDM this size is for the port_priv variable in struct ctl_io_hdr
182 * below. This should be defined in terms of the size of struct
183 * ctlfe_lun_cmd_info at the moment:
184 * struct ctlfe_lun_cmd_info {
185 * int cur_transfer_index;
186 * ctlfe_cmd_flags flags;
187 * bus_dma_segment_t cam_sglist[32];
188 * };
189 *
190 * This isn't really the way I'd prefer to do it, but it does make some
191 * sense, AS LONG AS we can guarantee that there will always only be one
192 * outstanding DMA request per ctl_io. If that assumption isn't valid,
193 * then we've got problems.
194 *
195 * At some point it may be nice switch CTL over to using CCBs for
196 * everything. At that point we can probably use the ATIO/CTIO model, so
197 * that multiple simultaneous DMAs per command will just work.
198 *
199 * Also note that the current size, 600, is appropriate for 64-bit
200 * architectures, but is overkill for 32-bit architectures. Need a way to
201 * figure out the size at compile time, or just get rid of this altogether.
202 */
203#define CTL_PORT_PRIV_SIZE 600
204
205struct ctl_sg_entry {
206 void *addr;
207 size_t len;
208};
209
210struct ctl_id {
211 uint32_t id;
212 uint64_t wwid[2];
213};
214
215typedef enum {
216 CTL_IO_NONE,
217 CTL_IO_SCSI,
218 CTL_IO_TASK,
219} ctl_io_type;
220
221struct ctl_nexus {
222 struct ctl_id initid; /* Initiator ID */
223 uint32_t targ_port; /* Target port, filled in by PORT */
224 struct ctl_id targ_target; /* Destination target */
225 uint32_t targ_lun; /* Destination lun */
226 uint32_t targ_mapped_lun; /* Destination lun CTL-wide */
227};
228
229typedef enum {
230 CTL_MSG_SERIALIZE,
231 CTL_MSG_R2R,
232 CTL_MSG_FINISH_IO,
233 CTL_MSG_BAD_JUJU,
234 CTL_MSG_MANAGE_TASKS,
235 CTL_MSG_PERS_ACTION,
236 CTL_MSG_SYNC_FE,
237 CTL_MSG_DATAMOVE,
238 CTL_MSG_DATAMOVE_DONE
239} ctl_msg_type;
240
241struct ctl_scsiio;
242
243#define CTL_NUM_SG_ENTRIES 9
244
245struct ctl_io_hdr {
246 uint32_t version; /* interface version XXX */
247 ctl_io_type io_type; /* task I/O, SCSI I/O, etc. */
248 ctl_msg_type msg_type;
249 struct ctl_nexus nexus; /* Initiator, port, target, lun */
250 uint32_t iid_indx; /* the index into the iid mapping */
251 uint32_t flags; /* transaction flags */
252 uint32_t status; /* transaction status */
253 uint32_t port_status; /* trans status, set by PORT, 0 = good*/
254 uint32_t timeout; /* timeout in ms */
255 uint32_t retries; /* retry count */
256#ifdef CTL_IO_DELAY
257 uint8_t timer_bytes[CTL_TIMER_BYTES]; /* timer kludge */
258#endif /* CTL_IO_DELAY */
259#ifdef CTL_TIME_IO
260 time_t start_time; /* I/O start time */
261 struct bintime start_bt; /* Timer start ticks */
262 struct bintime dma_start_bt; /* DMA start ticks */
263 struct bintime dma_bt; /* DMA total ticks */
264 uint32_t num_dmas; /* Number of DMAs */
265#endif /* CTL_TIME_IO */
266 union ctl_io *original_sc;
267 union ctl_io *serializing_sc;
268 void *pool; /* I/O pool */
269 union ctl_priv ctl_private[CTL_NUM_PRIV];/* CTL private area */
270 uint8_t port_priv[CTL_PORT_PRIV_SIZE];/* PORT private area*/
271 struct ctl_sg_entry remote_sglist[CTL_NUM_SG_ENTRIES];
272 struct ctl_sg_entry remote_dma_sglist[CTL_NUM_SG_ENTRIES];
273 struct ctl_sg_entry local_sglist[CTL_NUM_SG_ENTRIES];
274 struct ctl_sg_entry local_dma_sglist[CTL_NUM_SG_ENTRIES];
275 STAILQ_ENTRY(ctl_io_hdr) links; /* linked list pointer */
276 TAILQ_ENTRY(ctl_io_hdr) ooa_links;
277 TAILQ_ENTRY(ctl_io_hdr) blocked_links;
278};
279
280typedef enum {
281 CTL_TAG_UNTAGGED,
282 CTL_TAG_SIMPLE,
283 CTL_TAG_ORDERED,
284 CTL_TAG_HEAD_OF_QUEUE,
285 CTL_TAG_ACA
286} ctl_tag_type;
287
288union ctl_io;
289
290/*
291 * SCSI passthrough I/O structure for the CAM Target Layer. Note
292 * that some of these fields are here for completeness, but they aren't
293 * used in the CTL implementation. e.g., timeout and retries won't be
294 * used.
295 *
296 * Note: Make sure the io_hdr is *always* the first element in this
297 * structure.
298 */
299struct ctl_scsiio {
300 struct ctl_io_hdr io_hdr; /* common to all I/O types */
301
302 /*
303 * The ext_* fields are generally intended for frontend use; CTL itself
304 * doesn't modify or use them.
305 */
306 uint32_t ext_sg_entries; /* 0 = no S/G list, > 0 = num entries */
307 uint8_t *ext_data_ptr; /* data buffer or S/G list */
308 uint32_t ext_data_len; /* Data transfer length */
309 uint32_t ext_data_filled; /* Amount of data filled so far */
310
311 /*
312 * The number of scatter/gather entries in the list pointed to
313 * by kern_data_ptr. 0 means there is no list, just a data pointer.
314 */
315 uint32_t kern_sg_entries;
316
317 uint32_t rem_sg_entries; /* Unused. */
318
319 /*
320 * The data pointer or a pointer to the scatter/gather list.
321 */
322 uint8_t *kern_data_ptr;
323
324 /*
325 * Length of the data buffer or scatter/gather list. It's also
326 * the length of this particular piece of the data transfer,
327 * ie. number of bytes expected to be transferred by the current
328 * invocation of frontend's datamove() callback. It's always
329 * less than or equal to kern_total_len.
330 */
331 uint32_t kern_data_len;
332
333 /*
334 * Total length of data to be transferred during this particular
335 * SCSI command, as decoded from SCSI CDB.
336 */
337 uint32_t kern_total_len;
338
339 /*
340 * Amount of data left after the current data transfer.
341 */
342 uint32_t kern_data_resid;
343
344 /*
345 * Byte offset of this transfer, equal to the amount of data
346 * already transferred for this SCSI command during previous
347 * datamove() invocations.
348 */
349 uint32_t kern_rel_offset;
350
351 struct scsi_sense_data sense_data; /* sense data */
352 uint8_t sense_len; /* Returned sense length */
353 uint8_t scsi_status; /* SCSI status byte */
354 uint8_t sense_residual; /* Unused. */
355 uint32_t residual; /* data residual length */
356 uint32_t tag_num; /* tag number */
357 ctl_tag_type tag_type; /* simple, ordered, head of queue,etc.*/
358 uint8_t cdb_len; /* CDB length */
359 uint8_t cdb[CTL_MAX_CDBLEN]; /* CDB */
360 int (*be_move_done)(union ctl_io *io); /* called by fe */
361 int (*io_cont)(union ctl_io *io); /* to continue processing */
362};
363
364typedef enum {
365 CTL_TASK_ABORT_TASK,
366 CTL_TASK_ABORT_TASK_SET,
367 CTL_TASK_CLEAR_ACA,
368 CTL_TASK_CLEAR_TASK_SET,
369 CTL_TASK_I_T_NEXUS_RESET,
370 CTL_TASK_LUN_RESET,
371 CTL_TASK_TARGET_RESET,
372 CTL_TASK_BUS_RESET,
373 CTL_TASK_PORT_LOGIN,
374 CTL_TASK_PORT_LOGOUT
375} ctl_task_type;
376
377/*
378 * Task management I/O structure. Aborts, bus resets, etc., are sent using
379 * this structure.
380 *
381 * Note: Make sure the io_hdr is *always* the first element in this
382 * structure.
383 */
384struct ctl_taskio {
385 struct ctl_io_hdr io_hdr; /* common to all I/O types */
386 ctl_task_type task_action; /* Target Reset, Abort, etc. */
387 uint32_t tag_num; /* tag number */
388 ctl_tag_type tag_type; /* simple, ordered, etc. */
389};
390
391typedef enum {
392 CTL_PR_REG_KEY,
393 CTL_PR_UNREG_KEY,
394 CTL_PR_PREEMPT,
395 CTL_PR_CLEAR,
396 CTL_PR_RESERVE,
397 CTL_PR_RELEASE
398} ctl_pr_action;
399
400/*
401 * The PR info is specifically for sending Persistent Reserve actions
402 * to the other SC which it must also act on.
403 *
404 * Note: Make sure the io_hdr is *always* the first element in this
405 * structure.
406 */
407struct ctl_pr_info {
408 ctl_pr_action action;
409 uint8_t sa_res_key[8];
410 uint8_t res_type;
411 uint32_t residx;
412};
413
414struct ctl_ha_msg_hdr {
415 ctl_msg_type msg_type;
416 union ctl_io *original_sc;
417 union ctl_io *serializing_sc;
418 struct ctl_nexus nexus; /* Initiator, port, target, lun */
419 uint32_t status; /* transaction status */
420 TAILQ_ENTRY(ctl_ha_msg_hdr) links;
421};
422
423#define CTL_HA_MAX_SG_ENTRIES 16
424
425/*
426 * Used for CTL_MSG_PERS_ACTION.
427 */
428struct ctl_ha_msg_pr {
429 struct ctl_ha_msg_hdr hdr;
430 struct ctl_pr_info pr_info;
431};
432
433/*
434 * The S/G handling here is a little different than the standard ctl_scsiio
435 * structure, because we can't pass data by reference in between controllers.
436 * The S/G list in the ctl_scsiio struct is normally passed in the
437 * kern_data_ptr field. So kern_sg_entries here will always be non-zero,
438 * even if there is only one entry.
439 *
440 * Used for CTL_MSG_DATAMOVE.
441 */
442struct ctl_ha_msg_dt {
443 struct ctl_ha_msg_hdr hdr;
444 ctl_io_flags flags; /* Only I/O flags are used here */
445 uint32_t sg_sequence; /* S/G portion number */
446 uint8_t sg_last; /* last S/G batch = 1 */
447 uint32_t sent_sg_entries; /* previous S/G count */
448 uint32_t cur_sg_entries; /* current S/G entries */
449 uint32_t kern_sg_entries; /* total S/G entries */
450 uint32_t kern_data_len; /* Length of this S/G list */
451 uint32_t kern_total_len; /* Total length of this
452 transaction */
453 uint32_t kern_data_resid; /* Length left to transfer
454 after this*/
455 uint32_t kern_rel_offset; /* Byte Offset of this
456 transfer */
457 struct ctl_sg_entry sg_list[CTL_HA_MAX_SG_ENTRIES];
458};
459
460/*
461 * Used for CTL_MSG_SERIALIZE, CTL_MSG_FINISH_IO, CTL_MSG_BAD_JUJU.
462 */
463struct ctl_ha_msg_scsi {
464 struct ctl_ha_msg_hdr hdr;
465 uint8_t cdb[CTL_MAX_CDBLEN]; /* CDB */
466 uint32_t tag_num; /* tag number */
467 ctl_tag_type tag_type; /* simple, ordered, etc. */
468 uint8_t scsi_status; /* SCSI status byte */
469 struct scsi_sense_data sense_data; /* sense data */
470 uint8_t sense_len; /* Returned sense length */
471 uint8_t sense_residual; /* sense residual length */
472 uint32_t residual; /* data residual length */
473 uint32_t fetd_status; /* trans status, set by FETD,
474 0 = good*/
475 struct ctl_lba_len lbalen; /* used for stats */
476};
477
478/*
479 * Used for CTL_MSG_MANAGE_TASKS.
480 */
481struct ctl_ha_msg_task {
482 struct ctl_ha_msg_hdr hdr;
483 ctl_task_type task_action; /* Target Reset, Abort, etc. */
484 uint32_t tag_num; /* tag number */
485 ctl_tag_type tag_type; /* simple, ordered, etc. */
486};
487
488union ctl_ha_msg {
489 struct ctl_ha_msg_hdr hdr;
490 struct ctl_ha_msg_task task;
491 struct ctl_ha_msg_scsi scsi;
492 struct ctl_ha_msg_dt dt;
493 struct ctl_ha_msg_pr pr;
494};
495
496
497struct ctl_prio {
498 struct ctl_io_hdr io_hdr;
499 struct ctl_ha_msg_pr pr_msg;
500};
501
502
503
504union ctl_io {
505 struct ctl_io_hdr io_hdr; /* common to all I/O types */
506 struct ctl_scsiio scsiio; /* Normal SCSI commands */
507 struct ctl_taskio taskio; /* SCSI task management/reset */
508 struct ctl_prio presio; /* update per. res info on other SC */
509};
510
511#ifdef _KERNEL
512
513union ctl_io *ctl_alloc_io(void *pool_ref);
514union ctl_io *ctl_alloc_io_nowait(void *pool_ref);
515void ctl_free_io(union ctl_io *io);
516void ctl_zero_io(union ctl_io *io);
517void ctl_copy_io(union ctl_io *src, union ctl_io *dest);
518
519#endif /* _KERNEL */
520
521#endif /* _CTL_IO_H_ */
522
523/*
524 * vim: ts=8
525 */
2 * Copyright (c) 2003 Silicon Graphics International Corp.
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions, and the following disclaimer,
10 * without modification.
11 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
12 * substantially similar to the "NO WARRANTY" disclaimer below
13 * ("Disclaimer") and any redistribution must be conditioned upon
14 * including a substantially similar Disclaimer requirement for further
15 * binary redistribution.
16 *
17 * NO WARRANTY
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
27 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 * POSSIBILITY OF SUCH DAMAGES.
29 *
30 * $Id: //depot/users/kenm/FreeBSD-test2/sys/cam/ctl/ctl_io.h#5 $
31 * $FreeBSD: head/sys/cam/ctl/ctl_io.h 274962 2014-11-24 11:37:27Z mav $
32 */
33/*
34 * CAM Target Layer data movement structures/interface.
35 *
36 * Author: Ken Merry <ken@FreeBSD.org>
37 */
38
39#ifndef _CTL_IO_H_
40#define _CTL_IO_H_
41
42#ifdef _CTL_C
43#define EXTERN(__var,__val) __var = __val
44#else
45#define EXTERN(__var,__val) extern __var
46#endif
47
48#define CTL_MAX_CDBLEN 32
49/*
50 * Uncomment this next line to enable printing out times for I/Os
51 * that take longer than CTL_TIME_IO_SECS seconds to get to the datamove
52 * and/or done stage.
53 */
54#define CTL_TIME_IO
55#ifdef CTL_TIME_IO
56#define CTL_TIME_IO_DEFAULT_SECS 90
57EXTERN(int ctl_time_io_secs, CTL_TIME_IO_DEFAULT_SECS);
58#endif
59
60/*
61 * Uncomment these next two lines to enable the CTL I/O delay feature. You
62 * can delay I/O at two different points -- datamove and done. This is
63 * useful for diagnosing abort conditions (for hosts that send an abort on a
64 * timeout), and for determining how long a host's timeout is.
65 */
66#define CTL_IO_DELAY
67#define CTL_TIMER_BYTES sizeof(struct callout)
68
69typedef enum {
70 CTL_STATUS_NONE, /* No status */
71 CTL_SUCCESS, /* Transaction completed successfully */
72 CTL_CMD_TIMEOUT, /* Command timed out, shouldn't happen here */
73 CTL_SEL_TIMEOUT, /* Selection timeout, shouldn't happen here */
74 CTL_ERROR, /* General CTL error XXX expand on this? */
75 CTL_SCSI_ERROR, /* SCSI error, look at status byte/sense data */
76 CTL_CMD_ABORTED, /* Command aborted, don't return status */
77 CTL_STATUS_MASK = 0xfff,/* Mask off any status flags */
78 CTL_AUTOSENSE = 0x1000 /* Autosense performed */
79} ctl_io_status;
80
81/*
82 * WARNING: Keep the data in/out/none flags where they are. They're used
83 * in conjuction with ctl_cmd_flags. See comment above ctl_cmd_flags
84 * definition in ctl_private.h.
85 */
86typedef enum {
87 CTL_FLAG_NONE = 0x00000000, /* no flags */
88 CTL_FLAG_DATA_IN = 0x00000001, /* DATA IN */
89 CTL_FLAG_DATA_OUT = 0x00000002, /* DATA OUT */
90 CTL_FLAG_DATA_NONE = 0x00000003, /* no data */
91 CTL_FLAG_DATA_MASK = 0x00000003,
92 CTL_FLAG_KDPTR_SGLIST = 0x00000008, /* kern_data_ptr is S/G list*/
93 CTL_FLAG_EDPTR_SGLIST = 0x00000010, /* ext_data_ptr is S/G list */
94 CTL_FLAG_DO_AUTOSENSE = 0x00000020, /* grab sense info */
95 CTL_FLAG_USER_REQ = 0x00000040, /* request came from userland */
96 CTL_FLAG_CONTROL_DEV = 0x00000080, /* processor device */
97 CTL_FLAG_ALLOCATED = 0x00000100, /* data space allocated */
98 CTL_FLAG_BLOCKED = 0x00000200, /* on the blocked queue */
99 CTL_FLAG_ABORT_STATUS = 0x00000400, /* return TASK ABORTED status */
100 CTL_FLAG_ABORT = 0x00000800, /* this I/O should be aborted */
101 CTL_FLAG_DMA_INPROG = 0x00001000, /* DMA in progress */
102 CTL_FLAG_NO_DATASYNC = 0x00002000, /* don't cache flush data */
103 CTL_FLAG_DELAY_DONE = 0x00004000, /* delay injection done */
104 CTL_FLAG_INT_COPY = 0x00008000, /* internal copy, no done call*/
105 CTL_FLAG_SENT_2OTHER_SC = 0x00010000,
106 CTL_FLAG_FROM_OTHER_SC = 0x00020000,
107 CTL_FLAG_IS_WAS_ON_RTR = 0x00040000, /* Don't rerun cmd on failover*/
108 CTL_FLAG_BUS_ADDR = 0x00080000, /* ctl_sglist contains BUS
109 addresses, not virtual ones*/
110 CTL_FLAG_IO_CONT = 0x00100000, /* Continue I/O instead of
111 completing */
112 CTL_FLAG_AUTO_MIRROR = 0x00200000, /* Automatically use memory
113 from the RC cache mirrored
114 address area. */
115#if 0
116 CTL_FLAG_ALREADY_DONE = 0x00200000 /* I/O already completed */
117#endif
118 CTL_FLAG_NO_DATAMOVE = 0x00400000,
119 CTL_FLAG_DMA_QUEUED = 0x00800000, /* DMA queued but not started*/
120 CTL_FLAG_STATUS_QUEUED = 0x01000000, /* Status queued but not sent*/
121
122 CTL_FLAG_REDIR_DONE = 0x02000000, /* Redirection has already
123 been done. */
124 CTL_FLAG_FAILOVER = 0x04000000, /* Killed by a failover */
125 CTL_FLAG_IO_ACTIVE = 0x08000000, /* I/O active on this SC */
126 CTL_FLAG_RDMA_MASK = CTL_FLAG_NO_DATASYNC | CTL_FLAG_BUS_ADDR |
127 CTL_FLAG_AUTO_MIRROR | CTL_FLAG_REDIR_DONE
128 /* Flags we care about for
129 remote DMA */
130} ctl_io_flags;
131
132
133struct ctl_lba_len {
134 uint64_t lba;
135 uint32_t len;
136};
137
138struct ctl_lba_len_flags {
139 uint64_t lba;
140 uint32_t len;
141 uint32_t flags;
142#define CTL_LLF_FUA 0x04000000
143#define CTL_LLF_DPO 0x08000000
144#define CTL_LLF_READ 0x10000000
145#define CTL_LLF_WRITE 0x20000000
146#define CTL_LLF_VERIFY 0x40000000
147#define CTL_LLF_COMPARE 0x80000000
148};
149
150struct ctl_ptr_len_flags {
151 uint8_t *ptr;
152 uint32_t len;
153 uint32_t flags;
154};
155
156union ctl_priv {
157 uint8_t bytes[sizeof(uint64_t) * 2];
158 uint64_t integer;
159 void *ptr;
160};
161
162/*
163 * Number of CTL private areas.
164 */
165#define CTL_NUM_PRIV 6
166
167/*
168 * Which private area are we using for a particular piece of data?
169 */
170#define CTL_PRIV_LUN 0 /* CTL LUN pointer goes here */
171#define CTL_PRIV_LBA_LEN 1 /* Decoded LBA/len for read/write*/
172#define CTL_PRIV_MODEPAGE 1 /* Modepage info for config write */
173#define CTL_PRIV_BACKEND 2 /* Reserved for block, RAIDCore */
174#define CTL_PRIV_BACKEND_LUN 3 /* Backend LUN pointer */
175#define CTL_PRIV_FRONTEND 4 /* LSI driver, ioctl front end */
176#define CTL_PRIV_USER 5 /* Userland use */
177
178#define CTL_INVALID_PORTNAME 0xFF
179#define CTL_UNMAPPED_IID 0xFF
180/*
181 * XXX KDM this size is for the port_priv variable in struct ctl_io_hdr
182 * below. This should be defined in terms of the size of struct
183 * ctlfe_lun_cmd_info at the moment:
184 * struct ctlfe_lun_cmd_info {
185 * int cur_transfer_index;
186 * ctlfe_cmd_flags flags;
187 * bus_dma_segment_t cam_sglist[32];
188 * };
189 *
190 * This isn't really the way I'd prefer to do it, but it does make some
191 * sense, AS LONG AS we can guarantee that there will always only be one
192 * outstanding DMA request per ctl_io. If that assumption isn't valid,
193 * then we've got problems.
194 *
195 * At some point it may be nice switch CTL over to using CCBs for
196 * everything. At that point we can probably use the ATIO/CTIO model, so
197 * that multiple simultaneous DMAs per command will just work.
198 *
199 * Also note that the current size, 600, is appropriate for 64-bit
200 * architectures, but is overkill for 32-bit architectures. Need a way to
201 * figure out the size at compile time, or just get rid of this altogether.
202 */
203#define CTL_PORT_PRIV_SIZE 600
204
205struct ctl_sg_entry {
206 void *addr;
207 size_t len;
208};
209
210struct ctl_id {
211 uint32_t id;
212 uint64_t wwid[2];
213};
214
215typedef enum {
216 CTL_IO_NONE,
217 CTL_IO_SCSI,
218 CTL_IO_TASK,
219} ctl_io_type;
220
221struct ctl_nexus {
222 struct ctl_id initid; /* Initiator ID */
223 uint32_t targ_port; /* Target port, filled in by PORT */
224 struct ctl_id targ_target; /* Destination target */
225 uint32_t targ_lun; /* Destination lun */
226 uint32_t targ_mapped_lun; /* Destination lun CTL-wide */
227};
228
229typedef enum {
230 CTL_MSG_SERIALIZE,
231 CTL_MSG_R2R,
232 CTL_MSG_FINISH_IO,
233 CTL_MSG_BAD_JUJU,
234 CTL_MSG_MANAGE_TASKS,
235 CTL_MSG_PERS_ACTION,
236 CTL_MSG_SYNC_FE,
237 CTL_MSG_DATAMOVE,
238 CTL_MSG_DATAMOVE_DONE
239} ctl_msg_type;
240
241struct ctl_scsiio;
242
243#define CTL_NUM_SG_ENTRIES 9
244
245struct ctl_io_hdr {
246 uint32_t version; /* interface version XXX */
247 ctl_io_type io_type; /* task I/O, SCSI I/O, etc. */
248 ctl_msg_type msg_type;
249 struct ctl_nexus nexus; /* Initiator, port, target, lun */
250 uint32_t iid_indx; /* the index into the iid mapping */
251 uint32_t flags; /* transaction flags */
252 uint32_t status; /* transaction status */
253 uint32_t port_status; /* trans status, set by PORT, 0 = good*/
254 uint32_t timeout; /* timeout in ms */
255 uint32_t retries; /* retry count */
256#ifdef CTL_IO_DELAY
257 uint8_t timer_bytes[CTL_TIMER_BYTES]; /* timer kludge */
258#endif /* CTL_IO_DELAY */
259#ifdef CTL_TIME_IO
260 time_t start_time; /* I/O start time */
261 struct bintime start_bt; /* Timer start ticks */
262 struct bintime dma_start_bt; /* DMA start ticks */
263 struct bintime dma_bt; /* DMA total ticks */
264 uint32_t num_dmas; /* Number of DMAs */
265#endif /* CTL_TIME_IO */
266 union ctl_io *original_sc;
267 union ctl_io *serializing_sc;
268 void *pool; /* I/O pool */
269 union ctl_priv ctl_private[CTL_NUM_PRIV];/* CTL private area */
270 uint8_t port_priv[CTL_PORT_PRIV_SIZE];/* PORT private area*/
271 struct ctl_sg_entry remote_sglist[CTL_NUM_SG_ENTRIES];
272 struct ctl_sg_entry remote_dma_sglist[CTL_NUM_SG_ENTRIES];
273 struct ctl_sg_entry local_sglist[CTL_NUM_SG_ENTRIES];
274 struct ctl_sg_entry local_dma_sglist[CTL_NUM_SG_ENTRIES];
275 STAILQ_ENTRY(ctl_io_hdr) links; /* linked list pointer */
276 TAILQ_ENTRY(ctl_io_hdr) ooa_links;
277 TAILQ_ENTRY(ctl_io_hdr) blocked_links;
278};
279
280typedef enum {
281 CTL_TAG_UNTAGGED,
282 CTL_TAG_SIMPLE,
283 CTL_TAG_ORDERED,
284 CTL_TAG_HEAD_OF_QUEUE,
285 CTL_TAG_ACA
286} ctl_tag_type;
287
288union ctl_io;
289
290/*
291 * SCSI passthrough I/O structure for the CAM Target Layer. Note
292 * that some of these fields are here for completeness, but they aren't
293 * used in the CTL implementation. e.g., timeout and retries won't be
294 * used.
295 *
296 * Note: Make sure the io_hdr is *always* the first element in this
297 * structure.
298 */
299struct ctl_scsiio {
300 struct ctl_io_hdr io_hdr; /* common to all I/O types */
301
302 /*
303 * The ext_* fields are generally intended for frontend use; CTL itself
304 * doesn't modify or use them.
305 */
306 uint32_t ext_sg_entries; /* 0 = no S/G list, > 0 = num entries */
307 uint8_t *ext_data_ptr; /* data buffer or S/G list */
308 uint32_t ext_data_len; /* Data transfer length */
309 uint32_t ext_data_filled; /* Amount of data filled so far */
310
311 /*
312 * The number of scatter/gather entries in the list pointed to
313 * by kern_data_ptr. 0 means there is no list, just a data pointer.
314 */
315 uint32_t kern_sg_entries;
316
317 uint32_t rem_sg_entries; /* Unused. */
318
319 /*
320 * The data pointer or a pointer to the scatter/gather list.
321 */
322 uint8_t *kern_data_ptr;
323
324 /*
325 * Length of the data buffer or scatter/gather list. It's also
326 * the length of this particular piece of the data transfer,
327 * ie. number of bytes expected to be transferred by the current
328 * invocation of frontend's datamove() callback. It's always
329 * less than or equal to kern_total_len.
330 */
331 uint32_t kern_data_len;
332
333 /*
334 * Total length of data to be transferred during this particular
335 * SCSI command, as decoded from SCSI CDB.
336 */
337 uint32_t kern_total_len;
338
339 /*
340 * Amount of data left after the current data transfer.
341 */
342 uint32_t kern_data_resid;
343
344 /*
345 * Byte offset of this transfer, equal to the amount of data
346 * already transferred for this SCSI command during previous
347 * datamove() invocations.
348 */
349 uint32_t kern_rel_offset;
350
351 struct scsi_sense_data sense_data; /* sense data */
352 uint8_t sense_len; /* Returned sense length */
353 uint8_t scsi_status; /* SCSI status byte */
354 uint8_t sense_residual; /* Unused. */
355 uint32_t residual; /* data residual length */
356 uint32_t tag_num; /* tag number */
357 ctl_tag_type tag_type; /* simple, ordered, head of queue,etc.*/
358 uint8_t cdb_len; /* CDB length */
359 uint8_t cdb[CTL_MAX_CDBLEN]; /* CDB */
360 int (*be_move_done)(union ctl_io *io); /* called by fe */
361 int (*io_cont)(union ctl_io *io); /* to continue processing */
362};
363
364typedef enum {
365 CTL_TASK_ABORT_TASK,
366 CTL_TASK_ABORT_TASK_SET,
367 CTL_TASK_CLEAR_ACA,
368 CTL_TASK_CLEAR_TASK_SET,
369 CTL_TASK_I_T_NEXUS_RESET,
370 CTL_TASK_LUN_RESET,
371 CTL_TASK_TARGET_RESET,
372 CTL_TASK_BUS_RESET,
373 CTL_TASK_PORT_LOGIN,
374 CTL_TASK_PORT_LOGOUT
375} ctl_task_type;
376
377/*
378 * Task management I/O structure. Aborts, bus resets, etc., are sent using
379 * this structure.
380 *
381 * Note: Make sure the io_hdr is *always* the first element in this
382 * structure.
383 */
384struct ctl_taskio {
385 struct ctl_io_hdr io_hdr; /* common to all I/O types */
386 ctl_task_type task_action; /* Target Reset, Abort, etc. */
387 uint32_t tag_num; /* tag number */
388 ctl_tag_type tag_type; /* simple, ordered, etc. */
389};
390
391typedef enum {
392 CTL_PR_REG_KEY,
393 CTL_PR_UNREG_KEY,
394 CTL_PR_PREEMPT,
395 CTL_PR_CLEAR,
396 CTL_PR_RESERVE,
397 CTL_PR_RELEASE
398} ctl_pr_action;
399
400/*
401 * The PR info is specifically for sending Persistent Reserve actions
402 * to the other SC which it must also act on.
403 *
404 * Note: Make sure the io_hdr is *always* the first element in this
405 * structure.
406 */
407struct ctl_pr_info {
408 ctl_pr_action action;
409 uint8_t sa_res_key[8];
410 uint8_t res_type;
411 uint32_t residx;
412};
413
414struct ctl_ha_msg_hdr {
415 ctl_msg_type msg_type;
416 union ctl_io *original_sc;
417 union ctl_io *serializing_sc;
418 struct ctl_nexus nexus; /* Initiator, port, target, lun */
419 uint32_t status; /* transaction status */
420 TAILQ_ENTRY(ctl_ha_msg_hdr) links;
421};
422
423#define CTL_HA_MAX_SG_ENTRIES 16
424
425/*
426 * Used for CTL_MSG_PERS_ACTION.
427 */
428struct ctl_ha_msg_pr {
429 struct ctl_ha_msg_hdr hdr;
430 struct ctl_pr_info pr_info;
431};
432
433/*
434 * The S/G handling here is a little different than the standard ctl_scsiio
435 * structure, because we can't pass data by reference in between controllers.
436 * The S/G list in the ctl_scsiio struct is normally passed in the
437 * kern_data_ptr field. So kern_sg_entries here will always be non-zero,
438 * even if there is only one entry.
439 *
440 * Used for CTL_MSG_DATAMOVE.
441 */
442struct ctl_ha_msg_dt {
443 struct ctl_ha_msg_hdr hdr;
444 ctl_io_flags flags; /* Only I/O flags are used here */
445 uint32_t sg_sequence; /* S/G portion number */
446 uint8_t sg_last; /* last S/G batch = 1 */
447 uint32_t sent_sg_entries; /* previous S/G count */
448 uint32_t cur_sg_entries; /* current S/G entries */
449 uint32_t kern_sg_entries; /* total S/G entries */
450 uint32_t kern_data_len; /* Length of this S/G list */
451 uint32_t kern_total_len; /* Total length of this
452 transaction */
453 uint32_t kern_data_resid; /* Length left to transfer
454 after this*/
455 uint32_t kern_rel_offset; /* Byte Offset of this
456 transfer */
457 struct ctl_sg_entry sg_list[CTL_HA_MAX_SG_ENTRIES];
458};
459
460/*
461 * Used for CTL_MSG_SERIALIZE, CTL_MSG_FINISH_IO, CTL_MSG_BAD_JUJU.
462 */
463struct ctl_ha_msg_scsi {
464 struct ctl_ha_msg_hdr hdr;
465 uint8_t cdb[CTL_MAX_CDBLEN]; /* CDB */
466 uint32_t tag_num; /* tag number */
467 ctl_tag_type tag_type; /* simple, ordered, etc. */
468 uint8_t scsi_status; /* SCSI status byte */
469 struct scsi_sense_data sense_data; /* sense data */
470 uint8_t sense_len; /* Returned sense length */
471 uint8_t sense_residual; /* sense residual length */
472 uint32_t residual; /* data residual length */
473 uint32_t fetd_status; /* trans status, set by FETD,
474 0 = good*/
475 struct ctl_lba_len lbalen; /* used for stats */
476};
477
478/*
479 * Used for CTL_MSG_MANAGE_TASKS.
480 */
481struct ctl_ha_msg_task {
482 struct ctl_ha_msg_hdr hdr;
483 ctl_task_type task_action; /* Target Reset, Abort, etc. */
484 uint32_t tag_num; /* tag number */
485 ctl_tag_type tag_type; /* simple, ordered, etc. */
486};
487
488union ctl_ha_msg {
489 struct ctl_ha_msg_hdr hdr;
490 struct ctl_ha_msg_task task;
491 struct ctl_ha_msg_scsi scsi;
492 struct ctl_ha_msg_dt dt;
493 struct ctl_ha_msg_pr pr;
494};
495
496
497struct ctl_prio {
498 struct ctl_io_hdr io_hdr;
499 struct ctl_ha_msg_pr pr_msg;
500};
501
502
503
504union ctl_io {
505 struct ctl_io_hdr io_hdr; /* common to all I/O types */
506 struct ctl_scsiio scsiio; /* Normal SCSI commands */
507 struct ctl_taskio taskio; /* SCSI task management/reset */
508 struct ctl_prio presio; /* update per. res info on other SC */
509};
510
511#ifdef _KERNEL
512
513union ctl_io *ctl_alloc_io(void *pool_ref);
514union ctl_io *ctl_alloc_io_nowait(void *pool_ref);
515void ctl_free_io(union ctl_io *io);
516void ctl_zero_io(union ctl_io *io);
517void ctl_copy_io(union ctl_io *src, union ctl_io *dest);
518
519#endif /* _KERNEL */
520
521#endif /* _CTL_IO_H_ */
522
523/*
524 * vim: ts=8
525 */