Rename timers to physical_timer and virtual_timer.

More readable than pgt and vgt.

Author: jonathanpallant

examples/mps3-an536/src/bin/generic_timer.rs

@@ -25,10 +25,13 @@ fn main() -> ! {
 
     let delay_ticks = cntfrq / 2;
 
-    let pgt_ref: &mut dyn GenericTimer = &mut board.pgt;
-    let vgt_ref: &mut dyn GenericTimer = &mut board.vgt;
+    let physical_timer_ref: &mut dyn GenericTimer = &mut board.physical_timer;
+    let virtual_timer_ref: &mut dyn GenericTimer = &mut board.virtual_timer;
 
-    for (timer, name) in [(pgt_ref, "physical"), (vgt_ref, "virtual")] {
+    for (timer, name) in [
+        (physical_timer_ref, "physical"),
+        (virtual_timer_ref, "virtual"),
+    ] {
         println!("Using {} timer ************************", name);
 
         println!("Print five, every 100ms...");

examples/mps3-an536/src/bin/generic_timer_irq.rs

@@ -37,13 +37,13 @@ fn main() -> ! {
         .unwrap();
 
     // Setup virtual timer
-    board.vgt.enable(true);
-    board.vgt.interrupt_mask(false);
-    board.vgt.counter_compare_set(
+    board.virtual_timer.enable(true);
+    board.virtual_timer.interrupt_mask(false);
+    board.virtual_timer.counter_compare_set(
         board
-            .vgt
+            .virtual_timer
             .counter()
-            .wrapping_add(board.vgt.frequency_hz() as u64 / 5),
+            .wrapping_add(board.virtual_timer.frequency_hz() as u64 / 5),
     );
 
     println!("Enabling interrupts...");
@@ -88,11 +88,12 @@ fn irq_handler() {
 /// Run when the timer IRQ fires
 fn handle_timer_irq() {
     // SAFETY: We drop en other time handle in main, this is the only active handle.
-    let mut vgt = unsafe { El1VirtualTimer::new() };
+    let mut virtual_timer = unsafe { El1VirtualTimer::new() };
     // trigger a timer in 0.2 seconds
-    vgt.counter_compare_set(
-        vgt.counter_compare()
-            .wrapping_add(vgt.frequency_hz() as u64 / 5),
+    virtual_timer.counter_compare_set(
+        virtual_timer
+            .counter_compare()
+            .wrapping_add(virtual_timer.frequency_hz() as u64 / 5),
     );
 
     println!("    - Timer fired, resetting");

examples/mps3-an536/src/lib.rs

@@ -107,15 +107,15 @@ impl InterruptHandler {
     }
 }
 
-/// Represents all the hardware we support in our MPS3-AN536 system
+    /// Represents all the hardware we support in our MPS3-AN536 system
 pub struct Board {
     /// The Arm Generic Interrupt Controller (v3)
     #[cfg(feature = "gic")]
     pub gic: arm_gic::gicv3::GicV3<'static>,
     /// The Arm Virtual Generic Timer
-    pub vgt: cortex_ar::generic_timer::El1VirtualTimer,
+    pub virtual_timer: cortex_ar::generic_timer::El1VirtualTimer,
     /// The Arm Physical Generic Timer
-    pub pgt: cortex_ar::generic_timer::El1PhysicalTimer,
+    pub physical_timer: cortex_ar::generic_timer::El1PhysicalTimer,
 }
 
 impl Board {
@@ -136,10 +136,10 @@ impl Board {
                 gic: unsafe { make_gic() },
                 // SAFETY: This is the first and only time we create the virtual timer instance
                 // as guaranteed by the atomic flag check above, ensuring exclusive access.
-                vgt: unsafe { cortex_ar::generic_timer::El1VirtualTimer::new() },
+                virtual_timer: unsafe { cortex_ar::generic_timer::El1VirtualTimer::new() },
                 // SAFETY: This is the first and only time we create the physical timer instance
                 // as guaranteed by the atomic flag check above, ensuring exclusive access.
-                pgt: unsafe { cortex_ar::generic_timer::El1PhysicalTimer::new() },
+                physical_timer: unsafe { cortex_ar::generic_timer::El1PhysicalTimer::new() },
             })
         } else {
             None