initial code

Signed-off-by: Martin Kröning <martin.kroening@eonerc.rwth-aachen.de>

Author: mkroening

.github/workflows/ci.yml

@@ -0,0 +1,54 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+  merge_group:
+
+env:
+  RUSTFLAGS: -Dwarnings
+  RUSTDOCFLAGS: -Dwarnings
+
+jobs:
+  check:
+    name: Check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+      - uses: taiki-e/install-action@cargo-hack
+      - run: cargo hack check --feature-powerset --exclude-features nightly --no-dev-deps
+
+  clippy:
+    name: Clippy
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+      - run: cargo clippy --features alloc,mmio,pci,zerocopy
+
+  doc:
+    name: Doc
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+      - run: cargo doc --features alloc,mmio,pci,zerocopy
+
+  fmt:
+    name: Format
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@nightly
+        with:
+          components: rustfmt
+      - run: cargo fmt --all --check
+
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+      - run: cargo test --features alloc,mmio,pci,zerocopy

Cargo.lock

@@ -1,6 +1,33 @@
 [package]
 name = "virtio-spec"
-version = "0.0.0"
+version = "0.1.0"
+authors = ["Martin Kröning <mkroening@posteo.net>"]
 edition = "2021"
-description = "Reserved."
+description = "Definitions from the Virtual I/O Device (VIRTIO) specification."
+repository = "https://github.com/rust-osdev/virtio-spec-rs"
 license = "MIT OR Apache-2.0"
+keywords = ["virtio", "specification", "driver", "net", "pci"]
+categories = ["external-ffi-bindings", "no-std::no-alloc"]
+
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+
+[dependencies]
+allocator-api2 = { version = "0.2", default-features = false, features = ["alloc"], optional = true }
+bitfield-struct = "0.8"
+bitflags = "2"
+endian-num = { version = "0.1", features = ["bitflags", "linux-types"] }
+num_enum = { version = "0.7", default-features = false }
+pci_types = { version = "0.10", optional = true }
+volatile = "0.6"
+volatile-macro = "0.6"
+zerocopy = { version = "0.7", optional = true, default-features = false }
+zerocopy-derive = { version = "0.7", optional = true }
+
+[features]
+alloc = ["dep:allocator-api2"]
+mmio = []
+nightly = ["allocator-api2/nightly"]
+pci = ["dep:pci_types"]
+zerocopy = ["dep:zerocopy", "dep:zerocopy-derive", "endian-num/zerocopy"]

Cargo.toml

@@ -174,28 +174,3 @@ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
    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.

LICENSE-APACHE

@@ -0,0 +1,29 @@
+# virtio-spec-rs
+
+[![Crates.io](https://img.shields.io/crates/v/virtio-spec)](https://crates.io/crates/virtio-spec)
+[![docs.rs](https://img.shields.io/docsrs/virtio-spec)](https://docs.rs/virtio-spec)
+[![CI](https://github.com/rust-osdev/virtio-spec-rs/actions/workflows/ci.yml/badge.svg)](https://github.com/rust-osdev/virtio-spec-rs/actions/workflows/ci.yml)
+
+This crate contains the Rust equivalents of the definitions from the [Virtual I/O Device (VIRTIO) Specification](https://github.com/oasis-tcs/virtio-spec).
+This crate aims to be unopinionated regarding actual VIRTIO drivers that are implemented on top of this crate.
+
+For API documentation, see the [docs].
+
+[docs]: https://docs.rs/virtio-spec
+
+## 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
+
+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.

README.md

@@ -0,0 +1,3 @@
+format_code_in_doc_comments = true
+group_imports = "StdExternalCrate"
+imports_granularity = "Module"