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
|
/*
* Copyright (c) 2018, Freescale Semiconductor, Inc.
* Copyright 2019 - 2020, NXP
* All rights reserved.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
#ifndef _FSL_PDM_SDMA_H_
#define _FSL_PDM_SDMA_H_
#include "fsl_pdm.h"
#include "fsl_sdma.h"
/*!
* @addtogroup pdm_sdma PDM SDMA Driver
* @ingroup pdm
* @{
*/
/*******************************************************************************
* Definitions
******************************************************************************/
/*! @name Driver version */
/*@{*/
#define FSL_PDM_SDMA_DRIVER_VERSION (MAKE_VERSION(2, 7, 0)) /*!< Version 2.7.0 */
/*@}*/
typedef struct _pdm_sdma_handle pdm_sdma_handle_t;
/*! @brief PDM eDMA transfer callback function for finish and error */
typedef void (*pdm_sdma_callback_t)(PDM_Type *base, pdm_sdma_handle_t *handle, status_t status, void *userData);
/*! @brief PDM DMA transfer handle, users should not touch the content of the handle.*/
struct _pdm_sdma_handle
{
sdma_handle_t *dmaHandle; /*!< DMA handler for PDM send */
uint8_t nbytes; /*!< eDMA minor byte transfer count initially configured. */
uint8_t fifoWidth; /*!< fifo width */
uint8_t endChannel; /*!< The last enabled channel */
uint8_t channelNums; /*!< total channel numbers */
uint32_t count; /*!< The transfer data count in a DMA request */
uint32_t state; /*!< Internal state for PDM eDMA transfer */
uint32_t eventSource; /*!< PDM event source number */
pdm_sdma_callback_t callback; /*!< Callback for users while transfer finish or error occurs */
void *userData; /*!< User callback parameter */
sdma_buffer_descriptor_t bdPool[PDM_XFER_QUEUE_SIZE]; /*!< BD pool for SDMA transfer. */
pdm_transfer_t pdmQueue[PDM_XFER_QUEUE_SIZE]; /*!< Transfer queue storing queued transfer. */
size_t transferSize[PDM_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 eDMA Transactional
* @{
*/
/*!
* @brief Initializes the PDM eDMA handle.
*
* This function initializes the PDM DMA handle, which can be used for other PDM master transactional APIs.
* Usually, for a specified PDM instance, call this API once to get the initialized handle.
*
* @param base PDM base pointer.
* @param handle PDM eDMA handle pointer.
* @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.
* @param eventSource PDM event source number.
*/
void PDM_TransferCreateHandleSDMA(PDM_Type *base,
pdm_sdma_handle_t *handle,
pdm_sdma_callback_t callback,
void *userData,
sdma_handle_t *dmaHandle,
uint32_t eventSource);
/*!
* @brief Performs a non-blocking PDM receive using eDMA.
*
* @note This interface returns immediately after the transfer initiates. Call
* the PDM_GetReceiveRemainingBytes to poll the transfer status and check whether the PDM transfer is finished.
*
* @param base PDM base pointer
* @param handle PDM eDMA handle pointer.
* @param xfer Pointer to DMA transfer structure.
* @retval kStatus_Success Start a PDM eDMA receive successfully.
* @retval kStatus_InvalidArgument The input argument is invalid.
* @retval kStatus_RxBusy PDM is busy receiving data.
*/
status_t PDM_TransferReceiveSDMA(PDM_Type *base, pdm_sdma_handle_t *handle, pdm_transfer_t *xfer);
/*!
* @brief Aborts a PDM receive using eDMA.
*
* @param base PDM base pointer
* @param handle PDM eDMA handle pointer.
*/
void PDM_TransferAbortReceiveSDMA(PDM_Type *base, pdm_sdma_handle_t *handle);
/*!
* @brief PDM channel configurations.
*
* @param base PDM base pointer.
* @param handle PDM eDMA handle pointer.
* @param channel channel number.
* @param config channel configurations.
*/
void PDM_SetChannelConfigSDMA(PDM_Type *base,
pdm_sdma_handle_t *handle,
uint32_t channel,
const pdm_channel_config_t *config);
/*!
* @brief Terminate all the PDM sdma receive transfer.
*
* @param base PDM base pointer.
* @param handle PDM SDMA handle pointer.
*/
void PDM_TransferTerminateReceiveSDMA(PDM_Type *base, pdm_sdma_handle_t *handle);
/*! @} */
#if defined(__cplusplus)
}
#endif
/*!
* @}
*/
#endif
|
