2 * rocket_int.h --- internal header file for rocket.c
4 * Written by Theodore Ts'o, Copyright 1997.
5 * Copyright 1997 Comtrol Corporation.
10 * Definition of the types in rcktpt_type
12 #define ROCKET_TYPE_NORMAL 0
13 #define ROCKET_TYPE_MODEM 1
14 #define ROCKET_TYPE_MODEMII 2
15 #define ROCKET_TYPE_MODEMIII 3
16 #define ROCKET_TYPE_PC104 4
19 #include <asm/byteorder.h>
21 typedef unsigned char Byte_t;
22 typedef unsigned int ByteIO_t;
24 typedef unsigned int Word_t;
25 typedef unsigned int WordIO_t;
27 typedef unsigned long DWord_t;
28 typedef unsigned int DWordIO_t;
31 * Note! Normally the Linux I/O macros already take care of
32 * byte-swapping the I/O instructions. However, all accesses using
33 * sOutDW aren't really 32-bit accesses, but should be handled in byte
34 * order. Hence the use of the cpu_to_le32() macro to byte-swap
35 * things to no-op the byte swapping done by the big-endian outl()
39 #ifdef ROCKET_DEBUG_IO
40 static inline void sOutB(unsigned short port, unsigned char value)
42 #ifdef ROCKET_DEBUG_IO
43 printk("sOutB(%x, %x)...", port, value);
48 static inline void sOutW(unsigned short port, unsigned short value)
50 #ifdef ROCKET_DEBUG_IO
51 printk("sOutW(%x, %x)...", port, value);
56 static inline void sOutDW(unsigned short port, unsigned long value)
58 #ifdef ROCKET_DEBUG_IO
59 printk("sOutDW(%x, %lx)...", port, value);
61 outl_p(cpu_to_le32(value), port);
64 static inline unsigned char sInB(unsigned short port)
69 static inline unsigned short sInW(unsigned short port)
74 #else /* !ROCKET_DEBUG_IO */
75 #define sOutB(a, b) outb_p(b, a)
76 #define sOutW(a, b) outw_p(b, a)
77 #define sOutDW(port, value) outl_p(cpu_to_le32(value), port)
78 #define sInB(a) (inb_p(a))
79 #define sInW(a) (inw_p(a))
80 #endif /* ROCKET_DEBUG_IO */
82 /* This is used to move arrays of bytes so byte swapping isn't appropriate. */
83 #define sOutStrW(port, addr, count) if (count) outsw(port, addr, count)
84 #define sInStrW(port, addr, count) if (count) insw(port, addr, count)
87 #define AIOP_CTL_SIZE 4
88 #define CHAN_AIOP_SIZE 8
89 #define MAX_PORTS_PER_AIOP 8
90 #define MAX_AIOPS_PER_BOARD 4
91 #define MAX_PORTS_PER_BOARD 32
98 /* Controller ID numbers */
99 #define CTLID_NULL -1 /* no controller exists */
100 #define CTLID_0001 0x0001 /* controller release 1 */
102 /* AIOP ID numbers, identifies AIOP type implementing channel */
103 #define AIOPID_NULL -1 /* no AIOP or channel exists */
104 #define AIOPID_0001 0x0001 /* AIOP release 1 */
106 #define NULLDEV -1 /* identifies non-existant device */
107 #define NULLCTL -1 /* identifies non-existant controller */
108 #define NULLCTLPTR (CONTROLLER_T *)0 /* identifies non-existant controller */
109 #define NULLAIOP -1 /* identifies non-existant AIOP */
110 #define NULLCHAN -1 /* identifies non-existant channel */
112 /************************************************************************
113 Global Register Offsets - Direct Access - Fixed values
114 ************************************************************************/
116 #define _CMD_REG 0x38 /* Command Register 8 Write */
117 #define _INT_CHAN 0x39 /* Interrupt Channel Register 8 Read */
118 #define _INT_MASK 0x3A /* Interrupt Mask Register 8 Read / Write */
119 #define _UNUSED 0x3B /* Unused 8 */
120 #define _INDX_ADDR 0x3C /* Index Register Address 16 Write */
121 #define _INDX_DATA 0x3E /* Index Register Data 8/16 Read / Write */
123 /************************************************************************
124 Channel Register Offsets for 1st channel in AIOP - Direct Access
125 ************************************************************************/
126 #define _TD0 0x00 /* Transmit Data 16 Write */
127 #define _RD0 0x00 /* Receive Data 16 Read */
128 #define _CHN_STAT0 0x20 /* Channel Status 8/16 Read / Write */
129 #define _FIFO_CNT0 0x10 /* Transmit/Receive FIFO Count 16 Read */
130 #define _INT_ID0 0x30 /* Interrupt Identification 8 Read */
132 /************************************************************************
133 Tx Control Register Offsets - Indexed - External - Fixed
134 ************************************************************************/
135 #define _TX_ENBLS 0x980 /* Tx Processor Enables Register 8 Read / Write */
136 #define _TXCMP1 0x988 /* Transmit Compare Value #1 8 Read / Write */
137 #define _TXCMP2 0x989 /* Transmit Compare Value #2 8 Read / Write */
138 #define _TXREP1B1 0x98A /* Tx Replace Value #1 - Byte 1 8 Read / Write */
139 #define _TXREP1B2 0x98B /* Tx Replace Value #1 - Byte 2 8 Read / Write */
140 #define _TXREP2 0x98C /* Transmit Replace Value #2 8 Read / Write */
142 /************************************************************************
143 Memory Controller Register Offsets - Indexed - External - Fixed
144 ************************************************************************/
145 #define _RX_FIFO 0x000 /* Rx FIFO */
146 #define _TX_FIFO 0x800 /* Tx FIFO */
147 #define _RXF_OUTP 0x990 /* Rx FIFO OUT pointer 16 Read / Write */
148 #define _RXF_INP 0x992 /* Rx FIFO IN pointer 16 Read / Write */
149 #define _TXF_OUTP 0x994 /* Tx FIFO OUT pointer 8 Read / Write */
150 #define _TXF_INP 0x995 /* Tx FIFO IN pointer 8 Read / Write */
151 #define _TXP_CNT 0x996 /* Tx Priority Count 8 Read / Write */
152 #define _TXP_PNTR 0x997 /* Tx Priority Pointer 8 Read / Write */
154 #define PRI_PEND 0x80 /* Priority data pending (bit7, Tx pri cnt) */
155 #define TXFIFO_SIZE 255 /* size of Tx FIFO */
156 #define RXFIFO_SIZE 1023 /* size of Rx FIFO */
158 /************************************************************************
159 Tx Priority Buffer - Indexed - External - Fixed
160 ************************************************************************/
161 #define _TXP_BUF 0x9C0 /* Tx Priority Buffer 32 Bytes Read / Write */
162 #define TXP_SIZE 0x20 /* 32 bytes */
164 /************************************************************************
165 Channel Register Offsets - Indexed - Internal - Fixed
166 ************************************************************************/
168 #define _TX_CTRL 0xFF0 /* Transmit Control 16 Write */
169 #define _RX_CTRL 0xFF2 /* Receive Control 8 Write */
170 #define _BAUD 0xFF4 /* Baud Rate 16 Write */
171 #define _CLK_PRE 0xFF6 /* Clock Prescaler 8 Write */
173 #define STMBREAK 0x08 /* BREAK */
174 #define STMFRAME 0x04 /* framing error */
175 #define STMRCVROVR 0x02 /* receiver over run error */
176 #define STMPARITY 0x01 /* parity error */
177 #define STMERROR (STMBREAK | STMFRAME | STMPARITY)
178 #define STMBREAKH 0x800 /* BREAK */
179 #define STMFRAMEH 0x400 /* framing error */
180 #define STMRCVROVRH 0x200 /* receiver over run error */
181 #define STMPARITYH 0x100 /* parity error */
182 #define STMERRORH (STMBREAKH | STMFRAMEH | STMPARITYH)
184 #define CTS_ACT 0x20 /* CTS input asserted */
185 #define DSR_ACT 0x10 /* DSR input asserted */
186 #define CD_ACT 0x08 /* CD input asserted */
187 #define TXFIFOMT 0x04 /* Tx FIFO is empty */
188 #define TXSHRMT 0x02 /* Tx shift register is empty */
189 #define RDA 0x01 /* Rx data available */
190 #define DRAINED (TXFIFOMT | TXSHRMT) /* indicates Tx is drained */
192 #define STATMODE 0x8000 /* status mode enable bit */
193 #define RXFOVERFL 0x2000 /* receive FIFO overflow */
194 #define RX2MATCH 0x1000 /* receive compare byte 2 match */
195 #define RX1MATCH 0x0800 /* receive compare byte 1 match */
196 #define RXBREAK 0x0400 /* received BREAK */
197 #define RXFRAME 0x0200 /* received framing error */
198 #define RXPARITY 0x0100 /* received parity error */
199 #define STATERROR (RXBREAK | RXFRAME | RXPARITY)
201 #define CTSFC_EN 0x80 /* CTS flow control enable bit */
202 #define RTSTOG_EN 0x40 /* RTS toggle enable bit */
203 #define TXINT_EN 0x10 /* transmit interrupt enable */
204 #define STOP2 0x08 /* enable 2 stop bits (0 = 1 stop) */
205 #define PARITY_EN 0x04 /* enable parity (0 = no parity) */
206 #define EVEN_PAR 0x02 /* even parity (0 = odd parity) */
207 #define DATA8BIT 0x01 /* 8 bit data (0 = 7 bit data) */
209 #define SETBREAK 0x10 /* send break condition (must clear) */
210 #define LOCALLOOP 0x08 /* local loopback set for test */
211 #define SET_DTR 0x04 /* assert DTR */
212 #define SET_RTS 0x02 /* assert RTS */
213 #define TX_ENABLE 0x01 /* enable transmitter */
215 #define RTSFC_EN 0x40 /* RTS flow control enable */
216 #define RXPROC_EN 0x20 /* receive processor enable */
217 #define TRIG_NO 0x00 /* Rx FIFO trigger level 0 (no trigger) */
218 #define TRIG_1 0x08 /* trigger level 1 char */
219 #define TRIG_1_2 0x10 /* trigger level 1/2 */
220 #define TRIG_7_8 0x18 /* trigger level 7/8 */
221 #define TRIG_MASK 0x18 /* trigger level mask */
222 #define SRCINT_EN 0x04 /* special Rx condition interrupt enable */
223 #define RXINT_EN 0x02 /* Rx interrupt enable */
224 #define MCINT_EN 0x01 /* modem change interrupt enable */
226 #define RXF_TRIG 0x20 /* Rx FIFO trigger level interrupt */
227 #define TXFIFO_MT 0x10 /* Tx FIFO empty interrupt */
228 #define SRC_INT 0x08 /* special receive condition interrupt */
229 #define DELTA_CD 0x04 /* CD change interrupt */
230 #define DELTA_CTS 0x02 /* CTS change interrupt */
231 #define DELTA_DSR 0x01 /* DSR change interrupt */
233 #define REP1W2_EN 0x10 /* replace byte 1 with 2 bytes enable */
234 #define IGN2_EN 0x08 /* ignore byte 2 enable */
235 #define IGN1_EN 0x04 /* ignore byte 1 enable */
236 #define COMP2_EN 0x02 /* compare byte 2 enable */
237 #define COMP1_EN 0x01 /* compare byte 1 enable */
239 #define RESET_ALL 0x80 /* reset AIOP (all channels) */
240 #define TXOVERIDE 0x40 /* Transmit software off override */
241 #define RESETUART 0x20 /* reset channel's UART */
242 #define RESTXFCNT 0x10 /* reset channel's Tx FIFO count register */
243 #define RESRXFCNT 0x08 /* reset channel's Rx FIFO count register */
245 #define INTSTAT0 0x01 /* AIOP 0 interrupt status */
246 #define INTSTAT1 0x02 /* AIOP 1 interrupt status */
247 #define INTSTAT2 0x04 /* AIOP 2 interrupt status */
248 #define INTSTAT3 0x08 /* AIOP 3 interrupt status */
250 #define INTR_EN 0x08 /* allow interrupts to host */
251 #define INT_STROB 0x04 /* strobe and clear interrupt line (EOI) */
253 /**************************************************************************
254 MUDBAC remapped for PCI
255 **************************************************************************/
257 #define _CFG_INT_PCI 0x40
258 #define _PCI_INT_FUNC 0x3A
260 #define PCI_STROB 0x2000 /* bit 13 of int aiop register */
261 #define INTR_EN_PCI 0x0010 /* allow interrupts to host */
264 * Definitions for Universal PCI board registers
266 #define _PCI_9030_INT_CTRL 0x4c /* Offsets from BAR1 */
267 #define _PCI_9030_GPIO_CTRL 0x54
268 #define PCI_INT_CTRL_AIOP 0x0001
269 #define PCI_GPIO_CTRL_8PORT 0x4000
270 #define _PCI_9030_RING_IND 0xc0 /* Offsets from BAR1 */
272 #define CHAN3_EN 0x08 /* enable AIOP 3 */
273 #define CHAN2_EN 0x04 /* enable AIOP 2 */
274 #define CHAN1_EN 0x02 /* enable AIOP 1 */
275 #define CHAN0_EN 0x01 /* enable AIOP 0 */
276 #define FREQ_DIS 0x00
277 #define FREQ_274HZ 0x60
278 #define FREQ_137HZ 0x50
279 #define FREQ_69HZ 0x40
280 #define FREQ_34HZ 0x30
281 #define FREQ_17HZ 0x20
282 #define FREQ_9HZ 0x10
283 #define PERIODIC_ONLY 0x80 /* only PERIODIC interrupt */
285 #define CHANINT_EN 0x0100 /* flags to enable/disable channel ints */
288 #define RREGDATASIZE 52
291 * AIOP interrupt bits for ISA/PCI boards and UPCI boards.
293 #define AIOP_INTR_BIT_0 0x0001
294 #define AIOP_INTR_BIT_1 0x0002
295 #define AIOP_INTR_BIT_2 0x0004
296 #define AIOP_INTR_BIT_3 0x0008
298 #define AIOP_INTR_BITS ( \
304 #define UPCI_AIOP_INTR_BIT_0 0x0004
305 #define UPCI_AIOP_INTR_BIT_1 0x0020
306 #define UPCI_AIOP_INTR_BIT_2 0x0100
307 #define UPCI_AIOP_INTR_BIT_3 0x0800
309 #define UPCI_AIOP_INTR_BITS ( \
310 UPCI_AIOP_INTR_BIT_0 \
311 | UPCI_AIOP_INTR_BIT_1 \
312 | UPCI_AIOP_INTR_BIT_2 \
313 | UPCI_AIOP_INTR_BIT_3)
315 /* Controller level information structure */
331 int AltChanRingIndicator;
332 ByteIO_t UPCIRingInd;
333 WordIO_t AiopIO[AIOP_CTL_SIZE];
334 ByteIO_t AiopIntChanIO[AIOP_CTL_SIZE];
335 int AiopID[AIOP_CTL_SIZE];
336 int AiopNumChan[AIOP_CTL_SIZE];
337 Word_t *AiopIntrBits;
340 typedef CONTROLLER_T CONTROLLER_t;
342 /* Channel level information structure */
369 Byte_t R[RREGDATASIZE];
376 Byte_t TxReplace1[4];
377 Byte_t TxReplace2[4];
380 typedef CHANNEL_T CHANNEL_t;
381 typedef CHANNEL_T *CHANPTR_T;
383 #define InterfaceModeRS232 0x00
384 #define InterfaceModeRS422 0x08
385 #define InterfaceModeRS485 0x10
386 #define InterfaceModeRS232T 0x18
388 /***************************************************************************
390 Purpose: Stop sending a transmit BREAK signal
392 CHANNEL_T *ChP; Ptr to channel structure
394 #define sClrBreak(ChP) \
396 (ChP)->TxControl[3] &= ~SETBREAK; \
397 sOutDW((ChP)->IndexAddr,*(DWord_t *)&(ChP)->TxControl[0]); \
400 /***************************************************************************
402 Purpose: Clr the DTR output
404 CHANNEL_T *ChP; Ptr to channel structure
406 #define sClrDTR(ChP) \
408 (ChP)->TxControl[3] &= ~SET_DTR; \
409 sOutDW((ChP)->IndexAddr,*(DWord_t *)&(ChP)->TxControl[0]); \
412 /***************************************************************************
414 Purpose: Clr the RTS output
416 CHANNEL_T *ChP; Ptr to channel structure
418 #define sClrRTS(ChP) \
420 if ((ChP)->rtsToggle) break; \
421 (ChP)->TxControl[3] &= ~SET_RTS; \
422 sOutDW((ChP)->IndexAddr,*(DWord_t *)&(ChP)->TxControl[0]); \
425 /***************************************************************************
427 Purpose: Clear any existing transmit software flow control off condition
428 Call: sClrTxXOFF(ChP)
429 CHANNEL_T *ChP; Ptr to channel structure
431 #define sClrTxXOFF(ChP) \
433 sOutB((ChP)->Cmd,TXOVERIDE | (Byte_t)(ChP)->ChanNum); \
434 sOutB((ChP)->Cmd,(Byte_t)(ChP)->ChanNum); \
437 /***************************************************************************
438 Function: sCtlNumToCtlPtr
439 Purpose: Convert a controller number to controller structure pointer
440 Call: sCtlNumToCtlPtr(CtlNum)
441 int CtlNum; Controller number
442 Return: CONTROLLER_T *: Ptr to controller structure
444 #define sCtlNumToCtlPtr(CTLNUM) &sController[CTLNUM]
446 /***************************************************************************
447 Function: sControllerEOI
448 Purpose: Strobe the MUDBAC's End Of Interrupt bit.
449 Call: sControllerEOI(CtlP)
450 CONTROLLER_T *CtlP; Ptr to controller structure
452 #define sControllerEOI(CTLP) sOutB((CTLP)->MReg2IO,(CTLP)->MReg2 | INT_STROB)
454 /***************************************************************************
455 Function: sPCIControllerEOI
456 Purpose: Strobe the PCI End Of Interrupt bit.
457 For the UPCI boards, toggle the AIOP interrupt enable bit
458 (this was taken from the Windows driver).
459 Call: sPCIControllerEOI(CtlP)
460 CONTROLLER_T *CtlP; Ptr to controller structure
462 #define sPCIControllerEOI(CTLP) \
464 if ((CTLP)->isUPCI) { \
465 Word_t w = sInW((CTLP)->PCIIO); \
466 sOutW((CTLP)->PCIIO, (w ^ PCI_INT_CTRL_AIOP)); \
467 sOutW((CTLP)->PCIIO, w); \
470 sOutW((CTLP)->PCIIO, PCI_STROB); \
474 /***************************************************************************
476 Purpose: Disable I/O access to an AIOP
478 CONTROLLER_T *CtlP; Ptr to controller structure
479 int AiopNum; Number of AIOP on controller
481 #define sDisAiop(CTLP,AIOPNUM) \
483 (CTLP)->MReg3 &= sBitMapClrTbl[AIOPNUM]; \
484 sOutB((CTLP)->MReg3IO,(CTLP)->MReg3); \
487 /***************************************************************************
488 Function: sDisCTSFlowCtl
489 Purpose: Disable output flow control using CTS
490 Call: sDisCTSFlowCtl(ChP)
491 CHANNEL_T *ChP; Ptr to channel structure
493 #define sDisCTSFlowCtl(ChP) \
495 (ChP)->TxControl[2] &= ~CTSFC_EN; \
496 sOutDW((ChP)->IndexAddr,*(DWord_t *)&(ChP)->TxControl[0]); \
499 /***************************************************************************
501 Purpose: Disable IXANY Software Flow Control
503 CHANNEL_T *ChP; Ptr to channel structure
505 #define sDisIXANY(ChP) \
507 (ChP)->R[0x0e] = 0x86; \
508 sOutDW((ChP)->IndexAddr,*(DWord_t *)&(ChP)->R[0x0c]); \
511 /***************************************************************************
513 Purpose: Disable parity
514 Call: sDisParity(ChP)
515 CHANNEL_T *ChP; Ptr to channel structure
516 Comments: Function sSetParity() can be used in place of functions sEnParity(),
517 sDisParity(), sSetOddParity(), and sSetEvenParity().
519 #define sDisParity(ChP) \
521 (ChP)->TxControl[2] &= ~PARITY_EN; \
522 sOutDW((ChP)->IndexAddr,*(DWord_t *)&(ChP)->TxControl[0]); \
525 /***************************************************************************
526 Function: sDisRTSToggle
527 Purpose: Disable RTS toggle
528 Call: sDisRTSToggle(ChP)
529 CHANNEL_T *ChP; Ptr to channel structure
531 #define sDisRTSToggle(ChP) \
533 (ChP)->TxControl[2] &= ~RTSTOG_EN; \
534 sOutDW((ChP)->IndexAddr,*(DWord_t *)&(ChP)->TxControl[0]); \
535 (ChP)->rtsToggle = 0; \
538 /***************************************************************************
540 Purpose: Disable Rx FIFO
541 Call: sDisRxFIFO(ChP)
542 CHANNEL_T *ChP; Ptr to channel structure
544 #define sDisRxFIFO(ChP) \
546 (ChP)->R[0x32] = 0x0a; \
547 sOutDW((ChP)->IndexAddr,*(DWord_t *)&(ChP)->R[0x30]); \
550 /***************************************************************************
551 Function: sDisRxStatusMode
552 Purpose: Disable the Rx status mode
553 Call: sDisRxStatusMode(ChP)
554 CHANNEL_T *ChP; Ptr to channel structure
555 Comments: This takes the channel out of the receive status mode. All
556 subsequent reads of receive data using sReadRxWord() will return
559 #define sDisRxStatusMode(ChP) sOutW((ChP)->ChanStat,0)
561 /***************************************************************************
562 Function: sDisTransmit
563 Purpose: Disable transmit
564 Call: sDisTransmit(ChP)
565 CHANNEL_T *ChP; Ptr to channel structure
566 This disables movement of Tx data from the Tx FIFO into the 1 byte
567 Tx buffer. Therefore there could be up to a 2 byte latency
568 between the time sDisTransmit() is called and the transmit buffer
569 and transmit shift register going completely empty.
571 #define sDisTransmit(ChP) \
573 (ChP)->TxControl[3] &= ~TX_ENABLE; \
574 sOutDW((ChP)->IndexAddr,*(DWord_t *)&(ChP)->TxControl[0]); \
577 /***************************************************************************
578 Function: sDisTxSoftFlowCtl
579 Purpose: Disable Tx Software Flow Control
580 Call: sDisTxSoftFlowCtl(ChP)
581 CHANNEL_T *ChP; Ptr to channel structure
583 #define sDisTxSoftFlowCtl(ChP) \
585 (ChP)->R[0x06] = 0x8a; \
586 sOutDW((ChP)->IndexAddr,*(DWord_t *)&(ChP)->R[0x04]); \
589 /***************************************************************************
591 Purpose: Enable I/O access to an AIOP
593 CONTROLLER_T *CtlP; Ptr to controller structure
594 int AiopNum; Number of AIOP on controller
596 #define sEnAiop(CTLP,AIOPNUM) \
598 (CTLP)->MReg3 |= sBitMapSetTbl[AIOPNUM]; \
599 sOutB((CTLP)->MReg3IO,(CTLP)->MReg3); \
602 /***************************************************************************
603 Function: sEnCTSFlowCtl
604 Purpose: Enable output flow control using CTS
605 Call: sEnCTSFlowCtl(ChP)
606 CHANNEL_T *ChP; Ptr to channel structure
608 #define sEnCTSFlowCtl(ChP) \
610 (ChP)->TxControl[2] |= CTSFC_EN; \
611 sOutDW((ChP)->IndexAddr,*(DWord_t *)&(ChP)->TxControl[0]); \
614 /***************************************************************************
616 Purpose: Enable IXANY Software Flow Control
618 CHANNEL_T *ChP; Ptr to channel structure
620 #define sEnIXANY(ChP) \
622 (ChP)->R[0x0e] = 0x21; \
623 sOutDW((ChP)->IndexAddr,*(DWord_t *)&(ChP)->R[0x0c]); \
626 /***************************************************************************
628 Purpose: Enable parity
630 CHANNEL_T *ChP; Ptr to channel structure
631 Comments: Function sSetParity() can be used in place of functions sEnParity(),
632 sDisParity(), sSetOddParity(), and sSetEvenParity().
634 Warnings: Before enabling parity odd or even parity should be chosen using
635 functions sSetOddParity() or sSetEvenParity().
637 #define sEnParity(ChP) \
639 (ChP)->TxControl[2] |= PARITY_EN; \
640 sOutDW((ChP)->IndexAddr,*(DWord_t *)&(ChP)->TxControl[0]); \
643 /***************************************************************************
644 Function: sEnRTSToggle
645 Purpose: Enable RTS toggle
646 Call: sEnRTSToggle(ChP)
647 CHANNEL_T *ChP; Ptr to channel structure
648 Comments: This function will disable RTS flow control and clear the RTS
649 line to allow operation of RTS toggle.
651 #define sEnRTSToggle(ChP) \
653 (ChP)->RxControl[2] &= ~RTSFC_EN; \
654 sOutDW((ChP)->IndexAddr,*(DWord_t *)&(ChP)->RxControl[0]); \
655 (ChP)->TxControl[2] |= RTSTOG_EN; \
656 (ChP)->TxControl[3] &= ~SET_RTS; \
657 sOutDW((ChP)->IndexAddr,*(DWord_t *)&(ChP)->TxControl[0]); \
658 (ChP)->rtsToggle = 1; \
661 /***************************************************************************
663 Purpose: Enable Rx FIFO
665 CHANNEL_T *ChP; Ptr to channel structure
667 #define sEnRxFIFO(ChP) \
669 (ChP)->R[0x32] = 0x08; \
670 sOutDW((ChP)->IndexAddr,*(DWord_t *)&(ChP)->R[0x30]); \
673 /***************************************************************************
674 Function: sEnRxProcessor
675 Purpose: Enable the receive processor
676 Call: sEnRxProcessor(ChP)
677 CHANNEL_T *ChP; Ptr to channel structure
678 Comments: This function is used to start the receive processor. When
679 the channel is in the reset state the receive processor is not
680 running. This is done to prevent the receive processor from
681 executing invalid microcode instructions prior to the
682 downloading of the microcode.
684 Warnings: This function must be called after valid microcode has been
685 downloaded to the AIOP, and it must not be called before the
686 microcode has been downloaded.
688 #define sEnRxProcessor(ChP) \
690 (ChP)->RxControl[2] |= RXPROC_EN; \
691 sOutDW((ChP)->IndexAddr,*(DWord_t *)&(ChP)->RxControl[0]); \
694 /***************************************************************************
695 Function: sEnRxStatusMode
696 Purpose: Enable the Rx status mode
697 Call: sEnRxStatusMode(ChP)
698 CHANNEL_T *ChP; Ptr to channel structure
699 Comments: This places the channel in the receive status mode. All subsequent
700 reads of receive data using sReadRxWord() will return a data byte
701 in the low word and a status byte in the high word.
704 #define sEnRxStatusMode(ChP) sOutW((ChP)->ChanStat,STATMODE)
706 /***************************************************************************
707 Function: sEnTransmit
708 Purpose: Enable transmit
709 Call: sEnTransmit(ChP)
710 CHANNEL_T *ChP; Ptr to channel structure
712 #define sEnTransmit(ChP) \
714 (ChP)->TxControl[3] |= TX_ENABLE; \
715 sOutDW((ChP)->IndexAddr,*(DWord_t *)&(ChP)->TxControl[0]); \
718 /***************************************************************************
719 Function: sEnTxSoftFlowCtl
720 Purpose: Enable Tx Software Flow Control
721 Call: sEnTxSoftFlowCtl(ChP)
722 CHANNEL_T *ChP; Ptr to channel structure
724 #define sEnTxSoftFlowCtl(ChP) \
726 (ChP)->R[0x06] = 0xc5; \
727 sOutDW((ChP)->IndexAddr,*(DWord_t *)&(ChP)->R[0x04]); \
730 /***************************************************************************
731 Function: sGetAiopIntStatus
732 Purpose: Get the AIOP interrupt status
733 Call: sGetAiopIntStatus(CtlP,AiopNum)
734 CONTROLLER_T *CtlP; Ptr to controller structure
735 int AiopNum; AIOP number
736 Return: Byte_t: The AIOP interrupt status. Bits 0 through 7
737 represent channels 0 through 7 respectively. If a
738 bit is set that channel is interrupting.
740 #define sGetAiopIntStatus(CTLP,AIOPNUM) sInB((CTLP)->AiopIntChanIO[AIOPNUM])
742 /***************************************************************************
743 Function: sGetAiopNumChan
744 Purpose: Get the number of channels supported by an AIOP
745 Call: sGetAiopNumChan(CtlP,AiopNum)
746 CONTROLLER_T *CtlP; Ptr to controller structure
747 int AiopNum; AIOP number
748 Return: int: The number of channels supported by the AIOP
750 #define sGetAiopNumChan(CTLP,AIOPNUM) (CTLP)->AiopNumChan[AIOPNUM]
752 /***************************************************************************
753 Function: sGetChanIntID
754 Purpose: Get a channel's interrupt identification byte
755 Call: sGetChanIntID(ChP)
756 CHANNEL_T *ChP; Ptr to channel structure
757 Return: Byte_t: The channel interrupt ID. Can be any
758 combination of the following flags:
759 RXF_TRIG: Rx FIFO trigger level interrupt
760 TXFIFO_MT: Tx FIFO empty interrupt
761 SRC_INT: Special receive condition interrupt
762 DELTA_CD: CD change interrupt
763 DELTA_CTS: CTS change interrupt
764 DELTA_DSR: DSR change interrupt
766 #define sGetChanIntID(ChP) (sInB((ChP)->IntID) & (RXF_TRIG | TXFIFO_MT | SRC_INT | DELTA_CD | DELTA_CTS | DELTA_DSR))
768 /***************************************************************************
769 Function: sGetChanNum
770 Purpose: Get the number of a channel within an AIOP
771 Call: sGetChanNum(ChP)
772 CHANNEL_T *ChP; Ptr to channel structure
773 Return: int: Channel number within AIOP, or NULLCHAN if channel does
776 #define sGetChanNum(ChP) (ChP)->ChanNum
778 /***************************************************************************
779 Function: sGetChanStatus
780 Purpose: Get the channel status
781 Call: sGetChanStatus(ChP)
782 CHANNEL_T *ChP; Ptr to channel structure
783 Return: Word_t: The channel status. Can be any combination of
786 CTS_ACT: CTS input asserted
787 DSR_ACT: DSR input asserted
788 CD_ACT: CD input asserted
789 TXFIFOMT: Tx FIFO is empty
790 TXSHRMT: Tx shift register is empty
791 RDA: Rx data available
794 STATMODE: status mode enable bit
795 RXFOVERFL: receive FIFO overflow
796 RX2MATCH: receive compare byte 2 match
797 RX1MATCH: receive compare byte 1 match
798 RXBREAK: received BREAK
799 RXFRAME: received framing error
800 RXPARITY: received parity error
801 Warnings: This function will clear the high byte flags in the Channel
804 #define sGetChanStatus(ChP) sInW((ChP)->ChanStat)
806 /***************************************************************************
807 Function: sGetChanStatusLo
808 Purpose: Get the low byte only of the channel status
809 Call: sGetChanStatusLo(ChP)
810 CHANNEL_T *ChP; Ptr to channel structure
811 Return: Byte_t: The channel status low byte. Can be any combination
812 of the following flags:
813 CTS_ACT: CTS input asserted
814 DSR_ACT: DSR input asserted
815 CD_ACT: CD input asserted
816 TXFIFOMT: Tx FIFO is empty
817 TXSHRMT: Tx shift register is empty
818 RDA: Rx data available
820 #define sGetChanStatusLo(ChP) sInB((ByteIO_t)(ChP)->ChanStat)
822 /**********************************************************************
823 * Get RI status of channel
824 * Defined as a function in rocket.c -aes
827 #define sGetChanRI(ChP) ((ChP)->CtlP->AltChanRingIndicator ? \
828 (sInB((ByteIO_t)((ChP)->ChanStat+8)) & DSR_ACT) : \
829 (((ChP)->CtlP->boardType == ROCKET_TYPE_PC104) ? \
830 (!(sInB((ChP)->CtlP->AiopIO[3]) & sBitMapSetTbl[(ChP)->ChanNum])) : \
834 /***************************************************************************
835 Function: sGetControllerIntStatus
836 Purpose: Get the controller interrupt status
837 Call: sGetControllerIntStatus(CtlP)
838 CONTROLLER_T *CtlP; Ptr to controller structure
839 Return: Byte_t: The controller interrupt status in the lower 4
840 bits. Bits 0 through 3 represent AIOP's 0
841 through 3 respectively. If a bit is set that
842 AIOP is interrupting. Bits 4 through 7 will
845 #define sGetControllerIntStatus(CTLP) (sInB((CTLP)->MReg1IO) & 0x0f)
847 /***************************************************************************
848 Function: sPCIGetControllerIntStatus
849 Purpose: Get the controller interrupt status
850 Call: sPCIGetControllerIntStatus(CtlP)
851 CONTROLLER_T *CtlP; Ptr to controller structure
852 Return: unsigned char: The controller interrupt status in the lower 4
853 bits and bit 4. Bits 0 through 3 represent AIOP's 0
854 through 3 respectively. Bit 4 is set if the int
855 was generated from periodic. If a bit is set the
856 AIOP is interrupting.
858 #define sPCIGetControllerIntStatus(CTLP) \
860 (sInW((CTLP)->PCIIO2) & UPCI_AIOP_INTR_BITS) : \
861 ((sInW((CTLP)->PCIIO) >> 8) & AIOP_INTR_BITS))
863 /***************************************************************************
866 Purpose: Get the number of data bytes in the Rx FIFO
868 CHANNEL_T *ChP; Ptr to channel structure
869 Return: int: The number of data bytes in the Rx FIFO.
870 Comments: Byte read of count register is required to obtain Rx count.
873 #define sGetRxCnt(ChP) sInW((ChP)->TxRxCount)
875 /***************************************************************************
877 Purpose: Get the number of data bytes in the Tx FIFO
879 CHANNEL_T *ChP; Ptr to channel structure
880 Return: Byte_t: The number of data bytes in the Tx FIFO.
881 Comments: Byte read of count register is required to obtain Tx count.
884 #define sGetTxCnt(ChP) sInB((ByteIO_t)(ChP)->TxRxCount)
886 /*****************************************************************************
887 Function: sGetTxRxDataIO
888 Purpose: Get the I/O address of a channel's TxRx Data register
889 Call: sGetTxRxDataIO(ChP)
890 CHANNEL_T *ChP; Ptr to channel structure
891 Return: WordIO_t: I/O address of a channel's TxRx Data register
893 #define sGetTxRxDataIO(ChP) (ChP)->TxRxData
895 /***************************************************************************
896 Function: sInitChanDefaults
897 Purpose: Initialize a channel structure to it's default state.
898 Call: sInitChanDefaults(ChP)
899 CHANNEL_T *ChP; Ptr to the channel structure
900 Comments: This function must be called once for every channel structure
901 that exists before any other SSCI calls can be made.
904 #define sInitChanDefaults(ChP) \
906 (ChP)->CtlP = NULLCTLPTR; \
907 (ChP)->AiopNum = NULLAIOP; \
908 (ChP)->ChanID = AIOPID_NULL; \
909 (ChP)->ChanNum = NULLCHAN; \
912 /***************************************************************************
913 Function: sResetAiopByNum
914 Purpose: Reset the AIOP by number
915 Call: sResetAiopByNum(CTLP,AIOPNUM)
916 CONTROLLER_T CTLP; Ptr to controller structure
919 #define sResetAiopByNum(CTLP,AIOPNUM) \
921 sOutB((CTLP)->AiopIO[(AIOPNUM)]+_CMD_REG,RESET_ALL); \
922 sOutB((CTLP)->AiopIO[(AIOPNUM)]+_CMD_REG,0x0); \
925 /***************************************************************************
927 Purpose: Send a transmit BREAK signal
928 Call: sSendBreak(ChP)
929 CHANNEL_T *ChP; Ptr to channel structure
931 #define sSendBreak(ChP) \
933 (ChP)->TxControl[3] |= SETBREAK; \
934 sOutDW((ChP)->IndexAddr,*(DWord_t *)&(ChP)->TxControl[0]); \
937 /***************************************************************************
939 Purpose: Set baud rate
940 Call: sSetBaud(ChP,Divisor)
941 CHANNEL_T *ChP; Ptr to channel structure
942 Word_t Divisor; 16 bit baud rate divisor for channel
944 #define sSetBaud(ChP,DIVISOR) \
946 (ChP)->BaudDiv[2] = (Byte_t)(DIVISOR); \
947 (ChP)->BaudDiv[3] = (Byte_t)((DIVISOR) >> 8); \
948 sOutDW((ChP)->IndexAddr,*(DWord_t *)&(ChP)->BaudDiv[0]); \
951 /***************************************************************************
953 Purpose: Set data bits to 7
955 CHANNEL_T *ChP; Ptr to channel structure
957 #define sSetData7(ChP) \
959 (ChP)->TxControl[2] &= ~DATA8BIT; \
960 sOutDW((ChP)->IndexAddr,*(DWord_t *)&(ChP)->TxControl[0]); \
963 /***************************************************************************
965 Purpose: Set data bits to 8
967 CHANNEL_T *ChP; Ptr to channel structure
969 #define sSetData8(ChP) \
971 (ChP)->TxControl[2] |= DATA8BIT; \
972 sOutDW((ChP)->IndexAddr,*(DWord_t *)&(ChP)->TxControl[0]); \
975 /***************************************************************************
977 Purpose: Set the DTR output
979 CHANNEL_T *ChP; Ptr to channel structure
981 #define sSetDTR(ChP) \
983 (ChP)->TxControl[3] |= SET_DTR; \
984 sOutDW((ChP)->IndexAddr,*(DWord_t *)&(ChP)->TxControl[0]); \
987 /***************************************************************************
988 Function: sSetEvenParity
989 Purpose: Set even parity
990 Call: sSetEvenParity(ChP)
991 CHANNEL_T *ChP; Ptr to channel structure
992 Comments: Function sSetParity() can be used in place of functions sEnParity(),
993 sDisParity(), sSetOddParity(), and sSetEvenParity().
995 Warnings: This function has no effect unless parity is enabled with function
998 #define sSetEvenParity(ChP) \
1000 (ChP)->TxControl[2] |= EVEN_PAR; \
1001 sOutDW((ChP)->IndexAddr,*(DWord_t *)&(ChP)->TxControl[0]); \
1004 /***************************************************************************
1005 Function: sSetOddParity
1006 Purpose: Set odd parity
1007 Call: sSetOddParity(ChP)
1008 CHANNEL_T *ChP; Ptr to channel structure
1009 Comments: Function sSetParity() can be used in place of functions sEnParity(),
1010 sDisParity(), sSetOddParity(), and sSetEvenParity().
1012 Warnings: This function has no effect unless parity is enabled with function
1015 #define sSetOddParity(ChP) \
1017 (ChP)->TxControl[2] &= ~EVEN_PAR; \
1018 sOutDW((ChP)->IndexAddr,*(DWord_t *)&(ChP)->TxControl[0]); \
1021 /***************************************************************************
1023 Purpose: Set the RTS output
1025 CHANNEL_T *ChP; Ptr to channel structure
1027 #define sSetRTS(ChP) \
1029 if ((ChP)->rtsToggle) break; \
1030 (ChP)->TxControl[3] |= SET_RTS; \
1031 sOutDW((ChP)->IndexAddr,*(DWord_t *)&(ChP)->TxControl[0]); \
1034 /***************************************************************************
1035 Function: sSetRxTrigger
1036 Purpose: Set the Rx FIFO trigger level
1037 Call: sSetRxProcessor(ChP,Level)
1038 CHANNEL_T *ChP; Ptr to channel structure
1039 Byte_t Level; Number of characters in Rx FIFO at which the
1040 interrupt will be generated. Can be any of the following flags:
1043 TRIG_1: 1 character in FIFO
1044 TRIG_1_2: FIFO 1/2 full
1045 TRIG_7_8: FIFO 7/8 full
1046 Comments: An interrupt will be generated when the trigger level is reached
1047 only if function sEnInterrupt() has been called with flag
1048 RXINT_EN set. The RXF_TRIG flag in the Interrupt Idenfification
1049 register will be set whenever the trigger level is reached
1050 regardless of the setting of RXINT_EN.
1053 #define sSetRxTrigger(ChP,LEVEL) \
1055 (ChP)->RxControl[2] &= ~TRIG_MASK; \
1056 (ChP)->RxControl[2] |= LEVEL; \
1057 sOutDW((ChP)->IndexAddr,*(DWord_t *)&(ChP)->RxControl[0]); \
1060 /***************************************************************************
1062 Purpose: Set stop bits to 1
1063 Call: sSetStop1(ChP)
1064 CHANNEL_T *ChP; Ptr to channel structure
1066 #define sSetStop1(ChP) \
1068 (ChP)->TxControl[2] &= ~STOP2; \
1069 sOutDW((ChP)->IndexAddr,*(DWord_t *)&(ChP)->TxControl[0]); \
1072 /***************************************************************************
1074 Purpose: Set stop bits to 2
1075 Call: sSetStop2(ChP)
1076 CHANNEL_T *ChP; Ptr to channel structure
1078 #define sSetStop2(ChP) \
1080 (ChP)->TxControl[2] |= STOP2; \
1081 sOutDW((ChP)->IndexAddr,*(DWord_t *)&(ChP)->TxControl[0]); \
1084 /***************************************************************************
1085 Function: sSetTxXOFFChar
1086 Purpose: Set the Tx XOFF flow control character
1087 Call: sSetTxXOFFChar(ChP,Ch)
1088 CHANNEL_T *ChP; Ptr to channel structure
1089 Byte_t Ch; The value to set the Tx XOFF character to
1091 #define sSetTxXOFFChar(ChP,CH) \
1093 (ChP)->R[0x07] = (CH); \
1094 sOutDW((ChP)->IndexAddr,*(DWord_t *)&(ChP)->R[0x04]); \
1097 /***************************************************************************
1098 Function: sSetTxXONChar
1099 Purpose: Set the Tx XON flow control character
1100 Call: sSetTxXONChar(ChP,Ch)
1101 CHANNEL_T *ChP; Ptr to channel structure
1102 Byte_t Ch; The value to set the Tx XON character to
1104 #define sSetTxXONChar(ChP,CH) \
1106 (ChP)->R[0x0b] = (CH); \
1107 sOutDW((ChP)->IndexAddr,*(DWord_t *)&(ChP)->R[0x08]); \
1110 /***************************************************************************
1111 Function: sStartRxProcessor
1112 Purpose: Start a channel's receive processor
1113 Call: sStartRxProcessor(ChP)
1114 CHANNEL_T *ChP; Ptr to channel structure
1115 Comments: This function is used to start a Rx processor after it was
1116 stopped with sStopRxProcessor() or sStopSWInFlowCtl(). It
1117 will restart both the Rx processor and software input flow control.
1120 #define sStartRxProcessor(ChP) sOutDW((ChP)->IndexAddr,*(DWord_t *)&(ChP)->R[0])
1122 /***************************************************************************
1123 Function: sWriteTxByte
1124 Purpose: Write a transmit data byte to a channel.
1125 ByteIO_t io: Channel transmit register I/O address. This can
1126 be obtained with sGetTxRxDataIO().
1127 Byte_t Data; The transmit data byte.
1128 Warnings: This function writes the data byte without checking to see if
1129 sMaxTxSize is exceeded in the Tx FIFO.
1131 #define sWriteTxByte(IO,DATA) sOutB(IO,DATA)
1134 * Begin Linux specific definitions for the Rocketport driver
1136 * This code is Copyright Theodore Ts'o, 1995-1997
1145 struct tty_struct *tty;
1146 unsigned int board:3;
1147 unsigned int aiop:2;
1148 unsigned int chan:3;
1154 int xmit_fifo_room; /* room in xmit fifo */
1155 unsigned char *xmit_buf;
1162 int ignore_status_mask;
1163 int read_status_mask;
1166 #ifdef DECLARE_WAITQUEUE
1167 wait_queue_head_t open_wait;
1168 wait_queue_head_t close_wait;
1170 struct wait_queue *open_wait;
1171 struct wait_queue *close_wait;
1174 struct semaphore write_sem;
1177 #define RPORT_MAGIC 0x525001
1179 #define NUM_BOARDS 8
1180 #define MAX_RP_PORTS (32*NUM_BOARDS)
1183 * The size of the xmit buffer is 1 page, or 4096 bytes
1185 #define XMIT_BUF_SIZE 4096
1187 /* number of characters left in xmit buffer before we ask for more */
1188 #define WAKEUP_CHARS 256
1190 /* Internal flags used only by the rocketport driver */
1191 #define ROCKET_INITIALIZED 0x80000000 /* Port is active */
1192 #define ROCKET_CLOSING 0x40000000 /* Serial port is closing */
1193 #define ROCKET_NORMAL_ACTIVE 0x20000000 /* Normal port is active */
1196 #define SERIAL_TYPE_NORMAL 1
1199 * Assigned major numbers for the Comtrol Rocketport
1201 #define TTY_ROCKET_MAJOR 46
1202 #define CUA_ROCKET_MAJOR 47
1204 #ifdef PCI_VENDOR_ID_RP
1205 #undef PCI_VENDOR_ID_RP
1206 #undef PCI_DEVICE_ID_RP8OCTA
1207 #undef PCI_DEVICE_ID_RP8INTF
1208 #undef PCI_DEVICE_ID_RP16INTF
1209 #undef PCI_DEVICE_ID_RP32INTF
1210 #undef PCI_DEVICE_ID_URP8OCTA
1211 #undef PCI_DEVICE_ID_URP8INTF
1212 #undef PCI_DEVICE_ID_URP16INTF
1213 #undef PCI_DEVICE_ID_CRP16INTF
1214 #undef PCI_DEVICE_ID_URP32INTF
1217 /* Comtrol PCI Vendor ID */
1218 #define PCI_VENDOR_ID_RP 0x11fe
1220 /* Comtrol Device ID's */
1221 #define PCI_DEVICE_ID_RP32INTF 0x0001 /* Rocketport 32 port w/external I/F */
1222 #define PCI_DEVICE_ID_RP8INTF 0x0002 /* Rocketport 8 port w/external I/F */
1223 #define PCI_DEVICE_ID_RP16INTF 0x0003 /* Rocketport 16 port w/external I/F */
1224 #define PCI_DEVICE_ID_RP4QUAD 0x0004 /* Rocketport 4 port w/quad cable */
1225 #define PCI_DEVICE_ID_RP8OCTA 0x0005 /* Rocketport 8 port w/octa cable */
1226 #define PCI_DEVICE_ID_RP8J 0x0006 /* Rocketport 8 port w/RJ11 connectors */
1227 #define PCI_DEVICE_ID_RP4J 0x0007 /* Rocketport 4 port w/RJ11 connectors */
1228 #define PCI_DEVICE_ID_RP8SNI 0x0008 /* Rocketport 8 port w/ DB78 SNI (Siemens) connector */
1229 #define PCI_DEVICE_ID_RP16SNI 0x0009 /* Rocketport 16 port w/ DB78 SNI (Siemens) connector */
1230 #define PCI_DEVICE_ID_RPP4 0x000A /* Rocketport Plus 4 port */
1231 #define PCI_DEVICE_ID_RPP8 0x000B /* Rocketport Plus 8 port */
1232 #define PCI_DEVICE_ID_RP6M 0x000C /* RocketModem 6 port */
1233 #define PCI_DEVICE_ID_RP4M 0x000D /* RocketModem 4 port */
1234 #define PCI_DEVICE_ID_RP2_232 0x000E /* Rocketport Plus 2 port RS232 */
1235 #define PCI_DEVICE_ID_RP2_422 0x000F /* Rocketport Plus 2 port RS422 */
1237 /* Universal PCI boards */
1238 #define PCI_DEVICE_ID_URP32INTF 0x0801 /* Rocketport UPCI 32 port w/external I/F */
1239 #define PCI_DEVICE_ID_URP8INTF 0x0802 /* Rocketport UPCI 8 port w/external I/F */
1240 #define PCI_DEVICE_ID_URP16INTF 0x0803 /* Rocketport UPCI 16 port w/external I/F */
1241 #define PCI_DEVICE_ID_URP8OCTA 0x0805 /* Rocketport UPCI 8 port w/octa cable */
1242 #define PCI_DEVICE_ID_UPCI_RM3_8PORT 0x080C /* Rocketmodem III 8 port */
1243 #define PCI_DEVICE_ID_UPCI_RM3_4PORT 0x080D /* Rocketmodem III 4 port */
1245 /* Compact PCI device */
1246 #define PCI_DEVICE_ID_CRP16INTF 0x0903 /* Rocketport Compact PCI 16 port w/external I/F */
1248 #define TTY_GET_LINE(t) t->index
1249 #define TTY_DRIVER_MINOR_START(t) t->driver->minor_start
1250 #define TTY_DRIVER_SUBTYPE(t) t->driver->subtype
1251 #define TTY_DRIVER_NAME(t) t->driver->name
1252 #define TTY_DRIVER_NAME_BASE(t) t->driver->name_base
1253 #define TTY_DRIVER_FLUSH_BUFFER_EXISTS(t) t->driver->flush_buffer
1254 #define TTY_DRIVER_FLUSH_BUFFER(t) t->driver->flush_buffer(t)