ADC

Typedefs
typedef uint16_t	adcsample_t
	ADC sample data type.
typedef uint16_t	adc_channels_num_t
	Channels number in a conversion group.
typedef void(*	adcerrorcallback_t) (ADCDriver *adcp, adcerror_t err)
	ADC error callback type.

Enumerations
enum	adcerror_t { ADC_ERR_DMAFAILURE = 0 , ADC_ERR_OVERFLOW = 1 }
	Possible ADC failure causes. More...

Functions
static void	calibrate (ADCDriver *adcp)
static void	adc_lld_irq_handler (ADCDriver *adcp)
	ADC interrupt handler.
	OSAL_IRQ_HANDLER (KINETIS_ADC0_IRQ_VECTOR)
	OSAL_IRQ_HANDLER (KINETIS_ADC1_IRQ_VECTOR)
	OSAL_IRQ_HANDLER (KINETIS_ADC2_IRQ_VECTOR)
void	adc_lld_init (void)
	Low level ADC driver initialization.
void	adc_lld_start (ADCDriver *adcp)
	Configures and activates the ADC peripheral.
void	adc_lld_stop (ADCDriver *adcp)
	Deactivates the ADC peripheral.
void	adc_lld_start_conversion (ADCDriver *adcp)
	Starts an ADC conversion.
void	adc_lld_stop_conversion (ADCDriver *adcp)
	Stops an ongoing conversion.

Variables
ADCDriver	ADCD1
	ADC1 driver identifier.
ADCDriver	ADCD2
	ADC2 driver identifier.
ADCDriver	ADCD3
	ADC3 driver identifier.
uint32_t	channel_mask
	Bitmask of channels for ADC conversion.
uint32_t	cfg1
	ADC CFG1 register initialization data.
uint32_t	sc3
	ADC SC3 register initialization data.
ADCDriver	ADCD1
	ADC1 driver identifier.
ADCDriver	ADCD2
	ADC2 driver identifier.
ADCDriver	ADCD3
	ADC3 driver identifier.

Detailed Description

Typedef Documentation

adc_channels_num_t

typedef uint16_t adc_channels_num_t

Channels number in a conversion group.

Definition at line 195 of file hal_adc_lld.h.

adcerrorcallback_t

typedef void(* adcerrorcallback_t) (ADCDriver *adcp, adcerror_t err)

ADC error callback type.

Parameters

[in]	adcp	pointer to the ADCDriver object triggering the callback
[in]	err	ADC error code

Definition at line 214 of file hal_adc_lld.h.

adcsample_t

typedef uint16_t adcsample_t

ADC sample data type.

Definition at line 190 of file hal_adc_lld.h.

Enumeration Type Documentation

adcerror_t

enum adcerror_t

Possible ADC failure causes.

Note

Error codes are architecture dependent and should not relied upon.

Enumerator
ADC_ERR_DMAFAILURE	DMA operations failure.
ADC_ERR_OVERFLOW	ADC overflow condition.

Definition at line 202 of file hal_adc_lld.h.

             {
  ADC_ERR_DMAFAILURE = 0,                   /**< DMA operations failure.    */
  ADC_ERR_OVERFLOW = 1                      /**< ADC overflow condition.    */
} adcerror_t;

Function Documentation

adc_lld_init()

void adc_lld_init

(

void

)

Low level ADC driver initialization.

@notapi

Definition at line 195 of file hal_adc_lld.c.

                        {
 
#if KINETIS_ADC_USE_ADC0
  /* Driver initialization.*/
  adcObjectInit(&ADCD1);
  /* The shared vector is initialized on driver initialization and never
     disabled.*/
  nvicEnableVector(ADC0_IRQn, KINETIS_ADC_IRQ_PRIORITY);
#endif
 
#if KINETIS_ADC_USE_ADC1
  /* Driver initialization.*/
  adcObjectInit(&ADCD2);
  /* The shared vector is initialized on driver initialization and never
     disabled.*/
  nvicEnableVector(ADC1_IRQn, KINETIS_ADC_IRQ_PRIORITY);
#endif
 
#if KINETIS_ADC_USE_ADC2
  /* Driver initialization.*/
  adcObjectInit(&ADCD3);
  /* The shared vector is initialized on driver initialization and never
     disabled.*/
  nvicEnableVector(ADC2_IRQn, KINETIS_ADC_IRQ_PRIORITY);
#endif
 
}

