adc.c 24.2 KB
Newer Older
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
/*
 * This file is part of the Micro Python project, http://micropython.org/
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2013, 2014 Damien P. George
 *
 * 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.
 */

Dave Hylands's avatar
Dave Hylands committed
27
28
29
#include <stdio.h>
#include <string.h>

30
31
32
#include "py/nlr.h"
#include "py/runtime.h"
#include "py/binary.h"
33
#include "py/mphal.h"
Dave Hylands's avatar
Dave Hylands committed
34
35
#include "adc.h"
#include "pin.h"
36
#include "genhdr/pins.h"
37
#include "timer.h"
Dave Hylands's avatar
Dave Hylands committed
38

39
40
41
42
43
44
45
46
47
48
49
50
51
/// \moduleref pyb
/// \class ADC - analog to digital conversion: read analog values on a pin
///
/// Usage:
///
///     adc = pyb.ADC(pin)              # create an analog object from a pin
///     val = adc.read()                # read an analog value
///
///     adc = pyb.ADCAll(resolution)    # creale an ADCAll object
///     val = adc.read_channel(channel) # read the given channel
///     val = adc.read_core_temp()      # read MCU temperature
///     val = adc.read_core_vbat()      # read MCU VBAT
///     val = adc.read_core_vref()      # read MCU VREF
Dave Hylands's avatar
Dave Hylands committed
52
53
54
55
56

/* ADC defintions */
#define ADCx                    (ADC1)
#define ADCx_CLK_ENABLE         __ADC1_CLK_ENABLE
#define ADC_NUM_CHANNELS        (19)
57

58
59
60
61
62
#if defined(MCU_SERIES_F4)

#define ADC_FIRST_GPIO_CHANNEL  (0)
#define ADC_LAST_GPIO_CHANNEL   (15)
#define ADC_CAL_ADDRESS         (0x1fff7a2a)
63
64
#define ADC_CAL1                ((uint16_t*)(ADC_CAL_ADDRESS + 2))
#define ADC_CAL2                ((uint16_t*)(ADC_CAL_ADDRESS + 4))
65
66
67

#elif defined(MCU_SERIES_F7)

68
69
#define ADC_FIRST_GPIO_CHANNEL  (0)
#define ADC_LAST_GPIO_CHANNEL   (15)
70
#define ADC_CAL_ADDRESS         (0x1ff0f44a)
71
72
#define ADC_CAL1                ((uint16_t*)(ADC_CAL_ADDRESS + 2))
#define ADC_CAL2                ((uint16_t*)(ADC_CAL_ADDRESS + 4))
73

74
#elif defined(MCU_SERIES_L4)
75

76
77
#define ADC_FIRST_GPIO_CHANNEL  (1)
#define ADC_LAST_GPIO_CHANNEL   (16)
78
#define ADC_CAL_ADDRESS         (0x1fff75aa)
79
80
#define ADC_CAL1                ((uint16_t*)(ADC_CAL_ADDRESS - 2))
#define ADC_CAL2                ((uint16_t*)(ADC_CAL_ADDRESS + 0x20))
81

82
#else
83

84
#error Unsupported processor
85

86
#endif
Dave Hylands's avatar
Dave Hylands committed
87
88
89

#if defined(STM32F405xx) || defined(STM32F415xx) || \
    defined(STM32F407xx) || defined(STM32F417xx) || \
90
91
    defined(STM32F401xC) || defined(STM32F401xE) || \
    defined(STM32F411xE)
Dave Hylands's avatar
Dave Hylands committed
92
93
#define VBAT_DIV (2)
#elif defined(STM32F427xx) || defined(STM32F429xx) || \
94
      defined(STM32F437xx) || defined(STM32F439xx) || \
95
96
      defined(STM32F746xx) || defined(STM32F767xx) || \
      defined(STM32F769xx)
Dave Hylands's avatar
Dave Hylands committed
97
#define VBAT_DIV (4)
98
99
#elif defined(STM32L476xx)
#define VBAT_DIV (3)
100
101
#else
#error Unsupported processor
Dave Hylands's avatar
Dave Hylands committed
102
103
104
105
106
107
#endif

/* Core temperature sensor definitions */
#define CORE_TEMP_V25          (943)  /* (0.76v/3.3v)*(2^ADC resoultion) */
#define CORE_TEMP_AVG_SLOPE    (3)    /* (2.5mv/3.3v)*(2^ADC resoultion) */

108
109
110
111
// scale and calibration values for VBAT and VREF
#define ADC_SCALE (3.3f / 4095)
#define VREFIN_CAL ((uint16_t *)ADC_CAL_ADDRESS)

