[linux-2.6-block.git] / include / scsi / scsi_cmnd.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef _SCSI_SCSI_CMND_H
#define _SCSI_SCSI_CMND_H

#include <linux/dma-mapping.h>
#include <linux/blkdev.h>
#include <linux/t10-pi.h>
#include <linux/list.h>
#include <linux/types.h>
#include <linux/timer.h>
#include <linux/scatterlist.h>
#include <scsi/scsi_device.h>
#include <scsi/scsi_request.h>

struct Scsi_Host;
struct scsi_driver;

/*
 * MAX_COMMAND_SIZE is:
 * The longest fixed-length SCSI CDB as per the SCSI standard.
 * fixed-length means: commands that their size can be determined
 * by their opcode and the CDB does not carry a length specifier, (unlike
 * the VARIABLE_LENGTH_CMD(0x7f) command). This is actually not exactly
 * true and the SCSI standard also defines extended commands and
 * vendor specific commands that can be bigger than 16 bytes. The kernel
 * will support these using the same infrastructure used for VARLEN CDB's.
 * So in effect MAX_COMMAND_SIZE means the maximum size command scsi-ml
 * supports without specifying a cmd_len by ULD's
 */
#define MAX_COMMAND_SIZE 16
#if (MAX_COMMAND_SIZE > BLK_MAX_CDB)
# error MAX_COMMAND_SIZE can not be bigger than BLK_MAX_CDB
#endif

struct scsi_data_buffer {
	struct sg_table table;
	unsigned length;
	int resid;
};

/* embedded in scsi_cmnd */
struct scsi_pointer {
	char *ptr;		/* data pointer */
	int this_residual;	/* left in this buffer */
	struct scatterlist *buffer;	/* which buffer */
	int buffers_residual;	/* how many buffers left */

        dma_addr_t dma_handle;

	volatile int Status;
	volatile int Message;
	volatile int have_data_in;
	volatile int sent_command;
	volatile int phase;
};

/* for scmd->flags */
#define SCMD_TAGGED		(1 << 0)
#define SCMD_UNCHECKED_ISA_DMA	(1 << 1)
#define SCMD_INITIALIZED	(1 << 2)
/* flags preserved across unprep / reprep */
#define SCMD_PRESERVED_FLAGS	(SCMD_UNCHECKED_ISA_DMA | SCMD_INITIALIZED)

/* for scmd->state */
#define SCMD_STATE_COMPLETE	0

struct scsi_cmnd {
	struct scsi_request req;
	struct scsi_device *device;
	struct list_head list;  /* scsi_cmnd participates in queue lists */
	struct list_head eh_entry; /* entry for the host eh_cmd_q */
	struct delayed_work abort_work;

	struct rcu_head rcu;

	int eh_eflags;		/* Used by error handlr */

	/*
	 * A SCSI Command is assigned a nonzero serial_number before passed
	 * to the driver's queue command function.  The serial_number is
	 * cleared when scsi_done is entered indicating that the command
	 * has been completed.  It is a bug for LLDDs to use this number
	 * for purposes other than printk (and even that is only useful
	 * for debugging).
	 */
	unsigned long serial_number;

	/*
	 * This is set to jiffies as it was when the command was first
	 * allocated.  It is used to time how long the command has
	 * been outstanding
	 */
	unsigned long jiffies_at_alloc;

	int retries;
	int allowed;

	unsigned char prot_op;
	unsigned char prot_type;
	unsigned char prot_flags;

	unsigned short cmd_len;
	enum dma_data_direction sc_data_direction;

	/* These elements define the operation we are about to perform */
	unsigned char *cmnd;


	/* These elements define the operation we ultimately want to perform */
	struct scsi_data_buffer sdb;
	struct scsi_data_buffer *prot_sdb;

	unsigned underflow;	/* Return error if less than
				   this amount is transferred */

	unsigned transfersize;	/* How much we are guaranteed to
				   transfer with each SCSI transfer
				   (ie, between disconnect / 
				   reconnects.   Probably == sector
				   size */

	struct request *request;	/* The command we are
				   	   working on */

