[mirror_ubuntu-jammy-kernel.git] / drivers / scsi / st.h


#ifndef _ST_H
#define _ST_H

#include <linux/completion.h>
#include <linux/mutex.h>
#include <linux/kref.h>
#include <scsi/scsi_cmnd.h>

/* Descriptor for analyzed sense data */
struct st_cmdstatus {
	int midlevel_result;
	struct scsi_sense_hdr sense_hdr;
	int have_sense;
	int residual;
	u64 uremainder64;
	u8 flags;
	u8 remainder_valid;
	u8 fixed_format;
	u8 deferred;
};

struct scsi_tape;

/* scsi tape command */
struct st_request {
	unsigned char cmd[MAX_COMMAND_SIZE];
	unsigned char sense[SCSI_SENSE_BUFFERSIZE];
	int result;
	struct scsi_tape *stp;
	struct completion *waiting;
};

/* The tape buffer descriptor. */
struct st_buffer {
	unsigned char dma;	/* DMA-able buffer */
	unsigned char do_dio;   /* direct i/o set up? */
	unsigned char cleared;  /* internal buffer cleared after open? */
	int buffer_size;
	int buffer_blocks;
	int buffer_bytes;
	int read_pointer;
	int writing;
	int syscall_result;
	struct st_request *last_SRpnt;
	struct st_cmdstatus cmdstat;
	unsigned char *b_data;
	unsigned short use_sg;	/* zero or max number of s/g segments for this adapter */
	unsigned short sg_segs;		/* number of segments in s/g list */
	unsigned short orig_frp_segs;	/* number of segments allocated at first try */
	unsigned short frp_segs;	/* number of buffer segments */
	unsigned int frp_sg_current;	/* driver buffer length currently in s/g list */
	struct st_buf_fragment *frp;	/* the allocated buffer fragment list */
	struct scatterlist sg[1];	/* MUST BE last item */
};

/* The tape buffer fragment descriptor */
struct st_buf_fragment {
	struct page *page;
	unsigned int length;
};

/* The tape mode definition */
struct st_modedef {
	unsigned char defined;
	unsigned char sysv;	/* SYS V semantics? */
	unsigned char do_async_writes;
	unsigned char do_buffer_writes;
	unsigned char do_read_ahead;
	unsigned char defaults_for_writes;
	unsigned char default_compression;	/* 0 = don't touch, etc */
	short default_density;	/* Forced density, -1 = no value */
	int default_blksize;	/* Forced blocksize, -1 = no value */
	struct cdev *cdevs[2];  /* Auto-rewind and non-rewind devices */
};

/* Number of modes can be changed by changing ST_NBR_MODE_BITS. The maximum
   number of modes is 16 (ST_NBR_MODE_BITS 4) */
#define ST_NBR_MODE_BITS 2
#define ST_NBR_MODES (1 << ST_NBR_MODE_BITS)
#define ST_MODE_SHIFT (7 - ST_NBR_MODE_BITS)
#define ST_MODE_MASK ((ST_NBR_MODES - 1) << ST_MODE_SHIFT)

#define ST_MAX_TAPES 128
#define ST_MAX_TAPE_ENTRIES  (ST_MAX_TAPES << (ST_NBR_MODE_BITS + 1))

/* The status related to each partition */
struct st_partstat {
	unsigned char rw;
	unsigned char eof;
	unsigned char at_sm;
	unsigned char last_block_valid;
	u32 last_block_visited;
	int drv_block;		/* The block where the drive head is */
	int drv_file;
};

#define ST_NBR_PARTITIONS 4

/* The tape drive descriptor */
struct scsi_tape {
	struct scsi_driver *driver;
	struct scsi_device *device;
	struct mutex lock;	/* For serialization */
	struct completion wait;	/* For SCSI commands */
	struct st_buffer *buffer;

	/* Drive characteristics */
	unsigned char omit_blklims;
	unsigned char do_auto_lock;
	unsigned char can_bsr;
	unsigned char can_partitions;
	unsigned char two_fm;
	unsigned char fast_mteom;
	unsigned char immediate;
	unsigned char restr_dma;
	unsigned char scsi2_logical;
	unsigned char default_drvbuffer;	/* 0xff = don't touch, value 3 bits */
	unsigned char cln_mode;			/* 0 = none, otherwise sense byte nbr */
	unsigned char cln_sense_value;
	unsigned char cln_sense_mask;
	unsigned char use_pf;			/* Set Page Format bit in all mode selects? */
	unsigned char try_dio;			/* try direct i/o in general? */
	unsigned char try_dio_now;		/* try direct i/o before next close? */
	unsigned char c_algo;			/* compression algorithm */
	unsigned char pos_unknown;			/* after reset position unknown */
	unsigned char sili;			/* use SILI when reading in variable b mode */
	int tape_type;
	int long_timeout;	/* timeout for commands known to take long time */

