[linux-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_host.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;
};

/* 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_INITIALIZED	(1 << 1)
#define SCMD_LAST		(1 << 2)
/* flags preserved across unprep / reprep */
#define SCMD_PRESERVED_FLAGS	(SCMD_INITIALIZED)

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

struct scsi_cmnd {
	struct scsi_request req;
	struct scsi_device *device;
	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 */

	int budget_token;

	/*
	 * 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 */
	unsigned int extra_len;	/* length of alignment and padding */
};

/*
 * 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_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);

blk_status_t scsi_alloc_sgtables(struct scsi_cmnd *cmd);
void scsi_free_sgtables(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, unsigned int resid)
{
	cmd->req.resid_len = resid;
}

static inline unsigned int scsi_get_resid(struct scsi_cmnd *cmd)
{
	return cmd->req.resid_len;
}

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

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);
}

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

/*
 * 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 u32 scsi_prot_ref_tag(struct scsi_cmnd *scmd)
{
	struct request *rq = blk_mq_rq_from_pdu(scmd);

	return t10_pi_ref_tag(rq);
}

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_status_byte(struct scsi_cmnd *cmd, char status)
{
	cmd->result = (cmd->result & 0xffffff00) | status;
}

static inline u8 get_status_byte(struct scsi_cmnd *cmd)
{
	return cmd->result & 0xff;
}

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

static inline u8 get_host_byte(struct scsi_cmnd *cmd)
{
	return (cmd->result >> 16) & 0xff;
}

/**
 * scsi_msg_to_host_byte() - translate message byte
 *
 * Translate the SCSI parallel message byte to a matching
 * host byte setting. A message of COMMAND_COMPLETE indicates
 * a successful command execution, any other message indicate
 * an error. As the messages themselves only have a meaning
 * for the SCSI parallel protocol this function translates
 * them into a matching host byte value for SCSI EH.
 */
static inline void scsi_msg_to_host_byte(struct scsi_cmnd *cmd, u8 msg)
{
	switch (msg) {
	case COMMAND_COMPLETE:
		break;
	case ABORT_TASK_SET:
		set_host_byte(cmd, DID_ABORT);
		break;
	case TARGET_RESET:
		set_host_byte(cmd, DID_RESET);
		break;
	default:
		set_host_byte(cmd, DID_ERROR);
		break;
	}
}

static inline unsigned scsi_transfer_length(struct scsi_cmnd *scmd)
{
	unsigned int xfer_len = scmd->sdb.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;
}

extern void scsi_build_sense(struct scsi_cmnd *scmd, int desc,
			     u8 key, u8 asc, u8 ascq);

