summaryrefslogtreecommitdiff
path: root/drivers/fsl_uart_freertos.h
diff options
context:
space:
mode:
authorDominik Sliwa <dominik.sliwa@toradex.com>2018-10-30 16:31:29 +0100
committerDominik Sliwa <dominik.sliwa@toradex.com>2018-10-31 11:54:38 +0100
commit56e86c626df3dbf74c1021210636a7c5d92a49ce (patch)
tree54ba9581ad14d838d8926e4e6d673befad1f932c /drivers/fsl_uart_freertos.h
parent4dfc5493fec8f6290457446b0478695b153da60a (diff)
Signed-off-by: Dominik Sliwa <dominik.sliwa@toradex.com>
Diffstat (limited to 'drivers/fsl_uart_freertos.h')
-rw-r--r--drivers/fsl_uart_freertos.h166
1 files changed, 0 insertions, 166 deletions
diff --git a/drivers/fsl_uart_freertos.h b/drivers/fsl_uart_freertos.h
deleted file mode 100644
index 0525e23..0000000
--- a/drivers/fsl_uart_freertos.h
+++ /dev/null
@@ -1,166 +0,0 @@
-/*
- * Copyright (c) 2015, Freescale Semiconductor, Inc.
- * Copyright 2016-2017 NXP
- *
- * Redistribution and use in source and binary forms, with or without modification,
- * are permitted provided that the following conditions are met:
- *
- * o Redistributions of source code must retain the above copyright notice, this list
- * of conditions and the following disclaimer.
- *
- * o Redistributions in binary form must reproduce the above copyright notice, this
- * list of conditions and the following disclaimer in the documentation and/or
- * other materials provided with the distribution.
- *
- * o Neither the name of the copyright holder nor the names of its
- * contributors may be used to endorse or promote products derived from this
- * software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
- * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS 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.
- */
-#ifndef __FSL_UART_RTOS_H__
-#define __FSL_UART_RTOS_H__
-
-#include "FreeRTOSConfig.h"
-#include "fsl_uart.h"
-#include <FreeRTOS.h>
-#include <event_groups.h>
-#include <semphr.h>
-
-/*!
- * @addtogroup uart_freertos_driver
- * @{
- */
-
-/*******************************************************************************
- * Definitions
- ******************************************************************************/
-
-/*! @brief UART configuration structure */
-typedef struct _uart_rtos_config
-{
- UART_Type *base; /*!< UART base address */
- uint32_t srcclk; /*!< UART source clock in Hz*/
- uint32_t baudrate; /*!< Desired communication speed */
- uart_parity_mode_t parity; /*!< Parity setting */
- uart_stop_bit_count_t stopbits; /*!< Number of stop bits to use */
- uint8_t *buffer; /*!< Buffer for background reception */
- uint32_t buffer_size; /*!< Size of buffer for background reception */
-} uart_rtos_config_t;
-
-/*!
-* @cond RTOS_PRIVATE
-* @name UART FreeRTOS handler
-*
-* These are the only valid states for txEvent and rxEvent (uart_rtos_handle_t).
-*/
-/*@{*/
-/*! @brief Event flag - transfer complete. */
-#define RTOS_UART_COMPLETE 0x1
-/*! @brief Event flag - ring buffer overrun. */
-#define RTOS_UART_RING_BUFFER_OVERRUN 0x2
-/*! @brief Event flag - hardware buffer overrun. */
-#define RTOS_UART_HARDWARE_BUFFER_OVERRUN 0x4
-/*@}*/
-
-/*! @brief UART FreeRTOS transfer structure. */
-typedef struct _uart_rtos_handle
-{
- UART_Type *base; /*!< UART base address */
- uart_transfer_t txTransfer; /*!< TX transfer structure */
- uart_transfer_t rxTransfer; /*!< RX transfer structure */
- SemaphoreHandle_t rxSemaphore; /*!< RX semaphore for resource sharing */
- SemaphoreHandle_t txSemaphore; /*!< TX semaphore for resource sharing */
- EventGroupHandle_t rxEvent; /*!< RX completion event */
- EventGroupHandle_t txEvent; /*!< TX completion event */
- void *t_state; /*!< Transactional state of the underlying driver */
-#if (configSUPPORT_STATIC_ALLOCATION == 1)
- StaticSemaphore_t txSemaphoreBuffer; /*!< Statically allocated memory for txSemaphore */
- StaticSemaphore_t rxSemaphoreBuffer; /*!< Statically allocated memory for rxSemaphore */
- StaticEventGroup_t txEventBuffer; /*!< Statically allocated memory for txEvent */
- StaticEventGroup_t rxEventBuffer; /*!< Statically allocated memory for rxEvent */
-#endif
-} uart_rtos_handle_t;
-/*! \endcond */
-
-/*******************************************************************************
- * API
- ******************************************************************************/
-
-#if defined(__cplusplus)
-extern "C" {
-#endif
-
-/*!
- * @name UART RTOS Operation
- * @{
- */
-
-/*!
- * @brief Initializes a UART instance for operation in RTOS.
- *
- * @param handle The RTOS UART handle, the pointer to an allocated space for RTOS context.
- * @param t_handle The pointer to the allocated space to store the transactional layer internal state.
- * @param cfg The pointer to the parameters required to configure the UART after initialization.
- * @return 0 succeed; otherwise fail.
- */
-int UART_RTOS_Init(uart_rtos_handle_t *handle, uart_handle_t *t_handle, const uart_rtos_config_t *cfg);
-
-/*!
- * @brief Deinitializes a UART instance for operation.
- *
- * This function deinitializes the UART module, sets all register values to reset value,
- * and frees the resources.
- *
- * @param handle The RTOS UART handle.
- */
-int UART_RTOS_Deinit(uart_rtos_handle_t *handle);
-
-/*!
- * @name UART transactional Operation
- * @{
- */
-
-/*!
- * @brief Sends data in the background.
- *
- * This function sends data. It is a synchronous API.
- * If the hardware buffer is full, the task is in the blocked state.
- *
- * @param handle The RTOS UART handle.
- * @param buffer The pointer to the buffer to send.
- * @param length The number of bytes to send.
- */
-int UART_RTOS_Send(uart_rtos_handle_t *handle, const uint8_t *buffer, uint32_t length);
-
-/*!
- * @brief Receives data.
- *
- * This function receives data from UART. It is a synchronous API. If data is immediately available,
- * it is returned immediately and the number of bytes received.
- *
- * @param handle The RTOS UART handle.
- * @param buffer The pointer to the buffer to write received data.
- * @param length The number of bytes to receive.
- * @param received The pointer to a variable of size_t where the number of received data is filled.
- */
-int UART_RTOS_Receive(uart_rtos_handle_t *handle, uint8_t *buffer, uint32_t length, size_t *received);
-
-/* @} */
-
-#if defined(__cplusplus)
-}
-#endif
-
-/*! @}*/
-
-#endif /* __FSL_UART_RTOS_H__ */