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_int 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 ((lun_id_t)~0)
  48
  49 /*
  50  * Maximum length for a CAM CDB.
  51  */
  52 #define CAM_MAX_CDBLEN 16
  53
  54 /*
  55  * Definition of a CAM peripheral driver entry.  Peripheral drivers instantiate
  56  * one of these for each device they wish to communicate with and pass it into
  57  * the xpt layer when they wish to schedule work on that device via the
  58  * xpt_schedule API.
  59  */
  60 struct cam_periph;
  61
  62 /*
  63  * Priority information for a CAM structure.  The generation number is
  64  * incremented everytime a new entry is entered into the queue giving round
  65  * robin per priority level scheduling.
  66  */
  67 typedef struct {
  68         u_int32_t priority;
  69 #define CAM_PRIORITY_DEV        0
  70 #define CAM_PRIORITY_NORMAL     1
  71 #define CAM_PRIORITY_NONE       (u_int32_t)-1
  72         u_int32_t generation;
  73         int       index;
  74 #define CAM_UNQUEUED_INDEX      -1
  75 #define CAM_ACTIVE_INDEX        -2
  76 #define CAM_DONEQ_INDEX         -3
  77 } cam_pinfo;
  78
  79 /*
  80  * Macro to compare two generation numbers.  It is used like this:
  81  *
  82  *      if (GENERATIONCMP(a, >=, b))
  83  *              ...;
  84  *
  85  * GERERATIONCMP uses modular arithmetic to guard against wraps
  86  * wraps in the generation number.
  87  */
  88 #define GENERATIONCMP(x, op, y) ((int32_t)((x) - (y)) op 0)
  89
  90 /* CAM flags XXX Move to cam_periph.h ??? */
  91 typedef enum {
  92         CAM_FLAG_NONE           = 0x00,
  93         CAM_EXPECT_INQ_CHANGE   = 0x01,
  94         CAM_RETRY_SELTO         = 0x02 /* Retry Selection Timeouts */
  95 } cam_flags;
  96
  97 /* CAM  Status field values */
  98 typedef enum {
  99         CAM_REQ_INPROG,         /* CCB request is in progress */
 100         CAM_REQ_CMP,            /* CCB request completed without error */
 101         CAM_REQ_ABORTED,        /* CCB request aborted by the host */
 102         CAM_UA_ABORT,           /* Unable to abort CCB request */
 103         CAM_REQ_CMP_ERR,        /* CCB request completed with an error */
 104         CAM_BUSY,               /* CAM subsystem is busy */
 105         CAM_REQ_INVALID,        /* CCB request was invalid */
 106         CAM_PATH_INVALID,       /* Supplied Path ID is invalid */
 107         CAM_DEV_NOT_THERE,      /* SCSI Device Not Installed/there */
 108         CAM_UA_TERMIO,          /* Unable to terminate I/O CCB request */
 109         CAM_SEL_TIMEOUT,        /* Target Selection Timeout */
 110         CAM_CMD_TIMEOUT,        /* Command timeout */
 111         CAM_SCSI_STATUS_ERROR,  /* SCSI error, look at error code in CCB */
 112         CAM_MSG_REJECT_REC,     /* Message Reject Received */
 113         CAM_SCSI_BUS_RESET,     /* SCSI Bus Reset Sent/Received */
 114         CAM_UNCOR_PARITY,       /* Uncorrectable parity error occurred */
 115         CAM_AUTOSENSE_FAIL = 0x10,/* Autosense: request sense cmd fail */
 116         CAM_NO_HBA,             /* No HBA Detected error */
 117         CAM_DATA_RUN_ERR,       /* Data Overrun error */
 118         CAM_UNEXP_BUSFREE,      /* Unexpected Bus Free */
 119         CAM_SEQUENCE_FAIL,      /* Target Bus Phase Sequence Failure */
 120         CAM_CCB_LEN_ERR,        /* CCB length supplied is inadequate */
 121         CAM_PROVIDE_FAIL,       /* Unable to provide requested capability */
 122         CAM_BDR_SENT,           /* A SCSI BDR msg was sent to target */
 123         CAM_REQ_TERMIO,         /* CCB request terminated by the host */
 124         CAM_UNREC_HBA_ERROR,    /* Unrecoverable Host Bus Adapter Error */
 125         CAM_REQ_TOO_BIG,        /* The request was too large for this host */
 126         CAM_REQUEUE_REQ,        /*
 127                                  * This request should be requeued to preserve
 128                                  * transaction ordering.  This typically occurs
 129                                  * when the SIM recognizes an error that should
 130                                  * freeze the queue and must place additional
 131                                  * requests for the target at the sim level
 132                                  * back into the XPT queue.
 133                                  */
 134         CAM_ATA_STATUS_ERROR,   /* ATA error, look at error code in CCB */
 135         CAM_SCSI_IT_NEXUS_LOST, /* Initiator/Target Nexus lost. */
 136         CAM_IDE = 0x33,         /* Initiator Detected Error */
 137         CAM_RESRC_UNAVAIL,      /* Resource Unavailable */
 138         CAM_UNACKED_EVENT,      /* Unacknowledged Event by Host */
 139         CAM_MESSAGE_RECV,       /* Message Received in Host Target Mode */
 140         CAM_INVALID_CDB,        /* Invalid CDB received in Host Target Mode */
 141         CAM_LUN_INVALID,        /* Lun supplied is invalid */
 142         CAM_TID_INVALID,        /* Target ID supplied is invalid */
 143         CAM_FUNC_NOTAVAIL,      /* The requested function is not available */
 144         CAM_NO_NEXUS,           /* Nexus is not established */
 145         CAM_IID_INVALID,        /* The initiator ID is invalid */
 146         CAM_CDB_RECVD,          /* The SCSI CDB has been received */
 147         CAM_LUN_ALRDY_ENA,      /* The LUN is already enabled for target mode */
 148         CAM_SCSI_BUSY,          /* SCSI Bus Busy */
 149
 150         CAM_DEV_QFRZN = 0x40,   /* The DEV queue is frozen w/this err */
 151
 152                                 /* Autosense data valid for target */
 153         CAM_AUTOSNS_VALID = 0x80,
 154         CAM_RELEASE_SIMQ = 0x100,/* SIM ready to take more commands */
 155         CAM_SIM_QUEUED   = 0x200,/* SIM has this command in it's queue */
 156
 157         CAM_STATUS_MASK = 0x3F, /* Mask bits for just the status # */
 158
 159                                 /* Target Specific Adjunct Status */
 160         CAM_SENT_SENSE = 0x40000000     /* sent sense with status */
 161 } cam_status;
 162
 163 typedef enum {
 164         CAM_ESF_NONE            = 0x00,
 165         CAM_ESF_COMMAND         = 0x01,
 166         CAM_ESF_CAM_STATUS      = 0x02,
 167         CAM_ESF_PROTO_STATUS    = 0x04,
 168         CAM_ESF_ALL             = 0xff
 169 } cam_error_string_flags;
 170
 171 typedef enum {
 172         CAM_EPF_NONE            = 0x00,
 173         CAM_EPF_MINIMAL         = 0x01,
 174         CAM_EPF_NORMAL          = 0x02,
 175         CAM_EPF_ALL             = 0x03,
 176         CAM_EPF_LEVEL_MASK      = 0x0f
 177         /* All bits above bit 3 are protocol-specific */
 178 } cam_error_proto_flags;
 179
 180 typedef enum {
 181         CAM_ESF_PRINT_NONE      = 0x00,
 182         CAM_ESF_PRINT_STATUS    = 0x10,
 183         CAM_ESF_PRINT_SENSE     = 0x20
 184 } cam_error_scsi_flags;
 185
 186 struct cam_status_entry
 187 {
 188         cam_status  status_code;
 189         const char *status_text;
 190 };
 191
 192 extern const struct cam_status_entry cam_status_table[];
 193 extern const int num_cam_status_entries;
 194 union ccb;
 195
 196 #ifdef SYSCTL_DECL      /* from sysctl.h */
 197 SYSCTL_DECL(_kern_cam);
 198 #endif
 199
 200 __BEGIN_DECLS
 201 typedef int (cam_quirkmatch_t)(caddr_t, caddr_t);
 202
 203 caddr_t cam_quirkmatch(caddr_t target, caddr_t quirk_table, int num_entries,
 204                        int entry_size, cam_quirkmatch_t *comp_func);
 205
 206 void    cam_strvis(u_int8_t *dst, const u_int8_t *src, int srclen, int dstlen);
 207
 208 int     cam_strmatch(const u_int8_t *str, const u_int8_t *pattern, int str_len);
 209 const struct cam_status_entry*
 210         cam_fetch_status_entry(cam_status status);
 211 #ifdef _KERNEL
 212 char *  cam_error_string(union ccb *ccb, char *str, int str_len,
 213                          cam_error_string_flags flags,
 214                          cam_error_proto_flags proto_flags);
 215 void    cam_error_print(union ccb *ccb, cam_error_string_flags flags,
 216                         cam_error_proto_flags proto_flags);
 217 #else /* _KERNEL */
 218 struct cam_device;
 219
 220 char *  cam_error_string(struct cam_device *device, union ccb *ccb, char *str,
 221                          int str_len, cam_error_string_flags flags,
 222                          cam_error_proto_flags proto_flags);
 223 void    cam_error_print(struct cam_device *device, union ccb *ccb,
 224                         cam_error_string_flags flags,
 225                         cam_error_proto_flags proto_flags, FILE *ofile);
 226 #endif /* _KERNEL */
 227 __END_DECLS
 228
 229 #ifdef _KERNEL
 230 static __inline void cam_init_pinfo(cam_pinfo *pinfo);
 231
 232 static __inline void cam_init_pinfo(cam_pinfo *pinfo)
 233 {
 234         pinfo->priority = CAM_PRIORITY_NONE;
 235         pinfo->index = CAM_UNQUEUED_INDEX;
 236 }
 237 #endif
 238
 239 #endif /* _CAM_CAM_H */