mirror of
https://github.com/W3SLAV/micropython.git
synced 2025-06-19 03:55:44 -04:00
decf8e6a8b
The STATIC macro was introduced a very long time ago in commit
d5df6cd44a. The original reason for this was
to have the option to define it to nothing so that all static functions
become global functions and therefore visible to certain debug tools, so
one could do function size comparison and other things.
This STATIC feature is rarely (if ever) used. And with the use of LTO and
heavy inline optimisation, analysing the size of individual functions when
they are not static is not a good representation of the size of code when
fully optimised.
So the macro does not have much use and it's simpler to just remove it.
Then you know exactly what it's doing. For example, newcomers don't have
to learn what the STATIC macro is and why it exists. Reading the code is
also less "loud" with a lowercase static.
One other minor point in favour of removing it, is that it stops bugs with
`STATIC inline`, which should always be `static inline`.
Methodology for this commit was:
1) git ls-files | egrep '\.[ch]$' | \
xargs sed -Ei "s/(^| )STATIC($| )/\1static\2/"
2) Do some manual cleanup in the diff by searching for the word STATIC in
comments and changing those back.
3) "git-grep STATIC docs/", manually fixed those cases.
4) "rg -t python STATIC", manually fixed codegen lines that used STATIC.
This work was funded through GitHub Sponsors.
Signed-off-by: Angus Gratton <angus@redyak.com.au>
235 lines
10 KiB
C
235 lines
10 KiB
C
/*
|
|
* This file is part of the MicroPython project, http://micropython.org/
|
|
*
|
|
* The MIT License (MIT)
|
|
*
|
|
* Copyright (c) 2017 Nick Moore
|
|
* Copyright (c) 2021 Jonathan Hogg
|
|
*
|
|
* 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.
|
|
*/
|
|
|
|
// This file is never compiled standalone, it's included directly from
|
|
// extmod/machine_adc.c via MICROPY_PY_MACHINE_ADC_INCLUDEFILE.
|
|
|
|
#include "py/mphal.h"
|
|
#include "adc.h"
|
|
#include "driver/adc.h"
|
|
|
|
#define ADCBLOCK1 (&madcblock_obj[0])
|
|
#define ADCBLOCK2 (&madcblock_obj[1])
|
|
|
|
#if CONFIG_IDF_TARGET_ESP32
|
|
#define MICROPY_PY_MACHINE_ADC_CLASS_CONSTANTS_WIDTH_9_10_11 \
|
|
{ MP_ROM_QSTR(MP_QSTR_WIDTH_9BIT), MP_ROM_INT(9) }, \
|
|
{ MP_ROM_QSTR(MP_QSTR_WIDTH_10BIT), MP_ROM_INT(10) }, \
|
|
{ MP_ROM_QSTR(MP_QSTR_WIDTH_11BIT), MP_ROM_INT(11) },
|
|
#else
|
|
#define MICROPY_PY_MACHINE_ADC_CLASS_CONSTANTS_WIDTH_9_10_11
|
|
#endif
|
|
|
|
#if CONFIG_IDF_TARGET_ESP32 || CONFIG_IDF_TARGET_ESP32C3 || CONFIG_IDF_TARGET_ESP32S3
|
|
#define MICROPY_PY_MACHINE_ADC_CLASS_CONSTANTS_WIDTH_12 \
|
|
{ MP_ROM_QSTR(MP_QSTR_WIDTH_12BIT), MP_ROM_INT(12) },
|
|
#else
|
|
#define MICROPY_PY_MACHINE_ADC_CLASS_CONSTANTS_WIDTH_12
|
|
#endif
|
|
|
|
#if CONFIG_IDF_TARGET_ESP32S2
|
|
#define MICROPY_PY_MACHINE_ADC_CLASS_CONSTANTS_WIDTH_13 \
|
|
{ MP_ROM_QSTR(MP_QSTR_WIDTH_13BIT), MP_ROM_INT(13) },
|
|
#else
|
|
#define MICROPY_PY_MACHINE_ADC_CLASS_CONSTANTS_WIDTH_13
|
|
#endif
|
|
|
|
#define MICROPY_PY_MACHINE_ADC_CLASS_CONSTANTS \
|
|
{ MP_ROM_QSTR(MP_QSTR_ATTN_0DB), MP_ROM_INT(ADC_ATTEN_DB_0) }, \
|
|
{ MP_ROM_QSTR(MP_QSTR_ATTN_2_5DB), MP_ROM_INT(ADC_ATTEN_DB_2_5) }, \
|
|
{ MP_ROM_QSTR(MP_QSTR_ATTN_6DB), MP_ROM_INT(ADC_ATTEN_DB_6) }, \
|
|
{ MP_ROM_QSTR(MP_QSTR_ATTN_11DB), MP_ROM_INT(ADC_ATTEN_DB_11) }, \
|
|
MICROPY_PY_MACHINE_ADC_CLASS_CONSTANTS_WIDTH_9_10_11 \
|
|
MICROPY_PY_MACHINE_ADC_CLASS_CONSTANTS_WIDTH_12 \
|
|
MICROPY_PY_MACHINE_ADC_CLASS_CONSTANTS_WIDTH_13 \
|
|
|
|
static const machine_adc_obj_t madc_obj[] = {
|
|
#if CONFIG_IDF_TARGET_ESP32
|
|
{{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_0, GPIO_NUM_36},
|
|
{{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_1, GPIO_NUM_37},
|
|
{{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_2, GPIO_NUM_38},
|
|
{{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_3, GPIO_NUM_39},
|
|
{{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_4, GPIO_NUM_32},
|
|
{{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_5, GPIO_NUM_33},
|
|
{{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_6, GPIO_NUM_34},
|
|
{{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_7, GPIO_NUM_35},
|
|
{{&machine_adc_type}, ADCBLOCK2, ADC_CHANNEL_0, GPIO_NUM_4},
|
|
{{&machine_adc_type}, ADCBLOCK2, ADC_CHANNEL_1, GPIO_NUM_0},
|
|
{{&machine_adc_type}, ADCBLOCK2, ADC_CHANNEL_2, GPIO_NUM_2},
|
|
{{&machine_adc_type}, ADCBLOCK2, ADC_CHANNEL_3, GPIO_NUM_15},
|
|
{{&machine_adc_type}, ADCBLOCK2, ADC_CHANNEL_4, GPIO_NUM_13},
|
|
{{&machine_adc_type}, ADCBLOCK2, ADC_CHANNEL_5, GPIO_NUM_12},
|
|
{{&machine_adc_type}, ADCBLOCK2, ADC_CHANNEL_6, GPIO_NUM_14},
|
|
{{&machine_adc_type}, ADCBLOCK2, ADC_CHANNEL_7, GPIO_NUM_27},
|
|
{{&machine_adc_type}, ADCBLOCK2, ADC_CHANNEL_8, GPIO_NUM_25},
|
|
{{&machine_adc_type}, ADCBLOCK2, ADC_CHANNEL_9, GPIO_NUM_26},
|
|
#elif CONFIG_IDF_TARGET_ESP32C3
|
|
{{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_0, GPIO_NUM_0},
|
|
{{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_1, GPIO_NUM_1},
|
|
{{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_2, GPIO_NUM_2},
|
|
{{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_3, GPIO_NUM_3},
|
|
{{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_4, GPIO_NUM_4},
|
|
{{&machine_adc_type}, ADCBLOCK2, ADC_CHANNEL_0, GPIO_NUM_5},
|
|
#elif CONFIG_IDF_TARGET_ESP32S2 || CONFIG_IDF_TARGET_ESP32S3
|
|
{{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_0, GPIO_NUM_1},
|
|
{{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_1, GPIO_NUM_2},
|
|
{{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_2, GPIO_NUM_3},
|
|
{{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_3, GPIO_NUM_4},
|
|
{{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_4, GPIO_NUM_5},
|
|
{{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_5, GPIO_NUM_6},
|
|
{{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_6, GPIO_NUM_7},
|
|
{{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_7, GPIO_NUM_8},
|
|
{{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_8, GPIO_NUM_9},
|
|
{{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_9, GPIO_NUM_10},
|
|
{{&machine_adc_type}, ADCBLOCK2, ADC_CHANNEL_0, GPIO_NUM_11},
|
|
{{&machine_adc_type}, ADCBLOCK2, ADC_CHANNEL_1, GPIO_NUM_12},
|
|
{{&machine_adc_type}, ADCBLOCK2, ADC_CHANNEL_2, GPIO_NUM_13},
|
|
{{&machine_adc_type}, ADCBLOCK2, ADC_CHANNEL_3, GPIO_NUM_14},
|
|
{{&machine_adc_type}, ADCBLOCK2, ADC_CHANNEL_4, GPIO_NUM_15},
|
|
{{&machine_adc_type}, ADCBLOCK2, ADC_CHANNEL_5, GPIO_NUM_16},
|
|
{{&machine_adc_type}, ADCBLOCK2, ADC_CHANNEL_6, GPIO_NUM_17},
|
|
{{&machine_adc_type}, ADCBLOCK2, ADC_CHANNEL_7, GPIO_NUM_18},
|
|
{{&machine_adc_type}, ADCBLOCK2, ADC_CHANNEL_8, GPIO_NUM_19},
|
|
{{&machine_adc_type}, ADCBLOCK2, ADC_CHANNEL_9, GPIO_NUM_20},
|
|
#endif
|
|
};
|
|
|
|
// These values are initialised to 0, which means the corresponding ADC channel is not initialised.
|
|
// The madc_atten_get/madc_atten_set functions store (atten+1) here so that the uninitialised state
|
|
// can be distinguished from the initialised state.
|
|
static uint8_t madc_obj_atten[MP_ARRAY_SIZE(madc_obj)];
|
|
|
|
static inline adc_atten_t madc_atten_get(const machine_adc_obj_t *self) {
|
|
uint8_t value = madc_obj_atten[self - &madc_obj[0]];
|
|
return value == 0 ? ADC_ATTEN_MAX : value - 1;
|
|
}
|
|
|
|
static inline void madc_atten_set(const machine_adc_obj_t *self, adc_atten_t atten) {
|
|
madc_obj_atten[self - &madc_obj[0]] = atten + 1;
|
|
}
|
|
|
|
const machine_adc_obj_t *madc_search_helper(machine_adc_block_obj_t *block, adc_channel_t channel_id, gpio_num_t gpio_id) {
|
|
for (int i = 0; i < MP_ARRAY_SIZE(madc_obj); i++) {
|
|
const machine_adc_obj_t *adc = &madc_obj[i];
|
|
if ((block == NULL || block == adc->block) && (channel_id == -1 || channel_id == adc->channel_id) && (gpio_id == -1 || gpio_id == adc->gpio_id)) {
|
|
return adc;
|
|
}
|
|
}
|
|
return NULL;
|
|
}
|
|
|
|
static void mp_machine_adc_print(const mp_print_t *print, mp_obj_t self_in, mp_print_kind_t kind) {
|
|
const machine_adc_obj_t *self = MP_OBJ_TO_PTR(self_in);
|
|
mp_printf(print, "ADC(Pin(%u), atten=%u)", self->gpio_id, madc_atten_get(self));
|
|
}
|
|
|
|
static void madc_atten_helper(const machine_adc_obj_t *self, mp_int_t atten) {
|
|
esp_err_t err;
|
|
if (self->block->unit_id == ADC_UNIT_1) {
|
|
err = adc1_config_channel_atten(self->channel_id, atten);
|
|
} else {
|
|
err = adc2_config_channel_atten(self->channel_id, atten);
|
|
}
|
|
if (err != ESP_OK) {
|
|
mp_raise_ValueError(MP_ERROR_TEXT("invalid atten"));
|
|
}
|
|
madc_atten_set(self, atten);
|
|
}
|
|
|
|
void madc_init_helper(const machine_adc_obj_t *self, size_t n_pos_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
|
|
enum {
|
|
ARG_atten,
|
|
};
|
|
|
|
static const mp_arg_t allowed_args[] = {
|
|
{ MP_QSTR_atten, MP_ARG_KW_ONLY | MP_ARG_INT, {.u_int = -1} },
|
|
};
|
|
|
|
mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
|
|
mp_arg_parse_all(n_pos_args, pos_args, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
|
|
|
|
mp_int_t atten = args[ARG_atten].u_int;
|
|
if (atten != -1) {
|
|
madc_atten_helper(self, atten);
|
|
} else if (madc_atten_get(self) == ADC_ATTEN_MAX) {
|
|
madc_atten_helper(self, ADC_ATTEN_DB_0);
|
|
}
|
|
}
|
|
|
|
static void mp_machine_adc_init_helper(machine_adc_obj_t *self, size_t n_pos_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
|
|
madc_init_helper(self, n_pos_args, pos_args, kw_args);
|
|
}
|
|
|
|
static mp_obj_t mp_machine_adc_make_new(const mp_obj_type_t *type, size_t n_pos_args, size_t n_kw_args, const mp_obj_t *args) {
|
|
mp_arg_check_num(n_pos_args, n_kw_args, 1, MP_OBJ_FUN_ARGS_MAX, true);
|
|
gpio_num_t gpio_id = machine_pin_get_id(args[0]);
|
|
const machine_adc_obj_t *self = madc_search_helper(NULL, -1, gpio_id);
|
|
if (!self) {
|
|
mp_raise_ValueError(MP_ERROR_TEXT("invalid pin"));
|
|
}
|
|
|
|
if (self->block->width == -1) {
|
|
madcblock_bits_helper(self->block, self->block->bits);
|
|
}
|
|
|
|
mp_map_t kw_args;
|
|
mp_map_init_fixed_table(&kw_args, n_kw_args, args + n_pos_args);
|
|
madc_init_helper(self, n_pos_args - 1, args + 1, &kw_args);
|
|
|
|
return MP_OBJ_FROM_PTR(self);
|
|
}
|
|
|
|
static mp_obj_t mp_machine_adc_block(machine_adc_obj_t *self) {
|
|
return MP_OBJ_FROM_PTR(self->block);
|
|
}
|
|
|
|
static mp_int_t mp_machine_adc_read(machine_adc_obj_t *self) {
|
|
mp_int_t raw = madcblock_read_helper(self->block, self->channel_id);
|
|
return raw;
|
|
}
|
|
|
|
static mp_int_t mp_machine_adc_read_u16(machine_adc_obj_t *self) {
|
|
mp_uint_t raw = madcblock_read_helper(self->block, self->channel_id);
|
|
// Scale raw reading to 16 bit value using a Taylor expansion (for 8 <= bits <= 16)
|
|
mp_int_t bits = self->block->bits;
|
|
mp_uint_t u16 = raw << (16 - bits) | raw >> (2 * bits - 16);
|
|
return u16;
|
|
}
|
|
|
|
static mp_int_t mp_machine_adc_read_uv(machine_adc_obj_t *self) {
|
|
adc_atten_t atten = madc_atten_get(self);
|
|
return madcblock_read_uv_helper(self->block, self->channel_id, atten);
|
|
}
|
|
|
|
static void mp_machine_adc_atten_set(machine_adc_obj_t *self, mp_int_t atten) {
|
|
madc_atten_helper(self, atten);
|
|
}
|
|
|
|
static void mp_machine_adc_width_set(machine_adc_obj_t *self, mp_int_t width) {
|
|
madcblock_bits_helper(self->block, width);
|
|
}
|