diff options
Diffstat (limited to 'sys/cam/ctl/ctl_io.h')
| -rw-r--r-- | sys/cam/ctl/ctl_io.h | 474 |
1 files changed, 474 insertions, 0 deletions
diff --git a/sys/cam/ctl/ctl_io.h b/sys/cam/ctl/ctl_io.h new file mode 100644 index 000000000000..aa00a0634907 --- /dev/null +++ b/sys/cam/ctl/ctl_io.h @@ -0,0 +1,474 @@ +/*- + * Copyright (c) 2003 Silicon Graphics International Corp. + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions, and the following disclaimer, + * without modification. + * 2. Redistributions in binary form must reproduce at minimum a disclaimer + * substantially similar to the "NO WARRANTY" disclaimer below + * ("Disclaimer") and any redistribution must be conditioned upon + * including a substantially similar Disclaimer requirement for further + * binary redistribution. + * + * NO WARRANTY + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING + * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGES. + * + * $Id: //depot/users/kenm/FreeBSD-test2/sys/cam/ctl/ctl_io.h#5 $ + * $FreeBSD$ + */ +/* + * CAM Target Layer data movement structures/interface. + * + * Author: Ken Merry <ken@FreeBSD.org> + */ + +#ifndef _CTL_IO_H_ +#define _CTL_IO_H_ + +#ifdef _CTL_C +#define EXTERN(__var,__val) __var = __val +#else +#define EXTERN(__var,__val) extern __var +#endif + +#define CTL_MAX_CDBLEN 32 +/* + * Uncomment this next line to enable printing out times for I/Os + * that take longer than CTL_TIME_IO_SECS seconds to get to the datamove + * and/or done stage. + */ +#define CTL_TIME_IO +#ifdef CTL_TIME_IO +#define CTL_TIME_IO_DEFAULT_SECS 90 +EXTERN(int ctl_time_io_secs, CTL_TIME_IO_DEFAULT_SECS); +#endif + +/* + * Uncomment these next two lines to enable the CTL I/O delay feature. You + * can delay I/O at two different points -- datamove and done. This is + * useful for diagnosing abort conditions (for hosts that send an abort on a + * timeout), and for determining how long a host's timeout is. + */ +#define CTL_IO_DELAY +#define CTL_TIMER_BYTES sizeof(struct callout) + +typedef enum { + CTL_STATUS_NONE, /* No status */ + CTL_SUCCESS, /* Transaction completed successfully */ + CTL_CMD_TIMEOUT, /* Command timed out, shouldn't happen here */ + CTL_SEL_TIMEOUT, /* Selection timeout, shouldn't happen here */ + CTL_ERROR, /* General CTL error XXX expand on this? */ + CTL_SCSI_ERROR, /* SCSI error, look at status byte/sense data */ + CTL_CMD_ABORTED, /* Command aborted, don't return status */ + CTL_STATUS_MASK = 0xfff,/* Mask off any status flags */ + CTL_AUTOSENSE = 0x1000 /* Autosense performed */ +} ctl_io_status; + +/* + * WARNING: Keep the data in/out/none flags where they are. They're used + * in conjuction with ctl_cmd_flags. See comment above ctl_cmd_flags + * definition in ctl_private.h. + */ +typedef enum { + CTL_FLAG_NONE = 0x00000000, /* no flags */ + CTL_FLAG_DATA_IN = 0x00000001, /* DATA IN */ + CTL_FLAG_DATA_OUT = 0x00000002, /* DATA OUT */ + CTL_FLAG_DATA_NONE = 0x00000003, /* no data */ + CTL_FLAG_DATA_MASK = 0x00000003, + CTL_FLAG_KDPTR_SGLIST = 0x00000008, /* kern_data_ptr is S/G list*/ + CTL_FLAG_EDPTR_SGLIST = 0x00000010, /* ext_data_ptr is S/G list */ + CTL_FLAG_DO_AUTOSENSE = 0x00000020, /* grab sense info */ + CTL_FLAG_USER_REQ = 0x00000040, /* request came from userland */ + CTL_FLAG_CONTROL_DEV = 0x00000080, /* processor device */ + CTL_FLAG_ALLOCATED = 0x00000100, /* data space allocated */ + CTL_FLAG_BLOCKED = 0x00000200, /* on the blocked queue */ + CTL_FLAG_ABORT = 0x00000800, /* this I/O should be aborted */ + CTL_FLAG_DMA_INPROG = 0x00001000, /* DMA in progress */ + CTL_FLAG_NO_DATASYNC = 0x00002000, /* don't cache flush data */ + CTL_FLAG_DELAY_DONE = 0x00004000, /* delay injection done */ + CTL_FLAG_INT_COPY = 0x00008000, /* internal copy, no done call*/ + CTL_FLAG_SENT_2OTHER_SC = 0x00010000, + CTL_FLAG_FROM_OTHER_SC = 0x00020000, + CTL_FLAG_IS_WAS_ON_RTR = 0x00040000, /* Don't rerun cmd on failover*/ + CTL_FLAG_BUS_ADDR = 0x00080000, /* ctl_sglist contains BUS + addresses, not virtual ones*/ + CTL_FLAG_IO_CONT = 0x00100000, /* Continue I/O instead of + completing */ + CTL_FLAG_AUTO_MIRROR = 0x00200000, /* Automatically use memory + from the RC cache mirrored + address area. */ +#if 0 + CTL_FLAG_ALREADY_DONE = 0x00200000 /* I/O already completed */ +#endif + CTL_FLAG_NO_DATAMOVE = 0x00400000, + CTL_FLAG_DMA_QUEUED = 0x00800000, /* DMA queued but not started*/ + CTL_FLAG_STATUS_QUEUED = 0x01000000, /* Status queued but not sent*/ + + CTL_FLAG_REDIR_DONE = 0x02000000, /* Redirection has already + been done. */ + CTL_FLAG_FAILOVER = 0x04000000, /* Killed by a failover */ + CTL_FLAG_IO_ACTIVE = 0x08000000, /* I/O active on this SC */ + CTL_FLAG_RDMA_MASK = CTL_FLAG_NO_DATASYNC | CTL_FLAG_BUS_ADDR | + CTL_FLAG_AUTO_MIRROR | CTL_FLAG_REDIR_DONE + /* Flags we care about for + remote DMA */ +} ctl_io_flags; + + +struct ctl_lba_len { + uint64_t lba; + uint32_t len; +}; + +union ctl_priv { + uint8_t bytes[sizeof(uint64_t) * 2]; + uint64_t integer; + void *ptr; +}; + +/* + * Number of CTL private areas. + */ +#define CTL_NUM_PRIV 6 + +/* + * Which private area are we using for a particular piece of data? + */ +#define CTL_PRIV_LUN 0 /* CTL LUN pointer goes here */ +#define CTL_PRIV_LBA_LEN 1 /* Decoded LBA/len for read/write*/ +#define CTL_PRIV_MODEPAGE 1 /* Modepage info for config write */ +#define CTL_PRIV_BACKEND 2 /* Reserved for block, RAIDCore */ +#define CTL_PRIV_BACKEND_LUN 3 /* Backend LUN pointer */ +#define CTL_PRIV_FRONTEND 4 /* LSI driver, ioctl front end */ +#define CTL_PRIV_USER 5 /* Userland use */ + +#define CTL_INVALID_PORTNAME 0xFF +#define CTL_UNMAPPED_IID 0xFF +/* + * XXX KDM this size is for the port_priv variable in struct ctl_io_hdr + * below. This should be defined in terms of the size of struct + * ctlfe_lun_cmd_info at the moment: + * struct ctlfe_lun_cmd_info { + * int cur_transfer_index; + * ctlfe_cmd_flags flags; + * bus_dma_segment_t cam_sglist[32]; + * }; + * + * This isn't really the way I'd prefer to do it, but it does make some + * sense, AS LONG AS we can guarantee that there will always only be one + * outstanding DMA request per ctl_io. If that assumption isn't valid, + * then we've got problems. + * + * At some point it may be nice switch CTL over to using CCBs for + * everything. At that point we can probably use the ATIO/CTIO model, so + * that multiple simultaneous DMAs per command will just work. + * + * Also note that the current size, 600, is appropriate for 64-bit + * architectures, but is overkill for 32-bit architectures. Need a way to + * figure out the size at compile time, or just get rid of this altogether. + */ +#define CTL_PORT_PRIV_SIZE 600 + +struct ctl_sg_entry { + void *addr; + size_t len; +}; + +struct ctl_id { + uint32_t id; + uint64_t wwid[2]; +}; + +typedef enum { + CTL_IO_NONE, + CTL_IO_SCSI, + CTL_IO_TASK, +} ctl_io_type; + +struct ctl_nexus { + struct ctl_id initid; /* Initiator ID */ + uint32_t targ_port; /* Target port, filled in by PORT */ + struct ctl_id targ_target; /* Destination target */ + uint32_t targ_lun; /* Destination lun */ +}; + +typedef enum { + CTL_MSG_SERIALIZE, + CTL_MSG_R2R, + CTL_MSG_FINISH_IO, + CTL_MSG_BAD_JUJU, + CTL_MSG_MANAGE_TASKS, + CTL_MSG_PERS_ACTION, + CTL_MSG_SYNC_FE, + CTL_MSG_APS_LOCK, + CTL_MSG_DATAMOVE, + CTL_MSG_DATAMOVE_DONE +} ctl_msg_type; + +struct ctl_scsiio; + +#define CTL_NUM_SG_ENTRIES 9 + +struct ctl_io_hdr { + uint32_t version; /* interface version XXX */ + ctl_io_type io_type; /* task I/O, SCSI I/O, etc. */ + ctl_msg_type msg_type; + struct ctl_nexus nexus; /* Initiator, port, target, lun */ + uint32_t iid_indx; /* the index into the iid mapping */ + uint32_t flags; /* transaction flags */ + uint32_t status; /* transaction status */ + uint32_t port_status; /* trans status, set by PORT, 0 = good*/ + uint32_t timeout; /* timeout in ms */ + uint32_t retries; /* retry count */ +#ifdef CTL_IO_DELAY + uint8_t timer_bytes[CTL_TIMER_BYTES]; /* timer kludge */ +#endif /* CTL_IO_DELAY */ +#ifdef CTL_TIME_IO + time_t start_time; /* I/O start time */ + struct bintime start_bt; /* Timer start ticks */ + struct bintime dma_start_bt; /* DMA start ticks */ + struct bintime dma_bt; /* DMA total ticks */ + uint32_t num_dmas; /* Number of DMAs */ +#endif /* CTL_TIME_IO */ + union ctl_io *original_sc; + union ctl_io *serializing_sc; + void *pool; /* I/O pool */ + union ctl_priv ctl_private[CTL_NUM_PRIV];/* CTL private area */ + uint8_t port_priv[CTL_PORT_PRIV_SIZE];/* PORT private area*/ + struct ctl_sg_entry remote_sglist[CTL_NUM_SG_ENTRIES]; + struct ctl_sg_entry remote_dma_sglist[CTL_NUM_SG_ENTRIES]; + struct ctl_sg_entry local_sglist[CTL_NUM_SG_ENTRIES]; + struct ctl_sg_entry local_dma_sglist[CTL_NUM_SG_ENTRIES]; + STAILQ_ENTRY(ctl_io_hdr) links; /* linked list pointer */ + TAILQ_ENTRY(ctl_io_hdr) ooa_links; + TAILQ_ENTRY(ctl_io_hdr) blocked_links; +}; + +typedef enum { + CTL_TAG_UNTAGGED, + CTL_TAG_SIMPLE, + CTL_TAG_ORDERED, + CTL_TAG_HEAD_OF_QUEUE, + CTL_TAG_ACA +} ctl_tag_type; + +union ctl_io; + +/* + * SCSI passthrough I/O structure for the CAM Target Layer. Note + * that some of these fields are here for completeness, but they aren't + * used in the CTL implementation. e.g., timeout and retries won't be + * used. + * + * Note: Make sure the io_hdr is *always* the first element in this + * structure. + */ +struct ctl_scsiio { + struct ctl_io_hdr io_hdr; /* common to all I/O types */ + uint32_t ext_sg_entries; /* 0 = no S/G list, > 0 = num entries */ + uint8_t *ext_data_ptr; /* data buffer or S/G list */ + uint32_t ext_data_len; /* Data transfer length */ + uint32_t ext_data_filled; /* Amount of data filled so far */ + uint32_t kern_sg_entries; /* 0 = no S/G list, > 0 = num entries */ + uint32_t rem_sg_entries; /* 0 = no S/G list, > 0 = num entries */ + uint8_t *kern_data_ptr; /* data buffer or S/G list */ + uint32_t kern_data_len; /* Length of this S/G list/buffer */ + uint32_t kern_total_len; /* Total length of this transaction */ + uint32_t kern_data_resid; /* Length left to transfer after this*/ + uint32_t kern_rel_offset; /* Byte Offset of this transfer */ + struct scsi_sense_data sense_data; /* sense data */ + uint8_t sense_len; /* Returned sense length */ + uint8_t scsi_status; /* SCSI status byte */ + uint8_t sense_residual; /* sense residual length */ + uint32_t residual; /* data residual length */ + uint32_t tag_num; /* tag number */ + ctl_tag_type tag_type; /* simple, ordered, head of queue,etc.*/ + uint8_t cdb_len; /* CDB length */ + uint8_t cdb[CTL_MAX_CDBLEN]; /* CDB */ + int (*be_move_done)(union ctl_io *io); /* called by fe */ + int (*io_cont)(union ctl_io *io); /* to continue processing */ +}; + +typedef enum { + CTL_TASK_ABORT_TASK, + CTL_TASK_ABORT_TASK_SET, + CTL_TASK_CLEAR_ACA, + CTL_TASK_CLEAR_TASK_SET, + CTL_TASK_LUN_RESET, + CTL_TASK_TARGET_RESET, + CTL_TASK_BUS_RESET, + CTL_TASK_PORT_LOGIN, + CTL_TASK_PORT_LOGOUT +} ctl_task_type; + +/* + * Task management I/O structure. Aborts, bus resets, etc., are sent using + * this structure. + * + * Note: Make sure the io_hdr is *always* the first element in this + * structure. + */ +struct ctl_taskio { + struct ctl_io_hdr io_hdr; /* common to all I/O types */ + ctl_task_type task_action; /* Target Reset, Abort, etc. */ + uint32_t tag_num; /* tag number */ + ctl_tag_type tag_type; /* simple, ordered, etc. */ +}; + +typedef enum { + CTL_PR_REG_KEY, + CTL_PR_UNREG_KEY, + CTL_PR_PREEMPT, + CTL_PR_CLEAR, + CTL_PR_RESERVE, + CTL_PR_RELEASE +} ctl_pr_action; + +/* + * The PR info is specifically for sending Persistent Reserve actions + * to the other SC which it must also act on. + * + * Note: Make sure the io_hdr is *always* the first element in this + * structure. + */ +struct ctl_pr_info { + ctl_pr_action action; + uint8_t sa_res_key[8]; + uint8_t res_type; + uint16_t residx; +}; + +struct ctl_ha_msg_hdr { + ctl_msg_type msg_type; + union ctl_io *original_sc; + union ctl_io *serializing_sc; + struct ctl_nexus nexus; /* Initiator, port, target, lun */ + uint32_t status; /* transaction status */ + TAILQ_ENTRY(ctl_ha_msg_hdr) links; +}; + +#define CTL_HA_MAX_SG_ENTRIES 16 + +/* + * Used for CTL_MSG_APS_LOCK. + */ +struct ctl_ha_msg_aps { + struct ctl_ha_msg_hdr hdr; + uint8_t lock_flag; +}; + +/* + * Used for CTL_MSG_PERS_ACTION. + */ +struct ctl_ha_msg_pr { + struct ctl_ha_msg_hdr hdr; + struct ctl_pr_info pr_info; +}; + +/* + * The S/G handling here is a little different than the standard ctl_scsiio + * structure, because we can't pass data by reference in between controllers. + * The S/G list in the ctl_scsiio struct is normally passed in the + * kern_data_ptr field. So kern_sg_entries here will always be non-zero, + * even if there is only one entry. + * + * Used for CTL_MSG_DATAMOVE. + */ +struct ctl_ha_msg_dt { + struct ctl_ha_msg_hdr hdr; + ctl_io_flags flags; /* Only I/O flags are used here */ + uint32_t sg_sequence; /* S/G portion number */ + uint8_t sg_last; /* last S/G batch = 1 */ + uint32_t sent_sg_entries; /* previous S/G count */ + uint32_t cur_sg_entries; /* current S/G entries */ + uint32_t kern_sg_entries; /* total S/G entries */ + uint32_t kern_data_len; /* Length of this S/G list */ + uint32_t kern_total_len; /* Total length of this + transaction */ + uint32_t kern_data_resid; /* Length left to transfer + after this*/ + uint32_t kern_rel_offset; /* Byte Offset of this + transfer */ + struct ctl_sg_entry sg_list[CTL_HA_MAX_SG_ENTRIES]; +}; + +/* + * Used for CTL_MSG_SERIALIZE, CTL_MSG_FINISH_IO, CTL_MSG_BAD_JUJU. + */ +struct ctl_ha_msg_scsi { + struct ctl_ha_msg_hdr hdr; + uint8_t cdb[CTL_MAX_CDBLEN]; /* CDB */ + uint32_t tag_num; /* tag number */ + ctl_tag_type tag_type; /* simple, ordered, etc. */ + uint8_t scsi_status; /* SCSI status byte */ + struct scsi_sense_data sense_data; /* sense data */ + uint8_t sense_len; /* Returned sense length */ + uint8_t sense_residual; /* sense residual length */ + uint32_t residual; /* data residual length */ + uint32_t fetd_status; /* trans status, set by FETD, + 0 = good*/ + struct ctl_lba_len lbalen; /* used for stats */ +}; + +/* + * Used for CTL_MSG_MANAGE_TASKS. + */ +struct ctl_ha_msg_task { + struct ctl_ha_msg_hdr hdr; + ctl_task_type task_action; /* Target Reset, Abort, etc. */ + uint32_t tag_num; /* tag number */ + ctl_tag_type tag_type; /* simple, ordered, etc. */ +}; + +union ctl_ha_msg { + struct ctl_ha_msg_hdr hdr; + struct ctl_ha_msg_task task; + struct ctl_ha_msg_scsi scsi; + struct ctl_ha_msg_dt dt; + struct ctl_ha_msg_pr pr; + struct ctl_ha_msg_aps aps; +}; + + +struct ctl_prio { + struct ctl_io_hdr io_hdr; + struct ctl_ha_msg_pr pr_msg; +}; + + + +union ctl_io { + struct ctl_io_hdr io_hdr; /* common to all I/O types */ + struct ctl_scsiio scsiio; /* Normal SCSI commands */ + struct ctl_taskio taskio; /* SCSI task management/reset */ + struct ctl_prio presio; /* update per. res info on other SC */ +}; + +#ifdef _KERNEL + +union ctl_io *ctl_alloc_io(void *pool_ref); +void ctl_free_io(union ctl_io *io); +void ctl_zero_io(union ctl_io *io); +void ctl_copy_io(union ctl_io *src, union ctl_io *dest); + +#endif /* _KERNEL */ + +#endif /* _CTL_IO_H_ */ + +/* + * vim: ts=8 + */ |