uart.h
Go to the documentation of this file.
1 //*****************************************************************************
2 //
3 // uart.h - Defines and Macros for the UART.
4 //
5 // Copyright (c) 2005-2017 Texas Instruments Incorporated. All rights reserved.
6 // Software License Agreement
7 //
8 // Redistribution and use in source and binary forms, with or without
9 // modification, are permitted provided that the following conditions
10 // are met:
11 //
12 // Redistributions of source code must retain the above copyright
13 // notice, this list of conditions and the following disclaimer.
14 //
15 // Redistributions in binary form must reproduce the above copyright
16 // notice, this list of conditions and the following disclaimer in the
17 // documentation and/or other materials provided with the
18 // distribution.
19 //
20 // Neither the name of Texas Instruments Incorporated nor the names of
21 // its contributors may be used to endorse or promote products derived
22 // from this software without specific prior written permission.
23 //
24 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
28 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
30 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 //
36 //*****************************************************************************
37 
38 #ifndef __DRIVERLIB_UART_H__
39 #define __DRIVERLIB_UART_H__
40 
41 #include <stdint.h>
42 #include <stdbool.h>
43 
44 //*****************************************************************************
45 //
46 // If building with a C++ compiler, make all of the definitions in this header
47 // have a C binding.
48 //
49 //*****************************************************************************
50 #ifdef __cplusplus
51 extern "C"
52 {
53 #endif
54 
55 //*****************************************************************************
56 //
57 // Values that can be passed to UARTIntEnable, UARTIntDisable, and UARTIntClear
58 // as the ui32IntFlags parameter, and returned from UARTIntStatus.
59 //
60 //*****************************************************************************
61 #define UART_INT_DMATX 0x20000 // DMA TX interrupt
62 #define UART_INT_DMARX 0x10000 // DMA RX interrupt
63 #define UART_INT_9BIT 0x1000 // 9-bit address match interrupt
64 #define UART_INT_OE 0x400 // Overrun Error Interrupt Mask
65 #define UART_INT_BE 0x200 // Break Error Interrupt Mask
66 #define UART_INT_PE 0x100 // Parity Error Interrupt Mask
67 #define UART_INT_FE 0x080 // Framing Error Interrupt Mask
68 #define UART_INT_RT 0x040 // Receive Timeout Interrupt Mask
69 #define UART_INT_TX 0x020 // Transmit Interrupt Mask
70 #define UART_INT_RX 0x010 // Receive Interrupt Mask
71 #define UART_INT_DSR 0x008 // DSR Modem Interrupt Mask
72 #define UART_INT_DCD 0x004 // DCD Modem Interrupt Mask
73 #define UART_INT_CTS 0x002 // CTS Modem Interrupt Mask
74 #define UART_INT_RI 0x001 // RI Modem Interrupt Mask
75 
76 //*****************************************************************************
77 //
78 // Values that can be passed to UARTConfigSetExpClk as the ui32Config parameter
79 // and returned by UARTConfigGetExpClk in the pui32Config parameter.
80 // Additionally, the UART_CONFIG_PAR_* subset can be passed to
81 // UARTParityModeSet as the ui32Parity parameter, and are returned by
82 // UARTParityModeGet.
83 //
84 //*****************************************************************************
85 #define UART_CONFIG_WLEN_MASK 0x00000060 // Mask for extracting word length
86 #define UART_CONFIG_WLEN_8 0x00000060 // 8 bit data
87 #define UART_CONFIG_WLEN_7 0x00000040 // 7 bit data
88 #define UART_CONFIG_WLEN_6 0x00000020 // 6 bit data
89 #define UART_CONFIG_WLEN_5 0x00000000 // 5 bit data
90 #define UART_CONFIG_STOP_MASK 0x00000008 // Mask for extracting stop bits
91 #define UART_CONFIG_STOP_ONE 0x00000000 // One stop bit
92 #define UART_CONFIG_STOP_TWO 0x00000008 // Two stop bits
93 #define UART_CONFIG_PAR_MASK 0x00000086 // Mask for extracting parity
94 #define UART_CONFIG_PAR_NONE 0x00000000 // No parity
95 #define UART_CONFIG_PAR_EVEN 0x00000006 // Even parity
96 #define UART_CONFIG_PAR_ODD 0x00000002 // Odd parity
97 #define UART_CONFIG_PAR_ONE 0x00000082 // Parity bit is one
98 #define UART_CONFIG_PAR_ZERO 0x00000086 // Parity bit is zero
99 
100 //*****************************************************************************
101 //
102 // Values that can be passed to UARTFIFOLevelSet as the ui32TxLevel parameter
103 // and returned by UARTFIFOLevelGet in the pui32TxLevel.
104 //
105 //*****************************************************************************
106 #define UART_FIFO_TX1_8 0x00000000 // Transmit interrupt at 1/8 Full
107 #define UART_FIFO_TX2_8 0x00000001 // Transmit interrupt at 1/4 Full
108 #define UART_FIFO_TX4_8 0x00000002 // Transmit interrupt at 1/2 Full
109 #define UART_FIFO_TX6_8 0x00000003 // Transmit interrupt at 3/4 Full
110 #define UART_FIFO_TX7_8 0x00000004 // Transmit interrupt at 7/8 Full
111 
112 //*****************************************************************************
113 //
114 // Values that can be passed to UARTFIFOLevelSet as the ui32RxLevel parameter
115 // and returned by UARTFIFOLevelGet in the pui32RxLevel.
116 //
117 //*****************************************************************************
118 #define UART_FIFO_RX1_8 0x00000000 // Receive interrupt at 1/8 Full
119 #define UART_FIFO_RX2_8 0x00000008 // Receive interrupt at 1/4 Full
120 #define UART_FIFO_RX4_8 0x00000010 // Receive interrupt at 1/2 Full
121 #define UART_FIFO_RX6_8 0x00000018 // Receive interrupt at 3/4 Full
122 #define UART_FIFO_RX7_8 0x00000020 // Receive interrupt at 7/8 Full
123 
124 //*****************************************************************************
125 //
126 // Values that can be passed to UARTDMAEnable() and UARTDMADisable().
127 //
128 //*****************************************************************************
129 #define UART_DMA_ERR_RXSTOP 0x00000004 // Stop DMA receive if UART error
130 #define UART_DMA_TX 0x00000002 // Enable DMA for transmit
131 #define UART_DMA_RX 0x00000001 // Enable DMA for receive
132 
133 //*****************************************************************************
134 //
135 // Values returned from UARTRxErrorGet().
136 //
137 //*****************************************************************************
138 #define UART_RXERROR_OVERRUN 0x00000008
139 #define UART_RXERROR_BREAK 0x00000004
140 #define UART_RXERROR_PARITY 0x00000002
141 #define UART_RXERROR_FRAMING 0x00000001
142 
143 //*****************************************************************************
144 //
145 // Values that can be passed to UARTHandshakeOutputsSet() or returned from
146 // UARTHandshakeOutputGet().
147 //
148 //*****************************************************************************
149 #define UART_OUTPUT_RTS 0x00000800
150 #define UART_OUTPUT_DTR 0x00000400
151 
152 //*****************************************************************************
153 //
154 // Values that can be returned from UARTHandshakeInputsGet().
155 //
156 //*****************************************************************************
157 #define UART_INPUT_RI 0x00000100
158 #define UART_INPUT_DCD 0x00000004
159 #define UART_INPUT_DSR 0x00000002
160 #define UART_INPUT_CTS 0x00000001
161 
162 //*****************************************************************************
163 //
164 // Values that can be passed to UARTFlowControl() or returned from
165 // UARTFlowControlGet().
166 //
167 //*****************************************************************************
168 #define UART_FLOWCONTROL_TX 0x00008000
169 #define UART_FLOWCONTROL_RX 0x00004000
170 #define UART_FLOWCONTROL_NONE 0x00000000
171 
172 //*****************************************************************************
173 //
174 // Values that can be passed to UARTTxIntModeSet() or returned from
175 // UARTTxIntModeGet().
176 //
177 //*****************************************************************************
178 #define UART_TXINT_MODE_FIFO 0x00000000
179 #define UART_TXINT_MODE_EOT 0x00000010
180 
181 //*****************************************************************************
182 //
183 // Values that can be passed to UARTClockSourceSet() or returned from
184 // UARTClockSourceGet().
185 //
186 //*****************************************************************************
187 #define UART_CLOCK_SYSTEM 0x00000000
188 #define UART_CLOCK_ALTCLK 0x00000005
189 
190 //*****************************************************************************
191 //
192 // API Function prototypes
193 //
194 //*****************************************************************************
195 extern void UARTParityModeSet(uint32_t ui32Base, uint32_t ui32Parity);
196 extern uint32_t UARTParityModeGet(uint32_t ui32Base);
197 extern void UARTFIFOLevelSet(uint32_t ui32Base, uint32_t ui32TxLevel,
198  uint32_t ui32RxLevel);
199 extern void UARTFIFOLevelGet(uint32_t ui32Base, uint32_t *pui32TxLevel,
200  uint32_t *pui32RxLevel);
201 extern void UARTConfigSetExpClk(uint32_t ui32Base, uint32_t ui32UARTClk,
202  uint32_t ui32Baud, uint32_t ui32Config);
203 extern void UARTConfigGetExpClk(uint32_t ui32Base, uint32_t ui32UARTClk,
204  uint32_t *pui32Baud, uint32_t *pui32Config);
205 extern void UARTEnable(uint32_t ui32Base);
206 extern void UARTDisable(uint32_t ui32Base);
207 extern void UARTFIFOEnable(uint32_t ui32Base);
208 extern void UARTFIFODisable(uint32_t ui32Base);
209 extern void UARTEnableSIR(uint32_t ui32Base, bool bLowPower);
210 extern void UARTDisableSIR(uint32_t ui32Base);
211 extern bool UARTCharsAvail(uint32_t ui32Base);
212 extern bool UARTSpaceAvail(uint32_t ui32Base);
213 extern int32_t UARTCharGetNonBlocking(uint32_t ui32Base);
214 extern int32_t UARTCharGet(uint32_t ui32Base);
215 extern bool UARTCharPutNonBlocking(uint32_t ui32Base, unsigned char ucData);
216 extern void UARTCharPut(uint32_t ui32Base, unsigned char ucData);
217 extern void UARTBreakCtl(uint32_t ui32Base, bool bBreakState);
218 extern bool UARTBusy(uint32_t ui32Base);
219 extern void UARTIntRegister(uint32_t ui32Base, void (*pfnHandler)(void));
220 extern void UARTIntUnregister(uint32_t ui32Base);
221 extern void UARTIntEnable(uint32_t ui32Base, uint32_t ui32IntFlags);
222 extern void UARTIntDisable(uint32_t ui32Base, uint32_t ui32IntFlags);
223 extern uint32_t UARTIntStatus(uint32_t ui32Base, bool bMasked);
224 extern void UARTIntClear(uint32_t ui32Base, uint32_t ui32IntFlags);
225 extern void UARTDMAEnable(uint32_t ui32Base, uint32_t ui32DMAFlags);
226 extern void UARTDMADisable(uint32_t ui32Base, uint32_t ui32DMAFlags);
227 extern uint32_t UARTRxErrorGet(uint32_t ui32Base);
228 extern void UARTRxErrorClear(uint32_t ui32Base);
229 extern void UARTSmartCardEnable(uint32_t ui32Base);
230 extern void UARTSmartCardDisable(uint32_t ui32Base);
231 extern void UARTModemControlSet(uint32_t ui32Base, uint32_t ui32Control);
232 extern void UARTModemControlClear(uint32_t ui32Base, uint32_t ui32Control);
233 extern uint32_t UARTModemControlGet(uint32_t ui32Base);
234 extern uint32_t UARTModemStatusGet(uint32_t ui32Base);
235 extern void UARTFlowControlSet(uint32_t ui32Base, uint32_t ui32Mode);
236 extern uint32_t UARTFlowControlGet(uint32_t ui32Base);
237 extern void UARTTxIntModeSet(uint32_t ui32Base, uint32_t ui32Mode);
238 extern uint32_t UARTTxIntModeGet(uint32_t ui32Base);
239 extern void UARTClockSourceSet(uint32_t ui32Base, uint32_t ui32Source);
240 extern uint32_t UARTClockSourceGet(uint32_t ui32Base);
241 extern void UART9BitEnable(uint32_t ui32Base);
242 extern void UART9BitDisable(uint32_t ui32Base);
243 extern void UART9BitAddrSet(uint32_t ui32Base, uint8_t ui8Addr,
244  uint8_t ui8Mask);
245 extern void UART9BitAddrSend(uint32_t ui32Base, uint8_t ui8Addr);
246 extern void UARTLoopbackEnable(uint32_t ui32Base);
247 
248 //*****************************************************************************
249 //
250 // Mark the end of the C bindings section for C++ compilers.
251 //
252 //*****************************************************************************
253 #ifdef __cplusplus
254 }
255 #endif
256 
257 #endif // __DRIVERLIB_UART_H__
void UARTModemControlClear(uint32_t ui32Base, uint32_t ui32Control)
Definition: uart.c:798
void UARTFIFOEnable(uint32_t ui32Base)
Definition: uart.c:566
uint32_t UARTClockSourceGet(uint32_t ui32Base)
Definition: uart.c:1702
void UARTSmartCardDisable(uint32_t ui32Base)
Definition: uart.c:727
bool UARTCharsAvail(uint32_t ui32Base)
Definition: uart.c:1019
void UARTConfigSetExpClk(uint32_t ui32Base, uint32_t ui32UARTClk, uint32_t ui32Baud, uint32_t ui32Config)
Definition: uart.c:348
void UARTParityModeSet(uint32_t ui32Base, uint32_t ui32Parity)
Definition: uart.c:173
void UARTDMAEnable(uint32_t ui32Base, uint32_t ui32DMAFlags)
Definition: uart.c:1549
void UARTFIFOLevelSet(uint32_t ui32Base, uint32_t ui32TxLevel, uint32_t ui32RxLevel)
Definition: uart.c:241
void UARTIntRegister(uint32_t ui32Base, void(*pfnHandler)(void))
Definition: uart.c:1301
void UARTIntDisable(uint32_t ui32Base, uint32_t ui32IntFlags)
Definition: uart.c:1435
void UARTIntClear(uint32_t ui32Base, uint32_t ui32IntFlags)
Definition: uart.c:1513
void UARTDisable(uint32_t ui32Base)
Definition: uart.c:528
void UARTBreakCtl(uint32_t ui32Base, bool bBreakState)
Definition: uart.c:1236
void UARTModemControlSet(uint32_t ui32Base, uint32_t ui32Control)
Definition: uart.c:760
bool UARTSpaceAvail(uint32_t ui32Base)
Definition: uart.c:1046
void UARTSmartCardEnable(uint32_t ui32Base)
Definition: uart.c:687
void UARTRxErrorClear(uint32_t ui32Base)
Definition: uart.c:1640
bool UARTBusy(uint32_t ui32Base)
Definition: uart.c:1268
uint32_t UARTModemStatusGet(uint32_t ui32Base)
Definition: uart.c:858
int32_t UARTCharGetNonBlocking(uint32_t ui32Base)
Definition: uart.c:1075
void UART9BitEnable(uint32_t ui32Base)
Definition: uart.c:1727
void UARTEnableSIR(uint32_t ui32Base, bool bLowPower)
Definition: uart.c:623
void UART9BitDisable(uint32_t ui32Base)
Definition: uart.c:1752
uint32_t UARTIntStatus(uint32_t ui32Base, bool bMasked)
Definition: uart.c:1465
bool UARTCharPutNonBlocking(uint32_t ui32Base, unsigned char ucData)
Definition: uart.c:1154
void UARTClockSourceSet(uint32_t ui32Base, uint32_t ui32Source)
Definition: uart.c:1673
uint32_t UARTParityModeGet(uint32_t ui32Base)
Definition: uart.c:208
void UARTDisableSIR(uint32_t ui32Base)
Definition: uart.c:660
uint32_t UARTRxErrorGet(uint32_t ui32Base)
Definition: uart.c:1612
void UARTConfigGetExpClk(uint32_t ui32Base, uint32_t ui32UARTClk, uint32_t *pui32Baud, uint32_t *pui32Config)
Definition: uart.c:447
void UARTLoopbackEnable(uint32_t ui32Base)
Definition: uart.c:1877
int32_t UARTCharGet(uint32_t ui32Base)
Definition: uart.c:1116
void UART9BitAddrSend(uint32_t ui32Base, uint8_t ui8Addr)
Definition: uart.c:1818
uint32_t UARTFlowControlGet(uint32_t ui32Base)
Definition: uart.c:923
void UART9BitAddrSet(uint32_t ui32Base, uint8_t ui8Addr, uint8_t ui8Mask)
Definition: uart.c:1783
uint32_t UARTTxIntModeGet(uint32_t ui32Base)
Definition: uart.c:991
void UARTFIFOLevelGet(uint32_t ui32Base, uint32_t *pui32TxLevel, uint32_t *pui32RxLevel)
Definition: uart.c:284
uint32_t UARTModemControlGet(uint32_t ui32Base)
Definition: uart.c:832
void UARTEnable(uint32_t ui32Base)
Definition: uart.c:496
void UARTCharPut(uint32_t ui32Base, unsigned char ucData)
Definition: uart.c:1200
void UARTTxIntModeSet(uint32_t ui32Base, uint32_t ui32Mode)
Definition: uart.c:956
void UARTIntEnable(uint32_t ui32Base, uint32_t ui32IntFlags)
Definition: uart.c:1403
void UARTFlowControlSet(uint32_t ui32Base, uint32_t ui32Mode)
Definition: uart.c:891
void UARTIntUnregister(uint32_t ui32Base)
Definition: uart.c:1346
void UARTDMADisable(uint32_t ui32Base, uint32_t ui32DMAFlags)
Definition: uart.c:1581
void UARTFIFODisable(uint32_t ui32Base)
Definition: uart.c:591
Copyright 2017, Texas Instruments Incorporated