ioports 1.0.0

A simple library for interacting with IO ports on various platforms (currently, x86, x86_64, and RISCV64).
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

#![no_std]

use core::marker::PhantomData;

mod rw;
pub use rw::*;

impl PortReadWrite for u8 {}
impl PortReadWrite for u16 {}
impl PortReadWrite for u32 {}

/// A port wrapper that only allows read operations.
#[repr(transparent)]
#[derive(Debug, Clone, Eq, PartialEq)]
pub struct ReadOnlyPort<T: PortRead> {
    address: PortAddress,
    marker: PhantomData<T>,
}

impl<T: PortRead> ReadOnlyPort<T> {
    /// Creates a read-only port wrapper pointing to the provided address.
    ///
    /// ### Safety
    ///
    /// - Provided port address must point to a valid device.
    /// - Provided port address should not be otherwise aliased.
    /// - Port must be valid for reading types of size `T`.
    pub const unsafe fn new(address: PortAddress) -> Self {
        ReadOnlyPort {
            address,
            marker: PhantomData,
        }
    }

    /// The address of the port.
    pub const fn address(&self) -> PortAddress {
        self.address
    }

    /// Reads a `T` from the port.
    pub fn read(&self) -> T {
        unsafe { T::read(self.address()) }
    }
}

/// A port wrapper that only allows write operations.
#[repr(transparent)]
#[derive(Debug, Clone, Eq, PartialEq)]
pub struct WriteOnlyPort<T: PortWrite> {
    address: PortAddress,
    marker: PhantomData<T>,
}

impl<T: PortWrite> WriteOnlyPort<T> {
    /// Creates a write-only port wrapper pointing to the provided address.
    ///
    /// ### Safety
    ///
    /// - Provided port address must point to a valid device.
    /// - Provided port address should not be otherwise aliased.
    /// - Port must be valid for reading types of size `T`.
    pub const unsafe fn new(address: PortAddress) -> Self {
        WriteOnlyPort {
            address,
            marker: PhantomData,
        }
    }

    /// The address of the port.
    pub const fn address(&self) -> PortAddress {
        self.address
    }

    /// Writes a `T` to the port.
    pub fn write(&mut self, value: T) {
        unsafe { T::write(self.address(), value) }
    }
}

/// A port wrapper that allows read and write operations.
#[repr(transparent)]
#[derive(Debug, Clone, Eq, PartialEq)]
pub struct ReadWritePort<T: PortReadWrite> {
    address: PortAddress,
    marker: PhantomData<T>,
}

impl<T: PortReadWrite> ReadWritePort<T> {
    /// Creates a read-write port wrapper pointing to the provided address.
    ///
    /// ### Safety
    ///
    /// - Provided port address must point to a valid device.
    /// - Provided port address should not be otherwise aliased.
    /// - Port must be valid for reading types of size `T`.
    pub const unsafe fn new(address: PortAddress) -> Self {
        ReadWritePort {
            address,
            marker: PhantomData,
        }
    }

    /// The address of the port.
    pub const fn address(&self) -> PortAddress {
        self.address
    }

    /// Reads a `T` from the port.
    pub fn read(&self) -> T {
        unsafe { T::read(self.address()) }
    }

    /// Writes a `T` to the port.
    pub fn write(&mut self, value: T) {
        unsafe { T::write(self.address(), value) }
    }
}