LXR qemu/include/scsi/utils.h

   1#ifndef SCSI_UTILS_H
   2#define SCSI_UTILS_H
   3
   4#ifdef CONFIG_LINUX
   5#include <scsi/sg.h>
   6#endif
   7
   8#define SCSI_CMD_BUF_SIZE      16
   9#define SCSI_SENSE_LEN         18
  10#define SCSI_SENSE_LEN_SCANNER 32
  11#define SCSI_INQUIRY_LEN       36
  12
  13enum SCSIXferMode {
  14    SCSI_XFER_NONE,      /*  TEST_UNIT_READY, ...            */
  15    SCSI_XFER_FROM_DEV,  /*  READ, INQUIRY, MODE_SENSE, ...  */
  16    SCSI_XFER_TO_DEV,    /*  WRITE, MODE_SELECT, ...         */
  17};
  18
  19typedef struct SCSICommand {
  20    uint8_t buf[SCSI_CMD_BUF_SIZE];
  21    int len;
  22    size_t xfer;
  23    uint64_t lba;
  24    enum SCSIXferMode mode;
  25} SCSICommand;
  26
  27typedef struct SCSISense {
  28    uint8_t key;
  29    uint8_t asc;
  30    uint8_t ascq;
  31} SCSISense;
  32
  33int scsi_build_sense(uint8_t *buf, SCSISense sense);
  34SCSISense scsi_parse_sense_buf(const uint8_t *in_buf, int in_len);
  35int scsi_build_sense_buf(uint8_t *buf, size_t max_size, SCSISense sense,
  36                         bool fixed_sense);
  37
  38/*
  39 * Predefined sense codes
  40 */
  41
  42/* No sense data available */
  43extern const struct SCSISense sense_code_NO_SENSE;
  44/* LUN not ready, Manual intervention required */
  45extern const struct SCSISense sense_code_LUN_NOT_READY;
  46/* LUN not ready, Medium not present */
  47extern const struct SCSISense sense_code_NO_MEDIUM;
  48/* LUN not ready, medium removal prevented */
  49extern const struct SCSISense sense_code_NOT_READY_REMOVAL_PREVENTED;
  50/* Hardware error, internal target failure */
  51extern const struct SCSISense sense_code_TARGET_FAILURE;
  52/* Illegal request, invalid command operation code */
  53extern const struct SCSISense sense_code_INVALID_OPCODE;
  54/* Illegal request, LBA out of range */
  55extern const struct SCSISense sense_code_LBA_OUT_OF_RANGE;
  56/* Illegal request, Invalid field in CDB */
  57extern const struct SCSISense sense_code_INVALID_FIELD;
  58/* Illegal request, Invalid field in parameter list */
  59extern const struct SCSISense sense_code_INVALID_PARAM;
  60/* Illegal request, Parameter list length error */
  61extern const struct SCSISense sense_code_INVALID_PARAM_LEN;
  62/* Illegal request, LUN not supported */
  63extern const struct SCSISense sense_code_LUN_NOT_SUPPORTED;
  64/* Illegal request, Saving parameters not supported */
  65extern const struct SCSISense sense_code_SAVING_PARAMS_NOT_SUPPORTED;
  66/* Illegal request, Incompatible format */
  67extern const struct SCSISense sense_code_INCOMPATIBLE_FORMAT;
  68/* Illegal request, medium removal prevented */
  69extern const struct SCSISense sense_code_ILLEGAL_REQ_REMOVAL_PREVENTED;
  70/* Illegal request, Invalid Transfer Tag */
  71extern const struct SCSISense sense_code_INVALID_TAG;
  72/* Command aborted, I/O process terminated */
  73extern const struct SCSISense sense_code_IO_ERROR;
  74/* Command aborted, I_T Nexus loss occurred */
  75extern const struct SCSISense sense_code_I_T_NEXUS_LOSS;
  76/* Command aborted, Logical Unit failure */
  77extern const struct SCSISense sense_code_LUN_FAILURE;
  78/* Command aborted, LUN Communication failure */
  79extern const struct SCSISense sense_code_LUN_COMM_FAILURE;
  80/* Command aborted, Overlapped Commands Attempted */
  81extern const struct SCSISense sense_code_OVERLAPPED_COMMANDS;
  82/* Medium error, Unrecovered read error */
  83extern const struct SCSISense sense_code_READ_ERROR;
  84/* LUN not ready, Cause not reportable */
  85extern const struct SCSISense sense_code_NOT_READY;
  86/* Unit attention, Capacity data has changed */
  87extern const struct SCSISense sense_code_CAPACITY_CHANGED;
  88/* Unit attention, SCSI bus reset */
  89extern const struct SCSISense sense_code_SCSI_BUS_RESET;
  90/* LUN not ready, Medium not present */
  91extern const struct SCSISense sense_code_UNIT_ATTENTION_NO_MEDIUM;
  92/* Unit attention, Power on, reset or bus device reset occurred */
  93extern const struct SCSISense sense_code_RESET;
  94/* Unit attention, Medium may have changed*/
  95extern const struct SCSISense sense_code_MEDIUM_CHANGED;
  96/* Unit attention, Reported LUNs data has changed */
  97extern const struct SCSISense sense_code_REPORTED_LUNS_CHANGED;
  98/* Unit attention, Device internal reset */
  99extern const struct SCSISense sense_code_DEVICE_INTERNAL_RESET;
 100/* Data Protection, Write Protected */
 101extern const struct SCSISense sense_code_WRITE_PROTECTED;
 102/* Data Protection, Space Allocation Failed Write Protect */
 103extern const struct SCSISense sense_code_SPACE_ALLOC_FAILED;
 104
 105#define SENSE_CODE(x) sense_code_ ## x
 106
 107int scsi_sense_to_errno(int key, int asc, int ascq);
 108int scsi_sense_buf_to_errno(const uint8_t *sense, size_t sense_size);
 109bool scsi_sense_buf_is_guest_recoverable(const uint8_t *sense, size_t sense_size);
 110
 111int scsi_convert_sense(uint8_t *in_buf, int in_len,
 112                       uint8_t *buf, int len, bool fixed);
 113const char *scsi_command_name(uint8_t cmd);
 114
 115uint64_t scsi_cmd_lba(SCSICommand *cmd);
 116uint32_t scsi_data_cdb_xfer(uint8_t *buf);
 117uint32_t scsi_cdb_xfer(uint8_t *buf);
 118int scsi_cdb_length(uint8_t *buf);
 119
 120/* Linux SG_IO interface.  */
 121#ifdef CONFIG_LINUX
 122#define SG_ERR_DRIVER_TIMEOUT  0x06
 123#define SG_ERR_DRIVER_SENSE    0x08
 124
 125#define SG_ERR_DID_OK          0x00
 126#define SG_ERR_DID_NO_CONNECT  0x01
 127#define SG_ERR_DID_BUS_BUSY    0x02
 128#define SG_ERR_DID_TIME_OUT    0x03
 129
 130#define SG_ERR_DRIVER_SENSE    0x08
 131
 132int sg_io_sense_from_errno(int errno_value, struct sg_io_hdr *io_hdr,
 133                           SCSISense *sense);
 134#endif
 135
 136#endif
 137