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