[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_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

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

enum scsi_cmnd_submitter {
	SUBMITTED_BY_BLOCK_LAYER = 0,
	SUBMITTED_BY_SCSI_ERROR_HANDLER = 1,
	SUBMITTED_BY_SCSI_RESET_IOCTL = 2,
} __packed;

struct scsi_cmnd {
	struct scsi_request req;
	struct scsi_device *device;
	struct list_head eh_entry; /* entry for the host eh_abort_list/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;
	enum scsi_cmnd_submitter submitter;

	unsigned short cmd_len;
	enum dma_data_direction sc_data_direction;

	unsigned char cmnd[32]; /* SCSI CDB */

	/* 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 */

	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. */

	int flags;		/* Command flags */
	unsigned long state;	/* Command completion state */

	unsigned int extra_len;	/* length of alignment and padding */

	/*
	 * The fields below can be modified by the LLD but the fields above
	 * must not be modified.
	 */

	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 */
};

/* Variant of blk_mq_rq_from_pdu() that verifies the type of its argument. */
static inline struct request *scsi_cmd_to_rq(struct scsi_cmnd *scmd)
{
	return blk_mq_rq_from_pdu(scmd);
}

/*
 * 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)
{
	struct request *rq = scsi_cmd_to_rq(cmd);

	return *(struct scsi_driver **)rq->q->disk->private_data;
}

void scsi_done(struct scsi_cmnd *cmd);
void scsi_done_direct(struct scsi_cmnd *cmd);

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(scsi_cmd_to_rq(scmd));
}

static inline sector_t scsi_get_lba(struct scsi_cmnd *scmd)
{
	unsigned int shift = ilog2(scmd->device->sector_size) - SECTOR_SHIFT;

	return blk_rq_pos(scsi_cmd_to_rq(scmd)) >> shift;
}

static inline unsigned int scsi_logical_block_count(struct scsi_cmnd *scmd)
{
	unsigned int shift = ilog2(scmd->device->sector_size) - SECTOR_SHIFT;

	return blk_rq_bytes(scsi_cmd_to_rq(scmd)) >> shift;
}

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

struct request *scsi_alloc_request(struct request_queue *q,
		unsigned int op, blk_mq_req_flags_t flags);

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