cregit-Linux how code gets into the kernel

Release 4.15 include/scsi/scsi_cmnd.h

Directory: include/scsi
/* 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/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;

#include <scsi/scsi_device.h>

/*
 * 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_ZONE_WRITE_LOCK	(1 << 2)

#define SCMD_INITIALIZED	(1 << 3)
/* flags preserved across unprep / reprep */

#define SCMD_PRESERVED_FLAGS	(SCMD_UNCHECKED_ISA_DMA | SCMD_INITIALIZED)


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


#define SCSI_SENSE_BUFFERSIZE 	96
	
unsigned char *sense_buffer;
				/* obtained by REQUEST SENSE when
                                 * CHECK CONDITION is received on original
                                 * command (auto-sense) */

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

Contributors

PersonTokensPropCommitsCommitProp
Christoph Hellwig18100.00%1100.00%
Total18100.00%1100.00%

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

Contributors

PersonTokensPropCommitsCommitProp
Martin K. Petersen2996.67%266.67%
Li Zhong13.33%133.33%
Total30100.00%3100.00%

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 int scsi_init_io(struct scsi_cmnd *cmd); extern void scsi_initialize_rq(struct request *rq); extern int scsi_dma_map(struct scsi_cmnd *cmd); extern void scsi_dma_unmap(struct scsi_cmnd *cmd);
static inline unsigned scsi_sg_count(struct scsi_cmnd *cmd) { return cmd->sdb.table.nents; }

Contributors

PersonTokensPropCommitsCommitProp
Boaz Harrosh1780.95%150.00%
FUJITA Tomonori419.05%150.00%
Total21100.00%2100.00%


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

Contributors

PersonTokensPropCommitsCommitProp
Boaz Harrosh1982.61%150.00%
FUJITA Tomonori417.39%150.00%
Total23100.00%2100.00%


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

Contributors

PersonTokensPropCommitsCommitProp
Boaz Harrosh1578.95%150.00%
FUJITA Tomonori421.05%150.00%
Total19100.00%2100.00%


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

Contributors

PersonTokensPropCommitsCommitProp
FUJITA Tomonori2191.30%150.00%
Boaz Harrosh28.70%150.00%
Total23100.00%2100.00%


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

Contributors

PersonTokensPropCommitsCommitProp
FUJITA Tomonori1789.47%150.00%
Boaz Harrosh210.53%150.00%
Total19100.00%2100.00%

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

Contributors

PersonTokensPropCommitsCommitProp
Boaz Harrosh32100.00%1100.00%
Total32100.00%1100.00%


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

Contributors

PersonTokensPropCommitsCommitProp
Boaz Harrosh33100.00%1100.00%
Total33100.00%1100.00%


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

Contributors

PersonTokensPropCommitsCommitProp
Boaz Harrosh20100.00%1100.00%
Total20100.00%1100.00%


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

Contributors

PersonTokensPropCommitsCommitProp
FUJITA Tomonori37100.00%1100.00%
Total37100.00%1100.00%


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

Contributors

PersonTokensPropCommitsCommitProp
FUJITA Tomonori37100.00%1100.00%
Total37100.00%1100.00%

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

Contributors

PersonTokensPropCommitsCommitProp
Martin K. Petersen22100.00%1100.00%
Total22100.00%1100.00%


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

Contributors

PersonTokensPropCommitsCommitProp
Martin K. Petersen18100.00%1100.00%
Total18100.00%1100.00%

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

Contributors

PersonTokensPropCommitsCommitProp
Martin K. Petersen22100.00%1100.00%
Total22100.00%1100.00%


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

Contributors

PersonTokensPropCommitsCommitProp
Martin K. Petersen18100.00%1100.00%
Total18100.00%1100.00%


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

Contributors

PersonTokensPropCommitsCommitProp
Martin K. Petersen1785.00%150.00%
Tejun Heo315.00%150.00%
Total20100.00%2100.00%


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

Contributors

PersonTokensPropCommitsCommitProp
Martin K. Petersen20100.00%1100.00%
Total20100.00%1100.00%


static inline u32 scsi_prot_ref_tag(struct scsi_cmnd *scmd) { return blk_rq_pos(scmd->request) >> (ilog2(scsi_prot_interval(scmd)) - 9) & 0xffffffff; }

Contributors

PersonTokensPropCommitsCommitProp
Martin K. Petersen34100.00%1100.00%
Total34100.00%1100.00%


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

Contributors

PersonTokensPropCommitsCommitProp
Martin K. Petersen27100.00%1100.00%
Total27100.00%1100.00%


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

Contributors

PersonTokensPropCommitsCommitProp
Martin K. Petersen29100.00%1100.00%
Total29100.00%1100.00%


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

Contributors

PersonTokensPropCommitsCommitProp
Martin K. Petersen19100.00%1100.00%
Total19100.00%1100.00%

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

Contributors

PersonTokensPropCommitsCommitProp
James Bottomley2266.67%150.00%
Babu Moger1133.33%150.00%
Total33100.00%2100.00%


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

Contributors

PersonTokensPropCommitsCommitProp
James Bottomley2266.67%150.00%
Babu Moger1133.33%150.00%
Total33100.00%2100.00%


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

Contributors

PersonTokensPropCommitsCommitProp
James Bottomley2266.67%150.00%
Babu Moger1133.33%150.00%
Total33100.00%2100.00%


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

Contributors

PersonTokensPropCommitsCommitProp
Sagi Grimberg4173.21%133.33%
Martin K. Petersen1526.79%266.67%
Total56100.00%3100.00%

#endif /* _SCSI_SCSI_CMND_H */

Overall Contributors

PersonTokensPropCommitsCommitProp
Martin K. Petersen38032.20%614.29%
Christoph Hellwig21518.22%614.29%
Boaz Harrosh18115.34%511.90%
FUJITA Tomonori16814.24%49.52%
James Bottomley716.02%24.76%
Sagi Grimberg443.73%12.38%
Babu Moger332.80%12.38%
Guennadi Liakhovetski292.46%12.38%
Bart Van Assche231.95%37.14%
Jeff Garzik80.68%12.38%
Jens Axboe60.51%24.76%
Hannes Reinecke40.34%12.38%
Damien Le Moal40.34%12.38%
Tejun Heo30.25%12.38%
Matthew Wilcox30.25%24.76%
Tim Schmielau30.25%12.38%
Luben Tuikov20.17%12.38%
Kurt Garloff10.08%12.38%
Greg Kroah-Hartman10.08%12.38%
Li Zhong10.08%12.38%
Total1180100.00%42100.00%
Directory: include/scsi
Information contained on this website is for historical information purposes only and does not indicate or represent copyright ownership.
Created with cregit.