UART RusPiRo crate

This crate provides access to the Uart0 (miniUART) peripheral of the Raspberry Pi. This is quite helpful during bare metal development to use an terminal console connected to the miniUART of the Raspberry Pi to get some debug information printed while the program is executed on the device. Especialy if the program is in a state where there is no other output option.

Usage

To use the crate just add the following dependency to your Cargo.toml file:

[dependencies]
ruspiro-uart = "0.0.2"

Once done the access to the UART abstraction is available in your rust files like so:

use ruspiro_uart::Uart0;

fn demo() {
    let mut uart = Uart0::new();
    if uart.initialize(25_000_000, 115_200).is_ok() {
        uart.send_string("This is some string");
    }
}

In this example the Uart0 will be no longer be available once it goes out of scope. Whichs makes it a bit cumbersome to use it in a real world example. Therefore the proposed usage of the UART is to use it as a generic console output channel. To do so, please refer to the ruspiro-console crate. But in case you would like to use the uart without the console abstraction it is recommended to wrap it into a singleton to guaranty safe cross core access and only 1 time initialization. In the example we pass a fixed core clock rate to the initialization function. However, the real core clock rate could be optained with a call to the mailbox property tag interface of the Raspberry Pi (see ruspiro-mailbox for details.). This mailbox crate is not linked into the Uart crate to ensure usability of this crate with as less dependencies as possible.

use ruspiro_singleton::Singleton; // don't forget the dependency to be setup
use ruspiro_uart::Uart0;

static UART: Singleton<Uart0> = Singleton::new(Uart0::new());

fn demo() {
    let _ = UART.take_for(|uart| uart.initialize(250_000_000, 115_200)); // initialize(...) gives a Result, you may want to panic if there is an Error returned.

    print_something("Hello Uart...");
}

fn print_something(s: &str) {
    UART.take_for(|uart| uart.send_string(s));
}

License

This crate is licensed under MIT license (LICENSE or http://opensource.org/licenses/MIT)