Skip to content

Commit e1ec6af

Browse files
dpgeorgedpgeorge
committed
extmod/modmachine: Provide common bindings for 6 bare-metal functions.
Minor changes for consistency are: - nrf gains: unique_id(), freq() [they do nothing] - samd: deepsleep() now resets after calling lightsleep() - esp32: lightsleep()/deepsleep() no longer take kw arg "sleep", instead it's positional to match others. also, passing 0 here will now do a 0ms sleep instead of acting like nothing was passed. reset_cause() no longer takes any args (before it would just ignore them) - mimxrt: freq() with an argument and lightsleep() both raise NotImplementedError Signed-off-by: Damien George <[email protected]>
1 parent 48b5a7b commit e1ec6af

29 files changed

+316
-381
lines changed

Diff for: ‎extmod/modmachine.c

+64
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,16 @@ STATIC void mp_machine_idle(void);
4343
NORETURN void mp_machine_bootloader(size_t n_args, const mp_obj_t *args);
4444
#endif
4545

46+
#if MICROPY_PY_MACHINE_BARE_METAL_FUNCS
47+
STATIC mp_obj_t mp_machine_unique_id(void);
48+
NORETURN STATIC void mp_machine_reset(void);
49+
STATIC mp_int_t mp_machine_reset_cause(void);
50+
STATIC mp_obj_t mp_machine_get_freq(void);
51+
STATIC void mp_machine_set_freq(size_t n_args, const mp_obj_t *args);
52+
STATIC void mp_machine_lightsleep(size_t n_args, const mp_obj_t *args);
53+
NORETURN STATIC void mp_machine_deepsleep(size_t n_args, const mp_obj_t *args);
54+
#endif
55+
4656
// The port can provide additional machine-module implementation in this file.
4757
#ifdef MICROPY_PY_MACHINE_INCLUDEFILE
4858
#include MICROPY_PY_MACHINE_INCLUDEFILE
@@ -67,6 +77,46 @@ STATIC mp_obj_t machine_idle(void) {
6777
}
6878
STATIC MP_DEFINE_CONST_FUN_OBJ_0(machine_idle_obj, machine_idle);
6979

80+
#if MICROPY_PY_MACHINE_BARE_METAL_FUNCS
81+
82+
STATIC mp_obj_t machine_unique_id(void) {
83+
return mp_machine_unique_id();
84+
}
85+
MP_DEFINE_CONST_FUN_OBJ_0(machine_unique_id_obj, machine_unique_id);
86+
87+
NORETURN STATIC mp_obj_t machine_reset(void) {
88+
mp_machine_reset();
89+
}
90+
MP_DEFINE_CONST_FUN_OBJ_0(machine_reset_obj, machine_reset);
91+
92+
STATIC mp_obj_t machine_reset_cause(void) {
93+
return MP_OBJ_NEW_SMALL_INT(mp_machine_reset_cause());
94+
}
95+
MP_DEFINE_CONST_FUN_OBJ_0(machine_reset_cause_obj, machine_reset_cause);
96+
97+
STATIC mp_obj_t machine_freq(size_t n_args, const mp_obj_t *args) {
98+
if (n_args == 0) {
99+
return mp_machine_get_freq();
100+
} else {
101+
mp_machine_set_freq(n_args, args);
102+
return mp_const_none;
103+
}
104+
}
105+
MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(machine_freq_obj, 0, 1, machine_freq);
106+
107+
STATIC mp_obj_t machine_lightsleep(size_t n_args, const mp_obj_t *args) {
108+
mp_machine_lightsleep(n_args, args);
109+
return mp_const_none;
110+
}
111+
MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(machine_lightsleep_obj, 0, 1, machine_lightsleep);
112+
113+
NORETURN STATIC mp_obj_t machine_deepsleep(size_t n_args, const mp_obj_t *args) {
114+
mp_machine_deepsleep(n_args, args);
115+
}
116+
MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(machine_deepsleep_obj, 0, 1, machine_deepsleep);
117+
118+
#endif
119+
70120
STATIC const mp_rom_map_elem_t machine_module_globals_table[] = {
71121
{ MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_machine) },
72122

