RTEMS 5.2
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
uart.h
1/* ---------------------------------------------------------------------------- */
2/* Atmel Microcontroller Software Support */
3/* SAM Software Package License */
4/* ---------------------------------------------------------------------------- */
5/* Copyright (c) 2015, Atmel Corporation */
6/* */
7/* All rights reserved. */
8/* */
9/* Redistribution and use in source and binary forms, with or without */
10/* modification, are permitted provided that the following condition is met: */
11/* */
12/* - Redistributions of source code must retain the above copyright notice, */
13/* this list of conditions and the disclaimer below. */
14/* */
15/* Atmel's name may not be used to endorse or promote products derived from */
16/* this software without specific prior written permission. */
17/* */
18/* DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR */
19/* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF */
20/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE */
21/* DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT, */
22/* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT */
23/* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, */
24/* OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF */
25/* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING */
26/* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, */
27/* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
28/* ---------------------------------------------------------------------------- */
29
30#ifndef UART_H
31#define UART_H
32
33
34//------------------------------------------------------------------------------
35// Global functions
36//------------------------------------------------------------------------------
37
38void UART_Configure(Uart *uart, uint32_t mode, uint32_t baudrate,
39 uint32_t masterClock);
40
41void UART_SetTransmitterEnabled(Uart *uart, uint8_t enabled);
42
43void UART_SetReceiverEnabled(Uart *uart, uint8_t enabled);
44
45void UART_PutChar(Uart *uart, uint8_t c);
46
47uint32_t UART_IsRxReady(Uart *uart);
48
49uint8_t UART_GetChar(Uart *uart);
50
51uint32_t UART_GetStatus(Uart *uart);
52
53void UART_EnableIt(Uart *uart, uint32_t mode);
54
55void UART_DisableIt(Uart *uart, uint32_t mode);
56
57uint32_t UART_GetItMask(Uart *uart);
58
59void UART_SendBuffer(Uart *uart, uint8_t *pBuffer, uint32_t BuffLen);
60
61void UART_ReceiveBuffer(Uart *uart, uint8_t *pBuffer, uint32_t BuffLen);
62
63void UART_CompareConfig(Uart *uart, uint8_t Val1, uint8_t Val2);
64
65uint32_t UART_IsTxReady(Uart *uart);
66
67#endif //#ifndef UART_H
68
uint32_t UART_IsRxReady(Uart *uart)
Return 1 if a character can be read in UART.
Definition: uart.c:113
void UART_DisableIt(Uart *uart, uint32_t mode)
Disable interrupt.
Definition: uart.c:194
uint32_t UART_GetItMask(Uart *uart)
Return interrupt mask.
Definition: uart.c:203
void UART_PutChar(Uart *uart, uint8_t c)
Sends one packet of data through the specified UART peripheral. This function operates synchronously,...
Definition: uart.c:158
void UART_SetTransmitterEnabled(Uart *uart, uint8_t enabled)
Enables or disables the transmitter of an UART peripheral.
Definition: uart.c:86
uint8_t UART_GetChar(Uart *uart)
Reads and returns a character from the UART.
Definition: uart.c:125
uint32_t UART_IsTxReady(Uart *uart)
Return 1 if a character can be send to UART.
Definition: uart.c:136
void UART_EnableIt(Uart *uart, uint32_t mode)
Enable interrupt.
Definition: uart.c:184
void UART_SetReceiverEnabled(Uart *uart, uint8_t enabled)
Enables or disables the receiver of an UART peripheral.
Definition: uart.c:101
void UART_Configure(Uart *uart, uint32_t mode, uint32_t baudrate, uint32_t masterClock)
Configures an UART peripheral with the specified parameters.
Definition: uart.c:58
uint32_t UART_GetStatus(Uart *uart)
Get present status.
Definition: uart.c:174
Uart hardware registers.
Definition: component_uart.h:41