sys/cam/cam.h

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