Home | History | Annotate | Line # | Download | only in ic
z8530sc.h revision 1.18 
      1 /*	$NetBSD: z8530sc.h,v 1.18 2003/01/28 12:35:39 pk 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 
     49 /*
     50  * Function vector - per channel
     51  */
     52 struct zs_chanstate;
     53 struct zsops {
     54 	void	(*zsop_rxint) __P((struct zs_chanstate *));
     55 					/* receive char available */
     56 	void	(*zsop_stint) __P((struct zs_chanstate *, int));
     57 					/* external/status */
     58 	void	(*zsop_txint) __P((struct zs_chanstate *));
     59 					/* xmit buffer empty */
     60 	void	(*zsop_softint) __P((struct zs_chanstate *));
     61 					/* process software interrupt */
     62 };
     63 
     64 extern struct zsops zsops_null;
     65 
     66 
     67 /*
     68  * Software state, per zs channel.
     69  */
     70 struct zs_chanstate {
     71 
     72 	/* Pointers to the device registers. */
     73 	volatile u_char	*cs_reg_csr; 	/* ctrl, status, and reg. number. */
     74 	volatile u_char	*cs_reg_data;	/* data or numbered register */
     75 
     76 	int	cs_channel;		/* sub-unit number */
     77 	void   *cs_private;		/* sub-driver data pointer */
     78 	struct zsops *cs_ops;
     79 
     80 	struct simplelock cs_lock;	/* per channel lock */
     81 
     82 	int	cs_brg_clk;		/* BAUD Rate Generator clock
     83 					 * (usually PCLK / 16) */
     84 	int	cs_defspeed;		/* default baud rate */
     85 	int	cs_defcflag;		/* default cflag */
     86 
     87 	/*
     88 	 * We must keep a copy of the write registers as they are
     89 	 * mostly write-only and we sometimes need to set and clear
     90 	 * individual bits (e.g., in WR3).  Not all of these are
     91 	 * needed but 16 bytes is cheap and this makes the addressing
     92 	 * simpler.  Unfortunately, we can only write to some registers
     93 	 * when the chip is not actually transmitting, so whenever
     94 	 * we are expecting a `transmit done' interrupt the preg array
     95 	 * is allowed to `get ahead' of the current values.  In a
     96 	 * few places we must change the current value of a register,
     97 	 * rather than (or in addition to) the pending value; for these
     98 	 * cs_creg[] contains the current value.
     99 	 */
    100 	u_char	cs_creg[16];		/* current values */
    101 	u_char	cs_preg[16];		/* pending values */
    102 	int 	cs_heldchange;		/* change pending (creg != preg) */
    103 
    104 	u_char	cs_rr0;			/* last rr0 processed */
    105 	u_char	cs_rr0_delta;		/* rr0 changes at status intr. */
    106 	u_char	cs_rr0_mask;		/* rr0 bits that stop output */
    107 	u_char	cs_rr0_dcd;		/* which bit to read as DCD */
    108 	u_char	cs_rr0_cts;		/* which bit to read as CTS */
    109 	u_char	cs_rr0_pps;		/* which bit to use for PPS */
    110 	/* the above is set only while CRTSCTS is enabled. */
    111 
    112 	u_char	cs_wr5_dtr;		/* which bit to write as DTR */
    113 	u_char	cs_wr5_rts;		/* which bit to write as RTS */
    114 	/* the above is set only while CRTSCTS is enabled. */
    115 
    116 	char	cs_softreq;		/* need soft interrupt call */
    117 	char	cs_spare1;  	/* (for skippy :) */
    118 
    119 	/*
    120 	 * For strange systems that have oddly wired serial ports, we
    121 	 * provide a pointer to the channel state of the port that has
    122 	 * our status lines on it.
    123 	 */
    124 	struct  zs_chanstate *cs_ctl_chan;
    125 
    126 	/* power management hooks */
    127 	int	(*enable) __P((struct zs_chanstate *));
    128 	void	(*disable) __P((struct zs_chanstate *));
    129 	int	enabled;
    130 
    131 	/* MD code might define a larger variant of this. */
    132 };
    133 
    134 struct consdev;
    135 struct zsc_attach_args {
    136 	int channel;		/* two serial channels per zsc */
    137 	int hwflags;		/* see definitions below */
    138 	/* `consdev' is only valid if ZS_HWFLAG_USE_CONSDEV is set */
    139 	struct consdev *consdev;
    140 };
    141 /* In case of split console devices, use these: */
    142 #define ZS_HWFLAG_CONSOLE_INPUT		1
    143 #define ZS_HWFLAG_CONSOLE_OUTPUT	2
    144 #define ZS_HWFLAG_CONSOLE		\
    145 	(ZS_HWFLAG_CONSOLE_INPUT | ZS_HWFLAG_CONSOLE_OUTPUT)
    146 #define ZS_HWFLAG_NO_DCD	4	/* Ignore the DCD bit */
    147 #define ZS_HWFLAG_NO_CTS	8	/* Ignore the CTS bit */
    148 #define ZS_HWFLAG_RAW   	16	/* advise raw mode */
    149 #define ZS_HWFLAG_USE_CONSDEV  	32	/* Use console ops from `consdev' */
    150 #define	ZS_HWFLAG_NORESET	64	/* Don't reset at attach time */
    151 
    152 int 	zsc_intr_soft __P((void *));
    153 int 	zsc_intr_hard __P((void *));
    154 
    155 void	zs_abort __P((struct zs_chanstate *));
    156 void	zs_break __P((struct zs_chanstate *, int));
    157 void	zs_iflush __P((struct zs_chanstate *));
    158 void	zs_loadchannelregs __P((struct zs_chanstate *));
    159 int 	zs_set_speed __P((struct zs_chanstate *, int));
    160 int 	zs_set_modes __P((struct zs_chanstate *, int));
    161 
    162 int zs_check_kgdb __P((struct zs_chanstate *, int));
    163 
    164