adc_lld_irq_handler()

static void adc_lld_irq_handler ( ADCDriver *  adcp )

static

ADC interrupt handler.

@isr

Definition at line 106 of file hal_adc_lld.c.

                                                 {
#ifdef KE1xF
  /* Disable Interrupt, Disable Channel */
  adcp->adc12ChannelCfg.channelNumber = ADCx_SC1n_ADCH_DISABLED;
  adcp->adc12ChannelCfg.enableInterruptOnConversionCompleted = false;
  ADC12_SetChannelConfig(adcp->adc, adcp->channelGroup, &adcp->adc12ChannelCfg);
  /* Read the sample into the buffer */
  adcp->samples[adcp->current_index++] = ADC12_GetChannelConversionValue(adcp->adc, adcp->channelGroup);
#else
  /* Disable Interrupt, Disable Channel */
  adcp->adc->SC1A = ADCx_SC1n_ADCH(ADCx_SC1n_ADCH_DISABLED);
 
  /* Read the sample into the buffer */
  adcp->samples[adcp->current_index++] = adcp->adc->RA;
#endif /* KE1xF */
 
  bool more = true;
 
  /*  At the end of the buffer then we may be finished */
  if (adcp->current_index == adcp->number_of_samples) {
    /* We are never finished in circular mode */
    more = adcp->grpp->circular;
 
    _adc_isr_full_code(adcp);
 
    adcp->current_index = 0;
 
  }
 
  if (more) {
 
    /* Signal half completion in circular mode. */
    if (adcp->grpp->circular &&
        (adcp->current_index == (adcp->number_of_samples / 2))) {
 
        _adc_isr_half_code(adcp);
    }
 
#ifdef KE1xF
    adcp->current_channel = (adcp->current_channel + 1) % adcp->grpp->num_channels;
    adcp->adc12ChannelCfg.channelNumber = adcp->channelIndices[adcp->current_channel];
    adcp->adc12ChannelCfg.enableInterruptOnConversionCompleted = true;
    /* Enable Interrupt, Select the Channel */
    ADC12_SetChannelConfig(adcp->adc, adcp->channelGroup, &adcp->adc12ChannelCfg);
#else
    /* Skip to the next channel */
    do {
        adcp->current_channel = (adcp->current_channel + 1) & ADC_CHANNEL_MASK;
    } while (((1 << adcp->current_channel) & adcp->channel_mask) == 0);
 
    /* Enable Interrupt, Select the Channel */
    adcp->adc->SC1A = ADCx_SC1n_AIEN | ADCx_SC1n_ADCH(adcp->current_channel);
#endif /* KE1xF */
  }
}

Referenced by OSAL_IRQ_HANDLER(), OSAL_IRQ_HANDLER(), and OSAL_IRQ_HANDLER().

Here is the call graph for this function:

Here is the caller graph for this function:

adc_lld_start()

void adc_lld_start

(

ADCDriver *

adcp

)

Configures and activates the ADC peripheral.

Parameters

[in]

adcp

pointer to the ADCDriver object

@notapi

