mango-hal 0.2.1

Hardware Abstraction Layer for the mango operationg system.
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

// SPDX-License-Identifier: MIT OR Apache-2.0
//
// Copyright (c) 2020-2023 Andre Richter <andre.o.richter@gmail.com>

//! Common device driver code.

use crate::systems::rpi::memory::{Address, Virtual};
use core::{fmt, marker::PhantomData, ops};

//--------------------------------------------------------------------------------------------------
// Public Definitions
//--------------------------------------------------------------------------------------------------

pub struct MMIODerefWrapper<T>
{
  start_addr: Address<Virtual>,
  phantom: PhantomData<fn() -> T>,
}

/// A wrapper type for usize with integrated range bound check.
#[derive(Copy, Clone)]
pub struct BoundedUsize<const MAX_INCLUSIVE: usize>(usize);

//--------------------------------------------------------------------------------------------------
// Public Code
//--------------------------------------------------------------------------------------------------

impl<T> MMIODerefWrapper<T>
{
  /// Create an instance.
  pub const unsafe fn new(start_addr: Address<Virtual>) -> Self
  {
    Self {
      start_addr,
      phantom: PhantomData,
    }
  }
}

impl<T> ops::Deref for MMIODerefWrapper<T>
{
  type Target = T;

  fn deref(&self) -> &Self::Target
  {
    unsafe { &*(self.start_addr.as_usize() as *const _) }
  }
}

impl<const MAX_INCLUSIVE: usize> BoundedUsize<{ MAX_INCLUSIVE }>
{
  pub const MAX_INCLUSIVE: usize = MAX_INCLUSIVE;

  /// Creates a new instance if number <= MAX_INCLUSIVE.
  pub const fn new(number: usize) -> Self
  {
    assert!(number <= MAX_INCLUSIVE);

    Self(number)
  }

  /// Return the wrapped number.
  pub const fn get(self) -> usize
  {
    self.0
  }
}

impl<const MAX_INCLUSIVE: usize> fmt::Display for BoundedUsize<{ MAX_INCLUSIVE }>
{
  fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result
  {
    write!(f, "{}", self.0)
  }
}