added prescaler for 16 bit pwm in LPC1347 target
Fork of mbed-dev by
targets/hal/TARGET_Freescale/TARGET_KSDK2_MCUS/TARGET_KL43Z/drivers/fsl_flexio_uart_dma.h
- Committer:
- <>
- Date:
- 2016-09-02
- Revision:
- 144:ef7eb2e8f9f7
File content as of revision 144:ef7eb2e8f9f7:
/* * Copyright (c) 2015, Freescale Semiconductor, Inc. * All rights reserved. * * 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 Freescale Semiconductor, Inc. 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_FLEXIO_UART_DMA_H_ #define _FSL_FLEXIO_UART_DMA_H_ #include "fsl_flexio_uart.h" #include "fsl_dmamux.h" #include "fsl_dma.h" /*! * @addtogroup flexio_dma_uart * @{ */ /*! @file*/ /******************************************************************************* * Definitions ******************************************************************************/ /* Forward declaration of the handle typedef. */ typedef struct _flexio_uart_dma_handle flexio_uart_dma_handle_t; /*! @brief UART transfer callback function. */ typedef void (*flexio_uart_dma_transfer_callback_t)(FLEXIO_UART_Type *base, flexio_uart_dma_handle_t *handle, status_t status, void *userData); /*! * @brief UART DMA handle */ struct _flexio_uart_dma_handle { flexio_uart_dma_transfer_callback_t callback; /*!< Callback function. */ void *userData; /*!< UART callback function parameter.*/ size_t txSize; /*!< Total bytes to be sent. */ size_t rxSize; /*!< Total bytes to be received. */ dma_handle_t *txDmaHandle; /*!< The DMA TX channel used. */ dma_handle_t *rxDmaHandle; /*!< The DMA RX channel used. */ volatile uint8_t txState; /*!< TX transfer state. */ volatile uint8_t rxState; /*!< RX transfer state */ }; /******************************************************************************* * API ******************************************************************************/ #if defined(__cplusplus) extern "C" { #endif /*! * @name eDMA transactional * @{ */ /*! * @brief Initializes the FLEXIO_UART handle which is used in transactional functions * * @param base Pointer to FLEXIO_UART_Type structure. * @param handle Pointer to flexio_uart_dma_handle_t structure. * @param callback FlexIO UART callback, NULL means no callback. * @param userData User callback function data. * @param txDmaHandle User requested DMA handle for TX DMA transfer. * @param rxDmaHandle User requested DMA handle for RX DMA transfer. * @retval kStatus_Success Successfully create the handle. * @retval kStatus_OutOfRange The FlexIO UART DMA type/handle table out of range. */ status_t FLEXIO_UART_TransferCreateHandleDMA(FLEXIO_UART_Type *base, flexio_uart_dma_handle_t *handle, flexio_uart_dma_transfer_callback_t callback, void *userData, dma_handle_t *txDmaHandle, dma_handle_t *rxDmaHandle); /*! * @brief Sends data using DMA. * * This function send data using DMA, this is non-blocking function, which return * right away. When all data have been sent out, the send callback function is called. * * @param base Pointer to FLEXIO_UART_Type structure * @param handle Pointer to flexio_uart_dma_handle_t structure * @param xfer FLEXIO_UART DMA transfer structure, refer to #flexio_uart_transfer_t. * @retval kStatus_Success if succeed, others failed. * @retval kStatus_FLEXIO_UART_TxBusy Previous transfer on going. */ status_t FLEXIO_UART_TransferSendDMA(FLEXIO_UART_Type *base, flexio_uart_dma_handle_t *handle, flexio_uart_transfer_t *xfer); /*! * @brief Receives data using DMA. * * This function receives data using DMA. This is non-blocking function, which returns * right away. When all data have been received, the receive callback function is called. * * @param base Pointer to FLEXIO_UART_Type structure * @param handle Pointer to flexio_uart_dma_handle_t structure * @param xfer FLEXIO_UART DMA transfer sturcture, refer to #flexio_uart_transfer_t. * @retval kStatus_Success if succeed, others failed. * @retval kStatus_FLEXIO_UART_RxBusy Previous transfer on going. */ status_t FLEXIO_UART_TransferReceiveDMA(FLEXIO_UART_Type *base, flexio_uart_dma_handle_t *handle, flexio_uart_transfer_t *xfer); /*! * @brief Aborts the sent data which using DMA. * * This function aborts the sent data which using DMA. * * @param base Pointer to FLEXIO_UART_Type structure * @param handle Pointer to flexio_uart_dma_handle_t structure */ void FLEXIO_UART_TransferAbortSendDMA(FLEXIO_UART_Type *base, flexio_uart_dma_handle_t *handle); /*! * @brief Aborts the receive data which using DMA. * * This function aborts the receive data which using DMA. * * @param base Pointer to FLEXIO_UART_Type structure * @param handle Pointer to flexio_uart_dma_handle_t structure */ void FLEXIO_UART_TransferAbortReceiveDMA(FLEXIO_UART_Type *base, flexio_uart_dma_handle_t *handle); /*! * @brief Gets the number of bytes still not sent out. * * This function gets the number of bytes still not sent out. * * @param base Pointer to FLEXIO_UART_Type structure * @param handle Pointer to flexio_uart_dma_handle_t structure * @param count Number of bytes sent so far by the non-blocking transaction. */ status_t FLEXIO_UART_TransferGetSendCountDMA(FLEXIO_UART_Type *base, flexio_uart_dma_handle_t *handle, size_t *count); /*! * @brief Gets the number of bytes still not received. * * This function gets the number of bytes still not received. * * @param base Pointer to FLEXIO_UART_Type structure * @param handle Pointer to flexio_uart_dma_handle_t structure * @param count Number of bytes received so far by the non-blocking transaction. */ status_t FLEXIO_UART_TransferGetReceiveCountDMA(FLEXIO_UART_Type *base, flexio_uart_dma_handle_t *handle, size_t *count); /*@}*/ #if defined(__cplusplus) } #endif /*! @}*/ #endif /* _FSL_UART_DMA_H_ */