hal_adc_sd24.h

Go to the documentation of this file.

<EMDC_COPYRIGHT>
//#############################################################################
//
<EMDC_DEVICE_NAME>
//#############################################################################

#ifndef HAL_ADC_H_
#define HAL_ADC_H_

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

//*****************************************************************************
// defines
//*****************************************************************************

#define HAL_ADC_CONV_INVALID_INDEX  0xFF
#define HAL_ADC_MAX_MOD_FREQ        2097152L
#define HAL_ADC_V_ARRAY_LENGTH      4
#define HAL_ADC_I_ARRAY_LENGTH      4

//******************************************************************************
// DO NOT MODIFY THESE DEFINES
//******************************************************************************
#define HAL_ADC_V_MASK              (HAL_ADC_V_ARRAY_LENGTH-1)
#define HAL_ADC_I_MASK              (HAL_ADC_I_ARRAY_LENGTH-1)

//*****************************************************************************
//
// The following are values are used as masks for the chReadStatus global
// variable to keep track of what channels have been read.
//
//*****************************************************************************
#define HAL_ADC_CH0_READ            (BIT0)
#define HAL_ADC_CH1_READ            (BIT1)
#define HAL_ADC_CH2_READ            (BIT2)
#define HAL_ADC_CH3_READ            (BIT3)

//*****************************************************************************
//
// The following are values that can be passed to the sampleFreq parameter
// for functions: HAL_ADC_init()
//
//*****************************************************************************
#define HAL_ADC_FREQ_4000_HZ        (4000)
#define HAL_ADC_FREQ_8000_HZ        (8000)
#define HAL_ADC_FREQ_16000_HZ       (16000)

//*****************************************************************************
//
// The following are values are used as mask for the phaseDataReady global
// variable to trigger the foreground process.
//
//*****************************************************************************
#define HAL_ADC_PHASE_NO_DATA_READY         0x00
#define HAL_ADC_PHASE_A_DATA_READY          0x01
#define HAL_ADC_PHASE_B_DATA_READY          0x02
#define HAL_ADC_PHASE_C_DATA_READY          0x04
#define HAL_ADC_PHASE_NEUTRAL_DATA_READY    0x40
#define HAL_ADC_PHASE_TOTAL_DATA_READY      0x80

//*****************************************************************************
//
// The following are values are oversample values used to calculate the
// preload initial value.
//
//*****************************************************************************
#define HAL_ADC_OSR_32                      (32-1)
#define HAL_ADC_OSR_64                      (64-1)
#define HAL_ADC_OSR_128                     (128-1)
#define HAL_ADC_OSR_256                     (256-1)

//*****************************************************************************
// typedefs
//*****************************************************************************

typedef enum _HAL_ADC_message_code_
{
    HAL_ADC_message_code_no_error=0,
    HAL_ADC_message_code_invalid_freq_error=1,
} HAL_ADC_message_code;

typedef struct _HAL_ADC_SD24_Channel_
{
    uint8_t gain;
    uint8_t preload;
    int32_t *samplePtr;
    uint8_t converter;
} HAL_ADC_SD24_Channel;

typedef struct _HAL_ADC_SD24_Configuration_
{
    uint16_t overSampleRatio;
    uint16_t sampleFreq;
    uint8_t referenceSelect;
    uint8_t masterConverter;
    HAL_ADC_SD24_Channel *adcChannelPtr;
    uint8_t adcChannelLength;
} HAL_ADC_SD24_Configuration;

//*****************************************************************************
// the function prototypes
//*****************************************************************************

//*****************************************************************************
//
//
//******************************************************************************
extern HAL_ADC_message_code HAL_ADC_init(HAL_ADC_SD24_Configuration *config);

extern void HAL_ADC_startConversion(HAL_ADC_SD24_Configuration *config);

extern void HAL_ADC_stopConversion(HAL_ADC_SD24_Configuration *config);

extern void HAL_ADC_enableInterrupt(HAL_ADC_SD24_Configuration *config);

extern void HAL_ADC_disableInterrupt(HAL_ADC_SD24_Configuration *config);

extern void HAL_ADC_printResult(HAL_ADC_SD24_Configuration *config);

extern void HAL_ADC_clearVariables(uint8_t phase);

//*****************************************************************************
// globals
//*****************************************************************************

extern volatile uint8_t phaseDataReady;

extern HAL_ADC_SD24_Configuration halAdcConfig;

//******************************************************************************
//
// Close the Doxygen group.
//
//******************************************************************************

#endif