1 /**
2  * \file
3  *
4  * \brief USART related functionality declaration.
5  *
6  * Copyright (C) 2014 Atmel Corporation. All rights reserved.
7  *
8  * \asf_license_start
9  *
10  * \page License
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions are met:
14  *
15  * 1. Redistributions of source code must retain the above copyright notice,
16  *    this list of conditions and the following disclaimer.
17  *
18  * 2. Redistributions in binary form must reproduce the above copyright notice,
19  *    this list of conditions and the following disclaimer in the documentation
20  *    and/or other materials provided with the distribution.
21  *
22  * 3. The name of Atmel may not be used to endorse or promote products derived
23  *    from this software without specific prior written permission.
24  *
25  * 4. This software may only be redistributed and used in connection with an
26  *    Atmel microcontroller product.
27  *
28  * THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED
29  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
30  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
31  * EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR
32  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
34  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
36  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
37  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38  * POSSIBILITY OF SUCH DAMAGE.
39  *
40  * \asf_license_stop
41  *
42  */
43 
44 #ifndef _HPL_USART_H_INCLUDED
45 #define _HPL_USART_H_INCLUDED
46 
47 /**
48  * \addtogroup HPL USART SYNC
49  *
50  * \section hpl_usart_sync_rev Revision History
51  * - v1.0.0 Initial Release
52  *
53  *@{
54  */
55 
56 #include <compiler.h>
57 
58 #ifdef __cplusplus
59 extern "C" {
60 #endif
61 
62 /**
63  * \brief USART flow control state
64  */
65 union usart_flow_control_state {
66 	struct {
67 		uint8_t cts : 1;
68 		uint8_t rts : 1;
69 		uint8_t unavailable : 1;
70 		uint8_t reserved : 5;
71 	} bit;
72 	uint8_t value;
73 };
74 
75 /**
76  * \brief USART baud rate mode
77  */
78 enum usart_baud_rate_mode { USART_BAUDRATE_ASYNCH_ARITHMETIC, USART_BAUDRATE_ASYNCH_FRACTIONAL, USART_BAUDRATE_SYNCH };
79 
80 /**
81  * \brief USART data order
82  */
83 enum usart_data_order { USART_DATA_ORDER_MSB = 0, USART_DATA_ORDER_LSB = 1 };
84 
85 /**
86  * \brief USART mode
87  */
88 enum usart_mode { USART_MODE_ASYNCHRONOUS = 0, USART_MODE_SYNCHRONOUS = 1 };
89 
90 /**
91  * \brief USART parity
92  */
93 enum usart_parity {
94 	USART_PARITY_EVEN  = 0,
95 	USART_PARITY_ODD   = 1,
96 	USART_PARITY_NONE  = 2,
97 	USART_PARITY_SPACE = 3,
98 	USART_PARITY_MARK  = 4
99 };
100 
101 /**
102  * \brief USART stop bits mode
103  */
104 enum usart_stop_bits { USART_STOP_BITS_ONE = 0, USART_STOP_BITS_TWO = 1, USART_STOP_BITS_ONE_P_FIVE = 2 };
105 
106 /**
107  * \brief USART character size
108  */
109 enum usart_character_size {
110 	USART_CHARACTER_SIZE_8BITS = 0,
111 	USART_CHARACTER_SIZE_9BITS = 1,
112 	USART_CHARACTER_SIZE_5BITS = 5,
113 	USART_CHARACTER_SIZE_6BITS = 6,
114 	USART_CHARACTER_SIZE_7BITS = 7
115 };
116 
117 //@}
118 
119 #ifdef __cplusplus
120 }
121 #endif
122 /**@}*/
123 #endif /* _HPL_USART_H_INCLUDED */
124