xref: /netbsd-src/sys/arch/sun3/dev/xdvar.h (revision dc306354b0b29af51801a7632f1e95265a68cd81)
1 /*	$NetBSD: xdvar.h,v 1.5 1998/01/26 21:03:43 gwr 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 d v a r . h
36  *
37  * this file defines the software structure we use to control the
38  * 753/7053.
39  *
40  * author: Chuck Cranor <chuck@ccrc.wustl.edu>
41  */
42 
43 /*
44  * i/o request: wrapper for hardware's iopb data structure
45  */
46 
47 struct xd_iorq {
48   struct xd_iopb *iopb;             /* address of matching iopb */
49   struct xdc_softc *xdc;            /* who we are working with */
50   struct xd_softc *xd;              /* which disk */
51   int ttl;                          /* time to live */
52   int mode;                         /* current mode (state+other data) */
53   int tries;                        /* number of times we have tried it */
54   int errno;                        /* error number if we fail */
55   int lasterror;		    /* last error we got */
56   int blockno;                      /* starting block no for this xfer */
57   int sectcnt;                      /* number of sectors in xfer */
58   char *dbuf;                       /* KVA of data buffer (advances) */
59   char *dbufbase;                   /* base of dbuf */
60   struct buf *buf;                  /* for NORM */
61 };
62 
63 /*
64  * state
65  */
66 
67 #define XD_SUB_MASK 0xf0            /* mask bits for state */
68 #define XD_SUB_FREE 0x00            /* free */
69 #define XD_SUB_NORM 0x10            /* normal I/O request */
70 #define XD_SUB_WAIT 0x20            /* normal I/O request in the
71                                              context of a process */
72 #define XD_SUB_POLL 0x30            /* polled mode */
73 #define XD_SUB_DONE 0x40            /* not active, but can't be free'd yet */
74 #define XD_SUB_NOQ  0x50            /* don't queue, just submit (internal) */
75 
76 #define XD_STATE(X) ((X) & XD_SUB_MASK) /* extract state from mode */
77 #define XD_NEWSTATE(OLD, NEW) (((OLD) & ~XD_SUB_MASK) |(NEW)) /* new state */
78 
79 
80 /*
81  * other mode data
82  */
83 
84 #define XD_MODE_VERBO 0x08          /* print error messages */
85 #define XD_MODE_B144  0x04          /* handling a bad144 sector */
86 
87 
88 /*
89  * software timers and flags
90  */
91 
92 #define XDC_SUBWAITLIM 4   /* max number of "done" IOPBs there can be
93 				where we still allow a SUB_WAIT command */
94 #define XDC_TICKCNT (5*hz) /* call xdc_tick on this interval (5 sec) */
95 #define XDC_MAXTTL     2   /* max number of xd ticks to live */
96 #define XDC_NOUNIT (-1)    /* for xdcmd: no unit number */
97 
98 /*
99  * a "xd_softc" structure contains per-disk state info.
100  */
101 
102 struct xd_softc {
103   struct device sc_dev;            /* device struct, reqd by autoconf */
104   struct disk sc_dk;               /* generic disk info */
105   struct xdc_softc *parent;        /* parent */
106   u_short flags;                   /* flags */
107   u_short state;                   /* device state */
108   int xd_drive;                    /* unit number */
109   /* geometry */
110   u_short ncyl, acyl, pcyl;        /* number of cyl's */
111   u_short sectpercyl;              /* nhead*nsect */
112   u_char nhead;                    /* number of heads */
113   u_char nsect;                    /* number of sectors per track */
114   u_char hw_spt;                   /* as above, but includes spare sectors */
115   struct dkbad dkb;                /* bad144 sectors */
116 };
117 
118 /*
119  * flags
120  */
121 
122 #define XD_WLABEL 0x0001           /* write label */
123 /*
124  * state
125  */
126 
127 #define XD_DRIVE_UNKNOWN 0         /* never talked to it */
128 #define XD_DRIVE_ATTACHING 1       /* attach in progress */
129 #define XD_DRIVE_NOLABEL 2         /* drive on-line, no label */
130 #define XD_DRIVE_ONLINE  3         /* drive is on-line */
131 
132 /*
133  * a "xdc_softc" structure contains per-disk-controller state info,
134  * including a list of active controllers.
135  */
136 
137 struct xdc_softc {
138   struct device sc_dev;            /* device struct, reqd by autoconf */
139   struct evcnt sc_intrcnt;         /* event counter (for vmstat -i) */
140 
141   struct xdc *xdc;                 /* vaddr of vme registers */
142 
143   int bustype;                     /* from attach args */
144   int ipl;                         /* interrupt level */
145   int vector;                      /* interrupt vector */
146 
147   struct xd_softc *sc_drives[XDC_MAXDEV];   /* drives on this controller */
148 
149   struct xd_iorq *reqs;            /* i/o requests */
150   struct xd_iopb *iopbase;         /* iopb base addr (maps iopb->iorq) */
151   struct xd_iopb *dvmaiopb;        /* iopb base in DVMA space, not kvm */
152   struct buf sc_wq;                /* queue'd IOPBs for this controller */
153   char freereq[XDC_MAXIOPB];       /* free list (stack) */
154   char waitq[XDC_MAXIOPB];         /* wait queue */
155   u_char nfree;                    /* number of iopbs free */
156   u_char nrun;                     /* number running */
157   u_char nwait;                    /* number of waiting iopbs */
158   u_char ndone;                    /* number of done IORQs */
159   u_char waithead;                 /* head of queue */
160   u_char waitend;                  /* end of queue */
161 };
162 
163 /*
164  * reset blast modes
165  */
166 
167 #define XD_RSET_NONE (-1)          /* restart all requests */
168 #define XD_RSET_ALL  (-2)          /* don't restart anything */
169