Linux Kernel  3.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
io_16654.h
Go to the documentation of this file.
1 /************************************************************************
2  *
3  * 16654.H Definitions for 16C654 UART used on EdgePorts
4  *
5  * Copyright (C) 1998 Inside Out Networks, Inc.
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  ************************************************************************/
12 
13 #if !defined(_16654_H)
14 #define _16654_H
15 
16 /************************************************************************
17  *
18  * D e f i n e s / T y p e d e f s
19  *
20  ************************************************************************/
21 
22  //
23  // UART register numbers
24  // Numbers 0-7 are passed to the Edgeport directly. Numbers 8 and
25  // above are used internally to indicate that we must enable access
26  // to them via LCR bit 0x80 or LCR = 0xBF.
27  // The register number sent to the Edgeport is then (x & 0x7).
28  //
29  // Driver must not access registers that affect operation of the
30  // the EdgePort firmware -- that includes THR, RHR, IER, FCR.
31 
32 
33 #define THR 0 // ! Transmit Holding Register (Write)
34 #define RDR 0 // ! Receive Holding Register (Read)
35 #define IER 1 // ! Interrupt Enable Register
36 #define FCR 2 // ! Fifo Control Register (Write)
37 #define ISR 2 // Interrupt Status Register (Read)
38 #define LCR 3 // Line Control Register
39 #define MCR 4 // Modem Control Register
40 #define LSR 5 // Line Status Register
41 #define MSR 6 // Modem Status Register
42 #define SPR 7 // ScratchPad Register
43 #define DLL 8 // Bank2[ 0 ] Divisor Latch LSB
44 #define DLM 9 // Bank2[ 1 ] Divisor Latch MSB
45 #define EFR 10 // Bank2[ 2 ] Extended Function Register
46 //efine unused 11 // Bank2[ 3 ]
47 #define XON1 12 // Bank2[ 4 ] Xon-1
48 #define XON2 13 // Bank2[ 5 ] Xon-2
49 #define XOFF1 14 // Bank2[ 6 ] Xoff-1
50 #define XOFF2 15 // Bank2[ 7 ] Xoff-2
51 
52 #define NUM_16654_REGS 16
53 
54 #define IS_REG_2ND_BANK(x) ((x) >= 8)
55 
56  //
57  // Bit definitions for each register
58  //
59 
60 #define IER_RX 0x01 // Enable receive interrupt
61 #define IER_TX 0x02 // Enable transmit interrupt
62 #define IER_RXS 0x04 // Enable receive status interrupt
63 #define IER_MDM 0x08 // Enable modem status interrupt
64 #define IER_SLEEP 0x10 // Enable sleep mode
65 #define IER_XOFF 0x20 // Enable s/w flow control (XOFF) interrupt
66 #define IER_RTS 0x40 // Enable RTS interrupt
67 #define IER_CTS 0x80 // Enable CTS interrupt
68 #define IER_ENABLE_ALL 0xFF // Enable all ints
69 
70 
71 #define FCR_FIFO_EN 0x01 // Enable FIFOs
72 #define FCR_RXCLR 0x02 // Reset Rx FIFO
73 #define FCR_TXCLR 0x04 // Reset Tx FIFO
74 #define FCR_DMA_BLK 0x08 // Enable DMA block mode
75 #define FCR_TX_LEVEL_MASK 0x30 // Mask for Tx FIFO Level
76 #define FCR_TX_LEVEL_8 0x00 // Tx FIFO Level = 8 bytes
77 #define FCR_TX_LEVEL_16 0x10 // Tx FIFO Level = 16 bytes
78 #define FCR_TX_LEVEL_32 0x20 // Tx FIFO Level = 32 bytes
79 #define FCR_TX_LEVEL_56 0x30 // Tx FIFO Level = 56 bytes
80 #define FCR_RX_LEVEL_MASK 0xC0 // Mask for Rx FIFO Level
81 #define FCR_RX_LEVEL_8 0x00 // Rx FIFO Level = 8 bytes
82 #define FCR_RX_LEVEL_16 0x40 // Rx FIFO Level = 16 bytes
83 #define FCR_RX_LEVEL_56 0x80 // Rx FIFO Level = 56 bytes
84 #define FCR_RX_LEVEL_60 0xC0 // Rx FIFO Level = 60 bytes
85 
86 
87 #define ISR_INT_MDM_STATUS 0x00 // Modem status int pending
88 #define ISR_INT_NONE 0x01 // No interrupt pending
89 #define ISR_INT_TXRDY 0x02 // Tx ready int pending
90 #define ISR_INT_RXRDY 0x04 // Rx ready int pending
91 #define ISR_INT_LINE_STATUS 0x06 // Line status int pending
92 #define ISR_INT_RX_TIMEOUT 0x0C // Rx timeout int pending
93 #define ISR_INT_RX_XOFF 0x10 // Rx Xoff int pending
94 #define ISR_INT_RTS_CTS 0x20 // RTS/CTS change int pending
95 #define ISR_FIFO_ENABLED 0xC0 // Bits set if FIFOs enabled
96 #define ISR_INT_BITS_MASK 0x3E // Mask to isolate valid int causes
97 
98 
99 #define LCR_BITS_5 0x00 // 5 bits/char
100 #define LCR_BITS_6 0x01 // 6 bits/char
101 #define LCR_BITS_7 0x02 // 7 bits/char
102 #define LCR_BITS_8 0x03 // 8 bits/char
103 #define LCR_BITS_MASK 0x03 // Mask for bits/char field
104 
105 #define LCR_STOP_1 0x00 // 1 stop bit
106 #define LCR_STOP_1_5 0x04 // 1.5 stop bits (if 5 bits/char)
107 #define LCR_STOP_2 0x04 // 2 stop bits (if 6-8 bits/char)
108 #define LCR_STOP_MASK 0x04 // Mask for stop bits field
109 
110 #define LCR_PAR_NONE 0x00 // No parity
111 #define LCR_PAR_ODD 0x08 // Odd parity
112 #define LCR_PAR_EVEN 0x18 // Even parity
113 #define LCR_PAR_MARK 0x28 // Force parity bit to 1
114 #define LCR_PAR_SPACE 0x38 // Force parity bit to 0
115 #define LCR_PAR_MASK 0x38 // Mask for parity field
116 
117 #define LCR_SET_BREAK 0x40 // Set Break condition
118 #define LCR_DL_ENABLE 0x80 // Enable access to divisor latch
119 
120 #define LCR_ACCESS_EFR 0xBF // Load this value to access DLL,DLM,
121  // and also the '654-only registers
122  // EFR, XON1, XON2, XOFF1, XOFF2
123 
124 
125 #define MCR_DTR 0x01 // Assert DTR
126 #define MCR_RTS 0x02 // Assert RTS
127 #define MCR_OUT1 0x04 // Loopback only: Sets state of RI
128 #define MCR_MASTER_IE 0x08 // Enable interrupt outputs
129 #define MCR_LOOPBACK 0x10 // Set internal (digital) loopback mode
130 #define MCR_XON_ANY 0x20 // Enable any char to exit XOFF mode
131 #define MCR_IR_ENABLE 0x40 // Enable IrDA functions
132 #define MCR_BRG_DIV_4 0x80 // Divide baud rate clk by /4 instead of /1
133 
134 
135 #define LSR_RX_AVAIL 0x01 // Rx data available
136 #define LSR_OVER_ERR 0x02 // Rx overrun
137 #define LSR_PAR_ERR 0x04 // Rx parity error
138 #define LSR_FRM_ERR 0x08 // Rx framing error
139 #define LSR_BREAK 0x10 // Rx break condition detected
140 #define LSR_TX_EMPTY 0x20 // Tx Fifo empty
141 #define LSR_TX_ALL_EMPTY 0x40 // Tx Fifo and shift register empty
142 #define LSR_FIFO_ERR 0x80 // Rx Fifo contains at least 1 erred char
143 
144 
145 #define EDGEPORT_MSR_DELTA_CTS 0x01 // CTS changed from last read
146 #define EDGEPORT_MSR_DELTA_DSR 0x02 // DSR changed from last read
147 #define EDGEPORT_MSR_DELTA_RI 0x04 // RI changed from 0 -> 1
148 #define EDGEPORT_MSR_DELTA_CD 0x08 // CD changed from last read
149 #define EDGEPORT_MSR_CTS 0x10 // Current state of CTS
150 #define EDGEPORT_MSR_DSR 0x20 // Current state of DSR
151 #define EDGEPORT_MSR_RI 0x40 // Current state of RI
152 #define EDGEPORT_MSR_CD 0x80 // Current state of CD
153 
154 
155 
156  // Tx Rx
157  //-------------------------------
158 #define EFR_SWFC_NONE 0x00 // None None
159 #define EFR_SWFC_RX1 0x02 // None XOFF1
160 #define EFR_SWFC_RX2 0x01 // None XOFF2
161 #define EFR_SWFC_RX12 0x03 // None XOFF1 & XOFF2
162 #define EFR_SWFC_TX1 0x08 // XOFF1 None
163 #define EFR_SWFC_TX1_RX1 0x0a // XOFF1 XOFF1
164 #define EFR_SWFC_TX1_RX2 0x09 // XOFF1 XOFF2
165 #define EFR_SWFC_TX1_RX12 0x0b // XOFF1 XOFF1 & XOFF2
166 #define EFR_SWFC_TX2 0x04 // XOFF2 None
167 #define EFR_SWFC_TX2_RX1 0x06 // XOFF2 XOFF1
168 #define EFR_SWFC_TX2_RX2 0x05 // XOFF2 XOFF2
169 #define EFR_SWFC_TX2_RX12 0x07 // XOFF2 XOFF1 & XOFF2
170 #define EFR_SWFC_TX12 0x0c // XOFF1 & XOFF2 None
171 #define EFR_SWFC_TX12_RX1 0x0e // XOFF1 & XOFF2 XOFF1
172 #define EFR_SWFC_TX12_RX2 0x0d // XOFF1 & XOFF2 XOFF2
173 #define EFR_SWFC_TX12_RX12 0x0f // XOFF1 & XOFF2 XOFF1 & XOFF2
174 
175 #define EFR_TX_FC_MASK 0x0c // Mask to isolate Rx flow control
176 #define EFR_TX_FC_NONE 0x00 // No Tx Xon/Xoff flow control
177 #define EFR_TX_FC_X1 0x08 // Transmit Xon1/Xoff1
178 #define EFR_TX_FC_X2 0x04 // Transmit Xon2/Xoff2
179 #define EFR_TX_FC_X1_2 0x0c // Transmit Xon1&2/Xoff1&2
180 
181 #define EFR_RX_FC_MASK 0x03 // Mask to isolate Rx flow control
182 #define EFR_RX_FC_NONE 0x00 // No Rx Xon/Xoff flow control
183 #define EFR_RX_FC_X1 0x02 // Receiver compares Xon1/Xoff1
184 #define EFR_RX_FC_X2 0x01 // Receiver compares Xon2/Xoff2
185 #define EFR_RX_FC_X1_2 0x03 // Receiver compares Xon1&2/Xoff1&2
186 
187 
188 #define EFR_SWFC_MASK 0x0F // Mask for software flow control field
189 #define EFR_ENABLE_16654 0x10 // Enable 16C654 features
190 #define EFR_SPEC_DETECT 0x20 // Enable special character detect interrupt
191 #define EFR_AUTO_RTS 0x40 // Use RTS for Rx flow control
192 #define EFR_AUTO_CTS 0x80 // Use CTS for Tx flow control
193 
194 #endif // if !defined(_16654_H)
195