adc.c 14 KB
Newer Older
Dave Hylands's avatar
Dave Hylands committed
1
2
3
4
5
6
7
8
9
#include <stdio.h>
#include <stm32f4xx_hal.h>
#include <string.h>

#include "misc.h"
#include "nlr.h"
#include "mpconfig.h"
#include "qstr.h"
#include "obj.h"
10
#include "runtime.h"
11
#include "binary.h"
Dave Hylands's avatar
Dave Hylands committed
12
13
#include "adc.h"
#include "pin.h"
14
#include "genhdr/pins.h"
15
#include "timer.h"
Dave Hylands's avatar
Dave Hylands committed
16

17
18
19
20
21
22
23
24
25
26
27
28
29
/// \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
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

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

#if defined(STM32F405xx) || defined(STM32F415xx) || \
    defined(STM32F407xx) || defined(STM32F417xx) || \
    defined(STM32F401xC) || defined(STM32F401xE)
#define VBAT_DIV (2)
#elif defined(STM32F427xx) || defined(STM32F429xx) || \
      defined(STM32F437xx) || defined(STM32F439xx)
#define VBAT_DIV (4)
#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) */

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;

void adc_init_single(pyb_obj_adc_t *adc_obj) {
    if (!IS_ADC_CHANNEL(adc_obj->channel)) {
        return;
    }

    if (adc_obj->channel < ADC_NUM_GPIO_CHANNELS) {
      // Channels 0-16 correspond to real pins. Configure the GPIO pin in
      // ADC mode.
      const pin_obj_t *pin = pin_adc1[adc_obj->channel];
      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);
    }

    ADCx_CLK_ENABLE();

    ADC_HandleTypeDef *adcHandle = &adc_obj->handle;
    adcHandle->Instance                   = ADCx;
    adcHandle->Init.ClockPrescaler        = ADC_CLOCKPRESCALER_PCLK_DIV2;
    adcHandle->Init.Resolution            = ADC_RESOLUTION12b;
    adcHandle->Init.ScanConvMode          = DISABLE;
    adcHandle->Init.ContinuousConvMode    = DISABLE;
    adcHandle->Init.DiscontinuousConvMode = DISABLE;
    adcHandle->Init.NbrOfDiscConversion   = 0;
    adcHandle->Init.ExternalTrigConvEdge  = ADC_EXTERNALTRIGCONVEDGE_NONE;
    adcHandle->Init.ExternalTrigConv      = ADC_EXTERNALTRIGCONV_T1_CC1;
    adcHandle->Init.DataAlign             = ADC_DATAALIGN_RIGHT;
    adcHandle->Init.NbrOfConversion       = 1;
    adcHandle->Init.DMAContinuousRequests = DISABLE;
    adcHandle->Init.EOCSelection          = DISABLE;

    HAL_ADC_Init(adcHandle);

    ADC_ChannelConfTypeDef sConfig;

    sConfig.Channel = adc_obj->channel;
    sConfig.Rank = 1;
    sConfig.SamplingTime = ADC_SAMPLETIME_15CYCLES;
    sConfig.Offset = 0;

    HAL_ADC_ConfigChannel(adcHandle, &sConfig);
}

102
uint32_t adc_read_channel(ADC_HandleTypeDef *adcHandle) {
Dave Hylands's avatar
Dave Hylands committed
103
104
105
    uint32_t rawValue = 0;

    HAL_ADC_Start(adcHandle);
106
    if (HAL_ADC_PollForConversion(adcHandle, 10) == HAL_OK && HAL_ADC_GetState(adcHandle) == HAL_ADC_STATE_EOC_REG) {
Dave Hylands's avatar
Dave Hylands committed
107
108
109
110
111
112
113
114
115
116
        rawValue = HAL_ADC_GetValue(adcHandle);
    }
    HAL_ADC_Stop(adcHandle);

    return rawValue;
}

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

117
STATIC void adc_print(void (*print)(void *env, const char *fmt, ...), void *env, mp_obj_t self_in, mp_print_kind_t kind) {
Dave Hylands's avatar
Dave Hylands committed
118
119
120
121
122
123
    pyb_obj_adc_t *self = self_in;
    print(env, "<ADC on ");
    mp_obj_print_helper(print, env, self->pin_name, PRINT_STR);
    print(env, " channel=%lu>", self->channel);
}