	unsigned char *sense_buffer;
				/* obtained by REQUEST SENSE when
				 * CHECK CONDITION is received on original
				 * command (auto-sense). Length must be
				 * SCSI_SENSE_BUFFERSIZE bytes. */

	/* Low-level done function - can be used by low-level driver to point
	 *        to completion function.  Not used by mid/upper level code. */
	void (*scsi_done) (struct scsi_cmnd *);

	/*
	 * The following fields can be written to by the host specific code. 
	 * Everything else should be left alone. 
	 */
	struct scsi_pointer SCp;	/* Scratchpad used by some host adapters */

	unsigned char *host_scribble;	/* The host adapter is allowed to
					 * call scsi_malloc and get some memory
					 * and hang it here.  The host adapter
					 * is also expected to call scsi_free
					 * to release this memory.  (The memory
					 * obtained by scsi_malloc is guaranteed
					 * to be at an address < 16Mb). */

	int result;		/* Status code from lower level driver */
	int flags;		/* Command flags */
	unsigned long state;	/* Command completion state */

	unsigned char tag;	/* SCSI-II queued command tag */
};

/*
 * Return the driver private allocation behind the command.
 * Only works if cmd_size is set in the host template.
 */
static inline void *scsi_cmd_priv(struct scsi_cmnd *cmd)
{
	return cmd + 1;
}

/* make sure not to use it with passthrough commands */
static inline struct scsi_driver *scsi_cmd_to_driver(struct scsi_cmnd *cmd)
{
	return *(struct scsi_driver **)cmd->request->rq_disk->private_data;
}

extern void scsi_put_command(struct scsi_cmnd *);
extern void scsi_finish_command(struct scsi_cmnd *cmd);

extern void *scsi_kmap_atomic_sg(struct scatterlist *sg, int sg_count,
				 size_t *offset, size_t *len);
extern void scsi_kunmap_atomic_sg(void *virt);

extern blk_status_t scsi_init_io(struct scsi_cmnd *cmd);

#ifdef CONFIG_SCSI_DMA
extern int scsi_dma_map(struct scsi_cmnd *cmd);
extern void scsi_dma_unmap(struct scsi_cmnd *cmd);
#else /* !CONFIG_SCSI_DMA */
static inline int scsi_dma_map(struct scsi_cmnd *cmd) { return -ENOSYS; }
static inline void scsi_dma_unmap(struct scsi_cmnd *cmd) { }
#endif /* !CONFIG_SCSI_DMA */

static inline unsigned scsi_sg_count(struct scsi_cmnd *cmd)
{
	return cmd->sdb.table.nents;
}

static inline struct scatterlist *scsi_sglist(struct scsi_cmnd *cmd)
{
	return cmd->sdb.table.sgl;
}

static inline unsigned scsi_bufflen(struct scsi_cmnd *cmd)
{
	return cmd->sdb.length;
}

static inline void scsi_set_resid(struct scsi_cmnd *cmd, int resid)
{
	cmd->sdb.resid = resid;
}

static inline int scsi_get_resid(struct scsi_cmnd *cmd)
{
	return cmd->sdb.resid;
}

#define scsi_for_each_sg(cmd, sg, nseg, __i)			\
	for_each_sg(scsi_sglist(cmd), sg, nseg, __i)

static inline int scsi_bidi_cmnd(struct scsi_cmnd *cmd)
{
	return blk_bidi_rq(cmd->request) &&
		(cmd->request->next_rq->special != NULL);
}

static inline struct scsi_data_buffer *scsi_in(struct scsi_cmnd *cmd)
{
	return scsi_bidi_cmnd(cmd) ?
		cmd->request->next_rq->special : &cmd->sdb;
}

static inline struct scsi_data_buffer *scsi_out(struct scsi_cmnd *cmd)
{
	return &cmd->sdb;
}

static inline int scsi_sg_copy_from_buffer(struct scsi_cmnd *cmd,
					   void *buf, int buflen)
{
	return sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
				   buf, buflen);
}

