xref: /netbsd/sys/dev/scsipi/sdvar.h (revision c4a72b64)
1 /*	$NetBSD: sdvar.h,v 1.17 2002/07/16 18:03:18 hannken Exp $	*/
2 
3 /*-
4  * Copyright (c) 1998 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Charles M. Hannum.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *        This product includes software developed by the NetBSD
21  *        Foundation, Inc. and its contributors.
22  * 4. Neither the name of The NetBSD Foundation nor the names of its
23  *    contributors may be used to endorse or promote products derived
24  *    from this software without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36  * POSSIBILITY OF SUCH DAMAGE.
37  */
38 
39 /*
40  * Originally written by Julian Elischer (julian@dialix.oz.au)
41  * for TRW Financial Systems for use under the MACH(2.5) operating system.
42  *
43  * TRW Financial Systems, in accordance with their agreement with Carnegie
44  * Mellon University, makes this software available to CMU to distribute
45  * or use in any manner that they see fit as long as this message is kept with
46  * the software. For this reason TFS also grants any other persons or
47  * organisations permission to use or modify this software.
48  *
49  * TFS supplies this software to be publicly redistributed
50  * on the understanding that TFS is not responsible for the correct
51  * functioning of this software in any circumstances.
52  *
53  * Ported to run under 386BSD by Julian Elischer (julian@dialix.oz.au) Sept 1992
54  */
55 
56 #include "opt_scsi.h"
57 #include "rnd.h"
58 #if NRND > 0
59 #include <sys/rnd.h>
60 #endif
61 
62 #ifndef	SDRETRIES
63 #define	SDRETRIES	4
64 #endif
65 
66 #ifndef	SD_IO_TIMEOUT
67 #define	SD_IO_TIMEOUT	(60 * 1000)
68 #endif
69 
70 struct sd_ops;
71 
72 struct sd_softc {
73 	struct device sc_dev;
74 	struct disk sc_dk;
75 
76 	int flags;
77 #define	SDF_LOCKED	0x01
78 #define	SDF_WANTED	0x02
79 #define	SDF_WLABEL	0x04		/* label is writable */
80 #define	SDF_LABELLING	0x08		/* writing label */
81 #define	SDF_ANCIENT	0x10		/* disk is ancient; for minphys */
82 #define	SDF_DIRTY	0x20		/* disk is dirty; needs cache flush */
83 #define	SDF_FLUSHING	0x40		/* flushing, for sddone() */
84 
85 	struct scsipi_periph *sc_periph;/* contains our targ, lun, etc. */
86 
87 	struct disk_parms {
88 		u_long	heads;		/* number of heads */
89 		u_long	cyls;		/* number of cylinders */
90 		u_long	sectors;	/* number of sectors/track */
91 		u_long	blksize;	/* number of bytes/sector */
92 		u_long	disksize;	/* total number sectors */
93 		u_long	rot_rate;	/* rotational rate, in RPM */
94 	} params;
95 
96 	struct bufq_state buf_queue;
97 	u_int8_t type;
98 	char name[16]; /* product name, for default disklabel */
99 	const struct sd_ops *sc_ops;	/* our bus-dependent ops vector */
100 
101 	void *sc_sdhook;		/* our shutdown hook */
102 
103 #if NRND > 0
104 	rndsource_element_t rnd_source;
105 #endif
106 };
107 
108 struct sd_ops {
109 	int	(*sdo_get_parms) __P((struct sd_softc *, struct disk_parms *,
110 		    int));
111 	int	(*sdo_flush) __P((struct sd_softc *, int));
112 	int	(*sdo_getcache) __P((struct sd_softc *, int *));
113 	int	(*sdo_setcache) __P((struct sd_softc *, int));
114 };
115 #define	SDGP_RESULT_OK		0	/* paramters obtained */
116 #define	SDGP_RESULT_OFFLINE	1	/* no media, or otherwise losing */
117 #define	SDGP_RESULT_UNFORMATTED	2	/* unformatted media (max params) */
118 
119 void sdattach __P((struct device *, struct sd_softc *, struct scsipi_periph *,
120     const struct sd_ops *));
121 int sdactivate __P((struct device *, enum devact));
122 int sddetach __P((struct device *, int));
123