| Kévin Redon | 4cd3f7d | 2019-01-24 17:57:13 +0100 | [diff] [blame] | 1 | /** |
| 2 | * \file |
| 3 | * |
| 4 | * \brief USART related functionality declaration. |
| 5 | * |
| 6 | * Copyright (c) 2014-2018 Microchip Technology Inc. and its subsidiaries. |
| 7 | * |
| 8 | * \asf_license_start |
| 9 | * |
| 10 | * \page License |
| 11 | * |
| 12 | * Subject to your compliance with these terms, you may use Microchip |
| 13 | * software and any derivatives exclusively with Microchip products. |
| 14 | * It is your responsibility to comply with third party license terms applicable |
| 15 | * to your use of third party software (including open source software) that |
| 16 | * may accompany Microchip software. |
| 17 | * |
| 18 | * THIS SOFTWARE IS SUPPLIED BY MICROCHIP "AS IS". NO WARRANTIES, |
| 19 | * WHETHER EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS SOFTWARE, |
| 20 | * INCLUDING ANY IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, |
| 21 | * AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT WILL MICROCHIP BE |
| 22 | * LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE, INCIDENTAL OR CONSEQUENTIAL |
| 23 | * LOSS, DAMAGE, COST OR EXPENSE OF ANY KIND WHATSOEVER RELATED TO THE |
| 24 | * SOFTWARE, HOWEVER CAUSED, EVEN IF MICROCHIP HAS BEEN ADVISED OF THE |
| 25 | * POSSIBILITY OR THE DAMAGES ARE FORESEEABLE. TO THE FULLEST EXTENT |
| 26 | * ALLOWED BY LAW, MICROCHIP'S TOTAL LIABILITY ON ALL CLAIMS IN ANY WAY |
| 27 | * RELATED TO THIS SOFTWARE WILL NOT EXCEED THE AMOUNT OF FEES, IF ANY, |
| 28 | * THAT YOU HAVE PAID DIRECTLY TO MICROCHIP FOR THIS SOFTWARE. |
| 29 | * |
| 30 | * \asf_license_stop |
| 31 | * |
| 32 | */ |
| 33 | |
| 34 | #ifndef _HPL_USART_H_INCLUDED |
| 35 | #define _HPL_USART_H_INCLUDED |
| 36 | |
| 37 | /** |
| 38 | * \addtogroup HPL USART SYNC |
| 39 | * |
| 40 | * \section hpl_usart_sync_rev Revision History |
| 41 | * - v1.0.0 Initial Release |
| 42 | * |
| 43 | *@{ |
| 44 | */ |
| 45 | |
| 46 | #include <compiler.h> |
| 47 | |
| 48 | #ifdef __cplusplus |
| 49 | extern "C" { |
| 50 | #endif |
| 51 | |
| 52 | /** |
| 53 | * \brief USART flow control state |
| 54 | */ |
| 55 | union usart_flow_control_state { |
| 56 | struct { |
| 57 | uint8_t cts : 1; |
| 58 | uint8_t rts : 1; |
| 59 | uint8_t unavailable : 1; |
| 60 | uint8_t reserved : 5; |
| 61 | } bit; |
| 62 | uint8_t value; |
| 63 | }; |
| 64 | |
| 65 | /** |
| 66 | * \brief USART baud rate mode |
| 67 | */ |
| 68 | enum usart_baud_rate_mode { USART_BAUDRATE_ASYNCH_ARITHMETIC, USART_BAUDRATE_ASYNCH_FRACTIONAL, USART_BAUDRATE_SYNCH }; |
| 69 | |
| 70 | /** |
| 71 | * \brief USART data order |
| 72 | */ |
| 73 | enum usart_data_order { USART_DATA_ORDER_MSB = 0, USART_DATA_ORDER_LSB = 1 }; |
| 74 | |
| 75 | /** |
| 76 | * \brief USART mode |
| 77 | */ |
| 78 | enum usart_mode { USART_MODE_ASYNCHRONOUS = 0, USART_MODE_SYNCHRONOUS = 1 }; |
| 79 | |
| 80 | /** |
| 81 | * \brief USART parity |
| 82 | */ |
| 83 | enum usart_parity { |
| 84 | USART_PARITY_EVEN = 0, |
| 85 | USART_PARITY_ODD = 1, |
| 86 | USART_PARITY_NONE = 2, |
| 87 | USART_PARITY_SPACE = 3, |
| 88 | USART_PARITY_MARK = 4 |
| 89 | }; |
| 90 | |
| 91 | /** |
| 92 | * \brief USART stop bits mode |
| 93 | */ |
| 94 | enum usart_stop_bits { USART_STOP_BITS_ONE = 0, USART_STOP_BITS_TWO = 1, USART_STOP_BITS_ONE_P_FIVE = 2 }; |
| 95 | |
| 96 | /** |
| 97 | * \brief USART character size |
| 98 | */ |
| 99 | enum usart_character_size { |
| 100 | USART_CHARACTER_SIZE_8BITS = 0, |
| 101 | USART_CHARACTER_SIZE_9BITS = 1, |
| 102 | USART_CHARACTER_SIZE_5BITS = 5, |
| 103 | USART_CHARACTER_SIZE_6BITS = 6, |
| 104 | USART_CHARACTER_SIZE_7BITS = 7 |
| 105 | }; |
| 106 | |
| 107 | //@} |
| 108 | |
| 109 | #ifdef __cplusplus |
| 110 | } |
| 111 | #endif |
| 112 | /**@}*/ |
| 113 | #endif /* _HPL_USART_H_INCLUDED */ |