static inline int scsi_sg_copy_to_buffer(struct scsi_cmnd *cmd,
					 void *buf, int buflen)
{
	return sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
				 buf, buflen);
}

/*
 * The operations below are hints that tell the controller driver how
 * to handle I/Os with DIF or similar types of protection information.
 */
enum scsi_prot_operations {
	/* Normal I/O */
	SCSI_PROT_NORMAL = 0,

	/* OS-HBA: Protected, HBA-Target: Unprotected */
	SCSI_PROT_READ_INSERT,
	SCSI_PROT_WRITE_STRIP,

	/* OS-HBA: Unprotected, HBA-Target: Protected */
	SCSI_PROT_READ_STRIP,
	SCSI_PROT_WRITE_INSERT,

	/* OS-HBA: Protected, HBA-Target: Protected */
	SCSI_PROT_READ_PASS,
	SCSI_PROT_WRITE_PASS,
};

static inline void scsi_set_prot_op(struct scsi_cmnd *scmd, unsigned char op)
{
	scmd->prot_op = op;
}

static inline unsigned char scsi_get_prot_op(struct scsi_cmnd *scmd)
{
	return scmd->prot_op;
}

enum scsi_prot_flags {
	SCSI_PROT_TRANSFER_PI		= 1 << 0,
	SCSI_PROT_GUARD_CHECK		= 1 << 1,
	SCSI_PROT_REF_CHECK		= 1 << 2,
	SCSI_PROT_REF_INCREMENT		= 1 << 3,
	SCSI_PROT_IP_CHECKSUM		= 1 << 4,
};

/*
 * The controller usually does not know anything about the target it
 * is communicating with.  However, when DIX is enabled the controller
 * must be know target type so it can verify the protection
 * information passed along with the I/O.
 */
enum scsi_prot_target_type {
	SCSI_PROT_DIF_TYPE0 = 0,
	SCSI_PROT_DIF_TYPE1,
	SCSI_PROT_DIF_TYPE2,
	SCSI_PROT_DIF_TYPE3,
};

static inline void scsi_set_prot_type(struct scsi_cmnd *scmd, unsigned char type)
{
	scmd->prot_type = type;
}

static inline unsigned char scsi_get_prot_type(struct scsi_cmnd *scmd)
{
	return scmd->prot_type;
}

static inline sector_t scsi_get_lba(struct scsi_cmnd *scmd)
{
	return blk_rq_pos(scmd->request);
}

static inline unsigned int scsi_prot_interval(struct scsi_cmnd *scmd)
{
	return scmd->device->sector_size;
}

static inline unsigned scsi_prot_sg_count(struct scsi_cmnd *cmd)
{
	return cmd->prot_sdb ? cmd->prot_sdb->table.nents : 0;
}

static inline struct scatterlist *scsi_prot_sglist(struct scsi_cmnd *cmd)
{
	return cmd->prot_sdb ? cmd->prot_sdb->table.sgl : NULL;
}

static inline struct scsi_data_buffer *scsi_prot(struct scsi_cmnd *cmd)
{
	return cmd->prot_sdb;
}

#define scsi_for_each_prot_sg(cmd, sg, nseg, __i)		\
	for_each_sg(scsi_prot_sglist(cmd), sg, nseg, __i)

static inline void set_msg_byte(struct scsi_cmnd *cmd, char status)
{
	cmd->result = (cmd->result & 0xffff00ff) | (status << 8);
}

static inline void set_host_byte(struct scsi_cmnd *cmd, char status)
{
	cmd->result = (cmd->result & 0xff00ffff) | (status << 16);
}

static inline void set_driver_byte(struct scsi_cmnd *cmd, char status)
{
	cmd->result = (cmd->result & 0x00ffffff) | (status << 24);
}

static inline unsigned scsi_transfer_length(struct scsi_cmnd *scmd)
{
	unsigned int xfer_len = scsi_out(scmd)->length;
	unsigned int prot_interval = scsi_prot_interval(scmd);

	if (scmd->prot_flags & SCSI_PROT_TRANSFER_PI)
		xfer_len += (xfer_len >> ilog2(prot_interval)) * 8;

	return xfer_len;
}

