The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/cam/cam.h

Version: -  FREEBSD  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-2  -  FREEBSD-11-1  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-4  -  FREEBSD-10-3  -  FREEBSD-10-2  -  FREEBSD-10-1  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-3  -  FREEBSD-9-2  -  FREEBSD-9-1  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-4  -  FREEBSD-8-3  -  FREEBSD-8-2  -  FREEBSD-8-1  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-4  -  FREEBSD-7-3  -  FREEBSD-7-2  -  FREEBSD-7-1  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-4  -  FREEBSD-6-3  -  FREEBSD-6-2  -  FREEBSD-6-1  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-5  -  FREEBSD-5-4  -  FREEBSD-5-3  -  FREEBSD-5-2  -  FREEBSD-5-1  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  linux-2.6  -  linux-2.4.22  -  MK83  -  MK84  -  PLAN9  -  DFBSD  -  NETBSD  -  NETBSD5  -  NETBSD4  -  NETBSD3  -  NETBSD20  -  OPENBSD  -  xnu-517  -  xnu-792  -  xnu-792.6.70  -  xnu-1228  -  xnu-1456.1.26  -  xnu-1699.24.8  -  xnu-2050.18.24  -  OPENSOLARIS  -  minix-3-1-1 
SearchContext: -  none  -  3  -  10 

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

Cache object: b5bb12aad7cc12b4645aefb0d612b3ec


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.