124
125
126
/// \classmethod \constructor(pin)
/// Create an ADC object associated with the given pin.
/// This allows you to then read analog values on that pin.
127
128
STATIC mp_obj_t adc_make_new(mp_obj_t type_in, uint n_args, uint n_kw, const mp_obj_t *args) {
    // check number of arguments
Damien George's avatar
Damien George committed
129
    mp_arg_check_num(n_args, n_kw, 1, 1, false);
Dave Hylands's avatar
Dave Hylands committed
130

131
132
    // 1st argument is the pin name
    mp_obj_t pin_obj = args[0];
Dave Hylands's avatar
Dave Hylands committed
133
134
135
136
137
138

    uint32_t channel;

    if (MP_OBJ_IS_INT(pin_obj)) {
        channel = mp_obj_get_int(pin_obj);
    } else {
139
        const pin_obj_t *pin = pin_find(pin_obj);
Dave Hylands's avatar
Dave Hylands committed
140
141
        if ((pin->adc_num & PIN_ADC1) == 0) {
            // No ADC1 function on that pin
142
            nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_ValueError, "pin %s does not have ADC capabilities", pin->name));
Dave Hylands's avatar
Dave Hylands committed
143
144
145
146
147
        }
        channel = pin->adc_channel;
    }

    if (!IS_ADC_CHANNEL(channel)) {
148
        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
149
150
    }
    if (pin_adc1[channel] == NULL) {
151
        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
152
153
154
155
    }

    pyb_obj_adc_t *o = m_new_obj(pyb_obj_adc_t);
    memset(o, 0, sizeof(*o));
156
    o->base.type = &pyb_adc_type;
Dave Hylands's avatar
Dave Hylands committed
157
158
159
160
161
162
163
    o->pin_name = pin_obj;
    o->channel = channel;
    adc_init_single(o);

    return o;
}

164
165
166
/// \method read()
/// Read the value on the analog pin and return it.  The returned value
/// will be between 0 and 4095.
167
168
169
170
171
172
173
174
STATIC mp_obj_t adc_read(mp_obj_t self_in) {
    pyb_obj_adc_t *self = self_in;

    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);

175
176
177
178
179
180
181
182
183
184
185
186
187
/// \method read_timed(buf, freq)
/// Read analog values into the given buffer at the given frequency.
///
/// Example:
///
///     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.
188
189
190
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;

191
192
    mp_buffer_info_t bufinfo;
    mp_get_buffer_raise(buf_in, &bufinfo, MP_BUFFER_WRITE);
193
    int typesize = mp_binary_get_size('@', bufinfo.typecode, NULL);
194
195
196
197
198
199
200
201

    // Init TIM6 at the required frequency (in Hz)
    timer_tim6_init(mp_obj_get_int(freq_in));

    // Start timer
    HAL_TIM_Base_Start(&TIM6_Handle);

    // This uses the timer in polling mode to do the sampling
202
203
    // We could use DMA, but then we can't convert the values correctly for the buffer
    for (uint index = 0; index < bufinfo.len; index++) {
204
205
206
207
        // Wait for the timer to trigger
        while (__HAL_TIM_GET_FLAG(&TIM6_Handle, TIM_FLAG_UPDATE) == RESET) {
        }
        __HAL_TIM_CLEAR_FLAG(&TIM6_Handle, TIM_FLAG_UPDATE);
208
209
210
211
212
        uint value = adc_read_channel(&self->handle);
        if (typesize == 1) {
            value >>= 4;
        }
        mp_binary_set_val_array_from_int(bufinfo.typecode, bufinfo.buf, index, value);
213
214
215
216
217
218
219
220
221
    }

    // Stop timer
    HAL_TIM_Base_Stop(&TIM6_Handle);

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

222
223
STATIC const mp_map_elem_t adc_locals_dict_table[] = {
    { MP_OBJ_NEW_QSTR(MP_QSTR_read), (mp_obj_t)&adc_read_obj},
224
    { MP_OBJ_NEW_QSTR(MP_QSTR_read_timed), (mp_obj_t)&adc_read_timed_obj},
225
226
};

227
228
STATIC MP_DEFINE_CONST_DICT(adc_locals_dict, adc_locals_dict_table);

229
230
231
232
233
const mp_obj_type_t pyb_adc_type = {
    { &mp_type_type },
    .name = MP_QSTR_ADC,
    .print = adc_print,
    .make_new = adc_make_new,
234
    .locals_dict = (mp_obj_t)&adc_locals_dict,
235
};
Dave Hylands's avatar
Dave Hylands committed
236
237
238
239

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

