summaryrefslogtreecommitdiff
path: root/ecos/packages/hal/sh/sh2/current/include/mod_regs_ser.h
blob: 6afeef4752a8faca6fecda6de9dc8bc018dedba6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
//=============================================================================
//
//      mod_regs_ser.h
//
//      SCI, SCIF, and IRDA (serial) Module register definitions
//
//=============================================================================
// ####ECOSGPLCOPYRIGHTBEGIN####                                            
// -------------------------------------------                              
// This file is part of eCos, the Embedded Configurable Operating System.   
// Copyright (C) 1998, 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
//
// eCos is free software; you can redistribute it and/or modify it under    
// the terms of the GNU General Public License as published by the Free     
// Software Foundation; either version 2 or (at your option) any later      
// version.                                                                 
//
// eCos is distributed in the hope that it will be useful, but WITHOUT      
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or    
// FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License    
// for more details.                                                        
//
// You should have received a copy of the GNU General Public License        
// along with eCos; if not, write to the Free Software Foundation, Inc.,    
// 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.            
//
// As a special exception, if other files instantiate templates or use      
// macros or inline functions from this file, or you compile this file      
// and link it with other works to produce a work based on this file,       
// this file does not by itself cause the resulting work to be covered by   
// the GNU General Public License. However the source code for this file    
// must still be made available in accordance with section (3) of the GNU   
// General Public License v2.                                               
//
// This exception does not invalidate any other reasons why a work based    
// on this file might be covered by the GNU General Public License.         
// -------------------------------------------                              
// ####ECOSGPLCOPYRIGHTEND####                                              
//=============================================================================
//#####DESCRIPTIONBEGIN####
//
// Author(s):   jskov
// Contributors:jskov
// Date:        2000-10-30
// Note:        All three serial module definitions kept in the same file
//              since they share some of the information.
//####DESCRIPTIONEND####
//
//=============================================================================

#ifdef CYGARC_SH_MOD_SCI
//++++++ Module SCI ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
//--------------------------------------------------------------------------
// Serial registers. All 8 bit registers.
#define CYGARC_REG_SCI_SCSMR0                0xffff81a0 // serial mode register
#define CYGARC_REG_SCI_SCBRR0                0xffff81a1 // bit rate register
#define CYGARC_REG_SCI_SCSCR0                0xffff81a2 // serial control register
#define CYGARC_REG_SCI_SCTDR0                0xffff81a3 // transmit data register
#define CYGARC_REG_SCI_SCSSR0                0xffff81a4 // serial status register
#define CYGARC_REG_SCI_SCRDR0                0xffff81a5 // receive data register

#define CYGARC_REG_SCI_SCSMR1                0xffff81b0 // serial mode register

// Serial Mode Register
#define CYGARC_REG_SCI_SCSMR_CA             0x80 // communication mode
#define CYGARC_REG_SCI_SCSMR_CHR            0x40 // character length (7 if set)
#define CYGARC_REG_SCI_SCSMR_PE             0x20 // parity enable
#define CYGARC_REG_SCI_SCSMR_OE             0x10 // parity mode
#define CYGARC_REG_SCI_SCSMR_STOP           0x08 // stop bit length
#define CYGARC_REG_SCI_SCSMR_MP             0x04 // multiprocessor mode
#define CYGARC_REG_SCI_SCSMR_CKS1           0x02 // clock select 1
#define CYGARC_REG_SCI_SCSMR_CKS0           0x01 // clock select 0
#define CYGARC_REG_SCI_SCSMR_CKSx_MASK      0x03 // mask

// Serial Control Register
#define CYGARC_REG_SCI_SCSCR_TIE            0x80 // transmit interrupt enable
#define CYGARC_REG_SCI_SCSCR_RIE            0x40 // receive interrupt enable
#define CYGARC_REG_SCI_SCSCR_TE             0x20 // transmit enable
#define CYGARC_REG_SCI_SCSCR_RE             0x10 // receive enable
#define CYGARC_REG_SCI_SCSCR_MPIE           0x08 // multiprocessor interrupt enable
#define CYGARC_REG_SCI_SCSCR_TEIE           0x04 // transmit-end interrupt enable
#define CYGARC_REG_SCI_SCSCR_CKE1           0x02 // clock enable 1
#define CYGARC_REG_SCI_SCSCR_CKE0           0x01 // clock enable 0

