From 5d85bbabd58540f525abe906c2f1e07ba0181b44 Mon Sep 17 00:00:00 2001 From: Yuekai Jia Date: Wed, 17 Jul 2024 14:30:18 +0800 Subject: [PATCH] Publish v0.1.0 to crates.io --- Cargo.toml | 8 ++++---- README.md | 9 +++++++++ src/lib.rs | 11 +++++------ 3 files changed, 18 insertions(+), 10 deletions(-) create mode 100644 README.md diff --git a/Cargo.toml b/Cargo.toml index 19161fd..69e588b 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,13 +1,13 @@ [package] -name = "arm_gic" +name = "arm_gicv2" version = "0.1.0" edition = "2021" authors = ["Yuekai Jia "] -description = "ARM Generic Interrupt Controller (GIC) register definitions and basic operations" +description = "ARM Generic Interrupt Controller version 2 (GICv2) register definitions and basic operations" license = "GPL-3.0-or-later OR Apache-2.0 OR MulanPSL-2.0" homepage = "https://github.com/arceos-org/arceos" -repository = "https://github.com/arceos-org/arm_gic" -documentation = "https://arceos-org.github.io/arm_gic" +repository = "https://github.com/arceos-org/arm_gicv2" +documentation = "https://docs.rs/arm_gicv2" [dependencies] tock-registers = "0.8" diff --git a/README.md b/README.md new file mode 100644 index 0000000..f7b2ddf --- /dev/null +++ b/README.md @@ -0,0 +1,9 @@ +# arm_gicv2 + +[![Crates.io](https://img.shields.io/crates/v/arm_gicv2)](https://crates.io/crates/arm_gicv2) +[![Docs.rs](https://docs.rs/arm_gicv2/badge.svg)](https://docs.rs/arm_gicv2) +[![CI](https://github.com/arceos-org/arm_gicv2/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/arceos-org/arm_gicv2/actions/workflows/ci.yml) + +ARM Generic Interrupt Controller version 2 (GICv2) register definitions and basic operations. + +The official documentation: diff --git a/src/lib.rs b/src/lib.rs index 56e3578..aebe257 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,15 +1,14 @@ -//! ARM Generic Interrupt Controller (GIC) register definitions and basic -//! operations. - #![no_std] -#![feature(const_ptr_as_ref)] #![feature(const_option)] #![feature(const_nonnull_new)] - -pub mod gic_v2; +#![doc = include_str!("../README.md")] use core::ops::Range; +mod gic_v2; + +pub use gic_v2::{GicDistributor, GicCpuInterface}; + /// Interrupt ID 0-15 are used for SGIs (Software-generated interrupt). /// /// SGI is an interrupt generated by software writing to a GICD_SGIR register in