digi.h revision 78412 
1/*-
2 * Copyright (c) 2001 Brian Somers <brian@Awfulhak.org>
3 *   based on work by Slawa Olhovchenkov
4 *                    John Prince <johnp@knight-trosoft.com>
5 *                    Eric Hernes
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 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 *
29 * $FreeBSD: head/sys/dev/digi/digi.h 78412 2001-06-18 15:02:33Z brian $
30 */
31
32#define	W(p)				(*(u_int16_t *)(p))
33#define	vW(p)				(*(u_int16_t volatile *)(p))
34#define	D(p)				(*(u_int32_t *)(p))
35#define	vD(p)				(*(u_int32_t volatile *)(p))
36
37#define	CE_OVERRUN			0
38#define	CE_INTERRUPT_BUF_OVERFLOW	1
39#define	CE_TTY_BUF_OVERFLOW		2
40#define	CE_NTYPES			3
41#define	CE_RECORD(com, errnum)		(++(com)->delta_error_counts[errnum])
42
43/*#define DIGI_INTERRUPT*/
44
45#ifndef DEBUG
46#define	DEBUG
47#endif
48
49#ifdef DEBUG
50extern unsigned digi_debug;
51#define	DLOG(level, args)	if (digi_debug & (level)) device_printf args
52#else
53#define	DLOG(level, args)
54#endif
55
56
57struct digi_softc;
58
59/* digiboard port structure */
60struct digi_p {
61	struct digi_softc *sc;
62
63	int status;
64#define ENABLED 1
65#define DIGI_DTR_OFF 2
66#define PAUSE_TX 8
67#define PAUSE_RX 16
68
69	int opencnt;
70	ushort txbufsize;
71	ushort rxbufsize;
72	volatile struct board_chan *bc;
73	struct tty *tp;
74
75	dev_t dev[6];
76
77	u_char *txbuf;
78	u_char *rxbuf;
79	u_char txwin;
80	u_char rxwin;
81
82	u_char pnum;		/* port number */
83
84	u_char modemfake;	/* Modem values to be forced */
85	u_char mstat;
86	u_char modem;		/* Force values */
87
88	int active_out;		/* nonzero if the callout device is open */
89	int dtr_wait;		/* time to hold DTR down on close (* 1/hz) */
90	u_int wopeners;		/* # processes waiting for DCD in open() */
91
92	/*
93	 * The high level of the driver never reads status registers directly
94	 * because there would be too many side effects to handle conveniently.
95	 * Instead, it reads copies of the registers stored here by the
96	 * interrupt handler.
97	 */
98	u_char last_modem_status;	/* last MSR read by intr handler */
99	u_char prev_modem_status;	/* last MSR handled by high level */
100
101
102	/* Initial state. */
103	struct termios it_in;		/* should be in struct tty */
104	struct termios it_out;
105
106	/* Lock state. */
107	struct termios lt_in;		/* should be in struct tty */
108	struct termios lt_out;
109
110	u_int do_timestamp;
111	u_int do_dcd_timestamp;
112	struct timeval dcd_timestamp;
113
114	u_long bytes_in, bytes_out;
115	u_int delta_error_counts[CE_NTYPES];
116	u_long error_counts;
117
118	tcflag_t c_iflag;		/* hold true IXON/IXOFF/IXANY */
119	int lcc, lostcc, lbuf;
120	u_char send_ring;
121};
122
123/*
124 * Map TIOCM_* values to digiboard values
125 */
126struct digi_control_signals {
127	int rts;
128	int cd;
129	int dsr;
130	int cts;
131	int ri;
132	int dtr;
133};
134
135enum digi_board_status {
136	DIGI_STATUS_NOTINIT,
137	DIGI_STATUS_ENABLED,
138	DIGI_STATUS_DISABLED
139};
140
141/* Digiboard per-board structure */
142struct digi_softc {
143	/* struct board_info */
144	device_t dev;
145
146	const char *name;
147	enum digi_board_status status;
148	ushort numports;		/* number of ports on card */
149	ushort port;			/* I/O port */
150	ushort wport;			/* window select I/O port */
151
152	struct {
153		struct resource *mem;
154		int mrid;
155		struct resource *irq;
156		int irqrid;
157		struct resource *io;
158		int iorid;
159		void *irqHandler;
160		int unit;
161		dev_t ctldev;
162	} res;
163
164	u_char *vmem;			/* virtual memory address */
165	u_char *memcmd;
166	volatile u_char *memevent;
167	long pmem;			/* physical memory address */
168
169	struct {
170		u_char *data;
171		size_t size;
172	} bios, fep, link;
173
174#ifdef DIGI_INTERRUPT
175	struct timeval intr_timestamp;
176#endif
177
178	struct digi_p *ports;	/* pointer to array of port descriptors */
179	struct tty *ttys;	/* pointer to array of TTY structures */
180	volatile struct global_data *gdata;
181	u_char window;		/* saved window */
182	int win_size;
183	int win_bits;
184	int mem_size;
185	int mem_seg;
186	enum digi_model model;
187	const struct digi_control_signals *csigs;
188	int opencnt;
189	unsigned pcibus : 1;		/* On a PCI bus ? */
190
191	struct callout_handle callout;	/* poll timeout handle */
192	struct callout_handle inttest;	/* int test timeout handle */
193	const char *module;
194
195	u_char *(*setwin)(struct digi_softc *_sc, unsigned _addr);
196	void	(*hidewin)(struct digi_softc *_sc);
197	void	(*towin)(struct digi_softc *_sc, int _win);
198#ifdef DEBUG
199	int	intr_count;
200#endif
201};
202
203extern devclass_t digi_devclass;
204extern const struct digi_control_signals digi_xixe_signals;
205extern const struct digi_control_signals digi_normal_signals;
206
207const char	*digi_errortxt(int _id);
208int		 digi_modhandler(module_t _mod, int _event, void *_arg);
209int		 digi_attach(struct digi_softc *);
210int		 digi_detach(device_t _dev);
211int		 digi_shutdown(device_t _dev);
212