Struct Pa 

#[repr(transparent)]
pub struct Pa(usize);

Represents a physical address.

The Pa (Physical Address) struct is a wrapper around the usize type, which represents a physical address in memory. It is used to handle addresses that correspond directly to the hardware memory locations in the physical address space.

This struct provides methods to:

• Create a new physical address with validation.
• Convert a physical address to a virtual address.
• Convert a physical address to a raw usize type.

Example:

let pa = Pa::new(0x1234_5678_9ABC_DEF0).unwrap();
let kva = pa.into_kva(); // Convert to a kernel virtual address.

Tuple Fields

0: usize

Implementations

impl Pa

pub const ZERO: Self

The physical address 0.

This constant represents the special address 0.

pub const fn new(addr: usize) -> Option<Self>

Creates a new physical address if the address is valid.

This method attempts to create a new Pa instance by validating the provided physical address. The address must be less than 0xffff_0000_0000_0000, which ensures it falls within the valid physical address range.

Arguments

• addr: A usize representing the physical address.

Returns

• Some(Pa) if the address is valid.
• None if the address is outside the valid range.

Example:

let pa = Pa::new(0x1234_5678_9ABC_DEF0);

pub const fn into_usize(self) -> usize

Cast the physical address into a raw usize.

This method allows the physical address to be cast into a raw usize value, which can be used for low-level operations like pointer arithmetic or addressing.

Returns

• The underlying usize value representing the physical address.

pub const fn into_kva(self) -> Kva

Convert the physical address to a virtual address.

This method allows you to convert a Pa (physical address) to a [Kva] (kernel virtual address). The conversion uses a fixed offset to transform the physical address into a corresponding kernel virtual address.

Returns

• The corresponding kernel virtual address as a [Kva] instance.

Example:

let pa = Pa::new(0x1234_5678_9ABC_DEF0).unwrap();
let va = pa.into_kva();  // Convert the physical address to kernel virtual address

pub const fn page_down(self) -> Self

Align down the physical address to the page boundary.

pub const fn page_up(self) -> Self

Align up to the physical address to the page boundary.

pub const fn offset(self) -> usize

Extracts the page offset from the physical address.

This method retrieves the lower bits of the address that represent the offset within a memory page. The offset is useful when working with memory operations that need to determine the position within a page.

Returns

• The offset within the page as a usize.

Example

let pa = Pa::new(0x1234_5678).unwrap();
let offset = pa.offset();
assert_eq!(offset, 0x678); // Example offset within the page

Trait Implementations

impl Add<usize> for Pa

type Output = Pa

The resulting type after applying the + operator.

fn add(self, other: usize) -> Self::Output

Performs the + operation.

impl AddAssign<usize> for Pa

fn add_assign(&mut self, other: usize)

Performs the += operation.

impl BitAnd<usize> for Pa

type Output = Pa

The resulting type after applying the & operator.

fn bitand(self, other: usize) -> Self

Performs the & operation.

impl BitAndAssign<usize> for Pa

fn bitand_assign(&mut self, other: usize)

Performs the &= operation.

impl BitOr<usize> for Pa

type Output = Pa

The resulting type after applying the | operator.

fn bitor(self, other: usize) -> Self

Performs the | operation.

impl BitOrAssign<usize> for Pa

fn bitor_assign(&mut self, other: usize)

Performs the |= operation.

impl Clone for Pa

fn clone(&self) -> Pa

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Pa

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for Pa

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Ord for Pa

fn cmp(&self, other: &Pa) -> Ordering

This method returns an [Ordering] between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Pa

fn eq(&self, other: &Pa) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Pa

fn partial_cmp(&self, other: &Pa) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Sub<usize> for Pa

type Output = Pa

The resulting type after applying the - operator.

fn sub(self, other: usize) -> Self::Output

Performs the - operation.

impl Sub for Pa

type Output = usize

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self::Output

Performs the - operation.

impl SubAssign<usize> for Pa

fn sub_assign(&mut self, other: usize)

Performs the -= operation.

impl Copy for Pa

impl Eq for Pa

impl StructuralPartialEq for Pa