fsl_spdif_edma.h 7.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192
  1. /*
  2. * Copyright (c) 2016, Freescale Semiconductor, Inc.
  3. * Copyright 2017-2020 NXP
  4. * All rights reserved.
  5. *
  6. *
  7. * SPDX-License-Identifier: BSD-3-Clause
  8. */
  9. #ifndef _FSL_SPDIF_EDMA_H_
  10. #define _FSL_SPDIF_EDMA_H_
  11. #include "fsl_spdif.h"
  12. #include "fsl_edma.h"
  13. /*!
  14. * @addtogroup spdif_edma
  15. * @{
  16. */
  17. /*******************************************************************************
  18. * Definitions
  19. ******************************************************************************/
  20. /*! @name Driver version */
  21. /*@{*/
  22. #define FSL_SPDIF_EDMA_DRIVER_VERSION (MAKE_VERSION(2, 0, 5)) /*!< Version 2.0.5 */
  23. /*@}*/
  24. typedef struct _spdif_edma_handle spdif_edma_handle_t;
  25. /*! @brief SPDIF eDMA transfer callback function for finish and error */
  26. typedef void (*spdif_edma_callback_t)(SPDIF_Type *base, spdif_edma_handle_t *handle, status_t status, void *userData);
  27. /*! @brief SPDIF transfer structure */
  28. typedef struct _spdif_edma_transfer
  29. {
  30. uint8_t *leftData; /*!< Data start address to transfer. */
  31. uint8_t *rightData; /*!< Data start address to transfer. */
  32. size_t dataSize; /*!< Transfer size. */
  33. } spdif_edma_transfer_t;
  34. /*! @brief SPDIF DMA transfer handle, users should not touch the content of the handle.*/
  35. struct _spdif_edma_handle
  36. {
  37. edma_handle_t *dmaLeftHandle; /*!< DMA handler for SPDIF left channel */
  38. edma_handle_t *dmaRightHandle; /*!< DMA handler for SPDIF right channel */
  39. uint8_t nbytes; /*!< eDMA minor byte transfer count initially configured. */
  40. uint8_t count; /*!< The transfer data count in a DMA request */
  41. uint32_t state; /*!< Internal state for SPDIF eDMA transfer */
  42. spdif_edma_callback_t callback; /*!< Callback for users while transfer finish or error occurs */
  43. void *userData; /*!< User callback parameter */
  44. edma_tcd_t leftTcd[SPDIF_XFER_QUEUE_SIZE + 1U]; /*!< TCD pool for eDMA transfer. */
  45. edma_tcd_t rightTcd[SPDIF_XFER_QUEUE_SIZE + 1U]; /*!< TCD pool for eDMA transfer. */
  46. spdif_edma_transfer_t spdifQueue[SPDIF_XFER_QUEUE_SIZE]; /*!< Transfer queue storing queued transfer. */
  47. size_t transferSize[SPDIF_XFER_QUEUE_SIZE]; /*!< Data bytes need to transfer, left and right are the same, so use
  48. one */
  49. volatile uint8_t queueUser; /*!< Index for user to queue transfer. */
  50. volatile uint8_t queueDriver; /*!< Index for driver to get the transfer data and size */
  51. };
  52. /*******************************************************************************
  53. * APIs
  54. ******************************************************************************/
  55. #if defined(__cplusplus)
  56. extern "C" {
  57. #endif
  58. /*!
  59. * @name eDMA Transactional
  60. * @{
  61. */
  62. /*!
  63. * @brief Initializes the SPDIF eDMA handle.
  64. *
  65. * This function initializes the SPDIF master DMA handle, which can be used for other SPDIF master transactional APIs.
  66. * Usually, for a specified SPDIF instance, call this API once to get the initialized handle.
  67. *
  68. * @param base SPDIF base pointer.
  69. * @param handle SPDIF eDMA handle pointer.
  70. * @param base SPDIF peripheral base address.
  71. * @param callback Pointer to user callback function.
  72. * @param userData User parameter passed to the callback function.
  73. * @param dmaLeftHandle eDMA handle pointer for left channel, this handle shall be static allocated by users.
  74. * @param dmaRightHandle eDMA handle pointer for right channel, this handle shall be static allocated by users.
  75. */
  76. void SPDIF_TransferTxCreateHandleEDMA(SPDIF_Type *base,
  77. spdif_edma_handle_t *handle,
  78. spdif_edma_callback_t callback,
  79. void *userData,
  80. edma_handle_t *dmaLeftHandle,
  81. edma_handle_t *dmaRightHandle);
  82. /*!
  83. * @brief Initializes the SPDIF Rx eDMA handle.
  84. *
  85. * This function initializes the SPDIF slave DMA handle, which can be used for other SPDIF master transactional APIs.
  86. * Usually, for a specified SPDIF instance, call this API once to get the initialized handle.
  87. *
  88. * @param base SPDIF base pointer.
  89. * @param handle SPDIF eDMA handle pointer.
  90. * @param base SPDIF peripheral base address.
  91. * @param callback Pointer to user callback function.
  92. * @param userData User parameter passed to the callback function.
  93. * @param dmaLeftHandle eDMA handle pointer for left channel, this handle shall be static allocated by users.
  94. * @param dmaRightHandle eDMA handle pointer for right channel, this handle shall be static allocated by users.
  95. */
  96. void SPDIF_TransferRxCreateHandleEDMA(SPDIF_Type *base,
  97. spdif_edma_handle_t *handle,
  98. spdif_edma_callback_t callback,
  99. void *userData,
  100. edma_handle_t *dmaLeftHandle,
  101. edma_handle_t *dmaRightHandle);
  102. /*!
  103. * @brief Performs a non-blocking SPDIF transfer using DMA.
  104. *
  105. * @note This interface returns immediately after the transfer initiates. Call
  106. * SPDIF_GetTransferStatus to poll the transfer status and check whether the SPDIF transfer is finished.
  107. *
  108. * @param base SPDIF base pointer.
  109. * @param handle SPDIF eDMA handle pointer.
  110. * @param xfer Pointer to the DMA transfer structure.
  111. * @retval kStatus_Success Start a SPDIF eDMA send successfully.
  112. * @retval kStatus_InvalidArgument The input argument is invalid.
  113. * @retval kStatus_TxBusy SPDIF is busy sending data.
  114. */
  115. status_t SPDIF_TransferSendEDMA(SPDIF_Type *base, spdif_edma_handle_t *handle, spdif_edma_transfer_t *xfer);
  116. /*!
  117. * @brief Performs a non-blocking SPDIF receive using eDMA.
  118. *
  119. * @note This interface returns immediately after the transfer initiates. Call
  120. * the SPDIF_GetReceiveRemainingBytes to poll the transfer status and check whether the SPDIF transfer is finished.
  121. *
  122. * @param base SPDIF base pointer
  123. * @param handle SPDIF eDMA handle pointer.
  124. * @param xfer Pointer to DMA transfer structure.
  125. * @retval kStatus_Success Start a SPDIF eDMA receive successfully.
  126. * @retval kStatus_InvalidArgument The input argument is invalid.
  127. * @retval kStatus_RxBusy SPDIF is busy receiving data.
  128. */
  129. status_t SPDIF_TransferReceiveEDMA(SPDIF_Type *base, spdif_edma_handle_t *handle, spdif_edma_transfer_t *xfer);
  130. /*!
  131. * @brief Aborts a SPDIF transfer using eDMA.
  132. *
  133. * @param base SPDIF base pointer.
  134. * @param handle SPDIF eDMA handle pointer.
  135. */
  136. void SPDIF_TransferAbortSendEDMA(SPDIF_Type *base, spdif_edma_handle_t *handle);
  137. /*!
  138. * @brief Aborts a SPDIF receive using eDMA.
  139. *
  140. * @param base SPDIF base pointer
  141. * @param handle SPDIF eDMA handle pointer.
  142. */
  143. void SPDIF_TransferAbortReceiveEDMA(SPDIF_Type *base, spdif_edma_handle_t *handle);
  144. /*!
  145. * @brief Gets byte count sent by SPDIF.
  146. *
  147. * @param base SPDIF base pointer.
  148. * @param handle SPDIF eDMA handle pointer.
  149. * @param count Bytes count sent by SPDIF.
  150. * @retval kStatus_Success Succeed get the transfer count.
  151. * @retval kStatus_NoTransferInProgress There is no non-blocking transaction in progress.
  152. */
  153. status_t SPDIF_TransferGetSendCountEDMA(SPDIF_Type *base, spdif_edma_handle_t *handle, size_t *count);
  154. /*!
  155. * @brief Gets byte count received by SPDIF.
  156. *
  157. * @param base SPDIF base pointer
  158. * @param handle SPDIF eDMA handle pointer.
  159. * @param count Bytes count received by SPDIF.
  160. * @retval kStatus_Success Succeed get the transfer count.
  161. * @retval kStatus_NoTransferInProgress There is no non-blocking transaction in progress.
  162. */
  163. status_t SPDIF_TransferGetReceiveCountEDMA(SPDIF_Type *base, spdif_edma_handle_t *handle, size_t *count);
  164. /*! @} */
  165. #if defined(__cplusplus)
  166. }
  167. #endif
  168. /*!
  169. * @}
  170. */
  171. #endif