Class similar to AnalogIn that uses burst mode to run continious background conversions so when the input is read, the last value can immediatly be returned.

Dependents:   KL25Z_FFT_Demo test_armmath KL25Z_FFT_Demo_tony KL25Z_FFT_Demo_tony ... more

Supported devices

  • LPC1768
  • LPC4088
  • LPC11u24
  • KLxx
  • K20D50M

Introduction

When you read an AnalogIn object it will enable the corresponding ADC channel, depending on the implementation do either one or multiple measurements for more accuracy, and return that value to your program. This way the ADC is only active when it is required, and it is fairly straightforward. However the downside is, is that an ADC is relatively slow. On the LPC1768 it runs at 200kHz -> in that time it could also have done 500 instructions.

FastAnalogIn

This library uses the 'burst' feature of the microcontroller. This allows the ADC on the background to perform the AD conversions without requiring intervention from the microcontroller's core. Also there are no interrupts used, so also your time-sensitive code is not affected.

What the burst feature does is check which AD-channels are enabled, and he converts the enabled AD-channels one at a time. The result he stores in a register, where each channel has its own register. So this library checks which pins are used (you may make several FastAnalogIn objects, both for different pins and for the same pin, generally not extremely useful, but it is supported), and enables the relevant channels.

Reading a pin is done exactly the same for the user as AnalogIn, the read and read_us functions both work the same, and also the float operator is supported. However now it doesn't have to start a new conversion, so minus some overhead it can almost directly return the last measured value, no need to wait on the ADC!

Enable/Disable

FastAnalogIn has a few extra options that normal AnalogIn does not have: specifically you can either choose to have a FastAnalogIn object enabled or disabled. This is done with either the enable(bool enabled) and disable() functions, where enable(false) is equal to disable(), or by adding a second true/false argument to the constructor to either have it enabled at the beginning or disabled. By default it will be enabled.

LPC1768 & LPC4088
When a FastAnalogIn object is enabled, its corresponding ADC channel is also being scanned by the ADC and so it works as described above. When it is disabled you can still use the read functions, only now it will only enable the ADC channel for one conversion (actually two since for some reason the first conversion seems a bit weird), and when that conversion is done it will disable it again.

Since the ADC has to do the conversions one channel at a time, it becomes slower per channel if you enable many channels. For example, if you want to sample a sensor at a very high rate, and you also want to monitor your battery voltage. Then there is no reason to run an AD conversion on your battery continiously, so you can disable that channel and only run it once in a while.

KLxx
Multiple Fast instances can be declared of which only ONE can be continuous (all others must be non-continuous).
Example:

FastAnalogIn   speed(PTC2);           // Fast continuous
FastAnalogIn   temp1(PTC2, 0);        // Fast non-continuous.
FastAnalogIn   temp2(PTB3, 0);        // Fast non-continuous.

Downsides

Of course there are always downsides present. The extra power consumption probably won't be relevant for most, but still it is there. Aditionally there is no median filter like the normal AnalogIn has. Finally if you use AnalogIn you know exactly when the conversion happened, with FastAnalogIn you only know it was recently done but not exactly when.

AnalogIn + FastAnalogIn

Don't run both AnalogIn and FastAnalogIn objects in parallel as the results are unpredictable.
Both objects modify microcontroller registers, and neither of them bothers to inform the other one.
That's also the reason the disable() function was added.

Committer:
frankvnk
Date:
Sat Mar 08 15:44:57 2014 +0000
Revision:
2:9b61d0792927
Parent:
FastAnalogIn.cpp@1:575f4d2d6e9c
Child:
4:cd84739f7640
Added KLxx support

Who changed what in which revision?

