Rename InterruptRegisterSet to InterrupterRegisterSet (#143)

Author: Demindiro

src/registers/mod.rs

@@ -5,7 +5,9 @@ use accessor::Mapper;
 
 pub use capability::Capability;
 pub use operational::{Operational, PortRegisterSet};
+#[allow(deprecated)]
 pub use runtime::InterruptRegisterSet;
+pub use runtime::InterrupterRegisterSet;
 pub use runtime::Runtime;
 
 pub mod capability;
@@ -29,8 +31,9 @@ where
     pub port_register_set: array::ReadWrite<PortRegisterSet, M>,
     /// Runtime Registers
     pub runtime: Runtime<M>,
-    /// Interrupt Register Set Array
-    pub interrupt_register_set: array::ReadWrite<InterruptRegisterSet, M>,
+    /// Interrupter Register Set Array
+    // TODO rename to interrupter_register_set
+    pub interrupt_register_set: array::ReadWrite<InterrupterRegisterSet, M>,
 }
 impl<M> Registers<M>
 where
@@ -81,7 +84,7 @@ where
         let port_register_set = PortRegisterSet::new(mmio_base, &capability, mapper.clone());
         let runtime = Runtime::new(mmio_base, capability.rtsoff.read_volatile(), mapper.clone());
         let interrupt_register_set =
-            InterruptRegisterSet::new(mmio_base, capability.rtsoff.read_volatile(), mapper);
+            InterrupterRegisterSet::new(mmio_base, capability.rtsoff.read_volatile(), mapper);
 
         Self {
             capability,

src/registers/runtime.rs

@@ -9,8 +9,8 @@ use core::convert::TryInto;
 
 /// Runtime Registers
 ///
-/// Note that this struct does not contain the interrupt register sets. Refer to
-/// [`InterruptRegisterSet`].
+/// Note that this struct does not contain the interrupter register sets. Refer to
+/// [`InterrupterRegisterSet`].
 #[derive(Debug)]
 pub struct Runtime<M>
 where
@@ -55,13 +55,13 @@ impl_debug_from_methods! {
     }
 }
 
-/// Interrupt Register Set
+/// Interrupter Register Set
 #[repr(C)]
 #[derive(Copy, Clone, Debug)]
-pub struct InterruptRegisterSet {
-    /// Interrupt Management Register
+pub struct InterrupterRegisterSet {
+    /// Interrupter Management Register
     pub iman: InterrupterManagementRegister,
-    /// Interrupt Moderation Register
+    /// Interrupter Moderation Register
     pub imod: InterrupterModerationRegister,
     /// Event Ring Segment Table Size Register
     pub erstsz: EventRingSegmentTableSizeRegister,
@@ -71,8 +71,8 @@ pub struct InterruptRegisterSet {
     /// Event Ring Dequeue Pointer Register
     pub erdp: EventRingDequeuePointerRegister,
 }
-impl InterruptRegisterSet {
-    /// Creates an accessor to the Interrupt Register Set.
+impl InterrupterRegisterSet {
+    /// Creates an accessor to the Interrupter Register Set.
     ///
     /// # Safety
     ///
@@ -81,7 +81,7 @@ impl InterruptRegisterSet {
     ///
     /// # Panics
     ///
-    /// This method panics if the base address of the Interrupt Register Sets is not aligned
+    /// This method panics if the base address of the Interrupter Register Sets is not aligned
     /// correctly.
     pub unsafe fn new<M>(
         mmio_base: usize,
@@ -220,3 +220,7 @@ impl_debug_from_methods! {
         event_ring_dequeue_pointer
     }
 }
+
+/// Alias for [`InterrupterRegisterSet`].
+#[deprecated(note = "use InterrupterRegisterSet instead (note 'er')")]
+pub type InterruptRegisterSet = InterrupterRegisterSet;