diff --git a/.github/workflows/nix.yml b/.github/workflows/nix.yml
new file mode 100644
index 0000000..4525656
--- /dev/null
+++ b/.github/workflows/nix.yml
@@ -0,0 +1,30 @@
+name: Nix Related Actions
+
+on:
+ pull_request:
+ push:
+ branches: [main]
+
+jobs:
+ check:
+ name: Checks
+ runs-on: ubuntu-latest
+ strategy:
+ fail-fast: false
+ matrix:
+ command:
+ - treefmt --fail-on-change
+ - cargo check --all-features
+ - cargo clippy --all-features
+ - cargo test --all-features
+ - cargo doc --all-features
+ - run-nixos-integration-test
+ steps:
+ - uses: actions/checkout@v4
+ - uses: cachix/install-nix-action@v26
+ with:
+ nix_path: nixpkgs=channel:nixos-stable
+ extra_nix_config:
+ github_access_token: ${{ secrets.GITHUB_TOKEN }}
+ - name: ${{ matrix.command }}
+ run: nix develop --command ${{ matrix.command }}
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
deleted file mode 100644
index 3e8d45c..0000000
--- a/.gitlab-ci.yml
+++ /dev/null
@@ -1,63 +0,0 @@
-stages:
- - check
- - build
- - test
-
-# set defaults for all other jobs
-default:
- tags: [nix]
- before_script:
- - git config --global url."https://gitlab-ci-token:${CI_JOB_TOKEN}@gitlab.dlr.de/".insteadOf "ssh://git@gitlab.dlr.de"
- - mkdir -p ~/.config/nix
- - echo 'accept-flake-config = true' >> ~/.config/nix/nix.conf
- - echo 'experimental-features = nix-command flakes' >> ~/.config/nix/nix.conf
-
-checks:
- stage: check
- script:
- - nix develop --command run-checks
-
-variables:
- CARGO_EXTR_ARGS: "--all-features"
-
-rust-test:
- stage: test
- script:
- # pre-seed build cache
- - nix develop --command cargo build $CARGO_EXTRA_ARGS
- - nix develop --command cargo build --release $CARGO_EXTRA_ARGS
- # generate docs
- - nix develop --command cargo doc --all-features --document-private-items $CARGO_EXTRA_ARGS
- - |
- cat << EOF > target/doc/index.html
-
- EOF
- # generate clippy report
- - nix develop --command cargo clippy --message-format=json $CARGO_EXTRA_ARGS > clippy-lints.json
- - nix develop --command gitlab-clippy clippy-lints.json --output code-quality-report.json
- # run tests
- - nix develop --command cargo nextest run --profile ci $CARGO_EXTRA_ARGS
- - mv target/nextest/ci/junit.xml junit-debug.xml
- - nix develop --command cargo nextest run --profile ci --release $CARGO_EXTRA_ARGS
- - mv target/nextest/ci/junit.xml junit-release.xml
- artifacts:
- paths:
- [clippy-lints.json, code-quality-report.json, junit-**.xml, target/doc]
- reports:
- codequality: code-quality-report.json
- junit: junit-*.xml
-
-run-nixos-integration-test:
- stage: test
- script:
- - nix develop --command run-nixos-integration-test
-
-build-crates:
- stage: build
- script:
- - nix develop --command cargo build $CARGO_EXTRA_ARGS
-
-build-xng-images:
- stage: build
- script:
- - nix develop --command build-xng-images
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..bf660c4
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2024-03-27
+
+### Added
+
+- Initial release
diff --git a/CODEOWNERS b/CODEOWNERS
deleted file mode 100644
index bb1390e..0000000
--- a/CODEOWNERS
+++ /dev/null
@@ -1 +0,0 @@
-* @projekt-resilienz
diff --git a/LICENSE-APACHE b/LICENSE-APACHE
new file mode 100644
index 0000000..6b0b127
--- /dev/null
+++ b/LICENSE-APACHE
@@ -0,0 +1,203 @@
+
+ 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..d79d060
--- /dev/null
+++ b/LICENSE-MIT
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 The a653rs-router authors
+
+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 (including the next paragraph) 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
index 58e2a96..3913067 100644
--- a/README.md
+++ b/README.md
@@ -1,42 +1,50 @@
-# IO-Partition
+# a653rs-router
-This is a prototype of an IO-partition for an ARINC 653P4 compliant hypervisor.
-The project goal is to explore the possiblilties for network-transparent
-inter-partition APEX channels in the context of redundancy management and
-dynamic reconfiguration of IMA systems. It is developed in the memory-safe
-Rust programming language and uses [a653rs](https://github.com/DLR-FT/a653rs)
+This is a prototype of a message router for an ARINC 653 P4 compliant
+hypervisor. The project's goal is to explore the possiblilties for
+network-transparent inter-partition APEX channels in the context of redundancy
+management and dynamic reconfiguration of IMA systems. It is developed in the
+memory-safe Rust programming language and uses [a653rs](https://github.com/DLR-FT/a653rs)
to communicate with the hypervisor.
Keep in mind that this is a research project and it has not been developed and
tested according to DO-178C.
-## Development
+## License
-The development environment of this project is managed using [nix](https://nixos.org/download.html#download-nix).
-To enter the environment, run `nix develop`.
+Licensed under either of
-## Documentation
+- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
+- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
-```
-cargo doc --all --open
-```
+at your option.
-## Nightly features
+## Contribution
+
+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.
+
+## Development
-The echo example and support for Zynq7000 currently require a nightly compiler for support of const-generics.
-Other than that all crates should use only stable rust features.
+The development environment of this project is managed using [nix](https://
+nixos.org/download.html#download-nix). To enter the environment, run
+`nix develop`.
## Flashing the XNG image
-Building and flashing the FPGA image requires Vitis. Since the download is around 80 GiB large, it is not included in the devshell of this project.
+Building and flashing the FPGA image requires Vitis. Since the download is
+around 80 GiB large, it is not included in the devshell of this project.
Download it yourself and use the following shell to install it.
```
$ nix develop --no-write-lock-file github:nix-community/nix-environments#xilinx-vitis
```
-After installation, close fhs environment shell, open a new one and try to run Vitis.
-The UART examples use a specific configuration for the FPGA contained in [another project](https://gitlab.dlr.de/projekt-resilienz/vivado-coraz7-uart) which you need to compile and export.
+After installation, close fhs environment shell, open a new one and try to run
+Vitis. The UART examples use a specific configuration for the FPGA contained in
+[another project](https://gitlab.dlr.de/projekt-resilienz/vivado-coraz7-uart)
+which you need to compile and export.
```
$ source /opt/xilnx/Vitis/*/settings64.sh
diff --git a/a653rs-router-cfg/Cargo.toml b/a653rs-router-cfg/Cargo.toml
index 08a1376..67bbd62 100644
--- a/a653rs-router-cfg/Cargo.toml
+++ b/a653rs-router-cfg/Cargo.toml
@@ -1,8 +1,24 @@
[package]
name = "a653rs-router-cfg"
-description = "Compiles the configuration for the router to the postcard binary format"
version = "0.1.0"
edition = "2021"
+authors = [
+ "Tim Schubert ",
+]
+description = "Converts the configuration format for a653rs-router from YAML to postcard"
+license = "MIT OR Apache-2.0"
+keywords = [
+ "arinc",
+ "avionics",
+ "embedded",
+ "no_std",
+ "network"
+]
+categories = [
+ "aerospace",
+ "embedded",
+ "no_std"
+]
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
diff --git a/a653rs-router-linux/Cargo.toml b/a653rs-router-linux/Cargo.toml
index b8eb3f5..4d45a87 100644
--- a/a653rs-router-linux/Cargo.toml
+++ b/a653rs-router-linux/Cargo.toml
@@ -2,6 +2,23 @@
name = "a653rs-router-linux"
version = "0.1.0"
edition = "2021"
+authors = [
+ "Tim Schubert ",
+]
+description = "Instantiation of a653rs-router for a653rs-linux"
+license = "MIT OR Apache-2.0"
+keywords = [
+ "arinc",
+ "avionics",
+ "embedded",
+ "no_std",
+ "network"
+]
+categories = [
+ "aerospace",
+ "embedded",
+ "no_std"
+]
[features]
default = ["partition"]
diff --git a/a653rs-router-tests/Cargo.toml b/a653rs-router-tests/Cargo.toml
index d6fccc4..7809cc4 100644
--- a/a653rs-router-tests/Cargo.toml
+++ b/a653rs-router-tests/Cargo.toml
@@ -2,6 +2,8 @@
name = "a653rs-router-tests"
version = "0.1.0"
edition = "2021"
+license = "MIT OR Apache-2.0"
+description = "Tests for a653rs-router"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
diff --git a/a653rs-router-zynq7000/Cargo.toml b/a653rs-router-zynq7000/Cargo.toml
index 1fe3467..01b0107 100644
--- a/a653rs-router-zynq7000/Cargo.toml
+++ b/a653rs-router-zynq7000/Cargo.toml
@@ -2,6 +2,23 @@
name = "a653rs-router-zynq7000"
version = "0.1.0"
edition = "2021"
+authors = [
+ "Tim Schubert ",
+]
+description = "Instantiation of a653rs-router for a653rs-xng on Zynq7000"
+license = "MIT OR Apache-2.0"
+keywords = [
+ "arinc",
+ "avionics",
+ "embedded",
+ "no_std",
+ "network"
+]
+categories = [
+ "aerospace",
+ "embedded",
+ "no_std"
+]
[features]
log = [
diff --git a/a653rs-router/Cargo.toml b/a653rs-router/Cargo.toml
index b30cfba..054b62b 100644
--- a/a653rs-router/Cargo.toml
+++ b/a653rs-router/Cargo.toml
@@ -2,6 +2,23 @@
name = "a653rs-router"
version = "0.1.0"
edition = "2021"
+authors = [
+ "Tim Schubert ",
+]
+license = "MIT OR Apache-2.0"
+keywords = [
+ "arinc",
+ "avionics",
+ "embedded",
+ "no_std",
+ "network"
+]
+description = "ARINC 653 message router based on a653rs"
+categories = [
+ "aerospace",
+ "embedded",
+ "no_std"
+]
[features]
log = ["dep:log"]
diff --git a/examples/echo/Cargo.toml b/examples/echo/Cargo.toml
index 4dc11ab..ca49c38 100644
--- a/examples/echo/Cargo.toml
+++ b/examples/echo/Cargo.toml
@@ -2,6 +2,24 @@
name = "echo"
version = "0.1.0"
edition = "2021"
+authors = [
+ "Tim Schubert ",
+ "Breitmoser-Widdecke, Nora Kristin "
+]
+license = "MIT OR Apache-2.0"
+keywords = [
+ "arinc",
+ "avionics",
+ "embedded",
+ "no_std",
+ "network"
+]
+description = "ARINC 653 application partition for sending and receiving echo messages"
+categories = [
+ "aerospace",
+ "embedded",
+ "no_std"
+]
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
diff --git a/shell.nix b/shell.nix
index 17bac47..0d05d0b 100644
--- a/shell.nix
+++ b/shell.nix
@@ -27,6 +27,7 @@ pkgs.devshell.mkShell {
set +x
treefmt --fail-on-change
cargo check --all-features
+ cargo clippy --all-features
cargo test --all-features
cargo doc --all-features
'';
diff --git a/small-trace-gpio/Cargo.toml b/small-trace-gpio/Cargo.toml
index 288cac9..9a3e22f 100644
--- a/small-trace-gpio/Cargo.toml
+++ b/small-trace-gpio/Cargo.toml
@@ -1,8 +1,9 @@
[package]
name = "small-trace-gpio"
-description = "Tracer for writing traces to GPIOs"
version = "0.1.0"
edition = "2021"
+license = "MIT OR Apache-2.0"
+description = "Implementation of small-trace using GPIOs on the CoraZ7"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
diff --git a/small-trace/Cargo.toml b/small-trace/Cargo.toml
index 046e707..a79f6ee 100644
--- a/small-trace/Cargo.toml
+++ b/small-trace/Cargo.toml
@@ -2,6 +2,8 @@
name = "small-trace"
version = "0.1.0"
edition = "2021"
+license = "MIT OR Apache-2.0"
+description = "Traits for low-overhead instrumentation-based tracing"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html