Dave Hylands's avatar
Dave Hylands committed
112
113
114
115
116
117
118
typedef struct _pyb_obj_adc_t {
    mp_obj_base_t base;
    mp_obj_t pin_name;
    int channel;
    ADC_HandleTypeDef handle;
} pyb_obj_adc_t;

119
120
121
122
123
124
125
126
127
128
129
130
// convert user-facing channel number into internal channel number
static inline uint32_t adc_get_internal_channel(uint32_t channel) {
    #if defined(MCU_SERIES_F4) || defined(MCU_SERIES_F7)
    // on F4 and F7 MCUs we want channel 16 to always be the TEMPSENSOR
    // (on some MCUs ADC_CHANNEL_TEMPSENSOR=16, on others it doesn't)
    if (channel == 16) {
        channel = ADC_CHANNEL_TEMPSENSOR;
    }
    #endif
    return channel;
}

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
STATIC bool is_adcx_channel(int channel) {
#if defined(MCU_SERIES_F4) || defined(MCU_SERIES_F7)
    return IS_ADC_CHANNEL(channel);
#elif defined(MCU_SERIES_L4)
    ADC_HandleTypeDef handle;
    handle.Instance = ADCx;
    return IS_ADC_CHANNEL(&handle, channel);
#else
    #error Unsupported processor
#endif
}

STATIC void adc_wait_for_eoc_or_timeout(int32_t timeout) {
    uint32_t tickstart = HAL_GetTick();
#if defined(MCU_SERIES_F4) || defined(MCU_SERIES_F7)
    while ((ADCx->SR & ADC_FLAG_EOC) != ADC_FLAG_EOC) {
#elif defined(MCU_SERIES_L4)
    while (READ_BIT(ADCx->ISR, ADC_FLAG_EOC) != ADC_FLAG_EOC) {
#else
    #error Unsupported processor
#endif
        if (((HAL_GetTick() - tickstart ) > timeout)) {
            break; // timeout
        }
    }
}

STATIC void adcx_clock_enable(void) {
#if defined(MCU_SERIES_F4) || defined(MCU_SERIES_F7)
    ADCx_CLK_ENABLE();
#elif defined(MCU_SERIES_L4)
    __HAL_RCC_ADC_CLK_ENABLE();
#else
    #error Unsupported processor
#endif
}

168
STATIC void adc_init_single(pyb_obj_adc_t *adc_obj) {
169
    if (!is_adcx_channel(adc_obj->channel)) {
Dave Hylands's avatar
Dave Hylands committed
170
171
172
        return;
    }

173
    if (ADC_FIRST_GPIO_CHANNEL <= adc_obj->channel && adc_obj->channel <= ADC_LAST_GPIO_CHANNEL) {
Dave Hylands's avatar
Dave Hylands committed
174
175
176
      // Channels 0-16 correspond to real pins. Configure the GPIO pin in
      // ADC mode.
      const pin_obj_t *pin = pin_adc1[adc_obj->channel];
177
      mp_hal_gpio_clock_enable(pin->gpio);
Dave Hylands's avatar
Dave Hylands committed
178
179
      GPIO_InitTypeDef GPIO_InitStructure;
      GPIO_InitStructure.Pin = pin->pin_mask;
180
#if defined(MCU_SERIES_F4) || defined(MCU_SERIES_F7)
Dave Hylands's avatar
Dave Hylands committed
181
      GPIO_InitStructure.Mode = GPIO_MODE_ANALOG;
182
183
184
185
186
#elif defined(MCU_SERIES_L4)
      GPIO_InitStructure.Mode = GPIO_MODE_ANALOG_ADC_CONTROL;
#else
    #error Unsupported processor
#endif
Dave Hylands's avatar
Dave Hylands committed
187
188
189
190
      GPIO_InitStructure.Pull = GPIO_NOPULL;
      HAL_GPIO_Init(pin->gpio, &GPIO_InitStructure);
    }

191
    adcx_clock_enable();
Dave Hylands's avatar
Dave Hylands committed
192
193
194
195
196
197
198
199
200
201

    ADC_HandleTypeDef *adcHandle = &adc_obj->handle;
    adcHandle->Instance                   = ADCx;
    adcHandle->Init.ContinuousConvMode    = DISABLE;
    adcHandle->Init.DiscontinuousConvMode = DISABLE;
    adcHandle->Init.NbrOfDiscConversion   = 0;
    adcHandle->Init.ExternalTrigConvEdge  = ADC_EXTERNALTRIGCONVEDGE_NONE;
    adcHandle->Init.DataAlign             = ADC_DATAALIGN_RIGHT;
    adcHandle->Init.NbrOfConversion       = 1;
    adcHandle->Init.DMAContinuousRequests = DISABLE;
202
    adcHandle->Init.Resolution            = ADC_RESOLUTION_12B;
203
#if defined(MCU_SERIES_F4) || defined(MCU_SERIES_F7)
204
    adcHandle->Init.ClockPrescaler        = ADC_CLOCK_SYNC_PCLK_DIV2;
205
206
    adcHandle->Init.ScanConvMode          = DISABLE;
    adcHandle->Init.ExternalTrigConv      = ADC_EXTERNALTRIGCONV_T1_CC1;
207
    adcHandle->Init.EOCSelection          = DISABLE;
208
#elif defined(MCU_SERIES_L4)
209
    adcHandle->Init.ClockPrescaler        = ADC_CLOCK_ASYNC_DIV1;
210
    adcHandle->Init.ScanConvMode          = ADC_SCAN_DISABLE;
211
212
213
    adcHandle->Init.EOCSelection          = ADC_EOC_SINGLE_CONV;
    adcHandle->Init.ExternalTrigConv      = ADC_SOFTWARE_START;
    adcHandle->Init.ExternalTrigConvEdge  = ADC_EXTERNALTRIGCONVEDGE_NONE;
214
215
216
217
218
219
    adcHandle->Init.LowPowerAutoWait      = DISABLE;
    adcHandle->Init.Overrun               = ADC_OVR_DATA_PRESERVED;
    adcHandle->Init.OversamplingMode      = DISABLE;
#else
    #error Unsupported processor
#endif
Dave Hylands's avatar
Dave Hylands committed
220
221

    HAL_ADC_Init(adcHandle);
222
223
224
225
226
227
228
229
230

#if defined(MCU_SERIES_L4)
    ADC_MultiModeTypeDef multimode;
    multimode.Mode = ADC_MODE_INDEPENDENT;
    if (HAL_ADCEx_MultiModeConfigChannel(adcHandle, &multimode) != HAL_OK)
    {
        nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_ValueError, "Can not set multimode on ADC1 channel: %d", adc_obj->channel));
    }
