include/scsi/scsi_cmnd.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _SCSI_SCSI_CMND_H
   3 #define _SCSI_SCSI_CMND_H
   4
   5 #include <linux/dma-mapping.h>
   6 #include <linux/blkdev.h>
   7 #include <linux/t10-pi.h>
   8 #include <linux/list.h>
   9 #include <linux/types.h>
  10 #include <linux/timer.h>
  11 #include <linux/scatterlist.h>
  12 #include <scsi/scsi_device.h>
  13 #include <scsi/scsi_host.h>
  14 #include <scsi/scsi_request.h>
  15
  16 struct Scsi_Host;
  17 struct scsi_driver;
  18
  19 /*
  20  * MAX_COMMAND_SIZE is:
  21  * The longest fixed-length SCSI CDB as per the SCSI standard.
  22  * fixed-length means: commands that their size can be determined
  23  * by their opcode and the CDB does not carry a length specifier, (unlike
  24  * the VARIABLE_LENGTH_CMD(0x7f) command). This is actually not exactly
  25  * true and the SCSI standard also defines extended commands and
  26  * vendor specific commands that can be bigger than 16 bytes. The kernel
  27  * will support these using the same infrastructure used for VARLEN CDB's.
  28  * So in effect MAX_COMMAND_SIZE means the maximum size command scsi-ml
  29  * supports without specifying a cmd_len by ULD's
  30  */
  31 #define MAX_COMMAND_SIZE 16
  32 #if (MAX_COMMAND_SIZE > BLK_MAX_CDB)
  33 # error MAX_COMMAND_SIZE can not be bigger than BLK_MAX_CDB
  34 #endif
  35
  36 struct scsi_data_buffer {
  37         struct sg_table table;
  38         unsigned length;
  39 };
  40
  41 /* embedded in scsi_cmnd */
  42 struct scsi_pointer {
  43         char *ptr;              /* data pointer */
  44         int this_residual;      /* left in this buffer */
  45         struct scatterlist *buffer;     /* which buffer */
  46         int buffers_residual;   /* how many buffers left */
  47
  48         dma_addr_t dma_handle;
  49
  50         volatile int Status;
  51         volatile int Message;
  52         volatile int have_data_in;
  53         volatile int sent_command;
  54         volatile int phase;
  55 };
  56
  57 /* for scmd->flags */
  58 #define SCMD_TAGGED             (1 << 0)
  59 #define SCMD_INITIALIZED        (1 << 1)
  60 #define SCMD_LAST               (1 << 2)
  61 /* flags preserved across unprep / reprep */
  62 #define SCMD_PRESERVED_FLAGS    (SCMD_INITIALIZED)
  63
  64 /* for scmd->state */
  65 #define SCMD_STATE_COMPLETE     0
  66 #define SCMD_STATE_INFLIGHT     1
  67
  68 enum scsi_cmnd_submitter {
  69         SUBMITTED_BY_BLOCK_LAYER = 0,
  70         SUBMITTED_BY_SCSI_ERROR_HANDLER = 1,
  71         SUBMITTED_BY_SCSI_RESET_IOCTL = 2,
  72 } __packed;
  73
  74 struct scsi_cmnd {
  75         struct scsi_request req;
  76         struct scsi_device *device;
  77         struct list_head eh_entry; /* entry for the host eh_abort_list/eh_cmd_q */
  78         struct delayed_work abort_work;
  79
  80         struct rcu_head rcu;
  81
  82         int eh_eflags;          /* Used by error handlr */
  83
  84         int budget_token;
  85
  86         /*
  87          * This is set to jiffies as it was when the command was first
  88          * allocated.  It is used to time how long the command has
  89          * been outstanding
  90          */
  91         unsigned long jiffies_at_alloc;
  92
  93         int retries;
  94         int allowed;
  95
  96         unsigned char prot_op;
  97         unsigned char prot_type;
  98         unsigned char prot_flags;
  99         enum scsi_cmnd_submitter submitter;
 100
 101         unsigned short cmd_len;
 102         enum dma_data_direction sc_data_direction;
 103
 104         /* These elements define the operation we are about to perform */
 105         unsigned char *cmnd;
 106
 107
 108         /* These elements define the operation we ultimately want to perform */
 109         struct scsi_data_buffer sdb;
 110         struct scsi_data_buffer *prot_sdb;
 111
 112         unsigned underflow;     /* Return error if less than
 113                                    this amount is transferred */
 114
 115         unsigned transfersize;  /* How much we are guaranteed to
 116                                    transfer with each SCSI transfer
 117                                    (ie, between disconnect /
 118                                    reconnects.   Probably == sector
 119                                    size */
 120
 121         unsigned char *sense_buffer;
 122                                 /* obtained by REQUEST SENSE when
 123                                  * CHECK CONDITION is received on original
 124                                  * command (auto-sense). Length must be
 125                                  * SCSI_SENSE_BUFFERSIZE bytes. */
 126
 127         /* Low-level done function - can be used by low-level driver to point
 128          *        to completion function.  Not used by mid/upper level code. */
 129         void (*scsi_done) (struct scsi_cmnd *);
 130
 131         /*
 132          * The following fields can be written to by the host specific code.
 133          * Everything else should be left alone.
 134          */
 135         struct scsi_pointer SCp;        /* Scratchpad used by some host adapters */
 136
 137         unsigned char *host_scribble;   /* The host adapter is allowed to
 138                                          * call scsi_malloc and get some memory
 139                                          * and hang it here.  The host adapter
 140                                          * is also expected to call scsi_free
 141                                          * to release this memory.  (The memory
 142                                          * obtained by scsi_malloc is guaranteed
 143                                          * to be at an address < 16Mb). */
 144
 145         int result;             /* Status code from lower level driver */
 146         int flags;              /* Command flags */
 147         unsigned long state;    /* Command completion state */
 148
 149         unsigned int extra_len; /* length of alignment and padding */
 150 };
 151
 152 /* Variant of blk_mq_rq_from_pdu() that verifies the type of its argument. */
 153 static inline struct request *scsi_cmd_to_rq(struct scsi_cmnd *scmd)
 154 {
 155         return blk_mq_rq_from_pdu(scmd);
 156 }
 157
 158 /*
 159  * Return the driver private allocation behind the command.
 160  * Only works if cmd_size is set in the host template.
 161  */
 162 static inline void *scsi_cmd_priv(struct scsi_cmnd *cmd)
 163 {
 164         return cmd + 1;
 165 }
 166
 167 /* make sure not to use it with passthrough commands */
 168 static inline struct scsi_driver *scsi_cmd_to_driver(struct scsi_cmnd *cmd)
 169 {
 170         struct request *rq = scsi_cmd_to_rq(cmd);
 171
 172         return *(struct scsi_driver **)rq->rq_disk->private_data;
 173 }
 174
 175 void scsi_done(struct scsi_cmnd *cmd);
 176
 177 extern void scsi_finish_command(struct scsi_cmnd *cmd);
 178
 179 extern void *scsi_kmap_atomic_sg(struct scatterlist *sg, int sg_count,
 180                                  size_t *offset, size_t *len);
 181 extern void scsi_kunmap_atomic_sg(void *virt);
 182
 183 blk_status_t scsi_alloc_sgtables(struct scsi_cmnd *cmd);
 184 void scsi_free_sgtables(struct scsi_cmnd *cmd);
 185
 186 #ifdef CONFIG_SCSI_DMA
 187 extern int scsi_dma_map(struct scsi_cmnd *cmd);
 188 extern void scsi_dma_unmap(struct scsi_cmnd *cmd);
 189 #else /* !CONFIG_SCSI_DMA */
 190 static inline int scsi_dma_map(struct scsi_cmnd *cmd) { return -ENOSYS; }
 191 static inline void scsi_dma_unmap(struct scsi_cmnd *cmd) { }
 192 #endif /* !CONFIG_SCSI_DMA */
 193
 194 static inline unsigned scsi_sg_count(struct scsi_cmnd *cmd)
 195 {
 196         return cmd->sdb.table.nents;
 197 }
 198
 199 static inline struct scatterlist *scsi_sglist(struct scsi_cmnd *cmd)
 200 {
 201         return cmd->sdb.table.sgl;
 202 }
 203
 204 static inline unsigned scsi_bufflen(struct scsi_cmnd *cmd)
 205 {
 206         return cmd->sdb.length;
 207 }
 208
 209 static inline void scsi_set_resid(struct scsi_cmnd *cmd, unsigned int resid)
 210 {
 211         cmd->req.resid_len = resid;
 212 }
 213
 214 static inline unsigned int scsi_get_resid(struct scsi_cmnd *cmd)
 215 {
 216         return cmd->req.resid_len;
 217 }
 218
 219 #define scsi_for_each_sg(cmd, sg, nseg, __i)                    \
 220         for_each_sg(scsi_sglist(cmd), sg, nseg, __i)
 221
 222 static inline int scsi_sg_copy_from_buffer(struct scsi_cmnd *cmd,
 223                                            const void *buf, int buflen)
 224 {
 225         return sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
 226                                    buf, buflen);
 227 }
 228
 229 static inline int scsi_sg_copy_to_buffer(struct scsi_cmnd *cmd,
 230                                          void *buf, int buflen)
 231 {
 232         return sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
 233                                  buf, buflen);
 234 }
 235
 236 static inline sector_t scsi_get_sector(struct scsi_cmnd *scmd)
 237 {
 238         return blk_rq_pos(scsi_cmd_to_rq(scmd));
 239 }
 240
 241 static inline sector_t scsi_get_lba(struct scsi_cmnd *scmd)
 242 {
 243         unsigned int shift = ilog2(scmd->device->sector_size) - SECTOR_SHIFT;
 244
 245         return blk_rq_pos(scsi_cmd_to_rq(scmd)) >> shift;
 246 }
 247
 248 static inline unsigned int scsi_logical_block_count(struct scsi_cmnd *scmd)
 249 {
 250         unsigned int shift = ilog2(scmd->device->sector_size) - SECTOR_SHIFT;
 251
 252         return blk_rq_bytes(scsi_cmd_to_rq(scmd)) >> shift;
 253 }
 254
 255 /*
 256  * The operations below are hints that tell the controller driver how
 257  * to handle I/Os with DIF or similar types of protection information.
 258  */
 259 enum scsi_prot_operations {
 260         /* Normal I/O */
 261         SCSI_PROT_NORMAL = 0,
 262
 263         /* OS-HBA: Protected, HBA-Target: Unprotected */
 264         SCSI_PROT_READ_INSERT,
 265         SCSI_PROT_WRITE_STRIP,
 266
 267         /* OS-HBA: Unprotected, HBA-Target: Protected */
 268         SCSI_PROT_READ_STRIP,
 269         SCSI_PROT_WRITE_INSERT,
 270
 271         /* OS-HBA: Protected, HBA-Target: Protected */
 272         SCSI_PROT_READ_PASS,
 273         SCSI_PROT_WRITE_PASS,
 274 };
 275
 276 static inline void scsi_set_prot_op(struct scsi_cmnd *scmd, unsigned char op)
 277 {
 278         scmd->prot_op = op;
 279 }
 280
 281 static inline unsigned char scsi_get_prot_op(struct scsi_cmnd *scmd)
 282 {
 283         return scmd->prot_op;
 284 }
 285
 286 enum scsi_prot_flags {
 287         SCSI_PROT_TRANSFER_PI           = 1 << 0,
 288         SCSI_PROT_GUARD_CHECK           = 1 << 1,
 289         SCSI_PROT_REF_CHECK             = 1 << 2,
 290         SCSI_PROT_REF_INCREMENT         = 1 << 3,
 291         SCSI_PROT_IP_CHECKSUM           = 1 << 4,
 292 };
 293
 294 /*
 295  * The controller usually does not know anything about the target it
 296  * is communicating with.  However, when DIX is enabled the controller
 297  * must be know target type so it can verify the protection
 298  * information passed along with the I/O.
 299  */
 300 enum scsi_prot_target_type {
 301         SCSI_PROT_DIF_TYPE0 = 0,
 302         SCSI_PROT_DIF_TYPE1,
 303         SCSI_PROT_DIF_TYPE2,
 304         SCSI_PROT_DIF_TYPE3,
 305 };
 306
 307 static inline void scsi_set_prot_type(struct scsi_cmnd *scmd, unsigned char type)
 308 {
 309         scmd->prot_type = type;
 310 }
 311
 312 static inline unsigned char scsi_get_prot_type(struct scsi_cmnd *scmd)
 313 {
 314         return scmd->prot_type;
 315 }
 316
 317 static inline u32 scsi_prot_ref_tag(struct scsi_cmnd *scmd)
 318 {
 319         struct request *rq = blk_mq_rq_from_pdu(scmd);
 320
 321         return t10_pi_ref_tag(rq);
 322 }
 323
 324 static inline unsigned int scsi_prot_interval(struct scsi_cmnd *scmd)
 325 {
 326         return scmd->device->sector_size;
 327 }
 328
 329 static inline unsigned scsi_prot_sg_count(struct scsi_cmnd *cmd)
 330 {
 331         return cmd->prot_sdb ? cmd->prot_sdb->table.nents : 0;
 332 }
 333
 334 static inline struct scatterlist *scsi_prot_sglist(struct scsi_cmnd *cmd)
 335 {
 336         return cmd->prot_sdb ? cmd->prot_sdb->table.sgl : NULL;
 337 }
 338
 339 static inline struct scsi_data_buffer *scsi_prot(struct scsi_cmnd *cmd)
 340 {
 341         return cmd->prot_sdb;
 342 }
 343
 344 #define scsi_for_each_prot_sg(cmd, sg, nseg, __i)               \
 345         for_each_sg(scsi_prot_sglist(cmd), sg, nseg, __i)
 346
 347 static inline void set_status_byte(struct scsi_cmnd *cmd, char status)
 348 {
 349         cmd->result = (cmd->result & 0xffffff00) | status;
 350 }
 351
 352 static inline u8 get_status_byte(struct scsi_cmnd *cmd)
 353 {
 354         return cmd->result & 0xff;
 355 }
 356
 357 static inline void set_host_byte(struct scsi_cmnd *cmd, char status)
 358 {
 359         cmd->result = (cmd->result & 0xff00ffff) | (status << 16);
 360 }
 361
 362 static inline u8 get_host_byte(struct scsi_cmnd *cmd)
 363 {
 364         return (cmd->result >> 16) & 0xff;
 365 }
 366
 367 /**
 368  * scsi_msg_to_host_byte() - translate message byte
 369  *
 370  * Translate the SCSI parallel message byte to a matching
 371  * host byte setting. A message of COMMAND_COMPLETE indicates
 372  * a successful command execution, any other message indicate
 373  * an error. As the messages themselves only have a meaning
 374  * for the SCSI parallel protocol this function translates
 375  * them into a matching host byte value for SCSI EH.
 376  */
 377 static inline void scsi_msg_to_host_byte(struct scsi_cmnd *cmd, u8 msg)
 378 {
 379         switch (msg) {
 380         case COMMAND_COMPLETE:
 381                 break;
 382         case ABORT_TASK_SET:
 383                 set_host_byte(cmd, DID_ABORT);
 384                 break;
 385         case TARGET_RESET:
 386                 set_host_byte(cmd, DID_RESET);
 387                 break;
 388         default:
 389                 set_host_byte(cmd, DID_ERROR);
 390                 break;
 391         }
 392 }
 393
 394 static inline unsigned scsi_transfer_length(struct scsi_cmnd *scmd)
 395 {
 396         unsigned int xfer_len = scmd->sdb.length;
 397         unsigned int prot_interval = scsi_prot_interval(scmd);
 398
 399         if (scmd->prot_flags & SCSI_PROT_TRANSFER_PI)
 400                 xfer_len += (xfer_len >> ilog2(prot_interval)) * 8;
 401
 402         return xfer_len;
 403 }
 404
 405 extern void scsi_build_sense(struct scsi_cmnd *scmd, int desc,
 406                              u8 key, u8 asc, u8 ascq);
 407
 408 #endif /* _SCSI_SCSI_CMND_H */