WIFI & esp-hosted

[jnmar]

Hi,
Running 1.24.0
Ethernet network runs happily on a NUCLEO_STM32F767.
I am trying to set-up WIFI with the same NUCLEO_STM32F767 and the esp-hosted driver.
I have added MICROPY_PY_NETWORK_ESP_HOSTED=1 to make file.
Also added pins in mpconfigboard.h (SPI4 was chosen):

#define MICROPY_HW_SPI4_CLK (pin_E2)
#define MICROPY_HW_SPI4_MISO (pin_E5)
#define MICROPY_HW_SPI4_MOSI (pin_E6)

#define MICROPY_HW_WIFI_SPI_ID          (4)
#define MICROPY_HW_WIFI_SPI_CS          (pin_E3)
#define MICROPY_HW_WIFI_SPI_BAUDRATE    (25 * 1000 * 1000)

#define MICROPY_HW_WIFI_DATAREADY       (pin_E13)
#define MICROPY_HW_WIFI_HANDSHAKE       (pin_E11)
#define MICROPY_HW_WIFI_IRQ_PIN         (pin_B1)

#define MICROPY_HW_ESP_HOSTED_RESET     (pin_B2) 
#define MICROPY_HW_ESP_HOSTED_GPIO0     (pin_B6) 

Compiling runs fine.
extmod.mk in line 487 seems to take into account MICROPY_PY_NETWORK_ESP_HOSTED=1 as
esp_hosted_wifi.c, esp_hosted_netif.c & esp_hosted_hal.c matching .o and .P files are created in build/drivers/esp-hosted directory.

Running the following code:

  import network
     ...
        laner = network.LAN()
     ...

Ethernet network runs happily. But

        wlaner = network.WLAN(network.WLAN.IF_STA)

raises AttributeError: 'module' object has no attribute 'WLAN'

How can WLAN be declared ?

[robert-hh]

You have to add the esp_hosted interface for the MICROPY_PORT_NETWORK_INTERFACES in mpconfigport.h, similar to the code lines below:

#if MICROPY_PY_NETWORK_ESP_HOSTED
#define MICROPY_HW_NIC_ESP_HOSTED   { MP_ROM_QSTR(MP_QSTR_WLAN), MP_ROM_PTR(&mod_network_esp_hosted_type) },
#else
#define MICROPY_HW_NIC_ESP_HOSTED  
#endif

#ifndef MICROPY_BOARD_NETWORK_INTERFACES
#define MICROPY_BOARD_NETWORK_INTERFACES
#endif

#define MICROPY_PORT_NETWORK_INTERFACES \
    MICROPY_HW_NIC_ETH  \
    MICROPY_HW_NIC_CYW43 \
    MICROPY_HW_NIC_WIZNET5K \
    MICROPY_HW_NIC_ESP_HOSTED\
    MICROPY_BOARD_NETWORK_INTERFACES \

[jnmar]

I did what you suggested. Same error:
AttributeError: 'module' object has no attribute 'WLAN'

Note: in renesas-ra/configport.h, there is an additional line:

extern const struct _mp_obj_type_t mod_network_esp_hosted_type;

From line 213:

#if MICROPY_PY_NETWORK_ESP_HOSTED
extern const struct _mp_obj_type_t mod_network_esp_hosted_type;
#define MICROPY_HW_NIC_ESP_HOSTED   { MP_ROM_QSTR(MP_QSTR_WLAN), MP_ROM_PTR(&mod_network_esp_hosted_type) },
#else
#define MICROPY_HW_NIC_ESP_HOSTED
#endif

I tried both (with and without additional line), same error.

[robert-hh]

Did you also add MICROPY_HW_NIC_ESP_HOSTED to the list of MICROPY_PORT_NETWORK_INTERFACES?

[robert-hh]

I have added MICROPY_PY_NETWORK_ESP_HOSTED=1 to make file.

Did you add MICROPY_PY_NETWORK_ESP_HOSTED=1 to mpconfigboard.mk?

[jnmar]

No. I added MICROPY_PY_NETWORK_ESP_HOSTED=1 to the "upper" level make command (similarly to a MICROPY_VFS_LFS2=1).
By adding MICROPY_PY_NETWORK_ESP_HOSTED=1 to mpconfigboard.mk, build fails:

In file included from ../../py/runtime.h:29,
                 from ../../drivers/esp-hosted/esp_hosted_hal.c:36:
../../drivers/esp-hosted/esp_hosted_hal.c: In function 'esp_hosted_hal_init':
../../py/mpstate.h:312:40: error: 'mp_state_vm_t' {aka 'struct _mp_state_vm_t'} has no member named 'mp_wifi_spi'
  312 | #define MP_STATE_VM(x) (mp_state_ctx.vm.x)
      |                                        ^
./mpconfigport.h:233:23: note: in expansion of macro 'MP_STATE_VM'
  233 | #define MP_STATE_PORT MP_STATE_VM
      |                       ^~~~~~~~~~~
../../drivers/esp-hosted/esp_hosted_hal.c:76:5: note: in expansion of macro 'MP_STATE_PORT'
   76 |     MP_STATE_PORT(mp_wifi_spi) =
      |     ^~~~~~~~~~~~~
