From 0529cca04a7cf3809736e5cb4b453374c1273617 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jakub=20Hlusi=C4=8Dka?= Date: Thu, 26 Feb 2026 00:35:57 +0100 Subject: [PATCH] init --- .cargo/config.toml | 28 ++++++ .gitignore | 24 +++++ .vscode/settings.json | 8 ++ Cargo.toml | 32 ++++++ LICENSE-APACHE | 201 +++++++++++++++++++++++++++++++++++++ LICENSE-MIT | 25 +++++ README.md | 18 ++++ justfile | 65 ++++++++++++ rust-toolchain-risc-v.toml | 4 + rust-toolchain-xtensa.toml | 2 + src/lib.rs | 18 ++++ 11 files changed, 425 insertions(+) create mode 100644 .cargo/config.toml create mode 100644 .gitignore create mode 100644 .vscode/settings.json create mode 100644 Cargo.toml create mode 100644 LICENSE-APACHE create mode 100644 LICENSE-MIT create mode 100644 README.md create mode 100644 justfile create mode 100644 rust-toolchain-risc-v.toml create mode 100644 rust-toolchain-xtensa.toml create mode 100644 src/lib.rs diff --git a/.cargo/config.toml b/.cargo/config.toml new file mode 100644 index 0000000..0999bc4 --- /dev/null +++ b/.cargo/config.toml @@ -0,0 +1,28 @@ +[build] +# target = "riscv32imac-unknown-none-elf" +# target = "riscv32imc-unknown-none-elf" +# target = "xtensa-esp32s2-none-elf" +# target = "xtensa-esp32s3-none-elf" +# target = "xtensa-esp32-none-elf" + +[target.'cfg(target_arch = "riscv32")'] +runner = "espflash flash --monitor" +rustflags = [ + "-C", "link-arg=-Tlinkall.x", + "-C", "force-frame-pointers", +] + +[target.'cfg(target_arch = "xtensa")'] +runner = "espflash flash --monitor" +rustflags = [ + # GNU LD + "-C", "link-arg=-Wl,-Tlinkall.x", + "-C", "link-arg=-nostartfiles", + + # LLD + # "-C", "link-arg=-Tlinkall.x", + # "-C", "linker=rust-lld", +] + +[unstable] +build-std = ["alloc", "core"] diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..431cd7b --- /dev/null +++ b/.gitignore @@ -0,0 +1,24 @@ +# Generated by Cargo +# will have compiled files and executables +debug/ +target/ + +# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries +# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html +Cargo.lock + +# These are backup files generated by rustfmt +**/*.rs.bk + +# MSVC Windows builds of rustc generate these, which store debugging information +*.pdb + +# RustRover +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ + +# Ignore to allow users changing the toolchain. +/rust-toolchain.toml diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..f10a2c7 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,8 @@ +{ + "[rust]": { + "editor.formatOnSave": true, + }, + // helps remove rust-analyser errors due to requiring a feature flag and target + "rust-analyzer.cargo.features": ["esp32s3"], + "rust-analyzer.cargo.target": "xtensa-esp32s3-none-elf", +} diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..221b9de --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,32 @@ +[package] +name = "esp-hal-bounce-buffers" +version = "0.1.0" +edition = "2024" +description = "An implementation of bounce buffers for uninterrupted transmission of data from external RAM to a destination peripheral" +repository = "https://forgejo.limeth.cz/limeth/esp-hal-bounce-buffers" +license = "MIT OR Apache-2.0" + +[package.metadata.docs.rs] +features = ["esp32s3", "esp-hal/unstable"] +targets = ["xtensa-esp32s3-none-elf"] + +[dependencies] +document-features = "^0.2.12" +esp-hal = { version = "~1.0", features = ["requires-unstable"] } + +[features] +#! ### Chip Support Feature Flags +## Target the ESP32-S3. +esp32s3 = ["esp-hal/esp32s3"] + +# TODO: Add support for the following targets: +# ## Target the ESP32. +# esp32 = ["esp-backtrace/esp32", "esp-hal/esp32", "esp-println/esp32", "esp-bootloader-esp-idf/esp32", "esp-rtos/esp32"] +# ## Target the ESP32-C3. +# esp32c3 = ["esp-backtrace/esp32c3", "esp-hal/esp32c3", "esp-println/esp32c3", "esp-bootloader-esp-idf/esp32c3", "esp-rtos/esp32c3"] +# ## Target the ESP32-C6. +# esp32c6 = ["esp-backtrace/esp32c6", "esp-hal/esp32c6", "esp-println/esp32c6", "esp-bootloader-esp-idf/esp32c6", "esp-rtos/esp32c6"] +# ## Target the ESP32-H2. +# esp32h2 = ["esp-backtrace/esp32h2", "esp-hal/esp32h2", "esp-println/esp32h2", "esp-bootloader-esp-idf/esp32h2", "esp-rtos/esp32h2"] +# ## Target the ESP32-S2. +# esp32s2 = ["esp-backtrace/esp32s2", "esp-hal/esp32s2", "esp-println/esp32s2", "esp-bootloader-esp-idf/esp32s2", "esp-rtos/esp32s2"] diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..d2c040e --- /dev/null +++ b/LICENSE-APACHE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +APPENDIX: How to apply the Apache License to your work. + +To apply the Apache License to your work, attach the following +boilerplate notice, with the fields enclosed by brackets "[]" +replaced with your own identifying information. (Don't include +the brackets!) The text should be enclosed in the appropriate +comment syntax for the file format. We also recommend that a +file or class name and description of purpose be included on the +same "printed page" as the copyright notice for easier +identification within third-party archives. + +Copyright [yyyy] [name of copyright owner] + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..5488743 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,25 @@ +Copyright 2024 The esp-rs Community + +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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..cf5c0e9 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# esp-hal-bounce-buffers + +An implementation of bounce buffers for uninterrupted transmission of data from external RAM to a destination peripheral + +## License + +Licensed under either of: + +- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) +- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) + +at your option. + +### Contribution notice + +Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in +the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without +any additional terms or conditions. diff --git a/justfile b/justfile new file mode 100644 index 0000000..a060381 --- /dev/null +++ b/justfile @@ -0,0 +1,65 @@ +# all: check-risc-v build-risc-v check-xtensa build-xtensa clippy +all: check-xtensa build-xtensa clippy + +clippy: + cargo clippy --features "esp32s3,esp-hal/unstable" --target=xtensa-esp32s3-none-elf --release + +# check-risc-v: build-esp32c3 build-esp32c6 build-esp32h2 + +# check-esp32c3: +# cargo check --features "esp32c3,esp-hal/unstable" --target=riscv32imc-unknown-none-elf --release +# check-esp32c6: +# cargo check --features "esp32c6,esp-hal/unstable" --target=riscv32imac-unknown-none-elf --release +# check-esp32h2: +# cargo check --features "esp32h2,esp-hal/unstable" --target=riscv32imac-unknown-none-elf --release + +# build-risc-v: build-esp32c3 build-esp32c6 build-esp32h2 + +# build-esp32c3: +# cargo +stable build --examples --features "esp32c3,esp-hal/unstable" --target=riscv32imc-unknown-none-elf --release +# build-esp32c6: +# cargo +stable build --examples --features "esp32c6,esp-hal/unstable" --target=riscv32imac-unknown-none-elf --release +# build-esp32h2: +# cargo +stable build --examples --features "esp32h2,esp-hal/unstable" --target=riscv32imac-unknown-none-elf --release + + +# check-xtensa: check-esp32s2 check-esp32s3 check-esp32 +check-xtensa: check-esp32s3 + +# check-esp32: +# cargo +esp check --features "esp32,esp-hal/unstable" --target=xtensa-esp32-none-elf --release +# check-esp32s2: +# cargo +esp check --features "esp32s2,esp-hal/unstable" --target=xtensa-esp32s2-none-elf --release +check-esp32s3: + cargo +esp check --features "esp32s3,esp-hal/unstable" --target=xtensa-esp32s3-none-elf --release + +# build-xtensa: build-esp32s2 build-esp32s3 build-esp32 +build-xtensa: build-esp32s3 + +# build-esp32: +# cargo +esp build --examples --features "esp32,esp-hal/unstable" --target=xtensa-esp32-none-elf --release +# build-esp32s2: +# cargo +esp build --examples --features "esp32s2,esp-hal/unstable" --target=xtensa-esp32s2-none-elf --release +build-esp32s3: + cargo +esp build --examples --features "esp32s3,esp-hal/unstable" --target=xtensa-esp32s3-none-elf --release + +# run-esp32c3 example: +# cargo +stable run --example {{example}} --features "esp32c3,esp-hal/unstable" --target=riscv32imc-unknown-none-elf --release +# run-esp32c6 example: +# cargo +stable run --example {{example}} --features "esp32c6,esp-hal/unstable" --target=riscv32imac-unknown-none-elf --release +# run-esp32h2 example: +# cargo +stable run --example {{example}} --features "esp32h2,esp-hal/unstable" --target=riscv32imac-unknown-none-elf --release +# run-esp32 example: +# cargo +esp run --example {{example}} --features "esp32,esp-hal/unstable" --target=xtensa-esp32-none-elf --release +# run-esp32s2 example: +# cargo +esp run --example {{example}} --features "esp32s2,esp-hal/unstable" --target=xtensa-esp32s2-none-elf --release +run-esp32s3 example: + cargo +esp run --example {{example}} --features "esp32s3,esp-hal/unstable" --target=xtensa-esp32s3-none-elf --release + +msrv-buzzer: + cargo msrv find --target xtensa-esp32s3-none-elf -- cargo check -p esp-hal-buzzer --features "esp32s3,esp-hal/unstable" --target xtensa-esp32s3-none-elf +msrv-smartled: + cargo msrv find --target xtensa-esp32s3-none-elf -- cargo check -p esp-hal-smartled --features "esp32s3,esp-hal/unstable" --target xtensa-esp32s3-none-elf + +docs: + RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --features "esp32s3,esp-hal/unstable" --target xtensa-esp32s3-none-elf diff --git a/rust-toolchain-risc-v.toml b/rust-toolchain-risc-v.toml new file mode 100644 index 0000000..23a7bd2 --- /dev/null +++ b/rust-toolchain-risc-v.toml @@ -0,0 +1,4 @@ +[toolchain] +channel = "stable" +components = ["rust-src"] +targets = ["riscv32imc-unknown-none-elf", "riscv32imac-unknown-none-elf"] diff --git a/rust-toolchain-xtensa.toml b/rust-toolchain-xtensa.toml new file mode 100644 index 0000000..a2f5ab5 --- /dev/null +++ b/rust-toolchain-xtensa.toml @@ -0,0 +1,2 @@ +[toolchain] +channel = "esp" diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..96383af --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,18 @@ +#![no_std] + +extern crate alloc; + +pub fn add(left: u64, right: u64) -> u64 { + left + right +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn it_works() { + let result = add(2, 2); + assert_eq!(result, 4); + } +}