#endif
231
}
Dave Hylands's avatar
Dave Hylands committed
232

233
STATIC void adc_config_channel(ADC_HandleTypeDef *adc_handle, uint32_t channel) {
Dave Hylands's avatar
Dave Hylands committed
234
235
    ADC_ChannelConfTypeDef sConfig;

236
    sConfig.Channel = channel;
Dave Hylands's avatar
Dave Hylands committed
237
    sConfig.Rank = 1;
238
#if defined(MCU_SERIES_F4) || defined(MCU_SERIES_F7)
Dave Hylands's avatar
Dave Hylands committed
239
    sConfig.SamplingTime = ADC_SAMPLETIME_15CYCLES;
240
241
#elif defined(MCU_SERIES_L4)
    sConfig.SamplingTime = ADC_SAMPLETIME_12CYCLES_5;
242
243
    sConfig.SingleDiff = ADC_SINGLE_ENDED;
    sConfig.OffsetNumber = ADC_OFFSET_NONE;
244
245
246
#else
    #error Unsupported processor
#endif
Dave Hylands's avatar
Dave Hylands committed
247
248
    sConfig.Offset = 0;

249
    HAL_ADC_ConfigChannel(adc_handle, &sConfig);
Dave Hylands's avatar
Dave Hylands committed
250
251
}

252
STATIC uint32_t adc_read_channel(ADC_HandleTypeDef *adcHandle) {
Dave Hylands's avatar
Dave Hylands committed
253
254
255
    uint32_t rawValue = 0;

    HAL_ADC_Start(adcHandle);
256
257
    if (HAL_ADC_PollForConversion(adcHandle, 10) == HAL_OK
        && (HAL_ADC_GetState(adcHandle) & HAL_ADC_STATE_EOC_REG) == HAL_ADC_STATE_EOC_REG) {
Dave Hylands's avatar
Dave Hylands committed
258
259
260
261
262
263
264
265
266
267
        rawValue = HAL_ADC_GetValue(adcHandle);
    }
    HAL_ADC_Stop(adcHandle);

    return rawValue;
}

/******************************************************************************/
/* Micro Python bindings : adc object (single channel)                        */

268
STATIC void adc_print(const mp_print_t *print, mp_obj_t self_in, mp_print_kind_t kind) {
Dave Hylands's avatar
Dave Hylands committed
269
    pyb_obj_adc_t *self = self_in;
270
271
272
    mp_print_str(print, "<ADC on ");
    mp_obj_print_helper(print, self->pin_name, PRINT_STR);
    mp_printf(print, " channel=%lu>", self->channel);
Dave Hylands's avatar
Dave Hylands committed
273
274
}

