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