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_KL43Z/drivers/fsl_lpuart_dma.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_LPUART_DMA_H_
<> 144:ef7eb2e8f9f7 31 #define _FSL_LPUART_DMA_H_
<> 144:ef7eb2e8f9f7 32
<> 144:ef7eb2e8f9f7 33 #include "fsl_lpuart.h"
<> 144:ef7eb2e8f9f7 34 #include "fsl_dma.h"
<> 144:ef7eb2e8f9f7 35
<> 144:ef7eb2e8f9f7 36 /*!
<> 144:ef7eb2e8f9f7 37 * @addtogroup lpuart_dma_driver
<> 144:ef7eb2e8f9f7 38 * @{
<> 144:ef7eb2e8f9f7 39 */
<> 144:ef7eb2e8f9f7 40
<> 144:ef7eb2e8f9f7 41 /*! @file*/
<> 144:ef7eb2e8f9f7 42
<> 144:ef7eb2e8f9f7 43 /*******************************************************************************
<> 144:ef7eb2e8f9f7 44 * Definitions
<> 144:ef7eb2e8f9f7 45 ******************************************************************************/
<> 144:ef7eb2e8f9f7 46
<> 144:ef7eb2e8f9f7 47 /* Forward declaration of the handle typedef. */
<> 144:ef7eb2e8f9f7 48 typedef struct _lpuart_dma_handle lpuart_dma_handle_t;
<> 144:ef7eb2e8f9f7 49
<> 144:ef7eb2e8f9f7 50 /*! @brief LPUART transfer callback function. */
<> 144:ef7eb2e8f9f7 51 typedef void (*lpuart_dma_transfer_callback_t)(LPUART_Type *base,
<> 144:ef7eb2e8f9f7 52 lpuart_dma_handle_t *handle,
<> 144:ef7eb2e8f9f7 53 status_t status,
<> 144:ef7eb2e8f9f7 54 void *userData);
<> 144:ef7eb2e8f9f7 55
<> 144:ef7eb2e8f9f7 56 /*!
<> 144:ef7eb2e8f9f7 57 * @brief LPUART DMA handle
<> 144:ef7eb2e8f9f7 58 */
<> 144:ef7eb2e8f9f7 59 struct _lpuart_dma_handle
<> 144:ef7eb2e8f9f7 60 {
<> 144:ef7eb2e8f9f7 61 lpuart_dma_transfer_callback_t callback; /*!< Callback function. */
<> 144:ef7eb2e8f9f7 62 void *userData; /*!< LPUART callback function parameter.*/
<> 144:ef7eb2e8f9f7 63 size_t rxDataSizeAll; /*!< Size of the data to receive. */
<> 144:ef7eb2e8f9f7 64 size_t txDataSizeAll; /*!< Size of the data to send out. */
<> 144:ef7eb2e8f9f7 65
<> 144:ef7eb2e8f9f7 66 dma_handle_t *txDmaHandle; /*!< The DMA TX channel used. */
<> 144:ef7eb2e8f9f7 67 dma_handle_t *rxDmaHandle; /*!< The DMA RX channel used. */
<> 144:ef7eb2e8f9f7 68
<> 144:ef7eb2e8f9f7 69 volatile uint8_t txState; /*!< TX transfer state. */
<> 144:ef7eb2e8f9f7 70 volatile uint8_t rxState; /*!< RX transfer state */
<> 144:ef7eb2e8f9f7 71 };
<> 144:ef7eb2e8f9f7 72
<> 144:ef7eb2e8f9f7 73 /*******************************************************************************
<> 144:ef7eb2e8f9f7 74 * API
<> 144:ef7eb2e8f9f7 75 ******************************************************************************/
<> 144:ef7eb2e8f9f7 76
<> 144:ef7eb2e8f9f7 77 #if defined(__cplusplus)
<> 144:ef7eb2e8f9f7 78 extern "C" {
<> 144:ef7eb2e8f9f7 79 #endif
<> 144:ef7eb2e8f9f7 80
<> 144:ef7eb2e8f9f7 81 /*!
<> 144:ef7eb2e8f9f7 82 * @name EDMA transactional
<> 144:ef7eb2e8f9f7 83 * @{
<> 144:ef7eb2e8f9f7 84 */
<> 144:ef7eb2e8f9f7 85
<> 144:ef7eb2e8f9f7 86 /*!
<> 144:ef7eb2e8f9f7 87 * @brief Initializes the LPUART handle which is used in transactional functions.
<> 144:ef7eb2e8f9f7 88 * @param base LPUART peripheral base address.
<> 144:ef7eb2e8f9f7 89 * @param handle Pointer to lpuart_dma_handle_t structure.
<> 144:ef7eb2e8f9f7 90 * @param callback Callback function.
<> 144:ef7eb2e8f9f7 91 * @param userData User data.
<> 144:ef7eb2e8f9f7 92 * @param txDmaHandle User-requested DMA handle for TX DMA transfer.
<> 144:ef7eb2e8f9f7 93 * @param rxDmaHandle User-requested DMA handle for RX DMA transfer.
<> 144:ef7eb2e8f9f7 94 */
<> 144:ef7eb2e8f9f7 95 void LPUART_TransferCreateHandleDMA(LPUART_Type *base,
<> 144:ef7eb2e8f9f7 96 lpuart_dma_handle_t *handle,
<> 144:ef7eb2e8f9f7 97 lpuart_dma_transfer_callback_t callback,
<> 144:ef7eb2e8f9f7 98 void *userData,
<> 144:ef7eb2e8f9f7 99 dma_handle_t *txDmaHandle,
<> 144:ef7eb2e8f9f7 100 dma_handle_t *rxDmaHandle);
<> 144:ef7eb2e8f9f7 101
<> 144:ef7eb2e8f9f7 102 /*!
<> 144:ef7eb2e8f9f7 103 * @brief Sends data using DMA.
<> 144:ef7eb2e8f9f7 104 *
<> 144:ef7eb2e8f9f7 105 * This function sends data using DMA. This is a non-blocking function, which returns
<> 144:ef7eb2e8f9f7 106 * right away. When all data is sent, the send callback function is called.
<> 144:ef7eb2e8f9f7 107 *
<> 144:ef7eb2e8f9f7 108 * @param base LPUART peripheral base address.
<> 144:ef7eb2e8f9f7 109 * @param handle LPUART handle pointer.
<> 144:ef7eb2e8f9f7 110 * @param xfer LPUART DMA transfer structure. See #lpuart_transfer_t.
<> 144:ef7eb2e8f9f7 111 * @retval kStatus_Success if succeed, others failed.
<> 144:ef7eb2e8f9f7 112 * @retval kStatus_LPUART_TxBusy Previous transfer on going.
<> 144:ef7eb2e8f9f7 113 * @retval kStatus_InvalidArgument Invalid argument.
<> 144:ef7eb2e8f9f7 114 */
<> 144:ef7eb2e8f9f7 115 status_t LPUART_TransferSendDMA(LPUART_Type *base, lpuart_dma_handle_t *handle, lpuart_transfer_t *xfer);
<> 144:ef7eb2e8f9f7 116
<> 144:ef7eb2e8f9f7 117 /*!
<> 144:ef7eb2e8f9f7 118 * @brief Receives data using DMA.
<> 144:ef7eb2e8f9f7 119 *
<> 144:ef7eb2e8f9f7 120 * This function receives data using DMA. This is a non-blocking function, which returns
<> 144:ef7eb2e8f9f7 121 * right away. When all data is received, the receive callback function is called.
<> 144:ef7eb2e8f9f7 122 *
<> 144:ef7eb2e8f9f7 123 * @param base LPUART peripheral base address.
<> 144:ef7eb2e8f9f7 124 * @param handle Pointer to lpuart_dma_handle_t structure.
<> 144:ef7eb2e8f9f7 125 * @param xfer LPUART DMA transfer structure. See #lpuart_transfer_t.
<> 144:ef7eb2e8f9f7 126 * @retval kStatus_Success if succeed, others failed.
<> 144:ef7eb2e8f9f7 127 * @retval kStatus_LPUART_RxBusy Previous transfer on going.
<> 144:ef7eb2e8f9f7 128 * @retval kStatus_InvalidArgument Invalid argument.
<> 144:ef7eb2e8f9f7 129 */
<> 144:ef7eb2e8f9f7 130 status_t LPUART_TransferReceiveDMA(LPUART_Type *base, lpuart_dma_handle_t *handle, lpuart_transfer_t *xfer);
<> 144:ef7eb2e8f9f7 131
<> 144:ef7eb2e8f9f7 132 /*!
<> 144:ef7eb2e8f9f7 133 * @brief Aborts the sent data using DMA.
<> 144:ef7eb2e8f9f7 134 *
<> 144:ef7eb2e8f9f7 135 * This function aborts send data using DMA.
<> 144:ef7eb2e8f9f7 136 *
<> 144:ef7eb2e8f9f7 137 * @param base LPUART peripheral base address
<> 144:ef7eb2e8f9f7 138 * @param handle Pointer to lpuart_dma_handle_t structure
<> 144:ef7eb2e8f9f7 139 */
<> 144:ef7eb2e8f9f7 140 void LPUART_TransferAbortSendDMA(LPUART_Type *base, lpuart_dma_handle_t *handle);
<> 144:ef7eb2e8f9f7 141
<> 144:ef7eb2e8f9f7 142 /*!
<> 144:ef7eb2e8f9f7 143 * @brief Aborts the received data using DMA.
<> 144:ef7eb2e8f9f7 144 *
<> 144:ef7eb2e8f9f7 145 * This function aborts the received data using DMA.
<> 144:ef7eb2e8f9f7 146 *
<> 144:ef7eb2e8f9f7 147 * @param base LPUART peripheral base address
<> 144:ef7eb2e8f9f7 148 * @param handle Pointer to lpuart_dma_handle_t structure
<> 144:ef7eb2e8f9f7 149 */
<> 144:ef7eb2e8f9f7 150 void LPUART_TransferAbortReceiveDMA(LPUART_Type *base, lpuart_dma_handle_t *handle);
<> 144:ef7eb2e8f9f7 151
<> 144:ef7eb2e8f9f7 152 /*!
<> 144:ef7eb2e8f9f7 153 * @brief Get the number of bytes that have been written to LPUART TX register.
<> 144:ef7eb2e8f9f7 154 *
<> 144:ef7eb2e8f9f7 155 * This function gets the number of bytes that have been written to LPUART TX
<> 144:ef7eb2e8f9f7 156 * register by DMA.
<> 144:ef7eb2e8f9f7 157 *
<> 144:ef7eb2e8f9f7 158 * @param base LPUART peripheral base address.
<> 144:ef7eb2e8f9f7 159 * @param handle LPUART handle pointer.
<> 144:ef7eb2e8f9f7 160 * @param count Send bytes count.
<> 144:ef7eb2e8f9f7 161 * @retval kStatus_NoTransferInProgress No send in progress.
<> 144:ef7eb2e8f9f7 162 * @retval kStatus_InvalidArgument Parameter is invalid.
<> 144:ef7eb2e8f9f7 163 * @retval kStatus_Success Get successfully through the parameter \p count;
<> 144:ef7eb2e8f9f7 164 */
<> 144:ef7eb2e8f9f7 165 status_t LPUART_TransferGetSendCountDMA(LPUART_Type *base, lpuart_dma_handle_t *handle, uint32_t *count);
<> 144:ef7eb2e8f9f7 166
<> 144:ef7eb2e8f9f7 167 /*!
<> 144:ef7eb2e8f9f7 168 * @brief Get the number of bytes that have been received.
<> 144:ef7eb2e8f9f7 169 *
<> 144:ef7eb2e8f9f7 170 * This function gets the number of bytes that have been received.
<> 144:ef7eb2e8f9f7 171 *
<> 144:ef7eb2e8f9f7 172 * @param base LPUART peripheral base address.
<> 144:ef7eb2e8f9f7 173 * @param handle LPUART handle pointer.
<> 144:ef7eb2e8f9f7 174 * @param count Receive bytes count.
<> 144:ef7eb2e8f9f7 175 * @retval kStatus_NoTransferInProgress No receive in progress.
<> 144:ef7eb2e8f9f7 176 * @retval kStatus_InvalidArgument Parameter is invalid.
<> 144:ef7eb2e8f9f7 177 * @retval kStatus_Success Get successfully through the parameter \p count;
<> 144:ef7eb2e8f9f7 178 */
<> 144:ef7eb2e8f9f7 179 status_t LPUART_TransferGetReceiveCountDMA(LPUART_Type *base, lpuart_dma_handle_t *handle, uint32_t *count);
<> 144:ef7eb2e8f9f7 180
<> 144:ef7eb2e8f9f7 181 /*@}*/
<> 144:ef7eb2e8f9f7 182
<> 144:ef7eb2e8f9f7 183 #if defined(__cplusplus)
<> 144:ef7eb2e8f9f7 184 }
<> 144:ef7eb2e8f9f7 185 #endif
<> 144:ef7eb2e8f9f7 186
<> 144:ef7eb2e8f9f7 187 /*! @}*/
<> 144:ef7eb2e8f9f7 188
<> 144:ef7eb2e8f9f7 189 #endif /* _FSL_LPUART_DMA_H_ */