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