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_flexio_spi_dma.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_FLEXIO_SPI_DMA_H_
<> 144:ef7eb2e8f9f7 31 #define _FSL_FLEXIO_SPI_DMA_H_
<> 144:ef7eb2e8f9f7 32
<> 144:ef7eb2e8f9f7 33 #include "fsl_flexio_spi.h"
<> 144:ef7eb2e8f9f7 34 #include "fsl_dma.h"
<> 144:ef7eb2e8f9f7 35
<> 144:ef7eb2e8f9f7 36 /*!
<> 144:ef7eb2e8f9f7 37 * @addtogroup flexio_dma_spi
<> 144:ef7eb2e8f9f7 38 * @{
<> 144:ef7eb2e8f9f7 39 */
<> 144:ef7eb2e8f9f7 40
<> 144:ef7eb2e8f9f7 41
<> 144:ef7eb2e8f9f7 42 /*******************************************************************************
<> 144:ef7eb2e8f9f7 43 * Definitions
<> 144:ef7eb2e8f9f7 44 ******************************************************************************/
<> 144:ef7eb2e8f9f7 45
<> 144:ef7eb2e8f9f7 46 /*! @brief typedef for flexio_spi_master_dma_handle_t in advance. */
<> 144:ef7eb2e8f9f7 47 typedef struct _flexio_spi_master_dma_handle flexio_spi_master_dma_handle_t;
<> 144:ef7eb2e8f9f7 48
<> 144:ef7eb2e8f9f7 49 /*! @brief Slave handle is the same with master handle. */
<> 144:ef7eb2e8f9f7 50 typedef flexio_spi_master_dma_handle_t flexio_spi_slave_dma_handle_t;
<> 144:ef7eb2e8f9f7 51
<> 144:ef7eb2e8f9f7 52 /*! @brief FlexIO SPI master callback for finished transmit */
<> 144:ef7eb2e8f9f7 53 typedef void (*flexio_spi_master_dma_transfer_callback_t)(FLEXIO_SPI_Type *base,
<> 144:ef7eb2e8f9f7 54 flexio_spi_master_dma_handle_t *handle,
<> 144:ef7eb2e8f9f7 55 status_t status,
<> 144:ef7eb2e8f9f7 56 void *userData);
<> 144:ef7eb2e8f9f7 57
<> 144:ef7eb2e8f9f7 58 /*! @brief FlexIO SPI slave callback for finished transmit */
<> 144:ef7eb2e8f9f7 59 typedef void (*flexio_spi_slave_dma_transfer_callback_t)(FLEXIO_SPI_Type *base,
<> 144:ef7eb2e8f9f7 60 flexio_spi_slave_dma_handle_t *handle,
<> 144:ef7eb2e8f9f7 61 status_t status,
<> 144:ef7eb2e8f9f7 62 void *userData);
<> 144:ef7eb2e8f9f7 63
<> 144:ef7eb2e8f9f7 64 /*! @brief FlexIO SPI DMA transfer handle, users should not touch the content of the handle.*/
<> 144:ef7eb2e8f9f7 65 struct _flexio_spi_master_dma_handle
<> 144:ef7eb2e8f9f7 66 {
<> 144:ef7eb2e8f9f7 67 size_t transferSize; /*!< Total bytes to be transferred. */
<> 144:ef7eb2e8f9f7 68 bool txInProgress; /*!< Send transfer in progress */
<> 144:ef7eb2e8f9f7 69 bool rxInProgress; /*!< Receive transfer in progress */
<> 144:ef7eb2e8f9f7 70 dma_handle_t *txHandle; /*!< DMA handler for SPI send */
<> 144:ef7eb2e8f9f7 71 dma_handle_t *rxHandle; /*!< DMA handler for SPI receive */
<> 144:ef7eb2e8f9f7 72 flexio_spi_master_dma_transfer_callback_t callback; /*!< Callback for SPI DMA transfer */
<> 144:ef7eb2e8f9f7 73 void *userData; /*!< User Data for SPI DMA callback */
<> 144:ef7eb2e8f9f7 74 };
<> 144:ef7eb2e8f9f7 75
<> 144:ef7eb2e8f9f7 76 /*******************************************************************************
<> 144:ef7eb2e8f9f7 77 * APIs
<> 144:ef7eb2e8f9f7 78 ******************************************************************************/
<> 144:ef7eb2e8f9f7 79 #if defined(__cplusplus)
<> 144:ef7eb2e8f9f7 80 extern "C" {
<> 144:ef7eb2e8f9f7 81 #endif
<> 144:ef7eb2e8f9f7 82
<> 144:ef7eb2e8f9f7 83 /*!
<> 144:ef7eb2e8f9f7 84 * @name DMA Transactional
<> 144:ef7eb2e8f9f7 85 * @{
<> 144:ef7eb2e8f9f7 86 */
<> 144:ef7eb2e8f9f7 87
<> 144:ef7eb2e8f9f7 88 /*!
<> 144:ef7eb2e8f9f7 89 * @brief Initializes the FLEXO SPI master DMA handle.
<> 144:ef7eb2e8f9f7 90 *
<> 144:ef7eb2e8f9f7 91 * This function initializes the FLEXO SPI master DMA handle which can be used for other FLEXO SPI master transactional
<> 144:ef7eb2e8f9f7 92 * APIs.
<> 144:ef7eb2e8f9f7 93 * Usually, for a specified FLEXO SPI instance, user need only call this API once to get the initialized handle.
<> 144:ef7eb2e8f9f7 94 *
<> 144:ef7eb2e8f9f7 95 * @param base pointer to FLEXIO_SPI_Type structure.
<> 144:ef7eb2e8f9f7 96 * @param handle pointer to flexio_spi_master_dma_handle_t structure to store the transfer state.
<> 144:ef7eb2e8f9f7 97 * @param callback SPI callback, NULL means no callback.
<> 144:ef7eb2e8f9f7 98 * @param userData callback function parameter.
<> 144:ef7eb2e8f9f7 99 * @param txHandle User requested DMA handle for FlexIO SPI RX DMA transfer.
<> 144:ef7eb2e8f9f7 100 * @param rxHandle User requested DMA handle for FlexIO SPI TX DMA transfer.
<> 144:ef7eb2e8f9f7 101 * @retval kStatus_Success Successfully create the handle.
<> 144:ef7eb2e8f9f7 102 * @retval kStatus_OutOfRange The FlexIO SPI DMA type/handle table out of range.
<> 144:ef7eb2e8f9f7 103 */
<> 144:ef7eb2e8f9f7 104 status_t FLEXIO_SPI_MasterTransferCreateHandleDMA(FLEXIO_SPI_Type *base,
<> 144:ef7eb2e8f9f7 105 flexio_spi_master_dma_handle_t *handle,
<> 144:ef7eb2e8f9f7 106 flexio_spi_master_dma_transfer_callback_t callback,
<> 144:ef7eb2e8f9f7 107 void *userData,
<> 144:ef7eb2e8f9f7 108 dma_handle_t *txHandle,
<> 144:ef7eb2e8f9f7 109 dma_handle_t *rxHandle);
<> 144:ef7eb2e8f9f7 110
<> 144:ef7eb2e8f9f7 111 /*!
<> 144:ef7eb2e8f9f7 112 * @brief Performs a non-blocking FlexIO SPI transfer using DMA.
<> 144:ef7eb2e8f9f7 113 *
<> 144:ef7eb2e8f9f7 114 * @note This interface returned immediately after transfer initiates, users could call
<> 144:ef7eb2e8f9f7 115 * FLEXIO_SPI_MasterGetTransferCountDMA to poll the transfer status to check
<> 144:ef7eb2e8f9f7 116 * whether FlexIO SPI transfer finished.
<> 144:ef7eb2e8f9f7 117 *
<> 144:ef7eb2e8f9f7 118 * @param base pointer to FLEXIO_SPI_Type structure.
<> 144:ef7eb2e8f9f7 119 * @param handle pointer to flexio_spi_master_dma_handle_t structure to store the transfer state.
<> 144:ef7eb2e8f9f7 120 * @param xfer Pointer to FlexIO SPI transfer structure.
<> 144:ef7eb2e8f9f7 121 * @retval kStatus_Success Successfully start a transfer.
<> 144:ef7eb2e8f9f7 122 * @retval kStatus_InvalidArgument Input argument is invalid.
<> 144:ef7eb2e8f9f7 123 * @retval kStatus_FLEXIO_SPI_Busy FlexIO SPI is not idle, is running another transfer.
<> 144:ef7eb2e8f9f7 124 */
<> 144:ef7eb2e8f9f7 125 status_t FLEXIO_SPI_MasterTransferDMA(FLEXIO_SPI_Type *base,
<> 144:ef7eb2e8f9f7 126 flexio_spi_master_dma_handle_t *handle,
<> 144:ef7eb2e8f9f7 127 flexio_spi_transfer_t *xfer);
<> 144:ef7eb2e8f9f7 128
<> 144:ef7eb2e8f9f7 129 /*!
<> 144:ef7eb2e8f9f7 130 * @brief Aborts a FlexIO SPI transfer using DMA.
<> 144:ef7eb2e8f9f7 131 *
<> 144:ef7eb2e8f9f7 132 * @param base pointer to FLEXIO_SPI_Type structure.
<> 144:ef7eb2e8f9f7 133 * @param handle FlexIO SPI DMA handle pointer.
<> 144:ef7eb2e8f9f7 134 */
<> 144:ef7eb2e8f9f7 135 void FLEXIO_SPI_MasterTransferAbortDMA(FLEXIO_SPI_Type *base, flexio_spi_master_dma_handle_t *handle);
<> 144:ef7eb2e8f9f7 136
<> 144:ef7eb2e8f9f7 137 /*!
<> 144:ef7eb2e8f9f7 138 * @brief Gets the remaining bytes for FlexIO SPI DMA transfer.
<> 144:ef7eb2e8f9f7 139 *
<> 144:ef7eb2e8f9f7 140 * @param base pointer to FLEXIO_SPI_Type structure.
<> 144:ef7eb2e8f9f7 141 * @param handle FlexIO SPI DMA handle pointer.
<> 144:ef7eb2e8f9f7 142 * @param count Number of bytes transferred so far by the non-blocking transaction.
<> 144:ef7eb2e8f9f7 143 */
<> 144:ef7eb2e8f9f7 144 status_t FLEXIO_SPI_MasterTransferGetCountDMA(FLEXIO_SPI_Type *base,
<> 144:ef7eb2e8f9f7 145 flexio_spi_master_dma_handle_t *handle,
<> 144:ef7eb2e8f9f7 146 size_t *count);
<> 144:ef7eb2e8f9f7 147
<> 144:ef7eb2e8f9f7 148 /*!
<> 144:ef7eb2e8f9f7 149 * @brief Initializes the FlexIO SPI slave DMA handle.
<> 144:ef7eb2e8f9f7 150 *
<> 144:ef7eb2e8f9f7 151 * This function initializes the FlexIO SPI slave DMA handle.
<> 144:ef7eb2e8f9f7 152 *
<> 144:ef7eb2e8f9f7 153 * @param base pointer to FLEXIO_SPI_Type structure.
<> 144:ef7eb2e8f9f7 154 * @param handle pointer to flexio_spi_slave_dma_handle_t structure to store the transfer state.
<> 144:ef7eb2e8f9f7 155 * @param callback SPI callback, NULL means no callback.
<> 144:ef7eb2e8f9f7 156 * @param userData callback function parameter.
<> 144:ef7eb2e8f9f7 157 * @param txHandle User requested DMA handle for FlexIO SPI TX DMA transfer.
<> 144:ef7eb2e8f9f7 158 * @param rxHandle User requested DMA handle for FlexIO SPI RX DMA transfer.
<> 144:ef7eb2e8f9f7 159 */
<> 144:ef7eb2e8f9f7 160 static inline void FLEXIO_SPI_SlaveTransferCreateHandleDMA(FLEXIO_SPI_Type *base,
<> 144:ef7eb2e8f9f7 161 flexio_spi_slave_dma_handle_t *handle,
<> 144:ef7eb2e8f9f7 162 flexio_spi_slave_dma_transfer_callback_t callback,
<> 144:ef7eb2e8f9f7 163 void *userData,
<> 144:ef7eb2e8f9f7 164 dma_handle_t *txHandle,
<> 144:ef7eb2e8f9f7 165 dma_handle_t *rxHandle)
<> 144:ef7eb2e8f9f7 166 {
<> 144:ef7eb2e8f9f7 167 FLEXIO_SPI_MasterTransferCreateHandleDMA(base, handle, callback, userData, txHandle, rxHandle);
<> 144:ef7eb2e8f9f7 168 }
<> 144:ef7eb2e8f9f7 169
<> 144:ef7eb2e8f9f7 170 /*!
<> 144:ef7eb2e8f9f7 171 * @brief Performs a non-blocking FlexIO SPI transfer using DMA.
<> 144:ef7eb2e8f9f7 172 *
<> 144:ef7eb2e8f9f7 173 * @note This interface returned immediately after transfer initiates, users could call
<> 144:ef7eb2e8f9f7 174 * FLEXIO_SPI_SlaveGetTransferCountDMA to poll the transfer status to
<> 144:ef7eb2e8f9f7 175 * check whether FlexIO SPI transfer finished.
<> 144:ef7eb2e8f9f7 176 *
<> 144:ef7eb2e8f9f7 177 * @param base pointer to FLEXIO_SPI_Type structure.
<> 144:ef7eb2e8f9f7 178 * @param handle pointer to flexio_spi_slave_dma_handle_t structure to store the transfer state.
<> 144:ef7eb2e8f9f7 179 * @param xfer Pointer to FlexIO SPI transfer structure.
<> 144:ef7eb2e8f9f7 180 * @retval kStatus_Success Successfully start a transfer.
<> 144:ef7eb2e8f9f7 181 * @retval kStatus_InvalidArgument Input argument is invalid.
<> 144:ef7eb2e8f9f7 182 * @retval kStatus_FLEXIO_SPI_Busy FlexIO SPI is not idle, is running another transfer.
<> 144:ef7eb2e8f9f7 183 */
<> 144:ef7eb2e8f9f7 184 status_t FLEXIO_SPI_SlaveTransferDMA(FLEXIO_SPI_Type *base,
<> 144:ef7eb2e8f9f7 185 flexio_spi_slave_dma_handle_t *handle,
<> 144:ef7eb2e8f9f7 186 flexio_spi_transfer_t *xfer);
<> 144:ef7eb2e8f9f7 187
<> 144:ef7eb2e8f9f7 188 /*!
<> 144:ef7eb2e8f9f7 189 * @brief Aborts a FlexIO SPI transfer using DMA.
<> 144:ef7eb2e8f9f7 190 *
<> 144:ef7eb2e8f9f7 191 * @param base pointer to FLEXIO_SPI_Type structure.
<> 144:ef7eb2e8f9f7 192 * @param handle pointer to flexio_spi_slave_dma_handle_t structure to store the transfer state.
<> 144:ef7eb2e8f9f7 193 */
<> 144:ef7eb2e8f9f7 194 static inline void FLEXIO_SPI_SlaveTransferAbortDMA(FLEXIO_SPI_Type *base, flexio_spi_slave_dma_handle_t *handle)
<> 144:ef7eb2e8f9f7 195 {
<> 144:ef7eb2e8f9f7 196 FLEXIO_SPI_MasterTransferAbortDMA(base, handle);
<> 144:ef7eb2e8f9f7 197 }
<> 144:ef7eb2e8f9f7 198
<> 144:ef7eb2e8f9f7 199 /*!
<> 144:ef7eb2e8f9f7 200 * @brief Gets the remaining bytes to be transferred for FlexIO SPI DMA.
<> 144:ef7eb2e8f9f7 201 *
<> 144:ef7eb2e8f9f7 202 * @param base pointer to FLEXIO_SPI_Type structure.
<> 144:ef7eb2e8f9f7 203 * @param handle FlexIO SPI DMA handle pointer.
<> 144:ef7eb2e8f9f7 204 * @param count Number of bytes transferred so far by the non-blocking transaction.
<> 144:ef7eb2e8f9f7 205 */
<> 144:ef7eb2e8f9f7 206 static inline status_t FLEXIO_SPI_SlaveTransferGetCountDMA(FLEXIO_SPI_Type *base,
<> 144:ef7eb2e8f9f7 207 flexio_spi_slave_dma_handle_t *handle,
<> 144:ef7eb2e8f9f7 208 size_t *count)
<> 144:ef7eb2e8f9f7 209 {
<> 144:ef7eb2e8f9f7 210 return FLEXIO_SPI_MasterTransferGetCountDMA(base, handle, count);
<> 144:ef7eb2e8f9f7 211 }
<> 144:ef7eb2e8f9f7 212
<> 144:ef7eb2e8f9f7 213 /*! @} */
<> 144:ef7eb2e8f9f7 214
<> 144:ef7eb2e8f9f7 215 #if defined(__cplusplus)
<> 144:ef7eb2e8f9f7 216 }
<> 144:ef7eb2e8f9f7 217 #endif
<> 144:ef7eb2e8f9f7 218
<> 144:ef7eb2e8f9f7 219 /*!
<> 144:ef7eb2e8f9f7 220 * @}
<> 144:ef7eb2e8f9f7 221 */
<> 144:ef7eb2e8f9f7 222 #endif