Definition at line 230 of file hal_adc_lld.c.

                                    {
 
  /* If in stopped state then enables the ADC clock.*/
  if (adcp->state == ADC_STOP) {
#if KINETIS_ADC_USE_ADC0
    if (&ADCD1 == adcp) {
#ifndef KE1xF
      SIM->SCGC6 |= SIM_SCGC6_ADC0;
#endif /* KE1xF */
      adcp->adc = ADC0;
    }
#endif /* KINETIS_ADC_USE_ADC0 */
 
#if KINETIS_ADC_USE_ADC1
    if (&ADCD2 == adcp) {
#ifndef KE1xF
      SIM->SCGC6 |= SIM_SCGC6_ADC1;
#endif /* KE1xF */
      adcp->adc = ADC1;
    }
#endif /* KINETIS_ADC_USE_ADC1 */
 
#if KINETIS_ADC_USE_ADC2
    if (&ADCD3 == adcp) {
#ifndef KE1xF
      SIM->SCGC6 |= SIM_SCGC6_ADC2;
#endif /* KE1xF */
      adcp->adc = ADC2;
    }
#endif /* KINETIS_ADC_USE_ADC2 */
  }
 
#ifdef KE1xF
  adcp->channelGroup = 0;   // software-triggered
  adcp->adc12ChannelCfg.channelNumber = 0;      // we'll set it later, in adc_lld_start_conversion()
  adcp->adc12ChannelCfg.enableInterruptOnConversionCompleted = true;
 
  ADC12_GetDefaultConfig(&adcp->adc12Cfg);
  adcp->adc12Cfg.resolution = kADC12_Resolution12Bit;
  ADC12_Init(adcp->adc, &adcp->adc12Cfg);
#else
  adcp->channel_mask = adcp->grpp->channel_mask;
#endif /* KE1xF */
 
  if (adcp->config->calibrate) {
    calibrate(adcp);
  }
 
 
}

Here is the call graph for this function:

adc_lld_start_conversion()

void adc_lld_start_conversion

(

ADCDriver *

adcp

)

Starts an ADC conversion.

Parameters

[in]

adcp

pointer to the ADCDriver object

@notapi

Definition at line 309 of file hal_adc_lld.c.

                                               {
  const ADCConversionGroup *grpp = adcp->grpp;
 
#ifdef KE1xF
  // select first 16 channels
  int chn;
  adcp->channelIndices[0] = ADCx_SC1n_ADCH_DISABLED;
  for (chn = 0; chn < grpp->num_channels; chn++) {
    /*
    if (chn < 10 && ((grpp->smpr2 >> (chn * 3)) & 7) == 0) // ADC_SMPR1_SMP_ANx(n)
        continue;
    if (chn >= 10 && ((grpp->smpr1 >> ((chn - 10) * 3)) & 7) == 0) // ADC_SMPR1_SMP_ANx(n)
        continue;
    */
    if (chn < 6) {
      adcp->channelIndices[chn] = (grpp->sqr3 >> (chn * 5)) & 31;
    } else if (chn < 12) {
      adcp->channelIndices[chn] = (grpp->sqr2 >> ((chn - 6) * 5)) & 31;
    } else {
      adcp->channelIndices[chn] = (grpp->sqr1 >> ((chn - 12) * 5)) & 31;
    }
  }
 
  bool hw = (grpp->cr2 & ADC_CR2_SWSTART) ? false : true;
 
  ADC12_EnableHardwareTrigger(adcp->adc, hw); /* enable software trigger mode */
 
#else  
  /* Enable the Bandgap Buffer if channel mask includes BANDGAP */
  if (adcp->channel_mask & ADC_BANDGAP) {
    PMC->REGSC |= PMC_REGSC_BGBE;
  }
#endif /* KE1xF */
 
  adcp->number_of_samples = adcp->depth * grpp->num_channels;
  adcp->current_index = 0;
 
  /* Skip to the next channel */
  adcp->current_channel = 0;
#ifdef KE1xF
  adcp->adc12ChannelCfg.channelNumber = adcp->channelIndices[adcp->current_channel];
  adcp->adc12ChannelCfg.enableInterruptOnConversionCompleted = true;
  ADC12_SetChannelConfig(adcp->adc, adcp->channelGroup, &adcp->adc12ChannelCfg);
#else
  while (((1 << adcp->current_channel) & adcp->channel_mask) == 0) {
    adcp->current_channel = (adcp->current_channel + 1) & ADC_CHANNEL_MASK;
  }
 
  /* Set clock speed and conversion size */
  adcp->adc->CFG1 = grpp->cfg1;
 
  /* Set averaging */
  adcp->adc->SC3 = grpp->sc3;
 
  /* Enable Interrupt, Select Channel */
  adcp->adc->SC1A = ADCx_SC1n_AIEN | ADCx_SC1n_ADCH(adcp->current_channel);
#endif /* KE1xF */
}