#endif /* _SCSI_SCSI_CMND_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
1da177e4 LT	2	#ifndef _SCSI_SCSI_CMND_H
	3	#define _SCSI_SCSI_CMND_H
	4
	5	#include <linux/dma-mapping.h>
6f9a35e2	6	#include <linux/blkdev.h>
ddd0bc75	7	#include <linux/t10-pi.h>
1da177e4 LT	8	#include <linux/list.h>
1da177e4 LT	9	#include <linux/types.h>
4e57b681	10	#include <linux/timer.h>
c6132da1	11	#include <linux/scatterlist.h>
8846bab1	12	#include <scsi/scsi_device.h>
82ed4db4	13	#include <scsi/scsi_request.h>
1da177e4	14
b58d9154	15	struct Scsi_Host;
18a4d0a2	16	struct scsi_driver;
1da177e4	17
64a87b24 BH	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
30b0c37b BH	35	struct scsi_data_buffer {
	36	struct sg_table table;
	37	unsigned length;
	38	int resid;
	39	};
1da177e4 LT	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
125c99bc CH	57	/* for scmd->flags */
125c99bc CH	58	#define SCMD_TAGGED (1 << 0)
8e688254	59	#define SCMD_UNCHECKED_ISA_DMA (1 << 1)
39051dd8	60	#define SCMD_INITIALIZED (1 << 2)
64104f70 BVA	61	/* flags preserved across unprep / reprep */
64104f70 BVA	62	#define SCMD_PRESERVED_FLAGS (SCMD_UNCHECKED_ISA_DMA \| SCMD_INITIALIZED)
125c99bc	63
f1342709	64	/* for scmd->state */
29cadd2b	65	#define SCMD_STATE_COMPLETE 0
f1342709	66
1da177e4	67	struct scsi_cmnd {
82ed4db4	68	struct scsi_request req;
1da177e4	69	struct scsi_device *device;
1da177e4	70	struct list_head list; /* scsi_cmnd participates in queue lists */
1da177e4	71	struct list_head eh_entry; /* entry for the host eh_cmd_q */
e494f6a7	72	struct delayed_work abort_work;
3be8828f BVA	73
	74	struct rcu_head rcu;
	75
1da177e4	76	int eh_eflags; /* Used by error handlr */
1da177e4 LT	77
1da177e4 LT	78	/*
c6295cdf	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
12a44162 MW	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).
1da177e4 LT	85	*/
1da177e4 LT	86	unsigned long serial_number;
12a44162	87
b21a4138 JB	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;
1da177e4 LT	94
	95	int retries;
	96	int allowed;
1da177e4	97
db007fc5 MP	98	unsigned char prot_op;
db007fc5 MP	99	unsigned char prot_type;
c611529e	100	unsigned char prot_flags;
db007fc5	101
db4742dd	102	unsigned short cmd_len;
1da177e4	103	enum dma_data_direction sc_data_direction;
1da177e4 LT	104
1da177e4 LT	105	/* These elements define the operation we are about to perform */
64a87b24	106	unsigned char *cmnd;
1da177e4	107
1da177e4 LT	108
1da177e4 LT	109	/* These elements define the operation we ultimately want to perform */
30b0c37b	110	struct scsi_data_buffer sdb;
7027ad72 MP	111	struct scsi_data_buffer *prot_sdb;
7027ad72 MP	112
1da177e4 LT	113	unsigned underflow; /* Return error if less than
1da177e4 LT	114	this amount is transferred */
1da177e4 LT	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
1da177e4 LT	122	struct request request; / The command we are
	123	working on */
	124
de25deb1	125	unsigned char *sense_buffer;
c67a848c MW	126	/* obtained by REQUEST SENSE when
c67a848c MW	127	* CHECK CONDITION is received on original
704f8392 KC	128	* command (auto-sense). Length must be
704f8392 KC	129	* SCSI_SENSE_BUFFERSIZE bytes. */
1da177e4 LT	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
c67a848c MW	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). */
1da177e4 LT	148
1da177e4 LT	149	int result; /* Status code from lower level driver */
125c99bc	150	int flags; /* Command flags */
f1342709	151	unsigned long state; /* Command completion state */
1da177e4 LT	152
1da177e4 LT	153	unsigned char tag; /* SCSI-II queued command tag */
1da177e4 LT	154	};
1da177e4 LT	155
b54197c4 CH	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
57292b58	165	/* make sure not to use it with passthrough commands */
18a4d0a2 MP	166	static inline struct scsi_driver scsi_cmd_to_driver(struct scsi_cmnd cmd)
18a4d0a2 MP	167	{
329a402c	168	return (struct scsi_driver *)cmd->request->rq_disk->private_data;
18a4d0a2 MP	169	}
18a4d0a2 MP	170
1da177e4	171	extern void scsi_put_command(struct scsi_cmnd *);
1da177e4 LT	172	extern void scsi_finish_command(struct scsi_cmnd *cmd);
1da177e4 LT	173
cdb8c2a6 GL	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
159b2cbf	178	extern blk_status_t scsi_init_io(struct scsi_cmnd *cmd);
b58d9154	179
bff739b6	180	#ifdef CONFIG_SCSI_DMA
824d7b57 FT	181	extern int scsi_dma_map(struct scsi_cmnd *cmd);
824d7b57 FT	182	extern void scsi_dma_unmap(struct scsi_cmnd *cmd);
bff739b6 GU	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 */
824d7b57	187
30b0c37b BH	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	}
824d7b57 FT	202
	203	static inline void scsi_set_resid(struct scsi_cmnd *cmd, int resid)
	204	{
30b0c37b	205	cmd->sdb.resid = resid;
824d7b57 FT	206	}
	207
	208	static inline int scsi_get_resid(struct scsi_cmnd *cmd)
	209	{
30b0c37b	210	return cmd->sdb.resid;
824d7b57 FT	211	}
	212
	213	#define scsi_for_each_sg(cmd, sg, nseg, __i) \
