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

/* SPDX-License-Identifier: GPL-2.0 */

#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;
	struct bio *bio;
};

/* The tape buffer descriptor. */
struct st_buffer {
	unsigned char dma;	/* DMA-able buffer */
	unsigned char cleared;  /* internal buffer cleared after open? */
	unsigned short 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 st_request *last_SRpnt;
	struct st_cmdstatus cmdstat;
	struct page **reserved_pages;
	int reserved_page_order;
	struct page **mapped_pages;
	struct rq_map_data map_data;
	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 frp_segs;	/* number of buffer segments */
};

/* 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 scsi_tape *tape;
	struct device *devs[2];  /* Auto-rewind and non-rewind devices */
	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 (1 << (20 - (ST_NBR_MODE_BITS + 1)))
#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;
};

/* Tape statistics */
struct scsi_tape_stats {
	atomic64_t read_byte_cnt;  /* bytes read */
	atomic64_t write_byte_cnt; /* bytes written */
	atomic64_t in_flight;      /* Number of I/Os in flight */
	atomic64_t read_cnt;       /* Count of read requests */
	atomic64_t write_cnt;      /* Count of write requests */
	atomic64_t other_cnt;      /* Count of other requests either
				    * implicit or from user space
				    * ioctl. */
	atomic64_t resid_cnt;      /* Count of resid_len > 0 */
	atomic64_t tot_read_time;  /* ktime spent completing reads */
	atomic64_t tot_write_time; /* ktime spent completing writes */
	atomic64_t tot_io_time;    /* ktime spent doing any I/O */
	ktime_t read_time;         /* holds ktime request was queued */
	ktime_t write_time;        /* holds ktime request was queued */
	ktime_t other_time;        /* holds ktime request was queued */
	atomic_t last_read_size;   /* Number of bytes issued for last read */
	atomic_t last_write_size;  /* Number of bytes issued for last write */
};

#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;
	int index;

	/* 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 */
	unsigned char immediate_filemark;	/* write filemark immediately */
	int tape_type;
	int long_timeout;	/* timeout for commands known to take long time */

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

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