[deliverable/linux.git] / include / scsi / scsi_cmnd.h

#ifndef _SCSI_SCSI_CMND_H
#define _SCSI_SCSI_CMND_H

#include <linux/dma-mapping.h>
#include <linux/list.h>
#include <linux/types.h>
#include <linux/timer.h>

struct request;
struct scatterlist;
struct Scsi_Host;
struct scsi_device;


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

struct scsi_cmnd {
	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 */
	int eh_eflags;		/* Used by error handlr */
	void (*done) (struct scsi_cmnd *);	/* Mid-level done function */

	/*
	 * 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 currently doesn't have much use other
	 * than printk's.  Some lldd's use this number for other purposes.
	 * It's almost certain that such usages are either incorrect or
	 * meaningless.  Please kill all usages other than printk's.  Also,
	 * as this number is always identical to ->pid, please convert
	 * printk's to use ->pid, so that we can kill this field.
	 */
	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;
	int timeout_per_command;

	unsigned char cmd_len;
	enum dma_data_direction sc_data_direction;

	/* These elements define the operation we are about to perform */
#define MAX_COMMAND_SIZE	16
	unsigned char cmnd[MAX_COMMAND_SIZE];
	unsigned request_bufflen;	/* Actual request size */

	struct timer_list eh_timeout;	/* Used to time out the command. */
	void *request_buffer;		/* Actual requested buffer */

	/* These elements define the operation we ultimately want to perform */
	unsigned short use_sg;	/* Number of pieces of scatter-gather */
	unsigned short sglist_len;	/* size of malloc'd scatter-gather list */

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

	int resid;		/* Number of bytes requested to be
				   transferred less actual number
				   transferred (0 if not supported) */

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

#define SCSI_SENSE_BUFFERSIZE 	96
	unsigned char sense_buffer[SCSI_SENSE_BUFFERSIZE];
				/* 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 */

	unsigned char tag;	/* SCSI-II queued command tag */
	unsigned long pid;	/* Process ID, starts at 0. Unique per host. */
};

extern struct scsi_cmnd *scsi_get_command(struct scsi_device *, gfp_t);
extern struct scsi_cmnd *__scsi_get_command(struct Scsi_Host *, gfp_t);
extern void scsi_put_command(struct scsi_cmnd *);
extern void __scsi_put_command(struct Scsi_Host *, struct scsi_cmnd *,
			       struct device *);
