1139743Simp/*- 239212Sgibbs * Data structures and definitions for CAM Control Blocks (CCBs). 339212Sgibbs * 439212Sgibbs * Copyright (c) 1997, 1998 Justin T. Gibbs. 539212Sgibbs * All rights reserved. 639212Sgibbs * 739212Sgibbs * Redistribution and use in source and binary forms, with or without 839212Sgibbs * modification, are permitted provided that the following conditions 939212Sgibbs * are met: 1039212Sgibbs * 1. Redistributions of source code must retain the above copyright 1139212Sgibbs * notice, this list of conditions, and the following disclaimer, 1239212Sgibbs * without modification, immediately at the beginning of the file. 1339212Sgibbs * 2. The name of the author may not be used to endorse or promote products 1439212Sgibbs * derived from this software without specific prior written permission. 1539212Sgibbs * 1639212Sgibbs * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 1739212Sgibbs * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 1839212Sgibbs * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 1939212Sgibbs * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR 2039212Sgibbs * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 2139212Sgibbs * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2239212Sgibbs * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2339212Sgibbs * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2439212Sgibbs * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2539212Sgibbs * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 2639212Sgibbs * SUCH DAMAGE. 2739212Sgibbs * 2850477Speter * $FreeBSD: stable/11/sys/cam/cam_ccb.h 335166 2018-06-14 18:18:55Z mav $ 2939212Sgibbs */ 3039212Sgibbs 3139212Sgibbs#ifndef _CAM_CAM_CCB_H 3239212Sgibbs#define _CAM_CAM_CCB_H 1 3339212Sgibbs 3439212Sgibbs#include <sys/queue.h> 3539212Sgibbs#include <sys/cdefs.h> 3647412Sgibbs#include <sys/time.h> 37114216Skan#include <sys/limits.h> 3855206Speter#ifndef _KERNEL 3939212Sgibbs#include <sys/callout.h> 4039212Sgibbs#endif 4139212Sgibbs#include <cam/cam_debug.h> 4239212Sgibbs#include <cam/scsi/scsi_all.h> 43195534Sscottl#include <cam/ata/ata_all.h> 44301771Simp#include <cam/nvme/nvme_all.h> 4539212Sgibbs 4639212Sgibbs/* General allocation length definitions for CCB structures */ 4739212Sgibbs#define IOCDBLEN CAM_MAX_CDBLEN /* Space for CDB bytes/pointer */ 4839212Sgibbs#define VUHBALEN 14 /* Vendor Unique HBA length */ 4939212Sgibbs#define SIM_IDLEN 16 /* ASCII string len for SIM ID */ 5039212Sgibbs#define HBA_IDLEN 16 /* ASCII string len for HBA ID */ 5139212Sgibbs#define DEV_IDLEN 16 /* ASCII string len for device names */ 5239212Sgibbs#define CCB_PERIPH_PRIV_SIZE 2 /* size of peripheral private area */ 5339212Sgibbs#define CCB_SIM_PRIV_SIZE 2 /* size of sim private area */ 5439212Sgibbs 5539212Sgibbs/* Struct definitions for CAM control blocks */ 5639212Sgibbs 5739212Sgibbs/* Common CCB header */ 5839212Sgibbs/* CAM CCB flags */ 5939212Sgibbstypedef enum { 6039212Sgibbs CAM_CDB_POINTER = 0x00000001,/* The CDB field is a pointer */ 6139212Sgibbs CAM_QUEUE_ENABLE = 0x00000002,/* SIM queue actions are enabled */ 6239212Sgibbs CAM_CDB_LINKED = 0x00000004,/* CCB contains a linked CDB */ 6363455Sgibbs CAM_NEGOTIATE = 0x00000008,/* 6463455Sgibbs * Perform transport negotiation 6563455Sgibbs * with this command. 6663455Sgibbs */ 67246713Skib CAM_DATA_ISPHYS = 0x00000010,/* Data type with physical addrs */ 6839212Sgibbs CAM_DIS_AUTOSENSE = 0x00000020,/* Disable autosense feature */ 69216088Sken CAM_DIR_BOTH = 0x00000000,/* Data direction (00:IN/OUT) */ 7039212Sgibbs CAM_DIR_IN = 0x00000040,/* Data direction (01:DATA IN) */ 7139212Sgibbs CAM_DIR_OUT = 0x00000080,/* Data direction (10:DATA OUT) */ 7239212Sgibbs CAM_DIR_NONE = 0x000000C0,/* Data direction (11:no data) */ 7339212Sgibbs CAM_DIR_MASK = 0x000000C0,/* Data direction Mask */ 74246713Skib CAM_DATA_VADDR = 0x00000000,/* Data type (000:Virtual) */ 75246713Skib CAM_DATA_PADDR = 0x00000010,/* Data type (001:Physical) */ 76246713Skib CAM_DATA_SG = 0x00040000,/* Data type (010:sglist) */ 77246713Skib CAM_DATA_SG_PADDR = 0x00040010,/* Data type (011:sglist phys) */ 78246713Skib CAM_DATA_BIO = 0x00200000,/* Data type (100:bio) */ 79246713Skib CAM_DATA_MASK = 0x00240010,/* Data type mask */ 8039212Sgibbs CAM_SOFT_RST_OP = 0x00000100,/* Use Soft reset alternative */ 8139212Sgibbs CAM_ENG_SYNC = 0x00000200,/* Flush resid bytes on complete */ 8239212Sgibbs CAM_DEV_QFRZDIS = 0x00000400,/* Disable DEV Q freezing */ 8339212Sgibbs CAM_DEV_QFREEZE = 0x00000800,/* Freeze DEV Q on execution */ 8439212Sgibbs CAM_HIGH_POWER = 0x00001000,/* Command takes a lot of power */ 8539212Sgibbs CAM_SENSE_PTR = 0x00002000,/* Sense data is a pointer */ 8639212Sgibbs CAM_SENSE_PHYS = 0x00004000,/* Sense pointer is physical addr*/ 8739212Sgibbs CAM_TAG_ACTION_VALID = 0x00008000,/* Use the tag action in this ccb*/ 8839212Sgibbs CAM_PASS_ERR_RECOVER = 0x00010000,/* Pass driver does err. recovery*/ 8939212Sgibbs CAM_DIS_DISCONNECT = 0x00020000,/* Disable disconnect */ 9039212Sgibbs CAM_MSG_BUF_PHYS = 0x00080000,/* Message buffer ptr is physical*/ 9139212Sgibbs CAM_SNS_BUF_PHYS = 0x00100000,/* Autosense data ptr is physical*/ 9239212Sgibbs CAM_CDB_PHYS = 0x00400000,/* CDB poiner is physical */ 9339212Sgibbs CAM_ENG_SGLIST = 0x00800000,/* SG list is for the HBA engine */ 9439212Sgibbs 9539212Sgibbs/* Phase cognizant mode flags */ 9658111Sn_hibma CAM_DIS_AUTOSRP = 0x01000000,/* Disable autosave/restore ptrs */ 9739212Sgibbs CAM_DIS_AUTODISC = 0x02000000,/* Disable auto disconnect */ 9839212Sgibbs CAM_TGT_CCB_AVAIL = 0x04000000,/* Target CCB available */ 9939212Sgibbs CAM_TGT_PHASE_MODE = 0x08000000,/* The SIM runs in phase mode */ 10056145Smjacob CAM_MSGB_VALID = 0x10000000,/* Message buffer valid */ 10156145Smjacob CAM_STATUS_VALID = 0x20000000,/* Status buffer valid */ 10256145Smjacob CAM_DATAB_VALID = 0x40000000,/* Data buffer valid */ 103248520Skib 10439212Sgibbs/* Host target Mode flags */ 10556145Smjacob CAM_SEND_SENSE = 0x08000000,/* Send sense data with status */ 10656145Smjacob CAM_TERM_IO = 0x10000000,/* Terminate I/O Message sup. */ 10756145Smjacob CAM_DISCONNECT = 0x20000000,/* Disconnects are mandatory */ 108256843Smav CAM_SEND_STATUS = 0x40000000,/* Send status after data phase */ 109256843Smav 110256843Smav CAM_UNLOCKED = 0x80000000 /* Call callback without lock. */ 11139212Sgibbs} ccb_flags; 11239212Sgibbs 113291716Skentypedef enum { 114291960Sken CAM_USER_DATA_ADDR = 0x00000002,/* Userspace data pointers */ 115291960Sken CAM_SG_FORMAT_IOVEC = 0x00000004,/* iovec instead of busdma S/G*/ 116291960Sken CAM_UNMAPPED_BUF = 0x00000008 /* use unmapped I/O */ 117291716Sken} ccb_xflags; 118291716Sken 11939212Sgibbs/* XPT Opcodes for xpt_action */ 12039212Sgibbstypedef enum { 12146581Sken/* Function code flags are bits greater than 0xff */ 12246581Sken XPT_FC_QUEUED = 0x100, 12346581Sken /* Non-immediate function code */ 12446581Sken XPT_FC_USER_CCB = 0x200, 12546581Sken XPT_FC_XPT_ONLY = 0x400, 12646581Sken /* Only for the transport layer device */ 12749925Sgibbs XPT_FC_DEV_QUEUED = 0x800 | XPT_FC_QUEUED, 12849925Sgibbs /* Passes through the device queues */ 12939212Sgibbs/* Common function commands: 0x00->0x0F */ 13046581Sken XPT_NOOP = 0x00, 13146581Sken /* Execute Nothing */ 13249925Sgibbs XPT_SCSI_IO = 0x01 | XPT_FC_DEV_QUEUED, 13346581Sken /* Execute the requested I/O operation */ 13446581Sken XPT_GDEV_TYPE = 0x02, 13546581Sken /* Get type information for specified device */ 13646581Sken XPT_GDEVLIST = 0x03, 13746581Sken /* Get a list of peripheral devices */ 13846581Sken XPT_PATH_INQ = 0x04, 13946581Sken /* Path routing inquiry */ 14046581Sken XPT_REL_SIMQ = 0x05, 141203108Smav /* Release a frozen device queue */ 14246581Sken XPT_SASYNC_CB = 0x06, 14346581Sken /* Set Asynchronous Callback Parameters */ 14446581Sken XPT_SDEV_TYPE = 0x07, 14546581Sken /* Set device type information */ 14646581Sken XPT_SCAN_BUS = 0x08 | XPT_FC_QUEUED | XPT_FC_USER_CCB 14746581Sken | XPT_FC_XPT_ONLY, 14846581Sken /* (Re)Scan the SCSI Bus */ 14946581Sken XPT_DEV_MATCH = 0x09 | XPT_FC_XPT_ONLY, 15046581Sken /* Get EDT entries matching the given pattern */ 15146581Sken XPT_DEBUG = 0x0a, 15246581Sken /* Turn on debugging for a bus, target or lun */ 15347412Sgibbs XPT_PATH_STATS = 0x0b, 15447412Sgibbs /* Path statistics (error counts, etc.) */ 15547412Sgibbs XPT_GDEV_STATS = 0x0c, 15647412Sgibbs /* Device statistics (error counts, etc.) */ 157223081Sgibbs XPT_DEV_ADVINFO = 0x0e, 158223081Sgibbs /* Get/Set Device advanced information */ 159256843Smav XPT_ASYNC = 0x0f | XPT_FC_QUEUED | XPT_FC_USER_CCB 160256843Smav | XPT_FC_XPT_ONLY, 161256843Smav /* Asynchronous event */ 16239212Sgibbs/* SCSI Control Functions: 0x10->0x1F */ 16346581Sken XPT_ABORT = 0x10, 16446581Sken /* Abort the specified CCB */ 16546581Sken XPT_RESET_BUS = 0x11 | XPT_FC_XPT_ONLY, 16646581Sken /* Reset the specified SCSI bus */ 16749925Sgibbs XPT_RESET_DEV = 0x12 | XPT_FC_DEV_QUEUED, 16846581Sken /* Bus Device Reset the specified SCSI device */ 16946581Sken XPT_TERM_IO = 0x13, 17046581Sken /* Terminate the I/O process */ 17146581Sken XPT_SCAN_LUN = 0x14 | XPT_FC_QUEUED | XPT_FC_USER_CCB 17246581Sken | XPT_FC_XPT_ONLY, 17346581Sken /* Scan Logical Unit */ 17446581Sken XPT_GET_TRAN_SETTINGS = 0x15, 17546581Sken /* 17639212Sgibbs * Get default/user transfer settings 17739212Sgibbs * for the target 17839212Sgibbs */ 17946581Sken XPT_SET_TRAN_SETTINGS = 0x16, 18046581Sken /* 18139212Sgibbs * Set transfer rate/width 18239212Sgibbs * negotiation settings 18339212Sgibbs */ 18446581Sken XPT_CALC_GEOMETRY = 0x17, 18546581Sken /* 18639212Sgibbs * Calculate the geometry parameters for 18739212Sgibbs * a device give the sector size and 18839212Sgibbs * volume size. 18939212Sgibbs */ 190195534Sscottl XPT_ATA_IO = 0x18 | XPT_FC_DEV_QUEUED, 191195534Sscottl /* Execute the requested ATA I/O operation */ 19239212Sgibbs 193296604Simp XPT_GET_SIM_KNOB_OLD = 0x18, /* Compat only */ 194196008Smjacob 195196008Smjacob XPT_SET_SIM_KNOB = 0x19, 196196008Smjacob /* 197196008Smjacob * Set SIM specific knob values. 198196008Smjacob */ 199208582Smjacob 200296604Simp XPT_GET_SIM_KNOB = 0x1a, 201296604Simp /* 202296604Simp * Get SIM specific knob values. 203296604Simp */ 204296604Simp 205216088Sken XPT_SMP_IO = 0x1b | XPT_FC_DEV_QUEUED, 206216088Sken /* Serial Management Protocol */ 207216088Sken 208301740Simp XPT_NVME_IO = 0x1c | XPT_FC_DEV_QUEUED, 209328680Smav /* Execute the requested NVMe I/O operation */ 210301740Simp 211301741Simp XPT_MMCSD_IO = 0x1d | XPT_FC_DEV_QUEUED, 212301741Simp /* Placeholder for MMC / SD / SDIO I/O stuff */ 213301741Simp 214208582Smjacob XPT_SCAN_TGT = 0x1E | XPT_FC_QUEUED | XPT_FC_USER_CCB 215208582Smjacob | XPT_FC_XPT_ONLY, 216208582Smjacob /* Scan Target */ 217208582Smjacob 218328680Smav XPT_NVME_ADMIN = 0x1f | XPT_FC_DEV_QUEUED, 219328680Smav /* Execute the requested NVMe Admin operation */ 220328680Smav 22139212Sgibbs/* HBA engine commands 0x20->0x2F */ 22246581Sken XPT_ENG_INQ = 0x20 | XPT_FC_XPT_ONLY, 22346581Sken /* HBA engine feature inquiry */ 22474840Sken XPT_ENG_EXEC = 0x21 | XPT_FC_DEV_QUEUED, 22546581Sken /* HBA execute engine request */ 22639212Sgibbs 22739212Sgibbs/* Target mode commands: 0x30->0x3F */ 22846581Sken XPT_EN_LUN = 0x30, 22946581Sken /* Enable LUN as a target */ 23049925Sgibbs XPT_TARGET_IO = 0x31 | XPT_FC_DEV_QUEUED, 23146581Sken /* Execute target I/O request */ 23246581Sken XPT_ACCEPT_TARGET_IO = 0x32 | XPT_FC_QUEUED | XPT_FC_USER_CCB, 23346581Sken /* Accept Host Target Mode CDB */ 23449925Sgibbs XPT_CONT_TARGET_IO = 0x33 | XPT_FC_DEV_QUEUED, 23546581Sken /* Continue Host Target I/O Connection */ 23646581Sken XPT_IMMED_NOTIFY = 0x34 | XPT_FC_QUEUED | XPT_FC_USER_CCB, 237196008Smjacob /* Notify Host Target driver of event (obsolete) */ 238196008Smjacob XPT_NOTIFY_ACK = 0x35, 239196008Smjacob /* Acknowledgement of event (obsolete) */ 240196008Smjacob XPT_IMMEDIATE_NOTIFY = 0x36 | XPT_FC_QUEUED | XPT_FC_USER_CCB, 24146581Sken /* Notify Host Target driver of event */ 242196008Smjacob XPT_NOTIFY_ACKNOWLEDGE = 0x37 | XPT_FC_QUEUED | XPT_FC_USER_CCB, 24346581Sken /* Acknowledgement of event */ 244299371Strasz XPT_REPROBE_LUN = 0x38 | XPT_FC_QUEUED | XPT_FC_USER_CCB, 245299371Strasz /* Query device capacity and notify GEOM */ 24639212Sgibbs 24739212Sgibbs/* Vendor Unique codes: 0x80->0x8F */ 24846581Sken XPT_VUNIQUE = 0x80 24939212Sgibbs} xpt_opcode; 25039212Sgibbs 25146581Sken#define XPT_FC_GROUP_MASK 0xF0 25246581Sken#define XPT_FC_GROUP(op) ((op) & XPT_FC_GROUP_MASK) 25346581Sken#define XPT_FC_GROUP_COMMON 0x00 25446581Sken#define XPT_FC_GROUP_SCSI_CONTROL 0x10 25549925Sgibbs#define XPT_FC_GROUP_HBA_ENGINE 0x20 25646581Sken#define XPT_FC_GROUP_TMODE 0x30 25746581Sken#define XPT_FC_GROUP_VENDOR_UNIQUE 0x80 25844499Sgibbs 25949925Sgibbs#define XPT_FC_IS_DEV_QUEUED(ccb) \ 26049925Sgibbs (((ccb)->ccb_h.func_code & XPT_FC_DEV_QUEUED) == XPT_FC_DEV_QUEUED) 26149925Sgibbs#define XPT_FC_IS_QUEUED(ccb) \ 26249925Sgibbs (((ccb)->ccb_h.func_code & XPT_FC_QUEUED) != 0) 26374840Sken 26474840Skentypedef enum { 26574840Sken PROTO_UNKNOWN, 26674840Sken PROTO_UNSPECIFIED, 26774840Sken PROTO_SCSI, /* Small Computer System Interface */ 26874840Sken PROTO_ATA, /* AT Attachment */ 26974840Sken PROTO_ATAPI, /* AT Attachment Packetized Interface */ 270195534Sscottl PROTO_SATAPM, /* SATA Port Multiplier */ 271235897Smav PROTO_SEMB, /* SATA Enclosure Management Bridge */ 272301771Simp PROTO_NVME, /* NVME */ 27374840Sken} cam_proto; 27474840Sken 27574840Skentypedef enum { 27674840Sken XPORT_UNKNOWN, 27774840Sken XPORT_UNSPECIFIED, 27874840Sken XPORT_SPI, /* SCSI Parallel Interface */ 27974840Sken XPORT_FC, /* Fiber Channel */ 28074840Sken XPORT_SSA, /* Serial Storage Architecture */ 28174840Sken XPORT_USB, /* Universal Serial Bus */ 28274840Sken XPORT_PPB, /* Parallel Port Bus */ 283154593Smjacob XPORT_ATA, /* AT Attachment */ 284154593Smjacob XPORT_SAS, /* Serial Attached SCSI */ 285195534Sscottl XPORT_SATA, /* Serial AT Attachment */ 286196352Smav XPORT_ISCSI, /* iSCSI */ 287255915Snwhitehorn XPORT_SRP, /* SCSI RDMA Protocol */ 288301771Simp XPORT_NVME, /* NVMe over PCIe */ 28974840Sken} cam_xport; 29074840Sken 291220644Smav#define XPORT_IS_ATA(t) ((t) == XPORT_ATA || (t) == XPORT_SATA) 292220644Smav#define XPORT_IS_SCSI(t) ((t) != XPORT_UNKNOWN && \ 293220644Smav (t) != XPORT_UNSPECIFIED && \ 294220644Smav !XPORT_IS_ATA(t)) 295220644Smav#define XPORT_DEVSTAT_TYPE(t) (XPORT_IS_ATA(t) ? DEVSTAT_TYPE_IF_IDE : \ 296220644Smav XPORT_IS_SCSI(t) ? DEVSTAT_TYPE_IF_SCSI : \ 297220644Smav DEVSTAT_TYPE_IF_OTHER) 298220644Smav 299154593Smjacob#define PROTO_VERSION_UNKNOWN (UINT_MAX - 1) 300154593Smjacob#define PROTO_VERSION_UNSPECIFIED UINT_MAX 301154593Smjacob#define XPORT_VERSION_UNKNOWN (UINT_MAX - 1) 302154593Smjacob#define XPORT_VERSION_UNSPECIFIED UINT_MAX 30374840Sken 30439212Sgibbstypedef union { 30560938Sjake LIST_ENTRY(ccb_hdr) le; 30660938Sjake SLIST_ENTRY(ccb_hdr) sle; 30760938Sjake TAILQ_ENTRY(ccb_hdr) tqe; 30860938Sjake STAILQ_ENTRY(ccb_hdr) stqe; 30939212Sgibbs} camq_entry; 31039212Sgibbs 31139212Sgibbstypedef union { 31239212Sgibbs void *ptr; 31339212Sgibbs u_long field; 314168752Sscottl u_int8_t bytes[sizeof(uintptr_t)]; 31539212Sgibbs} ccb_priv_entry; 31639212Sgibbs 31739212Sgibbstypedef union { 31839212Sgibbs ccb_priv_entry entries[CCB_PERIPH_PRIV_SIZE]; 31939212Sgibbs u_int8_t bytes[CCB_PERIPH_PRIV_SIZE * sizeof(ccb_priv_entry)]; 32039212Sgibbs} ccb_ppriv_area; 32139212Sgibbs 32239212Sgibbstypedef union { 32339212Sgibbs ccb_priv_entry entries[CCB_SIM_PRIV_SIZE]; 32439212Sgibbs u_int8_t bytes[CCB_SIM_PRIV_SIZE * sizeof(ccb_priv_entry)]; 32539212Sgibbs} ccb_spriv_area; 32639212Sgibbs 327255870Sscottltypedef struct { 328255870Sscottl struct timeval *etime; 329255870Sscottl uintptr_t sim_data; 330255870Sscottl uintptr_t periph_data; 331255870Sscottl} ccb_qos_area; 332255870Sscottl 33339212Sgibbsstruct ccb_hdr { 334130200Sscottl cam_pinfo pinfo; /* Info for priority scheduling */ 33539212Sgibbs camq_entry xpt_links; /* For chaining in the XPT layer */ 33639212Sgibbs camq_entry sim_links; /* For chaining in the SIM layer */ 337130200Sscottl camq_entry periph_links; /* For chaining in the type driver */ 33839212Sgibbs u_int32_t retry_count; 33939212Sgibbs void (*cbfcnp)(struct cam_periph *, union ccb *); 340130200Sscottl /* Callback on completion function */ 34139212Sgibbs xpt_opcode func_code; /* XPT function code */ 342130200Sscottl u_int32_t status; /* Status returned by CAM subsystem */ 343130200Sscottl struct cam_path *path; /* Compiled path for this ccb */ 34439212Sgibbs path_id_t path_id; /* Path ID for the request */ 34539212Sgibbs target_id_t target_id; /* Target device ID */ 34639212Sgibbs lun_id_t target_lun; /* Target LUN number */ 347130200Sscottl u_int32_t flags; /* ccb_flags */ 348255870Sscottl u_int32_t xflags; /* Extended flags */ 34939212Sgibbs ccb_ppriv_area periph_priv; 35039212Sgibbs ccb_spriv_area sim_priv; 351255870Sscottl ccb_qos_area qos; 352255870Sscottl u_int32_t timeout; /* Hard timeout value in mseconds */ 353255870Sscottl struct timeval softtimeout; /* Soft timeout value in sec + usec */ 35439212Sgibbs}; 35539212Sgibbs 35639212Sgibbs/* Get Device Information CCB */ 35739212Sgibbsstruct ccb_getdev { 35839212Sgibbs struct ccb_hdr ccb_h; 359195534Sscottl cam_proto protocol; 36056145Smjacob struct scsi_inquiry_data inq_data; 361195534Sscottl struct ata_params ident_data; 36239212Sgibbs u_int8_t serial_num[252]; 363199178Smav u_int8_t inq_flags; 36439212Sgibbs u_int8_t serial_num_len; 365328735Smav void *padding[2]; 36639212Sgibbs}; 36739212Sgibbs 36847412Sgibbs/* Device Statistics CCB */ 36947412Sgibbsstruct ccb_getdevstats { 37047412Sgibbs struct ccb_hdr ccb_h; 37147412Sgibbs int dev_openings; /* Space left for more work on device*/ 37247412Sgibbs int dev_active; /* Transactions running on the device */ 373271588Smav int allocated; /* CCBs allocated for the device */ 374271588Smav int queued; /* CCBs queued to be sent to the device */ 37547412Sgibbs int held; /* 37647412Sgibbs * CCBs held by peripheral drivers 37747412Sgibbs * for this device 37847412Sgibbs */ 37947434Sgibbs int maxtags; /* 38047434Sgibbs * Boundary conditions for number of 38147434Sgibbs * tagged operations 38247434Sgibbs */ 38347434Sgibbs int mintags; 38447412Sgibbs struct timeval last_reset; /* Time of last bus reset/loop init */ 38547412Sgibbs}; 38639212Sgibbs 38739212Sgibbstypedef enum { 38839212Sgibbs CAM_GDEVLIST_LAST_DEVICE, 38939212Sgibbs CAM_GDEVLIST_LIST_CHANGED, 39039212Sgibbs CAM_GDEVLIST_MORE_DEVS, 39139212Sgibbs CAM_GDEVLIST_ERROR 39239212Sgibbs} ccb_getdevlist_status_e; 39339212Sgibbs 39439212Sgibbsstruct ccb_getdevlist { 39539212Sgibbs struct ccb_hdr ccb_h; 39639212Sgibbs char periph_name[DEV_IDLEN]; 39739212Sgibbs u_int32_t unit_number; 39839212Sgibbs unsigned int generation; 39939212Sgibbs u_int32_t index; 40039212Sgibbs ccb_getdevlist_status_e status; 40139212Sgibbs}; 40239212Sgibbs 40339212Sgibbstypedef enum { 40439212Sgibbs PERIPH_MATCH_NONE = 0x000, 40539212Sgibbs PERIPH_MATCH_PATH = 0x001, 40639212Sgibbs PERIPH_MATCH_TARGET = 0x002, 40739212Sgibbs PERIPH_MATCH_LUN = 0x004, 40839212Sgibbs PERIPH_MATCH_NAME = 0x008, 40939212Sgibbs PERIPH_MATCH_UNIT = 0x010, 41039212Sgibbs PERIPH_MATCH_ANY = 0x01f 41139212Sgibbs} periph_pattern_flags; 41239212Sgibbs 41339212Sgibbsstruct periph_match_pattern { 41439212Sgibbs char periph_name[DEV_IDLEN]; 41539212Sgibbs u_int32_t unit_number; 41639212Sgibbs path_id_t path_id; 41739212Sgibbs target_id_t target_id; 41839212Sgibbs lun_id_t target_lun; 41939212Sgibbs periph_pattern_flags flags; 42039212Sgibbs}; 42139212Sgibbs 42239212Sgibbstypedef enum { 42339212Sgibbs DEV_MATCH_NONE = 0x000, 42439212Sgibbs DEV_MATCH_PATH = 0x001, 42539212Sgibbs DEV_MATCH_TARGET = 0x002, 42639212Sgibbs DEV_MATCH_LUN = 0x004, 42739212Sgibbs DEV_MATCH_INQUIRY = 0x008, 428223081Sgibbs DEV_MATCH_DEVID = 0x010, 42939212Sgibbs DEV_MATCH_ANY = 0x00f 43039212Sgibbs} dev_pattern_flags; 43139212Sgibbs 432223081Sgibbsstruct device_id_match_pattern { 433223081Sgibbs uint8_t id_len; 434223081Sgibbs uint8_t id[256]; 435223081Sgibbs}; 436223081Sgibbs 43739212Sgibbsstruct device_match_pattern { 438223081Sgibbs path_id_t path_id; 439223081Sgibbs target_id_t target_id; 440223081Sgibbs lun_id_t target_lun; 441223081Sgibbs dev_pattern_flags flags; 442223081Sgibbs union { 443223081Sgibbs struct scsi_static_inquiry_pattern inq_pat; 444223081Sgibbs struct device_id_match_pattern devid_pat; 445223081Sgibbs } data; 44639212Sgibbs}; 44739212Sgibbs 44839212Sgibbstypedef enum { 44939212Sgibbs BUS_MATCH_NONE = 0x000, 45039212Sgibbs BUS_MATCH_PATH = 0x001, 45139212Sgibbs BUS_MATCH_NAME = 0x002, 45239212Sgibbs BUS_MATCH_UNIT = 0x004, 45339212Sgibbs BUS_MATCH_BUS_ID = 0x008, 45439212Sgibbs BUS_MATCH_ANY = 0x00f 45539212Sgibbs} bus_pattern_flags; 45639212Sgibbs 45739212Sgibbsstruct bus_match_pattern { 45839212Sgibbs path_id_t path_id; 45939212Sgibbs char dev_name[DEV_IDLEN]; 46039212Sgibbs u_int32_t unit_number; 46139212Sgibbs u_int32_t bus_id; 46239212Sgibbs bus_pattern_flags flags; 46339212Sgibbs}; 46439212Sgibbs 46539212Sgibbsunion match_pattern { 46639212Sgibbs struct periph_match_pattern periph_pattern; 46739212Sgibbs struct device_match_pattern device_pattern; 46839212Sgibbs struct bus_match_pattern bus_pattern; 46939212Sgibbs}; 47039212Sgibbs 47139212Sgibbstypedef enum { 47239212Sgibbs DEV_MATCH_PERIPH, 47339212Sgibbs DEV_MATCH_DEVICE, 47439212Sgibbs DEV_MATCH_BUS 47539212Sgibbs} dev_match_type; 47639212Sgibbs 47739212Sgibbsstruct dev_match_pattern { 47839212Sgibbs dev_match_type type; 47939212Sgibbs union match_pattern pattern; 48039212Sgibbs}; 48139212Sgibbs 48239212Sgibbsstruct periph_match_result { 48339212Sgibbs char periph_name[DEV_IDLEN]; 48439212Sgibbs u_int32_t unit_number; 48539212Sgibbs path_id_t path_id; 48639212Sgibbs target_id_t target_id; 48739212Sgibbs lun_id_t target_lun; 48839212Sgibbs}; 48939212Sgibbs 49046581Skentypedef enum { 49146581Sken DEV_RESULT_NOFLAG = 0x00, 49246581Sken DEV_RESULT_UNCONFIGURED = 0x01 49346581Sken} dev_result_flags; 49446581Sken 49539212Sgibbsstruct device_match_result { 49639212Sgibbs path_id_t path_id; 49739212Sgibbs target_id_t target_id; 49839212Sgibbs lun_id_t target_lun; 499195534Sscottl cam_proto protocol; 50039212Sgibbs struct scsi_inquiry_data inq_data; 501195534Sscottl struct ata_params ident_data; 50246581Sken dev_result_flags flags; 50339212Sgibbs}; 50439212Sgibbs 50539212Sgibbsstruct bus_match_result { 50639212Sgibbs path_id_t path_id; 50739212Sgibbs char dev_name[DEV_IDLEN]; 50839212Sgibbs u_int32_t unit_number; 50939212Sgibbs u_int32_t bus_id; 51039212Sgibbs}; 51139212Sgibbs 51239212Sgibbsunion match_result { 51339212Sgibbs struct periph_match_result periph_result; 51439212Sgibbs struct device_match_result device_result; 51539212Sgibbs struct bus_match_result bus_result; 51639212Sgibbs}; 51739212Sgibbs 51839212Sgibbsstruct dev_match_result { 51939212Sgibbs dev_match_type type; 52039212Sgibbs union match_result result; 52139212Sgibbs}; 52239212Sgibbs 52339212Sgibbstypedef enum { 52439212Sgibbs CAM_DEV_MATCH_LAST, 52539212Sgibbs CAM_DEV_MATCH_MORE, 52639212Sgibbs CAM_DEV_MATCH_LIST_CHANGED, 52739212Sgibbs CAM_DEV_MATCH_SIZE_ERROR, 52839212Sgibbs CAM_DEV_MATCH_ERROR 52939212Sgibbs} ccb_dev_match_status; 53039212Sgibbs 53139212Sgibbstypedef enum { 53239212Sgibbs CAM_DEV_POS_NONE = 0x000, 53339212Sgibbs CAM_DEV_POS_BUS = 0x001, 53439212Sgibbs CAM_DEV_POS_TARGET = 0x002, 53539212Sgibbs CAM_DEV_POS_DEVICE = 0x004, 53639212Sgibbs CAM_DEV_POS_PERIPH = 0x008, 53739212Sgibbs CAM_DEV_POS_PDPTR = 0x010, 53839212Sgibbs CAM_DEV_POS_TYPEMASK = 0xf00, 53939212Sgibbs CAM_DEV_POS_EDT = 0x100, 54039212Sgibbs CAM_DEV_POS_PDRV = 0x200 54139212Sgibbs} dev_pos_type; 54239212Sgibbs 54339212Sgibbsstruct ccb_dm_cookie { 54439212Sgibbs void *bus; 54539212Sgibbs void *target; 54639212Sgibbs void *device; 54739212Sgibbs void *periph; 54839212Sgibbs void *pdrv; 54939212Sgibbs}; 55039212Sgibbs 55139212Sgibbsstruct ccb_dev_position { 55239212Sgibbs u_int generations[4]; 55339212Sgibbs#define CAM_BUS_GENERATION 0x00 55439212Sgibbs#define CAM_TARGET_GENERATION 0x01 55539212Sgibbs#define CAM_DEV_GENERATION 0x02 55639212Sgibbs#define CAM_PERIPH_GENERATION 0x03 55739212Sgibbs dev_pos_type position_type; 55839212Sgibbs struct ccb_dm_cookie cookie; 55939212Sgibbs}; 56039212Sgibbs 56139212Sgibbsstruct ccb_dev_match { 56239212Sgibbs struct ccb_hdr ccb_h; 56339212Sgibbs ccb_dev_match_status status; 56439212Sgibbs u_int32_t num_patterns; 56539212Sgibbs u_int32_t pattern_buf_len; 56639212Sgibbs struct dev_match_pattern *patterns; 56739212Sgibbs u_int32_t num_matches; 56839212Sgibbs u_int32_t match_buf_len; 56939212Sgibbs struct dev_match_result *matches; 57039212Sgibbs struct ccb_dev_position pos; 57139212Sgibbs}; 57239212Sgibbs 57339212Sgibbs/* 57439212Sgibbs * Definitions for the path inquiry CCB fields. 57539212Sgibbs */ 576259397Snwhitehorn#define CAM_VERSION 0x19 /* Hex value for current version */ 57739212Sgibbs 57839212Sgibbstypedef enum { 57939212Sgibbs PI_MDP_ABLE = 0x80, /* Supports MDP message */ 58039212Sgibbs PI_WIDE_32 = 0x40, /* Supports 32 bit wide SCSI */ 58139212Sgibbs PI_WIDE_16 = 0x20, /* Supports 16 bit wide SCSI */ 58239212Sgibbs PI_SDTR_ABLE = 0x10, /* Supports SDTR message */ 58339212Sgibbs PI_LINKED_CDB = 0x08, /* Supports linked CDBs */ 584195534Sscottl PI_SATAPM = 0x04, /* Supports SATA PM */ 58539212Sgibbs PI_TAG_ABLE = 0x02, /* Supports tag queue messages */ 58653258Sken PI_SOFT_RST = 0x01 /* Supports soft reset alternative */ 58739212Sgibbs} pi_inqflag; 58839212Sgibbs 58939212Sgibbstypedef enum { 59039212Sgibbs PIT_PROCESSOR = 0x80, /* Target mode processor mode */ 59139212Sgibbs PIT_PHASE = 0x40, /* Target mode phase cog. mode */ 59239212Sgibbs PIT_DISCONNECT = 0x20, /* Disconnects supported in target mode */ 59339212Sgibbs PIT_TERM_IO = 0x10, /* Terminate I/O message supported in TM */ 59439212Sgibbs PIT_GRP_6 = 0x08, /* Group 6 commands supported */ 59553258Sken PIT_GRP_7 = 0x04 /* Group 7 commands supported */ 59639212Sgibbs} pi_tmflag; 59739212Sgibbs 59839212Sgibbstypedef enum { 599298143Simp PIM_ATA_EXT = 0x200,/* ATA requests can understand ata_ext requests */ 600255870Sscottl PIM_EXTLUNS = 0x100,/* 64bit extended LUNs supported */ 60139212Sgibbs PIM_SCANHILO = 0x80, /* Bus scans from high ID to low ID */ 60239212Sgibbs PIM_NOREMOVE = 0x40, /* Removeable devices not included in scan */ 60341644Sgibbs PIM_NOINITIATOR = 0x20, /* Initiator role not supported. */ 604118105Snjl PIM_NOBUSRESET = 0x10, /* User has disabled initial BUS RESET */ 605159311Smjacob PIM_NO_6_BYTE = 0x08, /* Do not send 6-byte commands */ 606248519Skib PIM_SEQSCAN = 0x04, /* Do bus scans sequentially, not in parallel */ 607248519Skib PIM_UNMAPPED = 0x02, 608253549Sken PIM_NOSCAN = 0x01 /* SIM does its own scanning */ 60939212Sgibbs} pi_miscflag; 61039212Sgibbs 61139212Sgibbs/* Path Inquiry CCB */ 61274840Skenstruct ccb_pathinq_settings_spi { 61374840Sken u_int8_t ppr_options; 61474840Sken}; 615196008Smjacob 61677708Smjacobstruct ccb_pathinq_settings_fc { 61777708Smjacob u_int64_t wwnn; /* world wide node name */ 61877708Smjacob u_int64_t wwpn; /* world wide port name */ 61977708Smjacob u_int32_t port; /* 24 bit port id, if known */ 62077708Smjacob u_int32_t bitrate; /* Mbps */ 62177708Smjacob}; 622196008Smjacob 623154593Smjacobstruct ccb_pathinq_settings_sas { 624154593Smjacob u_int32_t bitrate; /* Mbps */ 625154593Smjacob}; 626301778Simp 627301778Simpstruct ccb_pathinq_settings_nvme { 628328697Smav uint32_t nsid; /* Namespace ID for this path */ 629328750Smav uint32_t domain; 630328750Smav uint8_t bus; 631328750Smav uint8_t slot; 632328750Smav uint8_t function; 633328750Smav uint8_t extra; 634301778Simp}; 635301778Simp 63677708Smjacob#define PATHINQ_SETTINGS_SIZE 128 63774840Sken 63839212Sgibbsstruct ccb_pathinq { 63939212Sgibbs struct ccb_hdr ccb_h; 64039212Sgibbs u_int8_t version_num; /* Version number for the SIM/HBA */ 64139212Sgibbs u_int8_t hba_inquiry; /* Mimic of INQ byte 7 for the HBA */ 642255870Sscottl u_int16_t target_sprt; /* Flags for target mode support */ 643255870Sscottl u_int32_t hba_misc; /* Misc HBA features */ 64439212Sgibbs u_int16_t hba_eng_cnt; /* HBA engine count */ 64539212Sgibbs /* Vendor Unique capabilities */ 64639212Sgibbs u_int8_t vuhba_flags[VUHBALEN]; 64739212Sgibbs u_int32_t max_target; /* Maximum supported Target */ 64839212Sgibbs u_int32_t max_lun; /* Maximum supported Lun */ 64939212Sgibbs u_int32_t async_flags; /* Installed Async handlers */ 65039212Sgibbs path_id_t hpath_id; /* Highest Path ID in the subsystem */ 65139212Sgibbs target_id_t initiator_id; /* ID of the HBA on the SCSI bus */ 65239212Sgibbs char sim_vid[SIM_IDLEN]; /* Vendor ID of the SIM */ 65339212Sgibbs char hba_vid[HBA_IDLEN]; /* Vendor ID of the HBA */ 65439212Sgibbs char dev_name[DEV_IDLEN];/* Device name for SIM */ 65539212Sgibbs u_int32_t unit_number; /* Unit number for SIM */ 65639212Sgibbs u_int32_t bus_id; /* Bus ID for SIM */ 65746581Sken u_int32_t base_transfer_speed;/* Base bus speed in KB/sec */ 65874840Sken cam_proto protocol; 65974840Sken u_int protocol_version; 66074840Sken cam_xport transport; 66174840Sken u_int transport_version; 66274840Sken union { 66374840Sken struct ccb_pathinq_settings_spi spi; 66477708Smjacob struct ccb_pathinq_settings_fc fc; 665154593Smjacob struct ccb_pathinq_settings_sas sas; 666301778Simp struct ccb_pathinq_settings_nvme nvme; 66777708Smjacob char ccb_pathinq_settings_opaque[PATHINQ_SETTINGS_SIZE]; 66874840Sken } xport_specific; 669195534Sscottl u_int maxio; /* Max supported I/O size, in bytes. */ 670210471Smav u_int16_t hba_vendor; /* HBA vendor ID */ 671210471Smav u_int16_t hba_device; /* HBA device ID */ 672210471Smav u_int16_t hba_subvendor; /* HBA subvendor ID */ 673210471Smav u_int16_t hba_subdevice; /* HBA subdevice ID */ 67439212Sgibbs}; 67539212Sgibbs 67647412Sgibbs/* Path Statistics CCB */ 67747412Sgibbsstruct ccb_pathstats { 67847412Sgibbs struct ccb_hdr ccb_h; 67947412Sgibbs struct timeval last_reset; /* Time of last bus reset/loop init */ 68047412Sgibbs}; 68147412Sgibbs 682216088Skentypedef enum { 683216088Sken SMP_FLAG_NONE = 0x00, 684216088Sken SMP_FLAG_REQ_SG = 0x01, 685216088Sken SMP_FLAG_RSP_SG = 0x02 686216088Sken} ccb_smp_pass_flags; 687216088Sken 688216088Sken/* 689216088Sken * Serial Management Protocol CCB 690216088Sken * XXX Currently the semantics for this CCB are that it is executed either 691216088Sken * by the addressed device, or that device's parent (i.e. an expander for 692216088Sken * any device on an expander) if the addressed device doesn't support SMP. 693216088Sken * Later, once we have the ability to probe SMP-only devices and put them 694216088Sken * in CAM's topology, the CCB will only be executed by the addressed device 695216088Sken * if possible. 696216088Sken */ 697216088Skenstruct ccb_smpio { 698216088Sken struct ccb_hdr ccb_h; 699216088Sken uint8_t *smp_request; 700216088Sken int smp_request_len; 701216088Sken uint16_t smp_request_sglist_cnt; 702216088Sken uint8_t *smp_response; 703216088Sken int smp_response_len; 704216088Sken uint16_t smp_response_sglist_cnt; 705216088Sken ccb_smp_pass_flags flags; 706216088Sken}; 707216088Sken 70839212Sgibbstypedef union { 70939212Sgibbs u_int8_t *sense_ptr; /* 71039212Sgibbs * Pointer to storage 71139212Sgibbs * for sense information 71239212Sgibbs */ 71339212Sgibbs /* Storage Area for sense information */ 71439212Sgibbs struct scsi_sense_data sense_buf; 71539212Sgibbs} sense_t; 71639212Sgibbs 71739212Sgibbstypedef union { 71839212Sgibbs u_int8_t *cdb_ptr; /* Pointer to the CDB bytes to send */ 71939212Sgibbs /* Area for the CDB send */ 72039212Sgibbs u_int8_t cdb_bytes[IOCDBLEN]; 72139212Sgibbs} cdb_t; 72239212Sgibbs 72339212Sgibbs/* 72439212Sgibbs * SCSI I/O Request CCB used for the XPT_SCSI_IO and XPT_CONT_TARGET_IO 72539212Sgibbs * function codes. 72639212Sgibbs */ 72739212Sgibbsstruct ccb_scsiio { 72839212Sgibbs struct ccb_hdr ccb_h; 72939212Sgibbs union ccb *next_ccb; /* Ptr for next CCB for action */ 73039212Sgibbs u_int8_t *req_map; /* Ptr to mapping info */ 73139212Sgibbs u_int8_t *data_ptr; /* Ptr to the data buf/SG list */ 73239212Sgibbs u_int32_t dxfer_len; /* Data transfer length */ 73339212Sgibbs /* Autosense storage */ 73439212Sgibbs struct scsi_sense_data sense_data; 73539212Sgibbs u_int8_t sense_len; /* Number of bytes to autosense */ 73639212Sgibbs u_int8_t cdb_len; /* Number of bytes for the CDB */ 73739212Sgibbs u_int16_t sglist_cnt; /* Number of SG list entries */ 73839212Sgibbs u_int8_t scsi_status; /* Returned SCSI status */ 73939212Sgibbs u_int8_t sense_resid; /* Autosense resid length: 2's comp */ 74039212Sgibbs u_int32_t resid; /* Transfer residual length: 2's comp */ 74139212Sgibbs cdb_t cdb_io; /* Union for CDB bytes/pointer */ 74239212Sgibbs u_int8_t *msg_ptr; /* Pointer to the message buffer */ 74339212Sgibbs u_int16_t msg_len; /* Number of bytes for the Message */ 74439212Sgibbs u_int8_t tag_action; /* What to do for tag queueing */ 74540417Sgibbs /* 74640417Sgibbs * The tag action should be either the define below (to send a 74740417Sgibbs * non-tagged transaction) or one of the defined scsi tag messages 74840417Sgibbs * from scsi_message.h. 74940417Sgibbs */ 75040417Sgibbs#define CAM_TAG_ACTION_NONE 0x00 75149925Sgibbs u_int tag_id; /* tag id from initator (target mode) */ 75249925Sgibbs u_int init_id; /* initiator id of who selected */ 75339212Sgibbs}; 75439212Sgibbs 755296891Simpstatic __inline uint8_t * 756296891Simpscsiio_cdb_ptr(struct ccb_scsiio *ccb) 757296891Simp{ 758296891Simp return ((ccb->ccb_h.flags & CAM_CDB_POINTER) ? 759296891Simp ccb->cdb_io.cdb_ptr : ccb->cdb_io.cdb_bytes); 760296891Simp} 761296891Simp 762195534Sscottl/* 763195534Sscottl * ATA I/O Request CCB used for the XPT_ATA_IO function code. 764195534Sscottl */ 765195534Sscottlstruct ccb_ataio { 766195534Sscottl struct ccb_hdr ccb_h; 767195534Sscottl union ccb *next_ccb; /* Ptr for next CCB for action */ 768195534Sscottl struct ata_cmd cmd; /* ATA command register set */ 769195534Sscottl struct ata_res res; /* ATA result register set */ 770195534Sscottl u_int8_t *data_ptr; /* Ptr to the data buf/SG list */ 771195534Sscottl u_int32_t dxfer_len; /* Data transfer length */ 772195534Sscottl u_int32_t resid; /* Transfer residual length: 2's comp */ 773298142Simp u_int8_t ata_flags; /* Flags for the rest of the buffer */ 774298143Simp#define ATA_FLAG_AUX 0x1 775298143Simp uint32_t aux; 776298143Simp uint32_t unused; 777195534Sscottl}; 778195534Sscottl 77939212Sgibbsstruct ccb_accept_tio { 78039212Sgibbs struct ccb_hdr ccb_h; 78139212Sgibbs cdb_t cdb_io; /* Union for CDB bytes/pointer */ 78239212Sgibbs u_int8_t cdb_len; /* Number of bytes for the CDB */ 78339212Sgibbs u_int8_t tag_action; /* What to do for tag queueing */ 78456145Smjacob u_int8_t sense_len; /* Number of bytes of Sense Data */ 78555328Smjacob u_int tag_id; /* tag id from initator (target mode) */ 78655328Smjacob u_int init_id; /* initiator id of who selected */ 78756145Smjacob struct scsi_sense_data sense_data; 78839212Sgibbs}; 78939212Sgibbs 790312844Smavstatic __inline uint8_t * 791312844Smavatio_cdb_ptr(struct ccb_accept_tio *ccb) 792312844Smav{ 793312844Smav return ((ccb->ccb_h.flags & CAM_CDB_POINTER) ? 794312844Smav ccb->cdb_io.cdb_ptr : ccb->cdb_io.cdb_bytes); 795312844Smav} 796312844Smav 79739212Sgibbs/* Release SIM Queue */ 79839212Sgibbsstruct ccb_relsim { 79939212Sgibbs struct ccb_hdr ccb_h; 80039212Sgibbs u_int32_t release_flags; 80139212Sgibbs#define RELSIM_ADJUST_OPENINGS 0x01 80239212Sgibbs#define RELSIM_RELEASE_AFTER_TIMEOUT 0x02 80339212Sgibbs#define RELSIM_RELEASE_AFTER_CMDCMPLT 0x04 80439212Sgibbs#define RELSIM_RELEASE_AFTER_QEMPTY 0x08 80539212Sgibbs u_int32_t openings; 806203108Smav u_int32_t release_timeout; /* Abstract argument. */ 80739212Sgibbs u_int32_t qfrozen_cnt; 80839212Sgibbs}; 80939212Sgibbs 81039212Sgibbs/* 811328680Smav * NVMe I/O Request CCB used for the XPT_NVME_IO and XPT_NVME_ADMIN function codes. 812301771Simp */ 813301771Simpstruct ccb_nvmeio { 814301771Simp struct ccb_hdr ccb_h; 815301771Simp union ccb *next_ccb; /* Ptr for next CCB for action */ 816301771Simp struct nvme_command cmd; /* NVME command, per NVME standard */ 817301771Simp struct nvme_completion cpl; /* NVME completion, per NVME standard */ 818301771Simp uint8_t *data_ptr; /* Ptr to the data buf/SG list */ 819301771Simp uint32_t dxfer_len; /* Data transfer length */ 820328696Smav uint16_t sglist_cnt; /* Number of SG list entries */ 821328696Smav uint16_t unused; /* padding for removed uint32_t */ 822301771Simp}; 823301771Simp 824301771Simp/* 82539212Sgibbs * Definitions for the asynchronous callback CCB fields. 82639212Sgibbs */ 82739212Sgibbstypedef enum { 828238886Smav AC_UNIT_ATTENTION = 0x4000,/* Device reported UNIT ATTENTION */ 829223081Sgibbs AC_ADVINFO_CHANGED = 0x2000,/* Advance info might have changes */ 830196008Smjacob AC_CONTRACT = 0x1000,/* A contractual callback */ 83139212Sgibbs AC_GETDEV_CHANGED = 0x800,/* Getdev info might have changed */ 83239212Sgibbs AC_INQ_CHANGED = 0x400,/* Inquiry info might have changed */ 83339212Sgibbs AC_TRANSFER_NEG = 0x200,/* New transfer settings in effect */ 83439212Sgibbs AC_LOST_DEVICE = 0x100,/* A device went away */ 83539212Sgibbs AC_FOUND_DEVICE = 0x080,/* A new device was found */ 83639212Sgibbs AC_PATH_DEREGISTERED = 0x040,/* A path has de-registered */ 83739212Sgibbs AC_PATH_REGISTERED = 0x020,/* A new path has been registered */ 83839212Sgibbs AC_SENT_BDR = 0x010,/* A BDR message was sent to target */ 83939212Sgibbs AC_SCSI_AEN = 0x008,/* A SCSI AEN has been received */ 84039212Sgibbs AC_UNSOL_RESEL = 0x002,/* Unsolicited reselection occurred */ 84139212Sgibbs AC_BUS_RESET = 0x001 /* A SCSI bus reset occurred */ 84239212Sgibbs} ac_code; 84339212Sgibbs 84439212Sgibbstypedef void ac_callback_t (void *softc, u_int32_t code, 84539212Sgibbs struct cam_path *path, void *args); 84639212Sgibbs 847196008Smjacob/* 848196008Smjacob * Generic Asynchronous callbacks. 849196008Smjacob * 850196008Smjacob * Generic arguments passed bac which are then interpreted between a per-system 851196008Smjacob * contract number. 852196008Smjacob */ 853196008Smjacob#define AC_CONTRACT_DATA_MAX (128 - sizeof (u_int64_t)) 854196008Smjacobstruct ac_contract { 855196008Smjacob u_int64_t contract_number; 856196008Smjacob u_int8_t contract_data[AC_CONTRACT_DATA_MAX]; 857196008Smjacob}; 858196008Smjacob 859196008Smjacob#define AC_CONTRACT_DEV_CHG 1 860196008Smjacobstruct ac_device_changed { 861196008Smjacob u_int64_t wwpn; 862196008Smjacob u_int32_t port; 863196008Smjacob target_id_t target; 864196008Smjacob u_int8_t arrived; 865196008Smjacob}; 866196008Smjacob 86739212Sgibbs/* Set Asynchronous Callback CCB */ 86839212Sgibbsstruct ccb_setasync { 86939212Sgibbs struct ccb_hdr ccb_h; 87039212Sgibbs u_int32_t event_enable; /* Async Event enables */ 87139212Sgibbs ac_callback_t *callback; 87239212Sgibbs void *callback_arg; 87339212Sgibbs}; 87439212Sgibbs 87539212Sgibbs/* Set Device Type CCB */ 87639212Sgibbsstruct ccb_setdev { 87739212Sgibbs struct ccb_hdr ccb_h; 87839212Sgibbs u_int8_t dev_type; /* Value for dev type field in EDT */ 87939212Sgibbs}; 88039212Sgibbs 88139212Sgibbs/* SCSI Control Functions */ 88239212Sgibbs 88339212Sgibbs/* Abort XPT request CCB */ 88439212Sgibbsstruct ccb_abort { 88539212Sgibbs struct ccb_hdr ccb_h; 88639212Sgibbs union ccb *abort_ccb; /* Pointer to CCB to abort */ 88739212Sgibbs}; 88839212Sgibbs 88939212Sgibbs/* Reset SCSI Bus CCB */ 89039212Sgibbsstruct ccb_resetbus { 89139212Sgibbs struct ccb_hdr ccb_h; 89239212Sgibbs}; 89339212Sgibbs 89439212Sgibbs/* Reset SCSI Device CCB */ 89539212Sgibbsstruct ccb_resetdev { 89639212Sgibbs struct ccb_hdr ccb_h; 89739212Sgibbs}; 89839212Sgibbs 89939212Sgibbs/* Terminate I/O Process Request CCB */ 90039212Sgibbsstruct ccb_termio { 90139212Sgibbs struct ccb_hdr ccb_h; 90239212Sgibbs union ccb *termio_ccb; /* Pointer to CCB to terminate */ 90339212Sgibbs}; 90439212Sgibbs 90574840Skentypedef enum { 90674840Sken CTS_TYPE_CURRENT_SETTINGS, 90774840Sken CTS_TYPE_USER_SETTINGS 90874840Sken} cts_type; 90974840Sken 91074840Skenstruct ccb_trans_settings_scsi 91174840Sken{ 91239212Sgibbs u_int valid; /* Which fields to honor */ 91374840Sken#define CTS_SCSI_VALID_TQ 0x01 91439212Sgibbs u_int flags; 91574840Sken#define CTS_SCSI_FLAGS_TAG_ENB 0x01 91674840Sken}; 91774840Sken 918236437Smavstruct ccb_trans_settings_ata 919236437Smav{ 920236437Smav u_int valid; /* Which fields to honor */ 921236437Smav#define CTS_ATA_VALID_TQ 0x01 922236437Smav u_int flags; 923236437Smav#define CTS_ATA_FLAGS_TAG_ENB 0x01 924236437Smav}; 925236437Smav 92674840Skenstruct ccb_trans_settings_spi 92774840Sken{ 92874840Sken u_int valid; /* Which fields to honor */ 92974840Sken#define CTS_SPI_VALID_SYNC_RATE 0x01 93074840Sken#define CTS_SPI_VALID_SYNC_OFFSET 0x02 93174840Sken#define CTS_SPI_VALID_BUS_WIDTH 0x04 93274840Sken#define CTS_SPI_VALID_DISC 0x08 93374840Sken#define CTS_SPI_VALID_PPR_OPTIONS 0x10 93474840Sken u_int flags; 93574840Sken#define CTS_SPI_FLAGS_DISC_ENB 0x01 93639212Sgibbs u_int sync_period; 93739212Sgibbs u_int sync_offset; 93839212Sgibbs u_int bus_width; 93974840Sken u_int ppr_options; 94039212Sgibbs}; 94139212Sgibbs 94278709Smjacobstruct ccb_trans_settings_fc { 94378709Smjacob u_int valid; /* Which fields to honor */ 94478709Smjacob#define CTS_FC_VALID_WWNN 0x8000 94578709Smjacob#define CTS_FC_VALID_WWPN 0x4000 94678709Smjacob#define CTS_FC_VALID_PORT 0x2000 94778709Smjacob#define CTS_FC_VALID_SPEED 0x1000 94878709Smjacob u_int64_t wwnn; /* world wide node name */ 94978709Smjacob u_int64_t wwpn; /* world wide port name */ 95078709Smjacob u_int32_t port; /* 24 bit port id, if known */ 95178709Smjacob u_int32_t bitrate; /* Mbps */ 95278709Smjacob}; 95378709Smjacob 954154593Smjacobstruct ccb_trans_settings_sas { 955154593Smjacob u_int valid; /* Which fields to honor */ 956154593Smjacob#define CTS_SAS_VALID_SPEED 0x1000 957154593Smjacob u_int32_t bitrate; /* Mbps */ 958154593Smjacob}; 959154593Smjacob 960236437Smavstruct ccb_trans_settings_pata { 961198708Smav u_int valid; /* Which fields to honor */ 962198708Smav#define CTS_ATA_VALID_MODE 0x01 963199747Smav#define CTS_ATA_VALID_BYTECOUNT 0x02 964203376Smav#define CTS_ATA_VALID_ATAPI 0x20 965249199Smarius#define CTS_ATA_VALID_CAPS 0x40 966199821Smav int mode; /* Mode */ 967198708Smav u_int bytecount; /* Length of PIO transaction */ 968203376Smav u_int atapi; /* Length of ATAPI CDB */ 969249199Smarius u_int caps; /* Device and host SATA caps. */ 970249199Smarius#define CTS_ATA_CAPS_H 0x0000ffff 971249199Smarius#define CTS_ATA_CAPS_H_DMA48 0x00000001 /* 48-bit DMA */ 972249199Smarius#define CTS_ATA_CAPS_D 0xffff0000 973198708Smav}; 974198708Smav 975195534Sscottlstruct ccb_trans_settings_sata { 976195534Sscottl u_int valid; /* Which fields to honor */ 977199747Smav#define CTS_SATA_VALID_MODE 0x01 978199747Smav#define CTS_SATA_VALID_BYTECOUNT 0x02 979199747Smav#define CTS_SATA_VALID_REVISION 0x04 980199747Smav#define CTS_SATA_VALID_PM 0x08 981199747Smav#define CTS_SATA_VALID_TAGS 0x10 982203376Smav#define CTS_SATA_VALID_ATAPI 0x20 983207499Smav#define CTS_SATA_VALID_CAPS 0x40 984199821Smav int mode; /* Legacy PATA mode */ 985199747Smav u_int bytecount; /* Length of PIO transaction */ 986199821Smav int revision; /* SATA revision */ 987195534Sscottl u_int pm_present; /* PM is present (XPT->SIM) */ 988199747Smav u_int tags; /* Number of allowed tags */ 989203376Smav u_int atapi; /* Length of ATAPI CDB */ 990207499Smav u_int caps; /* Device and host SATA caps. */ 991207499Smav#define CTS_SATA_CAPS_H 0x0000ffff 992207499Smav#define CTS_SATA_CAPS_H_PMREQ 0x00000001 993207499Smav#define CTS_SATA_CAPS_H_APST 0x00000002 994207499Smav#define CTS_SATA_CAPS_H_DMAAA 0x00000010 /* Auto-activation */ 995220602Smav#define CTS_SATA_CAPS_H_AN 0x00000020 /* Async. notification */ 996207499Smav#define CTS_SATA_CAPS_D 0xffff0000 997207499Smav#define CTS_SATA_CAPS_D_PMREQ 0x00010000 998207499Smav#define CTS_SATA_CAPS_D_APST 0x00020000 999195534Sscottl}; 1000154593Smjacob 1001301778Simpstruct ccb_trans_settings_nvme 1002301778Simp{ 1003301778Simp u_int valid; /* Which fields to honor */ 1004301778Simp#define CTS_NVME_VALID_SPEC 0x01 1005301778Simp#define CTS_NVME_VALID_CAPS 0x02 1006335166Smav#define CTS_NVME_VALID_LINK 0x04 1007335166Smav uint32_t spec; /* NVMe spec implemented -- same as vs register */ 1008335166Smav uint32_t max_xfer; /* Max transfer size (0 -> unlimited */ 1009335166Smav uint32_t caps; 1010335166Smav uint8_t lanes; /* Number of PCIe lanes */ 1011335166Smav uint8_t speed; /* PCIe generation for each lane */ 1012335166Smav uint8_t max_lanes; /* Number of PCIe lanes */ 1013335166Smav uint8_t max_speed; /* PCIe generation for each lane */ 1014335166Smav u_int pad; /* Padding to keep ABI */ 1015301778Simp}; 1016301778Simp 101774840Sken/* Get/Set transfer rate/width/disconnection/tag queueing settings */ 101874840Skenstruct ccb_trans_settings { 101974840Sken struct ccb_hdr ccb_h; 102074840Sken cts_type type; /* Current or User settings */ 102174840Sken cam_proto protocol; 102274840Sken u_int protocol_version; 102374840Sken cam_xport transport; 102474840Sken u_int transport_version; 102574840Sken union { 102674840Sken u_int valid; /* Which fields to honor */ 1027236437Smav struct ccb_trans_settings_ata ata; 102874840Sken struct ccb_trans_settings_scsi scsi; 1029301778Simp struct ccb_trans_settings_nvme nvme; 103074840Sken } proto_specific; 103174840Sken union { 103274840Sken u_int valid; /* Which fields to honor */ 103374840Sken struct ccb_trans_settings_spi spi; 103478709Smjacob struct ccb_trans_settings_fc fc; 1035154593Smjacob struct ccb_trans_settings_sas sas; 1036236437Smav struct ccb_trans_settings_pata ata; 1037195534Sscottl struct ccb_trans_settings_sata sata; 1038301778Simp struct ccb_trans_settings_nvme nvme; 103974840Sken } xport_specific; 104074840Sken}; 104174840Sken 104274840Sken 104339212Sgibbs/* 104439212Sgibbs * Calculate the geometry parameters for a device 104539212Sgibbs * give the block size and volume size in blocks. 104639212Sgibbs */ 104739212Sgibbsstruct ccb_calc_geometry { 104839212Sgibbs struct ccb_hdr ccb_h; 104939212Sgibbs u_int32_t block_size; 1050114261Sken u_int64_t volume_size; 1051114261Sken u_int32_t cylinders; 105239212Sgibbs u_int8_t heads; 105339212Sgibbs u_int8_t secs_per_track; 105439212Sgibbs}; 105539212Sgibbs 105639212Sgibbs/* 1057196008Smjacob * Set or get SIM (and transport) specific knobs 1058196008Smjacob */ 1059196008Smjacob 1060196008Smjacob#define KNOB_VALID_ADDRESS 0x1 1061196008Smjacob#define KNOB_VALID_ROLE 0x2 1062196008Smjacob 1063196008Smjacob 1064196008Smjacob#define KNOB_ROLE_NONE 0x0 1065196008Smjacob#define KNOB_ROLE_INITIATOR 0x1 1066196008Smjacob#define KNOB_ROLE_TARGET 0x2 1067196008Smjacob#define KNOB_ROLE_BOTH 0x3 1068196008Smjacob 1069196008Smjacobstruct ccb_sim_knob_settings_spi { 1070196008Smjacob u_int valid; 1071196008Smjacob u_int initiator_id; 1072196008Smjacob u_int role; 1073196008Smjacob}; 1074196008Smjacob 1075196008Smjacobstruct ccb_sim_knob_settings_fc { 1076196008Smjacob u_int valid; 1077196008Smjacob u_int64_t wwnn; /* world wide node name */ 1078196008Smjacob u_int64_t wwpn; /* world wide port name */ 1079196008Smjacob u_int role; 1080196008Smjacob}; 1081196008Smjacob 1082196008Smjacobstruct ccb_sim_knob_settings_sas { 1083196008Smjacob u_int valid; 1084196008Smjacob u_int64_t wwnn; /* world wide node name */ 1085196008Smjacob u_int role; 1086196008Smjacob}; 1087196008Smjacob#define KNOB_SETTINGS_SIZE 128 1088196008Smjacob 1089196008Smjacobstruct ccb_sim_knob { 1090196008Smjacob struct ccb_hdr ccb_h; 1091196008Smjacob union { 1092196008Smjacob u_int valid; /* Which fields to honor */ 1093196008Smjacob struct ccb_sim_knob_settings_spi spi; 1094196008Smjacob struct ccb_sim_knob_settings_fc fc; 1095196008Smjacob struct ccb_sim_knob_settings_sas sas; 1096196008Smjacob char pad[KNOB_SETTINGS_SIZE]; 1097196008Smjacob } xport_specific; 1098196008Smjacob}; 1099196008Smjacob 1100196008Smjacob/* 110139212Sgibbs * Rescan the given bus, or bus/target/lun 110239212Sgibbs */ 110339212Sgibbsstruct ccb_rescan { 110439212Sgibbs struct ccb_hdr ccb_h; 110539212Sgibbs cam_flags flags; 110639212Sgibbs}; 110739212Sgibbs 110839212Sgibbs/* 110939212Sgibbs * Turn on debugging for the given bus, bus/target, or bus/target/lun. 111039212Sgibbs */ 111139212Sgibbsstruct ccb_debug { 111239212Sgibbs struct ccb_hdr ccb_h; 111339212Sgibbs cam_debug_flags flags; 111439212Sgibbs}; 111539212Sgibbs 111639212Sgibbs/* Target mode structures. */ 111739212Sgibbs 111839212Sgibbsstruct ccb_en_lun { 111939212Sgibbs struct ccb_hdr ccb_h; 112039212Sgibbs u_int16_t grp6_len; /* Group 6 VU CDB length */ 112139212Sgibbs u_int16_t grp7_len; /* Group 7 VU CDB length */ 112239212Sgibbs u_int8_t enable; 112339212Sgibbs}; 112439212Sgibbs 1125196008Smjacob/* old, barely used immediate notify, binary compatibility */ 112639212Sgibbsstruct ccb_immed_notify { 112739212Sgibbs struct ccb_hdr ccb_h; 112839212Sgibbs struct scsi_sense_data sense_data; 112956145Smjacob u_int8_t sense_len; /* Number of bytes in sense buffer */ 113039212Sgibbs u_int8_t initiator_id; /* Id of initiator that selected */ 113139212Sgibbs u_int8_t message_args[7]; /* Message Arguments */ 113239212Sgibbs}; 113339212Sgibbs 113439212Sgibbsstruct ccb_notify_ack { 113539212Sgibbs struct ccb_hdr ccb_h; 113639212Sgibbs u_int16_t seq_id; /* Sequence identifier */ 113739212Sgibbs u_int8_t event; /* Event flags */ 113839212Sgibbs}; 113939212Sgibbs 1140196008Smjacobstruct ccb_immediate_notify { 1141196008Smjacob struct ccb_hdr ccb_h; 1142196008Smjacob u_int tag_id; /* Tag for immediate notify */ 1143196008Smjacob u_int seq_id; /* Tag for target of notify */ 1144196008Smjacob u_int initiator_id; /* Initiator Identifier */ 1145196008Smjacob u_int arg; /* Function specific */ 1146196008Smjacob}; 1147196008Smjacob 1148196008Smjacobstruct ccb_notify_acknowledge { 1149196008Smjacob struct ccb_hdr ccb_h; 1150196008Smjacob u_int tag_id; /* Tag for immediate notify */ 1151196008Smjacob u_int seq_id; /* Tar for target of notify */ 1152196008Smjacob u_int initiator_id; /* Initiator Identifier */ 1153300293Smav u_int arg; /* Response information */ 1154300293Smav /* 1155300293Smav * Lower byte of arg is one of RESPONSE CODE values defined below 1156300293Smav * (subset of response codes from SPL-4 and FCP-4 specifications), 1157300293Smav * upper 3 bytes is code-specific ADDITIONAL RESPONSE INFORMATION. 1158300293Smav */ 1159300293Smav#define CAM_RSP_TMF_COMPLETE 0x00 1160300293Smav#define CAM_RSP_TMF_REJECTED 0x04 1161300293Smav#define CAM_RSP_TMF_FAILED 0x05 1162300293Smav#define CAM_RSP_TMF_SUCCEEDED 0x08 1163300293Smav#define CAM_RSP_TMF_INCORRECT_LUN 0x09 1164196008Smjacob}; 1165196008Smjacob 116639212Sgibbs/* HBA engine structures. */ 116739212Sgibbs 116839212Sgibbstypedef enum { 116939212Sgibbs EIT_BUFFER, /* Engine type: buffer memory */ 117039212Sgibbs EIT_LOSSLESS, /* Engine type: lossless compression */ 117139212Sgibbs EIT_LOSSY, /* Engine type: lossy compression */ 117239212Sgibbs EIT_ENCRYPT /* Engine type: encryption */ 117339212Sgibbs} ei_type; 117439212Sgibbs 117539212Sgibbstypedef enum { 117639212Sgibbs EAD_VUNIQUE, /* Engine algorithm ID: vendor unique */ 117739212Sgibbs EAD_LZ1V1, /* Engine algorithm ID: LZ1 var.1 */ 117839212Sgibbs EAD_LZ2V1, /* Engine algorithm ID: LZ2 var.1 */ 117953258Sken EAD_LZ2V2 /* Engine algorithm ID: LZ2 var.2 */ 118039212Sgibbs} ei_algo; 118139212Sgibbs 118239212Sgibbsstruct ccb_eng_inq { 118339212Sgibbs struct ccb_hdr ccb_h; 118439212Sgibbs u_int16_t eng_num; /* The engine number for this inquiry */ 118539212Sgibbs ei_type eng_type; /* Returned engine type */ 118639212Sgibbs ei_algo eng_algo; /* Returned engine algorithm type */ 118739212Sgibbs u_int32_t eng_memeory; /* Returned engine memory size */ 118839212Sgibbs}; 118939212Sgibbs 119039212Sgibbsstruct ccb_eng_exec { /* This structure must match SCSIIO size */ 119139212Sgibbs struct ccb_hdr ccb_h; 119239212Sgibbs u_int8_t *pdrv_ptr; /* Ptr used by the peripheral driver */ 119339212Sgibbs u_int8_t *req_map; /* Ptr for mapping info on the req. */ 119439212Sgibbs u_int8_t *data_ptr; /* Pointer to the data buf/SG list */ 119539212Sgibbs u_int32_t dxfer_len; /* Data transfer length */ 119639212Sgibbs u_int8_t *engdata_ptr; /* Pointer to the engine buffer data */ 119739212Sgibbs u_int16_t sglist_cnt; /* Num of scatter gather list entries */ 119839212Sgibbs u_int32_t dmax_len; /* Destination data maximum length */ 119939212Sgibbs u_int32_t dest_len; /* Destination data length */ 120039212Sgibbs int32_t src_resid; /* Source residual length: 2's comp */ 120139212Sgibbs u_int32_t timeout; /* Timeout value */ 120239212Sgibbs u_int16_t eng_num; /* Engine number for this request */ 120339212Sgibbs u_int16_t vu_flags; /* Vendor Unique flags */ 120439212Sgibbs}; 120539212Sgibbs 120639212Sgibbs/* 120739212Sgibbs * Definitions for the timeout field in the SCSI I/O CCB. 120839212Sgibbs */ 120939212Sgibbs#define CAM_TIME_DEFAULT 0x00000000 /* Use SIM default value */ 121039212Sgibbs#define CAM_TIME_INFINITY 0xFFFFFFFF /* Infinite timeout */ 121139212Sgibbs 121239212Sgibbs#define CAM_SUCCESS 0 /* For signaling general success */ 121339212Sgibbs#define CAM_FAILURE 1 /* For signaling general failure */ 121439212Sgibbs 121539212Sgibbs#define CAM_FALSE 0 121639212Sgibbs#define CAM_TRUE 1 121739212Sgibbs 121839212Sgibbs#define XPT_CCB_INVALID -1 /* for signaling a bad CCB to free */ 121939212Sgibbs 122039212Sgibbs/* 1221223081Sgibbs * CCB for working with advanced device information. This operates in a fashion 1222216088Sken * similar to XPT_GDEV_TYPE. Specify the target in ccb_h, the buffer 1223216088Sken * type requested, and provide a buffer size/buffer to write to. If the 1224223081Sgibbs * buffer is too small, provsiz will be larger than bufsiz. 1225216088Sken */ 1226223081Sgibbsstruct ccb_dev_advinfo { 1227216088Sken struct ccb_hdr ccb_h; 1228216088Sken uint32_t flags; 1229278964Sken#define CDAI_FLAG_NONE 0x0 /* No flags set */ 1230223081Sgibbs#define CDAI_FLAG_STORE 0x1 /* If set, action becomes store */ 1231216088Sken uint32_t buftype; /* IN: Type of data being requested */ 1232216088Sken /* NB: buftype is interpreted on a per-transport basis */ 1233223081Sgibbs#define CDAI_TYPE_SCSI_DEVID 1 1234223081Sgibbs#define CDAI_TYPE_SERIAL_NUM 2 1235223081Sgibbs#define CDAI_TYPE_PHYS_PATH 3 1236230590Sken#define CDAI_TYPE_RCAPLONG 4 1237278228Sken#define CDAI_TYPE_EXT_INQ 5 1238328735Smav#define CDAI_TYPE_NVME_CNTRL 6 /* NVMe Identify Controller data */ 1239328735Smav#define CDAI_TYPE_NVME_NS 7 /* NVMe Identify Namespace data */ 1240216088Sken off_t bufsiz; /* IN: Size of external buffer */ 1241216088Sken#define CAM_SCSI_DEVID_MAXLEN 65536 /* length in buffer is an uint16_t */ 1242216088Sken off_t provsiz; /* OUT: Size required/used */ 1243216088Sken uint8_t *buf; /* IN/OUT: Buffer for requested data */ 1244216088Sken}; 1245216088Sken 1246216088Sken/* 1247256843Smav * CCB for sending async events 1248256843Smav */ 1249256843Smavstruct ccb_async { 1250256843Smav struct ccb_hdr ccb_h; 1251256843Smav uint32_t async_code; 1252256843Smav off_t async_arg_size; 1253256843Smav void *async_arg_ptr; 1254256843Smav}; 1255256843Smav 1256256843Smav/* 125739212Sgibbs * Union of all CCB types for kernel space allocation. This union should 125839212Sgibbs * never be used for manipulating CCBs - its only use is for the allocation 125939212Sgibbs * and deallocation of raw CCB space and is the return type of xpt_ccb_alloc 126039212Sgibbs * and the argument to xpt_ccb_free. 126139212Sgibbs */ 126239212Sgibbsunion ccb { 126339212Sgibbs struct ccb_hdr ccb_h; /* For convenience */ 126439212Sgibbs struct ccb_scsiio csio; 126539212Sgibbs struct ccb_getdev cgd; 126639212Sgibbs struct ccb_getdevlist cgdl; 126739212Sgibbs struct ccb_pathinq cpi; 126839212Sgibbs struct ccb_relsim crs; 126939212Sgibbs struct ccb_setasync csa; 127039212Sgibbs struct ccb_setdev csd; 127147412Sgibbs struct ccb_pathstats cpis; 127247412Sgibbs struct ccb_getdevstats cgds; 127339212Sgibbs struct ccb_dev_match cdm; 127439212Sgibbs struct ccb_trans_settings cts; 127539212Sgibbs struct ccb_calc_geometry ccg; 1276196008Smjacob struct ccb_sim_knob knob; 127739212Sgibbs struct ccb_abort cab; 127839212Sgibbs struct ccb_resetbus crb; 127939212Sgibbs struct ccb_resetdev crd; 128039212Sgibbs struct ccb_termio tio; 128139212Sgibbs struct ccb_accept_tio atio; 128239212Sgibbs struct ccb_scsiio ctio; 128339212Sgibbs struct ccb_en_lun cel; 128439212Sgibbs struct ccb_immed_notify cin; 128539212Sgibbs struct ccb_notify_ack cna; 1286196008Smjacob struct ccb_immediate_notify cin1; 1287196008Smjacob struct ccb_notify_acknowledge cna2; 128839212Sgibbs struct ccb_eng_inq cei; 128939212Sgibbs struct ccb_eng_exec cee; 1290216088Sken struct ccb_smpio smpio; 129139212Sgibbs struct ccb_rescan crcn; 129239212Sgibbs struct ccb_debug cdbg; 1293195534Sscottl struct ccb_ataio ataio; 1294223081Sgibbs struct ccb_dev_advinfo cdai; 1295256843Smav struct ccb_async casync; 1296301771Simp struct ccb_nvmeio nvmeio; 129739212Sgibbs}; 129839212Sgibbs 1299300547Struckman#define CCB_CLEAR_ALL_EXCEPT_HDR(ccbp) \ 1300300547Struckman bzero((char *)(ccbp) + sizeof((ccbp)->ccb_h), \ 1301300547Struckman sizeof(*(ccbp)) - sizeof((ccbp)->ccb_h)) 1302300547Struckman 130339212Sgibbs__BEGIN_DECLS 130439212Sgibbsstatic __inline void 130539212Sgibbscam_fill_csio(struct ccb_scsiio *csio, u_int32_t retries, 130639212Sgibbs void (*cbfcnp)(struct cam_periph *, union ccb *), 130739212Sgibbs u_int32_t flags, u_int8_t tag_action, 130839212Sgibbs u_int8_t *data_ptr, u_int32_t dxfer_len, 130939212Sgibbs u_int8_t sense_len, u_int8_t cdb_len, 131039212Sgibbs u_int32_t timeout); 131139212Sgibbs 131239212Sgibbsstatic __inline void 1313301771Simpcam_fill_nvmeio(struct ccb_nvmeio *nvmeio, u_int32_t retries, 1314301771Simp void (*cbfcnp)(struct cam_periph *, union ccb *), 1315301771Simp u_int32_t flags, u_int8_t *data_ptr, u_int32_t dxfer_len, 1316301771Simp u_int32_t timeout); 1317301771Simp 1318301771Simpstatic __inline void 131939212Sgibbscam_fill_ctio(struct ccb_scsiio *csio, u_int32_t retries, 132039212Sgibbs void (*cbfcnp)(struct cam_periph *, union ccb *), 132139212Sgibbs u_int32_t flags, u_int tag_action, u_int tag_id, 132239212Sgibbs u_int init_id, u_int scsi_status, u_int8_t *data_ptr, 132339212Sgibbs u_int32_t dxfer_len, u_int32_t timeout); 1324195534Sscottl 132539212Sgibbsstatic __inline void 1326195534Sscottlcam_fill_ataio(struct ccb_ataio *ataio, u_int32_t retries, 1327195534Sscottl void (*cbfcnp)(struct cam_periph *, union ccb *), 1328195534Sscottl u_int32_t flags, u_int tag_action, 1329195534Sscottl u_int8_t *data_ptr, u_int32_t dxfer_len, 1330195534Sscottl u_int32_t timeout); 1331195534Sscottl 1332195534Sscottlstatic __inline void 1333216088Skencam_fill_smpio(struct ccb_smpio *smpio, uint32_t retries, 1334216088Sken void (*cbfcnp)(struct cam_periph *, union ccb *), uint32_t flags, 1335216088Sken uint8_t *smp_request, int smp_request_len, 1336216088Sken uint8_t *smp_response, int smp_response_len, 1337216088Sken uint32_t timeout); 1338216088Sken 1339216088Skenstatic __inline void 134039212Sgibbscam_fill_csio(struct ccb_scsiio *csio, u_int32_t retries, 134139212Sgibbs void (*cbfcnp)(struct cam_periph *, union ccb *), 134239212Sgibbs u_int32_t flags, u_int8_t tag_action, 134339212Sgibbs u_int8_t *data_ptr, u_int32_t dxfer_len, 134439212Sgibbs u_int8_t sense_len, u_int8_t cdb_len, 134539212Sgibbs u_int32_t timeout) 134639212Sgibbs{ 134739212Sgibbs csio->ccb_h.func_code = XPT_SCSI_IO; 134839212Sgibbs csio->ccb_h.flags = flags; 1349255915Snwhitehorn csio->ccb_h.xflags = 0; 135039212Sgibbs csio->ccb_h.retry_count = retries; 135139212Sgibbs csio->ccb_h.cbfcnp = cbfcnp; 135239212Sgibbs csio->ccb_h.timeout = timeout; 135339212Sgibbs csio->data_ptr = data_ptr; 135439212Sgibbs csio->dxfer_len = dxfer_len; 135539212Sgibbs csio->sense_len = sense_len; 135639212Sgibbs csio->cdb_len = cdb_len; 135739212Sgibbs csio->tag_action = tag_action; 135839212Sgibbs} 135939212Sgibbs 136039212Sgibbsstatic __inline void 136139212Sgibbscam_fill_ctio(struct ccb_scsiio *csio, u_int32_t retries, 136239212Sgibbs void (*cbfcnp)(struct cam_periph *, union ccb *), 136339212Sgibbs u_int32_t flags, u_int tag_action, u_int tag_id, 136439212Sgibbs u_int init_id, u_int scsi_status, u_int8_t *data_ptr, 136539212Sgibbs u_int32_t dxfer_len, u_int32_t timeout) 136639212Sgibbs{ 136739212Sgibbs csio->ccb_h.func_code = XPT_CONT_TARGET_IO; 136839212Sgibbs csio->ccb_h.flags = flags; 1369255915Snwhitehorn csio->ccb_h.xflags = 0; 137039212Sgibbs csio->ccb_h.retry_count = retries; 137139212Sgibbs csio->ccb_h.cbfcnp = cbfcnp; 137239212Sgibbs csio->ccb_h.timeout = timeout; 137339212Sgibbs csio->data_ptr = data_ptr; 137439212Sgibbs csio->dxfer_len = dxfer_len; 137539212Sgibbs csio->scsi_status = scsi_status; 137639212Sgibbs csio->tag_action = tag_action; 137739212Sgibbs csio->tag_id = tag_id; 137839212Sgibbs csio->init_id = init_id; 137939212Sgibbs} 138039212Sgibbs 1381195534Sscottlstatic __inline void 1382195534Sscottlcam_fill_ataio(struct ccb_ataio *ataio, u_int32_t retries, 1383195534Sscottl void (*cbfcnp)(struct cam_periph *, union ccb *), 1384298142Simp u_int32_t flags, u_int tag_action __unused, 1385195534Sscottl u_int8_t *data_ptr, u_int32_t dxfer_len, 1386195534Sscottl u_int32_t timeout) 1387195534Sscottl{ 1388195534Sscottl ataio->ccb_h.func_code = XPT_ATA_IO; 1389195534Sscottl ataio->ccb_h.flags = flags; 1390195534Sscottl ataio->ccb_h.retry_count = retries; 1391195534Sscottl ataio->ccb_h.cbfcnp = cbfcnp; 1392195534Sscottl ataio->ccb_h.timeout = timeout; 1393195534Sscottl ataio->data_ptr = data_ptr; 1394195534Sscottl ataio->dxfer_len = dxfer_len; 1395298142Simp ataio->ata_flags = 0; 1396195534Sscottl} 1397195534Sscottl 1398216088Skenstatic __inline void 1399216088Skencam_fill_smpio(struct ccb_smpio *smpio, uint32_t retries, 1400216088Sken void (*cbfcnp)(struct cam_periph *, union ccb *), uint32_t flags, 1401216088Sken uint8_t *smp_request, int smp_request_len, 1402216088Sken uint8_t *smp_response, int smp_response_len, 1403216088Sken uint32_t timeout) 1404216088Sken{ 1405216088Sken#ifdef _KERNEL 1406216088Sken KASSERT((flags & CAM_DIR_MASK) == CAM_DIR_BOTH, 1407216088Sken ("direction != CAM_DIR_BOTH")); 1408216088Sken KASSERT((smp_request != NULL) && (smp_response != NULL), 1409216088Sken ("need valid request and response buffers")); 1410216088Sken KASSERT((smp_request_len != 0) && (smp_response_len != 0), 1411216088Sken ("need non-zero request and response lengths")); 1412216088Sken#endif /*_KERNEL*/ 1413216088Sken smpio->ccb_h.func_code = XPT_SMP_IO; 1414216088Sken smpio->ccb_h.flags = flags; 1415216088Sken smpio->ccb_h.retry_count = retries; 1416216088Sken smpio->ccb_h.cbfcnp = cbfcnp; 1417216088Sken smpio->ccb_h.timeout = timeout; 1418216088Sken smpio->smp_request = smp_request; 1419216088Sken smpio->smp_request_len = smp_request_len; 1420216088Sken smpio->smp_response = smp_response; 1421216088Sken smpio->smp_response_len = smp_response_len; 1422216088Sken} 1423216088Sken 1424252382Sscottlstatic __inline void 1425252382Sscottlcam_set_ccbstatus(union ccb *ccb, cam_status status) 1426252382Sscottl{ 1427252382Sscottl ccb->ccb_h.status &= ~CAM_STATUS_MASK; 1428252382Sscottl ccb->ccb_h.status |= status; 1429252382Sscottl} 1430252382Sscottl 1431252382Sscottlstatic __inline cam_status 1432252382Sscottlcam_ccb_status(union ccb *ccb) 1433252382Sscottl{ 1434252684Sjkim return ((cam_status)(ccb->ccb_h.status & CAM_STATUS_MASK)); 1435252382Sscottl} 1436252382Sscottl 1437116350Snjlvoid cam_calc_geometry(struct ccb_calc_geometry *ccg, int extended); 1438116350Snjl 1439301771Simpstatic __inline void 1440301771Simpcam_fill_nvmeio(struct ccb_nvmeio *nvmeio, u_int32_t retries, 1441301771Simp void (*cbfcnp)(struct cam_periph *, union ccb *), 1442301771Simp u_int32_t flags, u_int8_t *data_ptr, u_int32_t dxfer_len, 1443301771Simp u_int32_t timeout) 1444301771Simp{ 1445301771Simp nvmeio->ccb_h.func_code = XPT_NVME_IO; 1446301771Simp nvmeio->ccb_h.flags = flags; 1447301771Simp nvmeio->ccb_h.retry_count = retries; 1448301771Simp nvmeio->ccb_h.cbfcnp = cbfcnp; 1449301771Simp nvmeio->ccb_h.timeout = timeout; 1450301771Simp nvmeio->data_ptr = data_ptr; 1451301771Simp nvmeio->dxfer_len = dxfer_len; 1452301771Simp} 1453328680Smav 1454328680Smavstatic __inline void 1455328680Smavcam_fill_nvmeadmin(struct ccb_nvmeio *nvmeio, u_int32_t retries, 1456328680Smav void (*cbfcnp)(struct cam_periph *, union ccb *), 1457328680Smav u_int32_t flags, u_int8_t *data_ptr, u_int32_t dxfer_len, 1458328680Smav u_int32_t timeout) 1459328680Smav{ 1460328680Smav nvmeio->ccb_h.func_code = XPT_NVME_ADMIN; 1461328680Smav nvmeio->ccb_h.flags = flags; 1462328680Smav nvmeio->ccb_h.retry_count = retries; 1463328680Smav nvmeio->ccb_h.cbfcnp = cbfcnp; 1464328680Smav nvmeio->ccb_h.timeout = timeout; 1465328680Smav nvmeio->data_ptr = data_ptr; 1466328680Smav nvmeio->dxfer_len = dxfer_len; 1467328680Smav} 146839212Sgibbs__END_DECLS 146939212Sgibbs 147039212Sgibbs#endif /* _CAM_CAM_CCB_H */ 1471