fsl_pdm_edma.h

/*
 * Copyright 2019 - 2020, NXP
 * All rights reserved.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
#ifndef _FSL_PDM_EDMA_H_
#define _FSL_PDM_EDMA_H_
 
#include "fsl_edma.h"
#include "fsl_pdm.h"
 
/*******************************************************************************
 * Definitions
 ******************************************************************************/
 
#define FSL_PDM_EDMA_DRIVER_VERSION (MAKE_VERSION(2, 6, 1)) 
 
typedef struct _pdm_edma_handle pdm_edma_handle_t;
 
typedef enum _pdm_edma_multi_channel_interleave
{
    kPDM_EDMAMultiChannelInterleavePerChannelSample =
        0U, 
    kPDM_EDMAMultiChannelInterleavePerChannelBlock =
        1U, 
} pdm_edma_multi_channel_interleave_t;
 
typedef struct _pdm_edma_transfer
{
    volatile uint8_t *data;                  
    volatile size_t dataSize;                
    struct _pdm_edma_transfer *linkTransfer; 
} pdm_edma_transfer_t;
 
typedef void (*pdm_edma_callback_t)(PDM_Type *base, pdm_edma_handle_t *handle, status_t status, void *userData);
 
struct _pdm_edma_handle
{
    edma_handle_t *dmaHandle;     
    uint8_t count;                
    uint32_t receivedBytes;       
    uint32_t state;               
    pdm_edma_callback_t callback; 
    bool isLoopTransfer;          
    void *userData;               
    edma_tcd_t *tcd;              
    uint32_t tcdNum;              
    uint32_t tcdUser;             
    uint32_t tcdDriver;           
    volatile uint32_t tcdUsedNum; 
    pdm_edma_multi_channel_interleave_t interleaveType; 
    uint8_t endChannel;  
    uint8_t channelNums; 
};
 
/*******************************************************************************
 * APIs
 ******************************************************************************/
#if defined(__cplusplus)
extern "C" {
#endif
 
void PDM_TransferInstallEDMATCDMemory(pdm_edma_handle_t *handle, void *tcdAddr, size_t tcdNum);
 
void PDM_TransferCreateHandleEDMA(
    PDM_Type *base, pdm_edma_handle_t *handle, pdm_edma_callback_t callback, void *userData, edma_handle_t *dmaHandle);
 
void PDM_TransferSetMultiChannelInterleaveType(pdm_edma_handle_t *handle,
                                               pdm_edma_multi_channel_interleave_t multiChannelInterleaveType);
 
void PDM_TransferSetChannelConfigEDMA(PDM_Type *base,
                                      pdm_edma_handle_t *handle,
                                      uint32_t channel,
                                      const pdm_channel_config_t *config);
 
status_t PDM_TransferReceiveEDMA(PDM_Type *base, pdm_edma_handle_t *handle, pdm_edma_transfer_t *xfer);
 
void PDM_TransferTerminateReceiveEDMA(PDM_Type *base, pdm_edma_handle_t *handle);
 
void PDM_TransferAbortReceiveEDMA(PDM_Type *base, pdm_edma_handle_t *handle);
 
status_t PDM_TransferGetReceiveCountEDMA(PDM_Type *base, pdm_edma_handle_t *handle, size_t *count);
 
#if defined(__cplusplus)
}
#endif
 
#endif