aboutsummaryrefslogtreecommitdiff
path: root/cyw43-pio/README.md
diff options
context:
space:
mode:
authorUlf Lilleengen <[email protected]>2023-12-19 16:08:06 +0100
committerUlf Lilleengen <[email protected]>2023-12-19 16:08:06 +0100
commit39c166ef9b754c5caa44ef4dd4a4e216078dbcea (patch)
treecece1955c41b80d92bd8056cc265a91cf3d0cf79 /cyw43-pio/README.md
parent5e76c8b41a05c89652a6c53061107482adc4125f (diff)
docs: document public apis for cyw43 driver
Diffstat (limited to 'cyw43-pio/README.md')
-rw-r--r--cyw43-pio/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/cyw43-pio/README.md b/cyw43-pio/README.md
new file mode 100644
index 000000000..2b22db360
--- /dev/null
+++ b/cyw43-pio/README.md
@@ -0,0 +1,17 @@
1# cyw43-pio
2
3RP2040 PIO driver for the nonstandard half-duplex SPI used in the Pico W. The PIO driver offloads SPI communication with the WiFi chip and improves throughput.
4
5## Minimum supported Rust version (MSRV)
6
7Embassy is guaranteed to compile on the latest stable Rust version at the time of release. It might compile with older versions but that may change in any new patch release.
8
9## License
10
11This work is licensed under either of
12
13- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
14 <http://www.apache.org/licenses/LICENSE-2.0>)
15- MIT license ([LICENSE-MIT](LICENSE-MIT) or <http://opensource.org/licenses/MIT>)
16
17at your option.