#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>
af183095	13	#include <scsi/scsi_host.h>
82ed4db4	14	#include <scsi/scsi_request.h>
1da177e4	15
b58d9154	16	struct Scsi_Host;
18a4d0a2	17	struct scsi_driver;
1da177e4	18
64a87b24 BH	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
30b0c37b BH	36	struct scsi_data_buffer {
	37	struct sg_table table;
	38	unsigned length;
30b0c37b	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)
aaff5eba CH	59	#define SCMD_INITIALIZED (1 << 1)
aaff5eba CH	60	#define SCMD_LAST (1 << 2)
64104f70	61	/* flags preserved across unprep / reprep */
aaff5eba	62	#define SCMD_PRESERVED_FLAGS (SCMD_INITIALIZED)
125c99bc	63
f1342709	64	/* for scmd->state */
29cadd2b	65	#define SCMD_STATE_COMPLETE 0
6eb045e0	66	#define SCMD_STATE_INFLIGHT 1
f1342709	67
1da177e4	68	struct scsi_cmnd {
82ed4db4	69	struct scsi_request req;
1da177e4	70	struct scsi_device *device;
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	77
d022d18c ML	78	int budget_token;
d022d18c ML	79
b21a4138 JB	80	/*
	81	* This is set to jiffies as it was when the command was first
	82	* allocated. It is used to time how long the command has
	83	* been outstanding
	84	*/
	85	unsigned long jiffies_at_alloc;
1da177e4 LT	86
	87	int retries;
	88	int allowed;
1da177e4	89
db007fc5 MP	90	unsigned char prot_op;
db007fc5 MP	91	unsigned char prot_type;
c611529e	92	unsigned char prot_flags;
db007fc5	93
db4742dd	94	unsigned short cmd_len;
1da177e4	95	enum dma_data_direction sc_data_direction;
1da177e4 LT	96
1da177e4 LT	97	/* These elements define the operation we are about to perform */
64a87b24	98	unsigned char *cmnd;
1da177e4	99
1da177e4 LT	100
1da177e4 LT	101	/* These elements define the operation we ultimately want to perform */
30b0c37b	102	struct scsi_data_buffer sdb;
7027ad72 MP	103	struct scsi_data_buffer *prot_sdb;
7027ad72 MP	104
1da177e4 LT	105	unsigned underflow; /* Return error if less than
1da177e4 LT	106	this amount is transferred */
1da177e4 LT	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
1da177e4 LT	114	struct request request; / The command we are
	115	working on */
	116
de25deb1	117	unsigned char *sense_buffer;
c67a848c MW	118	/* obtained by REQUEST SENSE when
c67a848c MW	119	* CHECK CONDITION is received on original
704f8392 KC	120	* command (auto-sense). Length must be
704f8392 KC	121	* SCSI_SENSE_BUFFERSIZE bytes. */
1da177e4 LT	122
	123	/* Low-level done function - can be used by low-level driver to point
	124	* to completion function. Not used by mid/upper level code. */
	125	void (scsi_done) (struct scsi_cmnd );
	126
	127	/*
	128	* The following fields can be written to by the host specific code.
	129	* Everything else should be left alone.
	130	*/
	131	struct scsi_pointer SCp; /* Scratchpad used by some host adapters */
	132
	133	unsigned char host_scribble; / The host adapter is allowed to
c67a848c MW	134	* call scsi_malloc and get some memory
	135	* and hang it here. The host adapter
	136	* is also expected to call scsi_free
	137	* to release this memory. (The memory
	138	* obtained by scsi_malloc is guaranteed
	139	* to be at an address < 16Mb). */
1da177e4 LT	140
1da177e4 LT	141	int result; /* Status code from lower level driver */
125c99bc	142	int flags; /* Command flags */
f1342709	143	unsigned long state; /* Command completion state */
1da177e4 LT	144
1da177e4 LT	145	unsigned char tag; /* SCSI-II queued command tag */
bdf8710d	146	unsigned int extra_len; /* length of alignment and padding */
1da177e4 LT	147	};
1da177e4 LT	148
b54197c4 CH	149	/*
	150	* Return the driver private allocation behind the command.
	151	* Only works if cmd_size is set in the host template.
	152	*/
	153	static inline void scsi_cmd_priv(struct scsi_cmnd cmd)
	154	{
	155	return cmd + 1;
	156	}
	157
57292b58	158	/* make sure not to use it with passthrough commands */
18a4d0a2 MP	159	static inline struct scsi_driver scsi_cmd_to_driver(struct scsi_cmnd cmd)
18a4d0a2 MP	160	{
329a402c	161	return (struct scsi_driver *)cmd->request->rq_disk->private_data;
18a4d0a2 MP	162	}
18a4d0a2 MP	163
1da177e4 LT	164	extern void scsi_finish_command(struct scsi_cmnd *cmd);
1da177e4 LT	165
cdb8c2a6 GL	166	extern void scsi_kmap_atomic_sg(struct scatterlist sg, int sg_count,
	167	size_t offset, size_t len);
	168	extern void scsi_kunmap_atomic_sg(void *virt);
	169
7007e9dd CH	170	blk_status_t scsi_alloc_sgtables(struct scsi_cmnd *cmd);
7007e9dd CH	171	void scsi_free_sgtables(struct scsi_cmnd *cmd);
b58d9154	172
bff739b6	173	#ifdef CONFIG_SCSI_DMA
824d7b57 FT	174	extern int scsi_dma_map(struct scsi_cmnd *cmd);
824d7b57 FT	175	extern void scsi_dma_unmap(struct scsi_cmnd *cmd);
bff739b6 GU	176	#else /* !CONFIG_SCSI_DMA */
	177	static inline int scsi_dma_map(struct scsi_cmnd *cmd) { return -ENOSYS; }
	178	static inline void scsi_dma_unmap(struct scsi_cmnd *cmd) { }
	179	#endif /* !CONFIG_SCSI_DMA */