// Serial Status Register
#define CYGARC_REG_SCI_SCSSR_TDRE           0x80 // transmit data register empty
#define CYGARC_REG_SCI_SCSSR_RDRF           0x40 // receive data register full
#define CYGARC_REG_SCI_SCSSR_ORER           0x20 // overrun error
#define CYGARC_REG_SCI_SCSSR_FER            0x10 // framing error
#define CYGARC_REG_SCI_SCSSR_PER            0x08 // parity error
#define CYGARC_REG_SCI_SCSSR_TEND           0x04 // transmit end
#define CYGARC_REG_SCI_SCSSR_MPB            0x02 // multiprocessor bit
#define CYGARC_REG_SCI_SCSSR_MPBT           0x01 // multiprocessor bit transfer

// When clearing the status register, always write the value:
// CYGARC_REG_SCSSR_CLEARMASK & ~bit
// to prevent other bits than the one of interest to be cleared.
#define CYGARC_REG_SCI_SCSSR_CLEARMASK      0xf8


#if (CYGARC_SH_MOD_SCI >= 2)
# define CYGARC_REG_SCI_SCSPTR               0xfffffe7c // serial port register
#endif

#endif // CYGARC_SH_MOD_SCI

// Baud rate values calculation, depending on peripheral clock (Pf)
// n is CKS setting (0-3)
// N = (Pf/(64*2^(2n-1)*B))-1
// With CYGARC_SCBRR_CKSx providing the values 1, 4, 16, 64 we get
//       N = (Pf/(32*_CKS*B))-1
//
// The CYGARC_SCBRR_OPTIMAL_CKS macro should compute the minimal CKS
// setting for the given baud rate and peripheral clock.
//
// The error of the CKS+count value can be computed by:
//  E(%) = ((Pf/((N+1)*B*(64^(n-1)))-1)*100 
//
#define CYGARC_SCBRR_PRESCALE(_b_) \
((((CYGHWR_HAL_SH_ONCHIP_PERIPHERAL_SPEED/32/1/(_b_))-1)<256) ? 1 : \
 (((CYGHWR_HAL_SH_ONCHIP_PERIPHERAL_SPEED/32/4/(_b_))-1)<256) ? 4 : \
 (((CYGHWR_HAL_SH_ONCHIP_PERIPHERAL_SPEED/32/16/(_b_))-1)<256) ? 16 : 64)

// Add half the divisor to reduce rounding errors to .5
#define CYGARC_SCBRR_ROUNDING(_b_) \
  16*CYGARC_SCBRR_PRESCALE(_b_)*(_b_)

// These two macros provide the static values we need to stuff into the
// registers.
#define CYGARC_SCBRR_CKSx(_b_) \
    ((1 == CYGARC_SCBRR_PRESCALE(_b_)) ? 0 : \
     (4 == CYGARC_SCBRR_PRESCALE(_b_)) ? 1 : \
     (16 == CYGARC_SCBRR_PRESCALE(_b_)) ? 2 : 3)
#define CYGARC_SCBRR_N(_b_)     \
    (((_b_) < 4800) ? 0 :       \
      ((_b_) > 115200) ? 0 :    \
       (((CYGHWR_HAL_SH_ONCHIP_PERIPHERAL_SPEED+CYGARC_SCBRR_ROUNDING(_b_))/32/CYGARC_SCBRR_PRESCALE(_b_)/(_b_))-1))


//++++++ Module SCIF +++++++++++++++++++++++++++++++++++++++++++++++++++++++
#ifdef CYGARC_SH_MOD_SCIF

//--------------------------------------------------------------------------
// Serial w FIFO registers (and IRDA)

