UART2Support.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2020, Texas Instruments Incorporated
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *
12  * * Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in the
14  * documentation and/or other materials provided with the distribution.
15  *
16  * * Neither the name of Texas Instruments Incorporated nor the names of
17  * its contributors may be used to endorse or promote products derived
18  * from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
27  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
40 #ifndef ti_drivers_UART2Support__include
41 #define ti_drivers_UART2Support__include
42 
43 #include <stddef.h>
44 #include <stdint.h>
45 #include <stdbool.h>
46 
47 #include <ti/drivers/UART2.h>
48 
49 #ifdef __cplusplus
50 extern "C" {
51 #endif
52 
58 extern void UART2Support_disableRx(UART2_HWAttrs const *hwAttrs);
59 
65 extern void UART2Support_disableTx(UART2_HWAttrs const *hwAttrs);
66 
72 extern void UART2Support_dmaRefreshRx(UART2_Handle handle);
73 
79 extern void UART2Support_dmaStartRx(UART2_Handle handle);
80 
86 extern void UART2Support_dmaStartTx(UART2_Handle handle);
87 
93 extern void UART2Support_dmaStopRx(UART2_Handle handle);
94 
100 extern void UART2Support_dmaStopTx(UART2_Handle handle);
101 
107 extern void UART2Support_enableInts(UART2_Handle handle);
108 
114 extern void UART2Support_enableRx(UART2_HWAttrs const *hwAttrs);
115 
121 extern void UART2Support_enableTx(UART2_HWAttrs const *hwAttrs);
122 
126 extern void UART2Support_powerSetConstraint(void);
127 
131 extern void UART2Support_powerRelConstraint(void);
132 
146 extern int_fast16_t UART2Support_rxStatus2ErrorCode(uint32_t errorData);
147 
160 extern uint32_t UART2Support_sendData(UART2_HWAttrs const *hwAttrs,
161  size_t size, uint8_t *buf);
162 
170 extern bool UART2Support_txDone(UART2_HWAttrs const *hwAttrs);
171 
185 extern int UART2Support_uartRxError(UART2_HWAttrs const *hwAttrs);
186 
187 #ifdef __cplusplus
188 }
189 #endif
190 
191 #endif /* ti_drivers_UART2__include */
UART2 Global configuration.
Definition: UART2.h:697
void UART2Support_dmaRefreshRx(UART2_Handle handle)
Function to update RX ring buffer state.
int UART2Support_uartRxError(UART2_HWAttrs const *hwAttrs)
Function to clear receive errors.
void UART2Support_dmaStopTx(UART2_Handle handle)
Function to disable the TX DMA.
bool UART2Support_txDone(UART2_HWAttrs const *hwAttrs)
Function to determine if TX is in progress.
PRELIMINARY UART driver interface
void UART2Support_dmaStopRx(UART2_Handle handle)
Function to disable the RX DMA.
void UART2Support_enableInts(UART2_Handle handle)
Function to enable receive, receive timeout, and error interrupts.
void UART2Support_powerSetConstraint(void)
Function to set power constraint.
void UART2Support_powerRelConstraint(void)
Function to release power constraint.
void UART2Support_enableTx(UART2_HWAttrs const *hwAttrs)
Function to enable the transmit interrupt.
void UART2Support_dmaStartRx(UART2_Handle handle)
Function to configure the receive DMA.
void UART2Support_enableRx(UART2_HWAttrs const *hwAttrs)
Function to enable the receive.
uint32_t UART2Support_sendData(UART2_HWAttrs const *hwAttrs, size_t size, uint8_t *buf)
Function to send data.
void UART2Support_dmaStartTx(UART2_Handle handle)
Function to configure the tramsit DMA.
void UART2Support_disableTx(UART2_HWAttrs const *hwAttrs)
Function to disable the transmit interrupt.
int_fast16_t UART2Support_rxStatus2ErrorCode(uint32_t errorData)
Function to convert RX error status to a UART2 error code.
void UART2Support_disableRx(UART2_HWAttrs const *hwAttrs)
Function to disable the receive and receive interrupts.
© Copyright 1995-2021, Texas Instruments Incorporated. All rights reserved.
Trademarks | Privacy policy | Terms of use | Terms of sale