include/scsi/scsi_common.h

   1 /*
   2  * Functions used by both the SCSI initiator code and the SCSI target code.
   3  */
   4
   5 #ifndef _SCSI_COMMON_H_
   6 #define _SCSI_COMMON_H_
   7
   8 #include <linux/types.h>
   9 #include <scsi/scsi_proto.h>
  10
  11 static inline unsigned
  12 scsi_varlen_cdb_length(const void *hdr)
  13 {
  14         return ((struct scsi_varlen_cdb_hdr *)hdr)->additional_cdb_length + 8;
  15 }
  16
  17 extern const unsigned char scsi_command_size_tbl[8];
  18 #define COMMAND_SIZE(opcode) scsi_command_size_tbl[((opcode) >> 5) & 7]
  19
  20 static inline unsigned
  21 scsi_command_size(const unsigned char *cmnd)
  22 {
  23         return (cmnd[0] == VARIABLE_LENGTH_CMD) ?
  24                 scsi_varlen_cdb_length(cmnd) : COMMAND_SIZE(cmnd[0]);
  25 }
  26
  27 static inline unsigned char
  28 scsi_command_control(const unsigned char *cmnd)
  29 {
  30         return (cmnd[0] == VARIABLE_LENGTH_CMD) ?
  31                 cmnd[1] : cmnd[COMMAND_SIZE(cmnd[0]) - 1];
  32 }
  33
  34 /* Returns a human-readable name for the device */
  35 extern const char *scsi_device_type(unsigned type);
  36
  37 extern void int_to_scsilun(u64, struct scsi_lun *);
  38 extern u64 scsilun_to_int(struct scsi_lun *);
  39
  40 /*
  41  * This is a slightly modified SCSI sense "descriptor" format header.
  42  * The addition is to allow the 0x70 and 0x71 response codes. The idea
  43  * is to place the salient data from either "fixed" or "descriptor" sense
  44  * format into one structure to ease application processing.
  45  *
  46  * The original sense buffer should be kept around for those cases
  47  * in which more information is required (e.g. the LBA of a MEDIUM ERROR).
  48  */
  49 struct scsi_sense_hdr {         /* See SPC-3 section 4.5 */
  50         u8 response_code;       /* permit: 0x0, 0x70, 0x71, 0x72, 0x73 */
  51         u8 sense_key;
  52         u8 asc;
  53         u8 ascq;
  54         u8 byte4;
  55         u8 byte5;
  56         u8 byte6;
  57         u8 additional_length;   /* always 0 for fixed sense format */
  58 };
  59
  60 static inline bool scsi_sense_valid(const struct scsi_sense_hdr *sshdr)
  61 {
  62         if (!sshdr)
  63                 return false;
  64
  65         return (sshdr->response_code & 0x70) == 0x70;
  66 }
  67
  68 extern bool scsi_normalize_sense(const u8 *sense_buffer, int sb_len,
  69                                  struct scsi_sense_hdr *sshdr);
  70
  71 extern void scsi_build_sense_buffer(int desc, u8 *buf, u8 key, u8 asc, u8 ascq);
  72 int scsi_set_sense_information(u8 *buf, int buf_len, u64 info);
  73 int scsi_set_sense_field_pointer(u8 *buf, int buf_len, u16 fp, u8 bp, bool cd);
  74 extern const u8 * scsi_sense_desc_find(const u8 * sense_buffer, int sb_len,
  75                                        int desc_type);
  76
  77 #endif /* _SCSI_COMMON_H_ */