#define CYGARC_REG_SCIF_SCSMR1               0xfffffcc0 // 8
#define CYGARC_REG_SCIF_SCBRR1               0xfffffcc2 // 8
#define CYGARC_REG_SCIF_SCSCR1               0xfffffcc4 // 8
#define CYGARC_REG_SCIF_SCFTDR1              0xfffffcc6 // 8
#define CYGARC_REG_SCIF_SC1SSR1              0xfffffcc8 // 16
#define CYGARC_REG_SCIF_SC2SSR1              0xfffffcca // 8
#define CYGARC_REG_SCIF_SCFRDR1              0xfffffccc // 8
#define CYGARC_REG_SCIF_SCFCR1               0xfffffcce // 8
#define CYGARC_REG_SCIF_SCFDR1               0xfffffcd0 // 16
#define CYGARC_REG_SCIF_SCFER1               0xfffffcd2 // 16
#define CYGARC_REG_SCIF_SCIFMR1              0xfffffcd4 // 8

#define CYGARC_REG_SCIF_SCSMR2               0xfffffce0 // 8
#define CYGARC_REG_SCIF_SCBRR2               0xfffffce2 // 8
#define CYGARC_REG_SCIF_SCSCR2               0xfffffce4 // 8
#define CYGARC_REG_SCIF_SCFTDR2              0xfffffce6 // 8
#define CYGARC_REG_SCIF_SC1SSR2              0xfffffce8 // 16
#define CYGARC_REG_SCIF_SC2SSR2              0xfffffcea // 8
#define CYGARC_REG_SCIF_SCFRDR2              0xfffffcec // 8
#define CYGARC_REG_SCIF_SCFCR2               0xfffffcee // 8
#define CYGARC_REG_SCIF_SCFDR2               0xfffffcf0 // 16
#define CYGARC_REG_SCIF_SCFER2               0xfffffcf2 // 16
#define CYGARC_REG_SCIF_SCIFMR2              0xfffffcf4 // 8

// Serial Mode Register
#define CYGARC_REG_SCIF_SCSMR_CA             0x80 // async(0)/sync(1)
#define CYGARC_REG_SCIF_SCSMR_CHR            0x40 // character length (7 if set)
#define CYGARC_REG_SCIF_SCSMR_PE             0x20 // parity enable
#define CYGARC_REG_SCIF_SCSMR_OE             0x10 // parity mode (odd if set)
#define CYGARC_REG_SCIF_SCSMR_STOP           0x08 // stop bit length
#define CYGARC_REG_SCIF_SCSMR_MP             0x04 // MP mode
#define CYGARC_REG_SCIF_SCSMR_CKS1           0x02 // clock select 1
#define CYGARC_REG_SCIF_SCSMR_CKS0           0x01 // clock select 0
#define CYGARC_REG_SCIF_SCSMR_CKSx_MASK      0x03 // mask

// Serial Control Register
#define CYGARC_REG_SCIF_SCSCR_TIE            0x80 // transmit interrupt enable
#define CYGARC_REG_SCIF_SCSCR_RIE            0x40 // receive interrupt enable
#define CYGARC_REG_SCIF_SCSCR_TE             0x20 // transmit enable
#define CYGARC_REG_SCIF_SCSCR_RE             0x10 // receive enable
#define CYGARC_REG_SCIF_SCSCR_MPIE           0x08 // MP interrupt enable
#define CYGARC_REG_SCIF_SCSCR_CKE1           0x02 // clock enable 1
#define CYGARC_REG_SCIF_SCSCR_CKE0           0x01 // clock enable 0

// Serial Status Register 1
#define CYGARC_REG_SCIF_SCSSR_PER_MASK       0xf000 // number of parity errors
#define CYGARC_REG_SCIF_SCSSR_PER_shift      12
#define CYGARC_REG_SCIF_SCSSR_FER_MASK       0x0f00 // number of framing errors
#define CYGARC_REG_SCIF_SCSSR_FER_shift      8
#define CYGARC_REG_SCIF_SCSSR_ER             0x0080 // receive error
#define CYGARC_REG_SCIF_SCSSR_TEND           0x0040 // transmit end
#define CYGARC_REG_SCIF_SCSSR_TDFE           0x0020 // transmit fifo data empty
#define CYGARC_REG_SCIF_SCSSR_BRK            0x0010 // break detection
#define CYGARC_REG_SCIF_SCSSR_FER            0x0008 // framing error
#define CYGARC_REG_SCIF_SCSSR_PER            0x0004 // parity error
#define CYGARC_REG_SCIF_SCSSR_RDF            0x0002 // receive fifo data full
#define CYGARC_REG_SCIF_SCSSR_DR             0x0001 // receive data ready

