2 * Copyright (c) Comtrol Corporation <support@comtrol.com>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted prodived that the follwoing conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notive, this list of conditions and the following disclainer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials prodided with the distribution.
13 * 3. All advertising materials mentioning features or use of this software
14 * must display the following acknowledgement:
15 * This product includes software developed by Comtrol Corporation.
16 * 4. The name of Comtrol Corporation may not be used to endorse or
17 * promote products derived from this software without specific
18 * prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY COMTROL CORPORATION ``AS IS'' AND ANY
21 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL COMTROL CORPORATION BE LIABLE FOR
24 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, LIFE OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 * Begin OS-specific defines - rpreg.h - for RocketPort FreeBSD
39 typedef uint8_t Byte_t;
40 typedef uint8_t ByteIO_t;
42 typedef uint16_t Word_t;
43 typedef uint16_t WordIO_t;
45 typedef uint32_t DWord_t;
46 typedef uint32_t DWordIO_t;
48 #define rp_readio(size, ctlp, rid, offset) \
49 (bus_read_##size(ctlp->io[rid], offset))
50 #define rp_readmultiio(size, ctlp, rid, offset, addr, count) \
51 (bus_read_multi_##size(ctlp->io[rid], offset, addr, count))
52 #define rp_writeio(size, ctlp, rid, offset, data) \
53 (bus_write_##size(ctlp->io[rid], offset, data))
54 #define rp_writemultiio(size, ctlp, rid, offset, addr, count) \
55 (bus_write_multi_##size(ctlp->io[rid], offset, addr, count))
57 #define rp_readio1(ctlp, rid, offset) rp_readio(1, ctlp, rid, offset)
58 #define rp_readio2(ctlp, rid, offset) rp_readio(2, ctlp, rid, offset)
59 #define rp_readio4(ctlp, rid, offset) rp_readio(4, ctlp, rid, offset)
60 #define rp_writeio1(ctlp, rid, offset, data) rp_writeio(1, ctlp, rid, offset, data)
61 #define rp_writeio2(ctlp, rid, offset, data) rp_writeio(2, ctlp, rid, offset, data)
62 #define rp_writeio4(ctlp, rid, offset, data) rp_writeio(4, ctlp, rid, offset, data)
63 #define rp_readmultiio1(ctlp, rid, offset, addr, count) rp_readmultiio(1, ctlp, rid, offset, addr, count)
64 #define rp_readmultiio2(ctlp, rid, offset, addr, count) rp_readmultiio(2, ctlp, rid, offset, addr, count)
65 #define rp_readmultiio4(ctlp, rid, offset, addr, count) rp_readmultiio(4, ctlp, rid, offset, addr, count)
66 #define rp_writemultiio1(ctlp, rid, offset, addr, count) rp_writemultiio(1, ctlp, rid, offset, addr, count)
67 #define rp_writemultiio2(ctlp, rid, offset, addr, count) rp_writemultiio(2, ctlp, rid, offset, addr, count)
68 #define rp_writemultiio4(ctlp, rid, offset, addr, count) rp_writemultiio(4, ctlp, rid, offset, addr, count)
70 #define rp_readaiop1(ctlp, aiop, offset) \
71 (rp_readio1((ctlp), (ctlp)->aiop2rid(aiop, offset), (ctlp)->aiop2off(aiop, offset)))
72 #define rp_readaiop2(ctlp, aiop, offset) \
73 (rp_readio2((ctlp), (ctlp)->aiop2rid(aiop, offset), (ctlp)->aiop2off(aiop, offset)))
74 #define rp_readaiop4(ctlp, aiop, offset) \
75 (rp_readio4((ctlp), (ctlp)->aiop2rid(aiop, offset), (ctlp)->aiop2off(aiop, offset)))
76 #define rp_readmultiaiop1(ctlp, aiop, offset, addr, count) \
77 (rp_readmultiio1((ctlp), (ctlp)->aiop2rid(aiop, offset), (ctlp)->aiop2off(aiop, offset), addr, count))
78 #define rp_readmultiaiop2(ctlp, aiop, offset, addr, count) \
79 (rp_readmultiio2((ctlp), (ctlp)->aiop2rid(aiop, offset), (ctlp)->aiop2off(aiop, offset), addr, count))
80 #define rp_readmultiaiop4(ctlp, aiop, offset, addr, count) \
81 (rp_readmultiio4((ctlp), (ctlp)->aiop2rid(aiop, offset), (ctlp)->aiop2off(aiop, offset), addr, count))
82 #define rp_writeaiop1(ctlp, aiop, offset, data) \
83 (rp_writeio1((ctlp), (ctlp)->aiop2rid(aiop, offset), (ctlp)->aiop2off(aiop, offset), data))
84 #define rp_writeaiop2(ctlp, aiop, offset, data) \
85 (rp_writeio2((ctlp), (ctlp)->aiop2rid(aiop, offset), (ctlp)->aiop2off(aiop, offset), data))
86 #define rp_writeaiop4(ctlp, aiop, offset, data) \
87 (rp_writeio4((ctlp), (ctlp)->aiop2rid(aiop, offset), (ctlp)->aiop2off(aiop, offset), data))
88 #define rp_writemultiaiop1(ctlp, aiop, offset, addr, count) \
89 (rp_writemultiio1((ctlp), (ctlp)->aiop2rid(aiop, offset), (ctlp)->aiop2off(aiop, offset), addr, count))
90 #define rp_writemultiaiop2(ctlp, aiop, offset, addr, count) \
91 (rp_writemultiio2((ctlp), (ctlp)->aiop2rid(aiop, offset), (ctlp)->aiop2off(aiop, offset), addr, count))
92 #define rp_writemultiaiop4(ctlp, aiop, offset, addr, count) \
93 (rp_writemultiio4((ctlp), (ctlp)->aiop2rid(aiop, offset), (ctlp)->aiop2off(aiop, offset), addr, count))
95 #define rp_readch1(chp, offset) \
96 (rp_readaiop1((chp)->CtlP, (chp)->AiopNum, offset))
97 #define rp_readch2(chp, offset) \
98 (rp_readaiop2((chp)->CtlP, (chp)->AiopNum, offset))
99 #define rp_readch4(chp, offset) \
100 (rp_readaiop4((chp)->CtlP, (chp)->AiopNum, offset))
101 #define rp_readmultich1(chp, offset, addr, count) \
102 (rp_readmultiaiop1((chp)->CtlP, (chp)->AiopNum, offset, addr, count))
103 #define rp_readmultich2(chp, offset, addr, count) \
104 (rp_readmultiaiop2((chp)->CtlP, (chp)->AiopNum, offset, addr, count))
105 #define rp_readmultich4(chp, offset, addr, count) \
106 (rp_readmultiaiop4((chp)->CtlP, (chp)->AiopNum, offset, addr, count))
107 #define rp_writech1(chp, offset, data) \
108 (rp_writeaiop1((chp)->CtlP, (chp)->AiopNum, offset, data))
109 #define rp_writech2(chp, offset, data) \
110 (rp_writeaiop2((chp)->CtlP, (chp)->AiopNum, offset, data))
111 #define rp_writech4(chp, offset, data) \
112 (rp_writeaiop4((chp)->CtlP, (chp)->AiopNum, offset, data))
113 #define rp_writemultich1(chp, offset, addr, count) \
114 (rp_writemultiaiop1((chp)->CtlP, (chp)->AiopNum, offset, addr, count))
115 #define rp_writemultich2(chp, offset, addr, count) \
116 (rp_writemultiaiop2((chp)->CtlP, (chp)->AiopNum, offset, addr, count))
117 #define rp_writemultich4(chp, offset, addr, count) \
118 (rp_writemultiaiop4((chp)->CtlP, (chp)->AiopNum, offset, addr, count))
121 * End of OS-specific defines
127 #define AIOP_CTL_SIZE 4
128 #define CHAN_AIOP_SIZE 8
129 #define MAX_PORTS_PER_AIOP 8
130 #define MAX_AIOPS_PER_BOARD 4
131 #define MAX_PORTS_PER_BOARD 32
133 /* Controller ID numbers */
134 #define CTLID_NULL -1 /* no controller exists */
135 #define CTLID_0001 0x0001 /* controller release 1 */
137 /* AIOP ID numbers, identifies AIOP type implementing channel */
138 #define AIOPID_NULL -1 /* no AIOP or channel exists */
139 #define AIOPID_0001 0x0001 /* AIOP release 1 */
141 #define NULLDEV -1 /* identifies non-existant device */
142 #define NULLCTL -1 /* identifies non-existant controller */
143 #define NULLCTLPTR (CONTROLLER_T *)0 /* identifies non-existant controller */
144 #define NULLAIOP -1 /* identifies non-existant AIOP */
145 #define NULLCHAN -1 /* identifies non-existant channel */
147 /************************************************************************
148 Global Register Offsets - Direct Access - Fixed values
149 ************************************************************************/
151 #define _CMD_REG 0x38 /* Command Register 8 Write */
152 #define _INT_CHAN 0x39 /* Interrupt Channel Register 8 Read */
153 #define _INT_MASK 0x3A /* Interrupt Mask Register 8 Read / Write */
154 #define _UNUSED 0x3B /* Unused 8 */
155 #define _INDX_ADDR 0x3C /* Index Register Address 16 Write */
156 #define _INDX_DATA 0x3E /* Index Register Data 8/16 Read / Write */
158 /************************************************************************
159 Channel Register Offsets for 1st channel in AIOP - Direct Access
160 ************************************************************************/
161 #define _TD0 0x00 /* Transmit Data 16 Write */
162 #define _RD0 0x00 /* Receive Data 16 Read */
163 #define _CHN_STAT0 0x20 /* Channel Status 8/16 Read / Write */
164 #define _FIFO_CNT0 0x10 /* Transmit/Receive FIFO Count 16 Read */
165 #define _INT_ID0 0x30 /* Interrupt Identification 8 Read */
167 /************************************************************************
168 Tx Control Register Offsets - Indexed - External - Fixed
169 ************************************************************************/
170 #define _TX_ENBLS 0x980 /* Tx Processor Enables Register 8 Read / Write */
171 #define _TXCMP1 0x988 /* Transmit Compare Value #1 8 Read / Write */
172 #define _TXCMP2 0x989 /* Transmit Compare Value #2 8 Read / Write */
173 #define _TXREP1B1 0x98A /* Tx Replace Value #1 - Byte 1 8 Read / Write */
174 #define _TXREP1B2 0x98B /* Tx Replace Value #1 - Byte 2 8 Read / Write */
175 #define _TXREP2 0x98C /* Transmit Replace Value #2 8 Read / Write */
177 /************************************************************************
179 ************************************************************************/
180 #define RXFIFO_DATA 0x5f
181 #define RXFIFO_OUT 0x5c
182 #define RXFIFO_EN 0x08
183 #define RXFIFO_DIS 0xa7
185 /************************************************************************
186 Memory Controller Register Offsets - Indexed - External - Fixed
187 ************************************************************************/
188 #define _RX_FIFO 0x000 /* Rx FIFO */
189 #define _TX_FIFO 0x800 /* Tx FIFO */
190 #define _RXF_OUTP 0x990 /* Rx FIFO OUT pointer 16 Read / Write */
191 #define _RXF_INP 0x992 /* Rx FIFO IN pointer 16 Read / Write */
192 #define _TXF_OUTP 0x994 /* Tx FIFO OUT pointer 8 Read / Write */
193 #define _TXF_INP 0x995 /* Tx FIFO IN pointer 8 Read / Write */
194 #define _TXP_CNT 0x996 /* Tx Priority Count 8 Read / Write */
195 #define _TXP_PNTR 0x997 /* Tx Priority Pointer 8 Read / Write */
197 #define PRI_PEND 0x80 /* Priority data pending (bit7, Tx pri cnt) */
198 #define TXFIFO_SIZE 255 /* size of Tx FIFO */
199 #define RXFIFO_SIZE 1023 /* size of Rx FIFO */
201 /************************************************************************
202 Tx Priority Buffer - Indexed - External - Fixed
203 ************************************************************************/
204 #define _TXP_BUF 0x9C0 /* Tx Priority Buffer 32 Bytes Read / Write */
205 #define TXP_SIZE 0x20 /* 32 bytes */
207 /************************************************************************
208 Channel Register Offsets - Indexed - Internal - Fixed
209 ************************************************************************/
211 #define _TX_CTRL 0xFF0 /* Transmit Control 16 Write */
212 #define _RX_CTRL 0xFF2 /* Receive Control 8 Write */
213 #define _BAUD 0xFF4 /* Baud Rate 16 Write */
214 #define _CLK_PRE 0xFF6 /* Clock Prescaler 8 Write */
216 #define CLOCK_PRESC 0x19 /* mod 9 (divide by 10) prescale */
242 #define STMBREAK 0x08 /* BREAK */
243 #define STMFRAME 0x04 /* framing error */
244 #define STMRCVROVR 0x02 /* receiver over run error */
245 #define STMPARITY 0x01 /* parity error */
246 #define STMERROR (STMBREAK | STMFRAME | STMPARITY)
247 #define STMBREAKH 0x800 /* BREAK */
248 #define STMFRAMEH 0x400 /* framing error */
249 #define STMRCVROVRH 0x200 /* receiver over run error */
250 #define STMPARITYH 0x100 /* parity error */
251 #define STMERRORH (STMBREAKH | STMFRAMEH | STMPARITYH)
253 #define CTS_ACT 0x20 /* CTS input asserted */
254 #define DSR_ACT 0x10 /* DSR input asserted */
255 #define CD_ACT 0x08 /* CD input asserted */
256 #define TXFIFOMT 0x04 /* Tx FIFO is empty */
257 #define TXSHRMT 0x02 /* Tx shift register is empty */
258 #define RDA 0x01 /* Rx data available */
259 #define DRAINED (TXFIFOMT | TXSHRMT) /* indicates Tx is drained */
261 #define STATMODE 0x8000 /* status mode enable bit */
262 #define RXFOVERFL 0x2000 /* receive FIFO overflow */
263 #define RX2MATCH 0x1000 /* receive compare byte 2 match */
264 #define RX1MATCH 0x0800 /* receive compare byte 1 match */
265 #define RXBREAK 0x0400 /* received BREAK */
266 #define RXFRAME 0x0200 /* received framing error */
267 #define RXPARITY 0x0100 /* received parity error */
268 #define STATERROR (RXBREAK | RXFRAME | RXPARITY)
270 #define CTSFC_EN 0x80 /* CTS flow control enable bit */
271 #define RTSTOG_EN 0x40 /* RTS toggle enable bit */
272 #define TXINT_EN 0x10 /* transmit interrupt enable */
273 #define STOP2 0x08 /* enable 2 stop bits (0 = 1 stop) */
274 #define PARITY_EN 0x04 /* enable parity (0 = no parity) */
275 #define EVEN_PAR 0x02 /* even parity (0 = odd parity) */
276 #define DATA8BIT 0x01 /* 8 bit data (0 = 7 bit data) */
278 #define SETBREAK 0x10 /* send break condition (must clear) */
279 #define LOCALLOOP 0x08 /* local loopback set for test */
280 #define SET_DTR 0x04 /* assert DTR */
281 #define SET_RTS 0x02 /* assert RTS */
282 #define TX_ENABLE 0x01 /* enable transmitter */
284 #define RTSFC_EN 0x40 /* RTS flow control enable */
285 #define RXPROC_EN 0x20 /* receive processor enable */
286 #define TRIG_NO 0x00 /* Rx FIFO trigger level 0 (no trigger) */
287 #define TRIG_1 0x08 /* trigger level 1 char */
288 #define TRIG_1_2 0x10 /* trigger level 1/2 */
289 #define TRIG_7_8 0x18 /* trigger level 7/8 */
290 #define TRIG_MASK 0x18 /* trigger level mask */
291 #define SRCINT_EN 0x04 /* special Rx condition interrupt enable */
292 #define RXINT_EN 0x02 /* Rx interrupt enable */
293 #define MCINT_EN 0x01 /* modem change interrupt enable */
295 #define RXF_TRIG 0x20 /* Rx FIFO trigger level interrupt */
296 #define TXFIFO_MT 0x10 /* Tx FIFO empty interrupt */
297 #define SRC_INT 0x08 /* special receive condition interrupt */
298 #define DELTA_CD 0x04 /* CD change interrupt */
299 #define DELTA_CTS 0x02 /* CTS change interrupt */
300 #define DELTA_DSR 0x01 /* DSR change interrupt */
302 #define REP1W2_EN 0x10 /* replace byte 1 with 2 bytes enable */
303 #define IGN2_EN 0x08 /* ignore byte 2 enable */
304 #define IGN1_EN 0x04 /* ignore byte 1 enable */
305 #define COMP2_EN 0x02 /* compare byte 2 enable */
306 #define COMP1_EN 0x01 /* compare byte 1 enable */
308 #define RESET_ALL 0x80 /* reset AIOP (all channels) */
309 #define TXOVERIDE 0x40 /* Transmit software off override */
310 #define RESETUART 0x20 /* reset channel's UART */
311 #define RESTXFCNT 0x10 /* reset channel's Tx FIFO count register */
312 #define RESRXFCNT 0x08 /* reset channel's Rx FIFO count register */
314 #define INTSTAT0 0x01 /* AIOP 0 interrupt status */
315 #define INTSTAT1 0x02 /* AIOP 1 interrupt status */
316 #define INTSTAT2 0x04 /* AIOP 2 interrupt status */
317 #define INTSTAT3 0x08 /* AIOP 3 interrupt status */
319 #define INTR_EN 0x08 /* allow interrupts to host */
320 #define INT_STROB 0x04 /* strobe and clear interrupt line (EOI) */
322 #define CHAN3_EN 0x08 /* enable AIOP 3 */
323 #define CHAN2_EN 0x04 /* enable AIOP 2 */
324 #define CHAN1_EN 0x02 /* enable AIOP 1 */
325 #define CHAN0_EN 0x01 /* enable AIOP 0 */
326 #define FREQ_DIS 0x00
327 #define FREQ_274HZ 0x60
328 #define FREQ_137HZ 0x50
329 #define FREQ_69HZ 0x40
330 #define FREQ_34HZ 0x30
331 #define FREQ_17HZ 0x20
332 #define FREQ_9HZ 0x10
333 #define PERIODIC_ONLY 0x80 /* only PERIODIC interrupt */
335 #define CHANINT_EN 0x0100 /* flags to enable/disable channel ints */
338 #define RREGDATASIZE 52
348 struct CONTROLLER_str;
351 /* The types of bus-specific methods */
352 typedef int rp_aiop2rid_t(int, int);
353 typedef int rp_aiop2off_t(int, int);
354 typedef unsigned char rp_ctlmask_t(struct CONTROLLER_str *);
356 /* Controller level information structure */
357 struct CONTROLLER_str
361 int AiopID[AIOP_CTL_SIZE];
362 int AiopNumChan[AIOP_CTL_SIZE];
364 struct mtx hwmtx; /* Spinlock protecting hardware. */
368 /* Device and resource management */
369 device_t dev; /* device */
370 int io_num; /* Number of IO resources */
371 int *io_rid; /* IO resource IDs */
372 struct resource **io; /* IO resources */
374 struct rp_port *rp; /* port */
377 struct cdev **dev_nodes;
379 /* Bus-specific properties */
382 /* Bus-specific methods */
383 rp_aiop2rid_t *aiop2rid; /* (aiop, offset) -> rid */
384 rp_aiop2off_t *aiop2off; /* (aiop, offset) -> off */
385 rp_ctlmask_t *ctlmask; /* Int status */
387 typedef struct CONTROLLER_str CONTROLLER_T;
388 typedef CONTROLLER_T CONTROLLER_t;
390 /* Channel level information structure */
406 Byte_t R[RREGDATASIZE];
413 Byte_t TxReplace1[4];
414 Byte_t TxReplace2[4];
417 typedef struct CHANNEL_str CHANNEL_T;
418 typedef CHANNEL_T CHANNEL_t;
419 typedef CHANNEL_T * CHANPTR_T;
421 #define CHNOFF_TXRXDATA(chp) ((chp)->ChanNum * 2 + _TD0)
422 #define CHNOFF_CHANSTAT(chp) ((chp)->ChanNum * 2 + _CHN_STAT0)
423 #define CHNOFF_TXRXCOUNT(chp) ((chp)->ChanNum * 2 + _FIFO_CNT0)
424 #define CHNOFF_INTID(chp) ((chp)->ChanNum + _INT_ID0)
426 /***************************************************************************
428 Purpose: Stop sending a transmit BREAK signal
430 CHANNEL_T *ChP; Ptr to channel structure
432 #define sClrBreak(ChP) \
434 (ChP)->TxControl[3] &= ~SETBREAK; \
435 rp_writech4(ChP,_INDX_ADDR,le32dec((ChP)->TxControl)); \
438 /***************************************************************************
440 Purpose: Clr the DTR output
442 CHANNEL_T *ChP; Ptr to channel structure
444 #define sClrDTR(ChP) \
446 (ChP)->TxControl[3] &= ~SET_DTR; \
447 rp_writech4(ChP,_INDX_ADDR,le32dec((ChP)->TxControl)); \
450 /***************************************************************************
452 Purpose: Clr the RTS output
454 CHANNEL_T *ChP; Ptr to channel structure
456 #define sClrRTS(ChP) \
458 (ChP)->TxControl[3] &= ~SET_RTS; \
459 rp_writech4(ChP,_INDX_ADDR,le32dec((ChP)->TxControl)); \
462 /***************************************************************************
464 Purpose: Clear any existing transmit software flow control off condition
465 Call: sClrTxXOFF(ChP)
466 CHANNEL_T *ChP; Ptr to channel structure
468 #define sClrTxXOFF(ChP) \
470 rp_writech1(ChP,_CMD_REG,TXOVERIDE | (Byte_t)(ChP)->ChanNum); \
471 rp_writech1(ChP,_CMD_REG,(Byte_t)(ChP)->ChanNum); \
474 /***************************************************************************
475 Function: sDisCTSFlowCtl
476 Purpose: Disable output flow control using CTS
477 Call: sDisCTSFlowCtl(ChP)
478 CHANNEL_T *ChP; Ptr to channel structure
480 #define sDisCTSFlowCtl(ChP) \
482 (ChP)->TxControl[2] &= ~CTSFC_EN; \
483 rp_writech4(ChP,_INDX_ADDR,le32dec((ChP)->TxControl)); \
486 /***************************************************************************
488 Purpose: Disable parity
489 Call: sDisParity(ChP)
490 CHANNEL_T *ChP; Ptr to channel structure
491 Comments: Function sSetParity() can be used in place of functions sEnParity(),
492 sDisParity(), sSetOddParity(), and sSetEvenParity().
494 #define sDisParity(ChP) \
496 (ChP)->TxControl[2] &= ~PARITY_EN; \
497 rp_writech4(ChP,_INDX_ADDR,le32dec((ChP)->TxControl)); \
500 /***************************************************************************
502 Purpose: Disable Rx FIFO
503 Call: sDisRxFIFO(ChP)
504 CHANNEL_T *ChP; Ptr to channel structure
506 #define sDisRxFIFO(ChP) \
508 (ChP)->R[0x32] = 0x0a; \
509 rp_writech4(ChP,_INDX_ADDR,le32dec((ChP)->R + 0x30)); \
512 /***************************************************************************
513 Function: sDisRxStatusMode
514 Purpose: Disable the Rx status mode
515 Call: sDisRxStatusMode(ChP)
516 CHANNEL_T *ChP; Ptr to channel structure
517 Comments: This takes the channel out of the receive status mode. All
518 subsequent reads of receive data using sReadRxWord() will return
521 #define sDisRxStatusMode(ChP) rp_writech2(ChP,CHNOFF_CHANSTAT(ChP),0)
523 /***************************************************************************
524 Function: sDisTransmit
525 Purpose: Disable transmit
526 Call: sDisTransmit(ChP)
527 CHANNEL_T *ChP; Ptr to channel structure
528 This disables movement of Tx data from the Tx FIFO into the 1 byte
529 Tx buffer. Therefore there could be up to a 2 byte latency
530 between the time sDisTransmit() is called and the transmit buffer
531 and transmit shift register going completely empty.
533 #define sDisTransmit(ChP) \
535 (ChP)->TxControl[3] &= ~TX_ENABLE; \
536 rp_writech4(ChP,_INDX_ADDR,le32dec((ChP)->TxControl)); \
539 /***************************************************************************
540 Function: sDisTxSoftFlowCtl
541 Purpose: Disable Tx Software Flow Control
542 Call: sDisTxSoftFlowCtl(ChP)
543 CHANNEL_T *ChP; Ptr to channel structure
545 #define sDisTxSoftFlowCtl(ChP) \
547 (ChP)->R[0x06] = 0x8a; \
548 rp_writech4(ChP,_INDX_ADDR,le32dec((ChP)->R + 0x04)); \
551 /***************************************************************************
552 Function: sEnCTSFlowCtl
553 Purpose: Enable output flow control using CTS
554 Call: sEnCTSFlowCtl(ChP)
555 CHANNEL_T *ChP; Ptr to channel structure
557 #define sEnCTSFlowCtl(ChP) \
559 (ChP)->TxControl[2] |= CTSFC_EN; \
560 rp_writech4(ChP,_INDX_ADDR,le32dec((ChP)->TxControl)); \
563 /***************************************************************************
565 Purpose: Enable parity
567 CHANNEL_T *ChP; Ptr to channel structure
568 Comments: Function sSetParity() can be used in place of functions sEnParity(),
569 sDisParity(), sSetOddParity(), and sSetEvenParity().
571 Warnings: Before enabling parity odd or even parity should be chosen using
572 functions sSetOddParity() or sSetEvenParity().
574 #define sEnParity(ChP) \
576 (ChP)->TxControl[2] |= PARITY_EN; \
577 rp_writech4(ChP,_INDX_ADDR,le32dec((ChP)->TxControl)); \
580 /***************************************************************************
581 Function: sEnRTSFlowCtl
584 #define sEnRTSFlowCtl(ChP) \
586 (ChP)->TxControl[2] &= ~RTSTOG_EN; \
587 (ChP)->TxControl[3] &= ~SET_RTS; \
588 rp_writech4(ChP,_INDX_ADDR,le32dec((ChP)->TxControl)); \
589 (ChP)->RxControl[2] |= RTSFC_EN; \
590 rp_writech4(ChP,_INDX_ADDR,le32dec((ChP)->RxControl)); \
593 /***************************************************************************
594 Function: sDisRTSFlowCtl
597 #define sDisRTSFlowCtl(ChP) \
599 (ChP)->RxControl[2] &= ~RTSFC_EN; \
600 rp_writech4(ChP,_INDX_ADDR,le32dec((ChP)->RxControl)); \
603 /***************************************************************************
605 Purpose: Enable Rx FIFO
607 CHANNEL_T *ChP; Ptr to channel structure
609 #define sEnRxFIFO(ChP) \
611 (ChP)->R[0x32] = 0x08; \
612 rp_writech4(ChP,_INDX_ADDR,le32dec((ChP)->R + 0x30)); \
615 /***************************************************************************
616 Function: sEnRxProcessor
617 Purpose: Enable the receive processor
618 Call: sEnRxProcessor(ChP)
619 CHANNEL_T *ChP; Ptr to channel structure
620 Comments: This function is used to start the receive processor. When
621 the channel is in the reset state the receive processor is not
622 running. This is done to prevent the receive processor from
623 executing invalid microcode instructions prior to the
624 downloading of the microcode.
626 Warnings: This function must be called after valid microcode has been
627 downloaded to the AIOP, and it must not be called before the
628 microcode has been downloaded.
630 #define sEnRxProcessor(ChP) \
632 (ChP)->RxControl[2] |= RXPROC_EN; \
633 rp_writech4(ChP,_INDX_ADDR,le32dec((ChP)->RxControl)); \
636 /***************************************************************************
637 Function: sEnRxStatusMode
638 Purpose: Enable the Rx status mode
639 Call: sEnRxStatusMode(ChP)
640 CHANNEL_T *ChP; Ptr to channel structure
641 Comments: This places the channel in the receive status mode. All subsequent
642 reads of receive data using sReadRxWord() will return a data byte
643 in the low word and a status byte in the high word.
646 #define sEnRxStatusMode(ChP) rp_writech2(ChP,CHNOFF_CHANSTAT(ChP),STATMODE)
648 /***************************************************************************
649 Function: sEnTransmit
650 Purpose: Enable transmit
651 Call: sEnTransmit(ChP)
652 CHANNEL_T *ChP; Ptr to channel structure
654 #define sEnTransmit(ChP) \
656 (ChP)->TxControl[3] |= TX_ENABLE; \
657 rp_writech4(ChP,_INDX_ADDR,le32dec((ChP)->TxControl)); \
660 /***************************************************************************
661 Function: sGetAiopIntStatus
662 Purpose: Get the AIOP interrupt status
663 Call: sGetAiopIntStatus(CtlP,AiopNum)
664 CONTROLLER_T *CtlP; Ptr to controller structure
665 int AiopNum; AIOP number
666 Return: Byte_t: The AIOP interrupt status. Bits 0 through 7
667 represent channels 0 through 7 respectively. If a
668 bit is set that channel is interrupting.
670 #define sGetAiopIntStatus(CtlP,AIOPNUM) rp_readaiop1(CtlP,AIOPNUM,_INT_CHAN)
672 /***************************************************************************
673 Function: sGetAiopNumChan
674 Purpose: Get the number of channels supported by an AIOP
675 Call: sGetAiopNumChan(CtlP,AiopNum)
676 CONTROLLER_T *CtlP; Ptr to controller structure
677 int AiopNum; AIOP number
678 Return: int: The number of channels supported by the AIOP
680 #define sGetAiopNumChan(CtlP,AIOPNUM) CtlP->AiopNumChan[AIOPNUM]
682 /***************************************************************************
683 Function: sGetChanIntID
684 Purpose: Get a channel's interrupt identification byte
685 Call: sGetChanIntID(ChP)
686 CHANNEL_T *ChP; Ptr to channel structure
687 Return: Byte_t: The channel interrupt ID. Can be any
688 combination of the following flags:
689 RXF_TRIG: Rx FIFO trigger level interrupt
690 TXFIFO_MT: Tx FIFO empty interrupt
691 SRC_INT: Special receive condition interrupt
692 DELTA_CD: CD change interrupt
693 DELTA_CTS: CTS change interrupt
694 DELTA_DSR: DSR change interrupt
696 #define sGetChanIntID(ChP) (rp_readch1(ChP,(ChP)->ChanNum+_INT_ID0) & (RXF_TRIG | TXFIFO_MT | SRC_INT | DELTA_CD | DELTA_CTS | DELTA_DSR))
698 /***************************************************************************
699 Function: sGetChanNum
700 Purpose: Get the number of a channel within an AIOP
701 Call: sGetChanNum(ChP)
702 CHANNEL_T *ChP; Ptr to channel structure
703 Return: int: Channel number within AIOP, or NULLCHAN if channel does
706 #define sGetChanNum(ChP) (ChP)->ChanNum
708 /***************************************************************************
709 Function: sGetChanStatus
710 Purpose: Get the channel status
711 Call: sGetChanStatus(ChP)
712 CHANNEL_T *ChP; Ptr to channel structure
713 Return: Word_t: The channel status. Can be any combination of
716 CTS_ACT: CTS input asserted
717 DSR_ACT: DSR input asserted
718 CD_ACT: CD input asserted
719 TXFIFOMT: Tx FIFO is empty
720 TXSHRMT: Tx shift register is empty
721 RDA: Rx data available
724 STATMODE: status mode enable bit
725 RXFOVERFL: receive FIFO overflow
726 RX2MATCH: receive compare byte 2 match
727 RX1MATCH: receive compare byte 1 match
728 RXBREAK: received BREAK
729 RXFRAME: received framing error
730 RXPARITY: received parity error
731 Warnings: This function will clear the high byte flags in the Channel
734 #define sGetChanStatus(ChP) rp_readch2(ChP,CHNOFF_CHANSTAT(ChP))
736 /***************************************************************************
737 Function: sGetChanStatusLo
738 Purpose: Get the low byte only of the channel status
739 Call: sGetChanStatusLo(ChP)
740 CHANNEL_T *ChP; Ptr to channel structure
741 Return: Byte_t: The channel status low byte. Can be any combination
742 of the following flags:
743 CTS_ACT: CTS input asserted
744 DSR_ACT: DSR input asserted
745 CD_ACT: CD input asserted
746 TXFIFOMT: Tx FIFO is empty
747 TXSHRMT: Tx shift register is empty
748 RDA: Rx data available
750 #define sGetChanStatusLo(ChP) rp_readch1(ChP,CHNOFF_CHANSTAT(ChP))
752 /***************************************************************************
754 Purpose: Get the number of data bytes in the Rx FIFO
756 CHANNEL_T *ChP; Ptr to channel structure
757 Return: int: The number of data bytes in the Rx FIFO.
758 Comments: Byte read of count register is required to obtain Rx count.
761 #define sGetRxCnt(ChP) rp_readch2(ChP,CHNOFF_TXRXCOUNT(ChP))
763 /***************************************************************************
765 Purpose: Get the number of data bytes in the Tx FIFO
767 CHANNEL_T *ChP; Ptr to channel structure
768 Return: Byte_t: The number of data bytes in the Tx FIFO.
769 Comments: Byte read of count register is required to obtain Tx count.
772 #define sGetTxCnt(ChP) rp_readch1(ChP,CHNOFF_TXRXCOUNT(ChP))
774 /*****************************************************************************
775 Function: sGetTxRxDataIO
776 Purpose: Get the offset of a channel's TxRx Data register
777 Call: sGetTxRxDataIO(ChP)
778 CHANNEL_T *ChP; Ptr to channel structure
779 Return: WordIO_t: offset of a channel's TxRx Data register
781 #define sGetTxRxDataIO(ChP) CHNOFF_TXRXDATA(ChP)
783 /***************************************************************************
784 Function: sInitChanDefaults
785 Purpose: Initialize a channel structure to its default state.
786 Call: sInitChanDefaults(ChP)
787 CHANNEL_T *ChP; Ptr to the channel structure
788 Comments: This function must be called once for every channel structure
789 that exists before any other SSCI calls can be made.
792 #define sInitChanDefaults(ChP) \
794 (ChP)->CtlP = NULLCTLPTR; \
795 (ChP)->AiopNum = NULLAIOP; \
796 (ChP)->ChanID = AIOPID_NULL; \
797 (ChP)->ChanNum = NULLCHAN; \
800 /***************************************************************************
801 Function: sResetAiopByNum
802 Purpose: Reset the AIOP by number
803 Call: sResetAiopByNum(CTLP,AIOPNUM)
804 CONTROLLER_T CTLP; Ptr to controller structure
807 #define sResetAiopByNum(CTLP,AIOPNUM) \
809 rp_writeaiop1(CTLP,AIOPNUM,_CMD_REG,RESET_ALL); \
810 rp_writeaiop1(CTLP,AIOPNUM,_CMD_REG,0x0); \
813 /***************************************************************************
815 Purpose: Send a transmit BREAK signal
816 Call: sSendBreak(ChP)
817 CHANNEL_T *ChP; Ptr to channel structure
819 #define sSendBreak(ChP) \
821 (ChP)->TxControl[3] |= SETBREAK; \
822 rp_writech4(ChP,_INDX_ADDR,le32dec((ChP)->TxControl)); \
825 /***************************************************************************
827 Purpose: Set baud rate
828 Call: sSetBaud(ChP,Divisor)
829 CHANNEL_T *ChP; Ptr to channel structure
830 Word_t Divisor; 16 bit baud rate divisor for channel
832 #define sSetBaud(ChP,DIVISOR) \
834 (ChP)->BaudDiv[2] = (Byte_t)(DIVISOR); \
835 (ChP)->BaudDiv[3] = (Byte_t)((DIVISOR) >> 8); \
836 rp_writech4(ChP,_INDX_ADDR,le32dec((ChP)->BaudDiv)); \
839 /***************************************************************************
841 Purpose: Set data bits to 7
843 CHANNEL_T *ChP; Ptr to channel structure
845 #define sSetData7(ChP) \
847 (ChP)->TxControl[2] &= ~DATA8BIT; \
848 rp_writech4(ChP,_INDX_ADDR,le32dec((ChP)->TxControl)); \
851 /***************************************************************************
853 Purpose: Set data bits to 8
855 CHANNEL_T *ChP; Ptr to channel structure
857 #define sSetData8(ChP) \
859 (ChP)->TxControl[2] |= DATA8BIT; \
860 rp_writech4(ChP,_INDX_ADDR,le32dec((ChP)->TxControl)); \
863 /***************************************************************************
865 Purpose: Set the DTR output
867 CHANNEL_T *ChP; Ptr to channel structure
869 #define sSetDTR(ChP) \
871 (ChP)->TxControl[3] |= SET_DTR; \
872 rp_writech4(ChP,_INDX_ADDR,le32dec((ChP)->TxControl)); \
875 /***************************************************************************
876 Function: sSetEvenParity
877 Purpose: Set even parity
878 Call: sSetEvenParity(ChP)
879 CHANNEL_T *ChP; Ptr to channel structure
880 Comments: Function sSetParity() can be used in place of functions sEnParity(),
881 sDisParity(), sSetOddParity(), and sSetEvenParity().
883 Warnings: This function has no effect unless parity is enabled with function
886 #define sSetEvenParity(ChP) \
888 (ChP)->TxControl[2] |= EVEN_PAR; \
889 rp_writech4(ChP,_INDX_ADDR,le32dec((ChP)->TxControl)); \
892 /***************************************************************************
893 Function: sSetOddParity
894 Purpose: Set odd parity
895 Call: sSetOddParity(ChP)
896 CHANNEL_T *ChP; Ptr to channel structure
897 Comments: Function sSetParity() can be used in place of functions sEnParity(),
898 sDisParity(), sSetOddParity(), and sSetEvenParity().
900 Warnings: This function has no effect unless parity is enabled with function
903 #define sSetOddParity(ChP) \
905 (ChP)->TxControl[2] &= ~EVEN_PAR; \
906 rp_writech4(ChP,_INDX_ADDR,le32dec((ChP)->TxControl)); \
909 /***************************************************************************
911 Purpose: Set the RTS output
913 CHANNEL_T *ChP; Ptr to channel structure
915 #define sSetRTS(ChP) \
917 (ChP)->TxControl[3] |= SET_RTS; \
918 rp_writech4(ChP,_INDX_ADDR,le32dec((ChP)->TxControl)); \
921 /***************************************************************************
922 Function: sSetRxTrigger
923 Purpose: Set the Rx FIFO trigger level
924 Call: sSetRxProcessor(ChP,Level)
925 CHANNEL_T *ChP; Ptr to channel structure
926 Byte_t Level; Number of characters in Rx FIFO at which the
927 interrupt will be generated. Can be any of the following flags:
930 TRIG_1: 1 character in FIFO
931 TRIG_1_2: FIFO 1/2 full
932 TRIG_7_8: FIFO 7/8 full
933 Comments: An interrupt will be generated when the trigger level is reached
934 only if function sEnInterrupt() has been called with flag
935 RXINT_EN set. The RXF_TRIG flag in the Interrupt Idenfification
936 register will be set whenever the trigger level is reached
937 regardless of the setting of RXINT_EN.
940 #define sSetRxTrigger(ChP,LEVEL) \
942 (ChP)->RxControl[2] &= ~TRIG_MASK; \
943 (ChP)->RxControl[2] |= LEVEL; \
944 rp_writech4(ChP,_INDX_ADDR,le32dec((ChP)->RxControl)); \
947 /***************************************************************************
949 Purpose: Set stop bits to 1
951 CHANNEL_T *ChP; Ptr to channel structure
953 #define sSetStop1(ChP) \
955 (ChP)->TxControl[2] &= ~STOP2; \
956 rp_writech4(ChP,_INDX_ADDR,le32dec((ChP)->TxControl)); \
959 /***************************************************************************
961 Purpose: Set stop bits to 2
963 CHANNEL_T *ChP; Ptr to channel structure
965 #define sSetStop2(ChP) \
967 (ChP)->TxControl[2] |= STOP2; \
968 rp_writech4(ChP,_INDX_ADDR,le32dec((ChP)->TxControl)); \
971 /***************************************************************************
972 Function: sStartRxProcessor
973 Purpose: Start a channel's receive processor
974 Call: sStartRxProcessor(ChP)
975 CHANNEL_T *ChP; Ptr to channel structure
976 Comments: This function is used to start a Rx processor after it was
977 stopped with sStopRxProcessor() or sStopSWInFlowCtl(). It
978 will restart both the Rx processor and software input flow control.
981 #define sStartRxProcessor(ChP) rp_writech4(ChP,_INDX_ADDR,le32dec((ChP)->R))
983 /***************************************************************************
984 Function: sWriteTxByte
985 Purpose: Write a transmit data byte to a channel.
986 CHANNEL_T *ChP; Ptr to channel structure
987 ByteIO_t io: Channel transmit register I/O address. This can
988 be obtained with sGetTxRxDataIO().
989 Byte_t Data; The transmit data byte.
990 Warnings: This function writes the data byte without checking to see if
991 sMaxTxSize is exceeded in the Tx FIFO.
993 #define sWriteTxByte(ChP,IO,DATA) rp_writech1(ChP,IO,DATA)
995 int sReadAiopID(CONTROLLER_T *CtlP, int aiop);
996 int sReadAiopNumChan(CONTROLLER_T *CtlP, int aiop);
997 int sInitChan( CONTROLLER_T *CtlP,
1001 Byte_t sGetRxErrStatus(CHANNEL_T *ChP);
1002 void sStopRxProcessor(CHANNEL_T *ChP);
1003 void sStopSWInFlowCtl(CHANNEL_T *ChP);
1004 void sFlushRxFIFO(CHANNEL_T *ChP);
1005 void sFlushTxFIFO(CHANNEL_T *ChP);
1006 int sWriteTxPrioByte(CHANNEL_T *ChP, Byte_t Data);
1007 void sEnInterrupts(CHANNEL_T *ChP,Word_t Flags);
1008 void sDisInterrupts(CHANNEL_T *ChP,Word_t Flags);
1009 int rp_attachcommon(CONTROLLER_T *ctlp, int num_aiops, int num_ports);
1010 void rp_releaseresource(CONTROLLER_t *ctlp);
1011 void rp_untimeout(void);
1012 static __inline void
1013 rp_lock(CONTROLLER_T *CtlP)
1015 if (CtlP->hwmtx_init != 0)
1016 mtx_lock_spin(&CtlP->hwmtx);
1018 static __inline void
1019 rp_unlock(CONTROLLER_T *CtlP)
1021 if (CtlP->hwmtx_init != 0)
1022 mtx_unlock_spin(&CtlP->hwmtx);
1026 extern Byte_t R[RDATASIZE];
1027 extern CONTROLLER_T sController[CTL_SIZE];
1028 extern Byte_t sIRQMap[16];
1030 extern Byte_t rp_sBitMapClrTbl[8];
1031 extern Byte_t rp_sBitMapSetTbl[8];