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 #if (MAX_COMMAND_SIZE > BLK_MAX_CDB)
  32 # error MAX_COMMAND_SIZE can not be bigger than BLK_MAX_CDB
  33 #endif
  34
  35 struct scsi_data_buffer {
  36         struct sg_table table;
  37         unsigned length;
  38         int resid;
  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_UNCHECKED_ISA_DMA  (1 << 1)
  60 #define SCMD_INITIALIZED        (1 << 2)
  61 /* flags preserved across unprep / reprep */
  62 #define SCMD_PRESERVED_FLAGS    (SCMD_UNCHECKED_ISA_DMA | SCMD_INITIALIZED)
  63
  64 /* for scmd->state */
  65 #define SCMD_STATE_COMPLETE     0
  66
  67 struct scsi_cmnd {
  68         struct scsi_request req;
  69         struct scsi_device *device;
  70         struct list_head list;  /* scsi_cmnd participates in queue lists */
  71         struct list_head eh_entry; /* entry for the host eh_cmd_q */
  72         struct delayed_work abort_work;
  73
  74         struct rcu_head rcu;
  75
  76         int eh_eflags;          /* Used by error handlr */
  77
  78         /*
  79          * A SCSI Command is assigned a nonzero serial_number before passed
  80          * to the driver's queue command function.  The serial_number is
  81          * cleared when scsi_done is entered indicating that the command
  82          * has been completed.  It is a bug for LLDDs to use this number
  83          * for purposes other than printk (and even that is only useful
  84          * for debugging).
  85          */
  86         unsigned long serial_number;
  87
  88         /*
  89          * This is set to jiffies as it was when the command was first
  90          * allocated.  It is used to time how long the command has
  91          * been outstanding
  92          */
  93         unsigned long jiffies_at_alloc;
  94
  95         int retries;
  96         int allowed;
  97
  98         unsigned char prot_op;
  99         unsigned char prot_type;
 100         unsigned char prot_flags;
 101
 102         unsigned short cmd_len;
 103         enum dma_data_direction sc_data_direction;
 104
 105         /* These elements define the operation we are about to perform */
 106         unsigned char *cmnd;
 107
 108
 109         /* These elements define the operation we ultimately want to perform */
 110         struct scsi_data_buffer sdb;
 111         struct scsi_data_buffer *prot_sdb;
 112
 113         unsigned underflow;     /* Return error if less than
 114                                    this amount is transferred */
 115
 116         unsigned transfersize;  /* How much we are guaranteed to
 117                                    transfer with each SCSI transfer
 118                                    (ie, between disconnect /
 119                                    reconnects.   Probably == sector
 120                                    size */
 121
 122         struct request *request;        /* The command we are
 123                                            working on */
 124
 125         unsigned char *sense_buffer;
 126                                 /* obtained by REQUEST SENSE when
 127                                  * CHECK CONDITION is received on original
 128                                  * command (auto-sense). Length must be
 129                                  * SCSI_SENSE_BUFFERSIZE bytes. */
 130
 131         /* Low-level done function - can be used by low-level driver to point
 132          *        to completion function.  Not used by mid/upper level code. */
 133         void (*scsi_done) (struct scsi_cmnd *);
 134
 135         /*
 136          * The following fields can be written to by the host specific code.
 137          * Everything else should be left alone.
 138          */
 139         struct scsi_pointer SCp;        /* Scratchpad used by some host adapters */
 140
 141         unsigned char *host_scribble;   /* The host adapter is allowed to
 142                                          * call scsi_malloc and get some memory
 143                                          * and hang it here.  The host adapter
 144                                          * is also expected to call scsi_free
 145                                          * to release this memory.  (The memory
 146                                          * obtained by scsi_malloc is guaranteed
 147                                          * to be at an address < 16Mb). */
 148
 149         int result;             /* Status code from lower level driver */
 150         int flags;              /* Command flags */
 151         unsigned long state;    /* Command completion state */
 152
 153         unsigned char tag;      /* SCSI-II queued command tag */
 154 };
 155
 156 /*
 157  * Return the driver private allocation behind the command.
 158  * Only works if cmd_size is set in the host template.
 159  */
 160 static inline void *scsi_cmd_priv(struct scsi_cmnd *cmd)
 161 {
 162         return cmd + 1;
 163 }
 164
 165 /* make sure not to use it with passthrough commands */
 166 static inline struct scsi_driver *scsi_cmd_to_driver(struct scsi_cmnd *cmd)
 167 {
 168         return *(struct scsi_driver **)cmd->request->rq_disk->private_data;
 169 }
 170
 171 extern void scsi_put_command(struct scsi_cmnd *);
 172 extern void scsi_finish_command(struct scsi_cmnd *cmd);
 173
 174 extern void *scsi_kmap_atomic_sg(struct scatterlist *sg, int sg_count,
 175                                  size_t *offset, size_t *len);
 176 extern void scsi_kunmap_atomic_sg(void *virt);
 177
 178 extern blk_status_t scsi_init_io(struct scsi_cmnd *cmd);
 179
 180 #ifdef CONFIG_SCSI_DMA
 181 extern int scsi_dma_map(struct scsi_cmnd *cmd);
 182 extern void scsi_dma_unmap(struct scsi_cmnd *cmd);
 183 #else /* !CONFIG_SCSI_DMA */
 184 static inline int scsi_dma_map(struct scsi_cmnd *cmd) { return -ENOSYS; }
 185 static inline void scsi_dma_unmap(struct scsi_cmnd *cmd) { }
 186 #endif /* !CONFIG_SCSI_DMA */
 187
 188 static inline unsigned scsi_sg_count(struct scsi_cmnd *cmd)
 189 {
 190         return cmd->sdb.table.nents;
 191 }
 192
 193 static inline struct scatterlist *scsi_sglist(struct scsi_cmnd *cmd)
 194 {
 195         return cmd->sdb.table.sgl;
 196 }
 197
 198 static inline unsigned scsi_bufflen(struct scsi_cmnd *cmd)
 199 {
 200         return cmd->sdb.length;
 201 }
 202
 203 static inline void scsi_set_resid(struct scsi_cmnd *cmd, int resid)
 204 {
 205         cmd->sdb.resid = resid;
 206 }
 207
 208 static inline int scsi_get_resid(struct scsi_cmnd *cmd)
 209 {
 210         return cmd->sdb.resid;
 211 }
 212
 213 #define scsi_for_each_sg(cmd, sg, nseg, __i)                    \
 214         for_each_sg(scsi_sglist(cmd), sg, nseg, __i)
 215
 216 static inline int scsi_bidi_cmnd(struct scsi_cmnd *cmd)
 217 {
 218         return blk_bidi_rq(cmd->request) &&
 219                 (cmd->request->next_rq->special != NULL);
 220 }
 221
 222 static inline struct scsi_data_buffer *scsi_in(struct scsi_cmnd *cmd)
 223 {
 224         return scsi_bidi_cmnd(cmd) ?
 225                 cmd->request->next_rq->special : &cmd->sdb;
 226 }
 227
 228 static inline struct scsi_data_buffer *scsi_out(struct scsi_cmnd *cmd)
 229 {
 230         return &cmd->sdb;
 231 }
 232
 233 static inline int scsi_sg_copy_from_buffer(struct scsi_cmnd *cmd,
 234                                            void *buf, int buflen)
 235 {
 236         return sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
 237                                    buf, buflen);
 238 }
 239
 240 static inline int scsi_sg_copy_to_buffer(struct scsi_cmnd *cmd,
 241                                          void *buf, int buflen)
 242 {
 243         return sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
 244                                  buf, buflen);
 245 }
 246
 247 /*
 248  * The operations below are hints that tell the controller driver how
 249  * to handle I/Os with DIF or similar types of protection information.
 250  */
 251 enum scsi_prot_operations {
 252         /* Normal I/O */
 253         SCSI_PROT_NORMAL = 0,
 254
 255         /* OS-HBA: Protected, HBA-Target: Unprotected */
 256         SCSI_PROT_READ_INSERT,
 257         SCSI_PROT_WRITE_STRIP,
 258
 259         /* OS-HBA: Unprotected, HBA-Target: Protected */
 260         SCSI_PROT_READ_STRIP,
 261         SCSI_PROT_WRITE_INSERT,
 262
 263         /* OS-HBA: Protected, HBA-Target: Protected */
 264         SCSI_PROT_READ_PASS,
 265         SCSI_PROT_WRITE_PASS,
 266 };
 267
 268 static inline void scsi_set_prot_op(struct scsi_cmnd *scmd, unsigned char op)
 269 {
 270         scmd->prot_op = op;
 271 }
 272
 273 static inline unsigned char scsi_get_prot_op(struct scsi_cmnd *scmd)
 274 {
 275         return scmd->prot_op;
 276 }
 277
 278 enum scsi_prot_flags {
 279         SCSI_PROT_TRANSFER_PI           = 1 << 0,
 280         SCSI_PROT_GUARD_CHECK           = 1 << 1,
 281         SCSI_PROT_REF_CHECK             = 1 << 2,
 282         SCSI_PROT_REF_INCREMENT         = 1 << 3,
 283         SCSI_PROT_IP_CHECKSUM           = 1 << 4,
 284 };
 285
 286 /*
 287  * The controller usually does not know anything about the target it
 288  * is communicating with.  However, when DIX is enabled the controller
 289  * must be know target type so it can verify the protection
 290  * information passed along with the I/O.
 291  */
 292 enum scsi_prot_target_type {
 293         SCSI_PROT_DIF_TYPE0 = 0,
 294         SCSI_PROT_DIF_TYPE1,
 295         SCSI_PROT_DIF_TYPE2,
 296         SCSI_PROT_DIF_TYPE3,
 297 };
 298
 299 static inline void scsi_set_prot_type(struct scsi_cmnd *scmd, unsigned char type)
 300 {
 301         scmd->prot_type = type;
 302 }
 303
 304 static inline unsigned char scsi_get_prot_type(struct scsi_cmnd *scmd)
 305 {
 306         return scmd->prot_type;
 307 }
 308
 309 static inline sector_t scsi_get_lba(struct scsi_cmnd *scmd)
 310 {
 311         return blk_rq_pos(scmd->request);
 312 }
 313
 314 static inline unsigned int scsi_prot_interval(struct scsi_cmnd *scmd)
 315 {
 316         return scmd->device->sector_size;
 317 }
 318
 319 static inline unsigned scsi_prot_sg_count(struct scsi_cmnd *cmd)
 320 {
 321         return cmd->prot_sdb ? cmd->prot_sdb->table.nents : 0;
 322 }
 323
 324 static inline struct scatterlist *scsi_prot_sglist(struct scsi_cmnd *cmd)
 325 {
 326         return cmd->prot_sdb ? cmd->prot_sdb->table.sgl : NULL;
 327 }
 328
 329 static inline struct scsi_data_buffer *scsi_prot(struct scsi_cmnd *cmd)
 330 {
 331         return cmd->prot_sdb;
 332 }
 333
 334 #define scsi_for_each_prot_sg(cmd, sg, nseg, __i)               \
 335         for_each_sg(scsi_prot_sglist(cmd), sg, nseg, __i)
 336
 337 static inline void set_msg_byte(struct scsi_cmnd *cmd, char status)
 338 {
 339         cmd->result = (cmd->result & 0xffff00ff) | (status << 8);
 340 }
 341
 342 static inline void set_host_byte(struct scsi_cmnd *cmd, char status)
 343 {
 344         cmd->result = (cmd->result & 0xff00ffff) | (status << 16);
 345 }
 346
 347 static inline void set_driver_byte(struct scsi_cmnd *cmd, char status)
 348 {
 349         cmd->result = (cmd->result & 0x00ffffff) | (status << 24);
 350 }
 351
 352 static inline unsigned scsi_transfer_length(struct scsi_cmnd *scmd)
 353 {
 354         unsigned int xfer_len = scsi_out(scmd)->length;
 355         unsigned int prot_interval = scsi_prot_interval(scmd);
 356
 357         if (scmd->prot_flags & SCSI_PROT_TRANSFER_PI)
 358                 xfer_len += (xfer_len >> ilog2(prot_interval)) * 8;
 359
 360         return xfer_len;
 361 }
 362
 363 #endif /* _SCSI_SCSI_CMND_H */