Merge pull request #12 from japaric/gh5

drop write macros in favor of IO objects + fmt::Write

src/debug.rs

@@ -26,6 +26,8 @@
 
 /// This values are taken from section 5.5.2 of
 /// ADS Debug Target Guide (DUI0058).
+// TODO document
+#[allow(missing_docs)]
 pub enum Exception {
     // Hardware reason codes
     BranchThroughZero = 0x20000,

src/hio.rs

@@ -0,0 +1,78 @@
+//! Host I/O
+
+use core::{fmt, slice};
+use nr;
+
+/// Host's standard error
+pub struct HStderr {
+    fd: usize,
+}
+
+impl HStderr {
+    /// Attempts to write an entire `buffer` into this sink
+    pub fn write_all(&mut self, buffer: &[u8]) -> Result<(), ()> {
+        write_all(self.fd, buffer)
+    }
+}
+
+impl fmt::Write for HStderr {
+    fn write_str(&mut self, s: &str) -> fmt::Result {
+        self.write_all(s.as_bytes()).map_err(|_| fmt::Error)
+    }
+}
+
+/// Host's standard output
+pub struct HStdout {
+    fd: usize,
+}
+
+impl HStdout {
+    /// Attempts to write an entire `buffer` into this sink
+    pub fn write_all(&mut self, buffer: &[u8]) -> Result<(), ()> {
+        write_all(self.fd, buffer)
+    }
+}
+
+impl fmt::Write for HStdout {
+    fn write_str(&mut self, s: &str) -> fmt::Result {
+        self.write_all(s.as_bytes()).map_err(|_| fmt::Error)
+    }
+}
+
+/// Construct a new handle to the host's standard error.
+pub fn hstderr() -> Result<HStderr, ()> {
+    open(":tt\0", nr::open::W_APPEND).map(|fd| HStderr { fd })
+}
+
+/// Construct a new handle to the host's standard output.
+pub fn hstdout() -> Result<HStdout, ()> {
+    open(":tt\0", nr::open::W_TRUNC).map(|fd| HStdout { fd })
+}
+
+fn open(name: &str, mode: usize) -> Result<usize, ()> {
+    let name = name.as_bytes();
+    match unsafe { syscall!(OPEN, name.as_ptr(), mode, name.len() - 1) } as
+        isize {
+        -1 => Err(()),
+        fd => Ok(fd as usize),
+    }
+}
+
+fn write_all(fd: usize, mut buffer: &[u8]) -> Result<(), ()> {
+    while !buffer.is_empty() {
+        match unsafe { syscall!(WRITE, fd, buffer.as_ptr(), buffer.len()) } {
+            // Done
+            0 => return Ok(()),
+            // `n` bytes were not written
+            n if n <= buffer.len() => {
+                let offset = (buffer.len() - n) as isize;
+                buffer = unsafe {
+                    slice::from_raw_parts(buffer.as_ptr().offset(offset), n)
+                }
+            }
+            // Error
+            _ => return Err(()),
+        }
+    }
+    Ok(())
+}

src/io.rs

@@ -1,86 +0,0 @@
-//! Host I/O
-
-use core::{fmt, slice};
-use core::fmt::Write;
-
-/// File descriptors
-const STDOUT: usize = 1;
-const STDERR: usize = 2;
-
-/// Host's standard error
-struct Stderr;
-
-/// Host's standard output
-struct Stdout;
-
-fn write_all(fd: usize, mut buffer: &[u8]) {
-    while !buffer.is_empty() {
-        match unsafe { syscall!(WRITE, fd, buffer.as_ptr(), buffer.len()) } {
-            // Done
-            0 => return,
-            // `n` bytes were not written
-            n => {
-                let offset = (buffer.len() - n) as isize;
-                buffer = unsafe {
-                    slice::from_raw_parts(buffer.as_ptr().offset(offset as isize), n)
-                }
-            }
-        }
-    }
-}
-
-impl Stderr {
-    fn write_all(&mut self, buffer: &[u8]) {
-        write_all(STDERR, buffer);
-    }
-}
-
-impl Stdout {
-    fn write_all(&mut self, buffer: &[u8]) {
-        write_all(STDOUT, buffer);
-    }
-}
-
-impl Write for Stderr {
-    fn write_str(&mut self, s: &str) -> fmt::Result {
-        self.write_all(s.as_bytes());
-        Ok(())
-    }
-}
-
-impl Write for Stdout {
-    fn write_str(&mut self, s: &str) -> fmt::Result {
-        self.write_all(s.as_bytes());
-        Ok(())
-    }
-}
-
-/// Write a `buffer` to the host's stderr
-pub fn ewrite(buffer: &[u8]) {
-    Stderr.write_all(buffer)
-}
-
-/// Write `fmt::Arguments` to the host's stderr
-pub fn ewrite_fmt(args: fmt::Arguments) {
-    Stderr.write_fmt(args).ok();
-}
-
-/// Write a `string` to the host's stderr
-pub fn ewrite_str(string: &str) {
-    Stderr.write_all(string.as_bytes())
-}
-
-/// Write a `buffer` to the host's stdout
-pub fn write(buffer: &[u8]) {
-    Stdout.write_all(buffer)
-}
-
-/// Write `fmt::Arguments` to the host's stdout
-pub fn write_fmt(args: fmt::Arguments) {
-    Stdout.write_fmt(args).ok();
-}
-
-/// Write a `string` to the host's stdout
-pub fn write_str(string: &str) {
-    Stdout.write_all(string.as_bytes())
-}

src/lib.rs

@@ -34,7 +34,7 @@
 //!
 //! fn main() {
 //!     // File descriptor (on the host)
-//!     const STDOUT: usize = 1;
+//!     const STDOUT: usize = 1; // NOTE the host stdout may not always be fd 1
 //!     static MSG: &'static [u8] = b"Hello, world!\n";
 //!
 //!     // Signature: fn write(fd: usize, ptr: *const u8, len: usize) -> usize
@@ -107,15 +107,17 @@
 //!
 //! [pdf]: http://infocenter.arm.com/help/topic/com.arm.doc.dui0471e/DUI0471E_developing_for_arm_processors.pdf
 
+#![deny(missing_docs)]
+#![deny(warnings)]
 #![feature(asm)]
 #![no_std]
 
 #[macro_use]
 mod macros;
 
-pub mod io;
-pub mod nr;
 pub mod debug;
+pub mod hio;
+pub mod nr;
 
 /// Performs a semihosting operation, takes a pointer to an argument block
 #[inline(always)]

src/macros.rs

@@ -27,33 +27,3 @@ macro_rules! syscall1 {
         $crate::syscall1($crate::nr::$nr, $a1 as usize)
     };
 }