824d7b57	180
30b0c37b BH	181	static inline unsigned scsi_sg_count(struct scsi_cmnd *cmd)
	182	{
	183	return cmd->sdb.table.nents;
	184	}
	185
	186	static inline struct scatterlist scsi_sglist(struct scsi_cmnd cmd)
	187	{
	188	return cmd->sdb.table.sgl;
	189	}
	190
	191	static inline unsigned scsi_bufflen(struct scsi_cmnd *cmd)
	192	{
	193	return cmd->sdb.length;
	194	}
824d7b57	195
9237f04e	196	static inline void scsi_set_resid(struct scsi_cmnd *cmd, unsigned int resid)
824d7b57	197	{
9fa505ad	198	cmd->req.resid_len = resid;
824d7b57 FT	199	}
824d7b57 FT	200
9237f04e	201	static inline unsigned int scsi_get_resid(struct scsi_cmnd *cmd)
824d7b57	202	{
9fa505ad	203	return cmd->req.resid_len;
824d7b57 FT	204	}
	205
	206	#define scsi_for_each_sg(cmd, sg, nseg, __i) \
c6132da1	207	for_each_sg(scsi_sglist(cmd), sg, nseg, __i)
824d7b57	208
9ac16b61 FT	209	static inline int scsi_sg_copy_from_buffer(struct scsi_cmnd *cmd,
	210	void *buf, int buflen)
	211	{
	212	return sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
	213	buf, buflen);
	214	}
	215
	216	static inline int scsi_sg_copy_to_buffer(struct scsi_cmnd *cmd,
	217	void *buf, int buflen)
	218	{
	219	return sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
	220	buf, buflen);
	221	}
	222
f0f214fe BVA	223	static inline sector_t scsi_get_sector(struct scsi_cmnd *scmd)
	224	{
	225	return blk_rq_pos(scmd->request);
	226	}
	227
db007fc5 MP	228	/*
	229	* The operations below are hints that tell the controller driver how
	230	* to handle I/Os with DIF or similar types of protection information.
	231	*/
	232	enum scsi_prot_operations {
	233	/* Normal I/O */
	234	SCSI_PROT_NORMAL = 0,
	235
	236	/* OS-HBA: Protected, HBA-Target: Unprotected */
	237	SCSI_PROT_READ_INSERT,
	238	SCSI_PROT_WRITE_STRIP,
	239
	240	/* OS-HBA: Unprotected, HBA-Target: Protected */
	241	SCSI_PROT_READ_STRIP,
	242	SCSI_PROT_WRITE_INSERT,
	243
	244	/* OS-HBA: Protected, HBA-Target: Protected */
	245	SCSI_PROT_READ_PASS,
	246	SCSI_PROT_WRITE_PASS,
db007fc5 MP	247	};
	248
	249	static inline void scsi_set_prot_op(struct scsi_cmnd *scmd, unsigned char op)
	250	{
	251	scmd->prot_op = op;
	252	}
	253
	254	static inline unsigned char scsi_get_prot_op(struct scsi_cmnd *scmd)
	255	{
	256	return scmd->prot_op;
	257	}
	258
c611529e MP	259	enum scsi_prot_flags {
	260	SCSI_PROT_TRANSFER_PI = 1 << 0,
	261	SCSI_PROT_GUARD_CHECK = 1 << 1,
	262	SCSI_PROT_REF_CHECK = 1 << 2,
	263	SCSI_PROT_REF_INCREMENT = 1 << 3,
	264	SCSI_PROT_IP_CHECKSUM = 1 << 4,
	265	};
	266
db007fc5 MP	267	/*
	268	* The controller usually does not know anything about the target it
	269	* is communicating with. However, when DIX is enabled the controller
	270	* must be know target type so it can verify the protection
	271	* information passed along with the I/O.
	272	*/
	273	enum scsi_prot_target_type {
	274	SCSI_PROT_DIF_TYPE0 = 0,
	275	SCSI_PROT_DIF_TYPE1,
	276	SCSI_PROT_DIF_TYPE2,
	277	SCSI_PROT_DIF_TYPE3,
	278	};
	279
	280	static inline void scsi_set_prot_type(struct scsi_cmnd *scmd, unsigned char type)
	281	{
	282	scmd->prot_type = type;
	283	}
	284
	285	static inline unsigned char scsi_get_prot_type(struct scsi_cmnd *scmd)
	286	{
	287	return scmd->prot_type;
	288	}
	289
	290	static inline sector_t scsi_get_lba(struct scsi_cmnd *scmd)
	291	{
83096ebf	292	return blk_rq_pos(scmd->request);
db007fc5 MP	293	}
db007fc5 MP	294
7ba46799 MP	295	static inline u32 scsi_prot_ref_tag(struct scsi_cmnd *scmd)
	296	{
	297	struct request *rq = blk_mq_rq_from_pdu(scmd);
	298
	299	return t10_pi_ref_tag(rq);
	300	}
	301