../../drivers/esp-hosted/esp_hosted_hal.c: In function 'esp_hosted_hal_deinit':
../../py/mpstate.h:312:40: error: 'mp_state_vm_t' {aka 'struct _mp_state_vm_t'} has no member named 'mp_wifi_spi'
  312 | #define MP_STATE_VM(x) (mp_state_ctx.vm.x)
      |                                        ^
./mpconfigport.h:233:23: note: in expansion of macro 'MP_STATE_VM'
  233 | #define MP_STATE_PORT MP_STATE_VM
      |                       ^~~~~~~~~~~
../../drivers/esp-hosted/esp_hosted_hal.c:108:5: note: in expansion of macro 'MP_STATE_PORT'
  108 |     MP_STATE_PORT(mp_wifi_spi) = MP_OBJ_NULL;
      |     ^~~~~~~~~~~~~
../../drivers/esp-hosted/esp_hosted_hal.c: In function 'esp_hosted_hal_spi_transfer':
../../py/mpstate.h:312:40: error: 'mp_state_vm_t' {aka 'struct _mp_state_vm_t'} has no member named 'mp_wifi_spi'
  312 | #define MP_STATE_VM(x) (mp_state_ctx.vm.x)
      |                                        ^
./mpconfigport.h:233:23: note: in expansion of macro 'MP_STATE_VM'
  233 | #define MP_STATE_PORT MP_STATE_VM
      |                       ^~~~~~~~~~~
../../drivers/esp-hosted/esp_hosted_hal.c:168:28: note: in expansion of macro 'MP_STATE_PORT'
  168 |     mp_obj_t mp_wifi_spi = MP_STATE_PORT(mp_wifi_spi);
      |                            ^~~~~~~~~~~~~
MPY automat/common/statuses.py
-e See https://github.com/micropython/micropython/wiki/Build-Troubleshooting

[robert-hh]

So esp_hosted support got not active before. Now it is. Did you clean the old build before starting the new build.

[jnmar]

