summaryrefslogtreecommitdiff
path: root/digital/zigbit/bitcloud/stack/Components/HAL/include/uart.h
blob: a2a52d3801500d81b82bb8bd84d2a82cd3e29410 (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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
/************************************************************************//**
  \file uart.h

  \brief
    UART interface

  \author
    Atmel Corporation: http://www.atmel.com \n
    Support email: avr@atmel.com

  Copyright (c) 2008-2011, Atmel Corporation. All rights reserved.
  Licensed under Atmel's Limited License Agreement (BitCloudTM).

  \internal
    History:
    17.11.2010 D. Loskutnikov - Created.
******************************************************************************/
#ifndef _UART_H
#define _UART_H

/******************************************************************************
                        Includes section
******************************************************************************/
#include <usart.h>
#include <halUart.h>

/******************************************************************************
                    Functions prototypes section
******************************************************************************/
/**************************************************************************//**
\brief Open UART

\param[in] desc UART descriptor
\return 1 if success, -1 if error
******************************************************************************/
int HAL_OpenUart(HAL_UartDescriptor_t *descriptor);

/**************************************************************************//**
\brief Close UART

\param[in] desc UART descriptor
\return
******************************************************************************/
int HAL_CloseUart(HAL_UartDescriptor_t *descriptor);

/**************************************************************************//**
\brief Send contents of buffer over UART

\param[in] desc UART descriptor
\param[in] buffer buffer to be sent
\param[in] length buffer length
\return number of sent bytes or -1 if error
******************************************************************************/
int HAL_WriteUart(HAL_UartDescriptor_t *descriptor, uint8_t *buffer, uint16_t length);

/**************************************************************************//**
\brief Copy received by UART bytes to user-supplied buffer

\param[in] desc UART descriptor
\param[in] buffer buffer to store data
\param[in] length maximum length of buffer
\return number of actually copied bytes or -1 if error
******************************************************************************/
int HAL_ReadUart(HAL_UartDescriptor_t *descriptor, uint8_t *buffer, uint16_t length);

/**************************************************************************//**
\brief Check if any bytes are pending for transmission over UART

\param[in] desc descriptor
\return -1 if error, 0 if not, 1 if yes
******************************************************************************/
int HAL_IsUartTxEmpty(HAL_UartDescriptor_t *descriptor);

/**************************************************************************//**
\brief Store UART error conditions

\param[in] desc UART descriptor
\param[in] err error condition
******************************************************************************/
void halUartStoreError(HAL_UartDescriptor_t *desc, uint8_t err);

/**************************************************************************//**
\brief Send byte from FIFO over UART

\param[in] desc UART descriptor
******************************************************************************/
void halUartTx(HAL_UartDescriptor_t *desc);

/**************************************************************************//**
\brief Store received byte to FIFO

\param[in] desc UART descriptor
******************************************************************************/
void halUartStoreRx(HAL_UartDescriptor_t *desc);

/**************************************************************************//**
\brief UART transmission complete handler

\param[in] desc UART descriptor
******************************************************************************/
void halSigUartTransmissionComplete(HAL_UartDescriptor_t *desc);

/**************************************************************************//**
\brief UART reception complete handler

\param[in] desc UART descriptor
******************************************************************************/
void halSigUartReceptionComplete(HAL_UartDescriptor_t *desc);

/**************************************************************************//**
\brief UART error handler

\param[in] desc UART descriptor
******************************************************************************/
void halSigUartErrorOccurred(HAL_UartDescriptor_t *desc);

#endif /* _UART_H */
// eof uart.h