smmu 1.7.1

ARM SMMU v3 (System Memory Management Unit) implementation - Production-grade translation engine
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

//! PASID (Process Address Space ID) newtype wrapper
//!
//! Provides type-safe PASID handling with validation per ARM SMMU v3 specification.
//!
//! # ARM SMMU v3 Compliance
//!
//! Per ARM SMMU v3 specification Section 3.6:
//! - PASID is a 20-bit value (0-1_048_575, i.e., 0x0_0000-0xF_FFFF)
//! - PASID 0 represents the default address space and must always be supported
//! - Maximum value is 0xF_FFFF (1_048_575)
//!
//! # Examples
//!
//! ```rust
//! use smmu::types::PASID;
//!
//! // Create PASID for default address space
//! let default_pasid = PASID::new(0).expect("PASID 0 must be valid");
//! assert_eq!(default_pasid.as_u32(), 0);
//!
//! // Or use Default
//! let default_pasid = PASID::default();
//!
//! // Create PASID with maximum value
//! let max_pasid = PASID::new(0xF_FFFF).expect("Maximum PASID");
//!
//! // Values exceeding 20-bit fail validation
//! let result = PASID::new(0x10_0000);
//! assert!(result.is_err());
//! ```

use super::ValidationError;
use std::fmt;

/// ARM SMMU v3 PASID maximum value (20-bit)
pub const PASID_MAX: u32 = 0xF_FFFF;

/// Helper function to format u32 with underscores for readability
fn format_with_underscores(value: u32) -> String {
    let s = value.to_string();
    let bytes = s.as_bytes();
    let len = bytes.len();
    let mut result = String::new();

    for (i, &byte) in bytes.iter().enumerate() {
        if i > 0 && (len - i) % 3 == 0 {
            result.push('_');
        }
        result.push(byte as char);
    }
    result
}

/// Type-safe PASID wrapper
///
/// Wraps a 32-bit unsigned integer with validation to ensure it is a valid 20-bit
/// PASID value (0-0xF_FFFF) as required by ARM SMMU v3 specification.
#[derive(Copy, Clone, Debug, Default, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct PASID(u32);

impl PASID {
    /// Creates a new PASID with validation
    ///
    /// # Arguments
    ///
    /// * `value` - The PASID value to validate and wrap (must be <= 0xF_FFFF)
    ///
    /// # Returns
    ///
    /// `Ok(PASID)` if the value is valid (0-0xF_FFFF), `Err(ValidationError)` otherwise
    ///
    /// # Errors
    ///
    /// Returns ValidationError if value exceeds 20-bit maximum (0xF_FFFF)
    ///
    /// # ARM SMMU v3 Compliance
    ///
    /// - Validates that value is within 20-bit range (0-0xF_FFFF)
    /// - PASID 0 (default address space) is always valid
    ///
    /// # Examples
    ///
    /// ```rust
    /// use smmu::types::PASID;
    /// let pasid = PASID::new(42).unwrap();
    /// let default_pasid = PASID::new(0).unwrap(); // Default address space
    /// let max_pasid = PASID::new(0xF_FFFF).unwrap(); // Maximum value
    /// ```
    pub fn new(value: u32) -> Result<Self, ValidationError> {
        if value > PASID_MAX {
            return Err(ValidationError::new(
                "PASID",
                &format!("0x{value:X}"),
                "must be <= 0xF_FFFF (20-bit maximum)",
            ));
        }
        Ok(Self(value))
    }

    /// Converts the PASID to its underlying `u32` value
    ///
    /// # Examples
    ///
    /// ```rust
    /// use smmu::types::PASID;
    /// let pasid = PASID::new(42).unwrap();
    /// assert_eq!(pasid.as_u32(), 42);
    /// ```
    #[must_use]
    pub const fn as_u32(self) -> u32 {
        self.0
    }
}

impl fmt::Display for PASID {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "PASID({})", format_with_underscores(self.0))
    }
}

impl TryFrom<u32> for PASID {
    type Error = ValidationError;

    fn try_from(value: u32) -> Result<Self, Self::Error> {
        Self::new(value)
    }
}

impl From<PASID> for u32 {
    fn from(pasid: PASID) -> Self {
        pasid.0
    }
}