PDMCC26XX.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2019, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef ti_drivers_pdm_PDMCC26XX__include
#define ti_drivers_pdm_PDMCC26XX__include

#include <ti/drivers/dpl/HwiP.h>
#include <ti/drivers/dpl/SemaphoreP.h>

#include <ti/drivers/Power.h>
#include <ti/drivers/power/PowerCC26XX.h>

#ifdef __cplusplus
extern "C" {
#endif

/*********************************************************************
 * CONSTANTS
 */

#ifndef PDM_TASK_STACK_SIZE
    #define PDM_TASK_STACK_SIZE 850
#endif

#define PCM_SAMPLE_SIZE 16 // Only 16 bits supported for now

#define PCM_COMPRESSION_RATE 4

#define MINIMUM_PDM_BUFFER_QUEUE_DEPTH 3

#define PCM_METADATA_SIZE sizeof(PDMCC26XX_metaData)

/*********************************************************************
 * TYPEDEFS
 */

typedef struct
{
    uint8_t seqNum; 
    int8_t si;      
    int16_t pv;     
} PDMCC26XX_metaData;

typedef struct
{
    PDMCC26XX_metaData metaData; 
    uint8_t pBuffer[];           
} PDMCC26XX_pcmBuffer;

typedef void *(*PDMCC26XX_MallocFxn)(size_t memSize);

typedef void (*PDMCC26XX_FreeFxn)(void *ptr, size_t memSize);

typedef bool (*PDMCC26XX_Pdm2PcmFxn)(const void *pdmInBuffer,
                                     uint32_t *decimationState,
                                     const int32_t *biquadCoefficients,
                                     int16_t *pcmOutBuffer);

typedef struct
{
    void *object;

    void const *hwAttrs;
} PDMCC26XX_Config;

extern const PDMCC26XX_Config PDMCC26XX_config[];

typedef struct
{
    uint32_t micPower;
    int taskPriority;
} PDMCC26XX_HWAttrs;

typedef PDMCC26XX_Config *PDMCC26XX_Handle;

typedef enum
{
    PDMCC26XX_STREAM_IDLE,                         
    PDMCC26XX_STREAM_BLOCK_READY,                  
    PDMCC26XX_STREAM_BLOCK_READY_BUT_PDM_OVERFLOW, 
    PDMCC26XX_STREAM_ERROR,                        
    PDMCC26XX_STREAM_STOPPING,                     
    PDMCC26XX_STREAM_STOPPED,                      
    PDMCC26XX_STREAM_FAILED_TO_STOP                
} PDMCC26XX_Status;

typedef enum
{
    PDMCC26XX_PCM_SAMPLE_RATE_16K = 0,
    PDMCC26XX_PCM_SAMPLE_RATE_8K
} PDMCC26XX_PcmSampleRate;

typedef enum
{
    PDMCC26XX_GAIN_24 = 1318, 
    PDMCC26XX_GAIN_18 = 660,  
    PDMCC26XX_GAIN_12 = 331,  
    PDMCC26XX_GAIN_6  = 166,  
    PDMCC26XX_GAIN_0  = 83,   
    PDMCC26XX_GAIN_END        
} PDMCC26XX_Gain;

typedef struct
{
    void *arg;               
    PDMCC26XX_Status status; 
} PDMCC26XX_StreamNotification;

typedef void (*PDMCC26XX_CallbackFxn)(PDMCC26XX_Handle handle, PDMCC26XX_StreamNotification *streamNotification);

typedef struct
{
    PDMCC26XX_pcmBuffer *buffer; 
    PDMCC26XX_Status status;     
} PDMCC26XX_BufferRequest;

typedef struct
{
    /* PDM control variables */
    bool micPowerActiveHigh;          
    bool applyCompression;            
    uint8_t pdmBufferQueueDepth;      
    uint16_t retBufSizeInBytes;       
    const int32_t *decimationFilter;  
    size_t decimationFilterStateSize; 
    PDMCC26XX_Gain defaultFilterGain; 
    PDMCC26XX_PcmSampleRate pcmSampleRate;   
    uint32_t startupDelayWithClockInSamples; 
    PDMCC26XX_CallbackFxn callbackFxn;       
    PDMCC26XX_MallocFxn mallocFxn;           
    PDMCC26XX_FreeFxn freeFxn;               
    uintptr_t custom;                        
} PDMCC26XX_Params;

typedef struct
{
    /* PDM control variables */
    bool streamStarted;            
    bool micPowerActiveHigh;       
    bool applyCompression;         
    bool isOpen;                   
    uint16_t retBufSizeInBytes;    
    uint16_t pcmBufferSizeInBytes; 
    uint32_t startupDelayWithClockInSamples; 
    const int32_t *decimationFilter;  
    uint32_t *decimationFilterState;  
    size_t decimationFilterStateSize; 
    PDMCC26XX_StreamNotification *streamNotification; 
    PDMCC26XX_CallbackFxn callbackFxn;                
    PDMCC26XX_MallocFxn mallocFxn;                    
    PDMCC26XX_FreeFxn freeFxn;                        
    PDMCC26XX_Pdm2PcmFxn pdm2pcmFxn;                  
    HwiP_Struct hwi;                                  
} PDMCC26XX_Object;

extern void PDMCC26XX_init(PDMCC26XX_Handle handle);

extern PDMCC26XX_Handle PDMCC26XX_open(PDMCC26XX_Params *params);

extern void PDMCC26XX_close(PDMCC26XX_Handle handle);

extern bool PDMCC26XX_startStream(PDMCC26XX_Handle handle);

extern bool PDMCC26XX_stopStream(PDMCC26XX_Handle handle);

extern bool PDMCC26XX_requestBuffer(PDMCC26XX_Handle handle, PDMCC26XX_BufferRequest *bufferRequest);

/*
 * ======== PDMCC26XX_Params_init ========
 * @brief   Function for initialising a PDMCC26XX_Params instance to its default value
 *
 * @param   params Pointer to a set of uninitialised params
 *
 */
extern void PDMCC26XX_Params_init(PDMCC26XX_Params *params);

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_pdm_PDMCC26XX__include */