275
276
277
/// \classmethod \constructor(pin)
/// Create an ADC object associated with the given pin.
/// This allows you to then read analog values on that pin.
278
STATIC mp_obj_t adc_make_new(const mp_obj_type_t *type, mp_uint_t n_args, mp_uint_t n_kw, const mp_obj_t *args) {
279
    // check number of arguments
Damien George's avatar
Damien George committed
280
    mp_arg_check_num(n_args, n_kw, 1, 1, false);
Dave Hylands's avatar
Dave Hylands committed
281

282
283
    // 1st argument is the pin name
    mp_obj_t pin_obj = args[0];
Dave Hylands's avatar
Dave Hylands committed
284
285
286
287

    uint32_t channel;

    if (MP_OBJ_IS_INT(pin_obj)) {
288
        channel = adc_get_internal_channel(mp_obj_get_int(pin_obj));
Dave Hylands's avatar
Dave Hylands committed
289
    } else {
290
        const pin_obj_t *pin = pin_find(pin_obj);
Dave Hylands's avatar
Dave Hylands committed
291
292
        if ((pin->adc_num & PIN_ADC1) == 0) {
            // No ADC1 function on that pin
293
            nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_ValueError, "pin %q does not have ADC capabilities", pin->name));
Dave Hylands's avatar
Dave Hylands committed
294
295
296
297
        }
        channel = pin->adc_channel;
    }

298
    if (!is_adcx_channel(channel)) {
299
        nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_ValueError, "not a valid ADC Channel: %d", channel));
Dave Hylands's avatar
Dave Hylands committed
300
    }
301
302
303
304
305
306
307
308


    if (ADC_FIRST_GPIO_CHANNEL <= channel && channel <= ADC_LAST_GPIO_CHANNEL) {
        // these channels correspond to physical GPIO ports so make sure they exist
        if (pin_adc1[channel] == NULL) {
            nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_ValueError,
                "channel %d not available on this board", channel));
        }
Dave Hylands's avatar
Dave Hylands committed
309
310
311
312
    }

    pyb_obj_adc_t *o = m_new_obj(pyb_obj_adc_t);
    memset(o, 0, sizeof(*o));
313
    o->base.type = &pyb_adc_type;
Dave Hylands's avatar
Dave Hylands committed
314
315
316
317
318
319
320
    o->pin_name = pin_obj;
    o->channel = channel;
    adc_init_single(o);

    return o;
}

321
322
323
/// \method read()
/// Read the value on the analog pin and return it.  The returned value
/// will be between 0 and 4095.
324
325
326
STATIC mp_obj_t adc_read(mp_obj_t self_in) {
    pyb_obj_adc_t *self = self_in;

327
    adc_config_channel(&self->handle, self->channel);
328
329
330
331
332
    uint32_t data = adc_read_channel(&self->handle);
    return mp_obj_new_int(data);
}
STATIC MP_DEFINE_CONST_FUN_OBJ_1(adc_read_obj, adc_read);