extern void scsi_io_completion(struct scsi_cmnd *, unsigned int);
extern void scsi_finish_command(struct scsi_cmnd *cmd);
extern void scsi_req_abort_cmd(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 struct scatterlist *scsi_alloc_sgtable(struct scsi_cmnd *, gfp_t);
extern void scsi_free_sgtable(struct scatterlist *, int);

#endif /* _SCSI_SCSI_CMND_H */
Commit	Line	Data
1da177e4 LT	1	#ifndef _SCSI_SCSI_CMND_H
	2	#define _SCSI_SCSI_CMND_H
	3
	4	#include <linux/dma-mapping.h>
	5	#include <linux/list.h>
	6	#include <linux/types.h>
4e57b681	7	#include <linux/timer.h>
1da177e4 LT	8
	9	struct request;
	10	struct scatterlist;
b58d9154	11	struct Scsi_Host;
1da177e4	12	struct scsi_device;
1da177e4 LT	13
	14
	15	/* embedded in scsi_cmnd */
	16	struct scsi_pointer {
	17	char ptr; / data pointer */
	18	int this_residual; /* left in this buffer */
	19	struct scatterlist buffer; / which buffer */
	20	int buffers_residual; /* how many buffers left */
	21
	22	dma_addr_t dma_handle;
	23
	24	volatile int Status;
	25	volatile int Message;
	26	volatile int have_data_in;
	27	volatile int sent_command;
	28	volatile int phase;
	29	};
	30
	31	struct scsi_cmnd {
1da177e4	32	struct scsi_device *device;
1da177e4	33	struct list_head list; /* scsi_cmnd participates in queue lists */
1da177e4	34	struct list_head eh_entry; /* entry for the host eh_cmd_q */
1da177e4 LT	35	int eh_eflags; /* Used by error handlr */
	36	void (done) (struct scsi_cmnd ); /* Mid-level done function */
	37
	38	/*
c6295cdf	39	* A SCSI Command is assigned a nonzero serial_number before passed
	40	* to the driver's queue command function. The serial_number is
	41	* cleared when scsi_done is entered indicating that the command
	42	* has been completed. It currently doesn't have much use other
	43	* than printk's. Some lldd's use this number for other purposes.
	44	* It's almost certain that such usages are either incorrect or
	45	* meaningless. Please kill all usages other than printk's. Also,
	46	* as this number is always identical to ->pid, please convert
	47	* printk's to use ->pid, so that we can kill this field.
1da177e4 LT	48	*/
1da177e4 LT	49	unsigned long serial_number;
b21a4138 JB	50	/*
	51	* This is set to jiffies as it was when the command was first
	52	* allocated. It is used to time how long the command has
	53	* been outstanding
	54	*/
	55	unsigned long jiffies_at_alloc;
1da177e4 LT	56
	57	int retries;
	58	int allowed;
	59	int timeout_per_command;
1da177e4	60
1da177e4	61	unsigned char cmd_len;
1da177e4	62	enum dma_data_direction sc_data_direction;
1da177e4 LT	63
	64	/* These elements define the operation we are about to perform */
	65	#define MAX_COMMAND_SIZE 16
	66	unsigned char cmnd[MAX_COMMAND_SIZE];
	67	unsigned request_bufflen; /* Actual request size */
	68
	69	struct timer_list eh_timeout; /* Used to time out the command. */
	70	void request_buffer; / Actual requested buffer */
	71
	72	/* These elements define the operation we ultimately want to perform */
1da177e4 LT	73	unsigned short use_sg; /* Number of pieces of scatter-gather */
1da177e4 LT	74	unsigned short sglist_len; /* size of malloc'd scatter-gather list */
1da177e4 LT	75
	76	unsigned underflow; /* Return error if less than
	77	this amount is transferred */
1da177e4 LT	78
	79	unsigned transfersize; /* How much we are guaranteed to
	80	transfer with each SCSI transfer
	81	(ie, between disconnect /
	82	reconnects. Probably == sector
	83	size */
	84
	85	int resid; /* Number of bytes requested to be
	86	transferred less actual number
	87	transferred (0 if not supported) */
	88
	89	struct request request; / The command we are
	90	working on */
	91
	92	#define SCSI_SENSE_BUFFERSIZE 96
c67a848c MW	93	unsigned char sense_buffer[SCSI_SENSE_BUFFERSIZE];
	94	/* obtained by REQUEST SENSE when
	95	* CHECK CONDITION is received on original
	96	* command (auto-sense) */
1da177e4 LT	97
	98	/* Low-level done function - can be used by low-level driver to point
	99	* to completion function. Not used by mid/upper level code. */
	100	void (scsi_done) (struct scsi_cmnd );
	101
	102	/*
	103	* The following fields can be written to by the host specific code.
	104	* Everything else should be left alone.
	105	*/
	106	struct scsi_pointer SCp; /* Scratchpad used by some host adapters */
	107
	108	unsigned char host_scribble; / The host adapter is allowed to
c67a848c MW	109	* call scsi_malloc and get some memory
	110	* and hang it here. The host adapter
	111	* is also expected to call scsi_free
	112	* to release this memory. (The memory
	113	* obtained by scsi_malloc is guaranteed
	114	* to be at an address < 16Mb). */
1da177e4 LT	115
	116	int result; /* Status code from lower level driver */
	117
	118	unsigned char tag; /* SCSI-II queued command tag */
	119	unsigned long pid; /* Process ID, starts at 0. Unique per host. */
	120	};
	121
c53033f6	122	extern struct scsi_cmnd scsi_get_command(struct scsi_device , gfp_t);
b58d9154	123	extern struct scsi_cmnd __scsi_get_command(struct Scsi_Host , gfp_t);
1da177e4	124	extern void scsi_put_command(struct scsi_cmnd *);
b58d9154 FT	125	extern void __scsi_put_command(struct Scsi_Host , struct scsi_cmnd ,
b58d9154 FT	126	struct device *);
03aba2f7	127	extern void scsi_io_completion(struct scsi_cmnd *, unsigned int);
1da177e4	128	extern void scsi_finish_command(struct scsi_cmnd *cmd);
89f48c4d	129	extern void scsi_req_abort_cmd(struct scsi_cmnd *cmd);
1da177e4	130
cdb8c2a6 GL	131	extern void scsi_kmap_atomic_sg(struct scatterlist sg, int sg_count,
	132	size_t offset, size_t len);
	133	extern void scsi_kunmap_atomic_sg(void *virt);
	134
b58d9154 FT	135	extern struct scatterlist scsi_alloc_sgtable(struct scsi_cmnd , gfp_t);
	136	extern void scsi_free_sgtable(struct scatterlist *, int);
	137
1da177e4	138	#endif /* _SCSI_SCSI_CMND_H */