xref: /netbsd-src/sys/arch/sun3/dev/xyvar.h (revision 274254cdae52594c1aa480a736aef78313d15c9c)
1 /* $NetBSD: xyvar.h,v 1.10 2008/06/28 12:13:38 tsutsui Exp $ */
2 
3 /*
4  *
5  * Copyright (c) 1995 Charles D. Cranor
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. All advertising materials mentioning features or use of this software
17  *    must display the following acknowledgement:
18  *      This product includes software developed by Charles D. Cranor.
19  * 4. The name of the author may not be used to endorse or promote products
20  *    derived from this software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
23  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
24  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
25  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
27  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
31  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33 
34 /*
35  * x y v a r . h
36  *
37  * this file defines the software structure we use to control the
38  * 450/451.
39  *
40  * author: Chuck Cranor <chuck@ccrc.wustl.edu>
41  */
42 
43 #include <sys/callout.h>
44 
45 /*
46  * i/o request: wrapper for hardware's iopb data structure
47  */
48 
49 struct xy_iorq {
50 	struct xy_iopb *iopb;		/* address of matching iopb */
51 	struct xyc_softc *xyc;		/* who we are working with */
52 	struct xy_softc *xy;		/* which disk */
53 	int ttl;			/* time to live */
54 	int mode;			/* current mode (state+other data) */
55 	int tries;			/* number of times we have tried it */
56 	int errno;			/* error number if we fail */
57 	int lasterror;			/* last error we got */
58 	int blockno;			/* starting block no for this xfer */
59 	int sectcnt;			/* number of sectors in xfer */
60 	char *dbuf;			/* KVA of data buffer (advances) */
61 	char *dbufbase;			/* base of dbuf */
62 	struct buf *buf;		/* for NORM */
63 };
64 
65 /*
66  * state
67  */
68 
69 #define XY_SUB_MASK	0xf0	/* mask bits for state */
70 #define XY_SUB_FREE	0x00	/* free */
71 #define XY_SUB_NORM	0x10	/* normal I/O request */
72 #define XY_SUB_WAIT	0x20	/* normal I/O request in the
73 				   context of a process */
74 #define XY_SUB_POLL	0x30	/* polled mode */
75 #define XY_SUB_DONE	0x40	/* not active, but can't be free'd yet */
76 #define XY_SUB_NOQ	0x50	/* don't queue, just submit (internal) */
77 
78 #define XY_STATE(X) ((X) & XY_SUB_MASK) /* extract state from mode */
79 #define XY_NEWSTATE(OLD, NEW) (((OLD) & ~XY_SUB_MASK) |(NEW)) /* new state */
80 
81 
82 /*
83  * other mode data
84  */
85 
86 #define XY_MODE_VERBO	0x08	/* print error messages */
87 #define XY_MODE_B144	0x04	/* handling a bad144 sector */
88 
89 
90 /*
91  * software timers and flags
92  */
93 
94 #define XYC_SUBWAITLIM	4	/* max number of "done" IOPBs there can be
95 				   where we still allow a SUB_WAIT command */
96 #define XYC_TICKCNT	(5*hz)	/* call xyc_tick on this interval (5 sec) */
97 #define XYC_MAXTTL	2	/* max number of xy ticks to live */
98 #define XYC_NOUNIT	(-1)	/* for xycmd: no unit number */
99 
100 /*
101  * a "xy_softc" structure contains per-disk state info.
102  */
103 
104 struct xy_softc {
105 	device_t sc_dev;		/* device struct, reqd by autoconf */
106 	struct disk sc_dk;		/* generic disk info */
107 	struct xyc_softc *parent;	/* parent */
108 	u_short flags;			/* flags */
109 	u_short state;			/* device state */
110 	int xy_drive;			/* unit number */
111 	int drive_type;			/* drive type (as per disk) */
112 	/* geometry */
113 	u_short ncyl, acyl, pcyl;	/* number of cyl's */
114 	u_short sectpercyl;		/* nhead*nsect */
115 	u_char nhead;			/* number of heads */
116 	u_char nsect;			/* number of sectors per track */
117 	u_char hw_spt;		      /* as above, but includes spare sectors */
118 	struct xy_iorq *xyrq;		/* this disk's ioreq structure */
119 	struct bufq_state *xyq;		/* queue'd I/O requests */
120 	struct dkbad dkb;		/* bad144 sectors */
121 };
122 
123 /*
124  * flags
125  */
126 
127 #define XY_WLABEL	0x0001	/* write label */
128 /*
129  * state
130  */
131 
132 #define XY_DRIVE_UNKNOWN	0	/* never talked to it */
133 #define XY_DRIVE_ATTACHING	1	/* attach in progress */
134 #define XY_DRIVE_NOLABEL	2	/* drive on-line, no label */
135 #define XY_DRIVE_ONLINE		3	/* drive is on-line */
136 
137 /*
138  * a "xyc_softc" structure contains per-disk-controller state info,
139  * including a list of active controllers.
140  */
141 
142 struct xyc_softc {
143 	device_t sc_dev;		/* device struct, reqd by autoconf */
144 	struct evcnt sc_intrcnt;	/* event counter (for vmstat -i) */
145 
146 	struct callout sc_tick_ch;
147 
148 	struct xyc *xyc;		/* vaddr of vme registers */
149 
150 	int bustype;			/* from attach args */
151 	int ipl;			/* interrupt level */
152 	int vector;			/* interrupt vector */
153 
154 	struct xy_softc *sc_drives[XYC_MAXDEV]; /* drives on this controller */
155 
156 	struct xy_iorq *reqs;		/* i/o requests */
157 	struct xy_iopb *iopbase;	/* iopb base addr (maps iopb->iorq) */
158 	struct xy_iopb *dvmaiopb;	/* iopb base in DVMA space, not kvm */
159 
160 	struct xy_iorq *ciorq;		/* controller's iorq */
161 	struct xy_iopb *ciopb;		/* controller's iopb */
162 
163 	int xy_hand;			/* hand */
164 	struct xy_iorq *xy_chain[XYC_MAXIOPB]; /* current chain */
165 	int no_ols;		      /* disable overlap seek for stupid 450s */
166 };
167 
168 /*
169  * reset blast modes
170  */
171 
172 #define XY_RSET_NONE	(struct xy_iorq *)(-1)	/* restart all requests */
173 #define XY_RSET_ALL	(struct xy_iorq *)(-2)	/* don't restart anything */
174