summaryrefslogtreecommitdiffstats
path: root/bsps/arm/atsam/include/libchip/include/usart_dma.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_dma.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_dma.h')
-rw-r--r--bsps/arm/atsam/include/libchip/include/usart_dma.h137
1 files changed, 137 insertions, 0 deletions
diff --git a/bsps/arm/atsam/include/libchip/include/usart_dma.h b/bsps/arm/atsam/include/libchip/include/usart_dma.h
new file mode 100644
index 0000000000..0329cd1818
--- /dev/null
+++ b/bsps/arm/atsam/include/libchip/include/usart_dma.h
@@ -0,0 +1,137 @@
+/* ---------------------------------------------------------------------------- */
+/* 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
+ *
+ * Implementation of USART driver, transfer data through DMA.
+ *
+ */
+
+#ifndef _USART_DMA_H_
+#define _USART_DMA_H_
+
+/*----------------------------------------------------------------------------
+ * Headers
+ *----------------------------------------------------------------------------*/
+
+#include "chip.h"
+
+/*----------------------------------------------------------------------------
+ * Definitions
+ *----------------------------------------------------------------------------*/
+
+/** An unspecified error has occurred.*/
+#define USARTD_ERROR 1
+
+/** USART driver is currently in use.*/
+#define USARTD_ERROR_LOCK 2
+
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/*----------------------------------------------------------------------------
+ * Types
+ *----------------------------------------------------------------------------*/
+
+/** USART transfer complete callback. */
+typedef void (*UsartdCallback)(uint8_t, void *);
+
+/** \brief usart Transfer Request prepared by the application upper layer.
+ *
+ * This structure is sent to the USART_Send or USART_Rcv to start the transfer.
+ * At the end of the transfer, the callback is invoked by the interrupt handler.
+ */
+typedef struct {
+ /** Pointer to the Buffer. */
+ uint8_t *pBuff;
+ /** Buff size in bytes. */
+ uint32_t BuffSize;
+ /** Dma channel num. */
+ uint8_t ChNum;
+ /** Callback function invoked at the end of transfer. */
+ UsartdCallback callback;
+ /** Callback arguments. */
+ void *pArgument;
+ /** flag to indicate the current transfer progress */
+ volatile uint8_t dmaProgress;
+ /* DMA LLI structure */
+ LinkedListDescriporView1 *pLLIview;
+ /* DMA transfer type */
+ eXdmadProgState dmaProgrammingMode;
+ /* DMA LLI size or num of micro block*/
+ uint16_t dmaBlockSize;
+ /* Flag using ring buffer or FiFo*/
+ uint8_t dmaRingBuffer;
+} UsartChannel;
+
+/** Constant structure associated with USART port. This structure prevents
+ client applications to have access in the same time. */
+typedef struct {
+ /** USART Id as defined in the product datasheet */
+ uint8_t usartId;
+ /** Pointer to USART Hardware registers */
+ Usart *pUsartHw;
+ /** Current Usart Rx channel */
+ UsartChannel *pRxChannel;
+ /** Current Usart Tx channel */
+ UsartChannel *pTxChannel;
+ /** Pointer to DMA driver */
+ sXdmad *pXdmad;
+} UsartDma;
+
+/*----------------------------------------------------------------------------
+ * Exported functions
+ *----------------------------------------------------------------------------*/
+
+uint32_t USARTD_Configure(UsartDma *pUsartd ,
+ uint8_t USARTId,
+ uint32_t UsartMode,
+ uint32_t BaudRate,
+ uint32_t UsartClk);
+
+uint32_t USARTD_EnableTxChannels(UsartDma *pUsartd, UsartChannel *pTxCh);
+
+uint32_t USARTD_EnableRxChannels(UsartDma *pUsartd, UsartChannel *pRxCh);
+
+uint32_t USARTD_DisableTxChannels(UsartDma *pUsartd, UsartChannel *pTxCh);
+
+uint32_t USARTD_DisableRxChannels(UsartDma *pUsartd, UsartChannel *pTxCh);
+
+uint32_t USARTD_SendData(UsartDma *pUsartd);
+
+uint32_t USARTD_RcvData(UsartDma *pUsartd);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* #ifndef _USART_DMA_ */