/* * Copyright (c) 2015, Freescale Semiconductor, Inc. * Copyright 2016-2017 NXP * All rights reserved. * * SPDX-License-Identifier: BSD-3-Clause */ #include "fsl_sai_edma.h" /* Component ID definition, used by tools. */ #ifndef FSL_COMPONENT_ID #define FSL_COMPONENT_ID "platform.drivers.sai_edma" #endif /******************************************************************************* * Definitions ******************************************************************************/ /* Used for 32byte aligned */ #define STCD_ADDR(address) (edma_tcd_t *)(((uint32_t)(address) + 32UL) & ~0x1FU) static I2S_Type *const s_saiBases[] = I2S_BASE_PTRS; /*handle; /* If finished a block, call the callback function */ (void)memset(&saiHandle->saiQueue[saiHandle->queueDriver], 0, sizeof(sai_transfer_t)); saiHandle->queueDriver = (saiHandle->queueDriver + 1U) % SAI_XFER_QUEUE_SIZE; if (saiHandle->callback != NULL) { (saiHandle->callback)(privHandle->base, saiHandle, kStatus_SAI_TxIdle, saiHandle->userData); } /* If all data finished, just stop the transfer */ if (saiHandle->saiQueue[saiHandle->queueDriver].data == NULL) { /* Disable DMA enable bit */ SAI_TxEnableDMA(privHandle->base, kSAI_FIFORequestDMAEnable, false); EDMA_AbortTransfer(handle); } } static void SAI_RxEDMACallback(edma_handle_t *handle, void *userData, bool done, uint32_t tcds) { sai_edma_private_handle_t *privHandle = (sai_edma_private_handle_t *)userData; sai_edma_handle_t *saiHandle = privHandle->handle; /* If finished a block, call the callback function */ (void)memset(&saiHandle->saiQueue[saiHandle->queueDriver], 0, sizeof(sai_transfer_t)); saiHandle->queueDriver = (saiHandle->queueDriver + 1U) % SAI_XFER_QUEUE_SIZE; if (saiHandle->callback != NULL) { (saiHandle->callback)(privHandle->base, saiHandle, kStatus_SAI_RxIdle, saiHandle->userData); } /* If all data finished, just stop the transfer */ if (saiHandle->saiQueue[saiHandle->queueDriver].data == NULL) { /* Disable DMA enable bit */ SAI_RxEnableDMA(privHandle->base, kSAI_FIFORequestDMAEnable, false); EDMA_AbortTransfer(handle); } } /*! * brief Initializes the SAI eDMA handle. * * This function initializes the SAI master DMA handle, which can be used for other SAI master transactional APIs. * Usually, for a specified SAI instance, call this API once to get the initialized handle. * * param base SAI base pointer. * param handle SAI eDMA handle pointer. * param base SAI peripheral base address. * param callback Pointer to user callback function. * param userData User parameter passed to the callback function. * param dmaHandle eDMA handle pointer, this handle shall be static allocated by users. */ void SAI_TransferTxCreateHandleEDMA( I2S_Type *base, sai_edma_handle_t *handle, sai_edma_callback_t callback, void *userData, edma_handle_t *txDmaHandle) { assert((handle != NULL) && (txDmaHandle != NULL)); uint32_t instance = SAI_GetInstance(base); /* Zero the handle */ (void)memset(handle, 0, sizeof(*handle)); /* Set sai base to handle */ handle->dmaHandle = txDmaHandle; handle->callback = callback; handle->userData = userData; /* Set SAI state to idle */ handle->state = (uint32_t)kSAI_Idle; s_edmaPrivateHandle[instance][0].base = base; s_edmaPrivateHandle[instance][0].handle = handle; /* Need to use scatter gather */ EDMA_InstallTCDMemory(txDmaHandle, (edma_tcd_t *)(STCD_ADDR(handle->tcd)), SAI_XFER_QUEUE_SIZE); /* Install callback for Tx dma channel */ EDMA_SetCallback(txDmaHandle, SAI_TxEDMACallback, &s_edmaPrivateHandle[instance][0]); } /*! * brief Initializes the SAI Rx eDMA handle. * * This function initializes the SAI slave DMA handle, which can be used for other SAI master transactional APIs. * Usually, for a specified SAI instance, call this API once to get the initialized handle. * * param base SAI base pointer. * param handle SAI eDMA handle pointer. * param base SAI peripheral base address. * param callback Pointer to user callback function. * param userData User parameter passed to the callback function. * param dmaHandle eDMA handle pointer, this handle shall be static allocated by users. */ void SAI_TransferRxCreateHandleEDMA( I2S_Type *base, sai_edma_handle_t *handle, sai_edma_callback_t callback, void *userData, edma_handle_t *rxDmaHandle) { assert((handle != NULL) && (rxDmaHandle != NULL)); uint32_t instance = SAI_GetInstance(base); /* Zero the handle */ (void)memset(handle, 0, sizeof(*handle)); /* Set sai base to handle */ handle->dmaHandle = rxDmaHandle; handle->callback = callback; handle->userData = userData; /* Set SAI state to idle */ handle->state = (uint32_t)kSAI_Idle; s_edmaPrivateHandle[instance][1].base = base; s_edmaPrivateHandle[instance][1].handle = handle; /* Need to use scatter gather */ EDMA_InstallTCDMemory(rxDmaHandle, STCD_ADDR(handle->tcd), SAI_XFER_QUEUE_SIZE); /* Install callback for Tx dma channel */ EDMA_SetCallback(rxDmaHandle, SAI_RxEDMACallback, &s_edmaPrivateHandle[instance][1]); } /*! * brief Configures the SAI Tx audio format. * * The audio format can be changed at run-time. This function configures the sample rate and audio data * format to be transferred. This function also sets the eDMA parameter according to formatting requirements. * * param base SAI base pointer. * param handle SAI eDMA handle pointer. * param format Pointer to SAI audio data format structure. * param mclkSourceClockHz SAI master clock source frequency in Hz. * param bclkSourceClockHz SAI bit clock source frequency in Hz. If bit clock source is master * clock, this value should equals to masterClockHz in format. * retval kStatus_Success Audio format set successfully. * retval kStatus_InvalidArgument The input argument is invalid. */ void SAI_TransferTxSetFormatEDMA(I2S_Type *base, sai_edma_handle_t *handle, sai_transfer_format_t *format, uint32_t mclkSourceClockHz, uint32_t bclkSourceClockHz) { assert((handle != NULL) && (format != NULL)); /* Configure the audio format to SAI registers */ SAI_TxSetFormat(base, format, mclkSourceClockHz, bclkSourceClockHz); /* Get the transfer size from format, this should be used in EDMA configuration */ if (format->bitWidth == 24U) { handle->bytesPerFrame = 4U; } else { handle->bytesPerFrame = (uint8_t)(format->bitWidth / 8U); } /* Update the data channel SAI used */ handle->channel = format->channel; /* Clear the channel enable bits until do a send/receive */ base->TCR3 &= ~I2S_TCR3_TCE_MASK; #if defined(FSL_FEATURE_SAI_FIFO_COUNT) && (FSL_FEATURE_SAI_FIFO_COUNT > 1) handle->count = (uint8_t)((uint32_t)FSL_FEATURE_SAI_FIFO_COUNT - format->watermark); #else handle->count = 1U; #endif /* FSL_FEATURE_SAI_FIFO_COUNT */ } /*! * @brief Configures the SAI Tx. * * * @param base SAI base pointer. * @param handle SAI eDMA handle pointer. * @param saiConfig sai configurations. */ void SAI_TransferTxSetConfigEDMA(I2S_Type *base, sai_edma_handle_t *handle, sai_transceiver_t *saiConfig) { assert((handle != NULL) && (saiConfig != NULL)); /* Configure the audio format to SAI registers */ SAI_TxSetConfig(base, saiConfig); /* Get the transfer size from format, this should be used in EDMA configuration */ if (saiConfig->serialData.dataWordLength == 24U) { handle->bytesPerFrame = 4U; } else { handle->bytesPerFrame = saiConfig->serialData.dataWordLength / 8U; } /* Update the data channel SAI used */ handle->channel = saiConfig->startChannel; /* Clear the channel enable bits until do a send/receive */ base->TCR3 &= ~I2S_TCR3_TCE_MASK; #if defined(FSL_FEATURE_SAI_FIFO_COUNT) && (FSL_FEATURE_SAI_FIFO_COUNT > 1) handle->count = (uint8_t)((uint32_t)FSL_FEATURE_SAI_FIFO_COUNT - saiConfig->fifo.fifoWatermark); #else handle->count = 1U; #endif /* FSL_FEATURE_SAI_FIFO_COUNT */ } /*! * brief Configures the SAI Rx audio format. * * The audio format can be changed at run-time. This function configures the sample rate and audio data * format to be transferred. This function also sets the eDMA parameter according to formatting requirements. * * param base SAI base pointer. * param handle SAI eDMA handle pointer. * param format Pointer to SAI audio data format structure. * param mclkSourceClockHz SAI master clock source frequency in Hz. * param bclkSourceClockHz SAI bit clock source frequency in Hz. If a bit clock source is the master * clock, this value should equal to masterClockHz in format. * retval kStatus_Success Audio format set successfully. * retval kStatus_InvalidArgument The input argument is invalid. */ void SAI_TransferRxSetFormatEDMA(I2S_Type *base, sai_edma_handle_t *handle, sai_transfer_format_t *format, uint32_t mclkSourceClockHz, uint32_t bclkSourceClockHz) { assert((handle != NULL) && (format != NULL)); /* Configure the audio format to SAI registers */ SAI_RxSetFormat(base, format, mclkSourceClockHz, bclkSourceClockHz); /* Get the transfer size from format, this should be used in EDMA configuration */ if (format->bitWidth == 24U) { handle->bytesPerFrame = 4U; } else { handle->bytesPerFrame = (uint8_t)(format->bitWidth / 8U); } /* Update the data channel SAI used */ handle->channel = format->channel; /* Clear the channel enable bits until do a send/receive */ base->RCR3 &= ~I2S_RCR3_RCE_MASK; #if defined(FSL_FEATURE_SAI_FIFO_COUNT) && (FSL_FEATURE_SAI_FIFO_COUNT > 1) handle->count = format->watermark; #else handle->count = 1U; #endif /* FSL_FEATURE_SAI_FIFO_COUNT */ } /*! * @brief Configures the SAI Rx. * * * @param base SAI base pointer. * @param handle SAI eDMA handle pointer. * @param saiConfig sai configurations. */ void SAI_TransferRxSetConfigEDMA(I2S_Type *base, sai_edma_handle_t *handle, sai_transceiver_t *saiConfig) { assert((handle != NULL) && (saiConfig != NULL)); /* Configure the audio format to SAI registers */ SAI_RxSetConfig(base, saiConfig); /* Get the transfer size from format, this should be used in EDMA configuration */ if (saiConfig->serialData.dataWordLength == 24U) { handle->bytesPerFrame = 4U; } else { handle->bytesPerFrame = saiConfig->serialData.dataWordLength / 8U; } /* Update the data channel SAI used */ handle->channel = saiConfig->startChannel; /* Clear the channel enable bits until do a send/receive */ base->RCR3 &= ~I2S_RCR3_RCE_MASK; #if defined(FSL_FEATURE_SAI_FIFO_COUNT) && (FSL_FEATURE_SAI_FIFO_COUNT > 1) handle->count = saiConfig->fifo.fifoWatermark; #else handle->count = 1U; #endif /* FSL_FEATURE_SAI_FIFO_COUNT */ } /*! * brief Performs a non-blocking SAI transfer using DMA. * * note This interface returns immediately after the transfer initiates. Call * SAI_GetTransferStatus to poll the transfer status and check whether the SAI transfer is finished. * * param base SAI base pointer. * param handle SAI eDMA handle pointer. * param xfer Pointer to the DMA transfer structure. * retval kStatus_Success Start a SAI eDMA send successfully. * retval kStatus_InvalidArgument The input argument is invalid. * retval kStatus_TxBusy SAI is busy sending data. */ status_t SAI_TransferSendEDMA(I2S_Type *base, sai_edma_handle_t *handle, sai_transfer_t *xfer) { assert((handle != NULL) && (xfer != NULL)); edma_transfer_config_t config = {0}; uint32_t destAddr = SAI_TxGetDataRegisterAddress(base, handle->channel); /* Check if input parameter invalid */ if ((xfer->data == NULL) || (xfer->dataSize == 0U)) { return kStatus_InvalidArgument; } if (handle->saiQueue[handle->queueUser].data != NULL) { return kStatus_SAI_QueueFull; } /* Change the state of handle */ handle->state = (uint32_t)kSAI_Busy; /* Update the queue state */ handle->transferSize[handle->queueUser] = xfer->dataSize; handle->saiQueue[handle->queueUser].data = xfer->data; handle->saiQueue[handle->queueUser].dataSize = xfer->dataSize; handle->queueUser = (handle->queueUser + 1U) % SAI_XFER_QUEUE_SIZE; /* Prepare edma configure */ EDMA_PrepareTransfer(&config, xfer->data, handle->bytesPerFrame, (uint32_t *)destAddr, handle->bytesPerFrame, (uint32_t)handle->count * handle->bytesPerFrame, xfer->dataSize, kEDMA_MemoryToPeripheral); /* Store the initially configured eDMA minor byte transfer count into the SAI handle */ handle->nbytes = handle->count * handle->bytesPerFrame; if (EDMA_SubmitTransfer(handle->dmaHandle, &config) != kStatus_Success) { return kStatus_SAI_QueueFull; } /* Start DMA transfer */ EDMA_StartTransfer(handle->dmaHandle); /* Enable DMA enable bit */ SAI_TxEnableDMA(base, kSAI_FIFORequestDMAEnable, true); /* Enable SAI Tx clock */ SAI_TxEnable(base, true); /* Enable the channel FIFO */ base->TCR3 |= I2S_TCR3_TCE(1UL << handle->channel); return kStatus_Success; } /*! * brief Performs a non-blocking SAI receive using eDMA. * * note This interface returns immediately after the transfer initiates. Call * the SAI_GetReceiveRemainingBytes to poll the transfer status and check whether the SAI transfer is finished. * * param base SAI base pointer * param handle SAI eDMA handle pointer. * param xfer Pointer to DMA transfer structure. * retval kStatus_Success Start a SAI eDMA receive successfully. * retval kStatus_InvalidArgument The input argument is invalid. * retval kStatus_RxBusy SAI is busy receiving data. */ status_t SAI_TransferReceiveEDMA(I2S_Type *base, sai_edma_handle_t *handle, sai_transfer_t *xfer) { assert((handle != NULL) && (xfer != NULL)); edma_transfer_config_t config = {0}; uint32_t srcAddr = SAI_RxGetDataRegisterAddress(base, handle->channel); /* Check if input parameter invalid */ if ((xfer->data == NULL) || (xfer->dataSize == 0U)) { return kStatus_InvalidArgument; } if (handle->saiQueue[handle->queueUser].data != NULL) { return kStatus_SAI_QueueFull; } /* Change the state of handle */ handle->state = (uint32_t)kSAI_Busy; /* Update queue state */ handle->transferSize[handle->queueUser] = xfer->dataSize; handle->saiQueue[handle->queueUser].data = xfer->data; handle->saiQueue[handle->queueUser].dataSize = xfer->dataSize; handle->queueUser = (handle->queueUser + 1U) % SAI_XFER_QUEUE_SIZE; /* Prepare edma configure */ EDMA_PrepareTransfer(&config, (uint32_t *)srcAddr, handle->bytesPerFrame, xfer->data, handle->bytesPerFrame, (uint32_t)handle->count * handle->bytesPerFrame, xfer->dataSize, kEDMA_PeripheralToMemory); /* Store the initially configured eDMA minor byte transfer count into the SAI handle */ handle->nbytes = handle->count * handle->bytesPerFrame; if (EDMA_SubmitTransfer(handle->dmaHandle, &config) != kStatus_Success) { return kStatus_SAI_QueueFull; } /* Start DMA transfer */ EDMA_StartTransfer(handle->dmaHandle); /* Enable DMA enable bit */ SAI_RxEnableDMA(base, kSAI_FIFORequestDMAEnable, true); /* Enable the channel FIFO */ base->RCR3 |= I2S_RCR3_RCE(1UL << handle->channel); /* Enable SAI Rx clock */ SAI_RxEnable(base, true); return kStatus_Success; } /*! * brief Aborts a SAI transfer using eDMA. * * This function only aborts the current transfer slots, the other transfer slots' information still kept * in the handler. If users want to terminate all transfer slots, just call SAI_TransferTerminateSendEDMA. * * param base SAI base pointer. * param handle SAI eDMA handle pointer. */ void SAI_TransferAbortSendEDMA(I2S_Type *base, sai_edma_handle_t *handle) { assert(handle != NULL); /* Disable dma */ EDMA_AbortTransfer(handle->dmaHandle); /* Disable the channel FIFO */ base->TCR3 &= ~I2S_TCR3_TCE_MASK; /* Disable DMA enable bit */ SAI_TxEnableDMA(base, kSAI_FIFORequestDMAEnable, false); /* Disable Tx */ SAI_TxEnable(base, false); /* If Tx is disabled, reset the FIFO pointer and clear error flags */ if ((base->TCSR & I2S_TCSR_TE_MASK) == 0UL) { base->TCSR |= (I2S_TCSR_FR_MASK | I2S_TCSR_SR_MASK); base->TCSR &= ~I2S_TCSR_SR_MASK; } /* Handle the queue index */ (void)memset(&handle->saiQueue[handle->queueDriver], 0, sizeof(sai_transfer_t)); handle->queueDriver = (handle->queueDriver + 1U) % SAI_XFER_QUEUE_SIZE; /* Set the handle state */ handle->state = (uint32_t)kSAI_Idle; } /*! * brief Aborts a SAI receive using eDMA. * * This function only aborts the current transfer slots, the other transfer slots' information still kept * in the handler. If users want to terminate all transfer slots, just call SAI_TransferTerminateReceiveEDMA. * * param base SAI base pointer. * param handle SAI eDMA handle pointer. */ void SAI_TransferAbortReceiveEDMA(I2S_Type *base, sai_edma_handle_t *handle) { assert(handle != NULL); /* Disable dma */ EDMA_AbortTransfer(handle->dmaHandle); /* Disable the channel FIFO */ base->RCR3 &= ~I2S_RCR3_RCE_MASK; /* Disable DMA enable bit */ SAI_RxEnableDMA(base, kSAI_FIFORequestDMAEnable, false); /* Disable Rx */ SAI_RxEnable(base, false); /* If Rx is disabled, reset the FIFO pointer and clear error flags */ if ((base->RCSR & I2S_RCSR_RE_MASK) == 0UL) { base->RCSR |= (I2S_RCSR_FR_MASK | I2S_RCSR_SR_MASK); base->RCSR &= ~I2S_RCSR_SR_MASK; } /* Handle the queue index */ (void)memset(&handle->saiQueue[handle->queueDriver], 0, sizeof(sai_transfer_t)); handle->queueDriver = (handle->queueDriver + 1U) % SAI_XFER_QUEUE_SIZE; /* Set the handle state */ handle->state = (uint32_t)kSAI_Idle; } /*! * brief Terminate all SAI send. * * This function will clear all transfer slots buffered in the sai queue. If users only want to abort the * current transfer slot, please call SAI_TransferAbortSendEDMA. * * param base SAI base pointer. * param handle SAI eDMA handle pointer. */ void SAI_TransferTerminateSendEDMA(I2S_Type *base, sai_edma_handle_t *handle) { assert(handle != NULL); /* Abort the current transfer */ SAI_TransferAbortSendEDMA(base, handle); /* Clear all the internal information */ (void)memset(handle->tcd, 0, sizeof(handle->tcd)); (void)memset(handle->saiQueue, 0, sizeof(handle->saiQueue)); (void)memset(handle->transferSize, 0, sizeof(handle->transferSize)); handle->queueUser = 0U; handle->queueDriver = 0U; } /*! * brief Terminate all SAI receive. * * This function will clear all transfer slots buffered in the sai queue. If users only want to abort the * current transfer slot, please call SAI_TransferAbortReceiveEDMA. * * param base SAI base pointer. * param handle SAI eDMA handle pointer. */ void SAI_TransferTerminateReceiveEDMA(I2S_Type *base, sai_edma_handle_t *handle) { assert(handle != NULL); /* Abort the current transfer */ SAI_TransferAbortReceiveEDMA(base, handle); /* Clear all the internal information */ (void)memset(handle->tcd, 0, sizeof(handle->tcd)); (void)memset(handle->saiQueue, 0, sizeof(handle->saiQueue)); (void)memset(handle->transferSize, 0, sizeof(handle->transferSize)); handle->queueUser = 0U; handle->queueDriver = 0U; } /*! * brief Gets byte count sent by SAI. * * param base SAI base pointer. * param handle SAI eDMA handle pointer. * param count Bytes count sent by SAI. * retval kStatus_Success Succeed get the transfer count. * retval kStatus_NoTransferInProgress There is no non-blocking transaction in progress. */ status_t SAI_TransferGetSendCountEDMA(I2S_Type *base, sai_edma_handle_t *handle, size_t *count) { assert(handle != NULL); status_t status = kStatus_Success; if (handle->state != (uint32_t)kSAI_Busy) { status = kStatus_NoTransferInProgress; } else { *count = (handle->transferSize[handle->queueDriver] - (uint32_t)handle->nbytes * EDMA_GetRemainingMajorLoopCount(handle->dmaHandle->base, handle->dmaHandle->channel)); } return status; } /*! * brief Gets byte count received by SAI. * * param base SAI base pointer * param handle SAI eDMA handle pointer. * param count Bytes count received by SAI. * retval kStatus_Success Succeed get the transfer count. * retval kStatus_NoTransferInProgress There is no non-blocking transaction in progress. */ status_t SAI_TransferGetReceiveCountEDMA(I2S_Type *base, sai_edma_handle_t *handle, size_t *count) { assert(handle != NULL); status_t status = kStatus_Success; if (handle->state != (uint32_t)kSAI_Busy) { status = kStatus_NoTransferInProgress; } else { *count = (handle->transferSize[handle->queueDriver] - (uint32_t)handle->nbytes * EDMA_GetRemainingMajorLoopCount(handle->dmaHandle->base, handle->dmaHandle->channel)); } return status; }