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
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

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

//! System console.

mod buffer_console;

use super::synchronization;

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

/// Console interfaces.
pub mod interface
{
  use core::fmt;

  /// Console write functions.
  pub trait Write
  {
    /// Write a single character.
    fn write_char(&self, c: char);

    /// Write a slice of characters.
    fn write_array(&self, a: &[char]);

    /// Write a Rust format string.
    fn write_fmt(&self, args: fmt::Arguments) -> fmt::Result;

    /// Block until the last buffered character has been physically put on the TX wire.
    fn flush(&self);
  }

  /// Console read functions.
  pub trait Read
  {
    /// Read a single character.
    fn read_char(&self) -> char
    {
      ' '
    }

    /// Clear RX buffers, if any.
    fn clear_rx(&self);
  }

  /// Console statistics.
  pub trait Statistics
  {
    /// Return the number of characters written.
    fn chars_written(&self) -> usize
    {
      0
    }

    /// Return the number of characters read.
    fn chars_read(&self) -> usize
    {
      0
    }
  }

  /// Trait alias for a full-fledged console.
  pub trait All: Write + Read + Statistics {}
}

//--------------------------------------------------------------------------------------------------
// Global instances
//--------------------------------------------------------------------------------------------------

static CUR_CONSOLE: InitStateLock<&'static (dyn interface::All + Sync)> =
  InitStateLock::new(&buffer_console::BUFFER_CONSOLE);

//--------------------------------------------------------------------------------------------------
// Public Code
//--------------------------------------------------------------------------------------------------
use synchronization::{interface::ReadWriteEx, InitStateLock};

/// Register a new console.
pub fn register_console(new_console: &'static (dyn interface::All + Sync))
{
  CUR_CONSOLE.write(|con| *con = new_console);

  static FIRST_SWITCH: InitStateLock<bool> = InitStateLock::new(true);
  FIRST_SWITCH.write(|first| {
    if *first
    {
      *first = false;

      buffer_console::BUFFER_CONSOLE.dump();
    }
  });
}

/// Return a reference to the currently registered console.
///
/// This is the global console used by all printing macros.
pub fn console() -> &'static dyn interface::All
{
  CUR_CONSOLE.read(|con| *con)
}