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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
|
/*
* Copyright 2017 - 2021 NXP
* All rights reserved.
*
*
* SPDX-License-Identifier: BSD-3-Clause
*/
#ifndef _FSL_SAI_SDMA_H_
#define _FSL_SAI_SDMA_H_
#include "fsl_sai.h"
#include "fsl_sdma.h"
/*!
* @addtogroup sai_sdma SAI SDMA Driver
* @ingroup sai
* @{
*/
/*******************************************************************************
* Definitions
******************************************************************************/
/*! @name Driver version */
/*@{*/
#define FSL_SAI_SDMA_DRIVER_VERSION (MAKE_VERSION(2, 5, 3)) /*!< Version 2.5.3 */
/*@}*/
typedef struct _sai_sdma_handle sai_sdma_handle_t;
/*! @brief SAI SDMA transfer callback function for finish and error */
typedef void (*sai_sdma_callback_t)(I2S_Type *base, sai_sdma_handle_t *handle, status_t status, void *userData);
/*! @brief SAI DMA transfer handle, users should not touch the content of the handle. */
struct _sai_sdma_handle
{
sdma_handle_t *dmaHandle; /*!< DMA handler for SAI send */
uint8_t bytesPerFrame; /*!< Bytes in a frame */
uint8_t channel; /*!< start data channel */
uint8_t channelNums; /*!< total transfer channel numbers, used for multififo */
uint8_t channelMask; /*!< enabled channel mask value, refernece _sai_channel_mask */
uint8_t fifoOffset; /*!< fifo address offset between multifo*/
uint32_t count; /*!< The transfer data count in a DMA request */
uint32_t state; /*!< Internal state for SAI SDMA transfer */
uint32_t eventSource; /*!< SAI event source number */
sai_sdma_callback_t callback; /*!< Callback for users while transfer finish or error occurs */
void *userData; /*!< User callback parameter */
sdma_buffer_descriptor_t bdPool[SAI_XFER_QUEUE_SIZE]; /*!< BD pool for SDMA transfer. */
sai_transfer_t saiQueue[SAI_XFER_QUEUE_SIZE]; /*!< Transfer queue storing queued transfer. */
size_t transferSize[SAI_XFER_QUEUE_SIZE]; /*!< Data bytes need to transfer */
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 SDMA Transactional
* @{
*/
/*!
* @brief Initializes the SAI SDMA 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 SDMA 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 SDMA handle pointer, this handle shall be static allocated by users.
* @param eventSource SAI event source number.
*/
void SAI_TransferTxCreateHandleSDMA(I2S_Type *base,
sai_sdma_handle_t *handle,
sai_sdma_callback_t callback,
void *userData,
sdma_handle_t *dmaHandle,
uint32_t eventSource);
/*!
* @brief Initializes the SAI Rx SDMA 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 SDMA 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 SDMA handle pointer, this handle shall be static allocated by users.
* @param eventSource SAI event source number.
*/
void SAI_TransferRxCreateHandleSDMA(I2S_Type *base,
sai_sdma_handle_t *handle,
sai_sdma_callback_t callback,
void *userData,
sdma_handle_t *dmaHandle,
uint32_t eventSource);
/*!
* @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 SDMA parameter according to formatting requirements.
*
* @param base SAI base pointer.
* @param handle SAI SDMA 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_TransferTxSetFormatSDMA(I2S_Type *base,
sai_sdma_handle_t *handle,
sai_transfer_format_t *format,
uint32_t mclkSourceClockHz,
uint32_t bclkSourceClockHz);
/*!
* @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 SDMA parameter according to formatting requirements.
*
* @param base SAI base pointer.
* @param handle SAI SDMA 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_TransferRxSetFormatSDMA(I2S_Type *base,
sai_sdma_handle_t *handle,
sai_transfer_format_t *format,
uint32_t mclkSourceClockHz,
uint32_t bclkSourceClockHz);
/*!
* @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 SDMA handle pointer.
* @param xfer Pointer to the DMA transfer structure.
* @retval kStatus_Success Start a SAI SDMA send successfully.
* @retval kStatus_InvalidArgument The input argument is invalid.
* @retval kStatus_TxBusy SAI is busy sending data.
*/
status_t SAI_TransferSendSDMA(I2S_Type *base, sai_sdma_handle_t *handle, sai_transfer_t *xfer);
/*!
* @brief Performs a non-blocking SAI receive using SDMA.
*
* @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 SDMA handle pointer.
* @param xfer Pointer to DMA transfer structure.
* @retval kStatus_Success Start a SAI SDMA receive successfully.
* @retval kStatus_InvalidArgument The input argument is invalid.
* @retval kStatus_RxBusy SAI is busy receiving data.
*/
status_t SAI_TransferReceiveSDMA(I2S_Type *base, sai_sdma_handle_t *handle, sai_transfer_t *xfer);
/*!
* @brief Aborts a SAI transfer using SDMA.
*
* @param base SAI base pointer.
* @param handle SAI SDMA handle pointer.
*/
void SAI_TransferAbortSendSDMA(I2S_Type *base, sai_sdma_handle_t *handle);
/*!
* @brief Aborts a SAI receive using SDMA.
*
* @param base SAI base pointer
* @param handle SAI SDMA handle pointer.
*/
void SAI_TransferAbortReceiveSDMA(I2S_Type *base, sai_sdma_handle_t *handle);
/*!
* @brief Terminate all the SAI sdma receive transfer.
*
* @param base SAI base pointer.
* @param handle SAI SDMA handle pointer.
*/
void SAI_TransferTerminateReceiveSDMA(I2S_Type *base, sai_sdma_handle_t *handle);
/*!
* @brief Terminate all the SAI sdma send transfer.
*
* @param base SAI base pointer.
* @param handle SAI SDMA handle pointer.
*/
void SAI_TransferTerminateSendSDMA(I2S_Type *base, sai_sdma_handle_t *handle);
/*!
* brief Configures the SAI RX.
*
* param base SAI base pointer.
* param handle SAI SDMA handle pointer.
* param saiConig sai configurations.
*/
void SAI_TransferRxSetConfigSDMA(I2S_Type *base, sai_sdma_handle_t *handle, sai_transceiver_t *saiConfig);
/*!
* brief Configures the SAI Tx.
*
* param base SAI base pointer.
* param handle SAI SDMA handle pointer.
* param saiConig sai configurations.
*/
void SAI_TransferTxSetConfigSDMA(I2S_Type *base, sai_sdma_handle_t *handle, sai_transceiver_t *saiConfig);
/*! @} */
#if defined(__cplusplus)
}
#endif
/*!
* @}
*/
#endif
|
