ADCBufCC26XX.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-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_adc_adcbufcc26xx__include
#define ti_drivers_adc_adcbufcc26xx__include

#ifdef __cplusplus
extern "C" {
#endif

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

#include <ti/drivers/ADCBuf.h>
#include <ti/drivers/PIN.h>
#include <ti/drivers/pin/PINCC26XX.h>
#include <ti/drivers/dma/UDMACC26XX.h>
#include <ti/drivers/timer/GPTimerCC26XX.h>
#include <ti/drivers/Power.h>
#include <ti/drivers/power/PowerCC26XX.h>

#include <driverlib/aux_adc.h>

/*
 * The following allows this header file to be included in an application file
 * which also includes ti/sysbios/hal/Hwi.h.
 */
#define ti_sysbios_family_arm_m3_Hwi__nolocalnames
#include <ti/sysbios/family/arm/m3/Hwi.h>
#include <ti/sysbios/knl/Clock.h>
#include <ti/sysbios/knl/Semaphore.h>
#include <ti/sysbios/knl/Swi.h>

/* Add ADCBufCC26XX_CMD_* macros here */

#define ADCBufCC26XX_CMD_ACQUIRE_ADC_SEMAPHORE ADCBuf_CMD_RESERVED + 1

#define ADCBufCC26XX_CMD_KEEP_ADC_SEMAPHORE ADCBuf_CMD_RESERVED + 2

#define ADCBufCC26XX_CMD_KEEP_ADC_SEMAPHORE_DISABLE ADCBuf_CMD_RESERVED + 3

#define ADCBufCC26XX_CMD_RELEASE_ADC_SEMAPHORE ADCBuf_CMD_RESERVED + 4

#define ADCBufCC26XX_RESOLUTION            12

#define ADCBufCC26XX_BYTES_PER_SAMPLE      2

/*
 * =============================================================================
 * Constants
 * =============================================================================
 */

/* ADCBuf function table pointer */
extern const ADCBuf_FxnTable ADCBufCC26XX_fxnTable;


/*
 * =============================================================================
 * Enumerations
 * =============================================================================
 */

typedef enum ADCBufCC26XX_Sampling_Mode {
    ADCBufCC26XX_SAMPING_MODE_SYNCHRONOUS,
    ADCBufCC26XX_SAMPING_MODE_ASYNCHRONOUS
} ADCBufCC26XX_Sampling_Mode;

typedef enum ADCBufCC26XX_Sampling_Duration {
    ADCBufCC26XX_SAMPLING_DURATION_2P7_US    = AUXADC_SAMPLE_TIME_2P7_US,
    ADCBufCC26XX_SAMPLING_DURATION_5P3_US    = AUXADC_SAMPLE_TIME_5P3_US,
    ADCBufCC26XX_SAMPLING_DURATION_10P6_US   = AUXADC_SAMPLE_TIME_10P6_US,
    ADCBufCC26XX_SAMPLING_DURATION_21P3_US   = AUXADC_SAMPLE_TIME_21P3_US,
    ADCBufCC26XX_SAMPLING_DURATION_42P6_US   = AUXADC_SAMPLE_TIME_42P6_US,
    ADCBufCC26XX_SAMPLING_DURATION_85P3_US   = AUXADC_SAMPLE_TIME_85P3_US,
    ADCBufCC26XX_SAMPLING_DURATION_170_US    = AUXADC_SAMPLE_TIME_170_US,
    ADCBufCC26XX_SAMPLING_DURATION_341_US    = AUXADC_SAMPLE_TIME_341_US,
    ADCBufCC26XX_SAMPLING_DURATION_682_US    = AUXADC_SAMPLE_TIME_682_US,
    ADCBufCC26XX_SAMPLING_DURATION_1P37_MS   = AUXADC_SAMPLE_TIME_1P37_MS,
    ADCBufCC26XX_SAMPLING_DURATION_2P73_MS   = AUXADC_SAMPLE_TIME_2P73_MS,
    ADCBufCC26XX_SAMPLING_DURATION_5P46_MS   = AUXADC_SAMPLE_TIME_5P46_MS,
    ADCBufCC26XX_SAMPLING_DURATION_10P9_MS   = AUXADC_SAMPLE_TIME_10P9_MS
} ADCBufCC26XX_Sampling_Duration;


typedef enum ADCBufCC26XX_Reference_Source {
    ADCBufCC26XX_FIXED_REFERENCE       = AUXADC_REF_FIXED,
    ADCBufCC26XX_VDDS_REFERENCE        = AUXADC_REF_VDDS_REL
} ADCBufCC26XX_Reference_Source;



/*
 * =============================================================================
 * Structs
 * =============================================================================
 */

typedef struct ADCBufCC26XX_AdcChannelLutEntry{
    uint8_t dio;            
    uint8_t compBInput;     
} ADCBufCC26XX_AdcChannelLutEntry;

typedef struct ADCBufCC26XX_ParamsExtension{
    ADCBufCC26XX_Sampling_Duration     samplingDuration;
    ADCBufCC26XX_Sampling_Mode         samplingMode;
    ADCBufCC26XX_Reference_Source      refSource;
    bool                                inputScalingEnabled;
} ADCBufCC26XX_ParamsExtension;

typedef struct ADCBufCC26XX_HWAttrs{
    uint32_t            swiPriority;
    uint32_t            gptDMAChannelMask;
    uint8_t             intPriority;
    ADCBufCC26XX_AdcChannelLutEntry  const *adcChannelLut;
    uint8_t             gpTimerUnit;
} ADCBufCC26XX_HWAttrs;



typedef struct ADCBufCC26XX_Object{
    /* ADC control variables */
    bool                            isOpen;                     
    bool                            conversionInProgress;       
    bool                            inputScalingEnabled;        
    bool                            keepADCSemaphore;           
    bool                            adcSemaphoreInPossession;   
    uint8_t                         currentChannel;             
    ADCBufCC26XX_Reference_Source   refSource;                  
    ADCBufCC26XX_Sampling_Mode      samplingMode;               
   ADCBufCC26XX_Sampling_Duration   samplingDuration;           
    ADCBuf_Callback                 callbackFxn;                
    ADCBuf_Recurrence_Mode          recurrenceMode;             
    ADCBuf_Return_Mode              returnMode;                 
    /* ADC SYS/BIOS objects */
    Hwi_Struct                      hwi;                        
    Swi_Struct                      swi;                        
    Semaphore_Struct                conversionComplete;         
    ADCBuf_Conversion               *currentConversion;         
    /* PIN driver state object and handle */
    PIN_State                       pinState;                   
    PIN_Handle                      pinHandle;                  
    /* UDMA driver handle */
    UDMACC26XX_Handle               udmaHandle;                 
    /* GPTimer driver handle */
    GPTimerCC26XX_Handle            timerHandle;                
    uint32_t                        semaphoreTimeout;           
    uint32_t                        samplingFrequency;          
} ADCBufCC26XX_Object, *ADCBufCC26XX_Handle;

/*
 * =============================================================================
 * Functions
 * =============================================================================
 */


/* Do not interfere with the app if they include the family Hwi module */
#undef ti_sysbios_family_arm_m3_Hwi__nolocalnames

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_adc_ADCBufCC26XX__include */