Here is the call graph for this function:

adc_lld_stop()

void adc_lld_stop

(

ADCDriver *

adcp

)

Deactivates the ADC peripheral.

Parameters

[in]

adcp

pointer to the ADCDriver object

@notapi

Definition at line 288 of file hal_adc_lld.c.

                                   {
 
  /* If in ready state then disables the ADC clock.*/
  if (adcp->state == ADC_READY) {
#ifdef KE1xF
    ADC12_Deinit(adcp->adc);
#else
    SIM->SCGC6 &= ~SIM_SCGC6_ADC0;
    /* Disable Interrupt, Disable Channel */
    adcp->adc->SC1A = ADCx_SC1n_ADCH(ADCx_SC1n_ADCH_DISABLED);
#endif /* KE1xF */
  }
}

Here is the call graph for this function:

adc_lld_stop_conversion()

void adc_lld_stop_conversion

(

ADCDriver *

adcp

)

Stops an ongoing conversion.

Parameters

[in]

adcp

pointer to the ADCDriver object

@notapi

Definition at line 375 of file hal_adc_lld.c.

                                              {
#ifndef KE1xF
  const ADCConversionGroup *grpp = adcp->grpp;
  /* Disable the Bandgap buffer if channel mask includes BANDGAP */
  if (adcp->channel_mask & ADC_BANDGAP) {
    /* Clear BGBE, ACKISO is w1c, avoid setting */
    PMC->REGSC &= ~(PMC_REGSC_BGBE | PMC_REGSC_ACKISO);
  }
#endif /* KE1xF */
}

calibrate()

static void calibrate ( ADCDriver *  adcp )

static

Definition at line 65 of file hal_adc_lld.c.

                                       {
#ifdef KE1xF
    ADC12_DoAutoCalibration(adcp->adc);
#else
  /* Clock Divide by 8, Use Bus Clock Div 2 */
  /* At 48MHz this results in ADCCLK of 48/8/2 == 3MHz */
  adcp->adc->CFG1 = ADCx_CFG1_ADIV(ADCx_CFG1_ADIV_DIV_8) |
      ADCx_CFG1_ADICLK(ADCx_CFG1_ADIVCLK_BUS_CLOCK_DIV_2);
 
  /* Use software trigger and disable DMA etc. */
  adcp->adc->SC2 = 0;
 
  /* Enable Hardware Average, Average 32 Samples, Calibrate */
  adcp->adc->SC3 = ADCx_SC3_AVGE |
      ADCx_SC3_AVGS(ADCx_SC3_AVGS_AVERAGE_32_SAMPLES) |
      ADCx_SC3_CAL;
 
  /* FIXME: May take several ms. Use an interrupt instead of busy wait */
  /* Wait for calibration completion */
  while (!(adcp->adc->SC1A & ADCx_SC1n_COCO))
    ;
 
  uint16_t gain = ((adcp->adc->CLP0 + adcp->adc->CLP1 + adcp->adc->CLP2 +
      adcp->adc->CLP3 + adcp->adc->CLP4 + adcp->adc->CLPS) / 2) | 0x8000;
  adcp->adc->PG = gain;
 
  gain = ((adcp->adc->CLM0 + adcp->adc->CLM1 + adcp->adc->CLM2 +
      adcp->adc->CLM3 + adcp->adc->CLM4 + adcp->adc->CLMS) / 2) | 0x8000;
  adcp->adc->MG = gain;
#endif /* KE1xF */
}

