ADCBufMSP432.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016-2018, 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_adcbufmsp432__include
#define ti_drivers_adc_adcbufmsp432__include

#ifdef __cplusplus
extern "C" {
#endif

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

#include <ti/devices/DeviceFamily.h>
#include <ti/devices/msp432p4xx/driverlib/sysctl_a.h>
#include <ti/drivers/ADCBuf.h>
#include <ti/drivers/dpl/HwiP.h>
#include <ti/drivers/dpl/SemaphoreP.h>
#include <ti/drivers/Power.h>
#include <ti/drivers/dma/UDMAMSP432.h>

#include <ti/devices/msp432p4xx/driverlib/adc14.h>
/* Add ADCBufMSP432_CMD_* macros here */

#define ADCBufMSP432_CMD_ENTER_ADC_ULTRA_LOW_POWER_MODE ADCBuf_CMD_RESERVED + 1

#define ADCBufMSP432_CMD_EXIT_ADC_ULTRA_LOW_POWER_MODE ADCBuf_CMD_RESERVED + 2

/*
 *  ADCBuf port/pin defines for pin configuration.  Ports P2, P3, and P7 are
 *  configurable through the port mapping controller.  None of the port
 *  mappings support ADC.
 *  Channel specifies the ADC channel and ranges from 0 to 23.
 *  pin range: 0 - 7, port range: 0 - 15
 *
 *
 *    15 - 10    9   8  7 - 4  3 - 0
 *  ---------------------------------
 *  |  CHANNEL | X | X | PORT | PIN |
 *  ---------------------------------
 *
 *  channel = pinConfig >> 10
 *  port = (pinConfig >> 4) & 0xf
 *  pin = 1 << (pinConfig & 0xf)
 *  moduleFunction = (pinConfig >> 8) & 0x3
 *
 *  For non-configurable ports (bits 20 - 12 will be 0).
 *  Bits 8 and 9 hold the module function (PRIMARY, SECONDARY, or
 *  TERTIARY).  All ADC modes are TERTIARY, so bits 8 and 9
 *  are 1.
 *
 *  MAP_GPIO_setAsPeripheralModuleFunctionInputPin(port,
 *       pin, moduleFunction);
 *  or:
 *  MAP_GPIO_setAsPeripheralModuleFunctionOutputPin(port,
 *       pin, moduleFunction);
 *
 */
/* Port 4 */
#define ADCBufMSP432_P4_0_A13 ((13 << 10) | 0x0340) /* ch 13, port 4, pin 0 */
#define ADCBufMSP432_P4_1_A12 ((12 << 10) | 0x0341) /* ch 12, port 4, pin 1 */
#define ADCBufMSP432_P4_2_A11 ((11 << 10) | 0x0342) /* ch 11, port 4, pin 2 */
#define ADCBufMSP432_P4_3_A10 ((10 << 10) | 0x0343) /* ch 10, port 4, pin 3 */
#define ADCBufMSP432_P4_4_A9  ((9 << 10) | 0x0344)  /* ch 9, port 4, pin 4 */
#define ADCBufMSP432_P4_5_A8  ((8 << 10) | 0x0345)  /* ch 8, port 4, pin 5 */
#define ADCBufMSP432_P4_6_A7  ((7 << 10) | 0x0346)  /* ch 7, port 4, pin 6 */
#define ADCBufMSP432_P4_7_A6  ((6 << 10) | 0x0347)  /* ch 6, port 4, pin 7 */

/* Port 5 */
#define ADCBufMSP432_P5_0_A5  ((5 << 10) | 0x0350)  /* ch 5, port 5, pin 0 */
#define ADCBufMSP432_P5_1_A4  ((4 << 10) | 0x0351)  /* ch 4, port 5, pin 1 */
#define ADCBufMSP432_P5_2_A3  ((3 << 10) | 0x0352)  /* ch 3, port 5, pin 2 */
#define ADCBufMSP432_P5_3_A2  ((2 << 10) | 0x0353)  /* ch 2, port 5, pin 3 */
#define ADCBufMSP432_P5_4_A1  ((1 << 10) | 0x0354)  /* ch 1, port 5, pin 4 */
#define ADCBufMSP432_P5_5_A0  ((0 << 10) | 0x0355)  /* ch 0, port 5, pin 5 */

/* Port 6 */
#define ADCBufMSP432_P6_0_A15 ((15 << 10) | 0x0360)  /* ch 15, port 6, pin 0 */
#define ADCBufMSP432_P6_1_A14 ((14 << 10) | 0x0361)  /* ch 14, port 6, pin 1 */

/* Port 8 */
#define ADCBufMSP432_P8_2_A23 ((23 << 10) | 0x0382)  /* ch 23, port 8, pin 2 */
#define ADCBufMSP432_P8_3_A22 ((22 << 10) | 0x0383)  /* ch 22, port 8, pin 3 */
#define ADCBufMSP432_P8_4_A21 ((21 << 10) | 0x0384)  /* ch 21, port 8, pin 4 */
#define ADCBufMSP432_P8_5_A20 ((20 << 10) | 0x0385)  /* ch 20, port 8, pin 5 */
#define ADCBufMSP432_P8_6_A19 ((19 << 10) | 0x0386)  /* ch 19, port 8, pin 6 */
#define ADCBufMSP432_P8_7_A18 ((18 << 10) | 0x0387)  /* ch 18, port 8, pin 7 */

/* Port 9 */
#define ADCBufMSP432_P9_0_A17 ((17 << 10) | 0x0390)  /* ch 17, port 9, pin 0 */
#define ADCBufMSP432_P9_1_A16 ((16 << 10) | 0x0391)  /* ch 16, port 9, pin 1 */

#define ADCBufMSP432_PIN_NONE 0
#define ADCBufMSP432_INTERNAL_SOURCE_PIN 0

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

/* ADC function table pointer */
extern const ADCBuf_FxnTable ADCBufMSP432_fxnTable;

typedef enum ADCBufMSP432_ReferenceSource {
    ADCBufMSP432_VREFPOS_AVCC_VREFNEG_VSS = ADC_VREFPOS_AVCC_VREFNEG_VSS,
    ADCBufMSP432_VREFPOS_INTBUF_VREFNEG_VSS = ADC_VREFPOS_INTBUF_VREFNEG_VSS,
    ADCBufMSP432_VREFPOS_EXTPOS_VREFNEG_EXTNEG = ADC_VREFPOS_EXTPOS_VREFNEG_EXTNEG,
    ADCBufMSP432_VREFPOS_EXTBUF_VREFNEG_EXTNEG = ADC_VREFPOS_EXTBUF_VREFNEG_EXTNEG
}ADCBufMSP432_ReferenceSource;

typedef enum ADCBufMSP432_SamplingDuration {
    ADCBufMSP432_SamplingDuration_PULSE_WIDTH_4 = ADC_PULSE_WIDTH_4,
    ADCBufMSP432_SamplingDuration_PULSE_WIDTH_8 = ADC_PULSE_WIDTH_8,
    ADCBufMSP432_SamplingDuration_PULSE_WIDTH_16 = ADC_PULSE_WIDTH_16,
    ADCBufMSP432_SamplingDuration_PULSE_WIDTH_32 = ADC_PULSE_WIDTH_32,
    ADCBufMSP432_SamplingDuration_PULSE_WIDTH_64 = ADC_PULSE_WIDTH_64,
    ADCBufMSP432_SamplingDuration_PULSE_WIDTH_96 = ADC_PULSE_WIDTH_96,
    ADCBufMSP432_SamplingDuration_PULSE_WIDTH_128 = ADC_PULSE_WIDTH_128,
    ADCBufMSP432_SamplingDuration_PULSE_WIDTH_192 = ADC_PULSE_WIDTH_192
} ADCBufMSP432_SamplingDuration;

typedef enum ADCBufMSP432_TimerReferenceSource {
    ADCBufMSP432_TIMERA0_CAPTURECOMPARE1 = 0,
    ADCBufMSP432_TIMERA0_CAPTURECOMPARE2 = 1,
    ADCBufMSP432_TIMERA1_CAPTURECOMPARE1 = 2,
    ADCBufMSP432_TIMERA1_CAPTURECOMPARE2 = 3,
    ADCBufMSP432_TIMERA2_CAPTURECOMPARE1 = 4,
    ADCBufMSP432_TIMERA2_CAPTURECOMPARE2 = 5,
    ADCBufMSP432_TIMERA3_CAPTURECOMPARE1 = 6
}ADCBufMSP432_TimerReferenceSource;

typedef enum ADCBufMSP432_ClockSource {
   ADCBufMSP432_ADC_CLOCK = ADC_CLOCKSOURCE_ADCOSC,
   ADCBufMSP432_SYSOSC_CLOCK = ADC_CLOCKSOURCE_SYSOSC,
   ADCBufMSP432_ACLK_CLOCK = ADC_CLOCKSOURCE_ACLK,
   ADCBufMSP432_MCLK_CLOCK = ADC_CLOCKSOURCE_MCLK,
   ADCBufMSP432_SMCLK_CLOCK = ADC_CLOCKSOURCE_SMCLK,
   ADCBufMSP432_HSMCLK_CLOCK = ADC_CLOCKSOURCE_HSMCLK
}ADCBufMSP432_ClockSource;

typedef enum ADCBufMSP432_TriggerSource {
    ADCBufMSP432_TIMER_TRIGGER = ADC_MANUAL_ITERATION,
    ADCBufMSP432_SOFTWARE_AUTOMATIC_TRIGGER = ADC_AUTOMATIC_ITERATION,
}ADCBufMSP432_TriggerSource;

typedef enum ADCBufMSP432_DifferentialMode {
    ADCBufMSP432_SINGLE_ENDED = ADC_NONDIFFERENTIAL_INPUTS,
    ADCBufMSP432_DIFFERENTIAL = ADC_DIFFERENTIAL_INPUTS
}ADCBufMSP432_DifferentialMode;

typedef enum ADCBufMSP432_InternalSourceMode {
    ADCBufMSP432_INTERNAL_SOURCE_MODE_OFF = 0,
    ADCBufMSP432_TEMPERATURE_MODE = ADC_TEMPSENSEMAP,
    ADCBufMSP432_BATTERY_MONITOR_MODE = ADC_BATTMAP
} ADCBufMSP432_InternalSourceMode;

typedef struct ADCBufMSP432_ParamsExtension{
    ADCBufMSP432_SamplingDuration samplingDuration;   
} ADCBufMSP432_ParamsExtension;

typedef struct ADCBufMSP432_Channels {
    uint_fast16_t  adcPin;                             
    ADCBufMSP432_ReferenceSource refSource;            
    uint32_t refVoltage;                               
    ADCBufMSP432_DifferentialMode adcInputMode;        
    uint_fast16_t adcDifferentialPin;                  
    ADCBufMSP432_InternalSourceMode adcInternalSource; 
} ADCBufMSP432_Channels;

typedef struct ADCBufMSP432_HWAttrs {
    uint32_t intPriority;                 
    ADCBufMSP432_Channels *channelSetting; 
    ADCBufMSP432_TimerReferenceSource adcTimerTriggerSource;    
    uint8_t useDMA; 
    uint8_t dmaIntNum;          
    ADCBufMSP432_TriggerSource adcTriggerSource; 
    uint32_t timerDutyCycle; 
    ADCBufMSP432_ClockSource clockSource;    
} ADCBufMSP432_HWAttrs;

typedef struct ADCBufMSP432_Object {
    SemaphoreP_Handle convertComplete;      /* Notify finished ADC convert */
    HwiP_Handle       hwiHandle;            /* Hardware interrupt handle */

    uint_fast8_t        pingpongFlag;          /* PingPong flag indicates which sample buffer is active in the conversion */
    uint_fast8_t        channelCount;          /* Count of sampling channels */
    ADCBuf_Conversion   *conversions;          /* Ptr to ADC conversion struct array passed by user */
    ADCBuf_Callback     callBackFxn;           /* Callback function pointer */
    uint_fast16_t       *intlResultBuf;        /* Internal result buffer */

    uint16_t            *conversionSampleBuf;       /* Ptr to current active sampling buffer */
    uint_fast16_t        conversionSampleIdx;        /* Internal dec. conversion buffer counter */
    uint_fast16_t        conversionSampleCount;      /* Total sampling count per channel */

    uint32_t                        semaphoreTimeout;           
    uint32_t                        samplingFrequency;          
    ADCBuf_Recurrence_Mode          recurrenceMode;             
    ADCBuf_Return_Mode              returnMode;                 
    ADCBufMSP432_SamplingDuration  samplingDuration;           
    uint32_t             timerAddr;            /* Timer base address for trigger source */

    bool                 isOpen;               /* To determine if the ADC is open */
    uint32_t             internalSourceMask;        /* Channel mask used to initialize and track which internal sources are being used */
    uint32_t             tempCal30;                 /*Temperature calibration for 30C*/
    uint32_t             tempCal85;                 /*Temperature calibration for 80C*/
    float                tempCalDifference;         /*Temperature calibration conversion constant*/
    UDMAMSP432_Handle    dmaHandle;                 /* DMA interrupt handle */
    UDMAMSP432_PingPongTransfer    pingpongDMATransfer;           /* Struct holding params for DMA ping pong transfers */
    UDMAMSP432_Transfer    dmaTransfer;           /* Struct holding params for DMA transfers */
} ADCBufMSP432_Object;

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_adc_ADCBufMSP432__include */