forked from pedvide/ADC
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathADC_Module.cpp
1268 lines (992 loc) · 39.5 KB
/
ADC_Module.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* Teensy 3.x, LC ADC library
* https://github.com/pedvide/ADC
* Copyright (c) 2016 Pedro Villanueva
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
/* ADC_Module.cpp: Implements the fuctions of a Teensy 3.x, LC ADC module
*
*/
#include "ADC_Module.h"
//#include "ADC.h"
// include the internal reference
#include "VREF.h"
/* Constructor
* Point the registers to the correct ADC module
* Copy the correct channel2sc1a
* Call init
* The very long initializer list could be shorter using some kind of struct?
*/
ADC_Module::ADC_Module(uint8_t ADC_number, const uint8_t* const a_channel2sc1a, const ADC_NLIST* const a_diff_table) :
ADC_num(ADC_number)
, channel2sc1a(a_channel2sc1a)
, diff_table(a_diff_table)
, ADC_SC1A(ADC_num? ADC1_SC1A : ADC0_SC1A)
, ADC_SC1B(ADC_num? ADC1_SC1B : ADC0_SC1B)
, ADC_CFG1(ADC_num? ADC1_CFG1 : ADC0_CFG1)
, ADC_CFG2(ADC_num? ADC1_CFG2 : ADC0_CFG2)
, ADC_RA(ADC_num? ADC1_RA : ADC0_RA)
, ADC_RB(ADC_num? ADC1_RB : ADC0_RB)
, ADC_CV1(ADC_num? ADC1_CV1 : ADC0_CV1)
, ADC_CV2(ADC_num? ADC1_CV2 : ADC0_CV2)
, ADC_SC2(ADC_num? ADC1_SC2 : ADC0_SC2)
, ADC_SC3(ADC_num? ADC1_SC3 : ADC0_SC3)
, ADC_PGA(ADC_num? ADC1_PGA : ADC0_PGA)
, ADC_OFS(ADC_num? ADC1_OFS : ADC0_OFS)
, ADC_PG(ADC_num? ADC1_PG : ADC0_PG)
, ADC_MG(ADC_num? ADC1_MG : ADC0_MG)
, ADC_CLPD(ADC_num? ADC1_CLPD : ADC0_CLPD)
, ADC_CLPS(ADC_num? ADC1_CLPS : ADC0_CLPS)
, ADC_CLP4(ADC_num? ADC1_CLP4 : ADC0_CLP4)
, ADC_CLP3(ADC_num? ADC1_CLP3 : ADC0_CLP3)
, ADC_CLP2(ADC_num? ADC1_CLP2 : ADC0_CLP2)
, ADC_CLP1(ADC_num? ADC1_CLP1 : ADC0_CLP1)
, ADC_CLP0(ADC_num? ADC1_CLP0 : ADC0_CLP0)
, ADC_CLMD(ADC_num? ADC1_CLMD : ADC0_CLMD)
, ADC_CLMS(ADC_num? ADC1_CLMS : ADC0_CLMS)
, ADC_CLM4(ADC_num? ADC1_CLM4 : ADC0_CLM4)
, ADC_CLM3(ADC_num? ADC1_CLM3 : ADC0_CLM3)
, ADC_CLM2(ADC_num? ADC1_CLM2 : ADC0_CLM2)
, ADC_CLM1(ADC_num? ADC1_CLM1 : ADC0_CLM1)
, ADC_CLM0(ADC_num? ADC1_CLM0 : ADC0_CLM0)
, PDB0_CHnC1(ADC_num? PDB0_CH1C1 : PDB0_CH0C1)
#if ADC_NUM_ADCS==2
// IRQ_ADC0 and IRQ_ADC1 aren't consecutive in Teensy 3.6
, IRQ_ADC(ADC_num? IRQ_ADC1 : IRQ_ADC0) // fix by SB, https://github.com/pedvide/ADC/issues/19
#else
, IRQ_ADC(IRQ_ADC0)
#endif
{
// call our init
analog_init();
}
/* Initialize stuff:
* - Clear all fail flags
* - Internal reference (default: external vcc)
* - Mux between a and b channels (b channels)
* - Calibrate with 32 averages and low speed
* - When first calibration is done it sets:
* - Resolution (default: 10 bits)
* - Conversion speed and sampling time (both set to medium speed)
* - Averaging (set to 4)
*/
void ADC_Module::analog_init() {
// default settings:
/*
- 10 bits resolution
- 4 averages
- vcc reference
- no interrupts
- pga gain=1
- conversion speed = medium
- sampling speed = medium
initiate to 0 (or 1) so the corresponding functions change it to the correct value
*/
analog_res_bits = 0;
analog_max_val = 0;
analog_num_average = 0;
analog_reference_internal = ADC_REF_SOURCE::REF_NONE;
pga_value = 1;
conversion_speed = ADC_CONVERSION_SPEED::VERY_HIGH_SPEED; // set to something different from line 139 so it gets changed there
sampling_speed = ADC_SAMPLING_SPEED::VERY_HIGH_SPEED;
calibrating = 0;
fail_flag = ADC_ERROR::CLEAR; // clear all errors
num_measurements = 0;
// select b channels
// ADC_CFG2_muxsel = 1;
atomic::setBitFlag(ADC_CFG2, ADC_CFG2_MUXSEL);
// set reference to vcc
setReference(ADC_REFERENCE::REF_3V3);
// set resolution to 10
setResolution(10);
// the first calibration will use 32 averages and lowest speed,
// when this calibration is over the averages and speed will be set to default by wait_for_cal and init_calib will be cleared.
init_calib = 1;
setAveraging(32);
setConversionSpeed(ADC_CONVERSION_SPEED::LOW_SPEED);
setSamplingSpeed(ADC_SAMPLING_SPEED::LOW_SPEED);
// begin init calibration
calibrate();
}
// starts calibration
void ADC_Module::calibrate() {
__disable_irq();
calibrating = 1;
// ADC_SC3_cal = 0; // stop possible previous calibration
atomic::clearBitFlag(ADC_SC3, ADC_SC3_CAL);
// ADC_SC3_calf = 1; // clear possible previous error
atomic::setBitFlag(ADC_SC3, ADC_SC3_CALF);
// ADC_SC3_cal = 1; // start calibration
atomic::setBitFlag(ADC_SC3, ADC_SC3_CAL);
__enable_irq();
}
/* Waits until calibration is finished and writes the corresponding registers
*
*/
void ADC_Module::wait_for_cal(void) {
uint16_t sum;
while(atomic::getBitFlag(ADC_SC3, ADC_SC3_CAL)) { // Bit ADC_SC3_CAL in register ADC0_SC3 cleared when calib. finishes.
yield();
}
if(atomic::getBitFlag(ADC_SC3, ADC_SC3_CALF)) { // calibration failed
fail_flag |= ADC_ERROR::CALIB; // the user should know and recalibrate manually
}
__disable_irq();
if (calibrating) {
sum = ADC_CLPS + ADC_CLP4 + ADC_CLP3 + ADC_CLP2 + ADC_CLP1 + ADC_CLP0;
sum = (sum / 2) | 0x8000;
ADC_PG = sum;
sum = ADC_CLMS + ADC_CLM4 + ADC_CLM3 + ADC_CLM2 + ADC_CLM1 + ADC_CLM0;
sum = (sum / 2) | 0x8000;
ADC_MG = sum;
calibrating = 0;
}
__enable_irq();
// the first calibration uses 32 averages and lowest speed,
// when this calibration is over, set the averages and speed to default.
if(init_calib) {
// set conversion speed to medium
setConversionSpeed(ADC_CONVERSION_SPEED::MED_SPEED);
// set sampling speed to medium
setSamplingSpeed(ADC_SAMPLING_SPEED::MED_SPEED);
// number of averages to 4
setAveraging(4);
init_calib = 0; // clear
}
}
//! Starts the calibration sequence, waits until it's done and writes the results
/** Usually it's not necessary to call this function directly, but do it if the "environment" changed
* significantly since the program was started.
*/
void ADC_Module::recalibrate() {
calibrate();
wait_for_cal();
}
/////////////// METHODS TO SET/GET SETTINGS OF THE ADC ////////////////////
/* Set the voltage reference you prefer, default is 3.3V
* It needs to recalibrate
* Use ADC_REF_3V3, ADC_REF_1V2 (not for Teensy LC) or ADC_REF_EXT
*/
void ADC_Module::setReference(ADC_REFERENCE type) {
ADC_REF_SOURCE ref_type = static_cast<ADC_REF_SOURCE>(type); // cast to source type, that is, either internal or default
if (analog_reference_internal==ref_type) { // don't need to change anything
return;
}
if (ref_type == ADC_REF_SOURCE::REF_ALT) { // 1.2V ref for Teensy 3.x, 3.3 VDD for Teensy LC
// internal reference requested
#if ADC_USE_INTERNAL_VREF
VREF::start(); // enable VREF if Teensy 3.x
#endif
analog_reference_internal = ADC_REF_SOURCE::REF_ALT;
// *ADC_SC2_ref = 1; // uses bitband: atomic
atomic::setBitFlag(ADC_SC2, ADC_SC2_REFSEL(1));
} else if(ref_type == ADC_REF_SOURCE::REF_DEFAULT) { // ext ref for all Teensys, vcc also for Teensy 3.x
// vcc or external reference requested
#if ADC_USE_INTERNAL_VREF
VREF::stop(); // disable 1.2V reference source when using the external ref (p. 102, 3.7.1.7)
#endif
analog_reference_internal = ADC_REF_SOURCE::REF_DEFAULT;
// *ADC_SC2_ref = 0; // uses bitband: atomic
atomic::clearBitFlag(ADC_SC2, ADC_SC2_REFSEL(1));
}
calibrate();
}
/* Change the resolution of the measurement
* For single-ended measurements: 8, 10, 12 or 16 bits.
* For differential measurements: 9, 11, 13 or 16 bits.
* If you want something in between (11 bits single-ended for example) select the inmediate higher
* and shift the result one to the right.
*
* It doesn't recalibrate
*/
void ADC_Module::setResolution(uint8_t bits) {
if(analog_res_bits==bits) {
return;
}
uint8_t config;
if (calibrating) wait_for_cal();
if (bits <= 9) {
config = 8;
} else if (bits <= 11) {
config = 10;
} else if (bits <= 13) {
config = 12;
} else if (bits > 13) {
config = 16;
} else {
config = 8; // default to 8 bits
}
// conversion resolution
// single-ended 8 bits is the same as differential 9 bits, etc.
if ( (config == 8) || (config == 9) ) {
// *ADC_CFG1_mode1 = 0;
// *ADC_CFG1_mode0 = 0;
atomic::clearBitFlag(ADC_CFG1, ADC_CFG1_MODE(3));
analog_max_val = 255; // diff mode 9 bits has 1 bit for sign, so max value is the same as single 8 bits
} else if ( (config == 10 )|| (config == 11) ) {
// *ADC_CFG1_mode1 = 1;
// *ADC_CFG1_mode0 = 0;
atomic::changeBitFlag(ADC_CFG1, ADC_CFG1_MODE(3), ADC_CFG1_MODE(2));
analog_max_val = 1023;
} else if ( (config == 12 )|| (config == 13) ) {
// *ADC_CFG1_mode1 = 0;
// *ADC_CFG1_mode0 = 1;
atomic::changeBitFlag(ADC_CFG1, ADC_CFG1_MODE(3), ADC_CFG1_MODE(1));
analog_max_val = 4095;
} else {
// *ADC_CFG1_mode1 = 1;
// *ADC_CFG1_mode0 = 1;
atomic::setBitFlag(ADC_CFG1, ADC_CFG1_MODE(3));
analog_max_val = 65535;
}
analog_res_bits = config;
// no recalibration is needed when changing the resolution, p. 619
}
/* Returns the resolution of the ADC
*
*/
uint8_t ADC_Module::getResolution() {
return analog_res_bits;
}
/* Returns the maximum value for a measurement, that is: 2^resolution-1
*
*/
uint32_t ADC_Module::getMaxValue() {
return analog_max_val;
}
// Sets the conversion speed
/* Increase the sampling speed for low impedance sources, decrease it for higher impedance ones.
* \param speed can be any of the ADC_SAMPLING_SPEED enum: VERY_LOW_SPEED, LOW_SPEED, MED_SPEED, HIGH_SPEED or VERY_HIGH_SPEED.
*
* VERY_LOW_SPEED is the lowest possible sampling speed (+24 ADCK).
* LOW_SPEED adds +16 ADCK.
* MED_SPEED adds +10 ADCK.
* HIGH_SPEED adds +6 ADCK.
* VERY_HIGH_SPEED is the highest possible sampling speed (0 ADCK added).
*/
void ADC_Module::setConversionSpeed(ADC_CONVERSION_SPEED speed) {
if(speed==conversion_speed) { // no change
return;
}
if (calibrating) wait_for_cal();
// internal asynchronous clock settings: fADK = 2.4, 4.0, 5.2 or 6.2 MHz
if( (speed == ADC_CONVERSION_SPEED::ADACK_2_4) ||
(speed == ADC_CONVERSION_SPEED::ADACK_4_0) ||
(speed == ADC_CONVERSION_SPEED::ADACK_5_2) ||
(speed == ADC_CONVERSION_SPEED::ADACK_6_2)) {
atomic::setBitFlag(ADC_CFG2, ADC_CFG2_ADACKEN); // enable ADACK (takes max 5us to be ready)
atomic::setBitFlag(ADC_CFG1, ADC_CFG1_ADICLK(3)); // select ADACK as clock source
atomic::clearBitFlag(ADC_CFG1, ADC_CFG1_ADIV(3)); // select no dividers
if(speed == ADC_CONVERSION_SPEED::ADACK_2_4) {
atomic::clearBitFlag(ADC_CFG2, ADC_CFG2_ADHSC);
atomic::setBitFlag(ADC_CFG1, ADC_CFG1_ADLPC);
} else if(speed == ADC_CONVERSION_SPEED::ADACK_4_0) {
atomic::setBitFlag(ADC_CFG2, ADC_CFG2_ADHSC);
atomic::setBitFlag(ADC_CFG1, ADC_CFG1_ADLPC);
} else if(speed == ADC_CONVERSION_SPEED::ADACK_5_2) {
atomic::clearBitFlag(ADC_CFG2, ADC_CFG2_ADHSC);
atomic::clearBitFlag(ADC_CFG1, ADC_CFG1_ADLPC);
} else if(speed == ADC_CONVERSION_SPEED::ADACK_6_2) {
atomic::setBitFlag(ADC_CFG2, ADC_CFG2_ADHSC);
atomic::clearBitFlag(ADC_CFG1, ADC_CFG1_ADLPC);
}
conversion_speed = speed;
return;
}
// normal bus clock used
// *ADC_CFG2_adacken = 0; // disable the internal asynchronous clock
atomic::clearBitFlag(ADC_CFG2, ADC_CFG2_ADACKEN);
uint32_t ADC_CFG1_speed; // store the clock and divisor
if(speed == ADC_CONVERSION_SPEED::VERY_LOW_SPEED) {
// *ADC_CFG2_adhsc = 0; // no high-speed config
// *ADC_CFG1_adlpc = 1; // use low power conf.
atomic::clearBitFlag(ADC_CFG2, ADC_CFG2_ADHSC);
atomic::setBitFlag(ADC_CFG1, ADC_CFG1_ADLPC);
ADC_CFG1_speed = ADC_CFG1_VERY_LOW_SPEED;
} else if(speed == ADC_CONVERSION_SPEED::LOW_SPEED) {
// *ADC_CFG2_adhsc = 0; // no high-speed config
// *ADC_CFG1_adlpc = 1; // use low power conf.
atomic::clearBitFlag(ADC_CFG2, ADC_CFG2_ADHSC);
atomic::setBitFlag(ADC_CFG1, ADC_CFG1_ADLPC);
ADC_CFG1_speed = ADC_CFG1_LOW_SPEED;
} else if(speed == ADC_CONVERSION_SPEED::MED_SPEED) {
// *ADC_CFG2_adhsc = 0; // no high-speed config
// *ADC_CFG1_adlpc = 0; // no low power conf.
atomic::clearBitFlag(ADC_CFG2, ADC_CFG2_ADHSC);
atomic::clearBitFlag(ADC_CFG1, ADC_CFG1_ADLPC);
ADC_CFG1_speed = ADC_CFG1_MED_SPEED;
} else if(speed == ADC_CONVERSION_SPEED::HIGH_SPEED_16BITS) {
// *ADC_CFG2_adhsc = 1; // high-speed config: add 2 ADCK
// *ADC_CFG1_adlpc = 0; // no low power conf.
atomic::setBitFlag(ADC_CFG2, ADC_CFG2_ADHSC);
atomic::clearBitFlag(ADC_CFG1, ADC_CFG1_ADLPC);
ADC_CFG1_speed = ADC_CFG1_HI_SPEED_16_BITS;
} else if(speed == ADC_CONVERSION_SPEED::HIGH_SPEED) {
// *ADC_CFG2_adhsc = 1; // high-speed config: add 2 ADCK
// *ADC_CFG1_adlpc = 0; // no low power conf.
atomic::setBitFlag(ADC_CFG2, ADC_CFG2_ADHSC);
atomic::clearBitFlag(ADC_CFG1, ADC_CFG1_ADLPC);
ADC_CFG1_speed = ADC_CFG1_HI_SPEED;
} else if(speed == ADC_CONVERSION_SPEED::VERY_HIGH_SPEED) { // this speed is most likely out of specs, so accuracy can be bad
// *ADC_CFG2_adhsc = 1; // high-speed config: add 2 ADCK
// *ADC_CFG1_adlpc = 0; // no low power conf.
atomic::setBitFlag(ADC_CFG2, ADC_CFG2_ADHSC);
atomic::clearBitFlag(ADC_CFG1, ADC_CFG1_ADLPC);
ADC_CFG1_speed = ADC_CFG1_VERY_HIGH_SPEED;
} else {
fail_flag |= ADC_ERROR::OTHER;
return;
}
// clock source is bus or bus/2
atomic::changeBitFlag(ADC_CFG1, ADC_CFG1_ADICLK(3), ADC_CFG1_speed & ADC_CFG1_ADICLK(3));
// divisor for the clock source: 1, 2, 4 or 8.
// so total speed can be: bus, bus/2, bus/4, bus/8 or bus/16.
atomic::changeBitFlag(ADC_CFG1, ADC_CFG1_ADIV(3), ADC_CFG1_speed & ADC_CFG1_ADIV(3));
conversion_speed = speed;
}
// Sets the sampling speed
/* Increase the sampling speed for low impedance sources, decrease it for higher impedance ones.
* \param speed can be any of the ADC_SAMPLING_SPEED enum: VERY_LOW_SPEED, LOW_SPEED, MED_SPEED, HIGH_SPEED or VERY_HIGH_SPEED.
*
* VERY_LOW_SPEED is the lowest possible sampling speed (+24 ADCK).
* LOW_SPEED adds +16 ADCK.
* MED_SPEED adds +10 ADCK.
* HIGH_SPEED adds +6 ADCK.
* VERY_HIGH_SPEED is the highest possible sampling speed (0 ADCK added).
*/
void ADC_Module::setSamplingSpeed(ADC_SAMPLING_SPEED speed) {
if (calibrating) wait_for_cal();
switch(speed) {
case ADC_SAMPLING_SPEED::VERY_LOW_SPEED:
atomic::setBitFlag(ADC_CFG1, ADC_CFG1_ADLSMP); // long sampling time enable
atomic::clearBitFlag(ADC_CFG2, ADC_CFG2_ADLSTS(3)); // maximum sampling time (+24 ADCK)
break;
case ADC_SAMPLING_SPEED::LOW_SPEED:
atomic::setBitFlag(ADC_CFG1, ADC_CFG1_ADLSMP); // long sampling time enable
atomic::changeBitFlag(ADC_CFG2, ADC_CFG2_ADLSTS(3), ADC_CFG2_ADLSTS(1)); // high sampling time (+16 ADCK)
break;
case ADC_SAMPLING_SPEED::MED_SPEED:
atomic::setBitFlag(ADC_CFG1, ADC_CFG1_ADLSMP); // long sampling time enable
atomic::changeBitFlag(ADC_CFG2, ADC_CFG2_ADLSTS(3), ADC_CFG2_ADLSTS(2)); // medium sampling time (+10 ADCK)
break;
case ADC_SAMPLING_SPEED::HIGH_SPEED:
atomic::setBitFlag(ADC_CFG1, ADC_CFG1_ADLSMP); // long sampling time enable
atomic::setBitFlag(ADC_CFG2, ADC_CFG2_ADLSTS(3)); // low sampling time (+6 ADCK)
break;
case ADC_SAMPLING_SPEED::VERY_HIGH_SPEED:
atomic::clearBitFlag(ADC_CFG1, ADC_CFG1_ADLSMP); // shortest sampling time
break;
}
sampling_speed = speed;
}
/* Set the number of averages: 0, 4, 8, 16 or 32.
*
*/
void ADC_Module::setAveraging(uint8_t num) {
if (calibrating) wait_for_cal();
if (num <= 1) {
num = 0;
// ADC_SC3_avge = 0;
atomic::clearBitFlag(ADC_SC3, ADC_SC3_AVGE);
} else {
// ADC_SC3_avge = 1;
atomic::setBitFlag(ADC_SC3, ADC_SC3_AVGE);
if (num <= 4) {
num = 4;
// ADC_SC3_avgs0 = 0;
// ADC_SC3_avgs1 = 0;
atomic::clearBitFlag(ADC_SC3, ADC_SC3_AVGS(3));
} else if (num <= 8) {
num = 8;
// ADC_SC3_avgs0 = 1;
// ADC_SC3_avgs1 = 0;
atomic::changeBitFlag(ADC_SC3, ADC_SC3_AVGS(3), ADC_SC3_AVGS(1));
} else if (num <= 16) {
num = 16;
// ADC_SC3_avgs0 = 0;
// ADC_SC3_avgs1 = 1;
atomic::changeBitFlag(ADC_SC3, ADC_SC3_AVGS(3), ADC_SC3_AVGS(2));
} else {
num = 32;
// ADC_SC3_avgs0 = 1;
// ADC_SC3_avgs1 = 1;
atomic::setBitFlag(ADC_SC3, ADC_SC3_AVGS(3));
}
}
analog_num_average = num;
}
/* Enable interrupts: An ADC Interrupt will be raised when the conversion is completed
* (including hardware averages and if the comparison (if any) is true).
*/
void ADC_Module::enableInterrupts() {
if (calibrating) wait_for_cal();
// ADC_SC1A_aien = 1;
atomic::setBitFlag(ADC_SC1A, ADC_SC1_AIEN);
NVIC_ENABLE_IRQ(IRQ_ADC);
}
/* Disable interrupts
*
*/
void ADC_Module::disableInterrupts() {
// ADC_SC1A_aien = 0;
atomic::clearBitFlag(ADC_SC1A, ADC_SC1_AIEN);
NVIC_DISABLE_IRQ(IRQ_ADC);
}
/* Enable DMA request: An ADC DMA request will be raised when the conversion is completed
* (including hardware averages and if the comparison (if any) is true).
*/
void ADC_Module::enableDMA() {
if (calibrating) wait_for_cal();
// ADC_SC2_dma = 1;
atomic::setBitFlag(ADC_SC2, ADC_SC2_DMAEN);
}
/* Disable ADC DMA request
*
*/
void ADC_Module::disableDMA() {
// ADC_SC2_dma = 0;
atomic::clearBitFlag(ADC_SC2, ADC_SC2_DMAEN);
}
/* Enable the compare function: A conversion will be completed only when the ADC value
* is >= compValue (greaterThan=1) or < compValue (greaterThan=0)
* Call it after changing the resolution
* Use with interrupts or poll conversion completion with isADC_Complete()
*/
void ADC_Module::enableCompare(int16_t compValue, bool greaterThan) {
if (calibrating) wait_for_cal(); // if we modify the adc's registers when calibrating, it will fail
// ADC_SC2_cfe = 1; // enable compare
// ADC_SC2_cfgt = (int32_t)greaterThan; // greater or less than?
atomic::setBitFlag(ADC_SC2, ADC_SC2_ACFE);
atomic::changeBitFlag(ADC_SC2, ADC_SC2_ACFGT, ADC_SC2_ACFGT*greaterThan);
ADC_CV1 = (int16_t)compValue; // comp value
}
/* Enable the compare function: A conversion will be completed only when the ADC value
* is inside (insideRange=1) or outside (=0) the range given by (lowerLimit, upperLimit),
* including (inclusive=1) the limits or not (inclusive=0).
* See Table 31-78, p. 617 of the freescale manual.
* Call it after changing the resolution
*/
void ADC_Module::enableCompareRange(int16_t lowerLimit, int16_t upperLimit, bool insideRange, bool inclusive) {
if (calibrating) wait_for_cal(); // if we modify the adc's registers when calibrating, it will fail
// ADC_SC2_cfe = 1; // enable compare
// ADC_SC2_cren = 1; // enable compare range
atomic::setBitFlag(ADC_SC2, ADC_SC2_ACFE);
atomic::setBitFlag(ADC_SC2, ADC_SC2_ACREN);
if(insideRange && inclusive) { // True if value is inside the range, including the limits. CV1 <= CV2 and ACFGT=1
// ADC_SC2_cfgt = 1;
atomic::setBitFlag(ADC_SC2, ADC_SC2_ACFGT);
ADC_CV1 = (int16_t)lowerLimit;
ADC_CV2 = (int16_t)upperLimit;
} else if(insideRange && !inclusive) {// True if value is inside the range, excluding the limits. CV1 > CV2 and ACFGT=0
// ADC_SC2_cfgt = 0;
atomic::clearBitFlag(ADC_SC2, ADC_SC2_ACFGT);
ADC_CV2 = (int16_t)lowerLimit;
ADC_CV1 = (int16_t)upperLimit;
} else if(!insideRange && inclusive) { // True if value is outside of range or is equal to either limit. CV1 > CV2 and ACFGT=1
// ADC_SC2_cfgt = 1;
atomic::setBitFlag(ADC_SC2, ADC_SC2_ACFGT);
ADC_CV2 = (int16_t)lowerLimit;
ADC_CV1 = (int16_t)upperLimit;
} else if(!insideRange && !inclusive) { // True if value is outside of range and not equal to either limit. CV1 > CV2 and ACFGT=0
// ADC_SC2_cfgt = 0;
atomic::clearBitFlag(ADC_SC2, ADC_SC2_ACFGT);
ADC_CV1 = (int16_t)lowerLimit;
ADC_CV2 = (int16_t)upperLimit;
}
}
/* Disable the compare function
*
*/
void ADC_Module::disableCompare() {
// ADC_SC2_cfe = 0;
atomic::clearBitFlag(ADC_SC2, ADC_SC2_ACFE);
}
/* Enables the PGA and sets the gain
* Use only for signals lower than 1.2 V
* \param gain can be 1, 2, 4, 8, 16 32 or 64
*
*/
void ADC_Module::enablePGA(uint8_t gain) {
#if ADC_USE_PGA
if (calibrating) wait_for_cal();
uint8_t setting;
if(gain <= 1) {
setting = 0;
} else if(gain<=2) {
setting = 1;
} else if(gain<=4) {
setting = 2;
} else if(gain<=8) {
setting = 3;
} else if(gain<=16) {
setting = 4;
} else if(gain<=32) {
setting = 5;
} else { // 64
setting = 6;
}
ADC_PGA = ADC_PGA_PGAEN | ADC_PGA_PGAG(setting);
pga_value=1<<setting;
#endif
}
/* Returns the PGA level
* PGA level = from 0 to 64
*/
uint8_t ADC_Module::getPGA() {
return pga_value;
}
//! Disable PGA
void ADC_Module::disablePGA() {
#if ADC_USE_PGA
// ADC_PGA_pgaen = 0;
atomic::clearBitFlag(ADC_PGA, ADC_PGA_PGAEN);
#endif
pga_value = 1;
}
//////////////// INFORMATION ABOUT VALID PINS //////////////////
// check whether the pin is a valid analog pin
bool ADC_Module::checkPin(uint8_t pin) {
if(pin>ADC_MAX_PIN) {
return false; // all others are invalid
}
// translate pin number to SC1A number, that also contains MUX a or b info.
const uint8_t sc1a_pin = channel2sc1a[pin];
// check for valid pin
if( (sc1a_pin&ADC_SC1A_CHANNELS) == ADC_SC1A_PIN_INVALID ) {
return false; // all others are invalid
}
return true;
}
// check whether the pins are a valid analog differential pins (including PGA if enabled)
bool ADC_Module::checkDifferentialPins(uint8_t pinP, uint8_t pinN) {
if(pinP>ADC_MAX_PIN) {
return false; // all others are invalid
}
// translate pinP number to SC1A number, to make sure it's differential
uint8_t sc1a_pin = channel2sc1a[pinP];
if( !(sc1a_pin&ADC_SC1A_PIN_DIFF) ) {
return false; // all others are invalid
}
// get SC1A number, also whether it can do PGA
sc1a_pin = getDifferentialPair(pinP);
// the pair can't be measured with this ADC
if( (sc1a_pin&ADC_SC1A_CHANNELS) == ADC_SC1A_PIN_INVALID ) {
return false; // all others are invalid
}
#if ADC_USE_PGA
// check if PGA is enabled, and whether the pin has access to it in this ADC module
if( isPGAEnabled() && !(sc1a_pin&ADC_SC1A_PIN_PGA) ) {
return false;
}
#endif // ADC_USE_PGA
return true;
}
//////////////// HELPER METHODS FOR CONVERSION /////////////////
// Starts a single-ended conversion on the pin (sets the mux correctly)
// Doesn't do any of the checks on the pin
// It doesn't change the continuous conversion bit
void ADC_Module::startReadFast(uint8_t pin) {
// translate pin number to SC1A number, that also contains MUX a or b info.
const uint8_t sc1a_pin = channel2sc1a[pin];
if(sc1a_pin&ADC_SC1A_PIN_MUX) { // mux a
atomic::clearBitFlag(ADC_CFG2, ADC_CFG2_MUXSEL);
} else { // mux b
atomic::setBitFlag(ADC_CFG2, ADC_CFG2_MUXSEL);
}
// select pin for single-ended mode and start conversion, enable interrupts if requested
__disable_irq();
ADC_SC1A = (sc1a_pin&ADC_SC1A_CHANNELS) + atomic::getBitFlag(ADC_SC1A, ADC_SC1_AIEN)*ADC_SC1_AIEN;
__enable_irq();
}
// Starts a differential conversion on the pair of pins
// Doesn't do any of the checks on the pins
// It doesn't change the continuous conversion bit
void ADC_Module::startDifferentialFast(uint8_t pinP, uint8_t pinN) {
// get SC1A number
uint8_t sc1a_pin = getDifferentialPair(pinP);
#if ADC_USE_PGA
// check if PGA is enabled
if(isPGAEnabled()) {
sc1a_pin = 0x2; // PGA always uses DAD2
}
#endif // ADC_USE_PGA
__disable_irq();
ADC_SC1A = ADC_SC1_DIFF + (sc1a_pin&ADC_SC1A_CHANNELS) + atomic::getBitFlag(ADC_SC1A, ADC_SC1_AIEN)*ADC_SC1_AIEN;
__enable_irq();
}
//////////////// BLOCKING CONVERSION METHODS //////////////////
/*
This methods are implemented like this:
1. Check that the pin is correct
2. if calibrating, wait for it to finish before modifiying any ADC register
3. Check if we're interrupting a measurement, if so store the settings.
4. Disable continuous conversion mode and start the current measurement
5. Wait until it's done, and check whether the comparison (if any) was succesful.
6. Get the result.
7. If step 3. is true, restore the previous ADC settings
*/
/* Reads the analog value of the pin.
* It waits until the value is read and then returns the result.
* If a comparison has been set up and fails, it will return ADC_ERROR_VALUE.
* Set the resolution, number of averages and voltage reference using the appropriate functions.
*/
int ADC_Module::analogRead(uint8_t pin) {
//digitalWriteFast(LED_BUILTIN, HIGH);
// check whether the pin is correct
if(!checkPin(pin)) {
fail_flag |= ADC_ERROR::WRONG_PIN;
return ADC_ERROR_VALUE;
}
// increase the counter of measurements
num_measurements++;
//digitalWriteFast(LED_BUILTIN, !digitalReadFast(LED_BUILTIN));
if (calibrating) wait_for_cal();
//digitalWriteFast(LED_BUILTIN, !digitalReadFast(LED_BUILTIN));
// check if we are interrupting a measurement, store setting if so.
// vars to save the current state of the ADC in case it's in use
ADC_Config old_config = {0};
const uint8_t wasADCInUse = isConverting(); // is the ADC running now?
if(wasADCInUse) { // this means we're interrupting a conversion
// save the current conversion config, we don't want any other interrupts messing up the configs
__disable_irq();
//digitalWriteFast(LED_BUILTIN, !digitalReadFast(LED_BUILTIN) );
saveConfig(&old_config);
__enable_irq();
}
// no continuous mode
singleMode();
startReadFast(pin); // start single read
// wait for the ADC to finish
while(isConverting()) {
yield();
}
// it's done, check if the comparison (if any) was true
int32_t result;
__disable_irq(); // make sure nothing interrupts this part
if (isComplete()) { // conversion succeded
result = (uint16_t)ADC_RA;
} else { // comparison was false
fail_flag |= ADC_ERROR::COMPARISON;
result = ADC_ERROR_VALUE;
}
__enable_irq();
// if we interrupted a conversion, set it again
if (wasADCInUse) {
//digitalWriteFast(LED_BUILTIN, !digitalReadFast(LED_BUILTIN) );
__disable_irq();
loadConfig(&old_config);
__enable_irq();
}
num_measurements--;
return result;
} // analogRead
/* Reads the differential analog value of two pins (pinP - pinN)
* It waits until the value is read and then returns the result
* If a comparison has been set up and fails, it will return ADC_ERROR_DIFF_VALUE
* Set the resolution, number of averages and voltage reference using the appropriate functions
*/
int ADC_Module::analogReadDifferential(uint8_t pinP, uint8_t pinN) {
if(!checkDifferentialPins(pinP, pinN)) {
fail_flag |= ADC_ERROR::WRONG_PIN;
return ADC_ERROR_VALUE; // all others are invalid
}
// increase the counter of measurements
num_measurements++;
// check for calibration before setting channels,
// because conversion will start as soon as we write to ADC_SC1A
if (calibrating) wait_for_cal();
uint8_t res = getResolution();
// vars to saved the current state of the ADC in case it's in use
ADC_Config old_config = {0};
uint8_t wasADCInUse = isConverting(); // is the ADC running now?
if(wasADCInUse) { // this means we're interrupting a conversion
// save the current conversion config, we don't want any other interrupts messing up the configs
__disable_irq();
saveConfig(&old_config);
__enable_irq();
}
// no continuous mode
singleMode();
startDifferentialFast(pinP, pinN); // start conversion
// wait for the ADC to finish
while( isConverting() ) {
yield();
//digitalWriteFast(LED_BUILTIN, !digitalReadFast(LED_BUILTIN) );
}
// it's done, check if the comparison (if any) was true
int32_t result;
__disable_irq(); // make sure nothing interrupts this part
if (isComplete()) { // conversion succeded
result = (int16_t)(int32_t)ADC_RA; // cast to 32 bits
if(res==16) { // 16 bit differential is actually 15 bit + 1 bit sign
result *= 2; // multiply by 2 as if it were really 16 bits, so that getMaxValue gives a correct value.
}
} else { // comparison was false
result = ADC_ERROR_VALUE;
fail_flag |= ADC_ERROR::COMPARISON;
}
__enable_irq();
// if we interrupted a conversion, set it again
if (wasADCInUse) {
__disable_irq();
loadConfig(&old_config);
__enable_irq();
}
num_measurements--;
return result;
} // analogReadDifferential
/////////////// NON-BLOCKING CONVERSION METHODS //////////////
/*
This methods are implemented like this:
1. Check that the pin is correct
2. if calibrating, wait for it to finish before modifiying any ADC register
3. Check if we're interrupting a measurement, if so store the settings (in a member of the class, so it can be accessed).
4. Disable continuous conversion mode and start the current measurement
The fast methods only do step 4.
*/
/* Starts an analog measurement on the pin.
* It returns inmediately, read value with readSingle().
* If the pin is incorrect it returns false.
*/
bool ADC_Module::startSingleRead(uint8_t pin) {
// check whether the pin is correct
if(!checkPin(pin)) {
fail_flag |= ADC_ERROR::WRONG_PIN;
return false;
}
if (calibrating) wait_for_cal();
// save the current state of the ADC in case it's in use
adcWasInUse = isConverting(); // is the ADC running now?
if(adcWasInUse) { // this means we're interrupting a conversion
// save the current conversion config, the adc isr will restore the adc
__disable_irq();
saveConfig(&adc_config);
__enable_irq();
}
// no continuous mode
singleMode();