source: rtems/cpukit/libcsupport/include/motorola/mc68681.h @ 4d3017a

4.104.114.84.95
Last change on this file since 4d3017a was 4d3017a, checked in by Ralf Corsepius <ralf.corsepius@…>, on Dec 2, 2004 at 6:04:55 PM

Add doxygen preamble.

  • Property mode set to 100644
File size: 13.1 KB
Line 
1/**
2 * @file rtems/motorola/mc68681.h
3 *
4 *
5 * mc68681-duart.h -- Low level support code for the Motorola mc68681
6 *                   DUART.
7 */
8
9/*
10 *
11 *  Originally written by rob@cygnus.com (Rob Savoye) for the libgloss
12 *    IDP support.
13 *
14 *  $Id$
15 */
16
17#ifndef __MC68681_H__
18#define __MC68681_H__
19
20/*
21 *  In the dark ages when this controller was designed, it was actually
22 *  possible to access data on unaligned byte boundaries with no penalty.
23 *  Now we find this chip in configurations in which the registers are
24 *  at 16-bit, 32-bit, and 64-bit boundaries at the whim of the board
25 *  designer.  If the registers are not at byte addresses, then
26 *  set this multiplier before including this file to correct the offsets.
27 */
28
29#ifndef MC68681_OFFSET_MULTIPLIER
30#define MC68681_OFFSET_MULTIPLIER 1
31#endif
32
33#define __MC68681_REG(_R) ((_R) * MC68681_OFFSET_MULTIPLIER)
34
35/*
36 * mc68681 register offsets Read/Write Addresses
37 */
38#define MC68681_MODE_REG_1A  __MC68681_REG(0)  /* MR1A-MR Prior to Read */
39#define MC68681_MODE_REG_2A  __MC68681_REG(0)  /* MR2A-MR After Read    */
40
41#define MC68681_COUNT_MODE_CURRENT_MSB       __MC68681_REG(6)  /* CTU   */
42#define MC68681_COUNTER_TIMER_UPPER_REG      __MC68681_REG(6)  /* CTU   */
43#define MC68681_COUNT_MODE_CURRENT_LSB       __MC68681_REG(7)  /* CTL   */
44#define MC68681_COUNTER_TIMER_LOWER_REG      __MC68681_REG(7)  /* CTL   */
45#define MC68681_INTERRUPT_VECTOR_REG         __MC68681_REG(12) /* IVR   */
46
47#define MC68681_MODE_REG_1B  __MC68681_REG(8)  /* MR1B-MR Prior to Read */
48#define MC68681_MODE_REG_2B  __MC68681_REG(8)  /* MR2BA-MR After Read   */
49
50/*
51 * mc68681 register offsets Read Only  Addresses
52 */
53#define MC68681_STATUS_REG_A                __MC68681_REG(1)   /* SRA   */
54#define MC68681_MASK_ISR_REG                __MC68681_REG(2)   /* MISR  */
55#define MC68681_RECEIVE_BUFFER_A            __MC68681_REG(3)   /* RHRA  */
56#define MC68681_INPUT_PORT_CHANGE_REG       __MC68681_REG(4)   /* IPCR  */
57#define MC68681_INTERRUPT_STATUS_REG        __MC68681_REG(5)   /* ISR   */
58#define MC68681_STATUS_REG_B                __MC68681_REG(9)   /* SRB   */
59#define MC68681_RECEIVE_BUFFER_B            __MC68681_REG(11)  /* RHRB  */
60#define MC68681_INPUT_PORT                  __MC68681_REG(13)  /* IP    */
61#define MC68681_START_COUNT_CMD             __MC68681_REG(14)  /* SCC   */
62#define MC68681_STOP_COUNT_CMD              __MC68681_REG(15)  /* STC   */
63
64/*
65 * mc68681 register offsets Write Only  Addresses
66 */
67#define MC68681_CLOCK_SELECT_REG_A          __MC68681_REG(1)   /* CSRA  */
68#define MC68681_COMMAND_REG_A               __MC68681_REG(2)   /* CRA   */
69#define MC68681_TRANSMIT_BUFFER_A           __MC68681_REG(3)   /* THRA  */
70#define MC68681_AUX_CTRL_REG                __MC68681_REG(4)   /* ACR   */
71#define MC68681_INTERRUPT_MASK_REG          __MC68681_REG(5)   /* IMR   */
72#define MC68681_CLOCK_SELECT_REG_B          __MC68681_REG(9)   /* CSRB  */
73#define MC68681_COMMAND_REG_B               __MC68681_REG(10)  /* CRB   */
74#define MC68681_TRANSMIT_BUFFER_B           __MC68681_REG(11)  /* THRB  */
75#define MC68681_OUTPUT_PORT_CONFIG_REG      __MC68681_REG(13)  /* OPCR  */
76#define MC68681_OUTPUT_PORT_SET_REG         __MC68681_REG(14)  /* SOPBC */
77#define MC68681_OUTPUT_PORT_RESET_BITS      __MC68681_REG(15)  /* COPBC */
78
79
80#ifndef MC6681_VOL
81#define MC6681_VOL( ptr )   ((volatile unsigned char *)(ptr))
82#endif
83
84#define MC68681_WRITE( _base, _reg, _data ) \
85   *((volatile unsigned char *)_base+_reg) = (_data)
86
87#define MC68681_READ( _base, _reg ) \
88   *(((volatile unsigned char *)_base+_reg))
89
90
91
92#define  MC68681_CLEAR                                     0x00
93
94#define MC68681_PORT_A                                     0
95#define MC68681_PORT_B                                     1
96
97/*
98 *  DUART Command Register Definitions:
99 *
100 *  MC68681_COMMAND_REG_A,MC68681_COMMAND_REG_B
101 */
102#define MC68681_MODE_REG_ENABLE_RX                          0x01
103#define MC68681_MODE_REG_DISABLE_RX                         0x02
104#define MC68681_MODE_REG_ENABLE_TX                          0x04
105#define MC68681_MODE_REG_DISABLE_TX                         0x08
106#define MC68681_MODE_REG_RESET_MR_PTR                       0x10
107#define MC68681_MODE_REG_RESET_RX                           0x20
108#define MC68681_MODE_REG_RESET_TX                           0x30
109#define MC68681_MODE_REG_RESET_ERROR                        0x40
110#define MC68681_MODE_REG_RESET_BREAK                        0x50
111#define MC68681_MODE_REG_START_BREAK                        0x60
112#define MC68681_MODE_REG_STOP_BREAK                         0x70
113#define MC68681_MODE_REG_SET_RX_BRG                         0x80
114#define MC68681_MODE_REG_CLEAR_RX_BRG                       0x90
115#define MC68681_MODE_REG_SET_TX_BRG                         0xa0
116#define MC68681_MODE_REG_CLEAR_TX_BRG                       0xb0
117#define MC68681_MODE_REG_SET_STANDBY                        0xc0
118#define MC68681_MODE_REG_SET_ACTIVE                         0xd0
119
120/*
121 * Mode Register Definitions
122 *
123 *  MC68681_MODE_REG_1A
124 *  MC68681_MODE_REG_1B
125 */
126#define MC68681_5BIT_CHARS                                  0x00
127#define MC68681_6BIT_CHARS                                  0x01
128#define MC68681_7BIT_CHARS                                  0x02
129#define MC68681_8BIT_CHARS                                  0x03
130
131#define MC68681_ODD_PARITY                                  0x00
132#define MC68681_EVEN_PARITY                                 0x04
133
134#define MC68681_WITH_PARITY                                 0x00
135#define MC68681_FORCE_PARITY                                0x08
136#define MC68681_NO_PARITY                                   0x10
137#define MC68681_MULTI_DROP                                  0x18
138
139#define MC68681_ERR_MODE_CHAR                               0x00
140#define MC68681_ERR_MODE_BLOCK                              0x20
141
142#define MC68681_RX_INTR_RX_READY                            0x00
143#define MC68681_RX_INTR_FFULL                               0x40
144
145#define MC68681_NO_RX_RTS_CTL                               0x00
146#define MC68681_RX_RTS_CTRL                                 0x80
147
148
149/*
150 * Mode Register Definitions
151 *
152 *  MC68681_MODE_REG_2A
153 *  MC68681_MODE_REG_2B
154 */
155#define MC68681_STOP_BIT_LENGTH__563                        0x00
156#define MC68681_STOP_BIT_LENGTH__625                        0x01
157#define MC68681_STOP_BIT_LENGTH__688                        0x02
158#define MC68681_STOP_BIT_LENGTH__75                         0x03
159#define MC68681_STOP_BIT_LENGTH__813                        0x04
160#define MC68681_STOP_BIT_LENGTH__875                        0x05
161#define MC68681_STOP_BIT_LENGTH__938                        0x06
162#define MC68681_STOP_BIT_LENGTH_1                           0x07
163#define MC68681_STOP_BIT_LENGTH_1_563                       0x08
164#define MC68681_STOP_BIT_LENGTH_1_625                       0x09
165#define MC68681_STOP_BIT_LENGTH_1_688                       0x0a
166#define MC68681_STOP_BIT_LENGTH_1_75                        0x0b
167#define MC68681_STOP_BIT_LENGTH_1_813                       0x0c
168#define MC68681_STOP_BIT_LENGTH_1_875                       0x0d
169#define MC68681_STOP_BIT_LENGTH_1_938                       0x0e
170#define MC68681_STOP_BIT_LENGTH_2                           0x0f
171
172#define MC68681_CTS_ENABLE_TX                               0x10
173#define MC68681_TX_RTS_CTRL                                 0x20
174
175#define MC68681_CHANNEL_MODE_NORMAL                         0x00
176#define MC68681_CHANNEL_MODE_ECHO                           0x40
177#define MC68681_CHANNEL_MODE_LOCAL_LOOP                     0x80
178#define MC68681_CHANNEL_MODE_REMOTE_LOOP                    0xc0
179
180/*
181 * Status Register Definitions
182 *
183 *    MC68681_STATUS_REG_A,  MC68681_STATUS_REG_B
184 */
185#define MC68681_RX_READY                                    0x01
186#define MC68681_FFULL                                       0x02
187#define MC68681_TX_READY                                    0x04
188#define MC68681_TX_EMPTY                                    0x08
189#define MC68681_OVERRUN_ERROR                               0x10
190#define MC68681_PARITY_ERROR                                0x20
191#define MC68681_FRAMING_ERROR                               0x40
192#define MC68681_RECEIVED_BREAK                              0x80
193
194
195/*
196 * Interupt Status Register Definitions.
197 *
198 * MC68681_INTERRUPT_STATUS_REG
199 */
200
201
202/*
203 *  Interupt Mask Register Definitions
204 *
205 *  MC68681_INTERRUPT_MASK_REG
206 */
207#define MC68681_IR_TX_READY_A                               0x01
208#define MC68681_IR_RX_READY_A                               0x02
209#define MC68681_IR_BREAK_A                                  0x04
210#define MC68681_IR_COUNTER_READY                            0x08
211#define MC68681_IR_TX_READY_B                               0x10
212#define MC68681_IR_RX_READY_B                               0x20
213#define MC68681_IR_BREAK_B                                  0x40
214#define MC68681_IR_INPUT_PORT_CHANGE                        0x80
215
216/*
217 * Status Register Definitions.
218 *
219 * MC68681_STATUS_REG_A,MC68681_STATUS_REG_B
220 */
221#define MC68681_STATUS_RXRDY                                0x01
222#define MC68681_STATUS_FFULL                                0x02
223#define MC68681_STATUS_TXRDY                                0x04
224#define MC68681_STATUS_TXEMT                                0x08
225#define MC68681_STATUS_OVERRUN_ERROR                        0x10
226#define MC68681_STATUS_PARITY_ERROR                         0x20
227#define MC68681_STATUS_FRAMING_ERROR                        0x40
228#define MC68681_STATUS_RECEIVED_BREAK                       0x80
229
230/*
231 * Definitions for the Interrupt Vector Register:
232 *
233 * MC68681_INTERRUPT_VECTOR_REG
234 */
235#define  MC68681_INTERRUPT_VECTOR_INIT                      0x0f
236
237/*
238 * Definitions for the Auxiliary Control Register
239 *
240 * MC68681_AUX_CTRL_REG
241 */
242#define MC68681_AUX_BRG_SET1                                0x00
243#define MC68681_AUX_BRG_SET2                                0x80
244
245
246/*
247 * The following Baud rates assume the X1 clock pin is driven with a
248 * 3.6864 MHz signal.  If a different frequency is used the DUART channel
249 * is running at the follwoing baud rate:
250 *       ((Table Baud Rate)*frequency)/3.6864 MHz
251 */
252
253/*
254 * Definitions for the Clock Select Register:
255 *
256 * MC68681_CLOCK_SELECT_REG_A,MC68681_CLOCK_SELECT_REG_A
257 *
258 * Note:  ACR[7] is the MSB of the Auxiliary Control register
259 *        X is the extend bit.
260 *        CRA - 0x08  Set Rx BRG Select Extend Bit   (X=1)
261 *        CRA - 0x09  Clear Rx BRG Select Extend Bit (X=0)
262 *        CRB - 0x0a  Set Tx BRG Select Extend Bit   (X=1)
263 *        CRB - 0x0b  Clear Tx BRG Select Extend Bit (x=1)
264 */
265#define MC68681_BAUD_RATE_MASK_50           0x00   /* ACR[7]=0,X=0 */
266                                                   /* ARC[7]=1,X=1 */
267#define MC68681_BAUD_RATE_MASK_75           0x00   /* ACR[7]=0,X=0 */
268                                                   /* ARC[7]=1,X=1 */
269#define MC68681_BAUD_RATE_MASK_110          0x01
270#define MC68681_BAUD_RATE_MASK_134_5        0x02
271#define MC68681_BAUD_RATE_MASK_150          0x03   /* ACR[7]=0,X=0 */
272                                                   /* ARC[7]=1,X=1 */
273#define MC68681_BAUD_RATE_MASK_200          0x03   /* ACR[7]=0,X=0 */
274                                                   /* ARC[7]=1,X=1 */
275#define MC68681_BAUD_RATE_MASK_300          0x04   /* ACR[7]=0,X=0 */
276                                                   /* ARC[7]=1,X=1 */
277#define MC68681_BAUD_RATE_MASK_600          0x05   /* ACR[7]=0,X=0 */
278                                                   /* ARC[7]=1,X=1 */
279#define MC68681_BAUD_RATE_MASK_1050         0x07   /* ACR[7]=0,X=0 */
280                                                   /* ARC[7]=1,X=1 */
281#define MC68681_BAUD_RATE_MASK_1200         0x06   /* ACR[7]=0,X=0 */
282                                                   /* ARC[7]=1,X=1 */
283#define MC68681_BAUD_RATE_MASK_1800         0x0a   /* ACR[7]=0,X=0 */
284                                                   /* ARC[7]=1,X=1 */
285#define MC68681_BAUD_RATE_MASK_2400         0x08   /* ACR[7]=0,X=0 */
286                                                   /* ARC[7]=1,X=1 */
287#define MC68681_BAUD_RATE_MASK_3600         0x04   /* ACR[7]=0,X=0 */
288                                                   /* ARC[7]=1,X=1 */
289#define MC68681_BAUD_RATE_MASK_4800         0x09
290#define MC68681_BAUD_RATE_MASK_7200         0x0a   /* ACR[7]=0,X=0 */
291                                                   /* ARC[7]=1,X=1 */
292#define MC68681_BAUD_RATE_MASK_9600         0xbb
293
294#define MC68681_BAUD_RATE_MASK_14_4K        0x05   /* ACR[7]=0,X=0 */
295                                                   /* ARC[7]=1,X=1 */
296#define MC68681_BAUD_RATE_MASK_19_2K        0xcc   /* ACR[7]=1,X=0 */
297                                                   /* ARC[7]=0,X=1 */
298#define MC68681_BAUD_RATE_MASK_28_8K        0x06   /* ACR[7]=0,X=0 */
299                                                   /* ARC[7]=1,X=1 */
300#define MC68681_BAUD_RATE_MASK_38_4K        0xcc   /* ACR[7]=0,X=0 */
301                                                   /* ARC[7]=1,X=1 */
302#define MC68681_BAUD_RATE_MASK_57_6K        0x07   /* ACR[7]=0,X=0 */
303                                                   /* ARC[7]=1,X=1 */
304#define MC68681_BAUD_RATE_MASK_115_5K       0x08
305#define MC68681_BAUD_RATE_MASK_TIMER        0xdd
306#define MC68681_BAUD_RATE_MASK_TIMER_16X    0xee
307#define MC68681_BAUD_RATE_MASK_TIMER_1X     0xff
308
309#endif
Note: See TracBrowser for help on using the repository browser.