sys/cam/cam.h

   1 /*-
   2  * Data structures and definitions for the CAM system.
   3  *
   4  * SPDX-License-Identifier: BSD-2-Clause
   5  *
   6  * Copyright (c) 1997 Justin T. Gibbs.
   7  * All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions, and the following disclaimer,
  14  *    without modification, immediately at the beginning of the file.
  15  * 2. The name of the author may not be used to endorse or promote products
  16  *    derived from this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
  22  * ANY DIRECT, INDIRECT, INCIDENTAL, 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, STRICT
  26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28  * SUCH DAMAGE.
  29  */
  30
  31 #ifndef _CAM_CAM_H
  32 #define _CAM_CAM_H 1
  33
  34 #ifdef _KERNEL
  35 #include "opt_cam.h"
  36 #endif
  37
  38 #ifndef _KERNEL
  39 #include <stdbool.h>
  40 #endif
  41
  42 typedef u_int path_id_t;
  43 typedef u_int target_id_t;
  44 typedef uint64_t lun_id_t;
  45
  46 #define CAM_XPT_PATH_ID ((path_id_t)~0)
  47 #define CAM_BUS_WILDCARD ((path_id_t)~0)
  48 #define CAM_TARGET_WILDCARD ((target_id_t)~0)
  49 #define CAM_LUN_WILDCARD (~(u_int)0)
  50
  51 #define CAM_EXTLUN_BYTE_SWIZZLE(lun) (  \
  52         ((((uint64_t)lun) & 0xffff000000000000L) >> 48) | \
  53         ((((uint64_t)lun) & 0x0000ffff00000000L) >> 16) | \
  54         ((((uint64_t)lun) & 0x00000000ffff0000L) << 16) | \
  55         ((((uint64_t)lun) & 0x000000000000ffffL) << 48))
  56
  57 /*
  58  * Maximum length for a CAM CDB.
  59  */
  60 #define CAM_MAX_CDBLEN 16
  61
  62 /*
  63  * Definition of a CAM peripheral driver entry.  Peripheral drivers instantiate
  64  * one of these for each device they wish to communicate with and pass it into
  65  * the xpt layer when they wish to schedule work on that device via the
  66  * xpt_schedule API.
  67  */
  68 struct cam_periph;
  69
  70 /*
  71  * Priority information for a CAM structure.
  72  */
  73 typedef enum {
  74     CAM_RL_HOST,
  75     CAM_RL_BUS,
  76     CAM_RL_XPT,
  77     CAM_RL_DEV,
  78     CAM_RL_NORMAL,
  79     CAM_RL_VALUES
  80 } cam_rl;
  81 /*
  82  * The generation number is incremented every time a new entry is entered into
  83  * the queue giving round robin per priority level scheduling.
  84  */
  85 typedef struct {
  86         uint32_t priority;
  87 #define CAM_PRIORITY_HOST       ((CAM_RL_HOST << 8) + 0x80)
  88 #define CAM_PRIORITY_BUS        ((CAM_RL_BUS << 8) + 0x80)
  89 #define CAM_PRIORITY_XPT        ((CAM_RL_XPT << 8) + 0x80)
  90 #define CAM_PRIORITY_DEV        ((CAM_RL_DEV << 8) + 0x80)
  91 #define CAM_PRIORITY_OOB        (CAM_RL_DEV << 8)
  92 #define CAM_PRIORITY_NORMAL     ((CAM_RL_NORMAL << 8) + 0x80)
  93 #define CAM_PRIORITY_NONE       (uint32_t)-1
  94         uint32_t generation;
  95         int       index;
  96 #define CAM_UNQUEUED_INDEX      -1
  97 #define CAM_ACTIVE_INDEX        -2
  98 #define CAM_DONEQ_INDEX         -3
  99 #define CAM_ASYNC_INDEX         -4
 100 #define CAM_EXTRAQ_INDEX        INT_MAX
 101 } cam_pinfo;
 102
 103 /*
 104  * Macro to compare two generation numbers.  It is used like this:
 105  *
 106  *      if (GENERATIONCMP(a, >=, b))
 107  *              ...;
 108  *
 109  * GERERATIONCMP uses modular arithmetic to guard against wraps
 110  * wraps in the generation number.
 111  */
 112 #define GENERATIONCMP(x, op, y) ((int32_t)((x) - (y)) op 0)
 113
 114 /* CAM flags XXX Move to cam_periph.h ??? */
 115 typedef enum {
 116         CAM_FLAG_NONE           = 0x00,
 117         CAM_EXPECT_INQ_CHANGE   = 0x01,
 118         CAM_RETRY_SELTO         = 0x02 /* Retry Selection Timeouts */
 119 } cam_flags;
 120
 121 enum {
 122         SF_RETRY_UA             = 0x01, /* Retry UNIT ATTENTION conditions. */
 123         SF_NO_PRINT             = 0x02, /* Never print error status. */
 124         SF_QUIET_IR             = 0x04, /* Be quiet about Illegal Request responses */
 125         SF_PRINT_ALWAYS         = 0x08, /* Always print error status. */
 126         SF_NO_RECOVERY          = 0x10, /* Don't do active error recovery. */
 127         SF_NO_RETRY             = 0x20, /* Don't do any retries. */
 128         SF_RETRY_BUSY           = 0x40  /* Retry BUSY status. */
 129 };
 130
 131 /* CAM  Status field values */
 132 typedef enum {
 133         /* CCB request is in progress */
 134         CAM_REQ_INPROG          = 0x00,
 135
 136         /* CCB request completed without error */
 137         CAM_REQ_CMP             = 0x01,
 138
 139         /* CCB request aborted by the host */
 140         CAM_REQ_ABORTED         = 0x02,
 141
 142         /* Unable to abort CCB request */
 143         CAM_UA_ABORT            = 0x03,
 144
 145         /* CCB request completed with an error */
 146         CAM_REQ_CMP_ERR         = 0x04,
 147
 148         /* CAM subsystem is busy */
 149         CAM_BUSY                = 0x05,
 150
 151         /* CCB request was invalid */
 152         CAM_REQ_INVALID         = 0x06,
 153
 154         /* Supplied Path ID is invalid */
 155         CAM_PATH_INVALID        = 0x07,
 156
 157         /* SCSI Device Not Installed/there */
 158         CAM_DEV_NOT_THERE       = 0x08,
 159
 160         /* Unable to terminate I/O CCB request */
 161         CAM_UA_TERMIO           = 0x09,
 162
 163         /* Target Selection Timeout */
 164         CAM_SEL_TIMEOUT         = 0x0a,
 165
 166         /* Command timeout */
 167         CAM_CMD_TIMEOUT         = 0x0b,
 168
 169         /* SCSI error, look at error code in CCB */
 170         CAM_SCSI_STATUS_ERROR   = 0x0c,
 171
 172         /* Message Reject Received */
 173         CAM_MSG_REJECT_REC      = 0x0d,
 174
 175         /* SCSI Bus Reset Sent/Received */
 176         CAM_SCSI_BUS_RESET      = 0x0e,
 177
 178         /* Uncorrectable parity error occurred */
 179         CAM_UNCOR_PARITY        = 0x0f,
 180
 181         /* Autosense: request sense cmd fail */
 182         CAM_AUTOSENSE_FAIL      = 0x10,
 183
 184         /* No HBA Detected error */
 185         CAM_NO_HBA              = 0x11,
 186
 187         /* Data Overrun error */
 188         CAM_DATA_RUN_ERR        = 0x12,
 189
 190         /* Unexpected Bus Free */
 191         CAM_UNEXP_BUSFREE       = 0x13,
 192
 193         /* Target Bus Phase Sequence Failure */
 194         CAM_SEQUENCE_FAIL       = 0x14,
 195
 196         /* CCB length supplied is inadequate */
 197         CAM_CCB_LEN_ERR         = 0x15,
 198
 199         /* Unable to provide requested capability*/
 200         CAM_PROVIDE_FAIL        = 0x16,
 201
 202         /* A SCSI BDR msg was sent to target */
 203         CAM_BDR_SENT            = 0x17,
 204
 205         /* CCB request terminated by the host */
 206         CAM_REQ_TERMIO          = 0x18,
 207
 208         /* Unrecoverable Host Bus Adapter Error */
 209         CAM_UNREC_HBA_ERROR     = 0x19,
 210
 211         /* Request was too large for this host */
 212         CAM_REQ_TOO_BIG         = 0x1a,
 213
 214         /*
 215          * This request should be requeued to preserve
 216          * transaction ordering.  This typically occurs
 217          * when the SIM recognizes an error that should
 218          * freeze the queue and must place additional
 219          * requests for the target at the sim level
 220          * back into the XPT queue.
 221          */
 222         CAM_REQUEUE_REQ         = 0x1b,
 223
 224         /* ATA error, look at error code in CCB */
 225         CAM_ATA_STATUS_ERROR    = 0x1c,
 226
 227         /* Initiator/Target Nexus lost. */
 228         CAM_SCSI_IT_NEXUS_LOST  = 0x1d,
 229
 230         /* SMP error, look at error code in CCB */
 231         CAM_SMP_STATUS_ERROR    = 0x1e,
 232
 233         /*
 234          * Command completed without error but  exceeded the soft
 235          * timeout threshold.
 236          */
 237         CAM_REQ_SOFTTIMEOUT     = 0x1f,
 238
 239         /*
 240          * NVME error, look at errro code in CCB
 241          */
 242         CAM_NVME_STATUS_ERROR   = 0x20,
 243
 244         /*
 245          * 0x21 - 0x32 are unassigned
 246          */
 247
 248         /* Initiator Detected Error */
 249         CAM_IDE                 = 0x33,
 250
 251         /* Resource Unavailable */
 252         CAM_RESRC_UNAVAIL       = 0x34,
 253
 254         /* Unacknowledged Event by Host */
 255         CAM_UNACKED_EVENT       = 0x35,
 256
 257         /* Message Received in Host Target Mode */
 258         CAM_MESSAGE_RECV        = 0x36,
 259
 260         /* Invalid CDB received in Host Target Mode */
 261         CAM_INVALID_CDB         = 0x37,
 262
 263         /* Lun supplied is invalid */
 264         CAM_LUN_INVALID         = 0x38,
 265
 266         /* Target ID supplied is invalid */
 267         CAM_TID_INVALID         = 0x39,
 268
 269         /* The requested function is not available */
 270         CAM_FUNC_NOTAVAIL       = 0x3a,
 271
 272         /* Nexus is not established */
 273         CAM_NO_NEXUS            = 0x3b,
 274
 275         /* The initiator ID is invalid */
 276         CAM_IID_INVALID         = 0x3c,
 277
 278         /* The SCSI CDB has been received */
 279         CAM_CDB_RECVD           = 0x3d,
 280
 281         /* The LUN is already enabled for target mode */
 282         CAM_LUN_ALRDY_ENA       = 0x3e,
 283
 284         /* SCSI Bus Busy */
 285         CAM_SCSI_BUSY           = 0x3f,
 286
 287         /*
 288          * Flags
 289          */
 290
 291         /* The DEV queue is frozen w/this err */
 292         CAM_DEV_QFRZN           = 0x40,
 293
 294         /* Autosense data valid for target */
 295         CAM_AUTOSNS_VALID       = 0x80,
 296
 297         /* SIM ready to take more commands */
 298         CAM_RELEASE_SIMQ        = 0x100,
 299
 300         /* SIM has this command in its queue */
 301         CAM_SIM_QUEUED          = 0x200,
 302
 303         /* Quality of service data is valid */
 304         CAM_QOS_VALID           = 0x400,
 305
 306         /* Mask bits for just the status # */
 307         CAM_STATUS_MASK = 0x3F,
 308
 309         /*
 310          * Target Specific Adjunct Status
 311          */
 312
 313         /* sent sense with status */
 314         CAM_SENT_SENSE          = 0x40000000
 315 } cam_status;
 316
 317 typedef enum {
 318         CAM_ESF_NONE            = 0x00,
 319         CAM_ESF_COMMAND         = 0x01,
 320         CAM_ESF_CAM_STATUS      = 0x02,
 321         CAM_ESF_PROTO_STATUS    = 0x04,
 322         CAM_ESF_ALL             = 0xff
 323 } cam_error_string_flags;
 324
 325 typedef enum {
 326         CAM_EPF_NONE            = 0x00,
 327         CAM_EPF_MINIMAL         = 0x01,
 328         CAM_EPF_NORMAL          = 0x02,
 329         CAM_EPF_ALL             = 0x03,
 330         CAM_EPF_LEVEL_MASK      = 0x0f
 331         /* All bits above bit 3 are protocol-specific */
 332 } cam_error_proto_flags;
 333
 334 typedef enum {
 335         CAM_ESF_PRINT_NONE      = 0x00,
 336         CAM_ESF_PRINT_STATUS    = 0x10,
 337         CAM_ESF_PRINT_SENSE     = 0x20
 338 } cam_error_scsi_flags;
 339
 340 typedef enum {
 341         CAM_ESMF_PRINT_NONE     = 0x00,
 342         CAM_ESMF_PRINT_STATUS   = 0x10,
 343         CAM_ESMF_PRINT_FULL_CMD = 0x20,
 344 } cam_error_smp_flags;
 345
 346 typedef enum {
 347         CAM_EAF_PRINT_NONE      = 0x00,
 348         CAM_EAF_PRINT_STATUS    = 0x10,
 349         CAM_EAF_PRINT_RESULT    = 0x20
 350 } cam_error_ata_flags;
 351
 352 typedef enum {
 353         CAM_STRVIS_FLAG_NONE            = 0x00,
 354         CAM_STRVIS_FLAG_NONASCII_MASK   = 0x03,
 355         CAM_STRVIS_FLAG_NONASCII_TRIM   = 0x00,
 356         CAM_STRVIS_FLAG_NONASCII_RAW    = 0x01,
 357         CAM_STRVIS_FLAG_NONASCII_SPC    = 0x02,
 358         CAM_STRVIS_FLAG_NONASCII_ESC    = 0x03
 359 } cam_strvis_flags;
 360
 361 struct cam_status_entry
 362 {
 363         cam_status  status_code;
 364         const char *status_text;
 365 };
 366
 367 extern const struct cam_status_entry cam_status_table[];
 368 extern const int num_cam_status_entries;
 369 #ifdef _KERNEL
 370 extern int cam_sort_io_queues;
 371 #endif
 372 union ccb;
 373 struct sbuf;
 374
 375 #ifdef SYSCTL_DECL      /* from sysctl.h */
 376 SYSCTL_DECL(_kern_cam);
 377 #endif
 378
 379 __BEGIN_DECLS
 380 typedef int (cam_quirkmatch_t)(caddr_t, caddr_t);
 381
 382 caddr_t cam_quirkmatch(caddr_t target, caddr_t quirk_table, int num_entries,
 383                        int entry_size, cam_quirkmatch_t *comp_func);
 384
 385 void    cam_strvis(uint8_t *dst, const uint8_t *src, int srclen, int dstlen);
 386 void    cam_strvis_flag(uint8_t *dst, const uint8_t *src, int srclen,
 387                         int dstlen, uint32_t flags);
 388 void    cam_strvis_sbuf(struct sbuf *sb, const uint8_t *src, int srclen,
 389                         uint32_t flags);
 390
 391 int     cam_strmatch(const uint8_t *str, const uint8_t *pattern, int str_len);
 392 const struct cam_status_entry*
 393         cam_fetch_status_entry(cam_status status);
 394 #ifdef _KERNEL
 395 char *  cam_error_string(union ccb *ccb, char *str, int str_len,
 396                          cam_error_string_flags flags,
 397                          cam_error_proto_flags proto_flags);
 398 void    cam_error_print(union ccb *ccb, cam_error_string_flags flags,
 399                         cam_error_proto_flags proto_flags);
 400 #else /* _KERNEL */
 401 struct cam_device;
 402
 403 char *  cam_error_string(struct cam_device *device, union ccb *ccb, char *str,
 404                          int str_len, cam_error_string_flags flags,
 405                          cam_error_proto_flags proto_flags);
 406 void    cam_error_print(struct cam_device *device, union ccb *ccb,
 407                         cam_error_string_flags flags,
 408                         cam_error_proto_flags proto_flags, FILE *ofile);
 409 #endif /* _KERNEL */
 410 __END_DECLS
 411
 412 #ifdef _KERNEL
 413 static __inline void cam_init_pinfo(cam_pinfo *pinfo)
 414 {
 415         pinfo->priority = CAM_PRIORITY_NONE;
 416         pinfo->index = CAM_UNQUEUED_INDEX;
 417 }
 418 #endif
 419
 420 #endif /* _CAM_CAM_H */