takashi kadono / Mbed OS Nucleo446_SSD1331

Color Oled(SSD1331) connect to STMicroelectronics Nucleo-F466

Dependencies:   ssd1331

mbed-os/targets/TARGET_Freescale/TARGET_MCUXpresso_MCUS/TARGET_K82F/drivers/fsl_sai_edma.h@3:f3764f852aa8, 2018-10-11 (annotated)

Committer:
kadonotakashi
Date:
Thu Oct 11 02:27:46 2018 +0000
Revision:
3:f3764f852aa8
Parent:
0:8fdf9a60065b 
Nucreo 446 + SSD1331 test version;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kadonotakashi 0:8fdf9a60065b 1 /*
kadonotakashi 0:8fdf9a60065b 2 * Copyright (c) 2015, Freescale Semiconductor, Inc.
kadonotakashi 0:8fdf9a60065b 3 * All rights reserved.
kadonotakashi 0:8fdf9a60065b 4 *
kadonotakashi 0:8fdf9a60065b 5 * Redistribution and use in source and binary forms, with or without modification,
kadonotakashi 0:8fdf9a60065b 6 * are permitted provided that the following conditions are met:
kadonotakashi 0:8fdf9a60065b 7 *
kadonotakashi 0:8fdf9a60065b 8 * o Redistributions of source code must retain the above copyright notice, this list
kadonotakashi 0:8fdf9a60065b 9 * of conditions and the following disclaimer.
kadonotakashi 0:8fdf9a60065b 10 *
kadonotakashi 0:8fdf9a60065b 11 * o Redistributions in binary form must reproduce the above copyright notice, this
kadonotakashi 0:8fdf9a60065b 12 * list of conditions and the following disclaimer in the documentation and/or
kadonotakashi 0:8fdf9a60065b 13 * other materials provided with the distribution.
kadonotakashi 0:8fdf9a60065b 14 *
kadonotakashi 0:8fdf9a60065b 15 * o Neither the name of Freescale Semiconductor, Inc. nor the names of its
kadonotakashi 0:8fdf9a60065b 16 * contributors may be used to endorse or promote products derived from this
kadonotakashi 0:8fdf9a60065b 17 * software without specific prior written permission.
kadonotakashi 0:8fdf9a60065b 18 *
kadonotakashi 0:8fdf9a60065b 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
kadonotakashi 0:8fdf9a60065b 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
kadonotakashi 0:8fdf9a60065b 21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
kadonotakashi 0:8fdf9a60065b 22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
kadonotakashi 0:8fdf9a60065b 23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
kadonotakashi 0:8fdf9a60065b 24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
kadonotakashi 0:8fdf9a60065b 25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
kadonotakashi 0:8fdf9a60065b 26 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
kadonotakashi 0:8fdf9a60065b 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
kadonotakashi 0:8fdf9a60065b 28 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
kadonotakashi 0:8fdf9a60065b 29 */
kadonotakashi 0:8fdf9a60065b 30 #ifndef _FSL_SAI_EDMA_H_
kadonotakashi 0:8fdf9a60065b 31 #define _FSL_SAI_EDMA_H_
kadonotakashi 0:8fdf9a60065b 32
kadonotakashi 0:8fdf9a60065b 33 #include "fsl_sai.h"
kadonotakashi 0:8fdf9a60065b 34 #include "fsl_edma.h"
kadonotakashi 0:8fdf9a60065b 35
kadonotakashi 0:8fdf9a60065b 36 /*!
kadonotakashi 0:8fdf9a60065b 37 * @addtogroup sai_edma
kadonotakashi 0:8fdf9a60065b 38 * @{
kadonotakashi 0:8fdf9a60065b 39 */
kadonotakashi 0:8fdf9a60065b 40
kadonotakashi 0:8fdf9a60065b 41 /*******************************************************************************
kadonotakashi 0:8fdf9a60065b 42 * Definitions
kadonotakashi 0:8fdf9a60065b 43 ******************************************************************************/
kadonotakashi 0:8fdf9a60065b 44
kadonotakashi 0:8fdf9a60065b 45 typedef struct _sai_edma_handle sai_edma_handle_t;
kadonotakashi 0:8fdf9a60065b 46
kadonotakashi 0:8fdf9a60065b 47 /*! @brief SAI eDMA transfer callback function for finish and error */
kadonotakashi 0:8fdf9a60065b 48 typedef void (*sai_edma_callback_t)(I2S_Type *base, sai_edma_handle_t *handle, status_t status, void *userData);
kadonotakashi 0:8fdf9a60065b 49
kadonotakashi 0:8fdf9a60065b 50 /*! @brief SAI DMA transfer handle, users should not touch the content of the handle.*/
kadonotakashi 0:8fdf9a60065b 51 struct _sai_edma_handle
kadonotakashi 0:8fdf9a60065b 52 {
kadonotakashi 0:8fdf9a60065b 53 edma_handle_t *dmaHandle; /*!< DMA handler for SAI send */
kadonotakashi 0:8fdf9a60065b 54 uint8_t nbytes; /*!< eDMA minor byte transfer count initially configured. */
kadonotakashi 0:8fdf9a60065b 55 uint8_t bytesPerFrame; /*!< Bytes in a frame */
kadonotakashi 0:8fdf9a60065b 56 uint8_t channel; /*!< Which data channel */
kadonotakashi 0:8fdf9a60065b 57 uint8_t count; /*!< The transfer data count in a DMA request */
kadonotakashi 0:8fdf9a60065b 58 uint32_t state; /*!< Internal state for SAI eDMA transfer */
kadonotakashi 0:8fdf9a60065b 59 sai_edma_callback_t callback; /*!< Callback for users while transfer finish or error occurs */
kadonotakashi 0:8fdf9a60065b 60 void *userData; /*!< User callback parameter */
kadonotakashi 0:8fdf9a60065b 61 edma_tcd_t tcd[SAI_XFER_QUEUE_SIZE + 1U]; /*!< TCD pool for eDMA transfer. */
kadonotakashi 0:8fdf9a60065b 62 sai_transfer_t saiQueue[SAI_XFER_QUEUE_SIZE]; /*!< Transfer queue storing queued transfer. */
kadonotakashi 0:8fdf9a60065b 63 size_t transferSize[SAI_XFER_QUEUE_SIZE]; /*!< Data bytes need to transfer */
kadonotakashi 0:8fdf9a60065b 64 volatile uint8_t queueUser; /*!< Index for user to queue transfer. */
kadonotakashi 0:8fdf9a60065b 65 volatile uint8_t queueDriver; /*!< Index for driver to get the transfer data and size */
kadonotakashi 0:8fdf9a60065b 66 };
kadonotakashi 0:8fdf9a60065b 67
kadonotakashi 0:8fdf9a60065b 68 /*******************************************************************************
kadonotakashi 0:8fdf9a60065b 69 * APIs
kadonotakashi 0:8fdf9a60065b 70 ******************************************************************************/
kadonotakashi 0:8fdf9a60065b 71 #if defined(__cplusplus)
kadonotakashi 0:8fdf9a60065b 72 extern "C" {
kadonotakashi 0:8fdf9a60065b 73 #endif
kadonotakashi 0:8fdf9a60065b 74
kadonotakashi 0:8fdf9a60065b 75 /*!
kadonotakashi 0:8fdf9a60065b 76 * @name eDMA Transactional
kadonotakashi 0:8fdf9a60065b 77 * @{
kadonotakashi 0:8fdf9a60065b 78 */
kadonotakashi 0:8fdf9a60065b 79
kadonotakashi 0:8fdf9a60065b 80 /*!
kadonotakashi 0:8fdf9a60065b 81 * @brief Initializes the SAI eDMA handle.
kadonotakashi 0:8fdf9a60065b 82 *
kadonotakashi 0:8fdf9a60065b 83 * This function initializes the SAI master DMA handle, which can be used for other SAI master transactional APIs.
kadonotakashi 0:8fdf9a60065b 84 * Usually, for a specified SAI instance, call this API once to get the initialized handle.
kadonotakashi 0:8fdf9a60065b 85 *
kadonotakashi 0:8fdf9a60065b 86 * @param base SAI base pointer.
kadonotakashi 0:8fdf9a60065b 87 * @param handle SAI eDMA handle pointer.
kadonotakashi 0:8fdf9a60065b 88 * @param base SAI peripheral base address.
kadonotakashi 0:8fdf9a60065b 89 * @param callback Pointer to user callback function.
kadonotakashi 0:8fdf9a60065b 90 * @param userData User parameter passed to the callback function.
kadonotakashi 0:8fdf9a60065b 91 * @param dmaHandle eDMA handle pointer, this handle shall be static allocated by users.
kadonotakashi 0:8fdf9a60065b 92 */
kadonotakashi 0:8fdf9a60065b 93 void SAI_TransferTxCreateHandleEDMA(
kadonotakashi 0:8fdf9a60065b 94 I2S_Type *base, sai_edma_handle_t *handle, sai_edma_callback_t callback, void *userData, edma_handle_t *dmaHandle);
kadonotakashi 0:8fdf9a60065b 95
kadonotakashi 0:8fdf9a60065b 96 /*!
kadonotakashi 0:8fdf9a60065b 97 * @brief Initializes the SAI Rx eDMA handle.
kadonotakashi 0:8fdf9a60065b 98 *
kadonotakashi 0:8fdf9a60065b 99 * This function initializes the SAI slave DMA handle, which can be used for other SAI master transactional APIs.
kadonotakashi 0:8fdf9a60065b 100 * Usually, for a specified SAI instance, call this API once to get the initialized handle.
kadonotakashi 0:8fdf9a60065b 101 *
kadonotakashi 0:8fdf9a60065b 102 * @param base SAI base pointer.
kadonotakashi 0:8fdf9a60065b 103 * @param handle SAI eDMA handle pointer.
kadonotakashi 0:8fdf9a60065b 104 * @param base SAI peripheral base address.
kadonotakashi 0:8fdf9a60065b 105 * @param callback Pointer to user callback function.
kadonotakashi 0:8fdf9a60065b 106 * @param userData User parameter passed to the callback function.
kadonotakashi 0:8fdf9a60065b 107 * @param dmaHandle eDMA handle pointer, this handle shall be static allocated by users.
kadonotakashi 0:8fdf9a60065b 108 */
kadonotakashi 0:8fdf9a60065b 109 void SAI_TransferRxCreateHandleEDMA(
kadonotakashi 0:8fdf9a60065b 110 I2S_Type *base, sai_edma_handle_t *handle, sai_edma_callback_t callback, void *userData, edma_handle_t *dmaHandle);
kadonotakashi 0:8fdf9a60065b 111
kadonotakashi 0:8fdf9a60065b 112 /*!
kadonotakashi 0:8fdf9a60065b 113 * @brief Configures the SAI Tx audio format.
kadonotakashi 0:8fdf9a60065b 114 *
kadonotakashi 0:8fdf9a60065b 115 * The audio format can be changed at run-time. This function configures the sample rate and audio data
kadonotakashi 0:8fdf9a60065b 116 * format to be transferred. This function also sets the eDMA parameter according to formatting requirements.
kadonotakashi 0:8fdf9a60065b 117 *
kadonotakashi 0:8fdf9a60065b 118 * @param base SAI base pointer.
kadonotakashi 0:8fdf9a60065b 119 * @param handle SAI eDMA handle pointer.
kadonotakashi 0:8fdf9a60065b 120 * @param format Pointer to SAI audio data format structure.
kadonotakashi 0:8fdf9a60065b 121 * @param mclkSourceClockHz SAI master clock source frequency in Hz.
kadonotakashi 0:8fdf9a60065b 122 * @param bclkSourceClockHz SAI bit clock source frequency in Hz. If bit clock source is master
kadonotakashi 0:8fdf9a60065b 123 * clock, this value should equals to masterClockHz in format.
kadonotakashi 0:8fdf9a60065b 124 * @retval kStatus_Success Audio format set successfully.
kadonotakashi 0:8fdf9a60065b 125 * @retval kStatus_InvalidArgument The input argument is invalid.
kadonotakashi 0:8fdf9a60065b 126 */
kadonotakashi 0:8fdf9a60065b 127 void SAI_TransferTxSetFormatEDMA(I2S_Type *base,
kadonotakashi 0:8fdf9a60065b 128 sai_edma_handle_t *handle,
kadonotakashi 0:8fdf9a60065b 129 sai_transfer_format_t *format,
kadonotakashi 0:8fdf9a60065b 130 uint32_t mclkSourceClockHz,
kadonotakashi 0:8fdf9a60065b 131 uint32_t bclkSourceClockHz);
kadonotakashi 0:8fdf9a60065b 132
kadonotakashi 0:8fdf9a60065b 133 /*!
kadonotakashi 0:8fdf9a60065b 134 * @brief Configures the SAI Rx audio format.
kadonotakashi 0:8fdf9a60065b 135 *
kadonotakashi 0:8fdf9a60065b 136 * The audio format can be changed at run-time. This function configures the sample rate and audio data
kadonotakashi 0:8fdf9a60065b 137 * format to be transferred. This function also sets the eDMA parameter according to formatting requirements.
kadonotakashi 0:8fdf9a60065b 138 *
kadonotakashi 0:8fdf9a60065b 139 * @param base SAI base pointer.
kadonotakashi 0:8fdf9a60065b 140 * @param handle SAI eDMA handle pointer.
kadonotakashi 0:8fdf9a60065b 141 * @param format Pointer to SAI audio data format structure.
kadonotakashi 0:8fdf9a60065b 142 * @param mclkSourceClockHz SAI master clock source frequency in Hz.
kadonotakashi 0:8fdf9a60065b 143 * @param bclkSourceClockHz SAI bit clock source frequency in Hz. If a bit clock source is the master
kadonotakashi 0:8fdf9a60065b 144 * clock, this value should equal to masterClockHz in format.
kadonotakashi 0:8fdf9a60065b 145 * @retval kStatus_Success Audio format set successfully.
kadonotakashi 0:8fdf9a60065b 146 * @retval kStatus_InvalidArgument The input argument is invalid.
kadonotakashi 0:8fdf9a60065b 147 */
kadonotakashi 0:8fdf9a60065b 148 void SAI_TransferRxSetFormatEDMA(I2S_Type *base,
kadonotakashi 0:8fdf9a60065b 149 sai_edma_handle_t *handle,
kadonotakashi 0:8fdf9a60065b 150 sai_transfer_format_t *format,
kadonotakashi 0:8fdf9a60065b 151 uint32_t mclkSourceClockHz,
kadonotakashi 0:8fdf9a60065b 152 uint32_t bclkSourceClockHz);
kadonotakashi 0:8fdf9a60065b 153
kadonotakashi 0:8fdf9a60065b 154 /*!
kadonotakashi 0:8fdf9a60065b 155 * @brief Performs a non-blocking SAI transfer using DMA.
kadonotakashi 0:8fdf9a60065b 156 *
kadonotakashi 0:8fdf9a60065b 157 * @note This interface returns immediately after the transfer initiates. Call
kadonotakashi 0:8fdf9a60065b 158 * SAI_GetTransferStatus to poll the transfer status and check whether the SAI transfer is finished.
kadonotakashi 0:8fdf9a60065b 159 *
kadonotakashi 0:8fdf9a60065b 160 * @param base SAI base pointer.
kadonotakashi 0:8fdf9a60065b 161 * @param handle SAI eDMA handle pointer.
kadonotakashi 0:8fdf9a60065b 162 * @param xfer Pointer to the DMA transfer structure.
kadonotakashi 0:8fdf9a60065b 163 * @retval kStatus_Success Start a SAI eDMA send successfully.
kadonotakashi 0:8fdf9a60065b 164 * @retval kStatus_InvalidArgument The input argument is invalid.
kadonotakashi 0:8fdf9a60065b 165 * @retval kStatus_TxBusy SAI is busy sending data.
kadonotakashi 0:8fdf9a60065b 166 */
kadonotakashi 0:8fdf9a60065b 167 status_t SAI_TransferSendEDMA(I2S_Type *base, sai_edma_handle_t *handle, sai_transfer_t *xfer);
kadonotakashi 0:8fdf9a60065b 168
kadonotakashi 0:8fdf9a60065b 169 /*!
kadonotakashi 0:8fdf9a60065b 170 * @brief Performs a non-blocking SAI receive using eDMA.
kadonotakashi 0:8fdf9a60065b 171 *
kadonotakashi 0:8fdf9a60065b 172 * @note This interface returns immediately after the transfer initiates. Call
kadonotakashi 0:8fdf9a60065b 173 * the SAI_GetReceiveRemainingBytes to poll the transfer status and check whether the SAI transfer is finished.
kadonotakashi 0:8fdf9a60065b 174 *
kadonotakashi 0:8fdf9a60065b 175 * @param base SAI base pointer
kadonotakashi 0:8fdf9a60065b 176 * @param handle SAI eDMA handle pointer.
kadonotakashi 0:8fdf9a60065b 177 * @param xfer Pointer to DMA transfer structure.
kadonotakashi 0:8fdf9a60065b 178 * @retval kStatus_Success Start a SAI eDMA receive successfully.
kadonotakashi 0:8fdf9a60065b 179 * @retval kStatus_InvalidArgument The input argument is invalid.
kadonotakashi 0:8fdf9a60065b 180 * @retval kStatus_RxBusy SAI is busy receiving data.
kadonotakashi 0:8fdf9a60065b 181 */
kadonotakashi 0:8fdf9a60065b 182 status_t SAI_TransferReceiveEDMA(I2S_Type *base, sai_edma_handle_t *handle, sai_transfer_t *xfer);
kadonotakashi 0:8fdf9a60065b 183
kadonotakashi 0:8fdf9a60065b 184 /*!
kadonotakashi 0:8fdf9a60065b 185 * @brief Aborts a SAI transfer using eDMA.
kadonotakashi 0:8fdf9a60065b 186 *
kadonotakashi 0:8fdf9a60065b 187 * @param base SAI base pointer.
kadonotakashi 0:8fdf9a60065b 188 * @param handle SAI eDMA handle pointer.
kadonotakashi 0:8fdf9a60065b 189 */
kadonotakashi 0:8fdf9a60065b 190 void SAI_TransferAbortSendEDMA(I2S_Type *base, sai_edma_handle_t *handle);
kadonotakashi 0:8fdf9a60065b 191
kadonotakashi 0:8fdf9a60065b 192 /*!
kadonotakashi 0:8fdf9a60065b 193 * @brief Aborts a SAI receive using eDMA.
kadonotakashi 0:8fdf9a60065b 194 *
kadonotakashi 0:8fdf9a60065b 195 * @param base SAI base pointer
kadonotakashi 0:8fdf9a60065b 196 * @param handle SAI eDMA handle pointer.
kadonotakashi 0:8fdf9a60065b 197 */
kadonotakashi 0:8fdf9a60065b 198 void SAI_TransferAbortReceiveEDMA(I2S_Type *base, sai_edma_handle_t *handle);
kadonotakashi 0:8fdf9a60065b 199
kadonotakashi 0:8fdf9a60065b 200 /*!
kadonotakashi 0:8fdf9a60065b 201 * @brief Gets byte count sent by SAI.
kadonotakashi 0:8fdf9a60065b 202 *
kadonotakashi 0:8fdf9a60065b 203 * @param base SAI base pointer.
kadonotakashi 0:8fdf9a60065b 204 * @param handle SAI eDMA handle pointer.
kadonotakashi 0:8fdf9a60065b 205 * @param count Bytes count sent by SAI.
kadonotakashi 0:8fdf9a60065b 206 * @retval kStatus_Success Succeed get the transfer count.
kadonotakashi 0:8fdf9a60065b 207 * @retval kStatus_NoTransferInProgress There is no non-blocking transaction in progress.
kadonotakashi 0:8fdf9a60065b 208 */
kadonotakashi 0:8fdf9a60065b 209 status_t SAI_TransferGetSendCountEDMA(I2S_Type *base, sai_edma_handle_t *handle, size_t *count);
kadonotakashi 0:8fdf9a60065b 210
kadonotakashi 0:8fdf9a60065b 211 /*!
kadonotakashi 0:8fdf9a60065b 212 * @brief Gets byte count received by SAI.
kadonotakashi 0:8fdf9a60065b 213 *
kadonotakashi 0:8fdf9a60065b 214 * @param base SAI base pointer
kadonotakashi 0:8fdf9a60065b 215 * @param handle SAI eDMA handle pointer.
kadonotakashi 0:8fdf9a60065b 216 * @param count Bytes count received by SAI.
kadonotakashi 0:8fdf9a60065b 217 * @retval kStatus_Success Succeed get the transfer count.
kadonotakashi 0:8fdf9a60065b 218 * @retval kStatus_NoTransferInProgress There is no non-blocking transaction in progress.
kadonotakashi 0:8fdf9a60065b 219 */
kadonotakashi 0:8fdf9a60065b 220 status_t SAI_TransferGetReceiveCountEDMA(I2S_Type *base, sai_edma_handle_t *handle, size_t *count);
kadonotakashi 0:8fdf9a60065b 221
kadonotakashi 0:8fdf9a60065b 222 /*! @} */
kadonotakashi 0:8fdf9a60065b 223
kadonotakashi 0:8fdf9a60065b 224 #if defined(__cplusplus)
kadonotakashi 0:8fdf9a60065b 225 }
kadonotakashi 0:8fdf9a60065b 226 #endif
kadonotakashi 0:8fdf9a60065b 227
kadonotakashi 0:8fdf9a60065b 228 /*!
kadonotakashi 0:8fdf9a60065b 229 * @}
kadonotakashi 0:8fdf9a60065b 230 */
kadonotakashi 0:8fdf9a60065b 231 #endif