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_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?
User | Revision | Line number | New 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_SPI_DMA_H_ |
<> | 144:ef7eb2e8f9f7 | 31 | #define _FSL_SPI_DMA_H_ |
<> | 144:ef7eb2e8f9f7 | 32 | |
<> | 144:ef7eb2e8f9f7 | 33 | #include "fsl_spi.h" |
<> | 144:ef7eb2e8f9f7 | 34 | #include "fsl_dma.h" |
<> | 144:ef7eb2e8f9f7 | 35 | |
<> | 144:ef7eb2e8f9f7 | 36 | /*! |
<> | 144:ef7eb2e8f9f7 | 37 | * @addtogroup spi_dma_driver |
<> | 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 | typedef struct _spi_dma_handle spi_dma_handle_t; |
<> | 144:ef7eb2e8f9f7 | 47 | |
<> | 144:ef7eb2e8f9f7 | 48 | /*! @brief SPI DMA callback called at the end of transfer. */ |
<> | 144:ef7eb2e8f9f7 | 49 | typedef void (*spi_dma_callback_t)(SPI_Type *base, spi_dma_handle_t *handle, status_t status, void *userData); |
<> | 144:ef7eb2e8f9f7 | 50 | |
<> | 144:ef7eb2e8f9f7 | 51 | /*! @brief SPI DMA transfer handle, users should not touch the content of the handle.*/ |
<> | 144:ef7eb2e8f9f7 | 52 | struct _spi_dma_handle |
<> | 144:ef7eb2e8f9f7 | 53 | { |
<> | 144:ef7eb2e8f9f7 | 54 | bool txInProgress; /*!< Send transfer finished */ |
<> | 144:ef7eb2e8f9f7 | 55 | bool rxInProgress; /*!< Receive transfer finished */ |
<> | 144:ef7eb2e8f9f7 | 56 | dma_handle_t *txHandle; /*!< DMA handler for SPI send */ |
<> | 144:ef7eb2e8f9f7 | 57 | dma_handle_t *rxHandle; /*!< DMA handler for SPI receive */ |
<> | 144:ef7eb2e8f9f7 | 58 | uint8_t bytesPerFrame; /*!< Bytes in a frame for SPI tranfer */ |
<> | 144:ef7eb2e8f9f7 | 59 | spi_dma_callback_t callback; /*!< Callback for SPI DMA transfer */ |
<> | 144:ef7eb2e8f9f7 | 60 | void *userData; /*!< User Data for SPI DMA callback */ |
<> | 144:ef7eb2e8f9f7 | 61 | uint32_t state; /*!< Internal state of SPI DMA transfer */ |
<> | 144:ef7eb2e8f9f7 | 62 | size_t transferSize; /*!< Bytes need to be transfer */ |
<> | 144:ef7eb2e8f9f7 | 63 | }; |
<> | 144:ef7eb2e8f9f7 | 64 | |
<> | 144:ef7eb2e8f9f7 | 65 | /******************************************************************************* |
<> | 144:ef7eb2e8f9f7 | 66 | * APIs |
<> | 144:ef7eb2e8f9f7 | 67 | ******************************************************************************/ |
<> | 144:ef7eb2e8f9f7 | 68 | #if defined(__cplusplus) |
<> | 144:ef7eb2e8f9f7 | 69 | extern "C" { |
<> | 144:ef7eb2e8f9f7 | 70 | #endif |
<> | 144:ef7eb2e8f9f7 | 71 | |
<> | 144:ef7eb2e8f9f7 | 72 | /*! |
<> | 144:ef7eb2e8f9f7 | 73 | * @name DMA Transactional |
<> | 144:ef7eb2e8f9f7 | 74 | * @{ |
<> | 144:ef7eb2e8f9f7 | 75 | */ |
<> | 144:ef7eb2e8f9f7 | 76 | |
<> | 144:ef7eb2e8f9f7 | 77 | /*! |
<> | 144:ef7eb2e8f9f7 | 78 | * @brief Initialize the SPI master DMA handle. |
<> | 144:ef7eb2e8f9f7 | 79 | * |
<> | 144:ef7eb2e8f9f7 | 80 | * This function initializes the SPI master DMA handle which can be used for other SPI master transactional APIs. |
<> | 144:ef7eb2e8f9f7 | 81 | * Usually, for a specified SPI instance, user need only call this API once to get the initialized handle. |
<> | 144:ef7eb2e8f9f7 | 82 | * |
<> | 144:ef7eb2e8f9f7 | 83 | * @param base SPI peripheral base address. |
<> | 144:ef7eb2e8f9f7 | 84 | * @param handle SPI handle pointer. |
<> | 144:ef7eb2e8f9f7 | 85 | * @param callback User callback function called at the end of a transfer. |
<> | 144:ef7eb2e8f9f7 | 86 | * @param userData User data for callback. |
<> | 144:ef7eb2e8f9f7 | 87 | * @param txHandle DMA handle pointer for SPI Tx, the handle shall be static allocated by users. |
<> | 144:ef7eb2e8f9f7 | 88 | * @param rxHandle DMA handle pointer for SPI Rx, the handle shall be static allocated by users. |
<> | 144:ef7eb2e8f9f7 | 89 | */ |
<> | 144:ef7eb2e8f9f7 | 90 | void SPI_MasterTransferCreateHandleDMA(SPI_Type *base, |
<> | 144:ef7eb2e8f9f7 | 91 | spi_dma_handle_t *handle, |
<> | 144:ef7eb2e8f9f7 | 92 | spi_dma_callback_t callback, |
<> | 144:ef7eb2e8f9f7 | 93 | void *userData, |
<> | 144:ef7eb2e8f9f7 | 94 | dma_handle_t *txHandle, |
<> | 144:ef7eb2e8f9f7 | 95 | dma_handle_t *rxHandle); |
<> | 144:ef7eb2e8f9f7 | 96 | |
<> | 144:ef7eb2e8f9f7 | 97 | /*! |
<> | 144:ef7eb2e8f9f7 | 98 | * @brief Perform a non-blocking SPI transfer using DMA. |
<> | 144:ef7eb2e8f9f7 | 99 | * |
<> | 144:ef7eb2e8f9f7 | 100 | * @note This interface returned immediately after transfer initiates, users should call |
<> | 144:ef7eb2e8f9f7 | 101 | * SPI_GetTransferStatus to poll the transfer status to check whether SPI transfer finished. |
<> | 144:ef7eb2e8f9f7 | 102 | * |
<> | 144:ef7eb2e8f9f7 | 103 | * @param base SPI peripheral base address. |
<> | 144:ef7eb2e8f9f7 | 104 | * @param handle SPI DMA handle pointer. |
<> | 144:ef7eb2e8f9f7 | 105 | * @param xfer Pointer to dma transfer structure. |
<> | 144:ef7eb2e8f9f7 | 106 | * @retval kStatus_Success Successfully start a transfer. |
<> | 144:ef7eb2e8f9f7 | 107 | * @retval kStatus_InvalidArgument Input argument is invalid. |
<> | 144:ef7eb2e8f9f7 | 108 | * @retval kStatus_SPI_Busy SPI is not idle, is running another transfer. |
<> | 144:ef7eb2e8f9f7 | 109 | */ |
<> | 144:ef7eb2e8f9f7 | 110 | status_t SPI_MasterTransferDMA(SPI_Type *base, spi_dma_handle_t *handle, spi_transfer_t *xfer); |
<> | 144:ef7eb2e8f9f7 | 111 | |
<> | 144:ef7eb2e8f9f7 | 112 | /*! |
<> | 144:ef7eb2e8f9f7 | 113 | * @brief Abort a SPI transfer using DMA. |
<> | 144:ef7eb2e8f9f7 | 114 | * |
<> | 144:ef7eb2e8f9f7 | 115 | * @param base SPI peripheral base address. |
<> | 144:ef7eb2e8f9f7 | 116 | * @param handle SPI DMA handle pointer. |
<> | 144:ef7eb2e8f9f7 | 117 | */ |
<> | 144:ef7eb2e8f9f7 | 118 | void SPI_MasterTransferAbortDMA(SPI_Type *base, spi_dma_handle_t *handle); |
<> | 144:ef7eb2e8f9f7 | 119 | |
<> | 144:ef7eb2e8f9f7 | 120 | /*! |
<> | 144:ef7eb2e8f9f7 | 121 | * @brief Get the transferred bytes for SPI slave DMA. |
<> | 144:ef7eb2e8f9f7 | 122 | * |
<> | 144:ef7eb2e8f9f7 | 123 | * @param base SPI peripheral base address. |
<> | 144:ef7eb2e8f9f7 | 124 | * @param handle SPI DMA handle pointer. |
<> | 144:ef7eb2e8f9f7 | 125 | * @param count Transferred bytes. |
<> | 144:ef7eb2e8f9f7 | 126 | * @retval kStatus_SPI_Success Succeed get the transfer count. |
<> | 144:ef7eb2e8f9f7 | 127 | * @retval kStatus_NoTransferInProgress There is not a non-blocking transaction currently in progress. |
<> | 144:ef7eb2e8f9f7 | 128 | */ |
<> | 144:ef7eb2e8f9f7 | 129 | status_t SPI_MasterTransferGetCountDMA(SPI_Type *base, spi_dma_handle_t *handle, size_t *count); |
<> | 144:ef7eb2e8f9f7 | 130 | |
<> | 144:ef7eb2e8f9f7 | 131 | /*! |
<> | 144:ef7eb2e8f9f7 | 132 | * @brief Initialize the SPI slave DMA handle. |
<> | 144:ef7eb2e8f9f7 | 133 | * |
<> | 144:ef7eb2e8f9f7 | 134 | * This function initializes the SPI slave DMA handle which can be used for other SPI master transactional APIs. |
<> | 144:ef7eb2e8f9f7 | 135 | * Usually, for a specified SPI instance, user need only call this API once to get the initialized handle. |
<> | 144:ef7eb2e8f9f7 | 136 | * |
<> | 144:ef7eb2e8f9f7 | 137 | * @param base SPI peripheral base address. |
<> | 144:ef7eb2e8f9f7 | 138 | * @param handle SPI handle pointer. |
<> | 144:ef7eb2e8f9f7 | 139 | * @param callback User callback function called at the end of a transfer. |
<> | 144:ef7eb2e8f9f7 | 140 | * @param userData User data for callback. |
<> | 144:ef7eb2e8f9f7 | 141 | * @param txHandle DMA handle pointer for SPI Tx, the handle shall be static allocated by users. |
<> | 144:ef7eb2e8f9f7 | 142 | * @param rxHandle DMA handle pointer for SPI Rx, the handle shall be static allocated by users. |
<> | 144:ef7eb2e8f9f7 | 143 | */ |
<> | 144:ef7eb2e8f9f7 | 144 | static inline void SPI_SlaveTransferCreateHandleDMA(SPI_Type *base, |
<> | 144:ef7eb2e8f9f7 | 145 | spi_dma_handle_t *handle, |
<> | 144:ef7eb2e8f9f7 | 146 | spi_dma_callback_t callback, |
<> | 144:ef7eb2e8f9f7 | 147 | void *userData, |
<> | 144:ef7eb2e8f9f7 | 148 | dma_handle_t *txHandle, |
<> | 144:ef7eb2e8f9f7 | 149 | dma_handle_t *rxHandle) |
<> | 144:ef7eb2e8f9f7 | 150 | { |
<> | 144:ef7eb2e8f9f7 | 151 | SPI_MasterTransferCreateHandleDMA(base, handle, callback, userData, txHandle, rxHandle); |
<> | 144:ef7eb2e8f9f7 | 152 | } |
<> | 144:ef7eb2e8f9f7 | 153 | |
<> | 144:ef7eb2e8f9f7 | 154 | /*! |
<> | 144:ef7eb2e8f9f7 | 155 | * @brief Perform a non-blocking SPI transfer using DMA. |
<> | 144:ef7eb2e8f9f7 | 156 | * |
<> | 144:ef7eb2e8f9f7 | 157 | * @note This interface returned immediately after transfer initiates, users should call |
<> | 144:ef7eb2e8f9f7 | 158 | * SPI_GetTransferStatus to poll the transfer status to check whether SPI transfer finished. |
<> | 144:ef7eb2e8f9f7 | 159 | * |
<> | 144:ef7eb2e8f9f7 | 160 | * @param base SPI peripheral base address. |
<> | 144:ef7eb2e8f9f7 | 161 | * @param handle SPI DMA handle pointer. |
<> | 144:ef7eb2e8f9f7 | 162 | * @param xfer Pointer to dma transfer structure. |
<> | 144:ef7eb2e8f9f7 | 163 | * @retval kStatus_Success Successfully start a transfer. |
<> | 144:ef7eb2e8f9f7 | 164 | * @retval kStatus_InvalidArgument Input argument is invalid. |
<> | 144:ef7eb2e8f9f7 | 165 | * @retval kStatus_SPI_Busy SPI is not idle, is running another transfer. |
<> | 144:ef7eb2e8f9f7 | 166 | */ |
<> | 144:ef7eb2e8f9f7 | 167 | static inline status_t SPI_SlaveTransferDMA(SPI_Type *base, spi_dma_handle_t *handle, spi_transfer_t *xfer) |
<> | 144:ef7eb2e8f9f7 | 168 | { |
<> | 144:ef7eb2e8f9f7 | 169 | return SPI_MasterTransferDMA(base, handle, xfer); |
<> | 144:ef7eb2e8f9f7 | 170 | } |
<> | 144:ef7eb2e8f9f7 | 171 | |
<> | 144:ef7eb2e8f9f7 | 172 | /*! |
<> | 144:ef7eb2e8f9f7 | 173 | * @brief Abort a SPI transfer using DMA. |
<> | 144:ef7eb2e8f9f7 | 174 | * |
<> | 144:ef7eb2e8f9f7 | 175 | * @param base SPI peripheral base address. |
<> | 144:ef7eb2e8f9f7 | 176 | * @param handle SPI DMA handle pointer. |
<> | 144:ef7eb2e8f9f7 | 177 | */ |
<> | 144:ef7eb2e8f9f7 | 178 | static inline void SPI_SlaveTransferAbortDMA(SPI_Type *base, spi_dma_handle_t *handle) |
<> | 144:ef7eb2e8f9f7 | 179 | { |
<> | 144:ef7eb2e8f9f7 | 180 | SPI_MasterTransferAbortDMA(base, handle); |
<> | 144:ef7eb2e8f9f7 | 181 | } |
<> | 144:ef7eb2e8f9f7 | 182 | |
<> | 144:ef7eb2e8f9f7 | 183 | /*! |
<> | 144:ef7eb2e8f9f7 | 184 | * @brief Get the transferred bytes for SPI slave DMA. |
<> | 144:ef7eb2e8f9f7 | 185 | * |
<> | 144:ef7eb2e8f9f7 | 186 | * @param base SPI peripheral base address. |
<> | 144:ef7eb2e8f9f7 | 187 | * @param handle SPI DMA handle pointer. |
<> | 144:ef7eb2e8f9f7 | 188 | * @param count Transferred bytes. |
<> | 144:ef7eb2e8f9f7 | 189 | * @retval kStatus_SPI_Success Succeed get the transfer count. |
<> | 144:ef7eb2e8f9f7 | 190 | * @retval kStatus_NoTransferInProgress There is not a non-blocking transaction currently in progress. |
<> | 144:ef7eb2e8f9f7 | 191 | */ |
<> | 144:ef7eb2e8f9f7 | 192 | static inline status_t SPI_SlaveTransferGetCountDMA(SPI_Type *base, spi_dma_handle_t *handle, size_t *count) |
<> | 144:ef7eb2e8f9f7 | 193 | { |
<> | 144:ef7eb2e8f9f7 | 194 | return SPI_MasterTransferGetCountDMA(base, handle, count); |
<> | 144:ef7eb2e8f9f7 | 195 | } |
<> | 144:ef7eb2e8f9f7 | 196 | |
<> | 144:ef7eb2e8f9f7 | 197 | /*! @} */ |
<> | 144:ef7eb2e8f9f7 | 198 | |
<> | 144:ef7eb2e8f9f7 | 199 | #if defined(__cplusplus) |
<> | 144:ef7eb2e8f9f7 | 200 | } |
<> | 144:ef7eb2e8f9f7 | 201 | #endif |
<> | 144:ef7eb2e8f9f7 | 202 | |
<> | 144:ef7eb2e8f9f7 | 203 | /*! |
<> | 144:ef7eb2e8f9f7 | 204 | * @} |
<> | 144:ef7eb2e8f9f7 | 205 | */ |
<> | 144:ef7eb2e8f9f7 | 206 | #endif |