CC3200 Peripheral Driver Library User's Guide  1.2.0
uart.h
1 //*****************************************************************************
2 //
3 // uart.h
4 //
5 // Defines and Macros for the UART.
6 //
7 // Copyright (C) 2014 Texas Instruments Incorporated - https://www.ti.com/
8 //
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions
12 // are met:
13 //
14 // Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the
20 // distribution.
21 //
22 // Neither the name of Texas Instruments Incorporated nor the names of
23 // its contributors may be used to endorse or promote products derived
24 // from this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
27 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
28 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
29 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
30 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
31 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
32 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
33 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
34 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
35 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
36 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 //*****************************************************************************
39 
40 #ifndef __UART_H__
41 #define __UART_H__
42 
43 //*****************************************************************************
44 //
45 // If building with a C++ compiler, make all of the definitions in this header
46 // have a C binding.
47 //
48 //*****************************************************************************
49 #ifdef __cplusplus
50 extern "C"
51 {
52 #endif
53 
54 //*****************************************************************************
55 //
56 // Values that can be passed to UARTIntEnable, UARTIntDisable, and UARTIntClear
57 // as the ulIntFlags parameter, and returned from UARTIntStatus.
58 //
59 //*****************************************************************************
60 #define UART_INT_DMATX 0x20000 // DMA Tx Done interrupt Mask
61 #define UART_INT_DMARX 0x10000 // DMA Rx Done interrupt Mask
62 #define UART_INT_EOT 0x800 // End of transfer interrupt Mask
63 #define UART_INT_OE 0x400 // Overrun Error Interrupt Mask
64 #define UART_INT_BE 0x200 // Break Error Interrupt Mask
65 #define UART_INT_PE 0x100 // Parity Error Interrupt Mask
66 #define UART_INT_FE 0x080 // Framing Error Interrupt Mask
67 #define UART_INT_RT 0x040 // Receive Timeout Interrupt Mask
68 #define UART_INT_TX 0x020 // Transmit Interrupt Mask
69 #define UART_INT_RX 0x010 // Receive Interrupt Mask
70 #define UART_INT_CTS 0x002 // CTS Modem Interrupt Mask
71 
72 
73 //*****************************************************************************
74 //
75 // Values that can be passed to UARTConfigSetExpClk as the ulConfig parameter
76 // and returned by UARTConfigGetExpClk in the pulConfig parameter.
77 // Additionally, the UART_CONFIG_PAR_* subset can be passed to
78 // UARTParityModeSet as the ulParity parameter, and are returned by
79 // UARTParityModeGet.
80 //
81 //*****************************************************************************
82 #define UART_CONFIG_WLEN_MASK 0x00000060 // Mask for extracting word length
83 #define UART_CONFIG_WLEN_8 0x00000060 // 8 bit data
84 #define UART_CONFIG_WLEN_7 0x00000040 // 7 bit data
85 #define UART_CONFIG_WLEN_6 0x00000020 // 6 bit data
86 #define UART_CONFIG_WLEN_5 0x00000000 // 5 bit data
87 #define UART_CONFIG_STOP_MASK 0x00000008 // Mask for extracting stop bits
88 #define UART_CONFIG_STOP_ONE 0x00000000 // One stop bit
89 #define UART_CONFIG_STOP_TWO 0x00000008 // Two stop bits
90 #define UART_CONFIG_PAR_MASK 0x00000086 // Mask for extracting parity
91 #define UART_CONFIG_PAR_NONE 0x00000000 // No parity
92 #define UART_CONFIG_PAR_EVEN 0x00000006 // Even parity
93 #define UART_CONFIG_PAR_ODD 0x00000002 // Odd parity
94 #define UART_CONFIG_PAR_ONE 0x00000082 // Parity bit is one
95 #define UART_CONFIG_PAR_ZERO 0x00000086 // Parity bit is zero
96 
97 //*****************************************************************************
98 //
99 // Values that can be passed to UARTFIFOLevelSet as the ulTxLevel parameter and
100 // returned by UARTFIFOLevelGet in the pulTxLevel.
101 //
102 //*****************************************************************************
103 #define UART_FIFO_TX1_8 0x00000000 // Transmit interrupt at 1/8 Full
104 #define UART_FIFO_TX2_8 0x00000001 // Transmit interrupt at 1/4 Full
105 #define UART_FIFO_TX4_8 0x00000002 // Transmit interrupt at 1/2 Full
106 #define UART_FIFO_TX6_8 0x00000003 // Transmit interrupt at 3/4 Full
107 #define UART_FIFO_TX7_8 0x00000004 // Transmit interrupt at 7/8 Full
108 
109 //*****************************************************************************
110 //
111 // Values that can be passed to UARTFIFOLevelSet as the ulRxLevel parameter and
112 // returned by UARTFIFOLevelGet in the pulRxLevel.
113 //
114 //*****************************************************************************
115 #define UART_FIFO_RX1_8 0x00000000 // Receive interrupt at 1/8 Full
116 #define UART_FIFO_RX2_8 0x00000008 // Receive interrupt at 1/4 Full
117 #define UART_FIFO_RX4_8 0x00000010 // Receive interrupt at 1/2 Full
118 #define UART_FIFO_RX6_8 0x00000018 // Receive interrupt at 3/4 Full
119 #define UART_FIFO_RX7_8 0x00000020 // Receive interrupt at 7/8 Full
120 
121 //*****************************************************************************
122 //
123 // Values that can be passed to UARTDMAEnable() and UARTDMADisable().
124 //
125 //*****************************************************************************
126 #define UART_DMA_ERR_RXSTOP 0x00000004 // Stop DMA receive if UART error
127 #define UART_DMA_TX 0x00000002 // Enable DMA for transmit
128 #define UART_DMA_RX 0x00000001 // Enable DMA for receive
129 
130 //*****************************************************************************
131 //
132 // Values returned from UARTRxErrorGet().
133 //
134 //*****************************************************************************
135 #define UART_RXERROR_OVERRUN 0x00000008
136 #define UART_RXERROR_BREAK 0x00000004
137 #define UART_RXERROR_PARITY 0x00000002
138 #define UART_RXERROR_FRAMING 0x00000001
139 
140 //*****************************************************************************
141 //
142 // Values that can be passed to UARTModemControlSet()and UARTModemControlClear()
143 // or returned from UARTModemControlGet().
144 //
145 //*****************************************************************************
146 #define UART_OUTPUT_RTS 0x00000800
147 
148 //*****************************************************************************
149 //
150 // Values that can be returned from UARTModemStatusGet().
151 //
152 //*****************************************************************************
153 #define UART_INPUT_CTS 0x00000001
154 
155 //*****************************************************************************
156 //
157 // Values that can be passed to UARTFlowControl() or returned from
158 // UARTFlowControlGet().
159 //
160 //*****************************************************************************
161 #define UART_FLOWCONTROL_TX 0x00008000
162 #define UART_FLOWCONTROL_RX 0x00004000
163 #define UART_FLOWCONTROL_NONE 0x00000000
164 
165 //*****************************************************************************
166 //
167 // Values that can be passed to UARTTxIntModeSet() or returned from
168 // UARTTxIntModeGet().
169 //
170 //*****************************************************************************
171 #define UART_TXINT_MODE_FIFO 0x00000000
172 #define UART_TXINT_MODE_EOT 0x00000010
173 
174 
175 //*****************************************************************************
176 //
177 // API Function prototypes
178 //
179 //*****************************************************************************
180 extern void UARTParityModeSet(unsigned long ulBase, unsigned long ulParity);
181 extern unsigned long UARTParityModeGet(unsigned long ulBase);
182 extern void UARTFIFOLevelSet(unsigned long ulBase, unsigned long ulTxLevel,
183  unsigned long ulRxLevel);
184 extern void UARTFIFOLevelGet(unsigned long ulBase, unsigned long *pulTxLevel,
185  unsigned long *pulRxLevel);
186 extern void UARTConfigSetExpClk(unsigned long ulBase, unsigned long ulUARTClk,
187  unsigned long ulBaud, unsigned long ulConfig);
188 extern void UARTConfigGetExpClk(unsigned long ulBase, unsigned long ulUARTClk,
189  unsigned long *pulBaud,
190  unsigned long *pulConfig);
191 extern void UARTEnable(unsigned long ulBase);
192 extern void UARTDisable(unsigned long ulBase);
193 extern void UARTFIFOEnable(unsigned long ulBase);
194 extern void UARTFIFODisable(unsigned long ulBase);
195 extern tBoolean UARTCharsAvail(unsigned long ulBase);
196 extern tBoolean UARTSpaceAvail(unsigned long ulBase);
197 extern long UARTCharGetNonBlocking(unsigned long ulBase);
198 extern long UARTCharGet(unsigned long ulBase);
199 extern tBoolean UARTCharPutNonBlocking(unsigned long ulBase,
200  unsigned char ucData);
201 extern void UARTCharPut(unsigned long ulBase, unsigned char ucData);
202 extern void UARTBreakCtl(unsigned long ulBase, tBoolean bBreakState);
203 extern tBoolean UARTBusy(unsigned long ulBase);
204 extern void UARTIntRegister(unsigned long ulBase, void(*pfnHandler)(void));
205 extern void UARTIntUnregister(unsigned long ulBase);
206 extern void UARTIntEnable(unsigned long ulBase, unsigned long ulIntFlags);
207 extern void UARTIntDisable(unsigned long ulBase, unsigned long ulIntFlags);
208 extern unsigned long UARTIntStatus(unsigned long ulBase, tBoolean bMasked);
209 extern void UARTIntClear(unsigned long ulBase, unsigned long ulIntFlags);
210 extern void UARTDMAEnable(unsigned long ulBase, unsigned long ulDMAFlags);
211 extern void UARTDMADisable(unsigned long ulBase, unsigned long ulDMAFlags);
212 extern unsigned long UARTRxErrorGet(unsigned long ulBase);
213 extern void UARTRxErrorClear(unsigned long ulBase);
214 extern void UARTModemControlSet(unsigned long ulBase,
215  unsigned long ulControl);
216 extern void UARTModemControlClear(unsigned long ulBase,
217  unsigned long ulControl);
218 extern unsigned long UARTModemControlGet(unsigned long ulBase);
219 extern unsigned long UARTModemStatusGet(unsigned long ulBase);
220 extern void UARTFlowControlSet(unsigned long ulBase, unsigned long ulMode);
221 extern unsigned long UARTFlowControlGet(unsigned long ulBase);
222 extern void UARTTxIntModeSet(unsigned long ulBase, unsigned long ulMode);
223 extern unsigned long UARTTxIntModeGet(unsigned long ulBase);
224 
225 //*****************************************************************************
226 //
227 // Mark the end of the C bindings section for C++ compilers.
228 //
229 //*****************************************************************************
230 #ifdef __cplusplus
231 }
232 #endif
233 
234 #endif // __UART_H__
tBoolean UARTSpaceAvail(unsigned long ulBase)
Definition: uart.c:900
unsigned long UARTModemStatusGet(unsigned long ulBase)
Definition: uart.c:694
unsigned long UARTIntStatus(unsigned long ulBase, tBoolean bMasked)
Definition: uart.c:1312
long UARTCharGet(unsigned long ulBase)
Definition: uart.c:971
void UARTConfigSetExpClk(unsigned long ulBase, unsigned long ulUARTClk, unsigned long ulBaud, unsigned long ulConfig)
Definition: uart.c:315
unsigned long UARTRxErrorGet(unsigned long ulBase)
Definition: uart.c:1459
void UARTFIFODisable(unsigned long ulBase)
Definition: uart.c:554
void UARTIntDisable(unsigned long ulBase, unsigned long ulIntFlags)
Definition: uart.c:1282
void UARTDMAEnable(unsigned long ulBase, unsigned long ulDMAFlags)
Definition: uart.c:1396
void UARTConfigGetExpClk(unsigned long ulBase, unsigned long ulUARTClk, unsigned long *pulBaud, unsigned long *pulConfig)
Definition: uart.c:409
void UARTRxErrorClear(unsigned long ulBase)
Definition: uart.c:1487
long UARTCharGetNonBlocking(unsigned long ulBase)
Definition: uart.c:930
void UARTDMADisable(unsigned long ulBase, unsigned long ulDMAFlags)
Definition: uart.c:1428
void UARTModemControlClear(unsigned long ulBase, unsigned long ulControl)
Definition: uart.c:632
void UARTDisable(unsigned long ulBase)
Definition: uart.c:491
void UARTBreakCtl(unsigned long ulBase, tBoolean bBreakState)
Definition: uart.c:1091
unsigned long UARTTxIntModeGet(unsigned long ulBase)
Definition: uart.c:845
void UARTModemControlSet(unsigned long ulBase, unsigned long ulControl)
Definition: uart.c:590
void UARTFlowControlSet(unsigned long ulBase, unsigned long ulMode)
Definition: uart.c:731
void UARTFIFOLevelSet(unsigned long ulBase, unsigned long ulTxLevel, unsigned long ulRxLevel)
Definition: uart.c:216
void UARTIntClear(unsigned long ulBase, unsigned long ulIntFlags)
Definition: uart.c:1360
tBoolean UARTCharsAvail(unsigned long ulBase)
Definition: uart.c:873
unsigned long UARTFlowControlGet(unsigned long ulBase)
Definition: uart.c:768
tBoolean UARTBusy(unsigned long ulBase)
Definition: uart.c:1123
tBoolean UARTCharPutNonBlocking(unsigned long ulBase, unsigned char ucData)
Definition: uart.c:1009
void UARTTxIntModeSet(unsigned long ulBase, unsigned long ulMode)
Definition: uart.c:806
void UARTIntUnregister(unsigned long ulBase)
Definition: uart.c:1200
void UARTFIFOLevelGet(unsigned long ulBase, unsigned long *pulTxLevel, unsigned long *pulRxLevel)
Definition: uart.c:259
void UARTIntEnable(unsigned long ulBase, unsigned long ulIntFlags)
Definition: uart.c:1251
void UARTCharPut(unsigned long ulBase, unsigned char ucData)
Definition: uart.c:1055
unsigned long UARTModemControlGet(unsigned long ulBase)
Definition: uart.c:667
void UARTFIFOEnable(unsigned long ulBase)
Definition: uart.c:529
void UARTEnable(unsigned long ulBase)
Definition: uart.c:459
unsigned long UARTParityModeGet(unsigned long ulBase)
Definition: uart.c:183
void UARTIntRegister(unsigned long ulBase, void(*pfnHandler)(void))
Definition: uart.c:1156
void UARTParityModeSet(unsigned long ulBase, unsigned long ulParity)
Definition: uart.c:148