-
-/// Macro for printing to the **host's** standard stderr
-#[macro_export]
-macro_rules! ehprint {
-    ($s:expr) => ($crate::io::ewrite_str($s));
-    ($($arg:tt)*) => ($crate::io::ewrite_fmt(format_args!($($arg)*)));
-}
-
-/// Macro for printing to the **host's** standard error, with a newline.
-#[macro_export]
-macro_rules! ehprintln {
-    () => (ehprint!("\n"));
-    ($fmt:expr) => (ehprint!(concat!($fmt, "\n")));
-    ($fmt:expr, $($arg:tt)*) => (ehprint!(concat!($fmt, "\n"), $($arg)*));
-}
-
-/// Macro for printing to the **host's** standard output
-#[macro_export]
-macro_rules! hprint {
-    ($s:expr) => ($crate::io::write_str($s));
-    ($($arg:tt)*) => ($crate::io::write_fmt(format_args!($($arg)*)));
-}
-
-/// Macro for printing to the **host's** standard output, with a newline.
-#[macro_export]
-macro_rules! hprintln {
-    () => (hprint!("\n"));
-    ($fmt:expr) => (hprint!(concat!($fmt, "\n")));
-    ($fmt:expr, $($arg:tt)*) => (hprint!(concat!($fmt, "\n"), $($arg)*));
-}

src/nr.rs

@@ -1,5 +1,8 @@
 //! Semihosting operations
 
+// TODO document
+#![allow(missing_docs)]
+
 pub const CLOCK: usize = 0x10;
 pub const CLOSE: usize = 0x05;
 pub const ELAPSED: usize = 0x30;
@@ -24,3 +27,18 @@ pub const WRITE: usize = 0x05;
 pub const WRITEC: usize = 0x03;
 pub const ENTER_SVC: usize = 0x17;
 pub const REPORT_EXCEPTION: usize = 0x18;
+
+pub mod open {
+    pub const R: usize = 0;
+    pub const R_TEXT: usize = 1;
+    pub const RW: usize = 2;
+    pub const RW_TEXT: usize = 3;
+    pub const W_TRUNC: usize = 4;
+    pub const W_TRUNC_TEXT: usize = 5;
+    pub const RW_TRUNC: usize = 6;
+    pub const RW_TRUNC_TEXT: usize = 7;
+    pub const W_APPEND: usize = 8;
+    pub const W_APPEND_TEXT: usize = 9;
+    pub const RW_APPEND: usize = 10;
+    pub const RW_APPEND_TEXT: usize = 11;
+}