xref: /original-bsd/sys/vax/uba/ubavar.h (revision d0e3910b)
1 /*
2  * Copyright (c) 1982, 1986 Regents of the University of California.
3  * All rights reserved.  The Berkeley software License Agreement
4  * specifies the terms and conditions for redistribution.
5  *
6  *	@(#)ubavar.h	7.3 (Berkeley) 10/23/87
7  */
8 
9 /*
10  * This file contains definitions related to the kernel structures
11  * for dealing with the unibus adapters.
12  *
13  * Each uba has a uba_hd structure.
14  * Each unibus controller which is not a device has a uba_ctlr structure.
15  * Each unibus device has a uba_device structure.
16  */
17 
18 #ifndef LOCORE
19 /*
20  * Per-uba structure.
21  *
22  * This structure holds the interrupt vector for the uba,
23  * and its address in physical and virtual space.  At boot time
24  * we determine the devices attached to the uba's and their
25  * interrupt vectors, filling in uh_vec.  We free the map
26  * register and bdp resources of the uba into the structures
27  * defined here.
28  *
29  * During normal operation, resources are allocated and returned
30  * to the structures here.  We watch the number of passive releases
31  * on each uba, and if the number is excessive may reset the uba.
32  *
33  * When uba resources are needed and not available, or if a device
34  * which can tolerate no other uba activity (rk07) gets on the bus,
35  * then device drivers may have to wait to get to the bus and are
36  * queued here.  It is also possible for processes to block in
37  * the unibus driver in resource wait (mrwant, bdpwant); these
38  * wait states are also recorded here.
39  */
40 struct	uba_hd {
41 	int	uh_type;		/* type of adaptor */
42 	struct	uba_regs *uh_uba;	/* virt addr of uba adaptor regs */
43 	struct	uba_regs *uh_physuba;	/* phys addr of uba adaptor regs */
44 	struct	pte *uh_mr;		/* start of page map */
45 	int	uh_memsize;		/* size of uba memory, pages */
46 	caddr_t	uh_mem;			/* start of uba memory address space */
47 	caddr_t	uh_iopage;		/* start of uba io page */
48 	int	(**uh_vec)();		/* interrupt vector */
49 	struct	uba_device *uh_actf;	/* head of queue to transfer */
50 	struct	uba_device *uh_actl;	/* tail of queue to transfer */
51 	short	uh_mrwant;		/* someone is waiting for map reg */
52 	short	uh_bdpwant;		/* someone awaits bdp's */
53 	int	uh_bdpfree;		/* free bdp's */
54 	int	uh_hangcnt;		/* number of ticks hung */
55 	int	uh_zvcnt;		/* number of recent 0 vectors */
56 	long	uh_zvtime;		/* time over which zvcnt accumulated */
57 	int	uh_zvtotal;		/* total number of 0 vectors */
58 	int	uh_errcnt;		/* number of errors */
59 	int	uh_lastiv;		/* last free interrupt vector */
60 	short	uh_users;		/* transient bdp use count */
61 	short	uh_xclu;		/* an rk07 is using this uba! */
62 	int	uh_lastmem;		/* limit of any unibus memory */
63 #define	UAMSIZ	100
64 	struct	map *uh_map;		/* buffered data path regs free */
65 };
66 
67 /*
68  * Per-controller structure.
69  * (E.g. one for each disk and tape controller, and other things
70  * which use and release buffered data paths.)
71  *
72  * If a controller has devices attached, then there are
73  * cross-referenced uba_drive structures.
74  * This structure is the one which is queued in unibus resource wait,
75  * and saves the information about unibus resources which are used.
76  * The queue of devices waiting to transfer is also attached here.
77  */
78 struct uba_ctlr {
79 	struct	uba_driver *um_driver;
80 	short	um_ctlr;	/* controller index in driver */
81 	short	um_ubanum;	/* the uba it is on */
82 	short	um_alive;	/* controller exists */
83 	int	(**um_intr)();	/* interrupt handler(s) */
84 	caddr_t	um_addr;	/* address of device in i/o space */
85 	struct	uba_hd *um_hd;
86 /* the driver saves the prototype command here for use in its go routine */
87 	int	um_cmd;		/* communication to dgo() */
88 	int	um_ubinfo;	/* save unibus registers, etc */
89 	int	um_bdp;		/* for controllers that hang on to bdp's */
90 	struct	buf um_tab;	/* queue of devices for this controller */
91 };
92 
93 /*
94  * Per ``device'' structure.
95  * (A controller has devices or uses and releases buffered data paths).
96  * (Everything else is a ``device''.)
97  *
98  * If a controller has many drives attached, then there will
99  * be several uba_device structures associated with a single uba_ctlr
100  * structure.
101  *
102  * This structure contains all the information necessary to run
103  * a unibus device such as a dz or a dh.  It also contains information
104  * for slaves of unibus controllers as to which device on the slave
105  * this is.  A flags field here can also be given in the system specification
106  * and is used to tell which dz lines are hard wired or other device
107  * specific parameters.
108  */
109 struct uba_device {
110 	struct	uba_driver *ui_driver;
111 	short	ui_unit;	/* unit number on the system */
112 	short	ui_ctlr;	/* mass ctlr number; -1 if none */
113 	short	ui_ubanum;	/* the uba it is on */
114 	short	ui_slave;	/* slave on controller */
115 	int	(**ui_intr)();	/* interrupt handler(s) */
116 	caddr_t	ui_addr;	/* address of device in i/o space */
117 	short	ui_dk;		/* if init 1 set to number for iostat */
118 	int	ui_flags;	/* parameter from system specification */
119 	short	ui_alive;	/* device exists */
120 	short	ui_type;	/* driver specific type information */
121 	caddr_t	ui_physaddr;	/* phys addr, for standalone (dump) code */
122 /* this is the forward link in a list of devices on a controller */
123 	struct	uba_device *ui_forw;
124 /* if the device is connected to a controller, this is the controller */
125 	struct	uba_ctlr *ui_mi;
126 	struct	uba_hd *ui_hd;
127 };
128 
129 /*
130  * Per-driver structure.
131  *
132  * Each unibus driver defines entries for a set of routines
133  * as well as an array of types which are acceptable to it.
134  * These are used at boot time by the configuration program.
135  */
136 struct uba_driver {
137 	int	(*ud_probe)();		/* see if a driver is really there */
138 	int	(*ud_slave)();		/* see if a slave is there */
139 	int	(*ud_attach)();		/* setup driver for a slave */
140 	int	(*ud_dgo)();		/* fill csr/ba to start transfer */
141 	u_short	*ud_addr;		/* device csr addresses */
142 	char	*ud_dname;		/* name of a device */
143 	struct	uba_device **ud_dinfo;	/* backpointers to ubdinit structs */
144 	char	*ud_mname;		/* name of a controller */
145 	struct	uba_ctlr **ud_minfo;	/* backpointers to ubminit structs */
146 	short	ud_xclu;		/* want exclusive use of bdp's */
147 	short	ud_keepbdp;		/* hang on to bdp's once allocated */
148 	int	(*ud_ubamem)();		/* see if dedicated memory is present */
149 };
150 #endif
151 
152 /*
153  * Flags to UBA map/bdp allocation routines
154  */
155 #define	UBA_NEEDBDP	0x01		/* transfer needs a bdp */
156 #define	UBA_CANTWAIT	0x02		/* don't block me */
157 #define	UBA_NEED16	0x04		/* need 16 bit addresses only */
158 #define	UBA_HAVEBDP	0x08		/* use bdp specified in high bits */
159 
160 /*
161  * Macros to bust return word from map allocation routines.
162  */
163 #define	UBAI_BDP(i)	((int)(((unsigned)(i))>>28))
164 #define	UBAI_NMR(i)	((int)((i)>>18)&0x3ff)
165 #define	UBAI_MR(i)	((int)((i)>>9)&0x1ff)
166 #define	UBAI_BOFF(i)	((int)((i)&0x1ff))
167 #define	UBAI_ADDR(i)	((int)((i)&0x3ffff))	/* uba addr (boff+mr) */
168 
169 #ifndef LOCORE
170 #ifdef KERNEL
171 #define	ubago(ui)	ubaqueue(ui, 0)
172 
173 /*
174  * UBA related kernel variables
175  */
176 int	numuba;					/* number of uba's */
177 struct	uba_hd uba_hd[];
178 
179 /*
180  * Ubminit and ubdinit initialize the mass storage controller and
181  * device tables specifying possible devices.
182  */
183 extern	struct	uba_ctlr ubminit[];
184 extern	struct	uba_device ubdinit[];
185 
186 /*
187  * UNIbus device address space is mapped by UMEMmap
188  * into virtual address umem[][].
189  * The IO page is mapped to the last 8K of each.
190  * This should be enlarged for the Q22 bus.
191  */
192 extern	struct pte UMEMmap[][512];	/* uba device addr pte's */
193 extern	char umem[][512*NBPG];		/* uba device addr space */
194 
195 /*
196  * Since some VAXen vector their unibus interrupts
197  * just adjacent to the system control block, we must
198  * allocate space there when running on ``any'' cpu.  This space is
199  * used for the vectors for uba0 and uba1 on all cpu's but 8600's.
200  */
201 extern	int (*UNIvec[])();			/* unibus vec for uba0 */
202 #if NUBA > 1
203 extern	int (*UNI1vec[])();			/* unibus vec for uba1 */
204 #endif
205 
206 #if defined(VAX780) || defined(VAX8600)
207 /*
208  * On DW780's, we must set the scb vectors for the nexus of the
209  * UNIbus adaptors to vector to locore unibus adaptor interrupt dispatchers
210  * which make 780's look like the other VAXen.
211  */
212 extern	Xua0int(), Xua1int(), Xua2int(), Xua3int();
213 #endif VAX780
214 #endif KERNEL
215 #endif !LOCORE
216