xref: /netbsd-src/sys/dev/scsipi/stvar.h (revision 76e339c2fce2377cebb86059cc9a525d99842710)
1*76e339c2Smlelstv /*	$NetBSD: stvar.h,v 1.26 2018/03/24 08:08:19 mlelstv Exp $ */
227155d9aSbouyer 
327155d9aSbouyer /*-
427155d9aSbouyer  * Copyright (c) 1998 The NetBSD Foundation, Inc.
527155d9aSbouyer  * All rights reserved.
627155d9aSbouyer  *
727155d9aSbouyer  * This code is derived from software contributed to The NetBSD Foundation
827155d9aSbouyer  * by Charles M. Hannum.
927155d9aSbouyer  *
1027155d9aSbouyer  * Redistribution and use in source and binary forms, with or without
1127155d9aSbouyer  * modification, are permitted provided that the following conditions
1227155d9aSbouyer  * are met:
1327155d9aSbouyer  * 1. Redistributions of source code must retain the above copyright
1427155d9aSbouyer  *    notice, this list of conditions and the following disclaimer.
1527155d9aSbouyer  * 2. Redistributions in binary form must reproduce the above copyright
1627155d9aSbouyer  *    notice, this list of conditions and the following disclaimer in the
1727155d9aSbouyer  *    documentation and/or other materials provided with the distribution.
1827155d9aSbouyer  *
1927155d9aSbouyer  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
2027155d9aSbouyer  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
2127155d9aSbouyer  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
2227155d9aSbouyer  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
2327155d9aSbouyer  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
2427155d9aSbouyer  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
2527155d9aSbouyer  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
2627155d9aSbouyer  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
2727155d9aSbouyer  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
2827155d9aSbouyer  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
2927155d9aSbouyer  * POSSIBILITY OF SUCH DAMAGE.
3027155d9aSbouyer  */
3127155d9aSbouyer 
3227155d9aSbouyer /*
3327155d9aSbouyer  * Originally written by Julian Elischer (julian@tfs.com)
3427155d9aSbouyer  * for TRW Financial Systems for use under the MACH(2.5) operating system.
3527155d9aSbouyer  *
3627155d9aSbouyer  * TRW Financial Systems, in accordance with their agreement with Carnegie
3727155d9aSbouyer  * Mellon University, makes this software available to CMU to distribute
3827155d9aSbouyer  * or use in any manner that they see fit as long as this message is kept with
3927155d9aSbouyer  * the software. For this reason TFS also grants any other persons or
4027155d9aSbouyer  * organisations permission to use or modify this software.
4127155d9aSbouyer  *
4227155d9aSbouyer  * TFS supplies this software to be publicly redistributed
4327155d9aSbouyer  * on the understanding that TFS is not responsible for the correct
4427155d9aSbouyer  * functioning of this software in any circumstances.
4527155d9aSbouyer  *
4627155d9aSbouyer  * Ported to run under 386BSD by Julian Elischer (julian@tfs.com) Sept 1992
4727155d9aSbouyer  * major changes by Julian Elischer (julian@jules.dialix.oz.au) May 1993
4827155d9aSbouyer  *
4927155d9aSbouyer  * A lot of rewhacking done by mjacob (mjacob@nas.nasa.gov).
5027155d9aSbouyer  */
5127155d9aSbouyer 
52233f556cSriastradh #include <sys/rndsource.h>
5327155d9aSbouyer 
5427155d9aSbouyer #include <dev/scsipi/scsipi_all.h>
5527155d9aSbouyer #include <dev/scsipi/scsiconf.h>
5627155d9aSbouyer 
570a63f01fSbouyer #define	ST_IO_TIME	(3 * 60 * 1000)		/* 3 minutes */
580a63f01fSbouyer #define	ST_CTL_TIME	(30 * 1000)		/* 30 seconds */
590a63f01fSbouyer #define	ST_SPC_TIME	(4 * 60 * 60 * 1000)	/* 4 hours */
600a63f01fSbouyer 
610a63f01fSbouyer #define	ST_RETRIES	4	/* only on non IO commands */
620a63f01fSbouyer 
6327155d9aSbouyer struct modes {
64f323bc53Sreinoud 	u_int quirks;			/* same definitions as in quirkdata */
6527155d9aSbouyer 	int blksize;
668b3a5fe4Smbalmer 	uint8_t density;
6727155d9aSbouyer };
6827155d9aSbouyer 
6927155d9aSbouyer struct quirkdata {
70f323bc53Sreinoud 	u_int quirks;
7127155d9aSbouyer #define	ST_Q_FORCE_BLKSIZE	0x0001
7227155d9aSbouyer #define	ST_Q_SENSE_HELP		0x0002	/* must do READ for good MODE SENSE */
7327155d9aSbouyer #define	ST_Q_IGNORE_LOADS	0x0004
7427155d9aSbouyer #define	ST_Q_BLKSIZE		0x0008	/* variable-block media_blksize > 0 */
7527155d9aSbouyer #define	ST_Q_UNIMODAL		0x0010	/* unimode drive rejects mode select */
7627155d9aSbouyer #define	ST_Q_NOPREVENT		0x0020	/* does not support PREVENT */
7727155d9aSbouyer #define	ST_Q_ERASE_NOIMM	0x0040	/* drive rejects ERASE/w Immed bit */
78e6922f82Sbouyer #define	ST_Q_NOFILEMARKS	0x0080	/* can only write 0 filemarks */
79f323bc53Sreinoud 	u_int page_0_size;
8027155d9aSbouyer #define	MAX_PAGE_0_SIZE	64
8127155d9aSbouyer 	struct modes modes[4];
8227155d9aSbouyer };
8327155d9aSbouyer 
8427155d9aSbouyer struct st_quirk_inquiry_pattern {
8527155d9aSbouyer 	struct scsipi_inquiry_pattern pattern;
8627155d9aSbouyer 	struct quirkdata quirkdata;
8727155d9aSbouyer };
8827155d9aSbouyer 
8927155d9aSbouyer struct st_softc {
908b3a5fe4Smbalmer 	device_t sc_dev;
910a63f01fSbouyer /*--------------------callback to bus-specific code--------------------------*/
923a4c3c08Sthorpej 	int (*ops)(struct st_softc *, int, int);
930a63f01fSbouyer #define ST_OPS_RBL		0x00	/* read block limit */
940a63f01fSbouyer #define ST_OPS_MODESENSE	0x01	/* mode sense */
950a63f01fSbouyer #define ST_OPS_MODESELECT	0x02	/* mode select */
960a63f01fSbouyer #define ST_OPS_CMPRSS_ON 	0x03	/* turn on compression */
970a63f01fSbouyer #define ST_OPS_CMPRSS_OFF 	0x04	/* turn off compression */
9827155d9aSbouyer /*--------------------present operating parameters, flags etc.---------------*/
9927155d9aSbouyer 	int flags;		/* see below                         */
100f323bc53Sreinoud 	u_int quirks;		/* quirks for the open mode          */
10127155d9aSbouyer 	int blksize;		/* blksize we are using              */
1028b3a5fe4Smbalmer 	uint8_t density;	/* present density                   */
103f323bc53Sreinoud 	u_int page_0_size;	/* size of page 0 data		     */
104f323bc53Sreinoud 	u_int last_dsty;	/* last density opened               */
105f323bc53Sreinoud 	short mt_resid;		/* last (short) resid                */
106f323bc53Sreinoud 	short mt_erreg;		/* last error (sense key) seen       */
107e5160e81Schristos 	/* relative to BOT location */
108e5160e81Schristos 	daddr_t fileno;
109e5160e81Schristos 	daddr_t blkno;
110e5160e81Schristos 	int32_t last_io_resid;
111e5160e81Schristos 	int32_t last_ctl_resid;
11227155d9aSbouyer #define	mt_key	mt_erreg
1138b3a5fe4Smbalmer 	uint8_t asc;		/* last asc code seen		     */
1148b3a5fe4Smbalmer 	uint8_t ascq;		/* last asc code seen		     */
11527155d9aSbouyer /*--------------------device/scsi parameters---------------------------------*/
11627155d9aSbouyer 	struct scsipi_periph *sc_periph;/* our link to the adpter etc.       */
11727155d9aSbouyer /*--------------------parameters reported by the device ---------------------*/
11827155d9aSbouyer 	int blkmin;		/* min blk size                       */
11927155d9aSbouyer 	int blkmax;		/* max blk size                       */
1203acb3fe6Schristos 	const struct quirkdata *quirkdata;	/* if we have a rogue entry  */
12127155d9aSbouyer /*--------------------parameters reported by the device for this media-------*/
122f323bc53Sreinoud 	u_long numblks;		/* nominal blocks capacity            */
12327155d9aSbouyer 	int media_blksize;	/* 0 if not ST_FIXEDBLOCKS            */
1248b3a5fe4Smbalmer 	uint8_t media_density;	/* this is what it said when asked    */
12527155d9aSbouyer /*--------------------quirks for the whole drive-----------------------------*/
126f323bc53Sreinoud 	u_int drive_quirks;	/* quirks of this drive               */
12727155d9aSbouyer /*--------------------How we should set up when opening each minor device----*/
12827155d9aSbouyer 	struct modes modes[4];	/* plus more for each mode            */
1298b3a5fe4Smbalmer 	uint8_t  modeflags[4];	/* flags for the modes                */
13027155d9aSbouyer #define DENSITY_SET_BY_USER	0x01
13127155d9aSbouyer #define DENSITY_SET_BY_QUIRK	0x02
13227155d9aSbouyer #define BLKSIZE_SET_BY_USER	0x04
13327155d9aSbouyer #define BLKSIZE_SET_BY_QUIRK	0x08
13427155d9aSbouyer /*--------------------storage for sense data returned by the drive-----------*/
135f323bc53Sreinoud 	u_char sense_data[MAX_PAGE_0_SIZE];	/*
13627155d9aSbouyer 						 * additional sense data needed
13727155d9aSbouyer 						 * for mode sense/select.
13827155d9aSbouyer 						 */
139aec75b1cSyamt 	struct bufq_state *buf_queue;	/* the queue of pending IO */
14027155d9aSbouyer 					/* operations */
141*76e339c2Smlelstv 	struct bufq_state *buf_defer;	/* the queue of deferred IO */
142*76e339c2Smlelstv 					/* operations */
14380620a83Sbouyer 	struct callout sc_callout;	/* restarting the queue after */
14480620a83Sbouyer 					/* transient error */
1451742ba77Sblymn 
1463c0adb7dSblymn 	struct io_stats *stats;		/* statistics for the drive */
1471742ba77Sblymn 
1483afd44cfStls 	krndsource_t	rnd_source;
149*76e339c2Smlelstv 	kmutex_t	sc_iolock;
15027155d9aSbouyer };
15127155d9aSbouyer 
1520a63f01fSbouyer #define	ST_INFO_VALID	0x0001
1530a63f01fSbouyer #define	ST_BLOCK_SET	0x0002	/* block size, mode set by ioctl      */
1540a63f01fSbouyer #define	ST_WRITTEN	0x0004	/* data has been written, EOD needed */
1550a63f01fSbouyer #define	ST_FIXEDBLOCKS	0x0008
1560a63f01fSbouyer #define	ST_AT_FILEMARK	0x0010
1570a63f01fSbouyer #define	ST_EIO_PENDING	0x0020	/* error reporting deferred until next op */
1580a63f01fSbouyer #define	ST_NEW_MOUNT	0x0040	/* still need to decide mode             */
1590a63f01fSbouyer #define	ST_READONLY	0x0080	/* st_mode_sense says write protected */
1600a63f01fSbouyer #define	ST_FM_WRITTEN	0x0100	/*
1610a63f01fSbouyer 				 * EOF file mark written  -- used with
1620a63f01fSbouyer 				 * ~ST_WRITTEN to indicate that multiple file
1630a63f01fSbouyer 				 * marks have been written
1640a63f01fSbouyer 				 */
1650a63f01fSbouyer #define	ST_BLANK_READ	0x0200	/* BLANK CHECK encountered already */
1660a63f01fSbouyer #define	ST_2FM_AT_EOD	0x0400	/* write 2 file marks at EOD */
1670a63f01fSbouyer #define	ST_MOUNTED	0x0800	/* Device is presently mounted */
1680a63f01fSbouyer #define	ST_DONTBUFFER	0x1000	/* Disable buffering/caching */
1690a63f01fSbouyer #define	ST_EARLYWARN	0x2000	/* Do (deferred) EOM for variable mode */
1700a63f01fSbouyer #define	ST_EOM_PENDING	0x4000	/* EOM reporting deferred until next op */
171e5160e81Schristos #define	ST_POSUPDATED	0x8000	/* tape position already updated */
17227155d9aSbouyer 
1730a63f01fSbouyer #define	ST_PER_ACTION	(ST_AT_FILEMARK | ST_EIO_PENDING | ST_EOM_PENDING | \
1740a63f01fSbouyer 			 ST_BLANK_READ)
1750a63f01fSbouyer #define	ST_PER_MOUNT	(ST_INFO_VALID | ST_BLOCK_SET | ST_WRITTEN |	\
1760a63f01fSbouyer 			 ST_FIXEDBLOCKS | ST_READONLY | ST_FM_WRITTEN |	\
177e5160e81Schristos 			 ST_2FM_AT_EOD | ST_PER_ACTION | ST_POSUPDATED)
1780a63f01fSbouyer 
1798b3a5fe4Smbalmer void	stattach(device_t, device_t, void *);
1807cf29912Scegger int	stdetach(device_t, int);
181345b8f10Spgoyette int	st_mode_select(struct st_softc *, int);
18227155d9aSbouyer 
18327155d9aSbouyer extern struct cfdriver st_cd;
184