xhci 0.9.2

A library to handle xHCI
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

//! xHCI Local Memory Capability.

use super::ExtendedCapability;
use accessor::{array, single, Mapper};
use bit_field::BitField;
use core::convert::TryInto;

/// xHCI Local Memory Capability.
#[derive(Debug)]
pub struct XhciLocalMemory<M>
where
    M: Mapper + Clone,
{
    /// The header of this Capability.
    pub header: single::ReadWrite<Header, M>,
    /// The Local Memory.
    pub memory: array::ReadWrite<u8, M>,
}
impl<M> XhciLocalMemory<M>
where
    M: Mapper + Clone,
{
    /// Creates an accessor to xHCI Local Memory Capability.
    ///
    /// This function returns `None` if the size of the Local Memory space is 0.
    ///
    /// # Safety
    ///
    /// `base` must be the correct address to xHCI Local Memory Capability.
    ///
    /// The caller must ensure that xHCI Local Memory Capability is accessed only by the created
    /// accessor.
    ///
    /// # Panics
    ///
    /// This method panics if `base` is not aligned correctly.
    pub unsafe fn new(base: usize, mapper: M) -> Option<Self> {
        let header: single::ReadWrite<Header, M> = single::ReadWrite::new(base, mapper.clone());
        let size = header.read_volatile().size();

        if size > 0 {
            let memory = array::ReadWrite::new(base + 8, (size * 1024).try_into().unwrap(), mapper);

            Some(Self { header, memory })
        } else {
            None
        }
    }
}
impl<M> From<XhciLocalMemory<M>> for ExtendedCapability<M>
where
    M: Mapper + Clone,
{
    fn from(x: XhciLocalMemory<M>) -> Self {
        ExtendedCapability::XhciLocalMemory(x)
    }
}

/// The first 8 bytes of the Capability.
#[repr(transparent)]
#[derive(Copy, Clone)]
pub struct Header([u32; 2]);
impl Header {
    /// Returns the Local Memory Enable bit.
    #[must_use]
    pub fn local_memory_enable(self) -> bool {
        self.0[0].get_bit(16)
    }

    /// Sets the Local Memory Enable bit.
    pub fn set_local_memory_enable(&mut self) {
        self.0[0].set_bit(16, true);
    }

    /// Clears the Local Memory Enable bit.
    pub fn clear_local_memory_enable(&mut self) {
        self.0[0].set_bit(16, false);
    }

    fn size(self) -> u32 {
        self.0[1]
    }
}
impl_debug_from_methods! {
    Header {
        local_memory_enable,
    }
}