	unsigned long max_pfn;	/* the maximum page number reachable by the HBA */

	/* Mode characteristics */
	struct st_modedef modes[ST_NBR_MODES];
	int current_mode;

	/* Status variables */
	int partition;
	int new_partition;
	int nbr_partitions;	/* zero until partition support enabled */
	struct st_partstat ps[ST_NBR_PARTITIONS];
	unsigned char dirty;
	unsigned char ready;
	unsigned char write_prot;
	unsigned char drv_write_prot;
	unsigned char in_use;
	unsigned char blksize_changed;
	unsigned char density_changed;
	unsigned char compression_changed;
	unsigned char drv_buffer;
	unsigned char density;
	unsigned char door_locked;
	unsigned char autorew_dev;   /* auto-rewind device */
	unsigned char rew_at_close;  /* rewind necessary at close */
	unsigned char inited;
	unsigned char cleaning_req;  /* cleaning requested? */
	int block_size;
	int min_block;
	int max_block;
	int recover_count;     /* From tape opening */
	int recover_reg;       /* From last status call */

#if DEBUG
	unsigned char write_pending;
	int nbr_finished;
	int nbr_waits;
	int nbr_requests;
	int nbr_dio;
	int nbr_pages;
	unsigned char last_cmnd[6];
	unsigned char last_sense[16];
#endif
	struct gendisk *disk;
	struct kref     kref;
};

/* Bit masks for use_pf */
#define USE_PF      1
#define PF_TESTED   2

/* Values of eof */
#define	ST_NOEOF	0
#define ST_FM_HIT       1
#define ST_FM           2
#define ST_EOM_OK       3
#define ST_EOM_ERROR	4
#define	ST_EOD_1        5
#define ST_EOD_2        6
#define ST_EOD		7
/* EOD hit while reading => ST_EOD_1 => return zero => ST_EOD_2 =>
   return zero => ST_EOD, return ENOSPC */
/* When writing: ST_EOM_OK == early warning found, write OK
		 ST_EOD_1  == allow trying new write after early warning
		 ST_EOM_ERROR == early warning found, not able to write all */

/* Values of rw */
#define	ST_IDLE		0
#define	ST_READING	1
#define	ST_WRITING	2

/* Values of ready state */
#define ST_READY	0
#define ST_NOT_READY	1
#define ST_NO_TAPE	2

/* Values for door lock state */
#define ST_UNLOCKED	0
#define ST_LOCKED_EXPLICIT 1
#define ST_LOCKED_AUTO  2
#define ST_LOCK_FAILS   3

/* Positioning SCSI-commands for Tandberg, etc. drives */
#define	QFA_REQUEST_BLOCK	0x02
#define	QFA_SEEK_BLOCK		0x0c

/* Setting the binary options */
#define ST_DONT_TOUCH  0
#define ST_NO          1
#define ST_YES         2

#define EXTENDED_SENSE_START  18

/* Masks for some conditions in the sense data */
#define SENSE_FMK   0x80
#define SENSE_EOM   0x40
#define SENSE_ILI   0x20

#endif
Commit	Line	Data
1da177e4 LT	1
	2	#ifndef _ST_H
	3	#define _ST_H
	4
	5	#include <linux/completion.h>
28f85009	6	#include <linux/mutex.h>
f03a5670	7	#include <linux/kref.h>
8b05b773	8	#include <scsi/scsi_cmnd.h>
1da177e4 LT	9
	10	/* Descriptor for analyzed sense data */
	11	struct st_cmdstatus {
	12	int midlevel_result;
	13	struct scsi_sense_hdr sense_hdr;
	14	int have_sense;
40f6b36c	15	int residual;
1da177e4 LT	16	u64 uremainder64;
	17	u8 flags;
	18	u8 remainder_valid;
	19	u8 fixed_format;
	20	u8 deferred;
	21	};
	22