Starting from scratch ( git clone https://github.com/micropython/micropython ).
Applying the above modifications. Build fails:

In file included from ../../py/objlist.h:29,
                 from ../../extmod/modnetwork.c:31:
./mpconfigport.h:217:75: error: 'mod_network_esp_hosted_type' undeclared here (not in a function)
  217 | #define MICROPY_HW_NIC_ESP_HOSTED {MP_ROM_QSTR(MP_QSTR_WLAN), MP_ROM_PTR(&mod_network_esp_hosted_type)},
      |                                                                           ^~~~~~~~~~~~~~~~~~~~~~~~~~~
../../py/obj.h:348:24: note: in definition of macro 'MP_ROM_PTR'
  348 | #define MP_ROM_PTR(p) (p)
      |                        ^
./mpconfigport.h:230:5: note: in expansion of macro 'MICROPY_HW_NIC_ESP_HOSTED'
  230 |     MICROPY_HW_NIC_ESP_HOSTED           \
      |     ^~~~~~~~~~~~~~~~~~~~~~~~~
../../extmod/modnetwork.c:166:5: note: in expansion of macro 'MICROPY_PORT_NETWORK_INTERFACES'
  166 |     MICROPY_PORT_NETWORK_INTERFACES
      |     ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-e See https://github.com/micropython/micropython/wiki/Build-Troubleshooting

Inserting line (as in renesas-ra/mpconfigport.h

extern const struct _mp_obj_type_t mod_network_esp_hosted_type;

So mpconfigport.h file is:

...
// extra constants
#define MICROPY_PORT_CONSTANTS       \
    MACHINE_BUILTIN_MODULE_CONSTANTS \
    PYB_BUILTIN_MODULE_CONSTANTS     \
    STM_BUILTIN_MODULE_CONSTANTS

#if MICROPY_PY_NETWORK_ESP_HOSTED
extern const struct _mp_obj_type_t mod_network_esp_hosted_type;
#define MICROPY_HW_NIC_ESP_HOSTED {MP_ROM_QSTR(MP_QSTR_WLAN), MP_ROM_PTR(&mod_network_esp_hosted_type)},
#else
#define MICROPY_HW_NIC_ESP_HOSTED
#endif

#ifndef MICROPY_BOARD_NETWORK_INTERFACES
#define MICROPY_BOARD_NETWORK_INTERFACES
#endif

#define MICROPY_PORT_NETWORK_INTERFACES \
    MICROPY_HW_NIC_ETH                  \
    MICROPY_HW_NIC_CYW43                \
    MICROPY_HW_NIC_WIZNET5K             \
    MICROPY_HW_NIC_ESP_HOSTED           \
    MICROPY_BOARD_NETWORK_INTERFACES

#define MP_STATE_PORT MP_STATE_VM

// type definitions for the specific machine

#define MICROPY_MAKE_POINTER_CALLABLE(p) ((void *)((uint32_t)(p) | 1))
...

Build fails (for sake of clarity ports/stm32 directory is duplicated into ports/IMU):

LINK build-NUCLEO_F767ZI/firmware.elf
/Applications/ArmGNUToolchain/13.3.rel1/arm-none-eabi/bin/../lib/gcc/arm-none-eabi/13.3.1/../../../../arm-none-eabi/bin/ld: build-NUCLEO_F767ZI/drivers/esp-hosted/esp_hosted_hal.o: in function `esp_hosted_pin_irq_callback':
/Volumes/USB_C_256GB/system/upython-1.25.preview/ports/IMU/../../drivers/esp-hosted/esp_hosted_hal.c:51:(.text.esp_hosted_pin_irq_callback+0x2): undefined reference to `mod_network_poll_events'
/Applications/ArmGNUToolchain/13.3.rel1/arm-none-eabi/bin/../lib/gcc/arm-none-eabi/13.3.1/../../../../arm-none-eabi/bin/ld: build-NUCLEO_F767ZI/drivers/esp-hosted/esp_hosted_hal.o: in function `esp_hosted_hal_spi_transfer':
/Volumes/USB_C_256GB/system/upython-1.25.preview/ports/IMU/../../drivers/esp-hosted/esp_hosted_hal.c:190:(.text.esp_hosted_hal_spi_transfer+0x9a): undefined reference to `mod_network_poll_events'
collect2: error: ld returned 1 exit status
make: *** [build-NUCLEO_F767ZI/firmware.elf] Error 1

[robert-hh]

So this function mod_network_poll_events() is missing, meaning that ESP_HOSTED cannot be added by just setting build flags. The place for mod_network_poll_events() would be mpnetworkport.c.

[jnmar]

Actually function mod_network_poll_events() is missing in stm32/mpnetworkport.c.
Function mod_network_poll_events() exists in renesas-ra/mpnetworkport.c. Copying

static void network_poll(mp_sched_node_t *node)
{
    // Run the lwIP internal updates
    sys_check_timeouts();

#if MICROPY_PY_NETWORK_ESP_HOSTED
    extern int esp_hosted_wifi_poll(void);
    // Poll the NIC for incoming data
    if (esp_hosted_wifi_poll() == -1)
    {
        soft_timer_remove(&network_timer);
    }
#endif
}

void mod_network_poll_events(void)
{
    mp_sched_schedule_node(&network_poll_node, network_poll);
}

from renesas-ra/mpnetworkport.c. into stm32/mpnetworkport.c, build now raises

CC mpnetworkport.c
mpnetworkport.c: In function 'network_poll':
mpnetworkport.c:116:9: error: implicit declaration of function 'soft_timer_remove' [-Werror=implicit-function-declaration]
  116 |         soft_timer_remove(&network_timer);
      |         ^~~~~~~~~~~~~~~~~
mpnetworkport.c:116:28: error: 'network_timer' undeclared (first use in this function)
  116 |         soft_timer_remove(&network_timer);
      |                            ^~~~~~~~~~~~~
mpnetworkport.c:116:28: note: each undeclared identifier is reported only once for each function it appears in
mpnetworkport.c: In function 'mod_network_poll_events':
mpnetworkport.c:123:29: error: 'network_poll_node' undeclared (first use in this function); did you mean 'network_poll'?
  123 |     mp_sched_schedule_node(&network_poll_node, network_poll);
      |                             ^~~~~~~~~~~~~~~~~
      |                             network_poll
cc1: all warnings being treated as errors
-e See https://github.com/micropython/micropython/wiki/Build-Troubleshooting

and function soft_timer_remove() does not exist in stm32 port, leading to a deep hole :)

[jnmar]

How can I contribute ?

[robert-hh]

By making a Pull Request (PR) with updated code. Make yourself familiar with this github feature.

[jnmar]

@andrewleech : You wrote here https://github.com/espressif/esp-hosted/issues/551 "I already know and use esp-hosted to provide wifi and bluetooth to host MCU's running micropython". Could you pls indicate which port was used ? I am willing to contribute on stm32 port, however I need some guidances. For instance code of another portage would help.

[andrewleech]

esp-hosted support is added / submitted to:

• samd port in https://github.com/micropython/micropython/pull/12464/files
• mimxrt port in mimxrt: Provide WiFi and BLE support for MIMXRT boards. #12937
• renesas port in https://github.com/micropython/micropython/pull/11405/commits

[robert-hh]

The samd port actually uses the nina esp32 firmware, I have a branch that uses the esp-hosted firmware. But that firmware does only fit into samd51x20 chips.
The mimxrt port uses esp-hosted for mimxrt1020 and up, and finally firmware for mimxrt 1010 and mimxrt1015.

[jnmar]

How the above mentionned solutions articulate with espressif/esp-hosted#522 (second comment on Nov, 3) and specifically with the generic MCU esp-hosted https://github.com/espressif/esp-hosted/tree/feature/esp_as_mcu_host ? Which solution is most suitable for being integrated within micropython in the long term perspective ?
The purpose is to "delegate" WIFI process to a co-processor, in a migration from an existing ethernet (based on a Nucleo board) to WIFI (based on custom board : stm32 + WIFI coprocessor).