xyvar.h revision 1.2 
1/*	$NetBSD: xyvar.h,v 1.2 1997/12/01 23:25:37 pk 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/*
44 * i/o request: wrapper for hardware's iopb data structure
45 */
46
47struct xy_iorq {
48  struct xy_iopb *iopb;             /* address of matching iopb */
49  struct xyc_softc *xyc;            /* who we are working with */
50  struct xy_softc *xy;              /* 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  struct buf *buf;                  /* for NORM */
60  bus_dmamap_t dmamap;		    /* DMA I/O handle */
61};
62
63/*
64 * state
65 */
66
67#define XY_SUB_MASK 0xf0            /* mask bits for state */
68#define XY_SUB_FREE 0x00            /* free */
69#define XY_SUB_NORM 0x10            /* normal I/O request */
70#define XY_SUB_WAIT 0x20            /* normal I/O request in the
71                                             context of a process */
72#define XY_SUB_POLL 0x30            /* polled mode */
73#define XY_SUB_DONE 0x40            /* not active, but can't be free'd yet */
74#define XY_SUB_NOQ  0x50            /* don't queue, just submit (internal) */
75
76#define XY_STATE(X) ((X) & XY_SUB_MASK) /* extract state from mode */
77#define XY_NEWSTATE(OLD, NEW) (((OLD) & ~XY_SUB_MASK) |(NEW)) /* new state */
78
79
80/*
81 * other mode data
82 */
83
84#define XY_MODE_VERBO 0x08          /* print error messages */
85#define XY_MODE_B144  0x04          /* handling a bad144 sector */
86
87
88/*
89 * software timers and flags
90 */
91
92#define XYC_SUBWAITLIM 4   /* max number of "done" IOPBs there can be
93				where we still allow a SUB_WAIT command */
94#define XYC_TICKCNT (5*hz) /* call xyc_tick on this interval (5 sec) */
95#define XYC_MAXTTL     2   /* max number of xy ticks to live */
96#define XYC_NOUNIT (-1)    /* for xycmd: no unit number */
97
98/*
99 * a "xy_softc" structure contains per-disk state info.
100 */
101
102struct xy_softc {
103  struct device sc_dev;            /* device struct, reqd by autoconf */
104  struct disk sc_dk;               /* generic disk info */
105  struct xyc_softc *parent;        /* parent */
106  u_short flags;                   /* flags */
107  u_short state;                   /* device state */
108  int xy_drive;                    /* unit number */
109  int drive_type;		   /* drive type (as per disk) */
110  /* geometry */
111  u_short ncyl, acyl, pcyl;        /* number of cyl's */
112  u_short sectpercyl;              /* nhead*nsect */
113  u_char nhead;                    /* number of heads */
114  u_char nsect;                    /* number of sectors per track */
115  u_char hw_spt;                   /* as above, but includes spare sectors */
116  struct xy_iorq *xyrq;		   /* this disk's ioreq structure */
117  struct buf xyq;		   /* queue'd I/O requests */
118  struct dkbad dkb;                /* bad144 sectors */
119};
120
121/*
122 * flags
123 */
124
125#define XY_WLABEL 0x0001           /* write label */
126/*
127 * state
128 */
129
130#define XY_DRIVE_UNKNOWN 0         /* never talked to it */
131#define XY_DRIVE_ATTACHING 1       /* attach in progress */
132#define XY_DRIVE_NOLABEL 2         /* drive on-line, no label */
133#define XY_DRIVE_ONLINE  3         /* drive is on-line */
134
135/*
136 * a "xyc_softc" structure contains per-disk-controller state info,
137 * including a list of active controllers.
138 */
139
140struct xyc_softc {
141	struct device sc_dev;            /* device struct, reqd by autoconf */
142	struct intrhand sc_ih;           /* interrupt info */
143	struct evcnt sc_intrcnt;         /* event counter (for vmstat -i) */
144
145	struct xyc *xyc;                 /* vaddr of vme registers */
146
147	struct xy_softc *sc_drives[XYC_MAXDEV]; /* drives on this controller */
148	int ipl;                         /* interrupt level */
149	int vector;                      /* interrupt vector */
150	bus_dma_tag_t dmatag;	 	 /* Bus DMA tag */
151
152	struct xy_iorq *reqs;            /* i/o requests */
153	struct xy_iopb *iopbase;         /* iopb base addr (maps iopb->iorq) */
154	struct xy_iopb *dvmaiopb;        /* iopb base in DVMA space, not kvm */
155
156	struct xy_iorq *ciorq;		 /* controller's iorq */
157	struct xy_iopb *ciopb;		 /* controller's iopb */
158
159	int xy_hand;			 /* hand */
160	struct xy_iorq *xy_chain[XYC_MAXIOPB];
161				   /* current chain */
162	int no_ols;		   /* disable overlap seek for stupid 450s */
163};
164
165/*
166 * reset blast modes
167 */
168
169#define XY_RSET_NONE (struct xy_iorq *)(-1)   /* restart all requests */
170#define XY_RSET_ALL  (struct xy_iorq *)(-2)   /* don't restart anything */
171