333
/// \method read_timed(buf, timer)
334
///
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
/// Read analog values into `buf` at a rate set by the `timer` object.
///
/// `buf` can be bytearray or array.array for example.  The ADC values have
/// 12-bit resolution and are stored directly into `buf` if its element size is
/// 16 bits or greater.  If `buf` has only 8-bit elements (eg a bytearray) then
/// the sample resolution will be reduced to 8 bits.
///
/// `timer` should be a Timer object, and a sample is read each time the timer
/// triggers.  The timer must already be initialised and running at the desired
/// sampling frequency.
///
/// To support previous behaviour of this function, `timer` can also be an
/// integer which specifies the frequency (in Hz) to sample at.  In this case
/// Timer(6) will be automatically configured to run at the given frequency.
///
/// Example using a Timer object (preferred way):
///
///     adc = pyb.ADC(pyb.Pin.board.X19)    # create an ADC on pin X19
///     tim = pyb.Timer(6, freq=10)         # create a timer running at 10Hz
///     buf = bytearray(100)                # creat a buffer to store the samples
///     adc.read_timed(buf, tim)            # sample 100 values, taking 10s
///
/// Example using an integer for the frequency:
358
359
360
361
362
363
364
365
366
///
///     adc = pyb.ADC(pyb.Pin.board.X19)    # create an ADC on pin X19
///     buf = bytearray(100)                # create a buffer of 100 bytes
///     adc.read_timed(buf, 10)             # read analog values into buf at 10Hz
///                                         #   this will take 10 seconds to finish
///     for val in buf:                     # loop over all values
///         print(val)                      # print the value out
///
/// This function does not allocate any memory.
367
368
369
STATIC mp_obj_t adc_read_timed(mp_obj_t self_in, mp_obj_t buf_in, mp_obj_t freq_in) {
    pyb_obj_adc_t *self = self_in;

370
371
    mp_buffer_info_t bufinfo;
    mp_get_buffer_raise(buf_in, &bufinfo, MP_BUFFER_WRITE);
372
    size_t typesize = mp_binary_get_size('@', bufinfo.typecode, NULL);
373

374
375
376
377
378
379
380
381
382
383
384
385
    TIM_HandleTypeDef *tim;
    #if defined(TIM6)
    if (mp_obj_is_integer(freq_in)) {
        // freq in Hz given so init TIM6 (legacy behaviour)
        tim = timer_tim6_init(mp_obj_get_int(freq_in));
        HAL_TIM_Base_Start(tim);
    } else
    #endif
    {
        // use the supplied timer object as the sampling time base
        tim = pyb_timer_get_handle(freq_in);
    }
386

387
    // configure the ADC channel
388
    adc_config_channel(&self->handle, self->channel);
389
390
391
392

    // This uses the timer in polling mode to do the sampling
    // TODO use DMA

393
394
    uint nelems = bufinfo.len / typesize;
    for (uint index = 0; index < nelems; index++) {
395
        // Wait for the timer to trigger so we sample at the correct frequency
396
        while (__HAL_TIM_GET_FLAG(tim, TIM_FLAG_UPDATE) == RESET) {
397
        }
398
        __HAL_TIM_CLEAR_FLAG(tim, TIM_FLAG_UPDATE);
399
400
401
402
403
404

        if (index == 0) {
            // for the first sample we need to turn the ADC on
            HAL_ADC_Start(&self->handle);
        } else {
            // for subsequent samples we can just set the "start sample" bit
405
#if defined(MCU_SERIES_F4) || defined(MCU_SERIES_F7)
406
            ADCx->CR2 |= (uint32_t)ADC_CR2_SWSTART;
407
408
409
410
411
#elif defined(MCU_SERIES_L4)
            SET_BIT(ADCx->CR, ADC_CR_ADSTART);
#else
            #error Unsupported processor
#endif
412
413
414
        }

        // wait for sample to complete
415
416
        #define READ_TIMED_TIMEOUT (10) // in ms
        adc_wait_for_eoc_or_timeout(READ_TIMED_TIMEOUT);
417
418
419
420
421

        // read value
        uint value = ADCx->DR;

        // store value in buffer
422
423
424
425
        if (typesize == 1) {
            value >>= 4;
        }
        mp_binary_set_val_array_from_int(bufinfo.typecode, bufinfo.buf, index, value);
426
427
    }

428
429
430
    // turn the ADC off
    HAL_ADC_Stop(&self->handle);

431
432
433
434
435
436
    #if defined(TIM6)
    if (mp_obj_is_integer(freq_in)) {
        // stop timer if we initialised TIM6 in this function (legacy behaviour)
        HAL_TIM_Base_Stop(tim);
    }
    #endif
437
438
439
440
441

    return mp_obj_new_int(bufinfo.len);
}
STATIC MP_DEFINE_CONST_FUN_OBJ_3(adc_read_timed_obj, adc_read_timed);

442
443
STATIC const mp_map_elem_t adc_locals_dict_table[] = {
    { MP_OBJ_NEW_QSTR(MP_QSTR_read), (mp_obj_t)&adc_read_obj},
444
    { MP_OBJ_NEW_QSTR(MP_QSTR_read_timed), (mp_obj_t)&adc_read_timed_obj},
445
446
};

447
448
STATIC MP_DEFINE_CONST_DICT(adc_locals_dict, adc_locals_dict_table);

449
450
451
452
453
const mp_obj_type_t pyb_adc_type = {
    { &mp_type_type },
    .name = MP_QSTR_ADC,
    .print = adc_print,
    .make_new = adc_make_new,
454
    .locals_dict = (mp_obj_t)&adc_locals_dict,
455
};
Dave Hylands's avatar
Dave Hylands committed
456
457
458
459

/******************************************************************************/
/* adc all object                                                             */

460
typedef struct _pyb_adc_all_obj_t {
Dave Hylands's avatar
Dave Hylands committed
461
462
    mp_obj_base_t base;
    ADC_HandleTypeDef handle;
463
} pyb_adc_all_obj_t;
Dave Hylands's avatar
Dave Hylands committed
464

