summaryrefslogtreecommitdiffstats
path: root/bsps/arm/atsam/include/libchip/include/usart.h
diff options
context:
space:
mode:
authorChris Johns <chrisj@rtems.org>2017-12-23 18:18:56 +1100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2018-01-25 08:45:26 +0100
commit2afb22b7e1ebcbe40373ff7e0efae7d207c655a9 (patch)
tree44759efe9374f13200a97e96d91bd9a2b7e5ce2a /bsps/arm/atsam/include/libchip/include/usart.h
parentMAINTAINERS: Add myself to Write After Approval. (diff)
downloadrtems-2afb22b7e1ebcbe40373ff7e0efae7d207c655a9.tar.bz2
Remove make preinstall
A speciality of the RTEMS build system was the make preinstall step. It copied header files from arbitrary locations into the build tree. The header files were included via the -Bsome/build/tree/path GCC command line option. This has at least seven problems: * The make preinstall step itself needs time and disk space. * Errors in header files show up in the build tree copy. This makes it hard for editors to open the right file to fix the error. * There is no clear relationship between source and build tree header files. This makes an audit of the build process difficult. * The visibility of all header files in the build tree makes it difficult to enforce API barriers. For example it is discouraged to use BSP-specifics in the cpukit. * An introduction of a new build system is difficult. * Include paths specified by the -B option are system headers. This may suppress warnings. * The parallel build had sporadic failures on some hosts. This patch removes the make preinstall step. All installed header files are moved to dedicated include directories in the source tree. Let @RTEMS_CPU@ be the target architecture, e.g. arm, powerpc, sparc, etc. Let @RTEMS_BSP_FAMILIY@ be a BSP family base directory, e.g. erc32, imx, qoriq, etc. The new cpukit include directories are: * cpukit/include * cpukit/score/cpu/@RTEMS_CPU@/include * cpukit/libnetworking The new BSP include directories are: * bsps/include * bsps/@RTEMS_CPU@/include * bsps/@RTEMS_CPU@/@RTEMS_BSP_FAMILIY@/include There are build tree include directories for generated files. The include directory order favours the most general header file, e.g. it is not possible to override general header files via the include path order. The "bootstrap -p" option was removed. The new "bootstrap -H" option should be used to regenerate the "headers.am" files. Update #3254.
Diffstat (limited to 'bsps/arm/atsam/include/libchip/include/usart.h')
-rw-r--r--bsps/arm/atsam/include/libchip/include/usart.h164
1 files changed, 164 insertions, 0 deletions
diff --git a/bsps/arm/atsam/include/libchip/include/usart.h b/bsps/arm/atsam/include/libchip/include/usart.h
new file mode 100644
index 0000000000..a1d1c378af
--- /dev/null
+++ b/bsps/arm/atsam/include/libchip/include/usart.h
@@ -0,0 +1,164 @@
+/* ---------------------------------------------------------------------------- */
+/* Atmel Microcontroller Software Support */
+/* SAM Software Package License */
+/* ---------------------------------------------------------------------------- */
+/* Copyright (c) 2015, Atmel Corporation */
+/* */
+/* All rights reserved. */
+/* */
+/* Redistribution and use in source and binary forms, with or without */
+/* modification, are permitted provided that the following condition is met: */
+/* */
+/* - Redistributions of source code must retain the above copyright notice, */
+/* this list of conditions and the disclaimer below. */
+/* */
+/* Atmel's name may not be used to endorse or promote products derived from */
+/* this software without specific prior written permission. */
+/* */
+/* DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR */
+/* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF */
+/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE */
+/* DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT, */
+/* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT */
+/* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, */
+/* OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF */
+/* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING */
+/* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, */
+/* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
+/* ---------------------------------------------------------------------------- */
+
+/**
+ * \file
+ *
+ * \par Purpose
+ *
+ * This module provides several definitions and methods for using an USART
+ * peripheral.
+ *
+ * \par Usage
+ *
+ * -# Enable the USART peripheral clock in the PMC.
+ * -# Enable the required USART PIOs (see pio.h).
+ * -# Configure the UART by calling USART_Configure.
+ * -# Enable the transmitter and/or the receiver of the USART using
+ * USART_SetTransmitterEnabled and USART_SetReceiverEnabled.
+ * -# Send data through the USART using the USART_Write methods.
+ * -# Receive data from the USART using the USART_Read functions; the
+ * availability of data can be polled
+ * with USART_IsDataAvailable.
+ * -# Disable the transmitter and/or the receiver of the USART with
+ * USART_SetTransmitterEnabled and USART_SetReceiverEnabled.
+ */
+
+#ifndef _USART_
+#define _USART_
+
+/*------------------------------------------------------------------------------
+ * Headers
+ *----------------------------------------------------------------------------*/
+
+#include "chip.h"
+
+#include <stdint.h>
+
+/*------------------------------------------------------------------------------
+ * Definitions
+ *----------------------------------------------------------------------------*/
+
+/** \section USART_mode USART modes
+ * This section lists several common operating modes for an USART peripheral.
+ *
+ * \b Modes
+ * - USART_MODE_ASYNCHRONOUS
+ * - USART_MODE_IRDA
+ */
+
+/** Basic asynchronous mode, i.e. 8 bits no parity.*/
+#define USART_MODE_ASYNCHRONOUS (US_MR_CHRL_8_BIT | US_MR_PAR_NO)
+
+#define MAX_RX_TIMEOUT 131071
+
+/** IRDA mode*/
+#define USART_MODE_IRDA \
+ (US_MR_USART_MODE_IRDA | US_MR_CHRL_8_BIT | US_MR_PAR_NO | US_MR_FILTER)
+
+/** SPI mode*/
+#define AT91C_US_USMODE_SPIM 0xE
+#define US_SPI_CPOL_0 (0x0<<16)
+#define US_SPI_CPHA_0 (0x0<<8)
+#define US_SPI_CPOL_1 (0x1<<16)
+#define US_SPI_CPHA_1 (0x1<<8)
+#define US_SPI_BPMODE_0 (US_SPI_CPOL_0|US_SPI_CPHA_1)
+#define US_SPI_BPMODE_1 (US_SPI_CPOL_0|US_SPI_CPHA_0)
+#define US_SPI_BPMODE_2 (US_SPI_CPOL_1|US_SPI_CPHA_1)
+#define US_SPI_BPMODE_3 (US_SPI_CPOL_1|US_SPI_CPHA_0)
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/*------------------------------------------------------------------------------*/
+/* Exported functions */
+/*------------------------------------------------------------------------------*/
+
+
+void USART_Configure(Usart *pUsart, uint32_t mode, uint32_t baudrate,
+ uint32_t masterClock);
+
+void USART_SetBaudrate(Usart *pUsart, uint8_t OverSamp, uint32_t baudrate,
+ uint32_t masterClock);
+
+uint32_t USART_GetStatus(Usart *usart);
+
+
+void USART_ResetRx(Usart *pUsart);
+
+void USART_ResetTx(Usart *pUsart);
+
+void USART_EnableTx(Usart *pUsart);
+
+void USART_EnableRx(Usart *pUsart);
+
+void USART_DisableRx(Usart *pUsart);
+
+void USART_DisableTx(Usart *pUsart);
+
+void USART_EnableIt(Usart *usart, uint32_t mode);
+
+void USART_DisableIt(Usart *usart, uint32_t mode);
+
+uint32_t USART_GetItMask(Usart *usart);
+
+void USART_SetTransmitterEnabled(Usart *usart, uint8_t enabled);
+
+void USART_SetReceiverEnabled(Usart *usart, uint8_t enabled);
+
+void USART_SetRTSEnabled(Usart *usart, uint8_t enabled);
+
+void USART_Write(Usart *usart, uint16_t data, volatile uint32_t timeOut);
+
+uint16_t USART_Read(Usart *usart, volatile uint32_t timeOut);
+
+uint8_t USART_IsDataAvailable(Usart *usart);
+
+void USART_SetIrdaFilter(Usart *pUsart, uint8_t filter);
+
+void USART_PutChar(Usart *usart, uint8_t c);
+
+uint32_t USART_IsRxReady(Usart *usart);
+
+uint8_t USART_GetChar(Usart *usart);
+
+void USART_EnableRecvTimeOut(Usart *usart, uint32_t timeout);
+
+void USART_EnableTxTimeGaurd(Usart *pUsart, uint32_t TimeGaurd);
+
+void USART_AcknowledgeRxTimeOut(Usart *usart, uint8_t Periodic);
+
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* #ifndef _USART_ */
+