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_uart_edma.h@147:ba84b7dc41a7, 2016-09-10 (annotated)

Committer:
JojoS
Date:
Sat Sep 10 15:32:04 2016 +0000
Revision:
147:ba84b7dc41a7
Parent:
144:ef7eb2e8f9f7 
added prescaler for 16 bit timers (solution as in LPC11xx), default prescaler 31 for max 28 ms period time

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_UART_EDMA_H_
<> 144:ef7eb2e8f9f7 31 #define _FSL_UART_EDMA_H_
<> 144:ef7eb2e8f9f7 32
<> 144:ef7eb2e8f9f7 33 #include "fsl_uart.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 uart_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 _uart_edma_handle uart_edma_handle_t;
<> 144:ef7eb2e8f9f7 50
<> 144:ef7eb2e8f9f7 51 /*! @brief UART transfer callback function. */
<> 144:ef7eb2e8f9f7 52 typedef void (*uart_edma_transfer_callback_t)(UART_Type *base,
<> 144:ef7eb2e8f9f7 53 uart_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 UART eDMA handle
<> 144:ef7eb2e8f9f7 59 */
<> 144:ef7eb2e8f9f7 60 struct _uart_edma_handle
<> 144:ef7eb2e8f9f7 61 {
<> 144:ef7eb2e8f9f7 62 uart_edma_transfer_callback_t callback; /*!< Callback function. */
<> 144:ef7eb2e8f9f7 63 void *userData; /*!< UART 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 UART handle which is used in transactional functions.
<> 144:ef7eb2e8f9f7 89 * @param base UART peripheral base address.
<> 144:ef7eb2e8f9f7 90 * @param handle Pointer to uart_edma_handle_t structure.
<> 144:ef7eb2e8f9f7 91 * @param callback UART callback, NULL means no callback.
<> 144:ef7eb2e8f9f7 92 * @param userData User callback function data.
<> 144:ef7eb2e8f9f7 93 * @param rxEdmaHandle User requested DMA handle for RX DMA transfer.
<> 144:ef7eb2e8f9f7 94 * @param txEdmaHandle User requested DMA handle for TX DMA transfer.
<> 144:ef7eb2e8f9f7 95 */
<> 144:ef7eb2e8f9f7 96 void UART_TransferCreateHandleEDMA(UART_Type *base,
<> 144:ef7eb2e8f9f7 97 uart_edma_handle_t *handle,
<> 144:ef7eb2e8f9f7 98 uart_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 UART peripheral base address.
<> 144:ef7eb2e8f9f7 110 * @param handle UART handle pointer.
<> 144:ef7eb2e8f9f7 111 * @param xfer UART eDMA transfer structure. See #uart_transfer_t.
<> 144:ef7eb2e8f9f7 112 * @retval kStatus_Success if succeed, others failed.
<> 144:ef7eb2e8f9f7 113 * @retval kStatus_UART_TxBusy Previous transfer on going.
<> 144:ef7eb2e8f9f7 114 * @retval kStatus_InvalidArgument Invalid argument.
<> 144:ef7eb2e8f9f7 115 */
<> 144:ef7eb2e8f9f7 116 status_t UART_SendEDMA(UART_Type *base, uart_edma_handle_t *handle, uart_transfer_t *xfer);
<> 144:ef7eb2e8f9f7 117
<> 144:ef7eb2e8f9f7 118 /*!
<> 144:ef7eb2e8f9f7 119 * @brief Receive data using eDMA.
<> 144:ef7eb2e8f9f7 120 *
<> 144:ef7eb2e8f9f7 121 * This function receives data using eDMA. This is a 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 UART peripheral base address.
<> 144:ef7eb2e8f9f7 125 * @param handle Pointer to uart_edma_handle_t structure.
<> 144:ef7eb2e8f9f7 126 * @param xfer UART eDMA transfer structure. See #uart_transfer_t.
<> 144:ef7eb2e8f9f7 127 * @retval kStatus_Success if succeed, others failed.
<> 144:ef7eb2e8f9f7 128 * @retval kStatus_UART_RxBusy Previous transfer on going.
<> 144:ef7eb2e8f9f7 129 * @retval kStatus_InvalidArgument Invalid argument.
<> 144:ef7eb2e8f9f7 130 */
<> 144:ef7eb2e8f9f7 131 status_t UART_ReceiveEDMA(UART_Type *base, uart_edma_handle_t *handle, uart_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 sent data using eDMA.
<> 144:ef7eb2e8f9f7 137 *
<> 144:ef7eb2e8f9f7 138 * @param base UART peripheral base address.
<> 144:ef7eb2e8f9f7 139 * @param handle Pointer to uart_edma_handle_t structure.
<> 144:ef7eb2e8f9f7 140 */
<> 144:ef7eb2e8f9f7 141 void UART_TransferAbortSendEDMA(UART_Type *base, uart_edma_handle_t *handle);
<> 144:ef7eb2e8f9f7 142
<> 144:ef7eb2e8f9f7 143 /*!
<> 144:ef7eb2e8f9f7 144 * @brief Aborts the receive data using eDMA.
<> 144:ef7eb2e8f9f7 145 *
<> 144:ef7eb2e8f9f7 146 * This function aborts receive data using eDMA.
<> 144:ef7eb2e8f9f7 147 *
<> 144:ef7eb2e8f9f7 148 * @param base UART peripheral base address.
<> 144:ef7eb2e8f9f7 149 * @param handle Pointer to uart_edma_handle_t structure.
<> 144:ef7eb2e8f9f7 150 */
<> 144:ef7eb2e8f9f7 151 void UART_TransferAbortReceiveEDMA(UART_Type *base, uart_edma_handle_t *handle);
<> 144:ef7eb2e8f9f7 152
<> 144:ef7eb2e8f9f7 153 /*!
<> 144:ef7eb2e8f9f7 154 * @brief Get the number of bytes that have been written to UART TX register.
<> 144:ef7eb2e8f9f7 155 *
<> 144:ef7eb2e8f9f7 156 * This function gets the number of bytes that have been written to UART TX
<> 144:ef7eb2e8f9f7 157 * register by DMA.
<> 144:ef7eb2e8f9f7 158 *
<> 144:ef7eb2e8f9f7 159 * @param base UART peripheral base address.
<> 144:ef7eb2e8f9f7 160 * @param handle UART 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 UART_TransferGetSendCountEDMA(UART_Type *base, uart_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 UART peripheral base address.
<> 144:ef7eb2e8f9f7 174 * @param handle UART 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 UART_TransferGetReceiveCountEDMA(UART_Type *base, uart_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_UART_EDMA_H_ */