465
void adc_init_all(pyb_adc_all_obj_t *adc_all, uint32_t resolution, uint32_t en_mask) {
Dave Hylands's avatar
Dave Hylands committed
466
467

    switch (resolution) {
468
469
470
471
        case 6:  resolution = ADC_RESOLUTION_6B;  break;
        case 8:  resolution = ADC_RESOLUTION_8B;  break;
        case 10: resolution = ADC_RESOLUTION_10B; break;
        case 12: resolution = ADC_RESOLUTION_12B; break;
Dave Hylands's avatar
Dave Hylands committed
472
        default:
473
            nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_ValueError,
Dave Hylands's avatar
Dave Hylands committed
474
475
476
                "resolution %d not supported", resolution));
    }

477
    for (uint32_t channel = ADC_FIRST_GPIO_CHANNEL; channel <= ADC_LAST_GPIO_CHANNEL; ++channel) {
478
479
480
481
482
483
484
485
486
487
488
489
490
491
        // only initialise those channels that are selected with the en_mask
        if (en_mask & (1 << channel)) {
            // Channels 0-16 correspond to real pins. Configure the GPIO pin in
            // ADC mode.
            const pin_obj_t *pin = pin_adc1[channel];
            if (pin) {
                mp_hal_gpio_clock_enable(pin->gpio);
                GPIO_InitTypeDef GPIO_InitStructure;
                GPIO_InitStructure.Pin = pin->pin_mask;
                GPIO_InitStructure.Mode = GPIO_MODE_ANALOG;
                GPIO_InitStructure.Pull = GPIO_NOPULL;
                HAL_GPIO_Init(pin->gpio, &GPIO_InitStructure);
            }
        }
Dave Hylands's avatar
Dave Hylands committed
492
493
    }

494
    adcx_clock_enable();
Dave Hylands's avatar
Dave Hylands committed
495
496
497
498
499
500
501
502
503
504
505
506

    ADC_HandleTypeDef *adcHandle = &adc_all->handle;
    adcHandle->Instance = ADCx;
    adcHandle->Init.Resolution            = resolution;
    adcHandle->Init.ContinuousConvMode    = DISABLE;
    adcHandle->Init.DiscontinuousConvMode = DISABLE;
    adcHandle->Init.NbrOfDiscConversion   = 0;
    adcHandle->Init.ExternalTrigConvEdge  = ADC_EXTERNALTRIGCONVEDGE_NONE;
    adcHandle->Init.DataAlign             = ADC_DATAALIGN_RIGHT;
    adcHandle->Init.NbrOfConversion       = 1;
    adcHandle->Init.DMAContinuousRequests = DISABLE;
    adcHandle->Init.EOCSelection          = DISABLE;
507
#if defined(MCU_SERIES_F4) || defined(MCU_SERIES_F7)
508
    adcHandle->Init.ClockPrescaler        = ADC_CLOCK_SYNC_PCLK_DIV2;
509
510
511
512
513
514
515
516
517
518
519
520
    adcHandle->Init.ScanConvMode          = DISABLE;
    adcHandle->Init.ExternalTrigConv      = ADC_EXTERNALTRIGCONV_T1_CC1;
#elif defined(MCU_SERIES_L4)
    adcHandle->Init.ClockPrescaler        = ADC_CLOCK_ASYNC_DIV2;
    adcHandle->Init.ScanConvMode          = ADC_SCAN_DISABLE;
    adcHandle->Init.ExternalTrigConv      = ADC_EXTERNALTRIG_T1_CC1;
    adcHandle->Init.LowPowerAutoWait      = DISABLE;
    adcHandle->Init.Overrun               = ADC_OVR_DATA_PRESERVED;
    adcHandle->Init.OversamplingMode      = DISABLE;
#else
    #error Unsupported processor
#endif
Dave Hylands's avatar
Dave Hylands committed
521
522
523
524

    HAL_ADC_Init(adcHandle);
}

525
uint32_t adc_config_and_read_channel(ADC_HandleTypeDef *adcHandle, uint32_t channel) {
526
    adc_config_channel(adcHandle, channel);
Dave Hylands's avatar
Dave Hylands committed
527
528
529
    return adc_read_channel(adcHandle);
}

Dave Hylands's avatar
Dave Hylands committed
530
531
532
533
int adc_get_resolution(ADC_HandleTypeDef *adcHandle) {
    uint32_t res_reg = __HAL_ADC_GET_RESOLUTION(adcHandle);

    switch (res_reg) {
534
535
536
        case ADC_RESOLUTION_6B:  return 6;
        case ADC_RESOLUTION_8B:  return 8;
        case ADC_RESOLUTION_10B: return 10;
Dave Hylands's avatar
Dave Hylands committed
537
538
539
540
    }
    return 12;
}

