Johannes Stratmann / mbed-dev

added prescaler for 16 bit pwm in LPC1347 target

Fork of mbed-dev by mbed official

targets/hal/TARGET_Freescale/TARGET_KSDK2_MCUS/TARGET_K66F/drivers/fsl_lpuart_edma.h@144:ef7eb2e8f9f7, 2016-09-02 (annotated)

Committer:
<>
Date:
Fri Sep 02 15:07:44 2016 +0100
Revision:
144:ef7eb2e8f9f7
This updates the lib to the mbed lib v125

Who changed what in which revision?

UserRevisionLine numberNew contents of line
<> 144:ef7eb2e8f9f7 1 /*
<> 144:ef7eb2e8f9f7 2 * Copyright (c) 2015, Freescale Semiconductor, Inc.
<> 144:ef7eb2e8f9f7 3 * All rights reserved.
<> 144:ef7eb2e8f9f7 4 *
<> 144:ef7eb2e8f9f7 5 * Redistribution and use in source and binary forms, with or without modification,
<> 144:ef7eb2e8f9f7 6 * are permitted provided that the following conditions are met:
<> 144:ef7eb2e8f9f7 7 *
<> 144:ef7eb2e8f9f7 8 * o Redistributions of source code must retain the above copyright notice, this list
<> 144:ef7eb2e8f9f7 9 * of conditions and the following disclaimer.
<> 144:ef7eb2e8f9f7 10 *
<> 144:ef7eb2e8f9f7 11 * o Redistributions in binary form must reproduce the above copyright notice, this
<> 144:ef7eb2e8f9f7 12 * list of conditions and the following disclaimer in the documentation and/or
<> 144:ef7eb2e8f9f7 13 * other materials provided with the distribution.
<> 144:ef7eb2e8f9f7 14 *
<> 144:ef7eb2e8f9f7 15 * o Neither the name of Freescale Semiconductor, Inc. nor the names of its
<> 144:ef7eb2e8f9f7 16 * contributors may be used to endorse or promote products derived from this
<> 144:ef7eb2e8f9f7 17 * software without specific prior written permission.
<> 144:ef7eb2e8f9f7 18 *
<> 144:ef7eb2e8f9f7 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
<> 144:ef7eb2e8f9f7 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
<> 144:ef7eb2e8f9f7 21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
<> 144:ef7eb2e8f9f7 22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
<> 144:ef7eb2e8f9f7 23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
<> 144:ef7eb2e8f9f7 24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
<> 144:ef7eb2e8f9f7 25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
<> 144:ef7eb2e8f9f7 26 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
<> 144:ef7eb2e8f9f7 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
<> 144:ef7eb2e8f9f7 28 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
<> 144:ef7eb2e8f9f7 29 */
<> 144:ef7eb2e8f9f7 30 #ifndef _FSL_LPUART_EDMA_H_
<> 144:ef7eb2e8f9f7 31 #define _FSL_LPUART_EDMA_H_
<> 144:ef7eb2e8f9f7 32
<> 144:ef7eb2e8f9f7 33 #include "fsl_lpuart.h"
<> 144:ef7eb2e8f9f7 34 #include "fsl_dmamux.h"
<> 144:ef7eb2e8f9f7 35 #include "fsl_edma.h"
<> 144:ef7eb2e8f9f7 36
<> 144:ef7eb2e8f9f7 37 /*!
<> 144:ef7eb2e8f9f7 38 * @addtogroup lpuart_edma_driver
<> 144:ef7eb2e8f9f7 39 * @{
<> 144:ef7eb2e8f9f7 40 */
<> 144:ef7eb2e8f9f7 41
<> 144:ef7eb2e8f9f7 42 /*! @file*/
<> 144:ef7eb2e8f9f7 43
<> 144:ef7eb2e8f9f7 44 /*******************************************************************************
<> 144:ef7eb2e8f9f7 45 * Definitions
<> 144:ef7eb2e8f9f7 46 ******************************************************************************/
<> 144:ef7eb2e8f9f7 47
<> 144:ef7eb2e8f9f7 48 /* Forward declaration of the handle typedef. */
<> 144:ef7eb2e8f9f7 49 typedef struct _lpuart_edma_handle lpuart_edma_handle_t;
<> 144:ef7eb2e8f9f7 50
<> 144:ef7eb2e8f9f7 51 /*! @brief LPUART transfer callback function. */
<> 144:ef7eb2e8f9f7 52 typedef void (*lpuart_edma_transfer_callback_t)(LPUART_Type *base,
<> 144:ef7eb2e8f9f7 53 lpuart_edma_handle_t *handle,
<> 144:ef7eb2e8f9f7 54 status_t status,
<> 144:ef7eb2e8f9f7 55 void *userData);
<> 144:ef7eb2e8f9f7 56
<> 144:ef7eb2e8f9f7 57 /*!
<> 144:ef7eb2e8f9f7 58 * @brief LPUART eDMA handle
<> 144:ef7eb2e8f9f7 59 */
<> 144:ef7eb2e8f9f7 60 struct _lpuart_edma_handle
<> 144:ef7eb2e8f9f7 61 {
<> 144:ef7eb2e8f9f7 62 lpuart_edma_transfer_callback_t callback; /*!< Callback function. */
<> 144:ef7eb2e8f9f7 63 void *userData; /*!< LPUART callback function parameter.*/
<> 144:ef7eb2e8f9f7 64 size_t rxDataSizeAll; /*!< Size of the data to receive. */
<> 144:ef7eb2e8f9f7 65 size_t txDataSizeAll; /*!< Size of the data to send out. */
<> 144:ef7eb2e8f9f7 66
<> 144:ef7eb2e8f9f7 67 edma_handle_t *txEdmaHandle; /*!< The eDMA TX channel used. */
<> 144:ef7eb2e8f9f7 68 edma_handle_t *rxEdmaHandle; /*!< The eDMA RX channel used. */
<> 144:ef7eb2e8f9f7 69
<> 144:ef7eb2e8f9f7 70 volatile uint8_t txState; /*!< TX transfer state. */
<> 144:ef7eb2e8f9f7 71 volatile uint8_t rxState; /*!< RX transfer state */
<> 144:ef7eb2e8f9f7 72 };
<> 144:ef7eb2e8f9f7 73
<> 144:ef7eb2e8f9f7 74 /*******************************************************************************
<> 144:ef7eb2e8f9f7 75 * API
<> 144:ef7eb2e8f9f7 76 ******************************************************************************/
<> 144:ef7eb2e8f9f7 77
<> 144:ef7eb2e8f9f7 78 #if defined(__cplusplus)
<> 144:ef7eb2e8f9f7 79 extern "C" {
<> 144:ef7eb2e8f9f7 80 #endif
<> 144:ef7eb2e8f9f7 81
<> 144:ef7eb2e8f9f7 82 /*!
<> 144:ef7eb2e8f9f7 83 * @name eDMA transactional
<> 144:ef7eb2e8f9f7 84 * @{
<> 144:ef7eb2e8f9f7 85 */
<> 144:ef7eb2e8f9f7 86
<> 144:ef7eb2e8f9f7 87 /*!
<> 144:ef7eb2e8f9f7 88 * @brief Initializes the LPUART handle which is used in transactional functions.
<> 144:ef7eb2e8f9f7 89 * @param base LPUART peripheral base address.
<> 144:ef7eb2e8f9f7 90 * @param handle Pointer to lpuart_edma_handle_t structure.
<> 144:ef7eb2e8f9f7 91 * @param callback Callback function.
<> 144:ef7eb2e8f9f7 92 * @param userData User data.
<> 144:ef7eb2e8f9f7 93 * @param txEdmaHandle User requested DMA handle for TX DMA transfer.
<> 144:ef7eb2e8f9f7 94 * @param rxEdmaHandle User requested DMA handle for RX DMA transfer.
<> 144:ef7eb2e8f9f7 95 */
<> 144:ef7eb2e8f9f7 96 void LPUART_TransferCreateHandleEDMA(LPUART_Type *base,
<> 144:ef7eb2e8f9f7 97 lpuart_edma_handle_t *handle,
<> 144:ef7eb2e8f9f7 98 lpuart_edma_transfer_callback_t callback,
<> 144:ef7eb2e8f9f7 99 void *userData,
<> 144:ef7eb2e8f9f7 100 edma_handle_t *txEdmaHandle,
<> 144:ef7eb2e8f9f7 101 edma_handle_t *rxEdmaHandle);
<> 144:ef7eb2e8f9f7 102
<> 144:ef7eb2e8f9f7 103 /*!
<> 144:ef7eb2e8f9f7 104 * @brief Sends data using eDMA.
<> 144:ef7eb2e8f9f7 105 *
<> 144:ef7eb2e8f9f7 106 * This function sends data using eDMA. This is a non-blocking function, which returns
<> 144:ef7eb2e8f9f7 107 * right away. When all data is sent, the send callback function is called.
<> 144:ef7eb2e8f9f7 108 *
<> 144:ef7eb2e8f9f7 109 * @param base LPUART peripheral base address.
<> 144:ef7eb2e8f9f7 110 * @param handle LPUART handle pointer.
<> 144:ef7eb2e8f9f7 111 * @param xfer LPUART eDMA transfer structure. See #lpuart_transfer_t.
<> 144:ef7eb2e8f9f7 112 * @retval kStatus_Success if succeed, others failed.
<> 144:ef7eb2e8f9f7 113 * @retval kStatus_LPUART_TxBusy Previous transfer on going.
<> 144:ef7eb2e8f9f7 114 * @retval kStatus_InvalidArgument Invalid argument.
<> 144:ef7eb2e8f9f7 115 */
<> 144:ef7eb2e8f9f7 116 status_t LPUART_SendEDMA(LPUART_Type *base, lpuart_edma_handle_t *handle, lpuart_transfer_t *xfer);
<> 144:ef7eb2e8f9f7 117
<> 144:ef7eb2e8f9f7 118 /*!
<> 144:ef7eb2e8f9f7 119 * @brief Receives data using eDMA.
<> 144:ef7eb2e8f9f7 120 *
<> 144:ef7eb2e8f9f7 121 * This function receives data using eDMA. This is non-blocking function, which returns
<> 144:ef7eb2e8f9f7 122 * right away. When all data is received, the receive callback function is called.
<> 144:ef7eb2e8f9f7 123 *
<> 144:ef7eb2e8f9f7 124 * @param base LPUART peripheral base address.
<> 144:ef7eb2e8f9f7 125 * @param handle Pointer to lpuart_edma_handle_t structure.
<> 144:ef7eb2e8f9f7 126 * @param xfer LPUART eDMA transfer structure, refer to #lpuart_transfer_t.
<> 144:ef7eb2e8f9f7 127 * @retval kStatus_Success if succeed, others fail.
<> 144:ef7eb2e8f9f7 128 * @retval kStatus_LPUART_RxBusy Previous transfer ongoing.
<> 144:ef7eb2e8f9f7 129 * @retval kStatus_InvalidArgument Invalid argument.
<> 144:ef7eb2e8f9f7 130 */
<> 144:ef7eb2e8f9f7 131 status_t LPUART_ReceiveEDMA(LPUART_Type *base, lpuart_edma_handle_t *handle, lpuart_transfer_t *xfer);
<> 144:ef7eb2e8f9f7 132
<> 144:ef7eb2e8f9f7 133 /*!
<> 144:ef7eb2e8f9f7 134 * @brief Aborts the sent data using eDMA.
<> 144:ef7eb2e8f9f7 135 *
<> 144:ef7eb2e8f9f7 136 * This function aborts the sent data using eDMA.
<> 144:ef7eb2e8f9f7 137 *
<> 144:ef7eb2e8f9f7 138 * @param base LPUART peripheral base address.
<> 144:ef7eb2e8f9f7 139 * @param handle Pointer to lpuart_edma_handle_t structure.
<> 144:ef7eb2e8f9f7 140 */
<> 144:ef7eb2e8f9f7 141 void LPUART_TransferAbortSendEDMA(LPUART_Type *base, lpuart_edma_handle_t *handle);
<> 144:ef7eb2e8f9f7 142
<> 144:ef7eb2e8f9f7 143 /*!
<> 144:ef7eb2e8f9f7 144 * @brief Aborts the received data using eDMA.
<> 144:ef7eb2e8f9f7 145 *
<> 144:ef7eb2e8f9f7 146 * This function aborts the received data using eDMA.
<> 144:ef7eb2e8f9f7 147 *
<> 144:ef7eb2e8f9f7 148 * @param base LPUART peripheral base address.
<> 144:ef7eb2e8f9f7 149 * @param handle Pointer to lpuart_edma_handle_t structure.
<> 144:ef7eb2e8f9f7 150 */
<> 144:ef7eb2e8f9f7 151 void LPUART_TransferAbortReceiveEDMA(LPUART_Type *base, lpuart_edma_handle_t *handle);
<> 144:ef7eb2e8f9f7 152
<> 144:ef7eb2e8f9f7 153 /*!
<> 144:ef7eb2e8f9f7 154 * @brief Get the number of bytes that have been written to LPUART TX register.
<> 144:ef7eb2e8f9f7 155 *
<> 144:ef7eb2e8f9f7 156 * This function gets the number of bytes that have been written to LPUART TX
<> 144:ef7eb2e8f9f7 157 * register by DMA.
<> 144:ef7eb2e8f9f7 158 *
<> 144:ef7eb2e8f9f7 159 * @param base LPUART peripheral base address.
<> 144:ef7eb2e8f9f7 160 * @param handle LPUART handle pointer.
<> 144:ef7eb2e8f9f7 161 * @param count Send bytes count.
<> 144:ef7eb2e8f9f7 162 * @retval kStatus_NoTransferInProgress No send in progress.
<> 144:ef7eb2e8f9f7 163 * @retval kStatus_InvalidArgument Parameter is invalid.
<> 144:ef7eb2e8f9f7 164 * @retval kStatus_Success Get successfully through the parameter \p count;
<> 144:ef7eb2e8f9f7 165 */
<> 144:ef7eb2e8f9f7 166 status_t LPUART_TransferGetSendCountEDMA(LPUART_Type *base, lpuart_edma_handle_t *handle, uint32_t *count);
<> 144:ef7eb2e8f9f7 167
<> 144:ef7eb2e8f9f7 168 /*!
<> 144:ef7eb2e8f9f7 169 * @brief Get the number of bytes that have been received.
<> 144:ef7eb2e8f9f7 170 *
<> 144:ef7eb2e8f9f7 171 * This function gets the number of bytes that have been received.
<> 144:ef7eb2e8f9f7 172 *
<> 144:ef7eb2e8f9f7 173 * @param base LPUART peripheral base address.
<> 144:ef7eb2e8f9f7 174 * @param handle LPUART handle pointer.
<> 144:ef7eb2e8f9f7 175 * @param count Receive bytes count.
<> 144:ef7eb2e8f9f7 176 * @retval kStatus_NoTransferInProgress No receive in progress.
<> 144:ef7eb2e8f9f7 177 * @retval kStatus_InvalidArgument Parameter is invalid.
<> 144:ef7eb2e8f9f7 178 * @retval kStatus_Success Get successfully through the parameter \p count;
<> 144:ef7eb2e8f9f7 179 */
<> 144:ef7eb2e8f9f7 180 status_t LPUART_TransferGetReceiveCountEDMA(LPUART_Type *base, lpuart_edma_handle_t *handle, uint32_t *count);
<> 144:ef7eb2e8f9f7 181
<> 144:ef7eb2e8f9f7 182 /*@}*/
<> 144:ef7eb2e8f9f7 183
<> 144:ef7eb2e8f9f7 184 #if defined(__cplusplus)
<> 144:ef7eb2e8f9f7 185 }
<> 144:ef7eb2e8f9f7 186 #endif
<> 144:ef7eb2e8f9f7 187
<> 144:ef7eb2e8f9f7 188 /*! @}*/
<> 144:ef7eb2e8f9f7 189
<> 144:ef7eb2e8f9f7 190 #endif /* _FSL_LPUART_EDMA_H_ */