sys/cam/cam.c

   1 /*-
   2  * Generic utility routines for the Common Access Method layer.
   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
  29 #include <sys/cdefs.h>
  30 __FBSDID("$FreeBSD$");
  31
  32 #include <sys/param.h>
  33 #ifdef _KERNEL
  34 #include <sys/systm.h>
  35 #include <sys/kernel.h>
  36 #include <sys/sysctl.h>
  37 #else /* _KERNEL */
  38 #include <stdlib.h>
  39 #include <stdio.h>
  40 #include <camlib.h>
  41 #endif /* _KERNEL */
  42
  43 #include <cam/cam.h>
  44 #include <cam/cam_ccb.h>
  45 #include <cam/scsi/scsi_all.h>
  46 #include <sys/sbuf.h>
  47
  48 #ifdef _KERNEL
  49 #include <sys/libkern.h>
  50 #include <cam/cam_queue.h>
  51 #include <cam/cam_xpt.h>
  52 #endif
  53
  54 static int      camstatusentrycomp(const void *key, const void *member);
  55
  56 const struct cam_status_entry cam_status_table[] = {
  57         { CAM_REQ_INPROG,        "CCB request is in progress"                },
  58         { CAM_REQ_CMP,           "CCB request completed without error"       },
  59         { CAM_REQ_ABORTED,       "CCB request aborted by the host"           },
  60         { CAM_UA_ABORT,          "Unable to abort CCB request"               },
  61         { CAM_REQ_CMP_ERR,       "CCB request completed with an error"       },
  62         { CAM_BUSY,              "CAM subsytem is busy"                      },
  63         { CAM_REQ_INVALID,       "CCB request was invalid"                   },
  64         { CAM_PATH_INVALID,      "Supplied Path ID is invalid"               },
  65         { CAM_DEV_NOT_THERE,     "Device Not Present"                        },
  66         { CAM_UA_TERMIO,         "Unable to terminate I/O CCB request"       },
  67         { CAM_SEL_TIMEOUT,       "Selection Timeout"                         },
  68         { CAM_CMD_TIMEOUT,       "Command timeout"                           },
  69         { CAM_SCSI_STATUS_ERROR, "SCSI Status Error"                         },
  70         { CAM_MSG_REJECT_REC,    "Message Reject Reveived"                   },
  71         { CAM_SCSI_BUS_RESET,    "SCSI Bus Reset Sent/Received"              },
  72         { CAM_UNCOR_PARITY,      "Uncorrectable parity/CRC error"            },
  73         { CAM_AUTOSENSE_FAIL,    "Auto-Sense Retrieval Failed"               },
  74         { CAM_NO_HBA,            "No HBA Detected"                           },
  75         { CAM_DATA_RUN_ERR,      "Data Overrun error"                        },
  76         { CAM_UNEXP_BUSFREE,     "Unexpected Bus Free"                       },
  77         { CAM_SEQUENCE_FAIL,     "Target Bus Phase Sequence Failure"         },
  78         { CAM_CCB_LEN_ERR,       "CCB length supplied is inadequate"         },
  79         { CAM_PROVIDE_FAIL,      "Unable to provide requested capability"    },
  80         { CAM_BDR_SENT,          "SCSI BDR Message Sent"                     },
  81         { CAM_REQ_TERMIO,        "CCB request terminated by the host"        },
  82         { CAM_UNREC_HBA_ERROR,   "Unrecoverable Host Bus Adapter Error"      },
  83         { CAM_REQ_TOO_BIG,       "The request was too large for this host"   },
  84         { CAM_REQUEUE_REQ,       "Unconditionally Re-queue Request",         },
  85         { CAM_ATA_STATUS_ERROR,  "ATA Status Error"                          },
  86         { CAM_IDE,               "Initiator Detected Error Message Received" },
  87         { CAM_RESRC_UNAVAIL,     "Resource Unavailable"                      },
  88         { CAM_UNACKED_EVENT,     "Unacknowledged Event by Host"              },
  89         { CAM_MESSAGE_RECV,      "Message Received in Host Target Mode"      },
  90         { CAM_INVALID_CDB,       "Invalid CDB received in Host Target Mode"  },
  91         { CAM_LUN_INVALID,       "Invalid Lun"                               },
  92         { CAM_TID_INVALID,       "Invalid Target ID"                         },
  93         { CAM_FUNC_NOTAVAIL,     "Function Not Available"                    },
  94         { CAM_NO_NEXUS,          "Nexus Not Established"                     },
  95         { CAM_IID_INVALID,       "Invalid Initiator ID"                      },
  96         { CAM_CDB_RECVD,         "CDB Received"                              },
  97         { CAM_LUN_ALRDY_ENA,     "LUN Already Enabled for Target Mode"       },
  98         { CAM_SCSI_BUSY,         "SCSI Bus Busy"                             },
  99 };
 100
 101 const int num_cam_status_entries =
 102     sizeof(cam_status_table)/sizeof(*cam_status_table);
 103
 104 #ifdef _KERNEL
 105 SYSCTL_NODE(_kern, OID_AUTO, cam, CTLFLAG_RD, 0, "CAM Subsystem");
 106 #endif
 107
 108 void
 109 cam_strvis(u_int8_t *dst, const u_int8_t *src, int srclen, int dstlen)
 110 {
 111
 112         /* Trim leading/trailing spaces, nulls. */
 113         while (srclen > 0 && src[0] == ' ')
 114                 src++, srclen--;
 115         while (srclen > 0
 116             && (src[srclen-1] == ' ' || src[srclen-1] == '\0'))
 117                 srclen--;
 118
 119         while (srclen > 0 && dstlen > 1) {
 120                 u_int8_t *cur_pos = dst;
 121
 122                 if (*src < 0x20 || *src >= 0x80) {
 123                         /* SCSI-II Specifies that these should never occur. */
 124                         /* non-printable character */
 125                         if (dstlen > 4) {
 126                                 *cur_pos++ = '\\';
 127                                 *cur_pos++ = ((*src & 0300) >> 6) + '0';
 128                                 *cur_pos++ = ((*src & 0070) >> 3) + '0';
 129                                 *cur_pos++ = ((*src & 0007) >> 0) + '0';
 130                         } else {
 131                                 *cur_pos++ = '?';
 132                         }
 133                 } else {
 134                         /* normal character */
 135                         *cur_pos++ = *src;
 136                 }
 137                 src++;
 138                 srclen--;
 139                 dstlen -= cur_pos - dst;
 140                 dst = cur_pos;
 141         }
 142         *dst = '\0';
 143 }
 144
 145 /*
 146  * Compare string with pattern, returning 0 on match.
 147  * Short pattern matches trailing blanks in name,
 148  * wildcard '*' in pattern matches rest of name,
 149  * wildcard '?' matches a single non-space character.
 150  */
 151 int
 152 cam_strmatch(const u_int8_t *str, const u_int8_t *pattern, int str_len)
 153 {
 154
 155         while (*pattern != '\0'&& str_len > 0) {
 156
 157                 if (*pattern == '*') {
 158                         return (0);
 159                 }
 160                 if ((*pattern != *str)
 161                  && (*pattern != '?' || *str == ' ')) {
 162                         return (1);
 163                 }
 164                 pattern++;
 165                 str++;
 166                 str_len--;
 167         }
 168         while (str_len > 0 && *str++ == ' ')
 169                 str_len--;
 170
 171         return (str_len);
 172 }
 173
 174 caddr_t
 175 cam_quirkmatch(caddr_t target, caddr_t quirk_table, int num_entries,
 176                int entry_size, cam_quirkmatch_t *comp_func)
 177 {
 178         for (; num_entries > 0; num_entries--, quirk_table += entry_size) {
 179                 if ((*comp_func)(target, quirk_table) == 0)
 180                         return (quirk_table);
 181         }
 182         return (NULL);
 183 }
 184
 185 const struct cam_status_entry*
 186 cam_fetch_status_entry(cam_status status)
 187 {
 188         status &= CAM_STATUS_MASK;
 189         return (bsearch(&status, &cam_status_table,
 190                         num_cam_status_entries,
 191                         sizeof(*cam_status_table),
 192                         camstatusentrycomp));
 193 }
 194
 195 static int
 196 camstatusentrycomp(const void *key, const void *member)
 197 {
 198         cam_status status;
 199         const struct cam_status_entry *table_entry;
 200
 201         status = *(const cam_status *)key;
 202         table_entry = (const struct cam_status_entry *)member;
 203
 204         return (status - table_entry->status_code);
 205 }
 206
 207
 208 #ifdef _KERNEL
 209 char *
 210 cam_error_string(union ccb *ccb, char *str, int str_len,
 211                  cam_error_string_flags flags,
 212                  cam_error_proto_flags proto_flags)
 213 #else /* !_KERNEL */
 214 char *
 215 cam_error_string(struct cam_device *device, union ccb *ccb, char *str,
 216                  int str_len, cam_error_string_flags flags,
 217                  cam_error_proto_flags proto_flags)
 218 #endif /* _KERNEL/!_KERNEL */
 219 {
 220         char path_str[64];
 221         struct sbuf sb;
 222
 223         if ((ccb == NULL)
 224          || (str == NULL)
 225          || (str_len <= 0))
 226                 return(NULL);
 227
 228         if (flags == CAM_ESF_NONE)
 229                 return(NULL);
 230
 231         switch (ccb->ccb_h.func_code) {
 232                 case XPT_SCSI_IO:
 233                         switch (proto_flags & CAM_EPF_LEVEL_MASK) {
 234                         case CAM_EPF_NONE:
 235                                 break;
 236                         case CAM_EPF_ALL:
 237                         case CAM_EPF_NORMAL:
 238                                 proto_flags |= CAM_ESF_PRINT_SENSE;
 239                                 /* FALLTHROUGH */
 240                         case CAM_EPF_MINIMAL:
 241                                 proto_flags |= CAM_ESF_PRINT_STATUS;
 242                                 /* FALLTHROUGH */
 243                         default:
 244                                 break;
 245                         }
 246                         break;
 247                 default:
 248                         break;
 249         }
 250 #ifdef _KERNEL
 251         xpt_path_string(ccb->csio.ccb_h.path, path_str, sizeof(path_str));
 252 #else /* !_KERNEL */
 253         cam_path_string(device, path_str, sizeof(path_str));
 254 #endif /* _KERNEL/!_KERNEL */
 255
 256         sbuf_new(&sb, str, str_len, 0);
 257
 258         if (flags & CAM_ESF_COMMAND) {
 259
 260                 sbuf_cat(&sb, path_str);
 261
 262                 switch (ccb->ccb_h.func_code) {
 263                 case XPT_SCSI_IO:
 264 #ifdef _KERNEL
 265                         scsi_command_string(&ccb->csio, &sb);
 266 #else /* !_KERNEL */
 267                         scsi_command_string(device, &ccb->csio, &sb);
 268 #endif /* _KERNEL/!_KERNEL */
 269                         sbuf_printf(&sb, "\n");
 270
 271                         break;
 272                 default:
 273                         break;
 274                 }
 275         }
 276
 277         if (flags & CAM_ESF_CAM_STATUS) {
 278                 cam_status status;
 279                 const struct cam_status_entry *entry;
 280
 281                 sbuf_cat(&sb, path_str);
 282
 283                 status = ccb->ccb_h.status & CAM_STATUS_MASK;
 284
 285                 entry = cam_fetch_status_entry(status);
 286
 287                 if (entry == NULL)
 288                         sbuf_printf(&sb, "CAM Status: Unknown (%#x)\n",
 289                                     ccb->ccb_h.status);
 290                 else
 291                         sbuf_printf(&sb, "CAM Status: %s\n",
 292                                     entry->status_text);
 293         }
 294
 295         if (flags & CAM_ESF_PROTO_STATUS) {
 296
 297                 switch (ccb->ccb_h.func_code) {
 298                 case XPT_SCSI_IO:
 299                         if ((ccb->ccb_h.status & CAM_STATUS_MASK) !=
 300                              CAM_SCSI_STATUS_ERROR)
 301                                 break;
 302
 303                         if (proto_flags & CAM_ESF_PRINT_STATUS) {
 304                                 sbuf_cat(&sb, path_str);
 305                                 /*
 306                                  * Print out the SCSI status byte as long as
 307                                  * the user wants some protocol output.
 308                                  */
 309                                 sbuf_printf(&sb, "SCSI Status: %s\n",
 310                                             scsi_status_string(&ccb->csio));
 311                         }
 312
 313                         if ((proto_flags & CAM_ESF_PRINT_SENSE)
 314                          && (ccb->csio.scsi_status == SCSI_STATUS_CHECK_COND)
 315                          && (ccb->ccb_h.status & CAM_AUTOSNS_VALID)) {
 316
 317 #ifdef _KERNEL
 318                                 scsi_sense_sbuf(&ccb->csio, &sb,
 319                                                 SSS_FLAG_NONE);
 320 #else /* !_KERNEL */
 321                                 scsi_sense_sbuf(device, &ccb->csio, &sb,
 322                                                 SSS_FLAG_NONE);
 323 #endif /* _KERNEL/!_KERNEL */
 324                         }
 325                         break;
 326                 default:
 327                         break;
 328                 }
 329         }
 330
 331         sbuf_finish(&sb);
 332
 333         return(sbuf_data(&sb));
 334 }
 335
 336 #ifdef _KERNEL
 337
 338 void
 339 cam_error_print(union ccb *ccb, cam_error_string_flags flags,
 340                 cam_error_proto_flags proto_flags)
 341 {
 342         char str[512];
 343
 344         printf("%s", cam_error_string(ccb, str, sizeof(str), flags,
 345                proto_flags));
 346 }
 347
 348 #else /* !_KERNEL */
 349
 350 void
 351 cam_error_print(struct cam_device *device, union ccb *ccb,
 352                 cam_error_string_flags flags, cam_error_proto_flags proto_flags,
 353                 FILE *ofile)
 354 {
 355         char str[512];
 356
 357         if ((device == NULL) || (ccb == NULL) || (ofile == NULL))
 358                 return;
 359
 360         fprintf(ofile, "%s", cam_error_string(device, ccb, str, sizeof(str),
 361                 flags, proto_flags));
 362 }
 363
 364 #endif /* _KERNEL/!_KERNEL */
 365
 366 /*
 367  * Common calculate geometry fuction
 368  *
 369  * Caller should set ccg->volume_size and block_size.
 370  * The extended parameter should be zero if extended translation
 371  * should not be used.
 372  */
 373 void
 374 cam_calc_geometry(struct ccb_calc_geometry *ccg, int extended)
 375 {
 376         uint32_t size_mb, secs_per_cylinder;
 377
 378         if (ccg->block_size == 0) {
 379                 ccg->ccb_h.status = CAM_REQ_CMP_ERR;
 380                 return;
 381         }
 382         size_mb = (1024L * 1024L) / ccg->block_size;
 383         if (size_mb == 0) {
 384                 ccg->ccb_h.status = CAM_REQ_CMP_ERR;
 385                 return;
 386         }
 387         size_mb = ccg->volume_size / size_mb;
 388         if (size_mb > 1024 && extended) {
 389                 ccg->heads = 255;
 390                 ccg->secs_per_track = 63;
 391         } else {
 392                 ccg->heads = 64;
 393                 ccg->secs_per_track = 32;
 394         }
 395         secs_per_cylinder = ccg->heads * ccg->secs_per_track;
 396         if (secs_per_cylinder == 0) {
 397                 ccg->ccb_h.status = CAM_REQ_CMP_ERR;
 398                 return;
 399         }
 400         ccg->cylinders = ccg->volume_size / secs_per_cylinder;
 401         ccg->ccb_h.status = CAM_REQ_CMP;
 402 }