541
int adc_read_core_temp(ADC_HandleTypeDef *adcHandle) {
Dave Hylands's avatar
Dave Hylands committed
542
    int32_t raw_value = adc_config_and_read_channel(adcHandle, ADC_CHANNEL_TEMPSENSOR);
Dave Hylands's avatar
Dave Hylands committed
543
544
545
546
547

    // Note: constants assume 12-bit resolution, so we scale the raw value to
    //       be 12-bits.
    raw_value <<= (12 - adc_get_resolution(adcHandle));

Dave Hylands's avatar
Dave Hylands committed
548
549
550
    return ((raw_value - CORE_TEMP_V25) / CORE_TEMP_AVG_SLOPE) + 25;
}

Dave Hylands's avatar
Dave Hylands committed
551
#if MICROPY_PY_BUILTINS_FLOAT
552
553
554
// correction factor for reference value
STATIC volatile float adc_refcor = 1.0f;

555
556
557
558
559
560
561
562
563
564
float adc_read_core_temp_float(ADC_HandleTypeDef *adcHandle) {
    int32_t raw_value = adc_config_and_read_channel(adcHandle, ADC_CHANNEL_TEMPSENSOR);

    // constants assume 12-bit resolution so we scale the raw value to 12-bits
    raw_value <<= (12 - adc_get_resolution(adcHandle));

    float core_temp_avg_slope = (*ADC_CAL2 - *ADC_CAL1) / 80.0;
    return (((float)raw_value * adc_refcor - *ADC_CAL1) / core_temp_avg_slope) + 30.0f;
}

565
float adc_read_core_vbat(ADC_HandleTypeDef *adcHandle) {
Dave Hylands's avatar
Dave Hylands committed
566
    uint32_t raw_value = adc_config_and_read_channel(adcHandle, ADC_CHANNEL_VBAT);
Dave Hylands's avatar
Dave Hylands committed
567
568
569
570
571

    // Note: constants assume 12-bit resolution, so we scale the raw value to
    //       be 12-bits.
    raw_value <<= (12 - adc_get_resolution(adcHandle));

572
573
574
575
576
577
578
579
580
581
    #if defined(MCU_SERIES_F4) || defined(MCU_SERIES_F7)
    // ST docs say that (at least on STM32F42x and STM32F43x), VBATE must
    // be disabled when TSVREFE is enabled for TEMPSENSOR and VREFINT
    // conversions to work.  VBATE is enabled by the above call to read
    // the channel, and here we disable VBATE so a subsequent call for
    // TEMPSENSOR or VREFINT works correctly.
    ADC->CCR &= ~ADC_CCR_VBATE;
    #endif

    return raw_value * VBAT_DIV * ADC_SCALE * adc_refcor;
Dave Hylands's avatar
Dave Hylands committed
582
583
}

584
float adc_read_core_vref(ADC_HandleTypeDef *adcHandle) {
Dave Hylands's avatar
Dave Hylands committed
585
    uint32_t raw_value = adc_config_and_read_channel(adcHandle, ADC_CHANNEL_VREFINT);
Dave Hylands's avatar
Dave Hylands committed
586
587
588
589
590

    // Note: constants assume 12-bit resolution, so we scale the raw value to
    //       be 12-bits.
    raw_value <<= (12 - adc_get_resolution(adcHandle));

591
592
593
594
    // update the reference correction factor
    adc_refcor = ((float)(*VREFIN_CAL)) / ((float)raw_value);

    return (*VREFIN_CAL) * ADC_SCALE;
Dave Hylands's avatar
Dave Hylands committed
595
}
Dave Hylands's avatar
Dave Hylands committed
596
#endif
Dave Hylands's avatar
Dave Hylands committed
597
598
599
600

/******************************************************************************/
/* Micro Python bindings : adc_all object                                     */

601
STATIC mp_obj_t adc_all_make_new(const mp_obj_type_t *type, mp_uint_t n_args, mp_uint_t n_kw, const mp_obj_t *args) {
602
    // check number of arguments
603
    mp_arg_check_num(n_args, n_kw, 1, 2, false);
604
605
606
607

    // make ADCAll object
    pyb_adc_all_obj_t *o = m_new_obj(pyb_adc_all_obj_t);
    o->base.type = &pyb_adc_all_type;
608
609
610
611
612
613
    mp_int_t res = mp_obj_get_int(args[0]);
    uint32_t en_mask = 0xffffffff;
    if (n_args > 1) {
        en_mask =  mp_obj_get_int(args[1]);
    }
    adc_init_all(o, res, en_mask);
614
615

    return o;
Dave Hylands's avatar
Dave Hylands committed
616
617
}

