ostd 0.17.2

Rust OS framework that facilitates the development of and innovation in OS kernels
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

// SPDX-License-Identifier: MPL-2.0

//! I/O port access.

/// An access marker type indicating that a port is only allowed to write values.
pub struct WriteOnlyAccess;
/// An access marker type indicating that a port is allowed to read or write values.
pub struct ReadWriteAccess;

/// A marker trait for access types which allow writing port values.
pub trait IoPortWriteAccess {}
/// A marker trait for access types which allow reading port values.
pub trait IoPortReadAccess {}

impl IoPortWriteAccess for WriteOnlyAccess {}
impl IoPortWriteAccess for ReadWriteAccess {}
impl IoPortReadAccess for ReadWriteAccess {}

/// A helper trait that implements the read port operation.
pub trait PortRead: Sized {
    /// Reads a `Self` value from the given port.
    ///
    /// ## Safety
    ///
    /// This function is unsafe because the I/O port could have side effects that violate memory
    /// safety.
    unsafe fn read_from_port(_port: u16) -> Self {
        unimplemented!()
    }
}

/// A helper trait that implements the write port operation.
pub trait PortWrite: Sized {
    /// Writes a `Self` value to the given port.
    ///
    /// ## Safety
    ///
    /// This function is unsafe because the I/O port could have side effects that violate memory
    /// safety.
    unsafe fn write_to_port(_port: u16, _value: Self) {
        unimplemented!()
    }
}

impl PortRead for u8 {}
impl PortWrite for u8 {}
impl PortRead for u16 {}
impl PortWrite for u16 {}
impl PortRead for u32 {}
impl PortWrite for u32 {}