c6132da1	214	for_each_sg(scsi_sglist(cmd), sg, nseg, __i)
824d7b57	215
6f9a35e2 BH	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
9ac16b61 FT	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
db007fc5 MP	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,
db007fc5 MP	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
c611529e MP	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
db007fc5 MP	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	{
83096ebf	311	return blk_rq_pos(scmd->request);
db007fc5 MP	312	}
db007fc5 MP	313
c611529e MP	314	static inline unsigned int scsi_prot_interval(struct scsi_cmnd *scmd)
	315	{
	316	return scmd->device->sector_size;
	317	}
	318
7027ad72 MP	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
f290f197 JB	337	static inline void set_msg_byte(struct scsi_cmnd *cmd, char status)
f290f197 JB	338	{
3384db9e	339	cmd->result = (cmd->result & 0xffff00ff) \| (status << 8);
f290f197 JB	340	}
	341
	342	static inline void set_host_byte(struct scsi_cmnd *cmd, char status)
	343	{
3384db9e	344	cmd->result = (cmd->result & 0xff00ffff) \| (status << 16);
f290f197 JB	345	}
	346
	347	static inline void set_driver_byte(struct scsi_cmnd *cmd, char status)
	348	{
3384db9e	349	cmd->result = (cmd->result & 0x00ffffff) \| (status << 24);
f290f197 JB	350	}
f290f197 JB	351
8846bab1 SG	352	static inline unsigned scsi_transfer_length(struct scsi_cmnd *scmd)
8846bab1 SG	353	{
5616b0a4	354	unsigned int xfer_len = scsi_out(scmd)->length;
c611529e	355	unsigned int prot_interval = scsi_prot_interval(scmd);
8846bab1	356
c611529e MP	357	if (scmd->prot_flags & SCSI_PROT_TRANSFER_PI)
c611529e MP	358	xfer_len += (xfer_len >> ilog2(prot_interval)) * 8;
8846bab1	359
c611529e	360	return xfer_len;
8846bab1 SG	361	}
8846bab1 SG	362
1da177e4	363	#endif /* _SCSI_SCSI_CMND_H */