xref: /netbsd-src/sys/arch/sun3/dev/xdvar.h (revision 39094c9da3fcde5a07dc9e7aa34980fc1d75529a)
1 /*	$NetBSD: xdvar.h,v 1.12 2011/02/01 20:19:32 chuck Exp $	*/
2 
3 /*
4  * Copyright (c) 1995 Charles D. Cranor
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 
28 /*
29  * x d v a r . h
30  *
31  * this file defines the software structure we use to control the
32  * 753/7053.
33  *
34  * author: Chuck Cranor <chuck@netbsd>
35  */
36 
37 #include <sys/callout.h>
38 
39 /*
40  * i/o request: wrapper for hardware's iopb data structure
41  */
42 
43 struct xd_iorq {
44 	struct xd_iopb *iopb;	/* address of matching iopb */
45 	struct xdc_softc *xdc;	/* who we are working with */
46 	struct xd_softc *xd;	/* which disk */
47 	int ttl;		/* time to live */
48 	int mode;		/* current mode (state+other data) */
49 	int tries;		/* number of times we have tried it */
50 	int errno;		/* error number if we fail */
51 	int lasterror;		/* last error we got */
52 	int blockno;		/* starting block no for this xfer */
53 	int sectcnt;		/* number of sectors in xfer */
54 	char *dbuf;		/* KVA of data buffer (advances) */
55 	char *dbufbase;		/* base of dbuf */
56 	struct buf *buf;	/* for NORM */
57 };
58 
59 /*
60  * state
61  */
62 
63 #define XD_SUB_MASK 0xf0	/* mask bits for state */
64 #define XD_SUB_FREE 0x00	/* free */
65 #define XD_SUB_NORM 0x10	/* normal I/O request */
66 #define XD_SUB_WAIT 0x20	/* normal I/O request in the
67 				   context of a process */
68 #define XD_SUB_POLL 0x30	/* polled mode */
69 #define XD_SUB_DONE 0x40	/* not active, but can't be free'd yet */
70 #define XD_SUB_NOQ  0x50	/* don't queue, just submit (internal) */
71 
72 #define XD_STATE(X) ((X) & XD_SUB_MASK) /* extract state from mode */
73 #define XD_NEWSTATE(OLD, NEW) (((OLD) & ~XD_SUB_MASK) |(NEW)) /* new state */
74 
75 
76 /*
77  * other mode data
78  */
79 
80 #define XD_MODE_VERBO 0x08	/* print error messages */
81 #define XD_MODE_B144  0x04	/* handling a bad144 sector */
82 
83 
84 /*
85  * software timers and flags
86  */
87 
88 #define XDC_SUBWAITLIM	4	/* max number of "done" IOPBs there can be
89 				   where we still allow a SUB_WAIT command */
90 #define XDC_TICKCNT	(5*hz)	/* call xdc_tick on this interval (5 sec) */
91 #define XDC_MAXTTL	2	/* max number of xd ticks to live */
92 #define XDC_NOUNIT	(-1)	/* for xdcmd: no unit number */
93 
94 /*
95  * a "xd_softc" structure contains per-disk state info.
96  */
97 
98 struct xd_softc {
99 	device_t sc_dev;		/* device struct, reqd by autoconf */
100 	struct disk sc_dk;		/* generic disk info */
101 	struct xdc_softc *parent;	/* parent */
102 	u_short flags;			/* flags */
103 	u_short state;			/* device state */
104 	int xd_drive;			/* unit number */
105 	/* geometry */
106 	u_short ncyl, acyl, pcyl;	/* number of cyl's */
107 	u_short sectpercyl;		/* nhead*nsect */
108 	u_char nhead;			/* number of heads */
109 	u_char nsect;			/* number of sectors per track */
110 	u_char hw_spt;		      /* as above, but includes spare sectors */
111 	struct dkbad dkb;               /* bad144 sectors */
112 };
113 
114 /*
115  * flags
116  */
117 
118 #define XD_WLABEL 0x0001	/* write label */
119 /*
120  * state
121  */
122 
123 #define XD_DRIVE_UNKNOWN	0	/* never talked to it */
124 #define XD_DRIVE_ATTACHING	1	/* attach in progress */
125 #define XD_DRIVE_NOLABEL	2	/* drive on-line, no label */
126 #define XD_DRIVE_ONLINE		3	/* drive is on-line */
127 
128 /*
129  * a "xdc_softc" structure contains per-disk-controller state info,
130  * including a list of active controllers.
131  */
132 
133 struct xdc_softc {
134 	device_t sc_dev;		/* device struct, reqd by autoconf */
135 	struct evcnt sc_intrcnt;	/* event counter (for vmstat -i) */
136 
137 	struct callout sc_tick_ch;
138 
139 	struct xdc *xdc;		/* vaddr of vme registers */
140 
141 	int bustype;			/* from attach args */
142 	int ipl;			/* interrupt level */
143 	int vector;			/* interrupt vector */
144 
145 	struct xd_softc *sc_drives[XDC_MAXDEV]; /* drives on this controller */
146 
147 	struct xd_iorq *reqs;		/* i/o requests */
148 	struct xd_iopb *iopbase;	/* iopb base addr (maps iopb->iorq) */
149 	struct xd_iopb *dvmaiopb;	/* iopb base in DVMA space, not kvm */
150 	struct bufq_state *sc_wq;	/* queue'd IOPBs for this controller */
151 	char freereq[XDC_MAXIOPB];	/* free list (stack) */
152 	char waitq[XDC_MAXIOPB];	/* wait queue */
153 	u_char nfree;			/* number of iopbs free */
154 	u_char nrun;			/* number running */
155 	u_char nwait;			/* number of waiting iopbs */
156 	u_char ndone;			/* number of done IORQs */
157 	u_char waithead;		/* head of queue */
158 	u_char waitend;			/* end of queue */
159 };
160 
161 /*
162  * reset blast modes
163  */
164 
165 #define XD_RSET_NONE	(-1)	/* restart all requests */
166 #define XD_RSET_ALL	(-2)	/* don't restart anything */
167