Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | #ifndef _SCSI_SCSI_CMND_H |
| 2 | #define _SCSI_SCSI_CMND_H |
| 3 | |
| 4 | #include <linux/dma-mapping.h> |
Boaz Harrosh | 6f9a35e | 2007-12-13 13:50:53 +0200 | [diff] [blame] | 5 | #include <linux/blkdev.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 6 | #include <linux/list.h> |
| 7 | #include <linux/types.h> |
Tim Schmielau | 4e57b68 | 2005-10-30 15:03:48 -0800 | [diff] [blame] | 8 | #include <linux/timer.h> |
Jens Axboe | c6132da | 2007-10-16 11:08:49 +0200 | [diff] [blame] | 9 | #include <linux/scatterlist.h> |
Sagi Grimberg | 8846bab | 2014-06-11 12:09:57 +0300 | [diff] [blame] | 10 | #include <scsi/scsi_device.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 11 | |
FUJITA Tomonori | b58d915 | 2006-11-16 19:24:10 +0900 | [diff] [blame] | 12 | struct Scsi_Host; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 13 | struct scsi_device; |
Martin K. Petersen | 18a4d0a | 2012-02-09 13:48:53 -0500 | [diff] [blame] | 14 | struct scsi_driver; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 15 | |
Boaz Harrosh | 64a87b2 | 2008-04-30 11:19:47 +0300 | [diff] [blame] | 16 | /* |
| 17 | * MAX_COMMAND_SIZE is: |
| 18 | * The longest fixed-length SCSI CDB as per the SCSI standard. |
| 19 | * fixed-length means: commands that their size can be determined |
| 20 | * by their opcode and the CDB does not carry a length specifier, (unlike |
| 21 | * the VARIABLE_LENGTH_CMD(0x7f) command). This is actually not exactly |
| 22 | * true and the SCSI standard also defines extended commands and |
| 23 | * vendor specific commands that can be bigger than 16 bytes. The kernel |
| 24 | * will support these using the same infrastructure used for VARLEN CDB's. |
| 25 | * So in effect MAX_COMMAND_SIZE means the maximum size command scsi-ml |
| 26 | * supports without specifying a cmd_len by ULD's |
| 27 | */ |
| 28 | #define MAX_COMMAND_SIZE 16 |
| 29 | #if (MAX_COMMAND_SIZE > BLK_MAX_CDB) |
| 30 | # error MAX_COMMAND_SIZE can not be bigger than BLK_MAX_CDB |
| 31 | #endif |
| 32 | |
Boaz Harrosh | 30b0c37 | 2007-12-13 13:47:40 +0200 | [diff] [blame] | 33 | struct scsi_data_buffer { |
| 34 | struct sg_table table; |
| 35 | unsigned length; |
| 36 | int resid; |
| 37 | }; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 38 | |
| 39 | /* embedded in scsi_cmnd */ |
| 40 | struct scsi_pointer { |
| 41 | char *ptr; /* data pointer */ |
| 42 | int this_residual; /* left in this buffer */ |
| 43 | struct scatterlist *buffer; /* which buffer */ |
| 44 | int buffers_residual; /* how many buffers left */ |
| 45 | |
| 46 | dma_addr_t dma_handle; |
| 47 | |
| 48 | volatile int Status; |
| 49 | volatile int Message; |
| 50 | volatile int have_data_in; |
| 51 | volatile int sent_command; |
| 52 | volatile int phase; |
| 53 | }; |
| 54 | |
| 55 | struct scsi_cmnd { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 56 | struct scsi_device *device; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 57 | struct list_head list; /* scsi_cmnd participates in queue lists */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 58 | struct list_head eh_entry; /* entry for the host eh_cmd_q */ |
Hannes Reinecke | e494f6a | 2013-11-11 13:44:54 +0100 | [diff] [blame] | 59 | struct delayed_work abort_work; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 60 | int eh_eflags; /* Used by error handlr */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 61 | |
| 62 | /* |
| c6295cd | 2005-04-03 14:59:11 -0500 | [diff] [blame] | 63 | * A SCSI Command is assigned a nonzero serial_number before passed |
| 64 | * to the driver's queue command function. The serial_number is |
| 65 | * cleared when scsi_done is entered indicating that the command |
Matthew Wilcox | 12a4416 | 2007-09-18 19:54:43 -0600 | [diff] [blame] | 66 | * has been completed. It is a bug for LLDDs to use this number |
| 67 | * for purposes other than printk (and even that is only useful |
| 68 | * for debugging). |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 69 | */ |
| 70 | unsigned long serial_number; |
Matthew Wilcox | 12a4416 | 2007-09-18 19:54:43 -0600 | [diff] [blame] | 71 | |
James Bottomley | b21a413 | 2005-08-05 21:45:40 -0500 | [diff] [blame] | 72 | /* |
| 73 | * This is set to jiffies as it was when the command was first |
| 74 | * allocated. It is used to time how long the command has |
| 75 | * been outstanding |
| 76 | */ |
| 77 | unsigned long jiffies_at_alloc; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 78 | |
| 79 | int retries; |
| 80 | int allowed; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 81 | |
Martin K. Petersen | db007fc | 2008-07-17 04:28:31 -0400 | [diff] [blame] | 82 | unsigned char prot_op; |
| 83 | unsigned char prot_type; |
| 84 | |
Boaz Harrosh | db4742d | 2008-04-30 11:27:26 +0300 | [diff] [blame] | 85 | unsigned short cmd_len; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 86 | enum dma_data_direction sc_data_direction; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 87 | |
| 88 | /* These elements define the operation we are about to perform */ |
Boaz Harrosh | 64a87b2 | 2008-04-30 11:19:47 +0300 | [diff] [blame] | 89 | unsigned char *cmnd; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 90 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 91 | |
| 92 | /* These elements define the operation we ultimately want to perform */ |
Boaz Harrosh | 30b0c37 | 2007-12-13 13:47:40 +0200 | [diff] [blame] | 93 | struct scsi_data_buffer sdb; |
Martin K. Petersen | 7027ad7 | 2008-07-17 17:08:48 -0400 | [diff] [blame] | 94 | struct scsi_data_buffer *prot_sdb; |
| 95 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 96 | unsigned underflow; /* Return error if less than |
| 97 | this amount is transferred */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 98 | |
| 99 | unsigned transfersize; /* How much we are guaranteed to |
| 100 | transfer with each SCSI transfer |
| 101 | (ie, between disconnect / |
| 102 | reconnects. Probably == sector |
| 103 | size */ |
| 104 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 105 | struct request *request; /* The command we are |
| 106 | working on */ |
| 107 | |
| 108 | #define SCSI_SENSE_BUFFERSIZE 96 |
FUJITA Tomonori | de25deb | 2008-01-16 13:32:17 +0900 | [diff] [blame] | 109 | unsigned char *sense_buffer; |
Matthew Wilcox | c67a848 | 2006-01-17 11:54:24 -0700 | [diff] [blame] | 110 | /* obtained by REQUEST SENSE when |
| 111 | * CHECK CONDITION is received on original |
| 112 | * command (auto-sense) */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 113 | |
| 114 | /* Low-level done function - can be used by low-level driver to point |
| 115 | * to completion function. Not used by mid/upper level code. */ |
| 116 | void (*scsi_done) (struct scsi_cmnd *); |
| 117 | |
| 118 | /* |
| 119 | * The following fields can be written to by the host specific code. |
| 120 | * Everything else should be left alone. |
| 121 | */ |
| 122 | struct scsi_pointer SCp; /* Scratchpad used by some host adapters */ |
| 123 | |
| 124 | unsigned char *host_scribble; /* The host adapter is allowed to |
Matthew Wilcox | c67a848 | 2006-01-17 11:54:24 -0700 | [diff] [blame] | 125 | * call scsi_malloc and get some memory |
| 126 | * and hang it here. The host adapter |
| 127 | * is also expected to call scsi_free |
| 128 | * to release this memory. (The memory |
| 129 | * obtained by scsi_malloc is guaranteed |
| 130 | * to be at an address < 16Mb). */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 131 | |
| 132 | int result; /* Status code from lower level driver */ |
| 133 | |
| 134 | unsigned char tag; /* SCSI-II queued command tag */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 135 | }; |
| 136 | |
Christoph Hellwig | b54197c | 2014-05-01 16:51:50 +0200 | [diff] [blame] | 137 | /* |
| 138 | * Return the driver private allocation behind the command. |
| 139 | * Only works if cmd_size is set in the host template. |
| 140 | */ |
| 141 | static inline void *scsi_cmd_priv(struct scsi_cmnd *cmd) |
| 142 | { |
| 143 | return cmd + 1; |
| 144 | } |
| 145 | |
Li Zhong | 329a402 | 2012-09-29 12:23:37 +0800 | [diff] [blame] | 146 | /* make sure not to use it with REQ_TYPE_BLOCK_PC commands */ |
Martin K. Petersen | 18a4d0a | 2012-02-09 13:48:53 -0500 | [diff] [blame] | 147 | static inline struct scsi_driver *scsi_cmd_to_driver(struct scsi_cmnd *cmd) |
| 148 | { |
Li Zhong | 329a402 | 2012-09-29 12:23:37 +0800 | [diff] [blame] | 149 | return *(struct scsi_driver **)cmd->request->rq_disk->private_data; |
Martin K. Petersen | 18a4d0a | 2012-02-09 13:48:53 -0500 | [diff] [blame] | 150 | } |
| 151 | |
Al Viro | c53033f | 2005-10-21 03:22:08 -0400 | [diff] [blame] | 152 | extern struct scsi_cmnd *scsi_get_command(struct scsi_device *, gfp_t); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 153 | extern void scsi_put_command(struct scsi_cmnd *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 154 | extern void scsi_finish_command(struct scsi_cmnd *cmd); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 155 | |
Guennadi Liakhovetski | cdb8c2a | 2006-04-02 21:57:43 +0200 | [diff] [blame] | 156 | extern void *scsi_kmap_atomic_sg(struct scatterlist *sg, int sg_count, |
| 157 | size_t *offset, size_t *len); |
| 158 | extern void scsi_kunmap_atomic_sg(void *virt); |
| 159 | |
Boaz Harrosh | bb52d82 | 2007-12-13 16:14:27 -0800 | [diff] [blame] | 160 | extern int scsi_init_io(struct scsi_cmnd *cmd, gfp_t gfp_mask); |
FUJITA Tomonori | b58d915 | 2006-11-16 19:24:10 +0900 | [diff] [blame] | 161 | |
FUJITA Tomonori | 824d7b5 | 2007-05-26 14:04:03 +0900 | [diff] [blame] | 162 | extern int scsi_dma_map(struct scsi_cmnd *cmd); |
| 163 | extern void scsi_dma_unmap(struct scsi_cmnd *cmd); |
| 164 | |
Boaz Harrosh | 30b0c37 | 2007-12-13 13:47:40 +0200 | [diff] [blame] | 165 | static inline unsigned scsi_sg_count(struct scsi_cmnd *cmd) |
| 166 | { |
| 167 | return cmd->sdb.table.nents; |
| 168 | } |
| 169 | |
| 170 | static inline struct scatterlist *scsi_sglist(struct scsi_cmnd *cmd) |
| 171 | { |
| 172 | return cmd->sdb.table.sgl; |
| 173 | } |
| 174 | |
| 175 | static inline unsigned scsi_bufflen(struct scsi_cmnd *cmd) |
| 176 | { |
| 177 | return cmd->sdb.length; |
| 178 | } |
FUJITA Tomonori | 824d7b5 | 2007-05-26 14:04:03 +0900 | [diff] [blame] | 179 | |
| 180 | static inline void scsi_set_resid(struct scsi_cmnd *cmd, int resid) |
| 181 | { |
Boaz Harrosh | 30b0c37 | 2007-12-13 13:47:40 +0200 | [diff] [blame] | 182 | cmd->sdb.resid = resid; |
FUJITA Tomonori | 824d7b5 | 2007-05-26 14:04:03 +0900 | [diff] [blame] | 183 | } |
| 184 | |
| 185 | static inline int scsi_get_resid(struct scsi_cmnd *cmd) |
| 186 | { |
Boaz Harrosh | 30b0c37 | 2007-12-13 13:47:40 +0200 | [diff] [blame] | 187 | return cmd->sdb.resid; |
FUJITA Tomonori | 824d7b5 | 2007-05-26 14:04:03 +0900 | [diff] [blame] | 188 | } |
| 189 | |
| 190 | #define scsi_for_each_sg(cmd, sg, nseg, __i) \ |
Jens Axboe | c6132da | 2007-10-16 11:08:49 +0200 | [diff] [blame] | 191 | for_each_sg(scsi_sglist(cmd), sg, nseg, __i) |
FUJITA Tomonori | 824d7b5 | 2007-05-26 14:04:03 +0900 | [diff] [blame] | 192 | |
Boaz Harrosh | 6f9a35e | 2007-12-13 13:50:53 +0200 | [diff] [blame] | 193 | static inline int scsi_bidi_cmnd(struct scsi_cmnd *cmd) |
| 194 | { |
| 195 | return blk_bidi_rq(cmd->request) && |
| 196 | (cmd->request->next_rq->special != NULL); |
| 197 | } |
| 198 | |
| 199 | static inline struct scsi_data_buffer *scsi_in(struct scsi_cmnd *cmd) |
| 200 | { |
| 201 | return scsi_bidi_cmnd(cmd) ? |
| 202 | cmd->request->next_rq->special : &cmd->sdb; |
| 203 | } |
| 204 | |
| 205 | static inline struct scsi_data_buffer *scsi_out(struct scsi_cmnd *cmd) |
| 206 | { |
| 207 | return &cmd->sdb; |
| 208 | } |
| 209 | |
FUJITA Tomonori | 9ac16b6 | 2008-03-09 13:44:29 +0900 | [diff] [blame] | 210 | static inline int scsi_sg_copy_from_buffer(struct scsi_cmnd *cmd, |
| 211 | void *buf, int buflen) |
| 212 | { |
| 213 | return sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd), |
| 214 | buf, buflen); |
| 215 | } |
| 216 | |
| 217 | static inline int scsi_sg_copy_to_buffer(struct scsi_cmnd *cmd, |
| 218 | void *buf, int buflen) |
| 219 | { |
| 220 | return sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd), |
| 221 | buf, buflen); |
| 222 | } |
| 223 | |
Martin K. Petersen | db007fc | 2008-07-17 04:28:31 -0400 | [diff] [blame] | 224 | /* |
| 225 | * The operations below are hints that tell the controller driver how |
| 226 | * to handle I/Os with DIF or similar types of protection information. |
| 227 | */ |
| 228 | enum scsi_prot_operations { |
| 229 | /* Normal I/O */ |
| 230 | SCSI_PROT_NORMAL = 0, |
| 231 | |
| 232 | /* OS-HBA: Protected, HBA-Target: Unprotected */ |
| 233 | SCSI_PROT_READ_INSERT, |
| 234 | SCSI_PROT_WRITE_STRIP, |
| 235 | |
| 236 | /* OS-HBA: Unprotected, HBA-Target: Protected */ |
| 237 | SCSI_PROT_READ_STRIP, |
| 238 | SCSI_PROT_WRITE_INSERT, |
| 239 | |
| 240 | /* OS-HBA: Protected, HBA-Target: Protected */ |
| 241 | SCSI_PROT_READ_PASS, |
| 242 | SCSI_PROT_WRITE_PASS, |
Martin K. Petersen | db007fc | 2008-07-17 04:28:31 -0400 | [diff] [blame] | 243 | }; |
| 244 | |
| 245 | static inline void scsi_set_prot_op(struct scsi_cmnd *scmd, unsigned char op) |
| 246 | { |
| 247 | scmd->prot_op = op; |
| 248 | } |
| 249 | |
| 250 | static inline unsigned char scsi_get_prot_op(struct scsi_cmnd *scmd) |
| 251 | { |
| 252 | return scmd->prot_op; |
| 253 | } |
| 254 | |
| 255 | /* |
| 256 | * The controller usually does not know anything about the target it |
| 257 | * is communicating with. However, when DIX is enabled the controller |
| 258 | * must be know target type so it can verify the protection |
| 259 | * information passed along with the I/O. |
| 260 | */ |
| 261 | enum scsi_prot_target_type { |
| 262 | SCSI_PROT_DIF_TYPE0 = 0, |
| 263 | SCSI_PROT_DIF_TYPE1, |
| 264 | SCSI_PROT_DIF_TYPE2, |
| 265 | SCSI_PROT_DIF_TYPE3, |
| 266 | }; |
| 267 | |
| 268 | static inline void scsi_set_prot_type(struct scsi_cmnd *scmd, unsigned char type) |
| 269 | { |
| 270 | scmd->prot_type = type; |
| 271 | } |
| 272 | |
| 273 | static inline unsigned char scsi_get_prot_type(struct scsi_cmnd *scmd) |
| 274 | { |
| 275 | return scmd->prot_type; |
| 276 | } |
| 277 | |
| 278 | static inline sector_t scsi_get_lba(struct scsi_cmnd *scmd) |
| 279 | { |
Tejun Heo | 83096eb | 2009-05-07 22:24:39 +0900 | [diff] [blame] | 280 | return blk_rq_pos(scmd->request); |
Martin K. Petersen | db007fc | 2008-07-17 04:28:31 -0400 | [diff] [blame] | 281 | } |
| 282 | |
Martin K. Petersen | 7027ad7 | 2008-07-17 17:08:48 -0400 | [diff] [blame] | 283 | static inline unsigned scsi_prot_sg_count(struct scsi_cmnd *cmd) |
| 284 | { |
| 285 | return cmd->prot_sdb ? cmd->prot_sdb->table.nents : 0; |
| 286 | } |
| 287 | |
| 288 | static inline struct scatterlist *scsi_prot_sglist(struct scsi_cmnd *cmd) |
| 289 | { |
| 290 | return cmd->prot_sdb ? cmd->prot_sdb->table.sgl : NULL; |
| 291 | } |
| 292 | |
| 293 | static inline struct scsi_data_buffer *scsi_prot(struct scsi_cmnd *cmd) |
| 294 | { |
| 295 | return cmd->prot_sdb; |
| 296 | } |
| 297 | |
| 298 | #define scsi_for_each_prot_sg(cmd, sg, nseg, __i) \ |
| 299 | for_each_sg(scsi_prot_sglist(cmd), sg, nseg, __i) |
| 300 | |
James Bottomley | f290f19 | 2009-02-08 21:59:48 -0600 | [diff] [blame] | 301 | static inline void set_msg_byte(struct scsi_cmnd *cmd, char status) |
| 302 | { |
Moger, Babu | 3384db9 | 2012-01-24 20:38:42 +0000 | [diff] [blame] | 303 | cmd->result = (cmd->result & 0xffff00ff) | (status << 8); |
James Bottomley | f290f19 | 2009-02-08 21:59:48 -0600 | [diff] [blame] | 304 | } |
| 305 | |
| 306 | static inline void set_host_byte(struct scsi_cmnd *cmd, char status) |
| 307 | { |
Moger, Babu | 3384db9 | 2012-01-24 20:38:42 +0000 | [diff] [blame] | 308 | cmd->result = (cmd->result & 0xff00ffff) | (status << 16); |
James Bottomley | f290f19 | 2009-02-08 21:59:48 -0600 | [diff] [blame] | 309 | } |
| 310 | |
| 311 | static inline void set_driver_byte(struct scsi_cmnd *cmd, char status) |
| 312 | { |
Moger, Babu | 3384db9 | 2012-01-24 20:38:42 +0000 | [diff] [blame] | 313 | cmd->result = (cmd->result & 0x00ffffff) | (status << 24); |
James Bottomley | f290f19 | 2009-02-08 21:59:48 -0600 | [diff] [blame] | 314 | } |
| 315 | |
Sagi Grimberg | 8846bab | 2014-06-11 12:09:57 +0300 | [diff] [blame] | 316 | static inline unsigned scsi_transfer_length(struct scsi_cmnd *scmd) |
| 317 | { |
Martin K. Petersen | 5616b0a | 2014-06-24 16:59:35 +0200 | [diff] [blame] | 318 | unsigned int xfer_len = scsi_out(scmd)->length; |
Sagi Grimberg | 8846bab | 2014-06-11 12:09:57 +0300 | [diff] [blame] | 319 | unsigned int prot_op = scsi_get_prot_op(scmd); |
| 320 | unsigned int sector_size = scmd->device->sector_size; |
| 321 | |
| 322 | switch (prot_op) { |
| 323 | case SCSI_PROT_NORMAL: |
| 324 | case SCSI_PROT_WRITE_STRIP: |
| 325 | case SCSI_PROT_READ_INSERT: |
| 326 | return xfer_len; |
| 327 | } |
| 328 | |
| 329 | return xfer_len + (xfer_len >> ilog2(sector_size)) * 8; |
| 330 | } |
| 331 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 332 | #endif /* _SCSI_SCSI_CMND_H */ |