618
STATIC mp_obj_t adc_all_read_channel(mp_obj_t self_in, mp_obj_t channel) {
619
    pyb_adc_all_obj_t *self = self_in;
620
    uint32_t chan = adc_get_internal_channel(mp_obj_get_int(channel));
Dave Hylands's avatar
Dave Hylands committed
621
622
623
    uint32_t data = adc_config_and_read_channel(&self->handle, chan);
    return mp_obj_new_int(data);
}
624
STATIC MP_DEFINE_CONST_FUN_OBJ_2(adc_all_read_channel_obj, adc_all_read_channel);
Dave Hylands's avatar
Dave Hylands committed
625

626
STATIC mp_obj_t adc_all_read_core_temp(mp_obj_t self_in) {
627
    pyb_adc_all_obj_t *self = self_in;
628
629
630
631
    #if MICROPY_PY_BUILTINS_FLOAT
    float data = adc_read_core_temp_float(&self->handle);
    return mp_obj_new_float(data);
    #else
Dave Hylands's avatar
Dave Hylands committed
632
633
    int data  = adc_read_core_temp(&self->handle);
    return mp_obj_new_int(data);
634
    #endif
Dave Hylands's avatar
Dave Hylands committed
635
}
636
STATIC MP_DEFINE_CONST_FUN_OBJ_1(adc_all_read_core_temp_obj, adc_all_read_core_temp);
Dave Hylands's avatar
Dave Hylands committed
637

Dave Hylands's avatar
Dave Hylands committed
638
#if MICROPY_PY_BUILTINS_FLOAT
639
STATIC mp_obj_t adc_all_read_core_vbat(mp_obj_t self_in) {
640
    pyb_adc_all_obj_t *self = self_in;
Dave Hylands's avatar
Dave Hylands committed
641
642
643
    float data = adc_read_core_vbat(&self->handle);
    return mp_obj_new_float(data);
}
644
STATIC MP_DEFINE_CONST_FUN_OBJ_1(adc_all_read_core_vbat_obj, adc_all_read_core_vbat);
Dave Hylands's avatar
Dave Hylands committed
645

646
STATIC mp_obj_t adc_all_read_core_vref(mp_obj_t self_in) {
647
    pyb_adc_all_obj_t *self = self_in;
Dave Hylands's avatar
Dave Hylands committed
648
649
650
    float data  = adc_read_core_vref(&self->handle);
    return mp_obj_new_float(data);
}
651
STATIC MP_DEFINE_CONST_FUN_OBJ_1(adc_all_read_core_vref_obj, adc_all_read_core_vref);
652
653
654
655
656
657
658

STATIC mp_obj_t adc_all_read_vref(mp_obj_t self_in) {
    pyb_adc_all_obj_t *self = self_in;
    adc_read_core_vref(&self->handle);
    return mp_obj_new_float(3.3 * adc_refcor);
}
STATIC MP_DEFINE_CONST_FUN_OBJ_1(adc_all_read_vref_obj, adc_all_read_vref);
Dave Hylands's avatar
Dave Hylands committed
659
#endif
Dave Hylands's avatar
Dave Hylands committed
660

661
STATIC const mp_map_elem_t adc_all_locals_dict_table[] = {
662
    { MP_OBJ_NEW_QSTR(MP_QSTR_read_channel),   (mp_obj_t)&adc_all_read_channel_obj},
663
    { MP_OBJ_NEW_QSTR(MP_QSTR_read_core_temp), (mp_obj_t)&adc_all_read_core_temp_obj},
Dave Hylands's avatar
Dave Hylands committed
664
#if MICROPY_PY_BUILTINS_FLOAT
665
666
    { MP_OBJ_NEW_QSTR(MP_QSTR_read_core_vbat), (mp_obj_t)&adc_all_read_core_vbat_obj},
    { MP_OBJ_NEW_QSTR(MP_QSTR_read_core_vref), (mp_obj_t)&adc_all_read_core_vref_obj},
667
    { MP_OBJ_NEW_QSTR(MP_QSTR_read_vref), (mp_obj_t)&adc_all_read_vref_obj},
Dave Hylands's avatar
Dave Hylands committed
668
#endif
Dave Hylands's avatar
Dave Hylands committed
669
670
};

671
672
STATIC MP_DEFINE_CONST_DICT(adc_all_locals_dict, adc_all_locals_dict_table);

673
const mp_obj_type_t pyb_adc_all_type = {
Dave Hylands's avatar
Dave Hylands committed
674
    { &mp_type_type },
675
676
    .name = MP_QSTR_ADCAll,
    .make_new = adc_all_make_new,
677
    .locals_dict = (mp_obj_t)&adc_all_locals_dict,
Dave Hylands's avatar
Dave Hylands committed
678
};