sdrv_pdm.h

Go to the documentation of this file.

 
#ifndef SDRV_PDM_H_
#define SDRV_PDM_H_
 
#include <types.h>
 
#include "sdrv_ckgen.h"
#include "sdrv_common.h"
#include "sdrv_dma.h"
 
/* sdrv pdm max transfres */
#define SDRV_PDM_XFER_NUM_TRANSFERS (4U)
/* sdrv pdm dma buff size default value */
#define SDRV_PDM_CHANNELS_COUNT 1
#define SDRV_PDM_CHANNELS_BYTES (SDRV_PDM_SAMPLE_WIDTH_16BITS / 8)
#define SDRV_PDM_DMA_PERIOD_FRAME_SIZE 1024 * 4
#define SDRV_PDM_DMA_PERIOD_SIZE                                               \
    SDRV_PDM_DMA_PERIOD_FRAME_SIZE *SDRV_PDM_CHANNELS_COUNT                    \
        *SDRV_PDM_CHANNELS_BYTES
#define SDRV_PDM_DMA_PERIOD_COUNT 2
#define SDRV_PDM_DMA_BUF_TOTAL_SIZE                                            \
    SDRV_PDM_DMA_PERIOD_SIZE *SDRV_PDM_DMA_PERIOD_COUNT
 
typedef enum sdrv_pdm_channel {
    SDRV_PDM_CHANNEL_LEFT = 0x00,
    SDRV_PDM_CHANNEL_RIGHT = 0x01,
    SDRV_PDM_CHANNEL_STEREO = 0x02,
} sdrv_pdm_channel_t;
 
typedef enum sdrv_pdm_gain {
    SDRV_PDM_GAIN_N6DB = 0x01,
    SDRV_PDM_GAIN_N12DB = 0x02,
    SDRV_PDM_GAIN_N18DB = 0x03,
    SDRV_PDM_GAIN_N24DB = 0x04,
    SDRV_PDM_GAIN_P0DB = 0x05,
    SDRV_PDM_GAIN_P6DB = 0x06,
    SDRV_PDM_GAIN_P12DB = 0x07,
    SDRV_PDM_GAIN_P18DB = 0x08,
    SDRV_PDM_GAIN_P24DB = 0x09,
} sdrv_pdm_gain_t;
 
typedef enum sdrv_pdm_sample_rate {
    SDRV_PDM_SR_5512 = 5512,
    SDRV_PDM_SR_8000 = 8000,
    SDRV_PDM_SR_11025 = 11025,
    SDRV_PDM_SR_16000 = 16000,
    SDRV_PDM_SR_22050 = 22050,
    SDRV_PDM_SR_32000 = 32000,
    SDRV_PDM_SR_44100 = 44100,
    SDRV_PDM_SR_48000 = 48000,
    SDRV_PDM_SR_64000 = 64000,
    SDRV_PDM_SR_88200 = 88200,
    SDRV_PDM_SR_96000 = 96000,
    SDRV_PDM_SR_176400 = 176400,
    SDRV_PDM_SR_192000 = 192000,
} sdrv_pdm_sample_rate_t;
 
typedef enum sdrv_pdm_sample_width {
    SDRV_PDM_SAMPLE_WIDTH_8BITS = 8,
    SDRV_PDM_SAMPLE_WIDTH_16BITS = 16,
    SDRV_PDM_SAMPLE_WIDTH_24BITS = 24,
    SDRV_PDM_SAMPLE_WIDTH_32BITS = 32,
} sdrv_pdm_sample_width_t;
 
typedef enum sdrv_pdm_status {
    /* status for Success */
    SDRV_PDM_STATUS_SUCCESS = SDRV_ERROR_STATUS(SDRV_STATUS_GROUP_COMMON, 0),
    /* status for Fail */
    SDRV_PDM_STATUS_FAIL = SDRV_ERROR_STATUS(SDRV_STATUS_GROUP_PDM, 1),
    /* status for invalid argument check */
    SDRV_PDM_STATUS_INVALID_PARAMS =
        SDRV_ERROR_STATUS(SDRV_STATUS_GROUP_PDM, 2),
    /* status for Overrun */
    SDRV_PDM_STATUS_OVERRUN = SDRV_ERROR_STATUS(SDRV_STATUS_GROUP_PDM, 3),
    /* status for underrun */
    SDRV_PDM_STATUS_UNDERRUN = SDRV_ERROR_STATUS(SDRV_STATUS_GROUP_PDM, 4),
} sdrv_pdm_status_t;
 
