FreeBSD/Linux Kernel Cross Reference
sys/dev/si/si.h
1 /*-
2 * Device driver for Specialix range (SI/XIO) of serial line multiplexors.
3 * 'C' definitions for Specialix serial multiplex driver.
4 *
5 * Copyright (C) 1990, 1992, 1998 Specialix International,
6 * Copyright (C) 1993, Andy Rutter <andy@acronym.co.uk>
7 * Copyright (C) 1995, Peter Wemm <peter@netplex.com.au>
8 *
9 * Derived from: SunOS 4.x version
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notices, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notices, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. All advertising materials mentioning features or use of this software
20 * must display the following acknowledgement:
21 * This product includes software developed by Andy Rutter of
22 * Advanced Methods and Tools Ltd. based on original information
23 * from Specialix International.
24 * 4. Neither the name of Advanced Methods and Tools, nor Specialix
25 * International may be used to endorse or promote products derived from
26 * this software without specific prior written permission.
27 *
28 * THIS SOFTWARE IS PROVIDED BY ``AS IS'' AND ANY EXPRESS OR IMPLIED
29 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
30 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
31 * NO EVENT SHALL THE AUTHORS BE LIABLE.
32 *
33 * $FreeBSD$
34 */
35
36 #include <sys/callout.h>
37
38 /*
39 * Macro to turn a device number into various parameters, and test for
40 * CONTROL device.
41 * max of 4 controllers with up to 32 ports per controller.
42 * minor device allocation is:
43 * adapter port
44 * 0 0-31
45 * 1 32-63
46 * 2 64-95
47 * 3 96-127
48 */
49 #define SI_MAXPORTPERCARD 32
50 #define SI_MAXCONTROLLER 4
51
52
53 /*
54 * breakup of minor device number:
55 * lowest 5 bits: port number on card 0x1f
56 * next 2 bits: card number 0x60
57 * top bit: callout 0x80
58 * next 8 bits is the major number
59 * next 2 bits select initial/lock states
60 * next 1 bit selects the master control device
61 */
62
63 #define SI_PORT_MASK 0x1f
64 #define SI_CARD_MASK 0x60
65 #define SI_TTY_MASK 0x7f
66 #define SI_CALLOUT_MASK 0x80
67 #define SI_INIT_STATE_MASK 0x10000
68 #define SI_LOCK_STATE_MASK 0x20000
69 #define SI_STATE_MASK 0x30000
70 #define SI_CONTROLDEV_MASK 0x40000
71 #define SI_SPECIAL_MASK 0x70000
72
73 #define SI_CARDSHIFT 5
74 #define SI_PORT(m) (m & SI_PORT_MASK)
75 #define SI_CARD(m) ((m & SI_CARD_MASK) >> SI_CARDSHIFT)
76 #define SI_TTY(m) (m & SI_TTY_MASK)
77
78 #define IS_CALLOUT(m) (m & SI_CALLOUT_MASK)
79 #define IS_STATE(m) (m & SI_STATE_MASK)
80 #define IS_CONTROLDEV(m) (m & SI_CONTROLDEV_MASK)
81 #define IS_SPECIAL(m) (m & SI_SPECIAL_MASK)
82
83 #define MINOR2SC(m) ((struct si_softc *)devclass_get_softc(si_devclass, SI_CARD(m)))
84 #define MINOR2PP(m) (MINOR2SC((m))->sc_ports + SI_PORT((m)))
85 #define MINOR2TP(m) (MINOR2PP((m))->sp_tty)
86 #define TP2PP(tp) (MINOR2PP(SI_TTY(minor((tp)->t_dev))))
87
88 /* Buffer parameters */
89 #define SI_BUFFERSIZE 256
90
91 typedef unsigned char BYTE; /* Type cast for unsigned 8 bit */
92 typedef unsigned short WORD; /* Type cast for unsigned 16 bit */
93
94
95 /*
96 * Hardware `registers', stored in the shared memory.
97 * These are related to the firmware running on the Z280.
98 */
99
100 struct si_reg {
101 BYTE initstat;
102 BYTE memsize;
103 WORD int_count;
104 WORD revision;
105 BYTE rx_int_count; /* isr_count on Jet */
106 BYTE main_count; /* spare on Z-280 */
107 WORD int_pending;
108 WORD int_counter;
109 BYTE int_scounter;
110 BYTE res[0x80 - 13];
111 };
112
113 /*
114 * Per module control structure, stored in shared memory.
115 */
116 struct si_module {
117 WORD sm_next; /* Next module */
118 BYTE sm_type; /* Number of channels */
119 BYTE sm_number; /* Module number on cable */
120 BYTE sm_dsr; /* Private dsr copy */
121 BYTE sm_res[0x80 - 5]; /* Reserve space to 128 bytes */
122 };
123
124 /*
125 * The 'next' pointer & with 0x7fff + SI base addres give
126 * the address of the next module block if fitted. (else 0)
127 * Note that next points to the TX buffer so 0x60 must be
128 * subtracted to find the true base.
129 */
130 #define TA4 0x00
131 #define TA8 0x08
132 #define TA4_ASIC 0x0A
133 #define TA8_ASIC 0x0B
134 #define MTA 0x28
135 #define SXDC 0x48
136
137 /*
138 * Per channel(port) control structure, stored in shared memory.
139 */
140 struct si_channel {
141 /*
142 * Generic stuff
143 */
144 WORD next; /* Next Channel */
145 WORD addr_uart; /* Uart address */
146 WORD module; /* address of module struct */
147 BYTE type; /* Uart type */
148 BYTE fill;
149 /*
150 * Uart type specific stuff
151 */
152 BYTE x_status; /* XON / XOFF status */
153 BYTE c_status; /* cooking status */
154 BYTE hi_rxipos; /* stuff into rx buff */
155 BYTE hi_rxopos; /* stuff out of rx buffer */
156 BYTE hi_txopos; /* Stuff into tx ptr */
157 BYTE hi_txipos; /* ditto out */
158 BYTE hi_stat; /* Command register */
159 BYTE dsr_bit; /* Magic bit for DSR */
160 BYTE txon; /* TX XON char */
161 BYTE txoff; /* ditto XOFF */
162 BYTE rxon; /* RX XON char */
163 BYTE rxoff; /* ditto XOFF */
164 BYTE hi_mr1; /* mode 1 image */
165 BYTE hi_mr2; /* mode 2 image */
166 BYTE hi_csr; /* clock register */
167 BYTE hi_op; /* Op control */
168 BYTE hi_ip; /* Input pins */
169 BYTE hi_state; /* status */
170 BYTE hi_prtcl; /* Protocol */
171 BYTE hi_txon; /* host copy tx xon stuff */
172 BYTE hi_txoff;
173 BYTE hi_rxon;
174 BYTE hi_rxoff;
175 BYTE close_prev; /* Was channel previously closed */
176 BYTE hi_break; /* host copy break process */
177 BYTE break_state; /* local copy ditto */
178 BYTE hi_mask; /* Mask for CS7 etc. */
179 BYTE mask_z280; /* Z280's copy */
180 BYTE res[0x60 - 36];
181 BYTE hi_txbuf[SI_BUFFERSIZE];
182 BYTE hi_rxbuf[SI_BUFFERSIZE];
183 BYTE res1[0xA0];
184 };
185
186 /*
187 * Register definitions
188 */
189
190 /*
191 * Break input control register definitions
192 */
193 #define BR_IGN 0x01 /* Ignore any received breaks */
194 #define BR_INT 0x02 /* Interrupt on received break */
195 #define BR_PARMRK 0x04 /* Enable parmrk parity error processing */
196 #define BR_PARIGN 0x08 /* Ignore chars with parity errors */
197
198 /*
199 * Protocol register provided by host for XON/XOFF and cooking
200 */
201 #define SP_TANY 0x01 /* Tx XON any char */
202 #define SP_TXEN 0x02 /* Tx XON/XOFF enabled */
203 #define SP_CEN 0x04 /* Cooking enabled */
204 #define SP_RXEN 0x08 /* Rx XON/XOFF enabled */
205 #define SP_DCEN 0x20 /* DCD / DTR check */
206 #define SP_PAEN 0x80 /* Parity checking enabled */
207
208 /*
209 * HOST STATUS / COMMAND REGISTER
210 */
211 #define IDLE_OPEN 0x00 /* Default mode, TX and RX polled
212 buffer updated etc */
213 #define LOPEN 0x02 /* Local open command (no modem ctl */
214 #define MOPEN 0x04 /* Open and monitor modem lines (blocks
215 for DCD */
216 #define MPEND 0x06 /* Wating for DCD */
217 #define CONFIG 0x08 /* Channel config has changed */
218 #define CLOSE 0x0A /* Close channel */
219 #define SBREAK 0x0C /* Start break */
220 #define EBREAK 0x0E /* End break */
221 #define IDLE_CLOSE 0x10 /* Closed channel */
222 #define IDLE_BREAK 0x12 /* In a break */
223 #define FCLOSE 0x14 /* Force a close */
224 #define RESUME 0x16 /* Clear a pending xoff */
225 #define WFLUSH 0x18 /* Flush output buffer */
226 #define RFLUSH 0x1A /* Flush input buffer */
227
228 /*
229 * Host status register
230 */
231 #define ST_BREAK 0x01 /* Break received (clear with config) */
232
233 /*
234 * OUTPUT PORT REGISTER
235 */
236 #define OP_CTS 0x01 /* Enable CTS */
237 #define OP_DSR 0x02 /* Enable DSR */
238 /*
239 * INPUT PORT REGISTER
240 */
241 #define IP_DCD 0x04 /* DCD High */
242 #define IP_DTR 0x20 /* DTR High */
243 #define IP_RTS 0x02 /* RTS High */
244 #define IP_RI 0x40 /* RI High */
245
246 /*
247 * Mode register and uart specific stuff
248 */
249 /*
250 * MODE REGISTER 1
251 */
252 #define MR1_5_BITS 0x00
253 #define MR1_6_BITS 0x01
254 #define MR1_7_BITS 0x02
255 #define MR1_8_BITS 0x03
256 /*
257 * Parity
258 */
259 #define MR1_ODD 0x04
260 #define MR1_EVEN 0x00
261 /*
262 * Parity mode
263 */
264 #define MR1_WITH 0x00
265 #define MR1_FORCE 0x08
266 #define MR1_NONE 0x10
267 #define MR1_SPECIAL 0x18
268 /*
269 * Error mode
270 */
271 #define MR1_CHAR 0x00
272 #define MR1_BLOCK 0x20
273 /*
274 * Request to send line automatic control
275 */
276 #define MR1_CTSCONT 0x80
277
278 /*
279 * MODE REGISTER 2
280 */
281 /*
282 * Number of stop bits
283 */
284 #define MR2_1_STOP 0x07
285 #define MR2_2_STOP 0x0F
286 /*
287 * Clear to send automatic testing before character sent
288 */
289 #define MR2_RTSCONT 0x10
290 /*
291 * Reset RTS automatically after sending character?
292 */
293 #define MR2_CTSCONT 0x20
294 /*
295 * Channel mode
296 */
297 #define MR2_NORMAL 0x00
298 #define MR2_AUTO 0x40
299 #define MR2_LOCAL 0x80
300 #define MR2_REMOTE 0xC0
301
302 /*
303 * CLOCK SELECT REGISTER - this and the code assumes ispeed == ospeed
304 */
305 /*
306 * Clocking rates are in lower and upper nibbles.. R = upper, T = lower
307 */
308 #define CLK75 0x0
309 #define CLK110 0x1 /* 110 on XIO!! */
310 #define CLK38400 0x2 /* out of sequence */
311 #define CLK150 0x3
312 #define CLK300 0x4
313 #define CLK600 0x5
314 #define CLK1200 0x6
315 #define CLK2000 0x7
316 #define CLK2400 0x8
317 #define CLK4800 0x9
318 #define CLK7200 0xa /* unchecked */
319 #define CLK9600 0xb
320 #define CLK19200 0xc
321 #define CLK57600 0xd
322
323 /*
324 * Per-port (channel) soft information structure, stored in the driver.
325 * This is visible via ioctl()'s.
326 */
327 struct si_port {
328 volatile struct si_channel *sp_ccb;
329 struct tty *sp_tty;
330 int sp_pend; /* pending command */
331 int sp_last_hi_ip; /* cached DCD */
332 int sp_state;
333 int sp_active_out; /* callout is open */
334 int sp_delta_overflows;
335 u_int sp_wopeners; /* # procs waiting DCD */
336 /* Initial state. */
337 struct termios sp_iin;
338 struct termios sp_iout;
339 /* Lock state. */
340 struct termios sp_lin;
341 struct termios sp_lout;
342 struct callout_handle lstart_ch;/* For canceling our timeout */
343 #ifdef SI_DEBUG
344 int sp_debug; /* debug mask */
345 #endif
346 };
347
348 /* sp_state */
349 #define SS_CLOSED 0x0000
350 #define SS_OPEN 0x0001 /* Port is active */
351 /* 0x0002 -- */
352 /* 0x0004 -- */
353 /* 0x0008 -- */
354 /* 0x0010 -- */
355 /* 0x0020 -- */
356 /* 0x0040 -- */
357 /* 0x0080 -- */
358 #define SS_LSTART 0x0100 /* lstart timeout pending */
359 #define SS_INLSTART 0x0200 /* running an lstart induced t_oproc */
360 #define SS_CLOSING 0x0400 /* in the middle of a siclose() */
361 /* 0x0800 -- */
362 #define SS_WAITWRITE 0x1000
363 #define SS_BLOCKWRITE 0x2000
364
365 /*
366 * Command post flags
367 */
368 #define SI_NOWAIT 0x00 /* Don't wait for command */
369 #define SI_WAIT 0x01 /* Wait for complete */
370
371 /*
372 * Extensive debugging stuff - manipulated using siconfig(8)
373 */
374 #define DBG_ENTRY 0x00000001
375 #define DBG_DRAIN 0x00000002
376 #define DBG_OPEN 0x00000004
377 #define DBG_CLOSE 0x00000008
378 #define DBG_READ 0x00000010
379 #define DBG_WRITE 0x00000020
380 #define DBG_PARAM 0x00000040
381 #define DBG_INTR 0x00000080
382 #define DBG_IOCTL 0x00000100
383 /* 0x00000200 */
384 #define DBG_SELECT 0x00000400
385 #define DBG_OPTIM 0x00000800
386 #define DBG_START 0x00001000
387 #define DBG_EXIT 0x00002000
388 #define DBG_FAIL 0x00004000
389 #define DBG_STOP 0x00008000
390 #define DBG_AUTOBOOT 0x00010000
391 #define DBG_MODEM 0x00020000
392 #define DBG_DOWNLOAD 0x00040000
393 #define DBG_LSTART 0x00080000
394 #define DBG_POLL 0x00100000
395 #define DBG_ALL 0xffffffff
396
397 /*
398 * SI ioctls
399 */
400 /*
401 * struct for use by Specialix ioctls - used by siconfig(8)
402 */
403 typedef struct {
404 unsigned char
405 sid_port:5, /* 0 - 31 ports per card */
406 sid_card:2, /* 0 - 3 cards */
407 sid_control:1; /* controlling device (all cards) */
408 } sidev_t;
409 struct si_tcsi {
410 sidev_t tc_dev;
411 union {
412 int x_int;
413 int x_dbglvl;
414 } tc_action;
415 #define tc_card tc_dev.sid_card
416 #define tc_port tc_dev.sid_port
417 #define tc_int tc_action.x_int
418 #define tc_dbglvl tc_action.x_dbglvl
419 };
420
421 struct si_pstat {
422 sidev_t tc_dev;
423 union {
424 struct si_port x_siport;
425 struct si_channel x_ccb;
426 struct tty x_tty;
427 } tc_action;
428 #define tc_siport tc_action.x_siport
429 #define tc_ccb tc_action.x_ccb
430 #define tc_tty tc_action.x_tty
431 };
432
433 #define IOCTL_MIN 96
434 #define TCSIDEBUG _IOW('S', 96, struct si_tcsi) /* Toggle debug */
435 #define TCSIRXIT _IOW('S', 97, struct si_tcsi) /* RX int throttle */
436 #define TCSIIT _IOW('S', 98, struct si_tcsi) /* TX int throttle */
437 /* 99 defunct */
438 /* 100 defunct */
439 /* 101 defunct */
440 /* 102 defunct */
441 /* 103 defunct */
442 /* 104 defunct */
443 #define TCSISTATE _IOWR('S', 105, struct si_tcsi) /* get current state of RTS
444 DCD and DTR pins */
445 /* 106 defunct */
446 #define TCSIPORTS _IOR('S', 107, int) /* Number of ports found */
447 #define TCSISDBG_LEVEL _IOW('S', 108, struct si_tcsi) /* equivalent of TCSIDEBUG which sets a
448 * particular debug level (DBG_??? bit
449 * mask), default is 0xffff */
450 #define TCSIGDBG_LEVEL _IOWR('S', 109, struct si_tcsi)
451 #define TCSIGRXIT _IOWR('S', 110, struct si_tcsi)
452 #define TCSIGIT _IOWR('S', 111, struct si_tcsi)
453 /* 112 defunct */
454 /* 113 defunct */
455 /* 114 defunct */
456 /* 115 defunct */
457 /* 116 defunct */
458 /* 117 defunct */
459
460 #define TCSISDBG_ALL _IOW('S', 118, int) /* set global debug level */
461 #define TCSIGDBG_ALL _IOR('S', 119, int) /* get global debug level */
462
463 /* 120 defunct */
464 /* 121 defunct */
465 /* 122 defunct */
466 /* 123 defunct */
467 #define TCSIMODULES _IOR('S', 124, int) /* Number of modules found */
468
469 /* Various stats and monitoring hooks per tty device */
470 #define TCSI_PORT _IOWR('S', 125, struct si_pstat) /* get si_port */
471 #define TCSI_CCB _IOWR('S', 126, struct si_pstat) /* get si_ccb */
472 #define TCSI_TTY _IOWR('S', 127, struct si_pstat) /* get tty struct */
473
474 #define IOCTL_MAX 127
475
476 #define IS_SI_IOCTL(cmd) ((u_int)((cmd)&0xff00) == ('S'<<8) && \
477 (u_int)((cmd)&0xff) >= IOCTL_MIN && \
478 (u_int)((cmd)&0xff) <= IOCTL_MAX)
479
480 #define CONTROLDEV "/dev/si_control"
Cache object: 16ff9b156bb66e4fefdb923e8e9e8efe
|