forked from micropython/micropython
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Rework the coproc API #7359
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Rework the coproc API #7359
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,151 @@ | ||
| /* | ||
| * This file is part of the Micro Python project, http://micropython.org/ | ||
| * | ||
| * The MIT License (MIT) | ||
| * | ||
| * Copyright (c) 2022 microDev | ||
| * | ||
| * 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/Pin.h" | ||
| #include "shared-bindings/util.h" | ||
| #include "bindings/espulp/ULP.h" | ||
|
|
||
| #include "py/runtime.h" | ||
|
|
||
| //| class ULP: | ||
| //| def __init__(self): | ||
| //| """The ultra-low-power processor. | ||
| //| | ||
| //| Raises an exception if another ULP has been instantiated. This | ||
| //| ensures that is is only used by one piece of code at a time.""" | ||
| //| ... | ||
| STATIC mp_obj_t espulp_ulp_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *all_args) { | ||
| espulp_ulp_obj_t *self = m_new_obj(espulp_ulp_obj_t); | ||
| self->base.type = &espulp_ulp_type; | ||
| common_hal_espulp_ulp_construct(self); | ||
| return MP_OBJ_FROM_PTR(self); | ||
| } | ||
|
|
||
| STATIC espulp_ulp_obj_t *get_ulp_obj(mp_obj_t self_in) { | ||
| if (!mp_obj_is_type(self_in, &espulp_ulp_type)) { | ||
| mp_raise_TypeError_varg(translate("Expected a %q"), MP_QSTR_ULP); | ||
| } | ||
| espulp_ulp_obj_t *self = MP_OBJ_TO_PTR(self_in); | ||
| if (common_hal_espulp_ulp_deinited(self)) { | ||
| raise_deinited_error(); | ||
| } | ||
| return self; | ||
| } | ||
|
|
||
| //| def deinit(self) -> None: | ||
| //| """Deinitialises the ULP and releases it for another program.""" | ||
| //| ... | ||
| STATIC mp_obj_t espulp_ulp_deinit(mp_obj_t self_in) { | ||
| espulp_ulp_obj_t *self = get_ulp_obj(self_in); | ||
| common_hal_espulp_ulp_deinit(self); | ||
| return mp_const_none; | ||
| } | ||
| STATIC MP_DEFINE_CONST_FUN_OBJ_1(espulp_ulp_deinit_obj, espulp_ulp_deinit); | ||
|
|
||
| //| def __enter__(self) -> ULP: | ||
| //| """No-op used by Context Managers.""" | ||
| //| ... | ||
| // Provided by context manager helper. | ||
|
|
||
| //| def __exit__(self) -> None: | ||
| //| """Automatically deinitializes the hardware when exiting a context. See | ||
| //| :ref:`lifetime-and-contextmanagers` for more info.""" | ||
| //| ... | ||
| STATIC mp_obj_t espulp_ulp_obj___exit__(size_t n_args, const mp_obj_t *args) { | ||
| (void)n_args; | ||
| return espulp_ulp_deinit(args[0]); | ||
| } | ||
| STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(espulp_ulp___exit___obj, 4, 4, espulp_ulp_obj___exit__); | ||
|
|
||
| //| def run( | ||
| //| self, program: ReadableBuffer, *, pins: Sequence[microcontroller.Pin] = () | ||
| //| ) -> None: | ||
| //| """Loads the program into ULP memory and then runs the program. The given pins are | ||
| //| claimed and not reset until `halt()` is called. | ||
| //| | ||
| //| The program will continue to run even when the running Python is halted.""" | ||
| //| ... | ||
| STATIC mp_obj_t espulp_ulp_run(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) { | ||
| enum { ARG_program, ARG_pins }; | ||
| static const mp_arg_t allowed_args[] = { | ||
| { MP_QSTR_program, MP_ARG_REQUIRED | MP_ARG_OBJ}, | ||
| { MP_QSTR_pins, MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_obj = mp_const_empty_tuple} }, | ||
| }; | ||
|
|
||
| mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)]; | ||
| espulp_ulp_obj_t *self = get_ulp_obj(pos_args[0]); | ||
| mp_arg_parse_all(n_args - 1, pos_args + 1, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args); | ||
|
|
||
| mp_buffer_info_t bufinfo; | ||
| mp_get_buffer_raise(args[ARG_program].u_obj, &bufinfo, MP_BUFFER_READ); | ||
|
|
||
| mp_obj_t pins_in = args[ARG_pins].u_obj; | ||
| const size_t num_pins = (size_t)MP_OBJ_SMALL_INT_VALUE(mp_obj_len(pins_in)); | ||
|
|
||
| // The ULP only supports 21 pins on the ESP32-S2 and S3. So we can store it | ||
| // as a bitmask in a 32 bit number. The common-hal code does further checks. | ||
| uint32_t pin_mask = 0; | ||
|
|
||
| for (mp_uint_t i = 0; i < num_pins; i++) { | ||
| mp_obj_t pin_obj = mp_obj_subscr(pins_in, MP_OBJ_NEW_SMALL_INT(i), MP_OBJ_SENTINEL); | ||
| validate_obj_is_free_pin(pin_obj); | ||
| const mcu_pin_obj_t *pin = ((const mcu_pin_obj_t *)pin_obj); | ||
| if (pin->number >= 32) { | ||
| raise_ValueError_invalid_pin(); | ||
| } | ||
| pin_mask |= 1 << pin->number; | ||
| } | ||
|
|
||
| common_hal_espulp_ulp_run(self, bufinfo.buf, bufinfo.len, pin_mask); | ||
| return mp_const_none; | ||
| } | ||
| STATIC MP_DEFINE_CONST_FUN_OBJ_KW(espulp_ulp_run_obj, 2, espulp_ulp_run); | ||
|
|
||
| //| def halt(self) -> None: | ||
| //| """Halts the running program and releases the pins given in `run()`.""" | ||
| //| ... | ||
| //| | ||
| STATIC mp_obj_t espulp_ulp_halt(mp_obj_t self_in) { | ||
| common_hal_espulp_ulp_halt(get_ulp_obj(self_in)); | ||
| return mp_const_none; | ||
| } | ||
| STATIC MP_DEFINE_CONST_FUN_OBJ_1(espulp_ulp_halt_obj, espulp_ulp_halt); | ||
|
|
||
| STATIC const mp_rom_map_elem_t espulp_ulp_locals_table[] = { | ||
| { MP_ROM_QSTR(MP_QSTR_deinit), MP_ROM_PTR(&espulp_ulp_deinit_obj) }, | ||
| { MP_ROM_QSTR(MP_QSTR___enter__), MP_ROM_PTR(&mp_identity_obj) }, | ||
| { MP_ROM_QSTR(MP_QSTR___exit__), MP_ROM_PTR(&espulp_ulp___exit___obj) }, | ||
| { MP_ROM_QSTR(MP_QSTR_run), MP_ROM_PTR(&espulp_ulp_run_obj) }, | ||
| { MP_ROM_QSTR(MP_QSTR_halt), MP_ROM_PTR(&espulp_ulp_halt_obj) }, | ||
| }; | ||
| STATIC MP_DEFINE_CONST_DICT(espulp_ulp_locals_dict, espulp_ulp_locals_table); | ||
|
|
||
| const mp_obj_type_t espulp_ulp_type = { | ||
| { &mp_type_type }, | ||
| .name = MP_QSTR_ULP, | ||
| .make_new = espulp_ulp_make_new, | ||
| .locals_dict = (mp_obj_t)&espulp_ulp_locals_dict, | ||
| }; | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.