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/scsi/scsi_all.h

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

    1 /*-
    2  * Largely written by Julian Elischer (julian@tfs.com)
    3  * for TRW Financial Systems.
    4  *
    5  * TRW Financial Systems, in accordance with their agreement with Carnegie
    6  * Mellon University, makes this software available to CMU to distribute
    7  * or use in any manner that they see fit as long as this message is kept with
    8  * the software. For this reason TFS also grants any other persons or
    9  * organisations permission to use or modify this software.
   10  *
   11  * TFS supplies this software to be publicly redistributed
   12  * on the understanding that TFS is not responsible for the correct
   13  * functioning of this software in any circumstances.
   14  *
   15  * Ported to run under 386BSD by Julian Elischer (julian@tfs.com) Sept 1992
   16  *
   17  * $FreeBSD: releng/9.1/sys/cam/scsi/scsi_all.h 237327 2012-06-20 16:51:14Z mav $
   18  */
   19 
   20 /*
   21  * SCSI general  interface description
   22  */
   23 
   24 #ifndef _SCSI_SCSI_ALL_H
   25 #define _SCSI_SCSI_ALL_H 1
   26 
   27 #include <sys/cdefs.h>
   28 #include <machine/stdarg.h>
   29 
   30 #ifdef _KERNEL
   31 /*
   32  * This is the number of seconds we wait for devices to settle after a SCSI
   33  * bus reset.
   34  */
   35 extern int scsi_delay;
   36 #endif /* _KERNEL */
   37 
   38 /*
   39  * SCSI command format
   40  */
   41 
   42 /*
   43  * Define dome bits that are in ALL (or a lot of) scsi commands
   44  */
   45 #define SCSI_CTL_LINK           0x01
   46 #define SCSI_CTL_FLAG           0x02
   47 #define SCSI_CTL_VENDOR         0xC0
   48 #define SCSI_CMD_LUN            0xA0    /* these two should not be needed */
   49 #define SCSI_CMD_LUN_SHIFT      5       /* LUN in the cmd is no longer SCSI */
   50 
   51 #define SCSI_MAX_CDBLEN         16      /* 
   52                                          * 16 byte commands are in the 
   53                                          * SCSI-3 spec 
   54                                          */
   55 #if defined(CAM_MAX_CDBLEN) && (CAM_MAX_CDBLEN < SCSI_MAX_CDBLEN)
   56 #error "CAM_MAX_CDBLEN cannot be less than SCSI_MAX_CDBLEN"
   57 #endif
   58 
   59 /* 6byte CDBs special case 0 length to be 256 */
   60 #define SCSI_CDB6_LEN(len)      ((len) == 0 ? 256 : len)
   61 
   62 /*
   63  * This type defines actions to be taken when a particular sense code is
   64  * received.  Right now, these flags are only defined to take up 16 bits,
   65  * but can be expanded in the future if necessary.
   66  */
   67 typedef enum {
   68         SS_NOP      = 0x000000, /* Do nothing */
   69         SS_RETRY    = 0x010000, /* Retry the command */
   70         SS_FAIL     = 0x020000, /* Bail out */
   71         SS_START    = 0x030000, /* Send a Start Unit command to the device,
   72                                  * then retry the original command.
   73                                  */
   74         SS_TUR      = 0x040000, /* Send a Test Unit Ready command to the
   75                                  * device, then retry the original command.
   76                                  */
   77         SS_MASK     = 0xff0000
   78 } scsi_sense_action;
   79 
   80 typedef enum {
   81         SSQ_NONE                = 0x0000,
   82         SSQ_DECREMENT_COUNT     = 0x0100,  /* Decrement the retry count */
   83         SSQ_MANY                = 0x0200,  /* send lots of recovery commands */
   84         SSQ_RANGE               = 0x0400,  /*
   85                                             * This table entry represents the
   86                                             * end of a range of ASCQs that
   87                                             * have identical error actions
   88                                             * and text.
   89                                             */
   90         SSQ_PRINT_SENSE         = 0x0800,
   91         SSQ_MASK                = 0xff00
   92 } scsi_sense_action_qualifier;
   93 
   94 /* Mask for error status values */
   95 #define SS_ERRMASK      0xff
   96 
   97 /* The default, retyable, error action */
   98 #define SS_RDEF         SS_RETRY|SSQ_DECREMENT_COUNT|SSQ_PRINT_SENSE|EIO
   99 
  100 /* The retyable, error action, with table specified error code */
  101 #define SS_RET          SS_RETRY|SSQ_DECREMENT_COUNT|SSQ_PRINT_SENSE
  102 
  103 /* Fatal error action, with table specified error code */
  104 #define SS_FATAL        SS_FAIL|SSQ_PRINT_SENSE
  105 
  106 struct scsi_generic
  107 {
  108         u_int8_t opcode;
  109         u_int8_t bytes[11];
  110 };
  111 
  112 struct scsi_request_sense
  113 {
  114         u_int8_t opcode;
  115         u_int8_t byte2;
  116 #define SRS_DESC        0x01
  117         u_int8_t unused[2];
  118         u_int8_t length;
  119         u_int8_t control;
  120 };
  121 
  122 struct scsi_test_unit_ready
  123 {
  124         u_int8_t opcode;
  125         u_int8_t byte2;
  126         u_int8_t unused[3];
  127         u_int8_t control;
  128 };
  129 
  130 struct scsi_receive_diag {
  131         uint8_t opcode;
  132         uint8_t byte2;
  133 #define SRD_PCV         0x01
  134         uint8_t page_code;
  135         uint8_t length[2]; 
  136         uint8_t control;
  137 };
  138 
  139 struct scsi_send_diag {
  140         uint8_t opcode;
  141         uint8_t byte2;
  142 #define SSD_UNITOFFL                            0x01
  143 #define SSD_DEVOFFL                             0x02
  144 #define SSD_SELFTEST                            0x04
  145 #define SSD_PF                                  0x10
  146 #define SSD_SELF_TEST_CODE_MASK                 0xE0
  147 #define SSD_SELF_TEST_CODE_SHIFT                5
  148 #define         SSD_SELF_TEST_CODE_NONE         0x00
  149 #define         SSD_SELF_TEST_CODE_BG_SHORT     0x01
  150 #define         SSD_SELF_TEST_CODE_BG_EXTENDED  0x02
  151 #define         SSD_SELF_TEST_CODE_BG_ABORT     0x04
  152 #define         SSD_SELF_TEST_CODE_FG_SHORT     0x05
  153 #define         SSD_SELF_TEST_CODE_FG_EXTENDED  0x06
  154         uint8_t reserved;
  155         uint8_t length[2];
  156         uint8_t control;
  157 };
  158 
  159 struct scsi_sense
  160 {
  161         u_int8_t opcode;
  162         u_int8_t byte2;
  163         u_int8_t unused[2];
  164         u_int8_t length;
  165         u_int8_t control;
  166 };
  167 
  168 struct scsi_inquiry
  169 {
  170         u_int8_t opcode;
  171         u_int8_t byte2;
  172 #define SI_EVPD         0x01
  173 #define SI_CMDDT        0x02
  174         u_int8_t page_code;
  175         u_int8_t length[2];
  176         u_int8_t control;
  177 };
  178 
  179 struct scsi_mode_sense_6
  180 {
  181         u_int8_t opcode;
  182         u_int8_t byte2;
  183 #define SMS_DBD                         0x08
  184         u_int8_t page;
  185 #define SMS_PAGE_CODE                   0x3F
  186 #define SMS_VENDOR_SPECIFIC_PAGE        0x00
  187 #define SMS_DISCONNECT_RECONNECT_PAGE   0x02
  188 #define SMS_FORMAT_DEVICE_PAGE          0x03
  189 #define SMS_GEOMETRY_PAGE               0x04
  190 #define SMS_CACHE_PAGE                  0x08
  191 #define SMS_PERIPHERAL_DEVICE_PAGE      0x09
  192 #define SMS_CONTROL_MODE_PAGE           0x0A
  193 #define SMS_PROTO_SPECIFIC_PAGE         0x19
  194 #define SMS_INFO_EXCEPTIONS_PAGE        0x1C
  195 #define SMS_ALL_PAGES_PAGE              0x3F
  196 #define SMS_PAGE_CTRL_MASK              0xC0
  197 #define SMS_PAGE_CTRL_CURRENT           0x00
  198 #define SMS_PAGE_CTRL_CHANGEABLE        0x40
  199 #define SMS_PAGE_CTRL_DEFAULT           0x80
  200 #define SMS_PAGE_CTRL_SAVED             0xC0
  201         u_int8_t subpage;
  202 #define SMS_SUBPAGE_PAGE_0              0x00
  203 #define SMS_SUBPAGE_ALL                 0xff
  204         u_int8_t length;
  205         u_int8_t control;
  206 };
  207 
  208 struct scsi_mode_sense_10
  209 {
  210         u_int8_t opcode;
  211         u_int8_t byte2;         /* same bits as small version */
  212 #define SMS10_LLBAA                     0x10
  213         u_int8_t page;          /* same bits as small version */
  214         u_int8_t subpage;
  215         u_int8_t unused[3];
  216         u_int8_t length[2];
  217         u_int8_t control;
  218 };
  219 
  220 struct scsi_mode_select_6
  221 {
  222         u_int8_t opcode;
  223         u_int8_t byte2;
  224 #define SMS_SP  0x01
  225 #define SMS_PF  0x10
  226         u_int8_t unused[2];
  227         u_int8_t length;
  228         u_int8_t control;
  229 };
  230 
  231 struct scsi_mode_select_10
  232 {
  233         u_int8_t opcode;
  234         u_int8_t byte2;         /* same bits as small version */
  235         u_int8_t unused[5];
  236         u_int8_t length[2];
  237         u_int8_t control;
  238 };
  239 
  240 /*
  241  * When sending a mode select to a tape drive, the medium type must be 0.
  242  */
  243 struct scsi_mode_hdr_6
  244 {
  245         u_int8_t datalen;
  246         u_int8_t medium_type;
  247         u_int8_t dev_specific;
  248         u_int8_t block_descr_len;
  249 };
  250 
  251 struct scsi_mode_hdr_10
  252 {
  253         u_int8_t datalen[2];
  254         u_int8_t medium_type;
  255         u_int8_t dev_specific;
  256         u_int8_t reserved[2];
  257         u_int8_t block_descr_len[2];
  258 };
  259 
  260 struct scsi_mode_block_descr
  261 {
  262         u_int8_t density_code;
  263         u_int8_t num_blocks[3];
  264         u_int8_t reserved;
  265         u_int8_t block_len[3];
  266 };
  267 
  268 struct scsi_per_res_in
  269 {
  270         u_int8_t opcode;
  271         u_int8_t action;
  272 #define SPRI_RK 0x00
  273 #define SPRI_RR 0x01
  274 #define SPRI_RC 0x02
  275 #define SPRI_RS 0x03
  276         u_int8_t reserved[5];
  277         u_int8_t length[2];
  278         u_int8_t control;
  279 };
  280 
  281 struct scsi_per_res_in_header
  282 {
  283         u_int8_t generation[4];
  284         u_int8_t length[4];
  285 };
  286 
  287 struct scsi_per_res_key
  288 {
  289         u_int8_t key[8];
  290 };
  291 
  292 struct scsi_per_res_in_keys
  293 {
  294         struct scsi_per_res_in_header header;
  295         struct scsi_per_res_key keys[0];
  296 };
  297 
  298 struct scsi_per_res_cap
  299 {
  300         uint8_t length[2];
  301         uint8_t flags1;
  302 #define SPRI_CRH        0x10
  303 #define SPRI_SIP_C      0x08
  304 #define SPRI_ATP_C      0x04
  305 #define SPRI_PTPL_C     0x01
  306         uint8_t flags2;
  307 #define SPRI_TMV        0x80
  308 #define SPRI_PTPL_A     0x01
  309         uint8_t type_mask[2];
  310 #define SPRI_TM_WR_EX_AR        0x8000
  311 #define SPRI_TM_EX_AC_RO        0x4000
  312 #define SPRI_TM_WR_EX_RO        0x2000
  313 #define SPRI_TM_EX_AC           0x0800
  314 #define SPRI_TM_WR_EX           0x0200
  315 #define SPRI_TM_EX_AC_AR        0x0001
  316         uint8_t reserved[2];
  317 };
  318 
  319 struct scsi_per_res_in_rsrv_data
  320 {
  321         uint8_t reservation[8];
  322         uint8_t obsolete1[4];
  323         uint8_t reserved;
  324         uint8_t scopetype;
  325 #define SPRT_WE    0x01
  326 #define SPRT_EA    0x03
  327 #define SPRT_WERO  0x05
  328 #define SPRT_EARO  0x06
  329 #define SPRT_WEAR  0x07
  330 #define SPRT_EAAR  0x08
  331         uint8_t obsolete2[2];
  332 };
  333 
  334 struct scsi_per_res_in_rsrv
  335 {
  336         struct scsi_per_res_in_header header;
  337         struct scsi_per_res_in_rsrv_data data;
  338 };
  339 
  340 struct scsi_per_res_out
  341 {
  342         u_int8_t opcode;
  343         u_int8_t action;
  344 #define SPRO_REGISTER           0x00
  345 #define SPRO_RESERVE            0x01
  346 #define SPRO_RELEASE            0x02
  347 #define SPRO_CLEAR              0x03
  348 #define SPRO_PREEMPT            0x04
  349 #define SPRO_PRE_ABO            0x05
  350 #define SPRO_REG_IGNO           0x06
  351 #define SPRO_REG_MOVE           0x07
  352 #define SPRO_ACTION_MASK        0x1f
  353         u_int8_t scope_type;
  354 #define SPR_SCOPE_MASK          0xf0
  355 #define SPR_LU_SCOPE            0x00
  356 #define SPR_TYPE_MASK           0x0f
  357 #define SPR_TYPE_WR_EX          0x01
  358 #define SPR_TYPE_EX_AC          0x03
  359 #define SPR_TYPE_WR_EX_RO       0x05
  360 #define SPR_TYPE_EX_AC_RO       0x06
  361 #define SPR_TYPE_WR_EX_AR       0x07
  362 #define SPR_TYPE_EX_AC_AR       0x08
  363         u_int8_t reserved[2];
  364         u_int8_t length[4];
  365         u_int8_t control;
  366 };
  367 
  368 struct scsi_per_res_out_parms
  369 {
  370         struct scsi_per_res_key res_key;
  371         u_int8_t serv_act_res_key[8];
  372         u_int8_t obsolete1[4];
  373         u_int8_t flags;
  374 #define SPR_SPEC_I_PT           0x08
  375 #define SPR_ALL_TG_PT           0x04
  376 #define SPR_APTPL               0x01
  377         u_int8_t reserved1;
  378         u_int8_t obsolete2[2];
  379 };
  380 
  381 
  382 struct scsi_log_sense
  383 {
  384         u_int8_t opcode;
  385         u_int8_t byte2;
  386 #define SLS_SP                          0x01
  387 #define SLS_PPC                         0x02
  388         u_int8_t page;
  389 #define SLS_PAGE_CODE                   0x3F
  390 #define SLS_ALL_PAGES_PAGE              0x00
  391 #define SLS_OVERRUN_PAGE                0x01
  392 #define SLS_ERROR_WRITE_PAGE            0x02
  393 #define SLS_ERROR_READ_PAGE             0x03
  394 #define SLS_ERROR_READREVERSE_PAGE      0x04
  395 #define SLS_ERROR_VERIFY_PAGE           0x05
  396 #define SLS_ERROR_NONMEDIUM_PAGE        0x06
  397 #define SLS_ERROR_LASTN_PAGE            0x07
  398 #define SLS_SELF_TEST_PAGE              0x10
  399 #define SLS_IE_PAGE                     0x2f
  400 #define SLS_PAGE_CTRL_MASK              0xC0
  401 #define SLS_PAGE_CTRL_THRESHOLD         0x00
  402 #define SLS_PAGE_CTRL_CUMULATIVE        0x40
  403 #define SLS_PAGE_CTRL_THRESH_DEFAULT    0x80
  404 #define SLS_PAGE_CTRL_CUMUL_DEFAULT     0xC0
  405         u_int8_t reserved[2];
  406         u_int8_t paramptr[2];
  407         u_int8_t length[2];
  408         u_int8_t control;
  409 };
  410 
  411 struct scsi_log_select
  412 {
  413         u_int8_t opcode;
  414         u_int8_t byte2;
  415 /*      SLS_SP                          0x01 */
  416 #define SLS_PCR                         0x02
  417         u_int8_t page;
  418 /*      SLS_PAGE_CTRL_MASK              0xC0 */
  419 /*      SLS_PAGE_CTRL_THRESHOLD         0x00 */
  420 /*      SLS_PAGE_CTRL_CUMULATIVE        0x40 */
  421 /*      SLS_PAGE_CTRL_THRESH_DEFAULT    0x80 */
  422 /*      SLS_PAGE_CTRL_CUMUL_DEFAULT     0xC0 */
  423         u_int8_t reserved[4];
  424         u_int8_t length[2];
  425         u_int8_t control;
  426 };
  427 
  428 struct scsi_log_header
  429 {
  430         u_int8_t page;
  431         u_int8_t reserved;
  432         u_int8_t datalen[2];
  433 };
  434 
  435 struct scsi_log_param_header {
  436         u_int8_t param_code[2];
  437         u_int8_t param_control;
  438 #define SLP_LP                          0x01
  439 #define SLP_LBIN                        0x02
  440 #define SLP_TMC_MASK                    0x0C
  441 #define SLP_TMC_ALWAYS                  0x00
  442 #define SLP_TMC_EQUAL                   0x04
  443 #define SLP_TMC_NOTEQUAL                0x08
  444 #define SLP_TMC_GREATER                 0x0C
  445 #define SLP_ETC                         0x10
  446 #define SLP_TSD                         0x20
  447 #define SLP_DS                          0x40
  448 #define SLP_DU                          0x80
  449         u_int8_t param_len;
  450 };
  451 
  452 struct scsi_control_page {
  453         u_int8_t page_code;
  454         u_int8_t page_length;
  455         u_int8_t rlec;
  456 #define SCP_RLEC                        0x01    /*Report Log Exception Cond*/
  457 #define SCP_GLTSD                       0x02    /*Global Logging target
  458                                                   save disable */
  459 #define SCP_DSENSE                      0x04    /*Descriptor Sense */
  460 #define SCP_DPICZ                       0x08    /*Disable Prot. Info Check
  461                                                   if Prot. Field is Zero */
  462 #define SCP_TMF_ONLY                    0x10    /*TM Functions Only*/
  463 #define SCP_TST_MASK                    0xE0    /*Task Set Type Mask*/
  464 #define SCP_TST_ONE                     0x00    /*One Task Set*/
  465 #define SCP_TST_SEPARATE                0x20    /*Separate Task Sets*/
  466         u_int8_t queue_flags;
  467 #define SCP_QUEUE_ALG_MASK              0xF0
  468 #define SCP_QUEUE_ALG_RESTRICTED        0x00
  469 #define SCP_QUEUE_ALG_UNRESTRICTED      0x10
  470 #define SCP_QUEUE_ERR                   0x02    /*Queued I/O aborted for CACs*/
  471 #define SCP_QUEUE_DQUE                  0x01    /*Queued I/O disabled*/
  472         u_int8_t eca_and_aen;
  473 #define SCP_EECA                        0x80    /*Enable Extended CA*/
  474 #define SCP_RAENP                       0x04    /*Ready AEN Permission*/
  475 #define SCP_UAAENP                      0x02    /*UA AEN Permission*/
  476 #define SCP_EAENP                       0x01    /*Error AEN Permission*/
  477         u_int8_t reserved;
  478         u_int8_t aen_holdoff_period[2];
  479 };
  480 
  481 struct scsi_cache_page {
  482         u_int8_t page_code;
  483 #define SCHP_PAGE_SAVABLE               0x80    /* Page is savable */
  484         u_int8_t page_length;
  485         u_int8_t cache_flags;
  486 #define SCHP_FLAGS_WCE                  0x04    /* Write Cache Enable */
  487 #define SCHP_FLAGS_MF                   0x02    /* Multiplication factor */
  488 #define SCHP_FLAGS_RCD                  0x01    /* Read Cache Disable */
  489         u_int8_t rw_cache_policy;
  490         u_int8_t dis_prefetch[2];
  491         u_int8_t min_prefetch[2];
  492         u_int8_t max_prefetch[2];
  493         u_int8_t max_prefetch_ceil[2];
  494 };
  495 
  496 /*
  497  * XXX KDM
  498  * Updated version of the cache page, as of SBC.  Update this to SBC-3 and
  499  * rationalize the two.
  500  */
  501 struct scsi_caching_page {
  502         uint8_t page_code;
  503 #define SMS_CACHING_PAGE                0x08
  504         uint8_t page_length;
  505         uint8_t flags1;
  506 #define SCP_IC          0x80
  507 #define SCP_ABPF        0x40
  508 #define SCP_CAP         0x20
  509 #define SCP_DISC        0x10
  510 #define SCP_SIZE        0x08
  511 #define SCP_WCE         0x04
  512 #define SCP_MF          0x02
  513 #define SCP_RCD         0x01
  514         uint8_t ret_priority;
  515         uint8_t disable_pf_transfer_len[2];
  516         uint8_t min_prefetch[2];
  517         uint8_t max_prefetch[2];
  518         uint8_t max_pf_ceiling[2];
  519         uint8_t flags2;
  520 #define SCP_FSW         0x80
  521 #define SCP_LBCSS       0x40
  522 #define SCP_DRA         0x20
  523 #define SCP_VS1         0x10
  524 #define SCP_VS2         0x08
  525         uint8_t cache_segments;
  526         uint8_t cache_seg_size[2];
  527         uint8_t reserved;
  528         uint8_t non_cache_seg_size[3];
  529 };
  530 
  531 /*
  532  * XXX KDM move this off to a vendor shim.
  533  */
  534 struct copan_power_subpage {
  535         uint8_t page_code;
  536 #define PWR_PAGE_CODE           0x00
  537         uint8_t subpage;
  538 #define PWR_SUBPAGE_CODE        0x02
  539         uint8_t page_length[2];
  540         uint8_t page_version;
  541 #define PWR_VERSION                 0x01
  542         uint8_t total_luns;
  543         uint8_t max_active_luns;
  544 #define PWR_DFLT_MAX_LUNS           0x07
  545         uint8_t reserved[25];
  546 };
  547 
  548 /*
  549  * XXX KDM move this off to a vendor shim.
  550  */
  551 struct copan_aps_subpage {
  552         uint8_t page_code;
  553 #define APS_PAGE_CODE           0x00
  554         uint8_t subpage;
  555 #define APS_SUBPAGE_CODE        0x03
  556         uint8_t page_length[2];
  557         uint8_t page_version;
  558 #define APS_VERSION                 0x00
  559         uint8_t lock_active;
  560 #define APS_LOCK_ACTIVE     0x01
  561 #define APS_LOCK_INACTIVE       0x00
  562         uint8_t reserved[26];
  563 };
  564 
  565 /*
  566  * XXX KDM move this off to a vendor shim.
  567  */
  568 struct copan_debugconf_subpage {
  569         uint8_t page_code;
  570 #define DBGCNF_PAGE_CODE                0x00
  571         uint8_t subpage;
  572 #define DBGCNF_SUBPAGE_CODE     0xF0
  573         uint8_t page_length[2];
  574         uint8_t page_version;
  575 #define DBGCNF_VERSION                  0x00
  576         uint8_t ctl_time_io_secs[2];
  577 };
  578 
  579 
  580 struct scsi_info_exceptions_page {
  581         u_int8_t page_code;
  582 #define SIEP_PAGE_SAVABLE               0x80    /* Page is savable */
  583         u_int8_t page_length;
  584         u_int8_t info_flags;
  585 #define SIEP_FLAGS_PERF                 0x80
  586 #define SIEP_FLAGS_EBF                  0x20
  587 #define SIEP_FLAGS_EWASC                0x10
  588 #define SIEP_FLAGS_DEXCPT               0x08
  589 #define SIEP_FLAGS_TEST                 0x04
  590 #define SIEP_FLAGS_EBACKERR             0x02
  591 #define SIEP_FLAGS_LOGERR               0x01
  592         u_int8_t mrie;
  593         u_int8_t interval_timer[4];
  594         u_int8_t report_count[4];
  595 };
  596 
  597 struct scsi_proto_specific_page {
  598         u_int8_t page_code;
  599 #define SPSP_PAGE_SAVABLE               0x80    /* Page is savable */
  600         u_int8_t page_length;
  601         u_int8_t protocol;
  602 #define SPSP_PROTO_FC                   0x00
  603 #define SPSP_PROTO_SPI                  0x01
  604 #define SPSP_PROTO_SSA                  0x02
  605 #define SPSP_PROTO_1394                 0x03
  606 #define SPSP_PROTO_RDMA                 0x04
  607 #define SPSP_PROTO_ISCSI                0x05
  608 #define SPSP_PROTO_SAS                  0x06
  609 #define SPSP_PROTO_ADT                  0x07
  610 #define SPSP_PROTO_ATA                  0x08
  611 #define SPSP_PROTO_NONE                 0x0f
  612 };
  613 
  614 struct scsi_reserve
  615 {
  616         u_int8_t opcode;
  617         u_int8_t byte2;
  618 #define SR_EXTENT       0x01
  619 #define SR_ID_MASK      0x0e
  620 #define SR_3RDPTY       0x10
  621 #define SR_LUN_MASK     0xe0
  622         u_int8_t resv_id;
  623         u_int8_t length[2];
  624         u_int8_t control;
  625 };
  626 
  627 struct scsi_reserve_10 {
  628         uint8_t opcode;
  629         uint8_t byte2;
  630 #define SR10_3RDPTY     0x10
  631 #define SR10_LONGID     0x02
  632 #define SR10_EXTENT     0x01
  633         uint8_t resv_id;
  634         uint8_t thirdparty_id;
  635         uint8_t reserved[3];
  636         uint8_t length[2];
  637         uint8_t control;
  638 };
  639 
  640 
  641 struct scsi_release
  642 {
  643         u_int8_t opcode;
  644         u_int8_t byte2;
  645         u_int8_t resv_id;
  646         u_int8_t unused[1];
  647         u_int8_t length;
  648         u_int8_t control;
  649 };
  650 
  651 struct scsi_release_10 {
  652         uint8_t opcode;
  653         uint8_t byte2;
  654         uint8_t resv_id;
  655         uint8_t thirdparty_id;
  656         uint8_t reserved[3];
  657         uint8_t length[2];
  658         uint8_t control;
  659 };
  660 
  661 struct scsi_prevent
  662 {
  663         u_int8_t opcode;
  664         u_int8_t byte2;
  665         u_int8_t unused[2];
  666         u_int8_t how;
  667         u_int8_t control;
  668 };
  669 #define PR_PREVENT 0x01
  670 #define PR_ALLOW   0x00
  671 
  672 struct scsi_sync_cache
  673 {
  674         u_int8_t opcode;
  675         u_int8_t byte2;
  676 #define SSC_IMMED       0x02
  677 #define SSC_RELADR      0x01
  678         u_int8_t begin_lba[4];
  679         u_int8_t reserved;
  680         u_int8_t lb_count[2];
  681         u_int8_t control;       
  682 };
  683 
  684 struct scsi_sync_cache_16
  685 {
  686         uint8_t opcode;
  687         uint8_t byte2;
  688         uint8_t begin_lba[8];
  689         uint8_t lb_count[4];
  690         uint8_t reserved;
  691         uint8_t control;
  692 };
  693 
  694 struct scsi_format {
  695         uint8_t opcode;
  696         uint8_t byte2;
  697 #define SF_LONGLIST             0x20
  698 #define SF_FMTDATA              0x10
  699 #define SF_CMPLIST              0x08
  700 #define SF_FORMAT_MASK          0x07
  701 #define SF_FORMAT_BLOCK         0x00
  702 #define SF_FORMAT_LONG_BLOCK    0x03
  703 #define SF_FORMAT_BFI           0x04
  704 #define SF_FORMAT_PHYS          0x05
  705         uint8_t vendor;
  706         uint8_t interleave[2];
  707         uint8_t control;
  708 };
  709 
  710 struct scsi_format_header_short {
  711         uint8_t reserved;
  712 #define SF_DATA_FOV     0x80
  713 #define SF_DATA_DPRY    0x40
  714 #define SF_DATA_DCRT    0x20
  715 #define SF_DATA_STPF    0x10
  716 #define SF_DATA_IP      0x08
  717 #define SF_DATA_DSP     0x04
  718 #define SF_DATA_IMMED   0x02
  719 #define SF_DATA_VS      0x01
  720         uint8_t byte2;
  721         uint8_t defect_list_len[2];
  722 };
  723 
  724 struct scsi_format_header_long {
  725         uint8_t reserved;
  726         uint8_t byte2;
  727         uint8_t reserved2[2];
  728         uint8_t defect_list_len[4];
  729 };
  730 
  731 struct scsi_changedef
  732 {
  733         u_int8_t opcode;
  734         u_int8_t byte2;
  735         u_int8_t unused1;
  736         u_int8_t how;
  737         u_int8_t unused[4];
  738         u_int8_t datalen;
  739         u_int8_t control;
  740 };
  741 
  742 struct scsi_read_buffer
  743 {
  744         u_int8_t opcode;
  745         u_int8_t byte2;
  746 #define RWB_MODE                0x07
  747 #define RWB_MODE_HDR_DATA       0x00
  748 #define RWB_MODE_VENDOR         0x01
  749 #define RWB_MODE_DATA           0x02
  750 #define RWB_MODE_DOWNLOAD       0x04
  751 #define RWB_MODE_DOWNLOAD_SAVE  0x05
  752         u_int8_t buffer_id;
  753         u_int8_t offset[3];
  754         u_int8_t length[3];
  755         u_int8_t control;
  756 };
  757 
  758 struct scsi_write_buffer
  759 {
  760         u_int8_t opcode;
  761         u_int8_t byte2;
  762         u_int8_t buffer_id;
  763         u_int8_t offset[3];
  764         u_int8_t length[3];
  765         u_int8_t control;
  766 };
  767 
  768 struct scsi_rw_6
  769 {
  770         u_int8_t opcode;
  771         u_int8_t addr[3];
  772 /* only 5 bits are valid in the MSB address byte */
  773 #define SRW_TOPADDR     0x1F
  774         u_int8_t length;
  775         u_int8_t control;
  776 };
  777 
  778 struct scsi_rw_10
  779 {
  780         u_int8_t opcode;
  781 #define SRW10_RELADDR   0x01
  782 /* EBP defined for WRITE(10) only */
  783 #define SRW10_EBP       0x04
  784 #define SRW10_FUA       0x08
  785 #define SRW10_DPO       0x10
  786         u_int8_t byte2;
  787         u_int8_t addr[4];
  788         u_int8_t reserved;
  789         u_int8_t length[2];
  790         u_int8_t control;
  791 };
  792 
  793 struct scsi_rw_12
  794 {
  795         u_int8_t opcode;
  796 #define SRW12_RELADDR   0x01
  797 #define SRW12_FUA       0x08
  798 #define SRW12_DPO       0x10
  799         u_int8_t byte2;
  800         u_int8_t addr[4];
  801         u_int8_t length[4];
  802         u_int8_t reserved;
  803         u_int8_t control;
  804 };
  805 
  806 struct scsi_rw_16
  807 {
  808         u_int8_t opcode;
  809 #define SRW16_RELADDR   0x01
  810 #define SRW16_FUA       0x08
  811 #define SRW16_DPO       0x10
  812         u_int8_t byte2;
  813         u_int8_t addr[8];
  814         u_int8_t length[4];
  815         u_int8_t reserved;
  816         u_int8_t control;
  817 };
  818 
  819 struct scsi_write_same_10
  820 {
  821         uint8_t opcode;
  822         uint8_t byte2;
  823 #define SWS_LBDATA      0x02
  824 #define SWS_PBDATA      0x04
  825 #define SWS_UNMAP       0x08
  826 #define SWS_ANCHOR      0x10
  827         uint8_t addr[4];
  828         uint8_t group;
  829         uint8_t length[2];
  830         uint8_t control;
  831 };
  832 
  833 struct scsi_write_same_16
  834 {
  835         uint8_t opcode;
  836         uint8_t byte2;
  837         uint8_t addr[8];
  838         uint8_t length[4];
  839         uint8_t group;
  840         uint8_t control;
  841 };
  842 
  843 struct scsi_unmap
  844 {
  845         uint8_t opcode;
  846         uint8_t byte2;
  847 #define SU_ANCHOR       0x01
  848         uint8_t reserved[4];
  849         uint8_t group;
  850         uint8_t length[2];
  851         uint8_t control;
  852 };
  853 
  854 struct scsi_write_verify_10
  855 {
  856         uint8_t opcode;
  857         uint8_t byte2;
  858 #define SWV_BYTCHK              0x02
  859 #define SWV_DPO                 0x10
  860 #define SWV_WRPROECT_MASK       0xe0
  861         uint8_t addr[4];
  862         uint8_t group;
  863         uint8_t length[2];
  864         uint8_t control;
  865 };
  866 
  867 struct scsi_write_verify_12
  868 {
  869         uint8_t opcode;
  870         uint8_t byte2;
  871         uint8_t addr[4];
  872         uint8_t length[4];
  873         uint8_t group;
  874         uint8_t control;
  875 };
  876 
  877 struct scsi_write_verify_16
  878 {
  879         uint8_t opcode;
  880         uint8_t byte2;
  881         uint8_t addr[8];
  882         uint8_t length[4];
  883         uint8_t group;
  884         uint8_t control;
  885 };
  886 
  887 
  888 struct scsi_start_stop_unit
  889 {
  890         u_int8_t opcode;
  891         u_int8_t byte2;
  892 #define SSS_IMMED               0x01
  893         u_int8_t reserved[2];
  894         u_int8_t how;
  895 #define SSS_START               0x01
  896 #define SSS_LOEJ                0x02
  897 #define SSS_PC_MASK             0xf0
  898 #define SSS_PC_START_VALID      0x00
  899 #define SSS_PC_ACTIVE           0x10
  900 #define SSS_PC_IDLE             0x20
  901 #define SSS_PC_STANDBY          0x30
  902 #define SSS_PC_LU_CONTROL       0x70
  903 #define SSS_PC_FORCE_IDLE_0     0xa0
  904 #define SSS_PC_FORCE_STANDBY_0  0xb0
  905         u_int8_t control;
  906 };
  907 
  908 struct ata_pass_12 {
  909         u_int8_t opcode;
  910         u_int8_t protocol;
  911 #define AP_MULTI        0xe0
  912         u_int8_t flags;
  913 #define AP_T_LEN        0x03
  914 #define AP_BB           0x04
  915 #define AP_T_DIR        0x08
  916 #define AP_CK_COND      0x20
  917 #define AP_OFFLINE      0x60
  918         u_int8_t features;
  919         u_int8_t sector_count;
  920         u_int8_t lba_low;
  921         u_int8_t lba_mid;
  922         u_int8_t lba_high;
  923         u_int8_t device;
  924         u_int8_t command;
  925         u_int8_t reserved;
  926         u_int8_t control;
  927 };
  928 
  929 struct scsi_maintenance_in
  930 {
  931         uint8_t  opcode;
  932         uint8_t  byte2;
  933 #define SERVICE_ACTION_MASK  0x1f
  934 #define SA_RPRT_TRGT_GRP     0x0a
  935         uint8_t  reserved[4];
  936         uint8_t  length[4];
  937         uint8_t  reserved1;
  938         uint8_t  control;
  939 };
  940 
  941 struct ata_pass_16 {
  942         u_int8_t opcode;
  943         u_int8_t protocol;
  944 #define AP_EXTEND       0x01
  945         u_int8_t flags;
  946         u_int8_t features_ext;
  947         u_int8_t features;
  948         u_int8_t sector_count_ext;
  949         u_int8_t sector_count;
  950         u_int8_t lba_low_ext;
  951         u_int8_t lba_low;
  952         u_int8_t lba_mid_ext;
  953         u_int8_t lba_mid;
  954         u_int8_t lba_high_ext;
  955         u_int8_t lba_high;
  956         u_int8_t device;
  957         u_int8_t command;
  958         u_int8_t control;
  959 };
  960 
  961 #define SC_SCSI_1 0x01
  962 #define SC_SCSI_2 0x03
  963 
  964 /*
  965  * Opcodes
  966  */
  967 
  968 #define TEST_UNIT_READY         0x00
  969 #define REQUEST_SENSE           0x03
  970 #define READ_6                  0x08
  971 #define WRITE_6                 0x0A
  972 #define INQUIRY                 0x12
  973 #define MODE_SELECT_6           0x15
  974 #define MODE_SENSE_6            0x1A
  975 #define START_STOP_UNIT         0x1B
  976 #define START_STOP              0x1B
  977 #define RESERVE                 0x16
  978 #define RELEASE                 0x17
  979 #define RECEIVE_DIAGNOSTIC      0x1C
  980 #define SEND_DIAGNOSTIC         0x1D
  981 #define PREVENT_ALLOW           0x1E
  982 #define READ_CAPACITY           0x25
  983 #define READ_10                 0x28
  984 #define WRITE_10                0x2A
  985 #define POSITION_TO_ELEMENT     0x2B
  986 #define WRITE_VERIFY_10         0x2E
  987 #define SYNCHRONIZE_CACHE       0x35
  988 #define READ_DEFECT_DATA_10     0x37
  989 #define WRITE_BUFFER            0x3B
  990 #define READ_BUFFER             0x3C
  991 #define CHANGE_DEFINITION       0x40
  992 #define WRITE_SAME_10           0x41
  993 #define UNMAP                   0x42
  994 #define LOG_SELECT              0x4C
  995 #define LOG_SENSE               0x4D
  996 #define MODE_SELECT_10          0x55
  997 #define RESERVE_10              0x56
  998 #define RELEASE_10              0x57
  999 #define MODE_SENSE_10           0x5A
 1000 #define PERSISTENT_RES_IN       0x5E
 1001 #define PERSISTENT_RES_OUT      0x5F
 1002 #define ATA_PASS_16             0x85
 1003 #define READ_16                 0x88
 1004 #define WRITE_16                0x8A
 1005 #define WRITE_VERIFY_16         0x8E
 1006 #define SYNCHRONIZE_CACHE_16    0x91
 1007 #define WRITE_SAME_16           0x93
 1008 #define SERVICE_ACTION_IN       0x9E
 1009 #define REPORT_LUNS             0xA0
 1010 #define ATA_PASS_12             0xA1
 1011 #define MAINTENANCE_IN          0xA3
 1012 #define MAINTENANCE_OUT         0xA4
 1013 #define MOVE_MEDIUM             0xA5
 1014 #define READ_12                 0xA8
 1015 #define WRITE_12                0xAA
 1016 #define WRITE_VERIFY_12         0xAE
 1017 #define READ_ELEMENT_STATUS     0xB8
 1018 #define READ_CD                 0xBE
 1019 
 1020 /* Maintenance In Service Action Codes */
 1021 #define REPORT_IDENTIFYING_INFRMATION           0x05
 1022 #define REPORT_TARGET_PORT_GROUPS               0x0A
 1023 #define REPORT_ALIASES                          0x0B
 1024 #define REPORT_SUPPORTED_OPERATION_CODES        0x0C
 1025 #define REPORT_SUPPORTED_TASK_MANAGEMENT_FUNCTIONS      0x0D
 1026 #define REPORT_PRIORITY                         0x0E
 1027 #define REPORT_TIMESTAMP                        0x0F
 1028 #define MANAGEMENT_PROTOCOL_IN                  0x10
 1029 /* Maintenance Out Service Action Codes */
 1030 #define SET_IDENTIFY_INFORMATION                0x06
 1031 #define SET_TARGET_PORT_GROUPS                  0x0A
 1032 #define CHANGE_ALIASES                          0x0B
 1033 #define SET_PRIORITY                            0x0E
 1034 #define SET_TIMESTAMP                           0x0F
 1035 #define MANGAEMENT_PROTOCOL_OUT                 0x10
 1036 
 1037 /*
 1038  * Device Types
 1039  */
 1040 #define T_DIRECT        0x00
 1041 #define T_SEQUENTIAL    0x01
 1042 #define T_PRINTER       0x02
 1043 #define T_PROCESSOR     0x03
 1044 #define T_WORM          0x04
 1045 #define T_CDROM         0x05
 1046 #define T_SCANNER       0x06
 1047 #define T_OPTICAL       0x07
 1048 #define T_CHANGER       0x08
 1049 #define T_COMM          0x09
 1050 #define T_ASC0          0x0a
 1051 #define T_ASC1          0x0b
 1052 #define T_STORARRAY     0x0c
 1053 #define T_ENCLOSURE     0x0d
 1054 #define T_RBC           0x0e
 1055 #define T_OCRW          0x0f
 1056 #define T_OSD           0x11
 1057 #define T_ADC           0x12
 1058 #define T_NODEVICE      0x1f
 1059 #define T_ANY           0xff    /* Used in Quirk table matches */
 1060 
 1061 #define T_REMOV         1
 1062 #define T_FIXED         0
 1063 
 1064 /*
 1065  * This length is the initial inquiry length used by the probe code, as    
 1066  * well as the legnth necessary for scsi_print_inquiry() to function 
 1067  * correctly.  If either use requires a different length in the future, 
 1068  * the two values should be de-coupled.
 1069  */
 1070 #define SHORT_INQUIRY_LENGTH    36
 1071 
 1072 struct scsi_inquiry_data
 1073 {
 1074         u_int8_t device;
 1075 #define SID_TYPE(inq_data) ((inq_data)->device & 0x1f)
 1076 #define SID_QUAL(inq_data) (((inq_data)->device & 0xE0) >> 5)
 1077 #define SID_QUAL_LU_CONNECTED   0x00    /*
 1078                                          * The specified peripheral device
 1079                                          * type is currently connected to
 1080                                          * logical unit.  If the target cannot
 1081                                          * determine whether or not a physical
 1082                                          * device is currently connected, it
 1083                                          * shall also use this peripheral
 1084                                          * qualifier when returning the INQUIRY
 1085                                          * data.  This peripheral qualifier
 1086                                          * does not mean that the device is
 1087                                          * ready for access by the initiator.
 1088                                          */
 1089 #define SID_QUAL_LU_OFFLINE     0x01    /*
 1090                                          * The target is capable of supporting
 1091                                          * the specified peripheral device type
 1092                                          * on this logical unit; however, the
 1093                                          * physical device is not currently
 1094                                          * connected to this logical unit.
 1095                                          */
 1096 #define SID_QUAL_RSVD           0x02
 1097 #define SID_QUAL_BAD_LU         0x03    /*
 1098                                          * The target is not capable of
 1099                                          * supporting a physical device on
 1100                                          * this logical unit. For this
 1101                                          * peripheral qualifier the peripheral
 1102                                          * device type shall be set to 1Fh to
 1103                                          * provide compatibility with previous
 1104                                          * versions of SCSI. All other
 1105                                          * peripheral device type values are
 1106                                          * reserved for this peripheral
 1107                                          * qualifier.
 1108                                          */
 1109 #define SID_QUAL_IS_VENDOR_UNIQUE(inq_data) ((SID_QUAL(inq_data) & 0x08) != 0)
 1110         u_int8_t dev_qual2;
 1111 #define SID_QUAL2       0x7F
 1112 #define SID_IS_REMOVABLE(inq_data) (((inq_data)->dev_qual2 & 0x80) != 0)
 1113         u_int8_t version;
 1114 #define SID_ANSI_REV(inq_data) ((inq_data)->version & 0x07)
 1115 #define         SCSI_REV_0              0
 1116 #define         SCSI_REV_CCS            1
 1117 #define         SCSI_REV_2              2
 1118 #define         SCSI_REV_SPC            3
 1119 #define         SCSI_REV_SPC2           4
 1120 #define         SCSI_REV_SPC3           5
 1121 #define         SCSI_REV_SPC4           6
 1122 
 1123 #define SID_ECMA        0x38
 1124 #define SID_ISO         0xC0
 1125         u_int8_t response_format;
 1126 #define SID_AENC        0x80
 1127 #define SID_TrmIOP      0x40
 1128 #define SID_NormACA     0x20
 1129 #define SID_HiSup       0x10
 1130         u_int8_t additional_length;
 1131 #define SID_ADDITIONAL_LENGTH(iqd)                                      \
 1132         ((iqd)->additional_length +                                     \
 1133         __offsetof(struct scsi_inquiry_data, additional_length) + 1)
 1134         u_int8_t spc3_flags;
 1135 #define SPC3_SID_PROTECT        0x01
 1136 #define SPC3_SID_3PC            0x08
 1137 #define SPC3_SID_TPGS_MASK      0x30
 1138 #define SPC3_SID_TPGS_IMPLICIT  0x10
 1139 #define SPC3_SID_TPGS_EXPLICIT  0x20
 1140 #define SPC3_SID_ACC            0x40
 1141 #define SPC3_SID_SCCS           0x80
 1142         u_int8_t spc2_flags;
 1143 #define SPC2_SID_ADDR16         0x01
 1144 #define SPC2_SID_MChngr         0x08
 1145 #define SPC2_SID_MultiP         0x10
 1146 #define SPC2_SID_EncServ        0x40
 1147 #define SPC2_SID_BQueue         0x80
 1148 
 1149 #define INQ_DATA_TQ_ENABLED(iqd)                                \
 1150     ((SID_ANSI_REV(iqd) < SCSI_REV_SPC2)? ((iqd)->flags & SID_CmdQue) : \
 1151     (((iqd)->flags & SID_CmdQue) && !((iqd)->spc2_flags & SPC2_SID_BQueue)) || \
 1152     (!((iqd)->flags & SID_CmdQue) && ((iqd)->spc2_flags & SPC2_SID_BQueue)))
 1153 
 1154         u_int8_t flags;
 1155 #define SID_SftRe       0x01
 1156 #define SID_CmdQue      0x02
 1157 #define SID_Linked      0x08
 1158 #define SID_Sync        0x10
 1159 #define SID_WBus16      0x20
 1160 #define SID_WBus32      0x40
 1161 #define SID_RelAdr      0x80
 1162 #define SID_VENDOR_SIZE   8
 1163         char     vendor[SID_VENDOR_SIZE];
 1164 #define SID_PRODUCT_SIZE  16
 1165         char     product[SID_PRODUCT_SIZE];
 1166 #define SID_REVISION_SIZE 4
 1167         char     revision[SID_REVISION_SIZE];
 1168         /*
 1169          * The following fields were taken from SCSI Primary Commands - 2
 1170          * (SPC-2) Revision 14, Dated 11 November 1999
 1171          */
 1172 #define SID_VENDOR_SPECIFIC_0_SIZE      20
 1173         u_int8_t vendor_specific0[SID_VENDOR_SPECIFIC_0_SIZE];
 1174         /*
 1175          * An extension of SCSI Parallel Specific Values
 1176          */
 1177 #define SID_SPI_IUS             0x01
 1178 #define SID_SPI_QAS             0x02
 1179 #define SID_SPI_CLOCK_ST        0x00
 1180 #define SID_SPI_CLOCK_DT        0x04
 1181 #define SID_SPI_CLOCK_DT_ST     0x0C
 1182 #define SID_SPI_MASK            0x0F
 1183         u_int8_t spi3data;
 1184         u_int8_t reserved2;
 1185         /*
 1186          * Version Descriptors, stored 2 byte values.
 1187          */
 1188         u_int8_t version1[2];
 1189         u_int8_t version2[2];
 1190         u_int8_t version3[2];
 1191         u_int8_t version4[2];
 1192         u_int8_t version5[2];
 1193         u_int8_t version6[2];
 1194         u_int8_t version7[2];
 1195         u_int8_t version8[2];
 1196 
 1197         u_int8_t reserved3[22];
 1198 
 1199 #define SID_VENDOR_SPECIFIC_1_SIZE      160
 1200         u_int8_t vendor_specific1[SID_VENDOR_SPECIFIC_1_SIZE];
 1201 };
 1202 
 1203 /*
 1204  * This structure is more suited to initiator operation, because the
 1205  * maximum number of supported pages is already allocated.
 1206  */
 1207 struct scsi_vpd_supported_page_list
 1208 {
 1209         u_int8_t device;
 1210         u_int8_t page_code;
 1211 #define SVPD_SUPPORTED_PAGE_LIST        0x00
 1212 #define SVPD_SUPPORTED_PAGES_HDR_LEN    4
 1213         u_int8_t reserved;
 1214         u_int8_t length;        /* number of VPD entries */
 1215 #define SVPD_SUPPORTED_PAGES_SIZE       251
 1216         u_int8_t list[SVPD_SUPPORTED_PAGES_SIZE];
 1217 };
 1218 
 1219 /*
 1220  * This structure is more suited to target operation, because the
 1221  * number of supported pages is left to the user to allocate.
 1222  */
 1223 struct scsi_vpd_supported_pages
 1224 {
 1225         u_int8_t device;
 1226         u_int8_t page_code;
 1227         u_int8_t reserved;
 1228 #define SVPD_SUPPORTED_PAGES    0x00
 1229         u_int8_t length;
 1230         u_int8_t page_list[0];
 1231 };
 1232 
 1233 
 1234 struct scsi_vpd_unit_serial_number
 1235 {
 1236         u_int8_t device;
 1237         u_int8_t page_code;
 1238 #define SVPD_UNIT_SERIAL_NUMBER 0x80
 1239         u_int8_t reserved;
 1240         u_int8_t length; /* serial number length */
 1241 #define SVPD_SERIAL_NUM_SIZE 251
 1242         u_int8_t serial_num[SVPD_SERIAL_NUM_SIZE];
 1243 };
 1244 
 1245 struct scsi_vpd_device_id
 1246 {
 1247         u_int8_t device;
 1248         u_int8_t page_code;
 1249 #define SVPD_DEVICE_ID                  0x83
 1250 #define SVPD_DEVICE_ID_MAX_SIZE         252
 1251 #define SVPD_DEVICE_ID_HDR_LEN \
 1252     __offsetof(struct scsi_vpd_device_id, desc_list)
 1253         u_int8_t length[2];
 1254         u_int8_t desc_list[];
 1255 };
 1256 
 1257 struct scsi_vpd_id_descriptor
 1258 {
 1259         u_int8_t        proto_codeset;
 1260 #define SCSI_PROTO_FC           0x00
 1261 #define SCSI_PROTO_SPI          0x01
 1262 #define SCSI_PROTO_SSA          0x02
 1263 #define SCSI_PROTO_1394         0x03
 1264 #define SCSI_PROTO_RDMA         0x04
 1265 #define SCSI_PROTO_iSCSI        0x05
 1266 #define SCSI_PROTO_SAS          0x06
 1267 #define SCSI_PROTO_ADT          0x07
 1268 #define SCSI_PROTO_ATA          0x08
 1269 #define SVPD_ID_PROTO_SHIFT     4
 1270 #define SVPD_ID_CODESET_BINARY  0x01
 1271 #define SVPD_ID_CODESET_ASCII   0x02
 1272 #define SVPD_ID_CODESET_MASK    0x0f
 1273         u_int8_t        id_type;
 1274 #define SVPD_ID_PIV             0x80
 1275 #define SVPD_ID_ASSOC_LUN       0x00
 1276 #define SVPD_ID_ASSOC_PORT      0x10
 1277 #define SVPD_ID_ASSOC_TARGET    0x20
 1278 #define SVPD_ID_ASSOC_MASK      0x30
 1279 #define SVPD_ID_TYPE_VENDOR     0x00
 1280 #define SVPD_ID_TYPE_T10        0x01
 1281 #define SVPD_ID_TYPE_EUI64      0x02
 1282 #define SVPD_ID_TYPE_NAA        0x03
 1283 #define SVPD_ID_TYPE_RELTARG    0x04
 1284 #define SVPD_ID_TYPE_TPORTGRP   0x05
 1285 #define SVPD_ID_TYPE_LUNGRP     0x06
 1286 #define SVPD_ID_TYPE_MD5_LUN_ID 0x07
 1287 #define SVPD_ID_TYPE_SCSI_NAME  0x08
 1288 #define SVPD_ID_TYPE_MASK       0x0f
 1289         u_int8_t        reserved;
 1290         u_int8_t        length;
 1291 #define SVPD_DEVICE_ID_DESC_HDR_LEN \
 1292     __offsetof(struct scsi_vpd_id_descriptor, identifier) 
 1293         u_int8_t        identifier[];
 1294 };
 1295 
 1296 struct scsi_vpd_id_t10
 1297 {
 1298         u_int8_t        vendor[8];
 1299         u_int8_t        vendor_spec_id[0];
 1300 };
 1301 
 1302 struct scsi_vpd_id_eui64
 1303 {
 1304         u_int8_t        ieee_company_id[3];
 1305         u_int8_t        extension_id[5];
 1306 };
 1307 
 1308 struct scsi_vpd_id_naa_basic
 1309 {
 1310         uint8_t naa;
 1311         /* big endian, packed:
 1312         uint8_t naa : 4;
 1313         uint8_t naa_desig : 4;
 1314         */
 1315 #define SVPD_ID_NAA_NAA_SHIFT           4
 1316 #define SVPD_ID_NAA_IEEE_EXT            0x02
 1317 #define SVPD_ID_NAA_LOCAL_REG           0x03
 1318 #define SVPD_ID_NAA_IEEE_REG            0x05
 1319 #define SVPD_ID_NAA_IEEE_REG_EXT        0x06
 1320         uint8_t naa_data[];
 1321 };
 1322 
 1323 struct scsi_vpd_id_naa_ieee_extended_id
 1324 {
 1325         uint8_t naa;
 1326         uint8_t vendor_specific_id_a;
 1327         uint8_t ieee_company_id[3];
 1328         uint8_t vendor_specific_id_b[4];
 1329 };
 1330 
 1331 struct scsi_vpd_id_naa_local_reg
 1332 {
 1333         uint8_t naa;
 1334         uint8_t local_value[7];
 1335 };
 1336 
 1337 struct scsi_vpd_id_naa_ieee_reg
 1338 {
 1339         uint8_t naa;
 1340         uint8_t reg_value[7];
 1341         /* big endian, packed:
 1342         uint8_t naa_basic : 4;
 1343         uint8_t ieee_company_id_0 : 4;
 1344         uint8_t ieee_company_id_1[2];
 1345         uint8_t ieee_company_id_2 : 4;
 1346         uint8_t vendor_specific_id_0 : 4;
 1347         uint8_t vendor_specific_id_1[4];
 1348         */
 1349 };
 1350 
 1351 struct scsi_vpd_id_naa_ieee_reg_extended
 1352 {
 1353         uint8_t naa;
 1354         uint8_t reg_value[15];
 1355         /* big endian, packed:
 1356         uint8_t naa_basic : 4;
 1357         uint8_t ieee_company_id_0 : 4;
 1358         uint8_t ieee_company_id_1[2];
 1359         uint8_t ieee_company_id_2 : 4;
 1360         uint8_t vendor_specific_id_0 : 4;
 1361         uint8_t vendor_specific_id_1[4];
 1362         uint8_t vendor_specific_id_ext[8];
 1363         */
 1364 };
 1365 
 1366 struct scsi_vpd_id_rel_trgt_port_id
 1367 {
 1368         uint8_t obsolete[2];
 1369         uint8_t rel_trgt_port_id[2];
 1370 };
 1371 
 1372 struct scsi_vpd_id_trgt_port_grp_id
 1373 {
 1374         uint8_t reserved[2];
 1375         uint8_t trgt_port_grp[2];
 1376 };
 1377 
 1378 struct scsi_vpd_id_lun_grp_id
 1379 {
 1380         uint8_t reserved[2];
 1381         uint8_t log_unit_grp[2];
 1382 };
 1383 
 1384 struct scsi_vpd_id_md5_lun_id
 1385 {
 1386         uint8_t lun_id[16];
 1387 };
 1388 
 1389 struct scsi_vpd_id_scsi_name
 1390 {
 1391         uint8_t name_string[256];
 1392 };
 1393 
 1394 struct scsi_service_action_in
 1395 {
 1396         uint8_t opcode;
 1397         uint8_t service_action;
 1398         uint8_t action_dependent[13];
 1399         uint8_t control;
 1400 };
 1401 
 1402 struct scsi_diag_page {
 1403         uint8_t page_code;
 1404         uint8_t page_specific_flags;
 1405         uint8_t length[2];
 1406         uint8_t params[0];
 1407 };
 1408 
 1409 struct scsi_read_capacity
 1410 {
 1411         u_int8_t opcode;
 1412         u_int8_t byte2;
 1413 #define SRC_RELADR      0x01
 1414         u_int8_t addr[4];
 1415         u_int8_t unused[2];
 1416         u_int8_t pmi;
 1417 #define SRC_PMI         0x01
 1418         u_int8_t control;
 1419 };
 1420 
 1421 struct scsi_read_capacity_16
 1422 {
 1423         uint8_t opcode;
 1424 #define SRC16_SERVICE_ACTION    0x10
 1425         uint8_t service_action;
 1426         uint8_t addr[8];
 1427         uint8_t alloc_len[4];
 1428 #define SRC16_PMI               0x01
 1429 #define SRC16_RELADR            0x02
 1430         uint8_t reladr;
 1431         uint8_t control;
 1432 };
 1433 
 1434 struct scsi_read_capacity_data
 1435 {
 1436         u_int8_t addr[4];
 1437         u_int8_t length[4];
 1438 };
 1439 
 1440 struct scsi_read_capacity_data_long
 1441 {
 1442         uint8_t addr[8];
 1443         uint8_t length[4];
 1444 #define SRC16_PROT_EN           0x01
 1445 #define SRC16_P_TYPE            0x0e
 1446         uint8_t prot;
 1447 #define SRC16_LBPPBE            0x0f
 1448 #define SRC16_PI_EXPONENT       0xf0
 1449 #define SRC16_PI_EXPONENT_SHIFT 4
 1450         uint8_t prot_lbppbe;
 1451 #define SRC16_LALBA             0x3fff
 1452 #define SRC16_LBPRZ             0x4000
 1453 #define SRC16_LBPME             0x8000
 1454         uint8_t lalba_lbp[2];
 1455 };
 1456 
 1457 struct scsi_report_luns
 1458 {
 1459         uint8_t opcode;
 1460         uint8_t reserved1;
 1461 #define RPL_REPORT_DEFAULT      0x00
 1462 #define RPL_REPORT_WELLKNOWN    0x01
 1463 #define RPL_REPORT_ALL          0x02
 1464         uint8_t select_report;
 1465         uint8_t reserved2[3];
 1466         uint8_t length[4];
 1467         uint8_t reserved3;
 1468         uint8_t control;
 1469 };
 1470 
 1471 struct scsi_report_luns_lundata {
 1472         uint8_t lundata[8];
 1473 #define RPL_LUNDATA_PERIPH_BUS_MASK     0x3f
 1474 #define RPL_LUNDATA_FLAT_LUN_MASK       0x3f
 1475 #define RPL_LUNDATA_FLAT_LUN_BITS       0x06
 1476 #define RPL_LUNDATA_LUN_TARG_MASK       0x3f
 1477 #define RPL_LUNDATA_LUN_BUS_MASK        0xe0
 1478 #define RPL_LUNDATA_LUN_LUN_MASK        0x1f
 1479 #define RPL_LUNDATA_EXT_LEN_MASK        0x30
 1480 #define RPL_LUNDATA_EXT_EAM_MASK        0x0f
 1481 #define RPL_LUNDATA_EXT_EAM_WK          0x01
 1482 #define RPL_LUNDATA_EXT_EAM_NOT_SPEC    0x0f
 1483 #define RPL_LUNDATA_ATYP_MASK   0xc0    /* MBZ for type 0 lun */
 1484 #define RPL_LUNDATA_ATYP_PERIPH 0x00
 1485 #define RPL_LUNDATA_ATYP_FLAT   0x40
 1486 #define RPL_LUNDATA_ATYP_LUN    0x80
 1487 #define RPL_LUNDATA_ATYP_EXTLUN 0xc0
 1488 };
 1489 
 1490 struct scsi_report_luns_data {
 1491         u_int8_t length[4];     /* length of LUN inventory, in bytes */
 1492         u_int8_t reserved[4];   /* unused */
 1493         /*
 1494          * LUN inventory- we only support the type zero form for now.
 1495          */
 1496         struct scsi_report_luns_lundata luns[0];
 1497 };
 1498 
 1499 struct scsi_target_group
 1500 {
 1501         uint8_t opcode;
 1502         uint8_t service_action;
 1503 #define STG_PDF_LENGTH          0x00
 1504 #define RPL_PDF_EXTENDED        0x20
 1505         uint8_t reserved1[4];
 1506         uint8_t length[4];
 1507         uint8_t reserved2;
 1508         uint8_t control;
 1509 };
 1510 
 1511 struct scsi_target_port_descriptor {
 1512         uint8_t reserved[2];
 1513         uint8_t relative_target_port_identifier[2];
 1514         uint8_t desc_list[];
 1515 };
 1516 
 1517 struct scsi_target_port_group_descriptor {
 1518         uint8_t pref_state;
 1519 #define TPG_PRIMARY                             0x80
 1520 #define TPG_ASYMMETRIC_ACCESS_STATE_MASK        0xf
 1521 #define TPG_ASYMMETRIC_ACCESS_OPTIMIZED         0x0
 1522 #define TPG_ASYMMETRIC_ACCESS_NONOPTIMIZED      0x1
 1523 #define TPG_ASYMMETRIC_ACCESS_STANDBY           0x2
 1524 #define TPG_ASYMMETRIC_ACCESS_UNAVAILABLE       0x3
 1525 #define TPG_ASYMMETRIC_ACCESS_LBA_DEPENDENT     0x4
 1526 #define TPG_ASYMMETRIC_ACCESS_OFFLINE           0xE
 1527 #define TPG_ASYMMETRIC_ACCESS_TRANSITIONING     0xF
 1528         uint8_t support;
 1529 #define TPG_AO_SUP      0x01
 1530 #define TPG_AN_SUP      0x02
 1531 #define TPG_S_SUP       0x04
 1532 #define TPG_U_SUP       0x08
 1533 #define TPG_LBD_SUP     0x10
 1534 #define TPG_O_SUP       0x40
 1535 #define TPG_T_SUP       0x80
 1536         uint8_t target_port_group[2];
 1537         uint8_t reserved;
 1538         uint8_t status;
 1539 #define TPG_UNAVLBL      0
 1540 #define TPG_SET_BY_STPG  0x01
 1541 #define TPG_IMPLICIT     0x02
 1542         uint8_t vendor_specific;
 1543         uint8_t target_port_count;
 1544         struct scsi_target_port_descriptor descriptors[];
 1545 };
 1546 
 1547 struct scsi_target_group_data {
 1548         uint8_t length[4];      /* length of returned data, in bytes */
 1549         struct scsi_target_port_group_descriptor groups[];
 1550 };
 1551 
 1552 struct scsi_target_group_data_extended {
 1553         uint8_t length[4];      /* length of returned data, in bytes */
 1554         uint8_t format_type;    /* STG_PDF_LENGTH or RPL_PDF_EXTENDED */
 1555         uint8_t implicit_transition_time;
 1556         uint8_t reserved[2];
 1557         struct scsi_target_port_group_descriptor groups[];
 1558 };
 1559 
 1560 
 1561 typedef enum {
 1562         SSD_TYPE_NONE,
 1563         SSD_TYPE_FIXED,
 1564         SSD_TYPE_DESC
 1565 } scsi_sense_data_type;
 1566 
 1567 typedef enum {
 1568         SSD_ELEM_NONE,
 1569         SSD_ELEM_SKIP,
 1570         SSD_ELEM_DESC,
 1571         SSD_ELEM_SKS,
 1572         SSD_ELEM_COMMAND,
 1573         SSD_ELEM_INFO,
 1574         SSD_ELEM_FRU,
 1575         SSD_ELEM_STREAM,
 1576         SSD_ELEM_MAX
 1577 } scsi_sense_elem_type;
 1578 
 1579 
 1580 struct scsi_sense_data
 1581 {
 1582         uint8_t error_code;
 1583         /*
 1584          * SPC-4 says that the maximum length of sense data is 252 bytes.
 1585          * So this structure is exactly 252 bytes log.
 1586          */
 1587 #define SSD_FULL_SIZE 252
 1588         uint8_t sense_buf[SSD_FULL_SIZE - 1];
 1589         /*
 1590          * XXX KDM is this still a reasonable minimum size?
 1591          */
 1592 #define SSD_MIN_SIZE 18
 1593         /*
 1594          * Maximum value for the extra_len field in the sense data.
 1595          */
 1596 #define SSD_EXTRA_MAX 244
 1597 };
 1598 
 1599 /*
 1600  * Fixed format sense data.
 1601  */
 1602 struct scsi_sense_data_fixed
 1603 {
 1604         u_int8_t error_code;
 1605 #define SSD_ERRCODE                     0x7F
 1606 #define         SSD_CURRENT_ERROR       0x70
 1607 #define         SSD_DEFERRED_ERROR      0x71
 1608 #define SSD_ERRCODE_VALID       0x80    
 1609         u_int8_t segment;
 1610         u_int8_t flags;
 1611 #define SSD_KEY                         0x0F
 1612 #define         SSD_KEY_NO_SENSE        0x00
 1613 #define         SSD_KEY_RECOVERED_ERROR 0x01
 1614 #define         SSD_KEY_NOT_READY       0x02
 1615 #define         SSD_KEY_MEDIUM_ERROR    0x03
 1616 #define         SSD_KEY_HARDWARE_ERROR  0x04
 1617 #define         SSD_KEY_ILLEGAL_REQUEST 0x05
 1618 #define         SSD_KEY_UNIT_ATTENTION  0x06
 1619 #define         SSD_KEY_DATA_PROTECT    0x07
 1620 #define         SSD_KEY_BLANK_CHECK     0x08
 1621 #define         SSD_KEY_Vendor_Specific 0x09
 1622 #define         SSD_KEY_COPY_ABORTED    0x0a
 1623 #define         SSD_KEY_ABORTED_COMMAND 0x0b            
 1624 #define         SSD_KEY_EQUAL           0x0c
 1625 #define         SSD_KEY_VOLUME_OVERFLOW 0x0d
 1626 #define         SSD_KEY_MISCOMPARE      0x0e
 1627 #define         SSD_KEY_COMPLETED       0x0f                    
 1628 #define SSD_ILI         0x20
 1629 #define SSD_EOM         0x40
 1630 #define SSD_FILEMARK    0x80
 1631         u_int8_t info[4];
 1632         u_int8_t extra_len;
 1633         u_int8_t cmd_spec_info[4];
 1634         u_int8_t add_sense_code;
 1635         u_int8_t add_sense_code_qual;
 1636         u_int8_t fru;
 1637         u_int8_t sense_key_spec[3];
 1638 #define SSD_SCS_VALID           0x80
 1639 #define SSD_FIELDPTR_CMD        0x40
 1640 #define SSD_BITPTR_VALID        0x08
 1641 #define SSD_BITPTR_VALUE        0x07
 1642         u_int8_t extra_bytes[14];
 1643 #define SSD_FIXED_IS_PRESENT(sense, length, field)                      \
 1644         ((length >= (offsetof(struct scsi_sense_data_fixed, field) +    \
 1645         sizeof(sense->field))) ? 1 :0)
 1646 #define SSD_FIXED_IS_FILLED(sense, field)                               \
 1647         ((((offsetof(struct scsi_sense_data_fixed, field) +             \
 1648         sizeof(sense->field)) -                                         \
 1649         (offsetof(struct scsi_sense_data_fixed, extra_len) +            \
 1650         sizeof(sense->extra_len))) <= sense->extra_len) ? 1 : 0)
 1651 };
 1652 
 1653 /*
 1654  * Descriptor format sense data definitions.
 1655  * Introduced in SPC-3.
 1656  */
 1657 struct scsi_sense_data_desc 
 1658 {
 1659         uint8_t error_code;
 1660 #define SSD_DESC_CURRENT_ERROR  0x72
 1661 #define SSD_DESC_DEFERRED_ERROR 0x73
 1662         uint8_t sense_key;
 1663         uint8_t add_sense_code;
 1664         uint8_t add_sense_code_qual;
 1665         uint8_t reserved[3];
 1666         /*
 1667          * Note that SPC-4, section 4.5.2.1 says that the extra_len field
 1668          * must be less than or equal to 244.
 1669          */
 1670         uint8_t extra_len;
 1671         uint8_t sense_desc[0];
 1672 #define SSD_DESC_IS_PRESENT(sense, length, field)                       \
 1673         ((length >= (offsetof(struct scsi_sense_data_desc, field) +     \
 1674         sizeof(sense->field))) ? 1 :0)
 1675 };
 1676 
 1677 struct scsi_sense_desc_header
 1678 {
 1679         uint8_t desc_type;
 1680         uint8_t length;
 1681 };
 1682 /*
 1683  * The information provide in the Information descriptor is device type or
 1684  * command specific information, and defined in a command standard.
 1685  *
 1686  * Note that any changes to the field names or positions in this structure,
 1687  * even reserved fields, should be accompanied by an examination of the
 1688  * code in ctl_set_sense() that uses them.
 1689  *
 1690  * Maximum descriptors allowed: 1 (as of SPC-4)
 1691  */
 1692 struct scsi_sense_info
 1693 {
 1694         uint8_t desc_type;
 1695 #define SSD_DESC_INFO   0x00
 1696         uint8_t length;
 1697         uint8_t byte2;
 1698 #define SSD_INFO_VALID  0x80
 1699         uint8_t reserved;
 1700         uint8_t info[8];
 1701 };
 1702 
 1703 /*
 1704  * Command-specific information depends on the command for which the
 1705  * reported condition occured.
 1706  *
 1707  * Note that any changes to the field names or positions in this structure,
 1708  * even reserved fields, should be accompanied by an examination of the
 1709  * code in ctl_set_sense() that uses them.
 1710  *
 1711  * Maximum descriptors allowed: 1 (as of SPC-4)
 1712  */
 1713 struct scsi_sense_command
 1714 {
 1715         uint8_t desc_type;
 1716 #define SSD_DESC_COMMAND        0x01
 1717         uint8_t length;
 1718         uint8_t reserved[2];
 1719         uint8_t command_info[8];
 1720 };
 1721 
 1722 /*
 1723  * Sense key specific descriptor.  The sense key specific data format
 1724  * depends on the sense key in question.
 1725  *
 1726  * Maximum descriptors allowed: 1 (as of SPC-4)
 1727  */
 1728 struct scsi_sense_sks
 1729 {
 1730         uint8_t desc_type;
 1731 #define SSD_DESC_SKS            0x02
 1732         uint8_t length;
 1733         uint8_t reserved1[2];
 1734         uint8_t sense_key_spec[3];
 1735 #define SSD_SKS_VALID           0x80
 1736         uint8_t reserved2;
 1737 };
 1738 
 1739 /*
 1740  * This is used for the Illegal Request sense key (0x05) only.
 1741  */
 1742 struct scsi_sense_sks_field
 1743 {
 1744         uint8_t byte0;
 1745 #define SSD_SKS_FIELD_VALID     0x80
 1746 #define SSD_SKS_FIELD_CMD       0x40
 1747 #define SSD_SKS_BPV             0x08
 1748 #define SSD_SKS_BIT_VALUE       0x07
 1749         uint8_t field[2];
 1750 };
 1751 
 1752 
 1753 /* 
 1754  * This is used for the Hardware Error (0x04), Medium Error (0x03) and
 1755  * Recovered Error (0x01) sense keys.
 1756  */
 1757 struct scsi_sense_sks_retry
 1758 {
 1759         uint8_t byte0;
 1760 #define SSD_SKS_RETRY_VALID     0x80
 1761         uint8_t actual_retry_count[2];
 1762 };
 1763 
 1764 /*
 1765  * Used with the NO Sense (0x00) or Not Ready (0x02) sense keys.
 1766  */
 1767 struct scsi_sense_sks_progress
 1768 {
 1769         uint8_t byte0;
 1770 #define SSD_SKS_PROGRESS_VALID  0x80
 1771         uint8_t progress[2];
 1772 #define SSD_SKS_PROGRESS_DENOM  0x10000
 1773 };
 1774 
 1775 /*
 1776  * Used with the Copy Aborted (0x0a) sense key.
 1777  */
 1778 struct scsi_sense_sks_segment
 1779 {
 1780         uint8_t byte0;
 1781 #define SSD_SKS_SEGMENT_VALID   0x80
 1782 #define SSD_SKS_SEGMENT_SD      0x20
 1783 #define SSD_SKS_SEGMENT_BPV     0x08
 1784 #define SSD_SKS_SEGMENT_BITPTR  0x07
 1785         uint8_t field[2];
 1786 };
 1787 
 1788 /*
 1789  * Used with the Unit Attention (0x06) sense key.
 1790  *
 1791  * This is currently used to indicate that the unit attention condition
 1792  * queue has overflowed (when the overflow bit is set).
 1793  */
 1794 struct scsi_sense_sks_overflow
 1795 {
 1796         uint8_t byte0;
 1797 #define SSD_SKS_OVERFLOW_VALID  0x80
 1798 #define SSD_SKS_OVERFLOW_SET    0x01
 1799         uint8_t reserved[2];
 1800 };
 1801 
 1802 /*
 1803  * This specifies which component is associated with the sense data.  There
 1804  * is no standard meaning for the fru value.
 1805  *
 1806  * Maximum descriptors allowed: 1 (as of SPC-4)
 1807  */
 1808 struct scsi_sense_fru
 1809 {
 1810         uint8_t desc_type;
 1811 #define SSD_DESC_FRU            0x03
 1812         uint8_t length;
 1813         uint8_t reserved;
 1814         uint8_t fru;
 1815 };
 1816 
 1817 /*
 1818  * Used for Stream commands, defined in SSC-4.
 1819  *
 1820  * Maximum descriptors allowed: 1 (as of SPC-4)
 1821  */
 1822  
 1823 struct scsi_sense_stream
 1824 {
 1825         uint8_t desc_type;
 1826 #define SSD_DESC_STREAM         0x04
 1827         uint8_t length;
 1828         uint8_t reserved;
 1829         uint8_t byte3;
 1830 #define SSD_DESC_STREAM_FM      0x80
 1831 #define SSD_DESC_STREAM_EOM     0x40
 1832 #define SSD_DESC_STREAM_ILI     0x20
 1833 };
 1834 
 1835 /*
 1836  * Used for Block commands, defined in SBC-3.
 1837  *
 1838  * This is currently (as of SBC-3) only used for the Incorrect Length
 1839  * Indication (ILI) bit, which says that the data length requested in the
 1840  * READ LONG or WRITE LONG command did not match the length of the logical
 1841  * block.
 1842  *
 1843  * Maximum descriptors allowed: 1 (as of SPC-4)
 1844  */
 1845 struct scsi_sense_block
 1846 {
 1847         uint8_t desc_type;
 1848 #define SSD_DESC_BLOCK          0x05
 1849         uint8_t length;
 1850         uint8_t reserved;
 1851         uint8_t byte3;
 1852 #define SSD_DESC_BLOCK_ILI      0x20
 1853 };
 1854 
 1855 /*
 1856  * Used for Object-Based Storage Devices (OSD-3).
 1857  *
 1858  * Maximum descriptors allowed: 1 (as of SPC-4)
 1859  */
 1860 struct scsi_sense_osd_objid
 1861 {
 1862         uint8_t desc_type;
 1863 #define SSD_DESC_OSD_OBJID      0x06
 1864         uint8_t length;
 1865         uint8_t reserved[6];
 1866         /*
 1867          * XXX KDM provide the bit definitions here?  There are a lot of
 1868          * them, and we don't have an OSD driver yet.
 1869          */
 1870         uint8_t not_init_cmds[4];
 1871         uint8_t completed_cmds[4];
 1872         uint8_t partition_id[8];
 1873         uint8_t object_id[8];
 1874 };
 1875 
 1876 /*
 1877  * Used for Object-Based Storage Devices (OSD-3).
 1878  *
 1879  * Maximum descriptors allowed: 1 (as of SPC-4)
 1880  */
 1881 struct scsi_sense_osd_integrity
 1882 {
 1883         uint8_t desc_type;
 1884 #define SSD_DESC_OSD_INTEGRITY  0x07
 1885         uint8_t length;
 1886         uint8_t integ_check_val[32];
 1887 };
 1888 
 1889 /*
 1890  * Used for Object-Based Storage Devices (OSD-3).
 1891  *
 1892  * Maximum descriptors allowed: 1 (as of SPC-4)
 1893  */
 1894 struct scsi_sense_osd_attr_id
 1895 {
 1896         uint8_t desc_type;
 1897 #define SSD_DESC_OSD_ATTR_ID    0x08
 1898         uint8_t length;
 1899         uint8_t reserved[2];
 1900         uint8_t attr_desc[0];
 1901 };
 1902 
 1903 /*
 1904  * Used with Sense keys No Sense (0x00) and Not Ready (0x02).
 1905  *
 1906  * Maximum descriptors allowed: 32 (as of SPC-4)
 1907  */
 1908 struct scsi_sense_progress
 1909 {
 1910         uint8_t desc_type;
 1911 #define SSD_DESC_PROGRESS       0x0a
 1912         uint8_t length;
 1913         uint8_t sense_key;
 1914         uint8_t add_sense_code;
 1915         uint8_t add_sense_code_qual;
 1916         uint8_t reserved;
 1917         uint8_t progress[2];
 1918 };
 1919 
 1920 /*
 1921  * This is typically forwarded as the result of an EXTENDED COPY command.
 1922  *
 1923  * Maximum descriptors allowed: 2 (as of SPC-4)
 1924  */
 1925 struct scsi_sense_forwarded
 1926 {
 1927         uint8_t desc_type;
 1928 #define SSD_DESC_FORWARDED      0x0c
 1929         uint8_t length;
 1930         uint8_t byte2;
 1931 #define SSD_FORWARDED_FSDT      0x80
 1932 #define SSD_FORWARDED_SDS_MASK  0x0f
 1933 #define SSD_FORWARDED_SDS_UNK   0x00
 1934 #define SSD_FORWARDED_SDS_EXSRC 0x01
 1935 #define SSD_FORWARDED_SDS_EXDST 0x02
 1936 };
 1937 
 1938 /*
 1939  * Vendor-specific sense descriptor.  The desc_type field will be in the
 1940  * range bewteen MIN and MAX inclusive.
 1941  */
 1942 struct scsi_sense_vendor
 1943 {
 1944         uint8_t desc_type;
 1945 #define SSD_DESC_VENDOR_MIN     0x80
 1946 #define SSD_DESC_VENDOR_MAX     0xff
 1947         uint8_t length;
 1948         uint8_t data[0];
 1949 };
 1950 
 1951 struct scsi_mode_header_6
 1952 {
 1953         u_int8_t data_length;   /* Sense data length */
 1954         u_int8_t medium_type;
 1955         u_int8_t dev_spec;
 1956         u_int8_t blk_desc_len;
 1957 };
 1958 
 1959 struct scsi_mode_header_10
 1960 {
 1961         u_int8_t data_length[2];/* Sense data length */
 1962         u_int8_t medium_type;
 1963         u_int8_t dev_spec;
 1964         u_int8_t unused[2];
 1965         u_int8_t blk_desc_len[2];
 1966 };
 1967 
 1968 struct scsi_mode_page_header
 1969 {
 1970         u_int8_t page_code;
 1971 #define SMPH_PS         0x80
 1972 #define SMPH_SPF        0x40
 1973 #define SMPH_PC_MASK    0x3f
 1974         u_int8_t page_length;
 1975 };
 1976 
 1977 struct scsi_mode_page_header_sp
 1978 {
 1979         uint8_t page_code;
 1980         uint8_t subpage;
 1981         uint8_t page_length[2];
 1982 };
 1983 
 1984 
 1985 struct scsi_mode_blk_desc
 1986 {
 1987         u_int8_t density;
 1988         u_int8_t nblocks[3];
 1989         u_int8_t reserved;
 1990         u_int8_t blklen[3];
 1991 };
 1992 
 1993 #define SCSI_DEFAULT_DENSITY    0x00    /* use 'default' density */
 1994 #define SCSI_SAME_DENSITY       0x7f    /* use 'same' density- >= SCSI-2 only */
 1995 
 1996 
 1997 /*
 1998  * Status Byte
 1999  */
 2000 #define SCSI_STATUS_OK                  0x00
 2001 #define SCSI_STATUS_CHECK_COND          0x02
 2002 #define SCSI_STATUS_COND_MET            0x04
 2003 #define SCSI_STATUS_BUSY                0x08
 2004 #define SCSI_STATUS_INTERMED            0x10
 2005 #define SCSI_STATUS_INTERMED_COND_MET   0x14
 2006 #define SCSI_STATUS_RESERV_CONFLICT     0x18
 2007 #define SCSI_STATUS_CMD_TERMINATED      0x22    /* Obsolete in SAM-2 */
 2008 #define SCSI_STATUS_QUEUE_FULL          0x28
 2009 #define SCSI_STATUS_ACA_ACTIVE          0x30
 2010 #define SCSI_STATUS_TASK_ABORTED        0x40
 2011 
 2012 struct scsi_inquiry_pattern {
 2013         u_int8_t   type;
 2014         u_int8_t   media_type;
 2015 #define SIP_MEDIA_REMOVABLE     0x01
 2016 #define SIP_MEDIA_FIXED         0x02
 2017         const char *vendor;
 2018         const char *product;
 2019         const char *revision;
 2020 }; 
 2021 
 2022 struct scsi_static_inquiry_pattern {
 2023         u_int8_t   type;
 2024         u_int8_t   media_type;
 2025         char       vendor[SID_VENDOR_SIZE+1];
 2026         char       product[SID_PRODUCT_SIZE+1];
 2027         char       revision[SID_REVISION_SIZE+1];
 2028 };
 2029 
 2030 struct scsi_sense_quirk_entry {
 2031         struct scsi_inquiry_pattern     inq_pat;
 2032         int                             num_sense_keys;
 2033         int                             num_ascs;
 2034         struct sense_key_table_entry    *sense_key_info;
 2035         struct asc_table_entry          *asc_info;
 2036 };
 2037 
 2038 struct sense_key_table_entry {
 2039         u_int8_t    sense_key;
 2040         u_int32_t   action;
 2041         const char *desc;
 2042 };
 2043 
 2044 struct asc_table_entry {
 2045         u_int8_t    asc;
 2046         u_int8_t    ascq;
 2047         u_int32_t   action;
 2048         const char *desc;
 2049 };
 2050 
 2051 struct op_table_entry {
 2052         u_int8_t    opcode;
 2053         u_int32_t   opmask;
 2054         const char  *desc;
 2055 };
 2056 
 2057 struct scsi_op_quirk_entry {
 2058         struct scsi_inquiry_pattern     inq_pat;
 2059         int                             num_ops;
 2060         struct op_table_entry           *op_table;
 2061 };
 2062 
 2063 typedef enum {
 2064         SSS_FLAG_NONE           = 0x00,
 2065         SSS_FLAG_PRINT_COMMAND  = 0x01
 2066 } scsi_sense_string_flags;
 2067 
 2068 struct ccb_scsiio;
 2069 struct cam_periph;
 2070 union  ccb;
 2071 #ifndef _KERNEL
 2072 struct cam_device;
 2073 #endif
 2074 
 2075 extern const char *scsi_sense_key_text[];
 2076 
 2077 struct sbuf;
 2078 
 2079 __BEGIN_DECLS
 2080 void scsi_sense_desc(int sense_key, int asc, int ascq,
 2081                      struct scsi_inquiry_data *inq_data,
 2082                      const char **sense_key_desc, const char **asc_desc);
 2083 scsi_sense_action scsi_error_action(struct ccb_scsiio* csio,
 2084                                     struct scsi_inquiry_data *inq_data,
 2085                                     u_int32_t sense_flags);
 2086 const char *    scsi_status_string(struct ccb_scsiio *csio);
 2087 
 2088 void scsi_desc_iterate(struct scsi_sense_data_desc *sense, u_int sense_len,
 2089                        int (*iter_func)(struct scsi_sense_data_desc *sense,
 2090                                         u_int, struct scsi_sense_desc_header *,
 2091                                         void *), void *arg);
 2092 uint8_t *scsi_find_desc(struct scsi_sense_data_desc *sense, u_int sense_len,
 2093                         uint8_t desc_type);
 2094 void scsi_set_sense_data(struct scsi_sense_data *sense_data, 
 2095                          scsi_sense_data_type sense_format, int current_error,
 2096                          int sense_key, int asc, int ascq, ...) ;
 2097 void scsi_set_sense_data_va(struct scsi_sense_data *sense_data,
 2098                             scsi_sense_data_type sense_format,
 2099                             int current_error, int sense_key, int asc,
 2100                             int ascq, va_list ap);
 2101 int scsi_get_sense_info(struct scsi_sense_data *sense_data, u_int sense_len,
 2102                         uint8_t info_type, uint64_t *info,
 2103                         int64_t *signed_info);
 2104 int scsi_get_sks(struct scsi_sense_data *sense_data, u_int sense_len,
 2105                  uint8_t *sks);
 2106 int scsi_get_block_info(struct scsi_sense_data *sense_data, u_int sense_len,
 2107                         struct scsi_inquiry_data *inq_data,
 2108                         uint8_t *block_bits);
 2109 int scsi_get_stream_info(struct scsi_sense_data *sense_data, u_int sense_len,
 2110                          struct scsi_inquiry_data *inq_data,
 2111                          uint8_t *stream_bits);
 2112 void scsi_info_sbuf(struct sbuf *sb, uint8_t *cdb, int cdb_len,
 2113                     struct scsi_inquiry_data *inq_data, uint64_t info);
 2114 void scsi_command_sbuf(struct sbuf *sb, uint8_t *cdb, int cdb_len,
 2115                        struct scsi_inquiry_data *inq_data, uint64_t csi);
 2116 void scsi_progress_sbuf(struct sbuf *sb, uint16_t progress);
 2117 int scsi_sks_sbuf(struct sbuf *sb, int sense_key, uint8_t *sks);
 2118 void scsi_fru_sbuf(struct sbuf *sb, uint64_t fru);
 2119 void scsi_stream_sbuf(struct sbuf *sb, uint8_t stream_bits, uint64_t info);
 2120 void scsi_block_sbuf(struct sbuf *sb, uint8_t block_bits, uint64_t info);
 2121 void scsi_sense_info_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
 2122                           u_int sense_len, uint8_t *cdb, int cdb_len,
 2123                           struct scsi_inquiry_data *inq_data,
 2124                           struct scsi_sense_desc_header *header);
 2125 
 2126 void scsi_sense_command_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
 2127                              u_int sense_len, uint8_t *cdb, int cdb_len,
 2128                              struct scsi_inquiry_data *inq_data,
 2129                              struct scsi_sense_desc_header *header);
 2130 void scsi_sense_sks_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
 2131                          u_int sense_len, uint8_t *cdb, int cdb_len,
 2132                          struct scsi_inquiry_data *inq_data,
 2133                          struct scsi_sense_desc_header *header);
 2134 void scsi_sense_fru_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
 2135                          u_int sense_len, uint8_t *cdb, int cdb_len,
 2136                          struct scsi_inquiry_data *inq_data,
 2137                          struct scsi_sense_desc_header *header);
 2138 void scsi_sense_stream_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
 2139                             u_int sense_len, uint8_t *cdb, int cdb_len,
 2140                             struct scsi_inquiry_data *inq_data,
 2141                             struct scsi_sense_desc_header *header);
 2142 void scsi_sense_block_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
 2143                            u_int sense_len, uint8_t *cdb, int cdb_len,
 2144                            struct scsi_inquiry_data *inq_data,
 2145                            struct scsi_sense_desc_header *header);
 2146 void scsi_sense_progress_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
 2147                               u_int sense_len, uint8_t *cdb, int cdb_len,
 2148                               struct scsi_inquiry_data *inq_data,
 2149                               struct scsi_sense_desc_header *header);
 2150 void scsi_sense_generic_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
 2151                              u_int sense_len, uint8_t *cdb, int cdb_len,
 2152                              struct scsi_inquiry_data *inq_data,
 2153                              struct scsi_sense_desc_header *header);
 2154 void scsi_sense_desc_sbuf(struct sbuf *sb, struct scsi_sense_data *sense,
 2155                           u_int sense_len, uint8_t *cdb, int cdb_len,
 2156                           struct scsi_inquiry_data *inq_data,
 2157                           struct scsi_sense_desc_header *header);
 2158 scsi_sense_data_type scsi_sense_type(struct scsi_sense_data *sense_data);
 2159 
 2160 void scsi_sense_only_sbuf(struct scsi_sense_data *sense, u_int sense_len,
 2161                           struct sbuf *sb, char *path_str,
 2162                           struct scsi_inquiry_data *inq_data, uint8_t *cdb,
 2163                           int cdb_len);
 2164 
 2165 #ifdef _KERNEL
 2166 int             scsi_command_string(struct ccb_scsiio *csio, struct sbuf *sb);
 2167 int             scsi_sense_sbuf(struct ccb_scsiio *csio, struct sbuf *sb,
 2168                                 scsi_sense_string_flags flags);
 2169 char *          scsi_sense_string(struct ccb_scsiio *csio,
 2170                                   char *str, int str_len);
 2171 void            scsi_sense_print(struct ccb_scsiio *csio);
 2172 #else /* _KERNEL */
 2173 int             scsi_command_string(struct cam_device *device,
 2174                                     struct ccb_scsiio *csio, struct sbuf *sb);
 2175 int             scsi_sense_sbuf(struct cam_device *device, 
 2176                                 struct ccb_scsiio *csio, struct sbuf *sb,
 2177                                 scsi_sense_string_flags flags);
 2178 char *          scsi_sense_string(struct cam_device *device, 
 2179                                   struct ccb_scsiio *csio,
 2180                                   char *str, int str_len);
 2181 void            scsi_sense_print(struct cam_device *device, 
 2182                                  struct ccb_scsiio *csio, FILE *ofile);
 2183 #endif /* _KERNEL */
 2184 
 2185 const char *    scsi_op_desc(u_int16_t opcode, 
 2186                              struct scsi_inquiry_data *inq_data);
 2187 char *          scsi_cdb_string(u_int8_t *cdb_ptr, char *cdb_string,
 2188                                 size_t len);
 2189 
 2190 void            scsi_print_inquiry(struct scsi_inquiry_data *inq_data);
 2191 
 2192 u_int           scsi_calc_syncsrate(u_int period_factor);
 2193 u_int           scsi_calc_syncparam(u_int period);
 2194 
 2195 typedef int     (*scsi_devid_checkfn_t)(uint8_t *);
 2196 int             scsi_devid_is_naa_ieee_reg(uint8_t *bufp);
 2197 int             scsi_devid_is_sas_target(uint8_t *bufp);
 2198 uint8_t *       scsi_get_devid(struct scsi_vpd_device_id *id, uint32_t len,
 2199                                scsi_devid_checkfn_t ck_fn);
 2200 
 2201 void            scsi_test_unit_ready(struct ccb_scsiio *csio, u_int32_t retries,
 2202                                      void (*cbfcnp)(struct cam_periph *, 
 2203                                                     union ccb *),
 2204                                      u_int8_t tag_action, 
 2205                                      u_int8_t sense_len, u_int32_t timeout);
 2206 
 2207 void            scsi_request_sense(struct ccb_scsiio *csio, u_int32_t retries,
 2208                                    void (*cbfcnp)(struct cam_periph *, 
 2209                                                   union ccb *),
 2210                                    void *data_ptr, u_int8_t dxfer_len,
 2211                                    u_int8_t tag_action, u_int8_t sense_len,
 2212                                    u_int32_t timeout);
 2213 
 2214 void            scsi_inquiry(struct ccb_scsiio *csio, u_int32_t retries,
 2215                              void (*cbfcnp)(struct cam_periph *, union ccb *),
 2216                              u_int8_t tag_action, u_int8_t *inq_buf, 
 2217                              u_int32_t inq_len, int evpd, u_int8_t page_code,
 2218                              u_int8_t sense_len, u_int32_t timeout);
 2219 
 2220 void            scsi_mode_sense(struct ccb_scsiio *csio, u_int32_t retries,
 2221                                 void (*cbfcnp)(struct cam_periph *,
 2222                                                union ccb *),
 2223                                 u_int8_t tag_action, int dbd,
 2224                                 u_int8_t page_code, u_int8_t page,
 2225                                 u_int8_t *param_buf, u_int32_t param_len,
 2226                                 u_int8_t sense_len, u_int32_t timeout);
 2227 
 2228 void            scsi_mode_sense_len(struct ccb_scsiio *csio, u_int32_t retries,
 2229                                     void (*cbfcnp)(struct cam_periph *,
 2230                                                    union ccb *),
 2231                                     u_int8_t tag_action, int dbd,
 2232                                     u_int8_t page_code, u_int8_t page,
 2233                                     u_int8_t *param_buf, u_int32_t param_len,
 2234                                     int minimum_cmd_size, u_int8_t sense_len,
 2235                                     u_int32_t timeout);
 2236 
 2237 void            scsi_mode_select(struct ccb_scsiio *csio, u_int32_t retries,
 2238                                  void (*cbfcnp)(struct cam_periph *,
 2239                                                 union ccb *),
 2240                                  u_int8_t tag_action, int scsi_page_fmt,
 2241                                  int save_pages, u_int8_t *param_buf,
 2242                                  u_int32_t param_len, u_int8_t sense_len,
 2243                                  u_int32_t timeout);
 2244 
 2245 void            scsi_mode_select_len(struct ccb_scsiio *csio, u_int32_t retries,
 2246                                      void (*cbfcnp)(struct cam_periph *,
 2247                                                     union ccb *),
 2248                                      u_int8_t tag_action, int scsi_page_fmt,
 2249                                      int save_pages, u_int8_t *param_buf,
 2250                                      u_int32_t param_len, int minimum_cmd_size,
 2251                                      u_int8_t sense_len, u_int32_t timeout);
 2252 
 2253 void            scsi_log_sense(struct ccb_scsiio *csio, u_int32_t retries,
 2254                                void (*cbfcnp)(struct cam_periph *, union ccb *),
 2255                                u_int8_t tag_action, u_int8_t page_code,
 2256                                u_int8_t page, int save_pages, int ppc,
 2257                                u_int32_t paramptr, u_int8_t *param_buf,
 2258                                u_int32_t param_len, u_int8_t sense_len,
 2259                                u_int32_t timeout);
 2260 
 2261 void            scsi_log_select(struct ccb_scsiio *csio, u_int32_t retries,
 2262                                 void (*cbfcnp)(struct cam_periph *,
 2263                                 union ccb *), u_int8_t tag_action,
 2264                                 u_int8_t page_code, int save_pages,
 2265                                 int pc_reset, u_int8_t *param_buf,
 2266                                 u_int32_t param_len, u_int8_t sense_len,
 2267                                 u_int32_t timeout);
 2268 
 2269 void            scsi_prevent(struct ccb_scsiio *csio, u_int32_t retries,
 2270                              void (*cbfcnp)(struct cam_periph *, union ccb *),
 2271                              u_int8_t tag_action, u_int8_t action,
 2272                              u_int8_t sense_len, u_int32_t timeout);
 2273 
 2274 void            scsi_read_capacity(struct ccb_scsiio *csio, u_int32_t retries,
 2275                                    void (*cbfcnp)(struct cam_periph *, 
 2276                                    union ccb *), u_int8_t tag_action, 
 2277                                    struct scsi_read_capacity_data *,
 2278                                    u_int8_t sense_len, u_int32_t timeout);
 2279 void            scsi_read_capacity_16(struct ccb_scsiio *csio, uint32_t retries,
 2280                                       void (*cbfcnp)(struct cam_periph *,
 2281                                       union ccb *), uint8_t tag_action,
 2282                                       uint64_t lba, int reladr, int pmi,
 2283                                       struct scsi_read_capacity_data_long
 2284                                       *rcap_buf, uint8_t sense_len,
 2285                                       uint32_t timeout);
 2286 
 2287 void            scsi_report_luns(struct ccb_scsiio *csio, u_int32_t retries,
 2288                                  void (*cbfcnp)(struct cam_periph *, 
 2289                                  union ccb *), u_int8_t tag_action, 
 2290                                  u_int8_t select_report,
 2291                                  struct scsi_report_luns_data *rpl_buf,
 2292                                  u_int32_t alloc_len, u_int8_t sense_len,
 2293                                  u_int32_t timeout);
 2294 
 2295 void            scsi_report_target_group(struct ccb_scsiio *csio, u_int32_t retries,
 2296                                  void (*cbfcnp)(struct cam_periph *, 
 2297                                  union ccb *), u_int8_t tag_action, 
 2298                                  u_int8_t pdf,
 2299                                  void *buf,
 2300                                  u_int32_t alloc_len, u_int8_t sense_len,
 2301                                  u_int32_t timeout);
 2302 
 2303 void            scsi_set_target_group(struct ccb_scsiio *csio, u_int32_t retries,
 2304                                  void (*cbfcnp)(struct cam_periph *, 
 2305                                  union ccb *), u_int8_t tag_action, void *buf,
 2306                                  u_int32_t alloc_len, u_int8_t sense_len,
 2307                                  u_int32_t timeout);
 2308 
 2309 void            scsi_synchronize_cache(struct ccb_scsiio *csio, 
 2310                                        u_int32_t retries,
 2311                                        void (*cbfcnp)(struct cam_periph *, 
 2312                                        union ccb *), u_int8_t tag_action, 
 2313                                        u_int32_t begin_lba, u_int16_t lb_count,
 2314                                        u_int8_t sense_len, u_int32_t timeout);
 2315 
 2316 void scsi_receive_diagnostic_results(struct ccb_scsiio *csio, u_int32_t retries,
 2317                                      void (*cbfcnp)(struct cam_periph *,
 2318                                                     union ccb*),
 2319                                      uint8_t tag_action, int pcv,
 2320                                      uint8_t page_code, uint8_t *data_ptr,
 2321                                      uint16_t allocation_length,
 2322                                      uint8_t sense_len, uint32_t timeout);
 2323 
 2324 void scsi_send_diagnostic(struct ccb_scsiio *csio, u_int32_t retries,
 2325                           void (*cbfcnp)(struct cam_periph *, union ccb *),
 2326                           uint8_t tag_action, int unit_offline,
 2327                           int device_offline, int self_test, int page_format,
 2328                           int self_test_code, uint8_t *data_ptr,
 2329                           uint16_t param_list_length, uint8_t sense_len,
 2330                           uint32_t timeout);
 2331 
 2332 void scsi_read_buffer(struct ccb_scsiio *csio, u_int32_t retries,
 2333                         void (*cbfcnp)(struct cam_periph *, union ccb*),
 2334                         uint8_t tag_action, int mode,
 2335                         uint8_t buffer_id, u_int32_t offset,
 2336                         uint8_t *data_ptr, uint32_t allocation_length,
 2337                         uint8_t sense_len, uint32_t timeout);
 2338 
 2339 void scsi_write_buffer(struct ccb_scsiio *csio, u_int32_t retries,
 2340                         void (*cbfcnp)(struct cam_periph *, union ccb *),
 2341                         uint8_t tag_action, int mode,
 2342                         uint8_t buffer_id, u_int32_t offset,
 2343                         uint8_t *data_ptr, uint32_t param_list_length,
 2344                         uint8_t sense_len, uint32_t timeout);
 2345 
 2346 void scsi_read_write(struct ccb_scsiio *csio, u_int32_t retries,
 2347                      void (*cbfcnp)(struct cam_periph *, union ccb *),
 2348                      u_int8_t tag_action, int readop, u_int8_t byte2, 
 2349                      int minimum_cmd_size, u_int64_t lba,
 2350                      u_int32_t block_count, u_int8_t *data_ptr,
 2351                      u_int32_t dxfer_len, u_int8_t sense_len,
 2352                      u_int32_t timeout);
 2353 
 2354 void scsi_write_same(struct ccb_scsiio *csio, u_int32_t retries,
 2355                      void (*cbfcnp)(struct cam_periph *, union ccb *),
 2356                      u_int8_t tag_action, u_int8_t byte2, 
 2357                      int minimum_cmd_size, u_int64_t lba,
 2358                      u_int32_t block_count, u_int8_t *data_ptr,
 2359                      u_int32_t dxfer_len, u_int8_t sense_len,
 2360                      u_int32_t timeout);
 2361 
 2362 void scsi_unmap(struct ccb_scsiio *csio, u_int32_t retries,
 2363                 void (*cbfcnp)(struct cam_periph *, union ccb *),
 2364                 u_int8_t tag_action, u_int8_t byte2,
 2365                 u_int8_t *data_ptr, u_int16_t dxfer_len,
 2366                 u_int8_t sense_len, u_int32_t timeout);
 2367 
 2368 void scsi_start_stop(struct ccb_scsiio *csio, u_int32_t retries,
 2369                      void (*cbfcnp)(struct cam_periph *, union ccb *),
 2370                      u_int8_t tag_action, int start, int load_eject,
 2371                      int immediate, u_int8_t sense_len, u_int32_t timeout);
 2372 
 2373 int             scsi_inquiry_match(caddr_t inqbuffer, caddr_t table_entry);
 2374 int             scsi_static_inquiry_match(caddr_t inqbuffer,
 2375                                           caddr_t table_entry);
 2376 int             scsi_devid_match(uint8_t *rhs, size_t rhs_len,
 2377                                  uint8_t *lhs, size_t lhs_len);
 2378 
 2379 void scsi_extract_sense(struct scsi_sense_data *sense, int *error_code,
 2380                         int *sense_key, int *asc, int *ascq);
 2381 void scsi_extract_sense_len(struct scsi_sense_data *sense,
 2382                             u_int sense_len, int *error_code, int *sense_key,
 2383                             int *asc, int *ascq, int show_errors);
 2384 int scsi_get_sense_key(struct scsi_sense_data *sense, u_int sense_len,
 2385                        int show_errors);
 2386 int scsi_get_asc(struct scsi_sense_data *sense, u_int sense_len,
 2387                  int show_errors);
 2388 int scsi_get_ascq(struct scsi_sense_data *sense, u_int sense_len,
 2389                   int show_errors);
 2390 static __inline void scsi_ulto2b(u_int32_t val, u_int8_t *bytes);
 2391 static __inline void scsi_ulto3b(u_int32_t val, u_int8_t *bytes);
 2392 static __inline void scsi_ulto4b(u_int32_t val, u_int8_t *bytes);
 2393 static __inline void scsi_u64to8b(u_int64_t val, u_int8_t *bytes);
 2394 static __inline uint32_t scsi_2btoul(const uint8_t *bytes);
 2395 static __inline uint32_t scsi_3btoul(const uint8_t *bytes);
 2396 static __inline int32_t scsi_3btol(const uint8_t *bytes);
 2397 static __inline uint32_t scsi_4btoul(const uint8_t *bytes);
 2398 static __inline uint64_t scsi_8btou64(const uint8_t *bytes);
 2399 static __inline void *find_mode_page_6(struct scsi_mode_header_6 *mode_header);
 2400 static __inline void *find_mode_page_10(struct scsi_mode_header_10 *mode_header);
 2401 
 2402 static __inline void
 2403 scsi_ulto2b(u_int32_t val, u_int8_t *bytes)
 2404 {
 2405 
 2406         bytes[0] = (val >> 8) & 0xff;
 2407         bytes[1] = val & 0xff;
 2408 }
 2409 
 2410 static __inline void
 2411 scsi_ulto3b(u_int32_t val, u_int8_t *bytes)
 2412 {
 2413 
 2414         bytes[0] = (val >> 16) & 0xff;
 2415         bytes[1] = (val >> 8) & 0xff;
 2416         bytes[2] = val & 0xff;
 2417 }
 2418 
 2419 static __inline void
 2420 scsi_ulto4b(u_int32_t val, u_int8_t *bytes)
 2421 {
 2422 
 2423         bytes[0] = (val >> 24) & 0xff;
 2424         bytes[1] = (val >> 16) & 0xff;
 2425         bytes[2] = (val >> 8) & 0xff;
 2426         bytes[3] = val & 0xff;
 2427 }
 2428 
 2429 static __inline void
 2430 scsi_u64to8b(u_int64_t val, u_int8_t *bytes)
 2431 {
 2432 
 2433         bytes[0] = (val >> 56) & 0xff;
 2434         bytes[1] = (val >> 48) & 0xff;
 2435         bytes[2] = (val >> 40) & 0xff;
 2436         bytes[3] = (val >> 32) & 0xff;
 2437         bytes[4] = (val >> 24) & 0xff;
 2438         bytes[5] = (val >> 16) & 0xff;
 2439         bytes[6] = (val >> 8) & 0xff;
 2440         bytes[7] = val & 0xff;
 2441 }
 2442 
 2443 static __inline uint32_t
 2444 scsi_2btoul(const uint8_t *bytes)
 2445 {
 2446         uint32_t rv;
 2447 
 2448         rv = (bytes[0] << 8) |
 2449              bytes[1];
 2450         return (rv);
 2451 }
 2452 
 2453 static __inline uint32_t
 2454 scsi_3btoul(const uint8_t *bytes)
 2455 {
 2456         uint32_t rv;
 2457 
 2458         rv = (bytes[0] << 16) |
 2459              (bytes[1] << 8) |
 2460              bytes[2];
 2461         return (rv);
 2462 }
 2463 
 2464 static __inline int32_t 
 2465 scsi_3btol(const uint8_t *bytes)
 2466 {
 2467         uint32_t rc = scsi_3btoul(bytes);
 2468  
 2469         if (rc & 0x00800000)
 2470                 rc |= 0xff000000;
 2471 
 2472         return (int32_t) rc;
 2473 }
 2474 
 2475 static __inline uint32_t
 2476 scsi_4btoul(const uint8_t *bytes)
 2477 {
 2478         uint32_t rv;
 2479 
 2480         rv = (bytes[0] << 24) |
 2481              (bytes[1] << 16) |
 2482              (bytes[2] << 8) |
 2483              bytes[3];
 2484         return (rv);
 2485 }
 2486 
 2487 static __inline uint64_t
 2488 scsi_8btou64(const uint8_t *bytes)
 2489 {
 2490         uint64_t rv;
 2491  
 2492         rv = (((uint64_t)bytes[0]) << 56) |
 2493              (((uint64_t)bytes[1]) << 48) |
 2494              (((uint64_t)bytes[2]) << 40) |
 2495              (((uint64_t)bytes[3]) << 32) |
 2496              (((uint64_t)bytes[4]) << 24) |
 2497              (((uint64_t)bytes[5]) << 16) |
 2498              (((uint64_t)bytes[6]) << 8) |
 2499              bytes[7];
 2500         return (rv);
 2501 }
 2502 
 2503 /*
 2504  * Given the pointer to a returned mode sense buffer, return a pointer to
 2505  * the start of the first mode page.
 2506  */
 2507 static __inline void *
 2508 find_mode_page_6(struct scsi_mode_header_6 *mode_header)
 2509 {
 2510         void *page_start;
 2511 
 2512         page_start = (void *)((u_int8_t *)&mode_header[1] +
 2513                               mode_header->blk_desc_len);
 2514 
 2515         return(page_start);
 2516 }
 2517 
 2518 static __inline void *
 2519 find_mode_page_10(struct scsi_mode_header_10 *mode_header)
 2520 {
 2521         void *page_start;
 2522 
 2523         page_start = (void *)((u_int8_t *)&mode_header[1] +
 2524                                scsi_2btoul(mode_header->blk_desc_len));
 2525 
 2526         return(page_start);
 2527 }
 2528 
 2529 __END_DECLS
 2530 
 2531 #endif /*_SCSI_SCSI_ALL_H*/

Cache object: 3a3e7c5f95b88a5f1304ca54031a7511


[ 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.