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


#ifndef _ST_H
#define _ST_H

#include <linux/completion.h>


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

/* The tape buffer descriptor. */
struct st_buffer {
	unsigned char in_use;
	unsigned char dma;	/* DMA-able buffer */
	unsigned char do_dio;   /* direct i/o set up? */
	int buffer_size;
	int buffer_blocks;
	int buffer_bytes;
	int read_pointer;
	int writing;
	int syscall_result;
	struct scsi_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 semaphore 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? */
	unsigned char c_algo;			/* compression algorithm */
	unsigned char pos_unknown;			/* after reset position unknown */
	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;
	int nbr_combinable;
	unsigned char last_cmnd[6];
	unsigned char last_sense[16];
#endif
	struct gendisk *disk;
};

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