xref: /netbsd/sys/arch/mac68k/include/z8530var.h (revision bf9ec67e)
1 /*	$NetBSD: z8530var.h,v 1.6 2002/03/17 19:40:44 atatat Exp $	*/
2 
3 /*
4  * Copyright (c) 1994 Gordon W. Ross
5  * Copyright (c) 1992, 1993
6  *	The Regents of the University of California.  All rights reserved.
7  *
8  * This software was developed by the Computer Systems Engineering group
9  * at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and
10  * contributed to Berkeley.
11  *
12  * All advertising materials mentioning features or use of this software
13  * must display the following acknowledgement:
14  *	This product includes software developed by the University of
15  *	California, Lawrence Berkeley Laboratory.
16  *
17  * Redistribution and use in source and binary forms, with or without
18  * modification, are permitted provided that the following conditions
19  * are met:
20  * 1. Redistributions of source code must retain the above copyright
21  *    notice, this list of conditions and the following disclaimer.
22  * 2. Redistributions in binary form must reproduce the above copyright
23  *    notice, this list of conditions and the following disclaimer in the
24  *    documentation and/or other materials provided with the distribution.
25  * 3. All advertising materials mentioning features or use of this software
26  *    must display the following acknowledgement:
27  *	This product includes software developed by the University of
28  *	California, Berkeley and its contributors.
29  * 4. Neither the name of the University nor the names of its contributors
30  *    may be used to endorse or promote products derived from this software
31  *    without specific prior written permission.
32  *
33  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
34  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
35  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
36  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
37  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
38  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
39  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
40  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
41  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
42  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
43  * SUCH DAMAGE.
44  *
45  *	@(#)zsvar.h	8.1 (Berkeley) 6/11/93
46  */
47 
48 #include <dev/ic/z8530sc.h>
49 
50 /*
51  * Clock source info structure, added here so xzs_chanstate works
52  */
53 struct zsclksrc {
54 	long    clk;    /* clock rate, in MHz, present on signal line */
55 	int     flags;  /* Specifies how this source can be used
56 			   (RTxC divided, RTxC BRG, PCLK BRG, TRxC divided)
57 			   and also if the source is "external" and if it
58 			   is changeable (by an ioctl ex.). The
59 			   source usage flags are used by the tty
60 			   child. The other bits tell zsloadchannelregs
61 			   if it should call an md signal source
62 			   changing routine. ZSC_VARIABLE says if
63 			   an ioctl should be able to cahnge the
64 			   clock rate.*/
65 };
66 #define ZSC_PCLK        0x01
67 #define ZSC_RTXBRG      0x02
68 #define ZSC_RTXDIV      0x04
69 #define ZSC_TRXDIV      0x08
70 #define ZSC_VARIABLE    0x40
71 #define ZSC_EXTERN      0x80
72 
73 #define ZSC_BRG         0x03
74 #define ZSC_DIV         0x0c
75 
76 
77 /*
78  * These are the machine-dependent (extended) variants of
79  * struct zs_chanstate and struct zsc_softc
80  */
81 struct xzs_chanstate {
82 	/* machine-independent part (First!)*/
83 	struct zs_chanstate xzs_cs;
84 	/* machine-dependent extensions */
85 	int cs_hwflags;
86 	int	cs_chip;		/* type of chip */
87 	/* Clock source info... */
88 	int	cs_clock_count;		/* how many signal sources available */
89 	struct zsclksrc cs_clocks[4];	/* info on available signal sources */
90 	long	cs_cclk_flag;		/* flag for current clock source */
91 	long	cs_pclk_flag;		/* flag for pending clock source */
92 	int	cs_csource;		/* current source # */
93 	int	cs_psource;		/* pending source # */
94 };
95 
96 struct zsc_softc {
97 	struct	device zsc_dev;		/* required first: base device */
98 	struct	zs_chanstate *zsc_cs[2];	/* channel A and B soft state */
99 	/* Machine-dependent part follows... */
100 	struct xzs_chanstate xzsc_xcs_store[2];
101 };
102 
103 /*
104  * Functions to read and write individual registers in a channel.
105  * The ZS chip requires a 1.6 uSec. recovery time between accesses,
106  * and the Sun3 hardware does NOT take care of this for you.
107  * MacII hardware DOES dake care of the delay for us. :-)
108  * XXX - Then these should be inline functions! -gwr
109  * Some clock-chirped macs loose serial ports. It could be that the
110  * hardware delay is tied to the CPU speed, and that the minimum delay
111  * no longer's respected. For them, ZS_DELAY might help.
112  * XXX - no one seems to want to try and check this -wrs
113  */
114 
115 u_char zs_read_reg __P((struct zs_chanstate *cs, u_char reg));
116 u_char zs_read_csr __P((struct zs_chanstate *cs));
117 u_char zs_read_data __P((struct zs_chanstate *cs));
118 
119 void  zs_write_reg __P((struct zs_chanstate *cs, u_char reg, u_char val));
120 void  zs_write_csr __P((struct zs_chanstate *cs, u_char val));
121 void  zs_write_data __P((struct zs_chanstate *cs, u_char val));
122 
123 /* XXX - Could define splzs() here instead of in psl.h */
124 
125 /* Hook for MD ioctl support */
126 int	zsmdioctl __P((struct zs_chanstate *cs, u_long cmd, caddr_t data));
127 /* XXX - This is a bit gross... */
128 #define ZS_MD_IOCTL(cs, cmd, data) zsmdioctl(cs, cmd, data)
129 
130 /* Callback for "external" clock sources */
131 void zsmd_setclock  __P((struct zs_chanstate *cs));
132 #define ZS_MD_SETCLK(cs) zsmd_setclock(cs)
133 
134 
135