UserRevisionLine numberNew contents of line
frankvnk 2:9b61d0792927 1 #ifdef TARGET_LPC1768
frankvnk 2:9b61d0792927 2
Sissors 0:c2a7b899e6c7 3 #include "FastAnalogIn.h"
Sissors 0:c2a7b899e6c7 4 static inline int div_round_up(int x, int y)
Sissors 0:c2a7b899e6c7 5 {
Sissors 0:c2a7b899e6c7 6 return (x + (y - 1)) / y;
Sissors 0:c2a7b899e6c7 7 }
Sissors 0:c2a7b899e6c7 8
frankvnk 2:9b61d0792927 9 static const PinMap PinMap_ADC[] = {
frankvnk 2:9b61d0792927 10 P0_23, ADC0_0, 1,
frankvnk 2:9b61d0792927 11 P0_24, ADC0_1, 1,
frankvnk 2:9b61d0792927 12 P0_25, ADC0_2, 1,
frankvnk 2:9b61d0792927 13 P0_26, ADC0_3, 1,
frankvnk 2:9b61d0792927 14 P1_30, ADC0_4, 3,
frankvnk 2:9b61d0792927 15 P1_31, ADC0_5, 3,
frankvnk 2:9b61d0792927 16 P0_2, ADC0_7, 2,
frankvnk 2:9b61d0792927 17 P0_3, ADC0_6, 2,
frankvnk 2:9b61d0792927 18 NC, NC, 0
Sissors 0:c2a7b899e6c7 19 };
Sissors 0:c2a7b899e6c7 20
Sissors 0:c2a7b899e6c7 21 FastAnalogIn::FastAnalogIn(PinName pin, bool enabled)
Sissors 0:c2a7b899e6c7 22 {
Sissors 0:c2a7b899e6c7 23 ADCnumber = (ADCName)pinmap_peripheral(pin, PinMap_ADC);
Sissors 0:c2a7b899e6c7 24 if (ADCnumber == (uint32_t)NC)
Sissors 0:c2a7b899e6c7 25 error("ADC pin mapping failed");
Sissors 0:c2a7b899e6c7 26 datareg = (uint32_t*) (&LPC_ADC->ADDR0 + ADCnumber);
Sissors 0:c2a7b899e6c7 27
Sissors 0:c2a7b899e6c7 28 // ensure power is turned on
Sissors 0:c2a7b899e6c7 29 LPC_SC->PCONP |= (1 << 12);
Sissors 0:c2a7b899e6c7 30 // set PCLK of ADC to /1
Sissors 0:c2a7b899e6c7 31 LPC_SC->PCLKSEL0 &= ~(0x3 << 24);
Sissors 0:c2a7b899e6c7 32 LPC_SC->PCLKSEL0 |= (0x1 << 24);
Sissors 0:c2a7b899e6c7 33 uint32_t PCLK = SystemCoreClock;
Sissors 0:c2a7b899e6c7 34
Sissors 0:c2a7b899e6c7 35 // calculate minimum clock divider
Sissors 0:c2a7b899e6c7 36 // clkdiv = divider - 1
Sissors 0:c2a7b899e6c7 37 uint32_t MAX_ADC_CLK = 13000000;
Sissors 0:c2a7b899e6c7 38 uint32_t clkdiv = div_round_up(PCLK, MAX_ADC_CLK) - 1;
Sissors 0:c2a7b899e6c7 39 // Set the clkdiv
Sissors 0:c2a7b899e6c7 40 LPC_ADC->ADCR &= ~(255<<8);
Sissors 0:c2a7b899e6c7 41 LPC_ADC->ADCR |= clkdiv<<8;
Sissors 0:c2a7b899e6c7 42
Sissors 0:c2a7b899e6c7 43 //Enable ADC:
Sissors 0:c2a7b899e6c7 44 LPC_ADC->ADCR |= 1<<21;
Sissors 0:c2a7b899e6c7 45
Sissors 0:c2a7b899e6c7 46 //Enable burstmode, set start as zero
Sissors 0:c2a7b899e6c7 47 LPC_ADC->ADCR |= 1<<16;
Sissors 0:c2a7b899e6c7 48 LPC_ADC->ADCR &= ~(7<<24);
Sissors 0:c2a7b899e6c7 49
Sissors 0:c2a7b899e6c7 50 //Map pins
Sissors 0:c2a7b899e6c7 51 pinmap_pinout(pin, PinMap_ADC);
Sissors 0:c2a7b899e6c7 52
Sissors 0:c2a7b899e6c7 53 //Enable channel
Sissors 0:c2a7b899e6c7 54 running = false;
Sissors 0:c2a7b899e6c7 55 enable(enabled);
Sissors 0:c2a7b899e6c7 56
Sissors 0:c2a7b899e6c7 57 }
Sissors 0:c2a7b899e6c7 58
Sissors 0:c2a7b899e6c7 59 void FastAnalogIn::enable(bool enabled)
Sissors 0:c2a7b899e6c7 60 {
Sissors 0:c2a7b899e6c7 61 //If currently not running
Sissors 0:c2a7b899e6c7 62 if (!running) {
Sissors 0:c2a7b899e6c7 63 if (enabled) {
Sissors 0:c2a7b899e6c7 64 //Enable the ADC channel
Sissors 0:c2a7b899e6c7 65 channel_usage[ADCnumber]++;
Sissors 0:c2a7b899e6c7 66 LPC_ADC->ADCR |= (1<<ADCnumber);
Sissors 0:c2a7b899e6c7 67 running = true;
Sissors 0:c2a7b899e6c7 68 } else
Sissors 0:c2a7b899e6c7 69 disable();
Sissors 0:c2a7b899e6c7 70 }
frankvnk 2:9b61d0792927 71 }
Sissors 0:c2a7b899e6c7 72
Sissors 0:c2a7b899e6c7 73 void FastAnalogIn::disable( void )
Sissors 0:c2a7b899e6c7 74 {
Sissors 0:c2a7b899e6c7 75 //If currently running
Sissors 0:c2a7b899e6c7 76 if (running) {
Sissors 0:c2a7b899e6c7 77 channel_usage[ADCnumber]--;
Sissors 0:c2a7b899e6c7 78
Sissors 0:c2a7b899e6c7 79 if (channel_usage[ADCnumber]==0)
Sissors 0:c2a7b899e6c7 80 LPC_ADC->ADCR &= ~(1<<ADCnumber);
Sissors 0:c2a7b899e6c7 81 }
Sissors 0:c2a7b899e6c7 82 running = false;
frankvnk 2:9b61d0792927 83 }
Sissors 0:c2a7b899e6c7 84
Sissors 0:c2a7b899e6c7 85 unsigned short FastAnalogIn::read_u16( void )
Sissors 0:c2a7b899e6c7 86 {
Sissors 1:575f4d2d6e9c 87 volatile unsigned int retval;
Sissors 0:c2a7b899e6c7 88 //If object is enabled return current value of datareg
Sissors 1:575f4d2d6e9c 89 if (running )
Sissors 1:575f4d2d6e9c 90 retval = *datareg;
Sissors 1:575f4d2d6e9c 91
Sissors 0:c2a7b899e6c7 92 //If it isn't running, enable it and wait until new value is written to datareg
Sissors 0:c2a7b899e6c7 93 else {
Sissors 0:c2a7b899e6c7 94 //Force a read to clear done bit, enable the ADC channel
Sissors 1:575f4d2d6e9c 95 retval = *datareg;
Sissors 0:c2a7b899e6c7 96 enable();
Sissors 0:c2a7b899e6c7 97 //Wait until it is converted
Sissors 0:c2a7b899e6c7 98 while(1) {
Sissors 0:c2a7b899e6c7 99 wait_us(1);
Sissors 0:c2a7b899e6c7 100 retval = *datareg;
Sissors 0:c2a7b899e6c7 101 if ((retval>>31) == 1)
Sissors 0:c2a7b899e6c7 102 break;
Sissors 0:c2a7b899e6c7 103 }
Sissors 0:c2a7b899e6c7 104
Sissors 0:c2a7b899e6c7 105 //Do a second conversion since first one always fails for some reason
Sissors 0:c2a7b899e6c7 106 while(1) {
Sissors 0:c2a7b899e6c7 107 wait_us(1);
Sissors 0:c2a7b899e6c7 108 retval = *datareg;
Sissors 0:c2a7b899e6c7 109 if ((retval>>31) == 1)
Sissors 0:c2a7b899e6c7 110 break;
Sissors 0:c2a7b899e6c7 111 }
Sissors 0:c2a7b899e6c7 112
Sissors 0:c2a7b899e6c7 113 //Disable again
Sissors 0:c2a7b899e6c7 114 disable();
Sissors 0:c2a7b899e6c7 115 }
Sissors 1:575f4d2d6e9c 116
Sissors 1:575f4d2d6e9c 117 //Do same thing as standard mbed lib, unused bit 0-3, replicate 4-7 in it
Sissors 1:575f4d2d6e9c 118 retval &= ~0xFFFF000F;
Sissors 1:575f4d2d6e9c 119 retval |= (retval >> 8) & 0x000F;
Sissors 1:575f4d2d6e9c 120 return retval;
Sissors 0:c2a7b899e6c7 121
Sissors 0:c2a7b899e6c7 122 }
frankvnk 2:9b61d0792927 123 #endif //defined TARGET_LPC1768