240
typedef struct _pyb_adc_all_obj_t {
Dave Hylands's avatar
Dave Hylands committed
241
242
    mp_obj_base_t base;
    ADC_HandleTypeDef handle;
243
} pyb_adc_all_obj_t;
Dave Hylands's avatar
Dave Hylands committed
244

245
void adc_init_all(pyb_adc_all_obj_t *adc_all, uint32_t resolution) {
Dave Hylands's avatar
Dave Hylands committed
246
247

    switch (resolution) {
Dave Hylands's avatar
Dave Hylands committed
248
249
250
251
        case 6:  resolution = ADC_RESOLUTION6b;  break;
        case 8:  resolution = ADC_RESOLUTION8b;  break;
        case 10: resolution = ADC_RESOLUTION10b; break;
        case 12: resolution = ADC_RESOLUTION12b; break;
Dave Hylands's avatar
Dave Hylands committed
252
        default:
253
            nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_ValueError,
Dave Hylands's avatar
Dave Hylands committed
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
                "resolution %d not supported", resolution));
    }

    for (uint32_t channel = 0; channel < ADC_NUM_GPIO_CHANNELS; channel++) {
        // Channels 0-16 correspond to real pins. Configure the GPIO pin in
        // ADC mode.
        const pin_obj_t *pin = pin_adc1[channel];
        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);
    }

    ADCx_CLK_ENABLE();

    ADC_HandleTypeDef *adcHandle = &adc_all->handle;
    adcHandle->Instance = ADCx;
    adcHandle->Init.ClockPrescaler        = ADC_CLOCKPRESCALER_PCLK_DIV2;
    adcHandle->Init.Resolution            = resolution;
    adcHandle->Init.ScanConvMode          = DISABLE;
    adcHandle->Init.ContinuousConvMode    = DISABLE;
    adcHandle->Init.DiscontinuousConvMode = DISABLE;
    adcHandle->Init.NbrOfDiscConversion   = 0;
    adcHandle->Init.ExternalTrigConvEdge  = ADC_EXTERNALTRIGCONVEDGE_NONE;
    adcHandle->Init.ExternalTrigConv      = ADC_EXTERNALTRIGCONV_T1_CC1;
    adcHandle->Init.DataAlign             = ADC_DATAALIGN_RIGHT;
    adcHandle->Init.NbrOfConversion       = 1;
    adcHandle->Init.DMAContinuousRequests = DISABLE;
    adcHandle->Init.EOCSelection          = DISABLE;

    HAL_ADC_Init(adcHandle);
}

288
uint32_t adc_config_and_read_channel(ADC_HandleTypeDef *adcHandle, uint32_t channel) {
Dave Hylands's avatar
Dave Hylands committed
289
290
291
292
293
294
295
296
297
298
    ADC_ChannelConfTypeDef sConfig;
    sConfig.Channel = channel;
    sConfig.Rank = 1;
    sConfig.SamplingTime = ADC_SAMPLETIME_15CYCLES;
    sConfig.Offset = 0;
    HAL_ADC_ConfigChannel(adcHandle, &sConfig);

    return adc_read_channel(adcHandle);
}

Dave Hylands's avatar
Dave Hylands committed
299
300
301
302
303
304
305
306
307
308
309
int adc_get_resolution(ADC_HandleTypeDef *adcHandle) {
    uint32_t res_reg = __HAL_ADC_GET_RESOLUTION(adcHandle);

    switch (res_reg) {
        case ADC_RESOLUTION6b:  return 6;
        case ADC_RESOLUTION8b:  return 8;
        case ADC_RESOLUTION10b: return 10;
    }
    return 12;
}

310
int adc_read_core_temp(ADC_HandleTypeDef *adcHandle) {
Dave Hylands's avatar
Dave Hylands committed
311
    int32_t raw_value = adc_config_and_read_channel(adcHandle, ADC_CHANNEL_TEMPSENSOR);
Dave Hylands's avatar
Dave Hylands committed
312
313
314
315
316

    // 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
317
318
319
    return ((raw_value - CORE_TEMP_V25) / CORE_TEMP_AVG_SLOPE) + 25;
}