// When clearing the status register, always write the value:
// CYGARC_REG_SCSSR_CLEARMASK & ~bit
// to prevent other bits than the one of interest to be cleared.
#define CYGARC_REG_SCIF_SCSSR_CLEARMASK      0x00f3

// Serial Status Register 2
#define CYGARC_REG_SCIF_SC2SSR_TLM            0x80 // Transmit LSB(0)/MSB(1)
#define CYGARC_REG_SCIF_SC2SSR_RLM            0x40 // Receive LSB(0)/MSB(1)
#define CYGARC_REG_SCIF_SC2SSR_BITRATE_4      0x00 // Bitrate
#define CYGARC_REG_SCIF_SC2SSR_BITRATE_8      0x10
#define CYGARC_REG_SCIF_SC2SSR_BITRATE_16     0x20
#define CYGARC_REG_SCIF_SC2SSR_MPB            0x08 // MP data received
#define CYGARC_REG_SCIF_SC2SSR_MPBT           0x04 // MP data transmited
#define CYGARC_REG_SCIF_SC2SSR_EI             0x02 // Ignore RX errors
#define CYGARC_REG_SCIF_SC2SSR_ORER           0x01 // overrun error

// Serial FIFO Control Register
#define CYGARC_REG_SCIF_SCFCR_RTRG_MASK      0xc0   // receive fifo data trigger
#define CYGARC_REG_SCIF_SCFCR_RTRG_1         0x00   // trigger on 1 char 
#define CYGARC_REG_SCIF_SCFCR_RTRG_4         0x40   // trigger on 4 chars
#define CYGARC_REG_SCIF_SCFCR_RTRG_8         0x80   // trigger on 8 chars
#define CYGARC_REG_SCIF_SCFCR_RTRG_14        0xc0   // trigger on 14 chars 

#define CYGARC_REG_SCIF_SCFCR_TTRG_MASK      0x30   // transmit fifo data trigger
#define CYGARC_REG_SCIF_SCFCR_TTRG_8         0x00   // trigger on 8 chars 
#define CYGARC_REG_SCIF_SCFCR_TTRG_4         0x10   // trigger on 4 chars
#define CYGARC_REG_SCIF_SCFCR_TTRG_2         0x20   // trigger on 2 chars
#define CYGARC_REG_SCIF_SCFCR_TTRG_1         0x30   // trigger on 1 char

#define CYGARC_REG_SCIF_SCFCR_MCE            0x08   // modem control enable
#define CYGARC_REG_SCIF_SCFCR_TFRST          0x04   // transmit fifo reset
#define CYGARC_REG_SCIF_SCFCR_RFRST          0x02   // receive fifo reset
#define CYGARC_REG_SCIF_SCFCR_LOOP           0x01   // loop back test


// Serial FIFO Data Count Set Register
#define CYGARC_REG_SCIF_SCFDR_RCOUNT_MASK    0x001f // number of chars in r fifo
#define CYGARC_REG_SCIF_SCFDR_RCOUNT_shift   0
#define CYGARC_REG_SCIF_SCFDR_TCOUNT_MASK    0x1f00 // number of chars in t fifo
#define CYGARC_REG_SCIF_SCFDR_TCOUNT_shift   8

// Serial IrDA Mode Register
#define CYGARC_REG_SCIF_SCIMR_IRMOD          0x80
#define CYGARC_REG_SCIF_SCIMR_PSEL           0x40
#define CYGARC_REG_SCIF_SCIMR_RIVS           0x20


#endif // CYGARC_SH_MOD_SCIF