c611529e MP	302	static inline unsigned int scsi_prot_interval(struct scsi_cmnd *scmd)
	303	{
	304	return scmd->device->sector_size;
	305	}
	306
7027ad72 MP	307	static inline unsigned scsi_prot_sg_count(struct scsi_cmnd *cmd)
	308	{
	309	return cmd->prot_sdb ? cmd->prot_sdb->table.nents : 0;
	310	}
	311
	312	static inline struct scatterlist scsi_prot_sglist(struct scsi_cmnd cmd)
	313	{
	314	return cmd->prot_sdb ? cmd->prot_sdb->table.sgl : NULL;
	315	}
	316
	317	static inline struct scsi_data_buffer scsi_prot(struct scsi_cmnd cmd)
	318	{
	319	return cmd->prot_sdb;
	320	}
	321
	322	#define scsi_for_each_prot_sg(cmd, sg, nseg, __i) \
	323	for_each_sg(scsi_prot_sglist(cmd), sg, nseg, __i)
	324
d37932a9 HR	325	static inline void set_status_byte(struct scsi_cmnd *cmd, char status)
	326	{
	327	cmd->result = (cmd->result & 0xffffff00) \| status;
	328	}
	329
f6b5a697 HR	330	static inline u8 get_status_byte(struct scsi_cmnd *cmd)
	331	{
	332	return cmd->result & 0xff;
	333	}
	334
f290f197 JB	335	static inline void set_host_byte(struct scsi_cmnd *cmd, char status)
f290f197 JB	336	{
3384db9e	337	cmd->result = (cmd->result & 0xff00ffff) \| (status << 16);
f290f197 JB	338	}
f290f197 JB	339
f6b5a697 HR	340	static inline u8 get_host_byte(struct scsi_cmnd *cmd)
	341	{
	342	return (cmd->result >> 16) & 0xff;
	343	}
	344
735b830c HR	345	/**
	346	* scsi_msg_to_host_byte() - translate message byte
	347	*
	348	* Translate the SCSI parallel message byte to a matching
	349	* host byte setting. A message of COMMAND_COMPLETE indicates
	350	* a successful command execution, any other message indicate
	351	* an error. As the messages themselves only have a meaning
	352	* for the SCSI parallel protocol this function translates
	353	* them into a matching host byte value for SCSI EH.
	354	*/
	355	static inline void scsi_msg_to_host_byte(struct scsi_cmnd *cmd, u8 msg)
	356	{
	357	switch (msg) {
	358	case COMMAND_COMPLETE:
	359	break;
	360	case ABORT_TASK_SET:
	361	set_host_byte(cmd, DID_ABORT);
	362	break;
	363	case TARGET_RESET:
	364	set_host_byte(cmd, DID_RESET);
	365	break;
	366	default:
	367	set_host_byte(cmd, DID_ERROR);
	368	break;
	369	}
	370	}
f290f197	371
8846bab1 SG	372	static inline unsigned scsi_transfer_length(struct scsi_cmnd *scmd)
8846bab1 SG	373	{
ae3d56d8	374	unsigned int xfer_len = scmd->sdb.length;
c611529e	375	unsigned int prot_interval = scsi_prot_interval(scmd);
8846bab1	376
c611529e MP	377	if (scmd->prot_flags & SCSI_PROT_TRANSFER_PI)
c611529e MP	378	xfer_len += (xfer_len >> ilog2(prot_interval)) * 8;
8846bab1	379
c611529e	380	return xfer_len;
8846bab1 SG	381	}
8846bab1 SG	382
f2b1e9c6 HR	383	extern void scsi_build_sense(struct scsi_cmnd *scmd, int desc,
	384	u8 key, u8 asc, u8 ascq);
	385
1da177e4	386	#endif /* _SCSI_SCSI_CMND_H */