Create clock module (#691)

* Move CMOS and RTC to clk module

* Add timer to clk module

* Move clocks to clk module

* Rename uptime and realtime to boot and epoch time

* Refactor module

* Refactor sync functions

* Return error instead of invoking the unimplemented macro in device files

doc/lisp.md

@@ -79,7 +79,7 @@ MOROS Lisp is a Lisp-1 dialect inspired by Scheme, Clojure, and Ruby!
 - `read`, `write`, `append`
 - `read-binary`, `write-binary`, `append-binary`
 - `read-line`, `read-char`
-- `uptime`, `realtime`
+- `clock/boot`, `clock/epoch`
 - `p`, `print`, `eprint`, `error`
 
 ### Math Library
@@ -176,6 +176,7 @@ Would produce the following output:
 
 ### Unreleased
 - Add `dirname`, `filename`, `eprint`, and `error` functions
+- Rename `uptime` to `clk/boot` and `realtime` to `clk/epoch`
 
 ### 0.7.1 (2024-06-20)
 - Add `floor`, `ceil`, and `round` functions

doc/manual.md

@@ -85,9 +85,9 @@ commands to test the system or `install` to setup the
     Created '/dev/ata/1/0'
     Created '/dev/ata/1/1'
     Created '/dev/clk'
-    Created '/dev/clk/uptime'
-    Created '/dev/clk/realtime'
-    Created '/dev/rtc'
+    Created '/dev/clk/boot'
+    Created '/dev/clk/epoch'
+    Created '/dev/clk/rtc'
     Created '/dev/null'
     Created '/dev/random'
     Created '/dev/console'
@@ -270,7 +270,7 @@ You can print the date with `date`:
 You can update the real time clock by writing the correct time to its device
 file:
 
-    > print "2023-03-21 10:00:00" => /dev/rtc
+    > print "2023-03-21 10:00:00" => /dev/clk/rtc
 
     > date
     2023-03-21 10:00:00 +0000
@@ -297,12 +297,12 @@ Add `env TZ 7200` to `/ini/boot.sh` before `shell` to save the timezone:
 
 There's a device file to get the number of seconds elapsed since Unix Epoch:
 
-    > read /dev/clk/realtime
+    > read /dev/clk/epoch
     1682105344.624905
 
 And another one since boot:
 
-    > read /dev/clk/uptime
+    > read /dev/clk/boot
     1169.384929
 
 ## Aliases
@@ -312,7 +312,7 @@ You can add custom commands to the shell with the `alias` command.
 For example you can define an `uptime` command that will read the device file
 described above:
 
-    > alias uptime "read /dev/clk/uptime"
+    > alias uptime "read /dev/clk/boot"
 
     > uptime
     1406.304852
@@ -377,5 +377,5 @@ There is also a `ntp` script to synchronize the clock over the network:
     > ntp
     2023-03-21 10:00:00
 
-    > ntp => /dev/rtc
+    > ntp => /dev/clk/rtc
     [12.111156] RTC 2023-03-21 10:00:00 +0000

doc/network.md

@@ -163,5 +163,5 @@ passed as an argument or defined in `/ini/ntp`:
 
 It can be used to synchronize the real-time clock (RTC):
 
-    > ntp => /dev/rtc
+    > ntp => /dev/clk/rtc
     [42.123456] RTC 2023-03-21 10:00:00 +0000

dsk/lib/lisp/file.lsp

@@ -75,13 +75,13 @@
 
 # Clocks
 
-(def (uptime)
-  "Returns the current value of the uptime clock"
-  (binary->number (read-binary "/dev/clk/uptime") "float"))
+(def (clock/boot)
+  "Returns the number of seconds since boot"
+  (binary->number (read-binary "/dev/clk/boot") "float"))
 
-(def (realtime)
-  "Returns the current value of the realtime clock"
-  (binary->number (read-binary "/dev/clk/realtime") "float"))
+(def (clock/epoch)
+  "Returns the number of seconds since epoch"
+  (binary->number (read-binary "/dev/clk/epoch") "float"))
 
 # Path
 

dsk/tmp/lisp/geotime.lsp

@@ -32,7 +32,7 @@
 
 (print
   (if (= (len args) 1)
-    (geotime (str->num (first args)) (realtime))
+    (geotime (str->num (first args)) (clk/epoch))
     (if (= (len args) 2)
       (geotime (str->num (first args)) (str->num (second args)))
       "Usage: geotime <longitude> [<timestamp>]")))

src/api/clock.rs

@@ -18,10 +18,10 @@ fn read_float(path: &str) -> f64 {
     0.0
 }
 
-pub fn uptime() -> f64 {
-    read_float("/dev/clk/uptime")
+pub fn boot_time() -> f64 {
+    read_float("/dev/clk/boot")
 }
 
-pub fn realtime() -> f64 {
-    read_float("/dev/clk/realtime")
+pub fn epoch_time() -> f64 {
+    read_float("/dev/clk/epoch")
 }

src/api/fs.rs

@@ -161,9 +161,9 @@ fn device_type(name: &str) -> Result<DeviceType, ()> {
         "file"        => Ok(DeviceType::File),
         "console"     => Ok(DeviceType::Console),
         "random"      => Ok(DeviceType::Random),
-        "uptime"      => Ok(DeviceType::Uptime),
-        "realtime"    => Ok(DeviceType::Realtime),
-        "rtc"         => Ok(DeviceType::RTC),
+        "clk-boot"    => Ok(DeviceType::BootTime),
+        "clk-epoch"   => Ok(DeviceType::EpochTime),
+        "clk-rtc"     => Ok(DeviceType::RTC),
         "tcp"         => Ok(DeviceType::TcpSocket),
         "udp"         => Ok(DeviceType::UdpSocket),
         "vga-buffer"  => Ok(DeviceType::VgaBuffer),

src/api/time.rs

@@ -8,7 +8,7 @@ pub fn now() -> OffsetDateTime {
 }
 
 pub fn now_utc() -> OffsetDateTime {
-    let s = clock::realtime(); // Since Unix Epoch
+    let s = clock::epoch_time(); // Since Unix Epoch
     let ns = Duration::nanoseconds(
         libm::floor(1e9 * (s - libm::floor(s))) as i64
     );

src/bin/geocal.rs

@@ -37,7 +37,7 @@ fn main(args: &[&str]) {
     let timestamp = if args.len() == 4 {
         args[3].parse().unwrap()
     } else {
-        clock::realtime() as i64
+        clock::epoch_time() as i64
     };
 
     let week;

src/bin/geodate.rs

@@ -21,7 +21,7 @@ fn main(args: &[&str]) {
     let timestamp = if args.len() == 3 {
         args[2].parse().expect("Could not parse timestamp")
     } else {
-        clock::realtime()
+        clock::epoch_time()
     };
 
     let t = geodate::get_formatted_date(format, timestamp as i64, longitude);

src/lib.rs

@@ -29,7 +29,7 @@ pub fn init(boot_info: &'static BootInfo) {
     sys::pic::init(); // Enable interrupts
     sys::serial::init();
     sys::keyboard::init();
-    sys::time::init();
+    sys::clk::init();
 
     let v = option_env!("MOROS_VERSION").unwrap_or(env!("CARGO_PKG_VERSION"));
     log!("SYS MOROS v{}", v);
@@ -42,7 +42,8 @@ pub fn init(boot_info: &'static BootInfo) {
     sys::net::init(); // Require PCI
     sys::ata::init();
     sys::fs::init(); // Require ATA
-    sys::clock::init(); // Require MEM
+
+    log!("RTC {}", sys::clk::date());
 }
 
 #[allow(dead_code)]

src/sys/ata.rs

@@ -100,7 +100,7 @@ impl Bus {
     }
 
     fn wait(&mut self, ns: u64) {
-        sys::time::nanowait(ns);
+        sys::clk::wait(ns);
     }
 
     fn clear_interrupt(&mut self) -> u8 {
@@ -132,9 +132,9 @@ impl Bus {
     }
 
     fn poll(&mut self, bit: Status, val: bool) -> Result<(), ()> {
-        let start = sys::clock::uptime();
+        let start = sys::clk::boot_time();
         while self.status().get_bit(bit as usize) != val {
-            if sys::clock::uptime() - start > 1.0 {
+            if sys::clk::boot_time() - start > 1.0 {
                 debug!(
                     "ATA hanged while polling {:?} bit in status register",
                     bit
@@ -164,7 +164,7 @@ impl Bus {
             // Bit 7 => 1
             self.drive_register.write(0xA0 | (drive << 4))
         }
-        sys::time::nanowait(400); // Wait at least 400 ns
+        sys::clk::wait(400); // Wait at least 400 ns
         self.poll(Status::BSY, false)?;
         self.poll(Status::DRQ, false)?;
         Ok(())
@@ -392,7 +392,7 @@ impl FileIO for Drive {
     }
 
     fn write(&mut self, _buf: &[u8]) -> Result<usize, ()> {
-        unimplemented!();
+        Err(())
     }
 
     fn close(&mut self) {

src/sys/clk/boot.rs

@@ -0,0 +1,54 @@
+use super::timer;
+
+use crate::api::fs::{FileIO, IO};
+
+#[derive(Debug, Clone)]
+pub struct BootTime;
+
+impl BootTime {
+    pub fn new() -> Self {
+        Self {}
+    }
+
+    pub fn size() -> usize {
+        core::mem::size_of::<f64>()
+    }
+}
+
+impl FileIO for BootTime {
+    fn read(&mut self, buf: &mut [u8]) -> Result<usize, ()> {
+        let time = boot_time().to_be_bytes();
+        let n = time.len();
+        if buf.len() >= n {
+            buf[0..n].clone_from_slice(&time);
+            Ok(n)
+        } else {
+            Err(())
+        }
+    }
+
+    fn write(&mut self, _buf: &[u8]) -> Result<usize, ()> {
+        Err(())
+    }
+
+    fn close(&mut self) {}
+
+    fn poll(&mut self, event: IO) -> bool {
+        match event {
+            IO::Read => true,
+            IO::Write => false,
+        }
+    }
+}
+
+/// Returns the number of seconds since boot.
+///
+/// This clock is monotonic.
+pub fn boot_time() -> f64 {
+    timer::time_between_ticks() * timer::ticks() as f64
+}
+
+#[test_case]
+fn test_boot_time() {
+    assert!(boot_time() > 0.0);
+}