diff options
Diffstat (limited to 'cyw43/README.md')
| -rw-r--r-- | cyw43/README.md | 43 |
1 files changed, 26 insertions, 17 deletions
diff --git a/cyw43/README.md b/cyw43/README.md index 5b4a5d789..9e9f7a34c 100644 --- a/cyw43/README.md +++ b/cyw43/README.md | |||
| @@ -1,27 +1,36 @@ | |||
| 1 | # cyw43 | 1 | # cyw43 |
| 2 | 2 | ||
| 3 | Rust driver for the CYW43439 wifi chip, used in the Raspberry Pi Pico W. Implementation based on [Infineon/wifi-host-driver](https://github.com/Infineon/wifi-host-driver). | 3 | Rust driver for the CYW43439 wifi+bluetooth chip. Implementation based on [Infineon/wifi-host-driver](https://github.com/Infineon/wifi-host-driver). |
| 4 | 4 | ||
| 5 | ## Current status | 5 | Works on the following boards: |
| 6 | 6 | ||
| 7 | Working: | 7 | - Raspberry Pi Pico W (RP2040) |
| 8 | 8 | - Raspberry Pi Pico 2 W (RP2350A) | |
| 9 | - Station mode (joining an AP). | 9 | - Pimoroni Pico Plus 2 W (RP2350B) |
| 10 | - AP mode (creating an AP) | 10 | - Any board with Raspberry Pi RM2 radio module. |
| 11 | - Scanning | 11 | - Any board with the CYW43439 chip, and possibly others if the protocol is similar enough. |
| 12 | - Sending and receiving Ethernet frames. | ||
| 13 | - Using the default MAC address. | ||
| 14 | - [`embassy-net`](https://embassy.dev) integration. | ||
| 15 | - RP2040 PIO driver for the nonstandard half-duplex SPI used in the Pico W. | ||
| 16 | - Using IRQ for device events | ||
| 17 | - GPIO support (for LED on the Pico W) | ||
| 18 | 12 | ||
| 19 | TODO: | 13 | ## Features |
| 20 | 14 | ||
| 21 | - Setting a custom MAC address. | 15 | Working: |
| 22 | - Bus sleep (for power consumption optimization) | ||
| 23 | 16 | ||
| 24 | ## Running the examples | 17 | - WiFi support |
| 18 | - Station mode (joining an AP). | ||
| 19 | - AP mode (creating an AP) | ||
| 20 | - Scanning | ||
| 21 | - Sending and receiving Ethernet frames. | ||
| 22 | - Using the default MAC address. | ||
| 23 | - [`embassy-net`](https://embassy.dev) integration. | ||
| 24 | - RP2040 PIO driver for the nonstandard half-duplex SPI used in the Pico W. | ||
| 25 | - Using IRQ for device events, no busy polling. | ||
| 26 | - GPIO support (for LED on the Pico W). | ||
| 27 | - Bluetooth support | ||
| 28 | - Bluetooth Classic + LE HCI commands. | ||
| 29 | - Concurrent operation with WiFi. | ||
| 30 | - Implements the [bt-hci](https://crates.io/crates/bt-hci) controller traits. | ||
| 31 | - Works with the [TrouBLE](https://github.com/embassy-rs/trouble) bluetooth LE stack. Check its repo for examples using `cyw43`. | ||
| 32 | |||
| 33 | ## Running the WiFi examples | ||
| 25 | 34 | ||
| 26 | - Install `probe-rs` following the instructions at <https://probe.rs>. | 35 | - Install `probe-rs` following the instructions at <https://probe.rs>. |
| 27 | - `cd examples/rp` | 36 | - `cd examples/rp` |