Support receiving bytes from serial ports

README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://github.com/rust-osdev/uart_16550/workflows/Build/badge.svg)](https://github.com/rust-osdev/uart_16550/actions?query=workflow%3ABuild) [![Docs.rs Badge](https://docs.rs/uart_16550/badge.svg)](https://docs.rs/uart_16550/)
 
-Minimal support for uart_16550 serial output.
+Minimal support for uart_16550 serial I/O.
 
 ## Usage
 
@@ -16,6 +16,9 @@ serial_port.init();
 
 // Now the serial port is ready to be used. To send a byte:
 serial_port.send(42);
+
+// To receive a byte:
+let data = serial_port.receive();
 ```
 
 ## License

src/lib.rs

@@ -1,4 +1,4 @@
-//! Minimal support for uart_16550 serial output.
+//! Minimal support for uart_16550 serial I/O.
 //!
 //! # Usage
 //!
@@ -12,6 +12,9 @@
 //!
 //! // Now the serial port is ready to be used. To send a byte:
 //! serial_port.send(42);
+//!
+//! // To receive a byte:
+//! let data = serial_port.receive();
 //! ```
 
 #![no_std]
@@ -139,6 +142,14 @@ impl SerialPort {
             }
         }
     }
+
+    /// Receives a byte on the serial port.
+    pub fn receive(&mut self) -> u8 {
+        unsafe {
+            while !self.line_sts().contains(LineStsFlags::INPUT_FULL) {}
+            self.data.read()
+        }
+    }
 }
 
 impl fmt::Write for SerialPort {