Rename x86_64 module to port and make submodules private

Also: Add docs annotation on docs.rs that `SerialPort` is only available on `x86_64`.

Author: phil-opp

Cargo.toml

@@ -24,3 +24,6 @@ pre-release-replacements = [
     { file="Changelog.md", search="# Unreleased", replace="# Unreleased\n\n# {{version}} – {{date}}", exactly=1 },
 ]
 pre-release-commit-message = "Release version {{version}}"
+
+[package.metadata.docs.rs]
+rustdoc-args = ["--cfg", "docsrs"]

src/lib.rs

@@ -57,9 +57,11 @@
 //! // To receive a byte:
 //! let data = serial_port.receive();
 //! ```
+
 #![no_std]
 #![warn(missing_docs)]
 #![cfg_attr(feature = "nightly", feature(const_ptr_offset))]
+#![cfg_attr(docsrs, feature(doc_cfg))]
 
 #[cfg(not(any(feature = "stable", feature = "nightly")))]
 compile_error!("Either the `stable` or `nightly` feature must be enabled");
@@ -75,14 +77,14 @@ macro_rules! wait_for {
 }
 
 /// Memory mapped implementation
-pub mod mmio;
+mod mmio;
 #[cfg(target_arch = "x86_64")]
 /// Port asm commands implementation
-pub mod x86_64;
+mod port;
 
 pub use crate::mmio::MmioSerialPort;
 #[cfg(target_arch = "x86_64")]
-pub use crate::x86_64::SerialPort;
+pub use crate::port::SerialPort;
 
 bitflags! {
     /// Interrupt enable flags

src/mmio.rs

@@ -5,7 +5,7 @@ use core::{
 
 use crate::LineStsFlags;
 
-/// An interface to a serial port that allows sending out individual bytes.
+/// A memory-mapped UART.
 pub struct MmioSerialPort {
     data: AtomicPtr<u8>,
     int_en: AtomicPtr<u8>,
@@ -16,7 +16,7 @@ pub struct MmioSerialPort {
 }
 
 impl MmioSerialPort {
-    /// Creates a new serial port interface on the given memory mapped address.
+    /// Creates a new UART interface on the given memory mapped address.
     ///
     /// This function is unsafe because the caller must ensure that the given base address
     /// really points to a serial port device.
@@ -46,7 +46,7 @@ impl MmioSerialPort {
         }
     }
 
-    /// Initializes the serial port.
+    /// Initializes the memory-mapped UART.
     ///
     /// The default configuration of [38400/8-N-1](https://en.wikipedia.org/wiki/8-N-1) is used.
     pub fn init(&mut self) {

src/x86_64.rs renamed to src/port.rs

@@ -4,7 +4,8 @@ use x86_64::instructions::port::{Port, PortReadOnly, PortWriteOnly};
 
 use crate::LineStsFlags;
 
-/// An interface to a serial port that allows sending out individual bytes.
+/// A port-mapped UART.
+#[cfg_attr(docsrs, doc(cfg(target_arch = "x86_64")))]
 pub struct SerialPort {
     data: Port<u8>,
     int_en: PortWriteOnly<u8>,