Skip to content

Commit f579774

Browse files
committed
Add missing docs
1 parent dee947a commit f579774

File tree

3 files changed

+14
-6
lines changed

3 files changed

+14
-6
lines changed

src/lib.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,13 +52,15 @@ macro_rules! wait_for {
5252
};
5353
}
5454

55+
/// Memory mapped implementation
5556
pub mod mmio;
5657
#[cfg(target_arch = "x86_64")]
58+
/// Port asm commands implementation
5759
pub mod x86_64;
5860

61+
pub use crate::mmio::MmioSerialPort;
5962
#[cfg(target_arch = "x86_64")]
6063
pub use crate::x86_64::SerialPort;
61-
pub use crate::mmio::MmioSerialPort;
6264

6365
bitflags! {
6466
/// Interrupt enable flags

src/mmio.rs

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
1+
use core::{
2+
fmt,
3+
sync::atomic::{
4+
AtomicPtr,
5+
Ordering,
6+
},
7+
};
8+
19
use crate::LineStsFlags;
2-
use core::{fmt, sync::atomic::{
3-
AtomicPtr,
4-
Ordering,
5-
}};
610

711
/// An interface to a serial port that allows sending out individual bytes.
812
pub struct MmioSerialPort {

src/x86_64.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1+
use core::fmt;
2+
13
use x86_64::instructions::port::Port;
4+
25
use crate::LineStsFlags;
3-
use core::fmt;
46

57
/// An interface to a serial port that allows sending out individual bytes.
68
pub struct SerialPort {

0 commit comments

Comments
 (0)