ADCBuf.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016, 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_adcbuf__include
#define ti_drivers_adcbuf__include

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>

#define ADCBuf_CMD_RESERVED             (32)

#define ADCBuf_STATUS_RESERVED          (-32)

#define ADCBuf_STATUS_SUCCESS           (0)

#define ADCBuf_STATUS_ERROR             (-1)

#define ADCBuf_STATUS_UNDEFINEDCMD      (-2)

#define ADCBuf_STATUS_UNSUPPORTED      (-3)

/* Add ADCBUF_CMD_<commands> here */

typedef struct ADCBuf_Config_              *ADCBuf_Handle;

typedef struct ADCBuf_Conversion_ {
    uint16_t            samplesRequestedCount;      
    void                *sampleBuffer;              
    void                *sampleBufferTwo;           
    void                *arg;                       
    uint32_t            adcChannel;                 
} ADCBuf_Conversion;

typedef void (*ADCBuf_Callback)            (ADCBuf_Handle handle,
                                            ADCBuf_Conversion *conversion,
                                            void *completedADCBuffer,
                                            uint32_t completedChannel);
typedef enum ADCBuf_Recurrence_Mode_ {
    ADCBuf_RECURRENCE_MODE_ONE_SHOT,
    ADCBuf_RECURRENCE_MODE_CONTINUOUS
} ADCBuf_Recurrence_Mode;

typedef enum ADCBuf_Return_Mode_ {
    ADCBuf_RETURN_MODE_BLOCKING,

    ADCBuf_RETURN_MODE_CALLBACK
} ADCBuf_Return_Mode;


typedef struct ADCBuf_Params_ {
    uint32_t                    blockingTimeout;    
    uint32_t                    samplingFrequency;  
    ADCBuf_Return_Mode          returnMode;         
    ADCBuf_Callback             callbackFxn;        
    ADCBuf_Recurrence_Mode      recurrenceMode;     
    void                        *custom;            
} ADCBuf_Params;

typedef void (*ADCBuf_CloseFxn)                  (ADCBuf_Handle handle);


typedef ADCBuf_Handle (*ADCBuf_OpenFxn)          (ADCBuf_Handle handle,
                                                  const ADCBuf_Params *params);

typedef int_fast16_t (*ADCBuf_ControlFxn)        (ADCBuf_Handle handle,
                                                  uint_fast8_t cmd,
                                                  void *arg);
/*
 *  @brief      A function pointer to a driver specific implementation of
 *              ADCBuf_init().
 */
typedef void (*ADCBuf_InitFxn)                   (ADCBuf_Handle handle);

typedef int_fast16_t (*ADCBuf_ConvertFxn)     (ADCBuf_Handle handle,
                                               ADCBuf_Conversion conversions[],
                                               uint_fast8_t channelCount);
typedef int_fast16_t (*ADCBuf_ConvertCancelFxn)(ADCBuf_Handle handle);

typedef uint_fast8_t (*ADCBuf_GetResolutionFxn)     (ADCBuf_Handle handle);

typedef int_fast16_t (*ADCBuf_adjustRawValuesFxn)(ADCBuf_Handle handle,
                                                void *sampleBuffer,
                                                uint_fast16_t sampleCount,
                                                uint32_t adcChannel);

typedef int_fast16_t (*ADCBuf_convertAdjustedToMicroVoltsFxn)  (ADCBuf_Handle handle,
                                                            uint32_t  adcChannel,
                                                            void *adjustedSampleBuffer,
                                                            uint32_t outputMicroVoltBuffer[],
                                                            uint_fast16_t sampleCount);

typedef struct ADCBuf_FxnTable_ {
    ADCBuf_CloseFxn            closeFxn;
    ADCBuf_ControlFxn          controlFxn;
    ADCBuf_InitFxn             initFxn;
    ADCBuf_OpenFxn             openFxn;
    ADCBuf_ConvertFxn          convertFxn;
    ADCBuf_ConvertCancelFxn    convertCancelFxn;
    ADCBuf_GetResolutionFxn    getResolutionFxn;
    ADCBuf_adjustRawValuesFxn   adjustRawValuesFxn;
    ADCBuf_convertAdjustedToMicroVoltsFxn   convertAdjustedToMicroVoltsFxn;
} ADCBuf_FxnTable;

typedef struct ADCBuf_Config_ {
    const ADCBuf_FxnTable   *fxnTablePtr;

    void                    *object;

    void const              *hwAttrs;
} ADCBuf_Config;

extern void ADCBuf_close(ADCBuf_Handle handle);


extern int_fast16_t ADCBuf_control(ADCBuf_Handle handle, uint_fast16_t cmd, void *cmdArg);

extern void ADCBuf_init(void);

extern void ADCBuf_Params_init(ADCBuf_Params *params);

extern ADCBuf_Handle ADCBuf_open(uint_least8_t index, ADCBuf_Params *params);

extern int_fast16_t ADCBuf_convert(ADCBuf_Handle handle, ADCBuf_Conversion conversions[],  uint_fast8_t channelCount);

extern int_fast16_t ADCBuf_convertCancel(ADCBuf_Handle handle);

extern uint_fast8_t ADCBuf_getResolution(ADCBuf_Handle handle);

extern int_fast16_t ADCBuf_adjustRawValues(ADCBuf_Handle handle, void *sampleBuf, uint_fast16_t sampleCount, uint32_t adcChan);

extern int_fast16_t ADCBuf_convertAdjustedToMicroVolts(ADCBuf_Handle handle, uint32_t  adcChan, void *adjustedSampleBuffer, uint32_t outputMicroVoltBuffer[], uint_fast16_t sampleCount);

#ifdef __cplusplus
}
#endif
#endif /* ti_drivers_adcbuf__include */