typedef struct sdrv_pdm_dma_data {
    paddr_t addr;
    sdrv_dma_bus_width_e addr_width;
    unsigned int max_burst;
    unsigned int fifo_size;
} sdrv_pdm_dma_data_t;
 
typedef struct sdrv_pdm_dma_buf {
    uint8_t *addr;
    int32_t buffer_bytes;
    int32_t period_bytes;
    int32_t periods;
    uint32_t appl_ptr;
    uint32_t hw_ptr;
    uint32_t boundary;
} sdrv_pdm_dma_buf_t;
 
typedef struct sdrv_pdm_transfer {
    uint8_t *data;
    uint32_t length;
    uint8_t id;
} sdrv_pdm_transfer_t;
 
/* @brief sdrv pdm transfer callback function. */
typedef void (*sdrv_pdm_callback)(sdrv_pdm_transfer_t *transfer, void *context,
                                  sdrv_pdm_status_t state);
typedef struct sdrv_pdm_params {
    sdrv_pdm_channel_t channels;
    sdrv_pdm_sample_width_t sample_width;
    sdrv_pdm_sample_rate_t sample_rate;
    sdrv_pdm_gain_t gain;
    unsigned int period_bytes;
    unsigned int periods;
    uint8_t *dma_buff;
    bool usedma;
 
} sdrv_pdm_params_t;
 
typedef struct sdrv_pdm_stream {
    sdrv_pdm_params_t params;
    sdrv_pdm_transfer_t queue[SDRV_PDM_XFER_NUM_TRANSFERS];
    bool active;
    uint8_t queue_appl;
    uint8_t queue_hw;
    sdrv_pdm_callback callback;
    void *context;
    bool pack_mode;
    bool data_lsb;
    unsigned threshold;
    sdrv_dma_t dma_instance;
    sdrv_dma_channel_t dma_channel;
    sdrv_pdm_dma_data_t dma_data;
    sdrv_pdm_dma_buf_t dma_buf;
    bool dma_abort;
} sdrv_pdm_stream_t;
 
typedef struct sdrv_pdm_config {
    paddr_t base;
    int id;
    uint32_t irq;
    sdrv_ckgen_node_t *clk;
    paddr_t dma_base;
    sdrv_dma_channel_id_e dma_channel;
} sdrv_pdm_config_t;
 
typedef struct sdrv_pdm {
    sdrv_pdm_config_t *config;
    uint32_t clk_rate;
    sdrv_pdm_stream_t stream;
} sdrv_pdm_t;
 
sdrv_pdm_status_t sdrv_pdm_init(sdrv_pdm_t *pdm, sdrv_pdm_config_t *cfg);
 
sdrv_pdm_status_t sdrv_pdm_get_default_params(sdrv_pdm_t *pdm,
                                              sdrv_pdm_params_t *params);
 
sdrv_pdm_status_t sdrv_pdm_set_params(sdrv_pdm_t *pdm,
                                      sdrv_pdm_params_t *params);
 
sdrv_pdm_status_t sdrv_pdm_create_transfer(sdrv_pdm_t *pdm,
                                           sdrv_pdm_callback callback,
                                           void *context);
 
sdrv_pdm_status_t sdrv_pdm_submit_transfer(sdrv_pdm_t *pdm,
                                           sdrv_pdm_transfer_t *transfer);
 
sdrv_pdm_status_t sdrv_pdm_start(sdrv_pdm_t *pdm);
 
sdrv_pdm_status_t sdrv_pdm_stop(sdrv_pdm_t *pdm);
 
#endif /* SDRV_PDM_H_ */