circuitpython/shared-bindings/microcontroller/Processor.c

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

179 lines
6.8 KiB
C
Raw Normal View History

/*
* This file is part of the Micro Python project, http://micropython.org/
*
* The MIT License (MIT)
*
* Copyright (c) 2017 Dan Halbert for Adafruit Industries
*
* 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.
*/
#include "shared-bindings/microcontroller/__init__.h"
#include "shared-bindings/microcontroller/Processor.h"
#include <math.h>
#include <stdint.h>
2022-04-13 09:47:55 -04:00
#include "shared-bindings/util.h"
2022-04-13 09:47:55 -04:00
#include "shared/runtime/buffer_helper.h"
#include "shared/runtime/context_manager_helpers.h"
#include "py/mperrno.h"
#include "py/objtype.h"
#include "py/objproperty.h"
#include "py/runtime.h"
2022-04-13 09:47:55 -04:00
//| class Processor:
//| """Microcontroller CPU information and control
//|
//| Usage::
//|
//| import microcontroller
//| print(microcontroller.cpu.frequency)
//| print(microcontroller.cpu.temperature)
//|
//| Note that on chips with more than one cpu (such as the RP2040)
2021-01-28 17:06:30 -05:00
//| microcontroller.cpu will return the value for CPU 0.
//| To get values from other CPUs use microcontroller.cpus indexed by
//| the number of the desired cpu. i.e.
//|
2021-01-28 17:06:30 -05:00
//| print(microcontroller.cpus[0].temperature)
//| print(microcontroller.cpus[1].frequency)"""
//|
2020-07-03 14:23:34 -04:00
//| def __init__(self) -> None:
//| """You cannot create an instance of `microcontroller.Processor`.
//| Use `microcontroller.cpu` to access the sole instance available."""
//| ...
2020-07-25 04:58:37 -04:00
//| frequency: int
//| """The CPU operating frequency in Hertz.
//|
//| **Limitations:** On most boards, ``frequency`` is read-only. Setting
//| the ``frequency`` is possible on RP2040 boards and some i.MX boards.
//|
2023-04-19 20:04:54 -04:00
//| .. warning:: Overclocking likely voids your warranties and may reduce
//| the lifetime of the chip.
//|
//| .. warning:: Changing the frequency may cause issues with other
//| subsystems, such as USB, PWM, and PIO. To minimize issues, set the CPU
//| frequency before initializing other systems.
//| """
2022-04-13 09:47:55 -04:00
#if CIRCUITPY_SETTABLE_PROCESSOR_FREQUENCY
2022-04-14 06:45:16 -04:00
STATIC mp_obj_t mcu_processor_set_frequency(mp_obj_t self, mp_obj_t freq) {
uint32_t value_of_freq = (uint32_t)mp_arg_validate_int_min(mp_obj_get_int(freq), 0, MP_QSTR_frequency);
common_hal_mcu_processor_set_frequency(self, value_of_freq);
2022-04-13 09:47:55 -04:00
return mp_const_none;
}
2022-04-14 06:45:16 -04:00
MP_DEFINE_CONST_FUN_OBJ_2(mcu_processor_set_frequency_obj, mcu_processor_set_frequency);
#endif
2022-04-13 09:47:55 -04:00
STATIC mp_obj_t mcu_processor_get_frequency(mp_obj_t self) {
return mp_obj_new_int_from_uint(common_hal_mcu_processor_get_frequency());
}
MP_DEFINE_CONST_FUN_OBJ_1(mcu_processor_get_frequency_obj, mcu_processor_get_frequency);
#if CIRCUITPY_SETTABLE_PROCESSOR_FREQUENCY
MP_PROPERTY_GETSET(mcu_processor_frequency_obj,
(mp_obj_t)&mcu_processor_get_frequency_obj,
(mp_obj_t)&mcu_processor_set_frequency_obj);
#else
MP_PROPERTY_GETTER(mcu_processor_frequency_obj,
(mp_obj_t)&mcu_processor_get_frequency_obj);
#endif
//| reset_reason: microcontroller.ResetReason
//| """The reason the microcontroller started up from reset state."""
STATIC mp_obj_t mcu_processor_get_reset_reason(mp_obj_t self) {
return cp_enum_find(&mcu_reset_reason_type, common_hal_mcu_processor_get_reset_reason());
}
MP_DEFINE_CONST_FUN_OBJ_1(mcu_processor_get_reset_reason_obj, mcu_processor_get_reset_reason);
MP_PROPERTY_GETTER(mcu_processor_reset_reason_obj,
(mp_obj_t)&mcu_processor_get_reset_reason_obj);
2020-07-25 04:58:37 -04:00
//| temperature: Optional[float]
//| """The on-chip temperature, in Celsius, as a float. (read-only)
//|
2022-10-13 11:47:10 -04:00
//| Is `None` if the temperature is not available.
//|
//| **Limitations:** Not available on ESP32 or ESP32-S3. On small SAMD21 builds without external flash,
//| the reported temperature has reduced accuracy and precision, to save code space.
2022-10-13 11:47:10 -04:00
//| """
STATIC mp_obj_t mcu_processor_get_temperature(mp_obj_t self) {
float temperature = common_hal_mcu_processor_get_temperature();
return isnan(temperature) ? mp_const_none : mp_obj_new_float(temperature);
}
MP_DEFINE_CONST_FUN_OBJ_1(mcu_processor_get_temperature_obj, mcu_processor_get_temperature);
MP_PROPERTY_GETTER(mcu_processor_temperature_obj,
(mp_obj_t)&mcu_processor_get_temperature_obj);
2020-07-25 04:58:37 -04:00
//| uid: bytearray
//| """The unique id (aka serial number) of the chip as a `bytearray`. (read-only)"""
STATIC mp_obj_t mcu_processor_get_uid(mp_obj_t self) {
uint8_t raw_id[COMMON_HAL_MCU_PROCESSOR_UID_LENGTH];
common_hal_mcu_processor_get_uid(raw_id);
return mp_obj_new_bytearray(sizeof(raw_id), raw_id);
}
MP_DEFINE_CONST_FUN_OBJ_1(mcu_processor_get_uid_obj, mcu_processor_get_uid);
MP_PROPERTY_GETTER(mcu_processor_uid_obj,
(mp_obj_t)&mcu_processor_get_uid_obj);
2020-07-25 04:58:37 -04:00
//| voltage: Optional[float]
//| """The input voltage to the microcontroller, as a float. (read-only)
2019-10-12 15:42:15 -04:00
//|
//| Is `None` if the voltage is not available."""
//|
2019-10-12 15:42:15 -04:00
STATIC mp_obj_t mcu_processor_get_voltage(mp_obj_t self) {
float voltage = common_hal_mcu_processor_get_voltage();
return isnan(voltage) ? mp_const_none : mp_obj_new_float(voltage);
}
MP_DEFINE_CONST_FUN_OBJ_1(mcu_processor_get_voltage_obj, mcu_processor_get_voltage);
MP_PROPERTY_GETTER(mcu_processor_voltage_obj,
(mp_obj_t)&mcu_processor_get_voltage_obj);
2019-10-12 15:42:15 -04:00
STATIC const mp_rom_map_elem_t mcu_processor_locals_dict_table[] = {
{ MP_ROM_QSTR(MP_QSTR_frequency), MP_ROM_PTR(&mcu_processor_frequency_obj) },
{ MP_ROM_QSTR(MP_QSTR_reset_reason), MP_ROM_PTR(&mcu_processor_reset_reason_obj) },
{ MP_ROM_QSTR(MP_QSTR_temperature), MP_ROM_PTR(&mcu_processor_temperature_obj) },
{ MP_ROM_QSTR(MP_QSTR_uid), MP_ROM_PTR(&mcu_processor_uid_obj) },
2019-10-12 15:42:15 -04:00
{ MP_ROM_QSTR(MP_QSTR_voltage), MP_ROM_PTR(&mcu_processor_voltage_obj) },
};
STATIC MP_DEFINE_CONST_DICT(mcu_processor_locals_dict, mcu_processor_locals_dict_table);
2023-09-19 21:09:29 -04:00
MP_DEFINE_CONST_OBJ_TYPE(
mcu_processor_type,
MP_QSTR_Processor,
MP_TYPE_FLAG_NONE,
locals_dict, &mcu_processor_locals_dict
);