8b05b773 MC	23	struct scsi_tape;
	24
	25	/* scsi tape command */
	26	struct st_request {
	27	unsigned char cmd[MAX_COMMAND_SIZE];
	28	unsigned char sense[SCSI_SENSE_BUFFERSIZE];
	29	int result;
	30	struct scsi_tape *stp;
	31	struct completion *waiting;
	32	};
	33
1da177e4 LT	34	/* The tape buffer descriptor. */
1da177e4 LT	35	struct st_buffer {
1da177e4 LT	36	unsigned char dma; /* DMA-able buffer */
1da177e4 LT	37	unsigned char do_dio; /* direct i/o set up? */
40f6b36c	38	unsigned char cleared; /* internal buffer cleared after open? */
1da177e4 LT	39	int buffer_size;
	40	int buffer_blocks;
	41	int buffer_bytes;
	42	int read_pointer;
	43	int writing;
	44	int syscall_result;
8b05b773	45	struct st_request *last_SRpnt;
1da177e4 LT	46	struct st_cmdstatus cmdstat;
	47	unsigned char *b_data;
	48	unsigned short use_sg; /* zero or max number of s/g segments for this adapter */
	49	unsigned short sg_segs; /* number of segments in s/g list */
	50	unsigned short orig_frp_segs; /* number of segments allocated at first try */
	51	unsigned short frp_segs; /* number of buffer segments */
	52	unsigned int frp_sg_current; /* driver buffer length currently in s/g list */
	53	struct st_buf_fragment frp; / the allocated buffer fragment list */
	54	struct scatterlist sg[1]; /* MUST BE last item */
	55	};
	56
	57	/* The tape buffer fragment descriptor */
	58	struct st_buf_fragment {
	59	struct page *page;
	60	unsigned int length;
	61	};
	62
	63	/* The tape mode definition */
	64	struct st_modedef {
	65	unsigned char defined;
	66	unsigned char sysv; /* SYS V semantics? */
	67	unsigned char do_async_writes;
	68	unsigned char do_buffer_writes;
	69	unsigned char do_read_ahead;
	70	unsigned char defaults_for_writes;
	71	unsigned char default_compression; /* 0 = don't touch, etc */
	72	short default_density; /* Forced density, -1 = no value */
	73	int default_blksize; /* Forced blocksize, -1 = no value */
	74	struct cdev cdevs[2]; / Auto-rewind and non-rewind devices */
	75	};
	76
	77	/* Number of modes can be changed by changing ST_NBR_MODE_BITS. The maximum
	78	number of modes is 16 (ST_NBR_MODE_BITS 4) */
	79	#define ST_NBR_MODE_BITS 2
	80	#define ST_NBR_MODES (1 << ST_NBR_MODE_BITS)
	81	#define ST_MODE_SHIFT (7 - ST_NBR_MODE_BITS)
	82	#define ST_MODE_MASK ((ST_NBR_MODES - 1) << ST_MODE_SHIFT)
	83
	84	#define ST_MAX_TAPES 128
	85	#define ST_MAX_TAPE_ENTRIES (ST_MAX_TAPES << (ST_NBR_MODE_BITS + 1))
	86
	87	/* The status related to each partition */
	88	struct st_partstat {
	89	unsigned char rw;
	90	unsigned char eof;
	91	unsigned char at_sm;
	92	unsigned char last_block_valid;
	93	u32 last_block_visited;
	94	int drv_block; /* The block where the drive head is */
	95	int drv_file;
	96	};
	97
	98	#define ST_NBR_PARTITIONS 4
	99
	100	/* The tape drive descriptor */
	101	struct scsi_tape {
	102	struct scsi_driver *driver;
	103	struct scsi_device *device;
28f85009	104	struct mutex lock; /* For serialization */
1da177e4 LT	105	struct completion wait; /* For SCSI commands */
	106	struct st_buffer *buffer;
	107
	108	/* Drive characteristics */
	109	unsigned char omit_blklims;
	110	unsigned char do_auto_lock;
	111	unsigned char can_bsr;
	112	unsigned char can_partitions;
	113	unsigned char two_fm;
	114	unsigned char fast_mteom;
	115	unsigned char immediate;
	116	unsigned char restr_dma;
	117	unsigned char scsi2_logical;
	118	unsigned char default_drvbuffer; /* 0xff = don't touch, value 3 bits */
	119	unsigned char cln_mode; /* 0 = none, otherwise sense byte nbr */
	120	unsigned char cln_sense_value;
	121	unsigned char cln_sense_mask;
	122	unsigned char use_pf; /* Set Page Format bit in all mode selects? */
9abe16c6 KM	123	unsigned char try_dio; /* try direct i/o in general? */
9abe16c6 KM	124	unsigned char try_dio_now; /* try direct i/o before next close? */
1da177e4 LT	125	unsigned char c_algo; /* compression algorithm */
1da177e4 LT	126	unsigned char pos_unknown; /* after reset position unknown */
40f6b36c	127	unsigned char sili; /* use SILI when reading in variable b mode */
1da177e4 LT	128	int tape_type;
	129	int long_timeout; /* timeout for commands known to take long time */
	130
	131	unsigned long max_pfn; /* the maximum page number reachable by the HBA */
	132
	133	/* Mode characteristics */
	134	struct st_modedef modes[ST_NBR_MODES];
	135	int current_mode;
	136
	137	/* Status variables */
	138	int partition;
	139	int new_partition;
	140	int nbr_partitions; /* zero until partition support enabled */
	141	struct st_partstat ps[ST_NBR_PARTITIONS];
	142	unsigned char dirty;
	143	unsigned char ready;
	144	unsigned char write_prot;
	145	unsigned char drv_write_prot;
	146	unsigned char in_use;
	147	unsigned char blksize_changed;
	148	unsigned char density_changed;
	149	unsigned char compression_changed;
	150	unsigned char drv_buffer;
	151	unsigned char density;
	152	unsigned char door_locked;
	153	unsigned char autorew_dev; /* auto-rewind device */
	154	unsigned char rew_at_close; /* rewind necessary at close */
	155	unsigned char inited;
	156	unsigned char cleaning_req; /* cleaning requested? */
	157	int block_size;
	158	int min_block;
	159	int max_block;
	160	int recover_count; /* From tape opening */
	161	int recover_reg; /* From last status call */
	162
	163	#if DEBUG
	164	unsigned char write_pending;
	165	int nbr_finished;
	166	int nbr_waits;
	167	int nbr_requests;
	168	int nbr_dio;
	169	int nbr_pages;
1da177e4 LT	170	unsigned char last_cmnd[6];
	171	unsigned char last_sense[16];
	172	#endif
	173	struct gendisk *disk;
f03a5670	174	struct kref kref;
1da177e4 LT	175	};
	176
	177	/* Bit masks for use_pf */
	178	#define USE_PF 1
	179	#define PF_TESTED 2
	180
	181	/* Values of eof */
	182	#define ST_NOEOF 0
	183	#define ST_FM_HIT 1
	184	#define ST_FM 2
	185	#define ST_EOM_OK 3
	186	#define ST_EOM_ERROR 4
	187	#define ST_EOD_1 5
	188	#define ST_EOD_2 6
	189	#define ST_EOD 7
	190	/* EOD hit while reading => ST_EOD_1 => return zero => ST_EOD_2 =>
	191	return zero => ST_EOD, return ENOSPC */
	192	/* When writing: ST_EOM_OK == early warning found, write OK
	193	ST_EOD_1 == allow trying new write after early warning
	194	ST_EOM_ERROR == early warning found, not able to write all */
	195
	196	/* Values of rw */
	197	#define ST_IDLE 0
	198	#define ST_READING 1
	199	#define ST_WRITING 2
	200
	201	/* Values of ready state */
	202	#define ST_READY 0
	203	#define ST_NOT_READY 1
	204	#define ST_NO_TAPE 2
	205
	206	/* Values for door lock state */
	207	#define ST_UNLOCKED 0
	208	#define ST_LOCKED_EXPLICIT 1
	209	#define ST_LOCKED_AUTO 2
	210	#define ST_LOCK_FAILS 3
	211
	212	/* Positioning SCSI-commands for Tandberg, etc. drives */
	213	#define QFA_REQUEST_BLOCK 0x02
	214	#define QFA_SEEK_BLOCK 0x0c
	215
	216	/* Setting the binary options */
	217	#define ST_DONT_TOUCH 0
	218	#define ST_NO 1
	219	#define ST_YES 2
	220
	221	#define EXTENDED_SENSE_START 18
	222
	223	/* Masks for some conditions in the sense data */
	224	#define SENSE_FMK 0x80
	225	#define SENSE_EOM 0x40
	226	#define SENSE_ILI 0x20
	227
	228	#endif