Thanks to visit codestin.com
Credit goes to github.com

Skip to content

extmod: Create a common cyw43 config header, apply mDNS fix in it. #17092

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

Conversation

projectgus
Copy link
Contributor

@projectgus projectgus commented Apr 8, 2025

Summary

  • First commit creates a new extmod/cyw43_config_common.h header with the common macros from ports which use CYW43 Wi-fi driver. There's more refactoring that could be done here (for example a cyw43_sdio_common.h header) but I've limited myself to macros that are the same, or that appear effectively the same, on every port.
  • Second commit moves the rp2 LWIP mDNS resolver fix added in ports/rp2: Fix rp2 mDNS issue via new cyw43 driver hooks. #17057 into the new header, so it's now also applied on stm32 and mimxrt ports which use the CYW43 driver.

Testing

  • Connected a PYBD_SF2 to my local network, verified I could look up the host via mDNS.
  • Ran the multi_wlan tests with a RPI_PICO_W board and a PYBD_SF2 as the two nodes. This uncovered two pre-existing issues (not added in this PR):
    • The stm32 port logs DHCPS: updates when running as the AP, so the test fails on the additional output (at least easy to manually check for).
    • On both ports, the cyw43 driver doesn't like being a STA first and then switching to become an AP (even though the unit tests de-activate the unused interface). To run the two tests in sequence then I needed to trigger a hard reset in between. Will investigate more when time permits.
  • I have not been able to test mimxrt as I have no suitable hardware. If I understand ports/mimxrt: Add CYW43 WiFi/BT support. #11397 correctly then no such widely available board exists, the only mimxrt+cyw43 users have added a CYW43 module to custom hardware or an eval board.

Trade-offs and Alternatives

  • Could keep the per-port config headers but it makes it harder to verify consistent behaviour between the different ports, and to apply non-port-specific changes like the mDNS resolver fix.

@projectgus projectgus added port-stm32 extmod Relates to extmod/ directory in source port-mimxrt port-rp2 labels Apr 8, 2025
@projectgus
Copy link
Contributor Author

@dpgeorge BTW I haven't forgotten our discussion about network_cyw43.h. I have a proposed refactor that covers this, but it turned out independent from this one.

Copy link

codecov bot commented Apr 8, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.54%. Comparing base (45e4deb) to head (d00eab4).
Report is 2 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master   #17092   +/-   ##
=======================================
  Coverage   98.54%   98.54%           
=======================================
  Files         169      169           
  Lines       21898    21898           
=======================================
  Hits        21580    21580           
  Misses        318      318           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link

github-actions bot commented Apr 8, 2025

Code size report:

   bare-arm:    +0 +0.000% 
minimal x86:    +0 +0.000% 
   unix x64:    +0 +0.000% standard
      stm32:    +0 +0.000% PYBV10
     mimxrt:    +0 +0.000% TEENSY40
        rp2:    +0 +0.000% RPI_PICO_W
       samd:    +0 +0.000% ADAFRUIT_ITSYBITSY_M4_EXPRESS
  qemu rv32:    +0 +0.000% VIRT_RV32

@projectgus projectgus added this to the release-1.26.0 milestone Apr 8, 2025
@projectgus projectgus force-pushed the refactor/cyw43_common_config branch from 83718b1 to df7dfc0 Compare April 15, 2025 01:35
@iabdalkader
Copy link
Contributor

Note that the old cywbt.c driver will be replaced with a new BTHCI Uart backend that's been recently added to cyw43 driver, which requires some additional config option (no big changes, see #16848). The new Alif port already uses the new BTHCI backend, and it could be switch to the common config: https://github.com/micropython/micropython/blob/master/ports/alif/cyw43_configport.h

@dpgeorge
Copy link
Member

Sorry @projectgus but this now needs rebasing after merging #16848.

@Gadgetoid
Copy link
Contributor

Some possible overlap between this and d6cfdca from #16057 ?

