rename doorbell::Register to Doorbell

rust-osdev · paulsohn · Dec 1, 2023 · Dec 4, 2023 · Dec 4, 2023 · Dec 4, 2023
commit f2e067e6877549285c9d22a8d4e31a93fb5b406f
diff --git a/src/registers/doorbell.rs b/src/registers/doorbell.rs
@@ -5,11 +5,15 @@ use accessor::array;
 use accessor::Mapper;
 use core::{convert::TryFrom, fmt};
 
+/// A type alias to [`Doorbell`] register for backward compability.
+#[deprecated = "Use `Doorbell` instead of `Register`."]
+pub type Register = Doorbell;
+
 /// The element of the Doorbell Array.
 #[repr(transparent)]
 #[derive(Copy, Clone, Default)]
-pub struct Register(u32);
-impl Register {
+pub struct Doorbell(u32);
+impl Doorbell {
     /// Creates a new accessor to the Doorbell Array.
     ///
     /// # Safety
@@ -44,7 +48,8 @@ impl Register {
     rw_field!(0..=7, doorbell_target, "Doorbell Target", u8);
     rw_field!(16..=31, doorbell_stream_id, "Doorbell Stream ID", u16);
 }
-impl fmt::Debug for Register {
+
+impl fmt::Debug for Doorbell {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         f.debug_struct("doorbell::Register")
             .field("doorbell_target", &self.doorbell_target())

diff --git a/src/registers/mod.rs b/src/registers/mod.rs
@@ -22,7 +22,7 @@ where
     /// Host Controller Capability Register
     pub capability: Capability<M>,
     /// Doorbell Array
-    pub doorbell: array::ReadWrite<doorbell::Register, M>,
+    pub doorbell: array::ReadWrite<doorbell::Doorbell, M>,
     /// Host Controller Operational Register
     pub operational: Operational<M>,
     /// Port Register Set Array
@@ -75,7 +75,7 @@ where
     /// ```
     pub unsafe fn new(mmio_base: usize, mapper: M) -> Self {
         let capability = Capability::new(mmio_base, &mapper);
-        let doorbell = doorbell::Register::new(mmio_base, &capability, mapper.clone());
+        let doorbell = doorbell::Doorbell::new(mmio_base, &capability, mapper.clone());
         let operational =
             Operational::new(mmio_base, capability.caplength.read_volatile(), &mapper);
         let port_register_set = PortRegisterSet::new(mmio_base, &capability, mapper.clone());