summaryrefslogtreecommitdiffstats
path: root/ArmRealViewEbPkg/Include/ArmEb/ArmEbUart.h
blob: 642b83ac4c5161cac76ec3f90018fa429ea77213 (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
/*++

Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>
Portions copyright (c) 2009, Hewlett-Packard Company. All rights reserved.<BR>
Portions copyright (c) 2010, Apple Inc. All rights reserved.<BR>
This program and the accompanying materials                          
are licensed and made available under the terms and conditions of the BSD License         
which accompanies this distribution.  The full text of the license may be found at        
http://opensource.org/licenses/bsd-license.php                                            
                                                                                          
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.  

--*/

#ifndef __ARM_EB_UART_H__
#define __ARM_EB_UART_H__


#define SERIAL_PORT_MAX_TIMEOUT            100000000    // 100 seconds


// EB constants
#define EB_UART1_BASE   0x10009000

// PL011 Registers
#define UARTDR          0x000
#define UARTRSR         0x004
#define UARTECR         0x004
#define UARTFR          0x018
#define UARTILPR        0x020
#define UARTIBRD        0x024
#define UARTFBRD        0x028
#define UARTLCR_H       0x02C
#define UARTCR          0x030
#define UARTIFLS        0x034
#define UARTIMSC        0x038
#define UARTRIS         0x03C
#define UARTMIS         0x040
#define UARTICR         0x044
#define UARTDMACR       0x048

// If the required baud rate is 115200 and UARTCLK = 24MHz then:
// Baud Rate Divisor = (24×10^6)/(16×115200) = 13.020833
// This means BRDI = 13 and BRDF = 0.020833
// Therefore, fractional part, m = integer(0.020833×64) = integer(1.33331) = 1
// Generated baud rate divider = 13+1/64 = 13.015625
// Generated baud rate = (24×10^6)/(16×13.015625) = 115246.098
// Error = (115246.098-115200)/115200 × 100 = 0.04%
#define UART_115200_IDIV    13
#define UART_115200_FDIV    1

// add more baud rates here as needed

// data status bits
#define UART_DATA_ERROR_MASK      0x0F00

// status reg bits
#define UART_STATUS_ERROR_MASK    0x0F

// flag reg bits
#define UART_TX_EMPTY_FLAG_MASK   0x80
#define UART_RX_FULL_FLAG_MASK    0x40
#define UART_TX_FULL_FLAG_MASK    0x20
#define UART_RX_EMPTY_FLAG_MASK   0x10
#define UART_BUSY_FLAG_MASK       0x08

// control reg bits
#define UART_CTSEN_CONTROL_MASK   0x8000
#define UART_RTSEN_CONTROL_MASK   0x4000
#define UART_RTS_CONTROL_MASK     0x0800
#define UART_DTR_CONTROL_MASK     0x0400


#endif