@projectgus projectgus force-pushed the refactor/cyw43_common_config branch 2 times, most recently from 12be4d6 to 09f64bb Compare May 1, 2025 02:24
@projectgus
Copy link
Contributor Author

The new Alif port already uses the new BTHCI backend, and it could be switch to the common config

Sorry @projectgus but this now needs rebasing after merging #16848.

I've rebased on top the BTHCI changes, and migrated the Alif port to the common cyw43 config. All ports build after updating, but I only have hardware to test stm32 PYBD_SF2 (confirmed Wi-Fi & BLE both work but didn't run complete tests).

I think the BTHCI macros could also be put into the common config but have left it out of this PR for now, same as SDIO.

@projectgus
Copy link
Contributor Author

projectgus commented May 1, 2025

Some possible overlap between this and d6cfdca from #16057 ?

I think some overlap, but as those changes are scoped to rp2 I think they're more or less a subset of these.

EDIT: Oops it was a while since I looked, I think that change is mostly breaking out the mpconfig layer of CYW43 config. Whereas this change is refactoring the driver-facing layer of CYW43 config (i.e. the layer that translates the mpconfig settings to the driver). So mostly orthogonal.

@projectgus projectgus requested review from iabdalkader and dpgeorge and removed request for iabdalkader May 1, 2025 06:33
@projectgus projectgus force-pushed the refactor/cyw43_common_config branch from 09f64bb to 2e687fe Compare May 2, 2025 02:33
@iabdalkader
Copy link
Contributor

I checked all changes for all the ports that I care about (so all except rp2), and they all look good. Also, I tested Alif port, and stm32 and both WiFi/BT are still working. I can't test mimxrt any time soon, maybe @kwagyeman can test it.

@kwagyeman
Copy link
Contributor

@iabdalkader - Pulled the latest of master of OpenMV, and then the micropython branched referenced, and applied the two commits and ran on the IMX. Bluetooth and WiFi both work.

@projectgus projectgus force-pushed the refactor/cyw43_common_config branch from 2e687fe to 786c3a2 Compare May 7, 2025 23:28
@projectgus
Copy link
Contributor Author

Thanks @iabdalkader and @kwagyeman for testing the other ports. Have removed the duplicate definition and rebased.

Copy link
Member

@dpgeorge dpgeorge left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apart from the few comments above, the refactoring looks good to me. I tested it on PYBD-SF6 and don't see any regressions.

@@ -0,0 +1,143 @@
/*
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure, but maybe this file should be extmod/cyw43-include/cyw43_config_common.h or extmod/cyw43-driver-include/cyw43_config_common.h?

There are other common include dirs with this naming scheme.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The other way we could do this is to move all three of extmod/network_cyw.* and this file to a directory like extmod/cyw43/. What do you think?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's leave it where it is for now. Can move it later if needed (eg in conjunction with factoring this into SDIO/SPI parts).

projectgus added 2 commits May 8, 2025 15:32
This is only a surface level refactor, some deeper refactoring would be
possible with (for example) the SDIO interface in mimxrt and stm32, or the
BTHCI interface which is is similar on supported ports. But sticking to
cases where the macros are the same across all ports.

This work was funded through GitHub Sponsors.

Signed-off-by: Angus Gratton <[email protected]>
This means the fix from dd1465e will also apply to stm32 and mimxrt ports
that use CYW43.

This work was funded through GitHub Sponsors.

Signed-off-by: Angus Gratton <[email protected]>
@projectgus projectgus force-pushed the refactor/cyw43_common_config branch from 786c3a2 to d00eab4 Compare May 8, 2025 05:33
@dpgeorge dpgeorge merged commit d00eab4 into micropython:master May 9, 2025
60 of 64 checks passed
@projectgus projectgus deleted the refactor/cyw43_common_config branch May 15, 2025 00:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
extmod Relates to extmod/ directory in source port-mimxrt port-rp2 port-stm32
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants