2022-06-30 06:01:02 +00:00
|
|
|
/*
|
|
|
|
|
* This file is part of the MicroPython project, http://micropython.org/
|
|
|
|
|
*
|
|
|
|
|
* The MIT License (MIT)
|
|
|
|
|
*
|
|
|
|
|
* Copyright (c) 2022 Damien P. George
|
|
|
|
|
*
|
|
|
|
|
* 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.
|
|
|
|
|
*/
|
|
|
|
|
#ifndef MICROPY_INCLUDED_RP2_CYW43_CONFIGPORT_H
|
|
|
|
|
#define MICROPY_INCLUDED_RP2_CYW43_CONFIGPORT_H
|
|
|
|
|
|
|
|
|
|
// The board-level config will be included here, so it can set some CYW43 values.
|
|
|
|
|
#include "py/mpconfig.h"
|
|
|
|
|
#include "py/mperrno.h"
|
|
|
|
|
#include "py/mphal.h"
|
2023-11-30 03:34:07 +00:00
|
|
|
#include "py/runtime.h"
|
2023-02-01 03:19:45 +00:00
|
|
|
#include "extmod/modnetwork.h"
|
2022-06-30 06:01:02 +00:00
|
|
|
#include "pendsv.h"
|
|
|
|
|
|
2022-07-25 15:37:03 +00:00
|
|
|
#define CYW43_WIFI_NVRAM_INCLUDE_FILE "wifi_nvram_43439.h"
|
2022-06-30 06:01:02 +00:00
|
|
|
#define CYW43_IOCTL_TIMEOUT_US (1000000)
|
|
|
|
|
#define CYW43_SLEEP_MAX (10)
|
|
|
|
|
#define CYW43_NETUTILS (1)
|
|
|
|
|
#define CYW43_USE_OTP_MAC (1)
|
|
|
|
|
|
|
|
|
|
#define CYW43_EPERM MP_EPERM // Operation not permitted
|
|
|
|
|
#define CYW43_EIO MP_EIO // I/O error
|
|
|
|
|
#define CYW43_EINVAL MP_EINVAL // Invalid argument
|
|
|
|
|
#define CYW43_ETIMEDOUT MP_ETIMEDOUT // Connection timed out
|
|
|
|
|
|
|
|
|
|
#define CYW43_THREAD_ENTER MICROPY_PY_LWIP_ENTER
|
|
|
|
|
#define CYW43_THREAD_EXIT MICROPY_PY_LWIP_EXIT
|
|
|
|
|
#define CYW43_THREAD_LOCK_CHECK
|
|
|
|
|
|
2023-10-03 02:32:48 +00:00
|
|
|
#define CYW43_HOST_NAME mod_network_hostname_data
|
2023-02-01 03:19:45 +00:00
|
|
|
|
2022-11-08 15:17:59 +00:00
|
|
|
#define CYW43_SDPCM_SEND_COMMON_WAIT \
|
|
|
|
|
if (get_core_num() == 0) { \
|
rp2: Fix lightsleep to work with interrupts and cyw43 driver.
This commit prevents the device from "hanging" when using lightsleep while
the WiFi chip is active.
Whenever the WiFi chip wants to interrupt the microcontroller to notify it
for a new package, it sets the CYW43_PIN_WL_HOST_WAKE pin to high,
triggering an IRQ. However, as polling the chip cannot happen in an
interrupt handler, it subsequently notifies the pendsv-service to do a poll
as soon as the interrupt handler ended. In order to prevent a new
interrupt from happening immediately afterwards, even before the poll has
run, the IRQ handler disables interrupts from the pin.
The first problem occurs, when a WiFi package arrives while the main loop
is in cyw43-code. In order to prevent concurrent access of the hardware,
the network code blocks pendsv from running again while entering lwIP code.
The same holds for direct cyw43 code (like changing the cyw43-gpios, i.e.
the LED on the Pico W). While the pendsv is disabled, interrupts can still
occur to schedule a poll (and disable further interrupts), but it will not
run. This can happen while the microcontroller is anywhere in rp2040 code.
In order to preserve power while waiting for cyw43 responses,
cyw43_configport.h defines CYW43_DO_IOCTL_WAIT and
CYW43_SDPCM_SEND_COMMON_WAIT to __WFI(). While this might work in most
cases, there are 2 edge cases where it fails:
- When an interrupt has already been received by the cyw43 stack, for
example due to an incoming ethernet packet.
- When the interrupt from the cyw43 response comes before the
microcontroller entered the __WFI() instruction.
When that happens, wfi will just block forever as no further interrupts are
received. The only way to safely use wfi to wake up from an interrupt is
inside a critical section, as this delays interrupts until the wfi is
entered, possibly resuming immediately until interrupts are reenabled and
the interrupt handler is run. Additionally this critical section needs to
check whether the interrupt has already been disabled and pendsv was
triggered, as in such a case, wfi can never be woken up, and needs to be
skipped, because there is already a package from the network chip waiting.
Note that this turns cyw43_yield into a nop (and thereby the cyw43-loops
into busy waits) from the second time onwards, as after the first call, a
pendsv request will definitely be pending. More logic could be added, to
explicitly enable the interrupt in this case.
Regarding lightsleep, this code has a similar problem. When an interrupt
occurs during lightsleep, the IRQ and pendsv handler and thereby poll are
run immediately, with the clocks still disabled, causing the SPI transfers
to fail. If we don't want to add complex logic inside the IRQ handler we
need to protect the whole lightsleep procedure form interrupts with a
critical section, exiting out early if an interrupt is pending for whatever
reason. Only then we can start to shut down clocks and only enable
interrupts when the system is ready again. Other interrupt handlers might
also be happy, that they are only run when the system is fully operational.
Tested on a Pico W, calling machine.lightsleep() within an endless loop and
pinging from the outside.
2022-09-27 09:37:34 +00:00
|
|
|
cyw43_yield(); \
|
2022-11-08 15:17:59 +00:00
|
|
|
} \
|
|
|
|
|
|
|
|
|
|
#define CYW43_DO_IOCTL_WAIT \
|
|
|
|
|
if (get_core_num() == 0) { \
|
rp2: Fix lightsleep to work with interrupts and cyw43 driver.
This commit prevents the device from "hanging" when using lightsleep while
the WiFi chip is active.
Whenever the WiFi chip wants to interrupt the microcontroller to notify it
for a new package, it sets the CYW43_PIN_WL_HOST_WAKE pin to high,
triggering an IRQ. However, as polling the chip cannot happen in an
interrupt handler, it subsequently notifies the pendsv-service to do a poll
as soon as the interrupt handler ended. In order to prevent a new
interrupt from happening immediately afterwards, even before the poll has
run, the IRQ handler disables interrupts from the pin.
The first problem occurs, when a WiFi package arrives while the main loop
is in cyw43-code. In order to prevent concurrent access of the hardware,
the network code blocks pendsv from running again while entering lwIP code.
The same holds for direct cyw43 code (like changing the cyw43-gpios, i.e.
the LED on the Pico W). While the pendsv is disabled, interrupts can still
occur to schedule a poll (and disable further interrupts), but it will not
run. This can happen while the microcontroller is anywhere in rp2040 code.
In order to preserve power while waiting for cyw43 responses,
cyw43_configport.h defines CYW43_DO_IOCTL_WAIT and
CYW43_SDPCM_SEND_COMMON_WAIT to __WFI(). While this might work in most
cases, there are 2 edge cases where it fails:
- When an interrupt has already been received by the cyw43 stack, for
example due to an incoming ethernet packet.
- When the interrupt from the cyw43 response comes before the
microcontroller entered the __WFI() instruction.
When that happens, wfi will just block forever as no further interrupts are
received. The only way to safely use wfi to wake up from an interrupt is
inside a critical section, as this delays interrupts until the wfi is
entered, possibly resuming immediately until interrupts are reenabled and
the interrupt handler is run. Additionally this critical section needs to
check whether the interrupt has already been disabled and pendsv was
triggered, as in such a case, wfi can never be woken up, and needs to be
skipped, because there is already a package from the network chip waiting.
Note that this turns cyw43_yield into a nop (and thereby the cyw43-loops
into busy waits) from the second time onwards, as after the first call, a
pendsv request will definitely be pending. More logic could be added, to
explicitly enable the interrupt in this case.
Regarding lightsleep, this code has a similar problem. When an interrupt
occurs during lightsleep, the IRQ and pendsv handler and thereby poll are
run immediately, with the clocks still disabled, causing the SPI transfers
to fail. If we don't want to add complex logic inside the IRQ handler we
need to protect the whole lightsleep procedure form interrupts with a
critical section, exiting out early if an interrupt is pending for whatever
reason. Only then we can start to shut down clocks and only enable
interrupts when the system is ready again. Other interrupt handlers might
also be happy, that they are only run when the system is fully operational.
Tested on a Pico W, calling machine.lightsleep() within an endless loop and
pinging from the outside.
2022-09-27 09:37:34 +00:00
|
|
|
cyw43_yield(); \
|
2022-11-08 15:17:59 +00:00
|
|
|
} \
|
2022-06-30 06:01:02 +00:00
|
|
|
|
|
|
|
|
#define CYW43_ARRAY_SIZE(a) MP_ARRAY_SIZE(a)
|
|
|
|
|
|
|
|
|
|
#define CYW43_HAL_PIN_MODE_INPUT MP_HAL_PIN_MODE_INPUT
|
|
|
|
|
#define CYW43_HAL_PIN_MODE_OUTPUT MP_HAL_PIN_MODE_OUTPUT
|
|
|
|
|
#define CYW43_HAL_PIN_PULL_NONE MP_HAL_PIN_PULL_NONE
|
|
|
|
|
#define CYW43_HAL_PIN_PULL_UP MP_HAL_PIN_PULL_UP
|
|
|
|
|
#define CYW43_HAL_PIN_PULL_DOWN MP_HAL_PIN_PULL_DOWN
|
|
|
|
|
|
|
|
|
|
#define CYW43_HAL_MAC_WLAN0 MP_HAL_MAC_WLAN0
|
|
|
|
|
|
|
|
|
|
// set in SDK board header
|
|
|
|
|
#define CYW43_NUM_GPIOS CYW43_WL_GPIO_COUNT
|
|
|
|
|
|
|
|
|
|
#define CYW43_POST_POLL_HOOK cyw43_post_poll_hook();
|
|
|
|
|
|
|
|
|
|
#define cyw43_hal_ticks_us mp_hal_ticks_us
|
|
|
|
|
#define cyw43_hal_ticks_ms mp_hal_ticks_ms
|
|
|
|
|
|
|
|
|
|
#define cyw43_hal_pin_obj_t mp_hal_pin_obj_t
|
|
|
|
|
#define cyw43_hal_pin_config mp_hal_pin_config
|
|
|
|
|
#define cyw43_hal_pin_read mp_hal_pin_read
|
|
|
|
|
#define cyw43_hal_pin_low mp_hal_pin_low
|
|
|
|
|
#define cyw43_hal_pin_high mp_hal_pin_high
|
|
|
|
|
|
|
|
|
|
#define cyw43_hal_get_mac mp_hal_get_mac
|
|
|
|
|
#define cyw43_hal_get_mac_ascii mp_hal_get_mac_ascii
|
|
|
|
|
#define cyw43_hal_generate_laa_mac mp_hal_generate_laa_mac
|
|
|
|
|
|
|
|
|
|
#define cyw43_schedule_internal_poll_dispatch(func) pendsv_schedule_dispatch(PENDSV_DISPATCH_CYW43, func)
|
|
|
|
|
|
2023-10-10 07:36:18 +00:00
|
|
|
// Bluetooth requires dynamic memory allocation to load its firmware (the allocation
|
|
|
|
|
// call is made from pico-sdk). This allocation is always done at thread-level, not
|
|
|
|
|
// from an IRQ, so is safe to delegate to the MicroPython GC heap.
|
2022-07-13 12:08:09 +00:00
|
|
|
#ifndef cyw43_malloc
|
2023-10-10 07:36:18 +00:00
|
|
|
#define cyw43_malloc(nmemb) m_tracked_calloc(nmemb, 1)
|
2022-07-13 12:08:09 +00:00
|
|
|
#endif
|
|
|
|
|
#ifndef cyw43_free
|
2023-10-10 07:36:18 +00:00
|
|
|
#define cyw43_free m_tracked_free
|
2022-07-13 12:08:09 +00:00
|
|
|
#endif
|
|
|
|
|
|
2022-06-30 06:01:02 +00:00
|
|
|
void cyw43_post_poll_hook(void);
|
rp2: Fix lightsleep to work with interrupts and cyw43 driver.
This commit prevents the device from "hanging" when using lightsleep while
the WiFi chip is active.
Whenever the WiFi chip wants to interrupt the microcontroller to notify it
for a new package, it sets the CYW43_PIN_WL_HOST_WAKE pin to high,
triggering an IRQ. However, as polling the chip cannot happen in an
interrupt handler, it subsequently notifies the pendsv-service to do a poll
as soon as the interrupt handler ended. In order to prevent a new
interrupt from happening immediately afterwards, even before the poll has
run, the IRQ handler disables interrupts from the pin.
The first problem occurs, when a WiFi package arrives while the main loop
is in cyw43-code. In order to prevent concurrent access of the hardware,
the network code blocks pendsv from running again while entering lwIP code.
The same holds for direct cyw43 code (like changing the cyw43-gpios, i.e.
the LED on the Pico W). While the pendsv is disabled, interrupts can still
occur to schedule a poll (and disable further interrupts), but it will not
run. This can happen while the microcontroller is anywhere in rp2040 code.
In order to preserve power while waiting for cyw43 responses,
cyw43_configport.h defines CYW43_DO_IOCTL_WAIT and
CYW43_SDPCM_SEND_COMMON_WAIT to __WFI(). While this might work in most
cases, there are 2 edge cases where it fails:
- When an interrupt has already been received by the cyw43 stack, for
example due to an incoming ethernet packet.
- When the interrupt from the cyw43 response comes before the
microcontroller entered the __WFI() instruction.
When that happens, wfi will just block forever as no further interrupts are
received. The only way to safely use wfi to wake up from an interrupt is
inside a critical section, as this delays interrupts until the wfi is
entered, possibly resuming immediately until interrupts are reenabled and
the interrupt handler is run. Additionally this critical section needs to
check whether the interrupt has already been disabled and pendsv was
triggered, as in such a case, wfi can never be woken up, and needs to be
skipped, because there is already a package from the network chip waiting.
Note that this turns cyw43_yield into a nop (and thereby the cyw43-loops
into busy waits) from the second time onwards, as after the first call, a
pendsv request will definitely be pending. More logic could be added, to
explicitly enable the interrupt in this case.
Regarding lightsleep, this code has a similar problem. When an interrupt
occurs during lightsleep, the IRQ and pendsv handler and thereby poll are
run immediately, with the clocks still disabled, causing the SPI transfers
to fail. If we don't want to add complex logic inside the IRQ handler we
need to protect the whole lightsleep procedure form interrupts with a
critical section, exiting out early if an interrupt is pending for whatever
reason. Only then we can start to shut down clocks and only enable
interrupts when the system is ready again. Other interrupt handlers might
also be happy, that they are only run when the system is fully operational.
Tested on a Pico W, calling machine.lightsleep() within an endless loop and
pinging from the outside.
2022-09-27 09:37:34 +00:00
|
|
|
extern volatile int cyw43_has_pending;
|
|
|
|
|
|
|
|
|
|
static inline void cyw43_yield(void) {
|
|
|
|
|
if (!cyw43_has_pending) {
|
2023-11-14 02:26:27 +00:00
|
|
|
best_effort_wfe_or_timeout(make_timeout_time_ms(1));
|
rp2: Fix lightsleep to work with interrupts and cyw43 driver.
This commit prevents the device from "hanging" when using lightsleep while
the WiFi chip is active.
Whenever the WiFi chip wants to interrupt the microcontroller to notify it
for a new package, it sets the CYW43_PIN_WL_HOST_WAKE pin to high,
triggering an IRQ. However, as polling the chip cannot happen in an
interrupt handler, it subsequently notifies the pendsv-service to do a poll
as soon as the interrupt handler ended. In order to prevent a new
interrupt from happening immediately afterwards, even before the poll has
run, the IRQ handler disables interrupts from the pin.
The first problem occurs, when a WiFi package arrives while the main loop
is in cyw43-code. In order to prevent concurrent access of the hardware,
the network code blocks pendsv from running again while entering lwIP code.
The same holds for direct cyw43 code (like changing the cyw43-gpios, i.e.
the LED on the Pico W). While the pendsv is disabled, interrupts can still
occur to schedule a poll (and disable further interrupts), but it will not
run. This can happen while the microcontroller is anywhere in rp2040 code.
In order to preserve power while waiting for cyw43 responses,
cyw43_configport.h defines CYW43_DO_IOCTL_WAIT and
CYW43_SDPCM_SEND_COMMON_WAIT to __WFI(). While this might work in most
cases, there are 2 edge cases where it fails:
- When an interrupt has already been received by the cyw43 stack, for
example due to an incoming ethernet packet.
- When the interrupt from the cyw43 response comes before the
microcontroller entered the __WFI() instruction.
When that happens, wfi will just block forever as no further interrupts are
received. The only way to safely use wfi to wake up from an interrupt is
inside a critical section, as this delays interrupts until the wfi is
entered, possibly resuming immediately until interrupts are reenabled and
the interrupt handler is run. Additionally this critical section needs to
check whether the interrupt has already been disabled and pendsv was
triggered, as in such a case, wfi can never be woken up, and needs to be
skipped, because there is already a package from the network chip waiting.
Note that this turns cyw43_yield into a nop (and thereby the cyw43-loops
into busy waits) from the second time onwards, as after the first call, a
pendsv request will definitely be pending. More logic could be added, to
explicitly enable the interrupt in this case.
Regarding lightsleep, this code has a similar problem. When an interrupt
occurs during lightsleep, the IRQ and pendsv handler and thereby poll are
run immediately, with the clocks still disabled, causing the SPI transfers
to fail. If we don't want to add complex logic inside the IRQ handler we
need to protect the whole lightsleep procedure form interrupts with a
critical section, exiting out early if an interrupt is pending for whatever
reason. Only then we can start to shut down clocks and only enable
interrupts when the system is ready again. Other interrupt handlers might
also be happy, that they are only run when the system is fully operational.
Tested on a Pico W, calling machine.lightsleep() within an endless loop and
pinging from the outside.
2022-09-27 09:37:34 +00:00
|
|
|
}
|
|
|
|
|
}
|
2022-06-30 06:01:02 +00:00
|
|
|
|
|
|
|
|
static inline void cyw43_delay_us(uint32_t us) {
|
|
|
|
|
uint32_t start = mp_hal_ticks_us();
|
|
|
|
|
while (mp_hal_ticks_us() - start < us) {
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
static inline void cyw43_delay_ms(uint32_t ms) {
|
2023-11-14 05:18:55 +00:00
|
|
|
mp_hal_delay_ms(ms);
|
2022-06-30 06:01:02 +00:00
|
|
|
}
|
|
|
|
|
|
2023-11-30 03:34:07 +00:00
|
|
|
#define CYW43_EVENT_POLL_HOOK mp_event_handle_nowait()
|
2022-07-14 17:11:34 +00:00
|
|
|
|
2022-06-30 06:01:02 +00:00
|
|
|
#endif // MICROPY_INCLUDED_RP2_CYW43_CONFIGPORT_H
|