diff --git a/zynq/zedboard-bsp/Cargo.toml b/zynq/zedboard-bsp/Cargo.toml index 249959f..4d7c321 100644 --- a/zynq/zedboard-bsp/Cargo.toml +++ b/zynq/zedboard-bsp/Cargo.toml @@ -2,10 +2,16 @@ name = "zedboard-bsp" version = "0.1.0" edition = "2024" +description = "Board Support Package (BSP) for the Zedboard" +homepage = "https://egit.irs.uni-stuttgart.de/rust/zynq7000-rs" +repository = "https://egit.irs.uni-stuttgart.de/rust/zynq7000-rs" +license = "MIT OR Apache-2.0" +keywords = ["no-std", "zedboard", "bare-metal", "amd", "zynq7000"] +categories = ["embedded", "no-std", "hardware-support"] [dependencies] -zynq7000 = { path = "../zynq7000" } -zynq7000-hal = { path = "../zynq7000-hal" } +zynq7000 = { path = "../zynq7000", version = "0.1" } +zynq7000-hal = { path = "../zynq7000-hal", version = "0.1" } bitbybit = "1.4" arbitrary-int = "2" num_enum = { version = "0.7", default-features = false } diff --git a/zynq/zedboard-bsp/LICENSE-APACHE b/zynq/zedboard-bsp/LICENSE-APACHE new file mode 100644 index 0000000..16fe87b --- /dev/null +++ b/zynq/zedboard-bsp/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/zynq/zedboard-bsp/LICENSE-MIT b/zynq/zedboard-bsp/LICENSE-MIT new file mode 100644 index 0000000..8311204 --- /dev/null +++ b/zynq/zedboard-bsp/LICENSE-MIT @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2025 Robin A. Mueller + +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/zynq/zedboard-bsp/README.md b/zynq/zedboard-bsp/README.md index 8069743..39d215f 100644 --- a/zynq/zedboard-bsp/README.md +++ b/zynq/zedboard-bsp/README.md @@ -1,3 +1,7 @@ +[![Crates.io](https://img.shields.io/crates/v/zedboard-bsp)](https://crates.io/crates/zedboard-bsp) +[![docs.rs](https://img.shields.io/docsrs/zedboard-bsp)](https://docs.rs/zedboard-bsp) +[![ci](https://github.com/us-irs/zynq7000-rs/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/us-irs/zynq7000-rs/actions/workflows/ci.yml) + Zedboard Board Support Package (BSP) =========== diff --git a/zynq/zynq7000-embassy/Cargo.toml b/zynq/zynq7000-embassy/Cargo.toml index 8928c1c..6620fab 100644 --- a/zynq/zynq7000-embassy/Cargo.toml +++ b/zynq/zynq7000-embassy/Cargo.toml @@ -13,9 +13,7 @@ categories = ["embedded", "no-std", "hardware-support"] [dependencies] critical-section = "1" once_cell = { version = "1", default-features = false, features = ["critical-section"] } -zynq7000-hal = { path = "../zynq7000-hal" } +zynq7000-hal = { path = "../zynq7000-hal", version = "0.1" } -# embassy-time-driver = { git = "https://github.com/embassy-rs/embassy.git", branch = "main", version = "0.2" } -# embassy-time-queue-utils = { git = "https://github.com/embassy-rs/embassy.git", branch = "main", version = "0.1" } embassy-time-driver = "0.2" embassy-time-queue-utils = "0.3" diff --git a/zynq/zynq7000-embassy/README.md b/zynq/zynq7000-embassy/README.md index 1231e19..edcab4b 100644 --- a/zynq/zynq7000-embassy/README.md +++ b/zynq/zynq7000-embassy/README.md @@ -1,3 +1,7 @@ +[![Crates.io](https://img.shields.io/crates/v/zynq7000-embassy)](https://crates.io/crates/zynq7000-embassy) +[![docs.rs](https://img.shields.io/docsrs/zynq7000-embassy)](https://docs.rs/zynq7000-embassy) +[![ci](https://github.com/us-irs/zynq7000-rs/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/us-irs/zynq7000-rs/actions/workflows/ci.yml) + # Embassy-rs support for the AMD Zynq7000 SoC family This repository contains the [embassy-rs](https://github.com/embassy-rs/embassy) support for the diff --git a/zynq/zynq7000-hal/Cargo.toml b/zynq/zynq7000-hal/Cargo.toml index f5ffc47..32a081d 100644 --- a/zynq/zynq7000-hal/Cargo.toml +++ b/zynq/zynq7000-hal/Cargo.toml @@ -3,17 +3,17 @@ name = "zynq7000-hal" version = "0.1.0" authors = ["Robin Mueller "] edition = "2024" -description = "HAL for the Zynq7000 family of SoCs" +description = "Hardware Abstraction Layer (HAL) for the Zynq7000 family of SoCs" homepage = "https://egit.irs.uni-stuttgart.de/rust/zynq7000-rs" repository = "https://egit.irs.uni-stuttgart.de/rust/zynq7000-rs" license = "MIT OR Apache-2.0" -keywords = ["no-std", "hal", "amd", "zynq7000", "xilinx", "bare-metal"] +keywords = ["no-std", "hal", "amd", "zynq7000", "bare-metal"] categories = ["embedded", "no-std", "hardware-support"] [dependencies] cortex-ar = { version = "0.3" } -zynq7000 = { path = "../zynq7000" } -zynq7000-mmu = { path = "../zynq7000-mmu", version = "0.1.0" } +zynq7000 = { path = "../zynq7000", version = "0.1" } +zynq7000-mmu = { path = "../zynq7000-mmu", version = "0.1" } static_assertions = "1.1" bitbybit = "1.4" @@ -49,3 +49,7 @@ alloc = [] [dev-dependencies] approx = "0.5" + +[package.metadata.docs.rs] +features = ["alloc"] +rustdoc-args = ["--generate-link-to-definition"] diff --git a/zynq/zynq7000-hal/README.md b/zynq/zynq7000-hal/README.md index 03a371c..39922b1 100644 --- a/zynq/zynq7000-hal/README.md +++ b/zynq/zynq7000-hal/README.md @@ -1,3 +1,7 @@ +[![Crates.io](https://img.shields.io/crates/v/zynq7000-hal)](https://crates.io/crates/zynq7000-hal) +[![docs.rs](https://img.shields.io/docsrs/zynq7000-hal)](https://docs.rs/zynq7000-hal) +[![ci](https://github.com/us-irs/zynq7000-rs/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/us-irs/zynq7000-rs/actions/workflows/ci.yml) + # HAL for the AMD Zynq 7000 SoC family This repository contains the **H**ardware **A**bstraction **L**ayer (HAL), which is an additional diff --git a/zynq/zynq7000-hal/docs.sh b/zynq/zynq7000-hal/docs.sh deleted file mode 100755 index 28b3872..0000000 --- a/zynq/zynq7000-hal/docs.sh +++ /dev/null @@ -1,3 +0,0 @@ -#!/bin/sh -export RUSTDOCFLAGS="--cfg docsrs --generate-link-to-definition -Z unstable-options" -cargo +nightly doc --features alloc --open diff --git a/zynq/zynq7000-hal/src/lib.rs b/zynq/zynq7000-hal/src/lib.rs index 56390bf..f21c1b1 100644 --- a/zynq/zynq7000-hal/src/lib.rs +++ b/zynq/zynq7000-hal/src/lib.rs @@ -8,6 +8,7 @@ //! [embedded-hal](https://github.com/rust-embedded/embedded-hal) project, making it compatible with //! various drivers in the embedded rust ecosystem. #![no_std] +#![cfg_attr(docsrs, feature(doc_cfg))] #[cfg(feature = "alloc")] extern crate alloc; diff --git a/zynq/zynq7000-mmu/Cargo.toml b/zynq/zynq7000-mmu/Cargo.toml index 06946cf..6536869 100644 --- a/zynq/zynq7000-mmu/Cargo.toml +++ b/zynq/zynq7000-mmu/Cargo.toml @@ -3,6 +3,11 @@ name = "zynq7000-mmu" description = "Zynq7000 MMU structures" version = "0.1.0" edition = "2024" +license = "MIT OR Apache-2.0" +homepage = "https://egit.irs.uni-stuttgart.de/rust/zynq7000-rs" +repository = "https://egit.irs.uni-stuttgart.de/rust/zynq7000-rs" +keywords = ["no-std", "mmu", "bare-metal", "amd", "zynq7000"] +categories = ["embedded", "no-std", "hardware-support"] [dependencies] thiserror = { version = "2", default-features = false } diff --git a/zynq/zynq7000-mmu/LICENSE-APACHE b/zynq/zynq7000-mmu/LICENSE-APACHE new file mode 100644 index 0000000..16fe87b --- /dev/null +++ b/zynq/zynq7000-mmu/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/zynq/zynq7000-mmu/LICENSE-MIT b/zynq/zynq7000-mmu/LICENSE-MIT new file mode 100644 index 0000000..8311204 --- /dev/null +++ b/zynq/zynq7000-mmu/LICENSE-MIT @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2025 Robin A. Mueller + +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/zynq/zynq7000-mmu/README.md b/zynq/zynq7000-mmu/README.md new file mode 100644 index 0000000..cc009ce --- /dev/null +++ b/zynq/zynq7000-mmu/README.md @@ -0,0 +1,5 @@ +Zynq7000 Memory Management Unit (MMU) library +========= + +Dedicated library for MMU abstractions which can be used by both Zynq +runtime crates, PACs and HALs. diff --git a/zynq/zynq7000-mmu/src/lib.rs b/zynq/zynq7000-mmu/src/lib.rs index 82b625b..6c59afb 100644 --- a/zynq/zynq7000-mmu/src/lib.rs +++ b/zynq/zynq7000-mmu/src/lib.rs @@ -1,6 +1,9 @@ -//! The MMU structures live inside a dedicated shared crate so it can be used by both the Zynq -//! runtime crate and the HAL crate. +//! # Zynq7000 Memory Management Unit (MMU) +//! +//! Dedicated shared crate for Zynq7000 MMU abstractions which can be used by Zynq +//! runtime crates, PACs and HALs. #![no_std] +#![cfg_attr(docsrs, feature(doc_cfg))] use core::cell::UnsafeCell; use cortex_ar::mmu::L1Section; diff --git a/zynq/zynq7000-rt/Cargo.toml b/zynq/zynq7000-rt/Cargo.toml index 944fa4c..1f05ecf 100644 --- a/zynq/zynq7000-rt/Cargo.toml +++ b/zynq/zynq7000-rt/Cargo.toml @@ -7,15 +7,18 @@ description = "Run-time support for the Zynq7000 family of SoCs for running bare homepage = "https://egit.irs.uni-stuttgart.de/rust/zynq7000-rs" repository = "https://egit.irs.uni-stuttgart.de/rust/zynq7000-rs" license = "MIT OR Apache-2.0" -keywords = ["no-std", "arm", "cortex-a", "amd", "zynq7000"] +keywords = ["no-std", "rt", "cortex-a", "amd", "zynq7000"] categories = ["embedded", "no-std", "hardware-support"] [dependencies] cortex-a-rt = { version = "0.1", optional = true, features = ["vfp-dp"] } cortex-ar = { version = "0.3" } arbitrary-int = "2" -zynq7000-mmu = { path = "../zynq7000-mmu", version = "0.1.0" } +zynq7000-mmu = { path = "../zynq7000-mmu", version = "0.1" } [features] default = ["rt"] rt = ["dep:cortex-a-rt"] + +[package.metadata.docs.rs] +rustdoc-args = ["--generate-link-to-definition"] diff --git a/zynq/zynq7000-rt/LICENSE-APACHE b/zynq/zynq7000-rt/LICENSE-APACHE new file mode 100644 index 0000000..16fe87b --- /dev/null +++ b/zynq/zynq7000-rt/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/zynq/zynq7000-rt/LICENSE-MIT b/zynq/zynq7000-rt/LICENSE-MIT new file mode 100644 index 0000000..8311204 --- /dev/null +++ b/zynq/zynq7000-rt/LICENSE-MIT @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2025 Robin A. Mueller + +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/zynq/zynq7000-rt/README.md b/zynq/zynq7000-rt/README.md index b1e31c7..a58df33 100644 --- a/zynq/zynq7000-rt/README.md +++ b/zynq/zynq7000-rt/README.md @@ -1,3 +1,7 @@ +[![Crates.io](https://img.shields.io/crates/v/zynq7000-rt)](https://crates.io/crates/zynq7000-rt) +[![docs.rs](https://img.shields.io/docsrs/zynq7000-rt)](https://docs.rs/zynq7000-rt) +[![ci](https://github.com/us-irs/zynq7000-rs/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/us-irs/zynq7000-rs/actions/workflows/ci.yml) + Zynq7000 Rust Run-Time Support ======== @@ -21,10 +25,5 @@ crate to provide ARM vectors and the linker script. ## Re-Generating the MMU table The MMU table is a static flat map of 4096 entries for each 1 MB in the memory map. -It was generated using the `table-gen` binary tool. - -You can re-run the tool using - -```sh -cargo +stable --target run --bin table-gen --no-default-features --features tools -``` +It was generated using the [`mmu-table-gen`](https://egit.irs.uni-stuttgart.de/rust/zynq7000-rs/src/branch/main/tools/mmu-table-gen) +tool. diff --git a/zynq/zynq7000-rt/docs.sh b/zynq/zynq7000-rt/docs.sh deleted file mode 100755 index be49e6f..0000000 --- a/zynq/zynq7000-rt/docs.sh +++ /dev/null @@ -1,3 +0,0 @@ -#!/bin/sh -export RUSTDOCFLAGS="--cfg docsrs --generate-link-to-definition -Z unstable-options" -cargo +nightly doc --open diff --git a/zynq/zynq7000-rt/regen-table.sh b/zynq/zynq7000-rt/regen-table.sh deleted file mode 100755 index 4efe896..0000000 --- a/zynq/zynq7000-rt/regen-table.sh +++ /dev/null @@ -1,2 +0,0 @@ -#!/bin/bash -cargo +stable run --target $(rustc -vV | grep host | cut -d ' ' -f2) --bin table-gen --no-default-features --features tools diff --git a/zynq/zynq7000-rt/src/lib.rs b/zynq/zynq7000-rt/src/lib.rs index 6ae917e..b0efd60 100644 --- a/zynq/zynq7000-rt/src/lib.rs +++ b/zynq/zynq7000-rt/src/lib.rs @@ -8,6 +8,7 @@ //! - MMU table is specified as Rust code. //! - Modification to the stack setup code, because a different linker script is used. #![no_std] +#![cfg_attr(docsrs, feature(doc_cfg))] #[cfg(feature = "rt")] pub use cortex_a_rt::*; diff --git a/zynq/zynq7000/Cargo.toml b/zynq/zynq7000/Cargo.toml index 4de4921..c6dcb7b 100644 --- a/zynq/zynq7000/Cargo.toml +++ b/zynq/zynq7000/Cargo.toml @@ -3,11 +3,11 @@ name = "zynq7000" version = "0.1.0" authors = ["Robin Mueller "] edition = "2024" -description = "PAC for the Zynq7000 family of SoCs" +description = "Peripheral Access Crate (PAC) for the Zynq7000 family of SoCs" homepage = "https://egit.irs.uni-stuttgart.de/rust/zynq7000-rs" repository = "https://egit.irs.uni-stuttgart.de/rust/zynq7000-rs" license = "MIT OR Apache-2.0" -keywords = ["no-std", "arm", "cortex-a", "amd", "zynq7000"] +keywords = ["no-std", "pac", "bare-metal", "amd", "zynq7000"] categories = ["embedded", "no-std", "hardware-support"] [dependencies] @@ -23,5 +23,4 @@ once_cell = { version = "1", default-features = false, features = ["critical-sec approx = "0.5" [package.metadata.docs.rs] -all-features = true rustdoc-args = ["--generate-link-to-definition"] diff --git a/zynq/zynq7000/README.md b/zynq/zynq7000/README.md index cddaee7..cbc368e 100644 --- a/zynq/zynq7000/README.md +++ b/zynq/zynq7000/README.md @@ -1,8 +1,12 @@ -# PAC for the AMD Zynq 7000 SoC family +[![Crates.io](https://img.shields.io/crates/v/zynq7000)](https://crates.io/crates/zynq7000) +[![docs.rs](https://img.shields.io/docsrs/zynq7000)](https://docs.rs/zynq7000) +[![ci](https://github.com/us-irs/zynq7000-rs/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/us-irs/zynq7000-rs/actions/workflows/ci.yml) +# PAC for This repository contains the Peripheral Access Crate (PAC) for the AMD Zynq7000 SoC family. If you are interested in higher-level abstractions, it is recommended you visit -the `zynq7000-hal` HAL crate which build on top of this PAC. +the [`zynq7000-hal`](https://egit.irs.uni-stuttgart.de/rust/zynq7000-rs/src/branch/main/zynq/zynq7000-hal) +HAL crate which build on top of this PAC. Check out the documentation for more details. diff --git a/zynq/zynq7000/build.rs b/zynq/zynq7000/build.rs deleted file mode 100644 index c2bce4f..0000000 --- a/zynq/zynq7000/build.rs +++ /dev/null @@ -1,3 +0,0 @@ -fn main() { - println!("cargo:rerun-if-changed=build.rs"); -} diff --git a/zynq/zynq7000/docs.sh b/zynq/zynq7000/docs.sh deleted file mode 100755 index be49e6f..0000000 --- a/zynq/zynq7000/docs.sh +++ /dev/null @@ -1,3 +0,0 @@ -#!/bin/sh -export RUSTDOCFLAGS="--cfg docsrs --generate-link-to-definition -Z unstable-options" -cargo +nightly doc --open diff --git a/zynq/zynq7000/src/lib.rs b/zynq/zynq7000/src/lib.rs index d544bb0..7c11337 100644 --- a/zynq/zynq7000/src/lib.rs +++ b/zynq/zynq7000/src/lib.rs @@ -9,6 +9,7 @@ //! [The Zynq7000 HAL library](https://egit.irs.uni-stuttgart.de/rust/zynq7000-rs/src/branch/main/zynq7000-hal) //! contains such a HAL which builds on this PAC. #![no_std] +#![cfg_attr(docsrs, feature(doc_cfg))] use core::sync::atomic::{AtomicBool, Ordering};