@@ -75,14 +125,28 @@ STATIC const mp_rom_map_elem_t machine_module_globals_table[] = {
75125
{ MP_ROM_QSTR(MP_QSTR_mem16), MP_ROM_PTR(&machine_mem16_obj) },
76126
{ MP_ROM_QSTR(MP_QSTR_mem32), MP_ROM_PTR(&machine_mem32_obj) },
77127

128+
// Miscellaneous functions.
129+
#if MICROPY_PY_MACHINE_BARE_METAL_FUNCS
130+
{ MP_ROM_QSTR(MP_QSTR_unique_id), MP_ROM_PTR(&machine_unique_id_obj) },
131+
#endif
132+
78133
// Reset related functions.
79134
{ MP_ROM_QSTR(MP_QSTR_soft_reset), MP_ROM_PTR(&machine_soft_reset_obj) },
80135
#if MICROPY_PY_MACHINE_BOOTLOADER
81136
{ MP_ROM_QSTR(MP_QSTR_bootloader), MP_ROM_PTR(&machine_bootloader_obj) },
82137
#endif
138+
#if MICROPY_PY_MACHINE_BARE_METAL_FUNCS
139+
{ MP_ROM_QSTR(MP_QSTR_reset), MP_ROM_PTR(&machine_reset_obj) },
140+
{ MP_ROM_QSTR(MP_QSTR_reset_cause), MP_ROM_PTR(&machine_reset_cause_obj) },
141+
#endif
83142

84143
// Power related functions.
85144
{ MP_ROM_QSTR(MP_QSTR_idle), MP_ROM_PTR(&machine_idle_obj) },
145+
#if MICROPY_PY_MACHINE_BARE_METAL_FUNCS
146+
{ MP_ROM_QSTR(MP_QSTR_freq), MP_ROM_PTR(&machine_freq_obj) },
147+
{ MP_ROM_QSTR(MP_QSTR_lightsleep), MP_ROM_PTR(&machine_lightsleep_obj) },
148+
{ MP_ROM_QSTR(MP_QSTR_deepsleep), MP_ROM_PTR(&machine_deepsleep_obj) },
149+
#endif
86150

87151
// Functions for bit protocols.
88152
#if MICROPY_PY_MACHINE_BITSTREAM

Diff for: ‎extmod/modmachine.h

+6
Original file line numberDiff line numberDiff line change
@@ -241,6 +241,12 @@ NORETURN mp_obj_t machine_bootloader(size_t n_args, const mp_obj_t *args);
241241
void machine_bitstream_high_low(mp_hal_pin_obj_t pin, uint32_t *timing_ns, const uint8_t *buf, size_t len);
242242
mp_uint_t machine_time_pulse_us(mp_hal_pin_obj_t pin, int pulse_level, mp_uint_t timeout_us);
243243

244+
MP_DECLARE_CONST_FUN_OBJ_0(machine_unique_id_obj);
245+
MP_DECLARE_CONST_FUN_OBJ_0(machine_reset_obj);
246+
MP_DECLARE_CONST_FUN_OBJ_0(machine_reset_cause_obj);
247+
MP_DECLARE_CONST_FUN_OBJ_VAR_BETWEEN(machine_freq_obj);
248+
MP_DECLARE_CONST_FUN_OBJ_VAR_BETWEEN(machine_lightsleep_obj);
249+
MP_DECLARE_CONST_FUN_OBJ_VAR_BETWEEN(machine_deepsleep_obj);
244250
MP_DECLARE_CONST_FUN_OBJ_VAR_BETWEEN(machine_bootloader_obj);
245251
MP_DECLARE_CONST_FUN_OBJ_VAR_BETWEEN(machine_bitstream_obj);
246252
MP_DECLARE_CONST_FUN_OBJ_VAR_BETWEEN(machine_time_pulse_us_obj);

Diff for: ‎ports/cc3200/mods/modmachine.c

+15-26
Original file line numberDiff line numberDiff line change
@@ -56,16 +56,10 @@
5656
#endif
5757

5858
#define MICROPY_PY_MACHINE_EXTRA_GLOBALS \
59-
{ MP_ROM_QSTR(MP_QSTR_reset), MP_ROM_PTR(&machine_reset_obj) }, \
6059
MICROPY_PY_MACHINE_INFO_ENTRY \
61-
{ MP_ROM_QSTR(MP_QSTR_freq), MP_ROM_PTR(&machine_freq_obj) }, \
62-
{ MP_ROM_QSTR(MP_QSTR_unique_id), MP_ROM_PTR(&machine_unique_id_obj) }, \
6360
{ MP_ROM_QSTR(MP_QSTR_main), MP_ROM_PTR(&machine_main_obj) }, \
6461
{ MP_ROM_QSTR(MP_QSTR_rng), MP_ROM_PTR(&machine_rng_get_obj) }, \
6562
{ MP_ROM_QSTR(MP_QSTR_sleep), MP_ROM_PTR(&machine_lightsleep_obj) }, \
66-
{ MP_ROM_QSTR(MP_QSTR_lightsleep), MP_ROM_PTR(&machine_lightsleep_obj) }, \
67-
{ MP_ROM_QSTR(MP_QSTR_deepsleep), MP_ROM_PTR(&machine_deepsleep_obj) }, \
68-
{ MP_ROM_QSTR(MP_QSTR_reset_cause), MP_ROM_PTR(&machine_reset_cause_obj) }, \
6963
{ MP_ROM_QSTR(MP_QSTR_wake_reason), MP_ROM_PTR(&machine_wake_reason_obj) }, \
7064
\
7165
{ MP_ROM_QSTR(MP_QSTR_disable_irq), MP_ROM_PTR(&machine_disable_irq_obj) }, \
@@ -99,24 +93,20 @@ extern OsiTaskHandle svTaskHandle;
9993
extern OsiTaskHandle xSimpleLinkSpawnTaskHndl;
10094
#endif
10195

102-
103-
/// \module machine - functions related to the SoC
104-
///
105-
10696
MP_DECLARE_CONST_FUN_OBJ_0(machine_disable_irq_obj);
10797
MP_DECLARE_CONST_FUN_OBJ_VAR_BETWEEN(machine_enable_irq_obj);
10898

10999
/******************************************************************************/
110100
// MicroPython bindings;
111101

112-
STATIC mp_obj_t machine_reset(void) {
102+
NORETURN STATIC void mp_machine_reset(void) {
113103
// disable wlan
114104
wlan_stop(SL_STOP_TIMEOUT_LONG);
115105
// reset the cpu and it's peripherals
116106
MAP_PRCMMCUReset(true);
117-
return mp_const_none;
107+
for (;;) {
108+
}
118109
}
119-
STATIC MP_DEFINE_CONST_FUN_OBJ_0(machine_reset_obj, machine_reset);
120110

121111
#ifdef DEBUG
122112
STATIC mp_obj_t machine_info(uint n_args, const mp_obj_t *args) {
@@ -145,17 +135,19 @@ STATIC mp_obj_t machine_info(uint n_args, const mp_obj_t *args) {
145135
STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(machine_info_obj, 0, 1, machine_info);
146136
#endif
147137

148-
STATIC mp_obj_t machine_freq(void) {
138+
STATIC mp_obj_t mp_machine_get_freq(void) {
149139
return mp_obj_new_int(HAL_FCPU_HZ);
150140
}
151-
STATIC MP_DEFINE_CONST_FUN_OBJ_0(machine_freq_obj, machine_freq);
152141

153-
STATIC mp_obj_t machine_unique_id(void) {
142+
STATIC void mp_machine_set_freq(size_t n_args, const mp_obj_t *args) {
143+
mp_raise_NotImplementedError(NULL);
144+
}
145+
146+
STATIC mp_obj_t mp_machine_unique_id(void) {
154147
uint8_t mac[SL_BSSID_LENGTH];
155148
wlan_get_mac (mac);
156149
return mp_obj_new_bytes(mac, SL_BSSID_LENGTH);
157150
}
158-
STATIC MP_DEFINE_CONST_FUN_OBJ_0(machine_unique_id_obj, machine_unique_id);
159151

160152
STATIC mp_obj_t machine_main(mp_obj_t main) {
161153
if (mp_obj_is_str(main)) {
@@ -171,22 +163,19 @@ STATIC void mp_machine_idle(void) {
171163
__WFI();
172164
}
173165

174-
STATIC mp_obj_t machine_lightsleep(void) {
166+
STATIC void mp_machine_lightsleep(size_t n_args, const mp_obj_t *args) {
175167
pyb_sleep_sleep();
176-
return mp_const_none;
177168
}
178-
STATIC MP_DEFINE_CONST_FUN_OBJ_0(machine_lightsleep_obj, machine_lightsleep);
179169

180-
STATIC mp_obj_t machine_deepsleep (void) {
170+
NORETURN STATIC void mp_machine_deepsleep(size_t n_args, const mp_obj_t *args) {
181171
pyb_sleep_deepsleep();
182-
return mp_const_none;
172+
for (;;) {
173+
}
183174
}
184-
STATIC MP_DEFINE_CONST_FUN_OBJ_0(machine_deepsleep_obj, machine_deepsleep);
185175

186-
STATIC mp_obj_t machine_reset_cause (void) {
187-
return mp_obj_new_int(pyb_sleep_get_reset_cause());
176+
STATIC mp_int_t mp_machine_reset_cause(void) {
177+
return pyb_sleep_get_reset_cause();
188178
}
189-
STATIC MP_DEFINE_CONST_FUN_OBJ_0(machine_reset_cause_obj, machine_reset_cause);
190179

191180
STATIC mp_obj_t machine_wake_reason (void) {
192181
return mp_obj_new_int(pyb_sleep_get_wake_reason());

Diff for: ‎ports/cc3200/mpconfigport.h

+1
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,7 @@
122122
#define MICROPY_PY_TIME_INCLUDEFILE "ports/cc3200/mods/modtime.c"
123123
#define MICROPY_PY_MACHINE (1)
124124
#define MICROPY_PY_MACHINE_INCLUDEFILE "ports/cc3200/mods/modmachine.c"
125+
#define MICROPY_PY_MACHINE_BARE_METAL_FUNCS (1)
125126
#define MICROPY_PY_MACHINE_WDT (1)
126127
#define MICROPY_PY_MACHINE_WDT_INCLUDEFILE "ports/cc3200/mods/machine_wdt.c"
127128

0 commit comments

Comments
 (0)