Referenced by adc_lld_start().

Here is the call graph for this function:

Here is the caller graph for this function:

OSAL_IRQ_HANDLER() [1/3]

OSAL_IRQ_HANDLER

(

KINETIS_ADC0_IRQ_VECTOR

)

Definition at line 163 of file hal_adc_lld.c.

                                          {
  OSAL_IRQ_PROLOGUE();
  adc_lld_irq_handler(&ADCD1);
  OSAL_IRQ_EPILOGUE();
}

Here is the call graph for this function:

OSAL_IRQ_HANDLER() [2/3]

OSAL_IRQ_HANDLER

(

KINETIS_ADC1_IRQ_VECTOR

)

Definition at line 171 of file hal_adc_lld.c.

                                          {
  OSAL_IRQ_PROLOGUE();
  adc_lld_irq_handler(&ADCD2);
  OSAL_IRQ_EPILOGUE();
}

Here is the call graph for this function:

OSAL_IRQ_HANDLER() [3/3]

OSAL_IRQ_HANDLER

(

KINETIS_ADC2_IRQ_VECTOR

)

Definition at line 179 of file hal_adc_lld.c.

                                          {
  OSAL_IRQ_PROLOGUE();
  adc_lld_irq_handler(&ADCD3);
  OSAL_IRQ_EPILOGUE();
}

Here is the call graph for this function:

Variable Documentation

ADCD1 [1/2]

ADCDriver ADCD1

ADC1 driver identifier.

Definition at line 44 of file hal_adc_lld.c.

Referenced by adc_lld_init(), adc_lld_start(), getMcuTemperature(), OSAL_IRQ_HANDLER(), portInitAdc(), readBatch(), and readSlowAnalogInputs().

ADCD1 [2/2]

ADCDriver ADCD1

extern

ADC1 driver identifier.

Definition at line 44 of file hal_adc_lld.c.

Referenced by adc_lld_init(), adc_lld_start(), getMcuTemperature(), OSAL_IRQ_HANDLER(), portInitAdc(), readBatch(), and readSlowAnalogInputs().

ADCD2 [1/2]

ADCDriver ADCD2

ADC2 driver identifier.

Definition at line 49 of file hal_adc_lld.c.

Referenced by adc_lld_init(), adc_lld_start(), OSAL_IRQ_HANDLER(), and portInitAdc().

ADCD2 [2/2]

ADCDriver ADCD2

extern

ADC2 driver identifier.

Definition at line 49 of file hal_adc_lld.c.

Referenced by adc_lld_init(), adc_lld_start(), OSAL_IRQ_HANDLER(), and portInitAdc().

ADCD3 [1/2]

ADCDriver ADCD3

ADC3 driver identifier.

Definition at line 54 of file hal_adc_lld.c.

Referenced by adc_lld_init(), adc_lld_start(), initTriggerScope(), OSAL_IRQ_HANDLER(), and portInitAdc().

ADCD3 [2/2]

ADCDriver ADCD3

extern

ADC3 driver identifier.

Definition at line 54 of file hal_adc_lld.c.

Referenced by adc_lld_init(), adc_lld_start(), initTriggerScope(), OSAL_IRQ_HANDLER(), and portInitAdc().

cfg1

uint32_t cfg1

ADC CFG1 register initialization data.

Note

All the required bits must be defined into this field.

Definition at line 264 of file hal_adc_lld.h.

channel_mask

uint32_t channel_mask

Bitmask of channels for ADC conversion.

Definition at line 259 of file hal_adc_lld.h.

sc3

uint32_t sc3

ADC SC3 register initialization data.

Note

All the required bits must be defined into this field.

Definition at line 269 of file hal_adc_lld.h.