320
float adc_read_core_vbat(ADC_HandleTypeDef *adcHandle) {
Dave Hylands's avatar
Dave Hylands committed
321
    uint32_t raw_value = adc_config_and_read_channel(adcHandle, ADC_CHANNEL_VBAT);
Dave Hylands's avatar
Dave Hylands committed
322
323
324
325
326

    // 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
327
328
329
    return raw_value * VBAT_DIV / 4096.0f * 3.3f;
}

330
float adc_read_core_vref(ADC_HandleTypeDef *adcHandle) {
Dave Hylands's avatar
Dave Hylands committed
331
    uint32_t raw_value = adc_config_and_read_channel(adcHandle, ADC_CHANNEL_VREFINT);
Dave Hylands's avatar
Dave Hylands committed
332
333
334
335
336

    // 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
337
338
339
340
341
342
    return raw_value * VBAT_DIV / 4096.0f * 3.3f;
}

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

343
344
STATIC mp_obj_t adc_all_make_new(mp_obj_t type_in, uint n_args, uint n_kw, const mp_obj_t *args) {
    // check number of arguments
Damien George's avatar
Damien George committed
345
    mp_arg_check_num(n_args, n_kw, 1, 1, false);
346
347
348
349
350
351
352

    // make ADCAll object
    pyb_adc_all_obj_t *o = m_new_obj(pyb_adc_all_obj_t);
    o->base.type = &pyb_adc_all_type;
    adc_init_all(o, mp_obj_get_int(args[0])); // args[0] is the resolution

    return o;
Dave Hylands's avatar
Dave Hylands committed
353
354
}

355
STATIC mp_obj_t adc_all_read_channel(mp_obj_t self_in, mp_obj_t channel) {
356
    pyb_adc_all_obj_t *self = self_in;
Dave Hylands's avatar
Dave Hylands committed
357
358
359
360
    uint32_t chan = mp_obj_get_int(channel);
    uint32_t data = adc_config_and_read_channel(&self->handle, chan);
    return mp_obj_new_int(data);
}
361
STATIC MP_DEFINE_CONST_FUN_OBJ_2(adc_all_read_channel_obj, adc_all_read_channel);
Dave Hylands's avatar
Dave Hylands committed
362

363
STATIC mp_obj_t adc_all_read_core_temp(mp_obj_t self_in) {
364
    pyb_adc_all_obj_t *self = self_in;
Dave Hylands's avatar
Dave Hylands committed
365
366
367
    int data  = adc_read_core_temp(&self->handle);
    return mp_obj_new_int(data);
}
368
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
369

370
STATIC mp_obj_t adc_all_read_core_vbat(mp_obj_t self_in) {
371
    pyb_adc_all_obj_t *self = self_in;
Dave Hylands's avatar
Dave Hylands committed
372
373
374
    float data = adc_read_core_vbat(&self->handle);
    return mp_obj_new_float(data);
}
375
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
376

377
STATIC mp_obj_t adc_all_read_core_vref(mp_obj_t self_in) {
378
    pyb_adc_all_obj_t *self = self_in;
Dave Hylands's avatar
Dave Hylands committed
379
380
381
    float data  = adc_read_core_vref(&self->handle);
    return mp_obj_new_float(data);
}
382
STATIC MP_DEFINE_CONST_FUN_OBJ_1(adc_all_read_core_vref_obj, adc_all_read_core_vref);
Dave Hylands's avatar
Dave Hylands committed
383

384
STATIC const mp_map_elem_t adc_all_locals_dict_table[] = {
385
    { MP_OBJ_NEW_QSTR(MP_QSTR_read_channel),   (mp_obj_t)&adc_all_read_channel_obj},
386
387
388
    { MP_OBJ_NEW_QSTR(MP_QSTR_read_core_temp), (mp_obj_t)&adc_all_read_core_temp_obj},
    { 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},
Dave Hylands's avatar
Dave Hylands committed
389
390
};

391
392
STATIC MP_DEFINE_CONST_DICT(adc_all_locals_dict, adc_all_locals_dict_table);

393
const mp_obj_type_t pyb_adc_all_type = {
Dave Hylands's avatar
Dave Hylands committed
394
    { &mp_type_type },
395
396
    .name = MP_QSTR_ADCAll,
    .make_new = adc_all_make_new,
397
    .locals_dict = (mp_obj_t)&adc_all_locals_dict,
Dave Hylands's avatar
Dave Hylands committed
398
};