Support auto-generated cores

Author: dylanmckay

Cargo.toml

@@ -13,3 +13,7 @@ description = """
 Reusable components for the Arduino Uno.
 """
 keywords = ["avr", "arduino", "uno"]
+
+[build-dependencies]
+avr-mcu = "0.2"
+

avr-atmega328p.json

@@ -0,0 +1,26 @@
+{
+  "llvm-target": "avr-unknown-unknown",
+  "cpu": "atmega328p",
+  "target-endian": "little",
+  "target-pointer-width": "16",
+  "os": "unknown",
+  "target-env": "",
+  "target-vendor": "unknown",
+  "arch": "avr",
+  "data-layout": "e-p:16:8-i8:8-i16:8-i32:8-i64:8-f32:8-f64:8-n8-a:8",
+
+  "executables": true,
+
+  "linker": "avr-gcc",
+  "linker-flavor": "gcc",
+  "pre-link-args": {
+    "gcc": ["-Os", "-mmcu=atmega328p"]
+  },
+  "exe-suffix": ".elf",
+  "post-link-args": {
+    "gcc": ["-Wl,--gc-sections"]
+  },
+
+  "no-default-libraries": false
+}
+

build.rs

@@ -0,0 +1,161 @@
+extern crate avr_mcu;
+
+use avr_mcu::*;
+use std::fs::{self, File};
+use std::io;
+use std::io::prelude::*;
+use std::path::{Path, PathBuf};
+
+fn cores_path() -> PathBuf {
+    Path::new(env!("CARGO_MANIFEST_DIR")).join("src").join("cores")
+}
+
+fn core_module_name(mcu: &Mcu) -> String {
+    mcu.device.name.to_lowercase().to_owned()
+}
+
+fn main() {
+    if !cores_path().exists() {
+        fs::create_dir_all(&cores_path()).expect("could not create cores directory");
+    }
+
+    let current_mcu = avr_mcu::current::mcu()
+        .expect("no target cpu specified");
+    generate_cores(&[current_mcu]).unwrap()
+}
+
+fn generate_cores(mcus: &[Mcu]) -> Result<(), io::Error> {
+    for mcu in mcus {
+        generate_core_module(mcu).expect("failed to generate mcu core");
+    }
+    generate_cores_mod_rs(mcus)
+}
+
+fn generate_core_module(mcu: &Mcu) -> Result<(), io::Error> {
+    let path = cores_path().join(format!("{}.rs", core_module_name(mcu)));
+    let mut file = File::create(&path)?;
+    write_core_module(mcu, &mut file)
+}
+
+fn generate_cores_mod_rs(mcus: &[Mcu]) -> Result<(), io::Error> {
+    let path = cores_path().join("mod.rs");
+    let mut w = File::create(&path)?;
+
+    writeln!(w, "//! Cores")?;
+    writeln!(w)?;
+    for mcu in mcus {
+        writeln!(w, "/// The {}.", mcu.device.name)?;
+        writeln!(w, "pub mod {};", core_module_name(mcu))?;
+    }
+    writeln!(w)
+}
+
+fn write_core_module(mcu: &Mcu, w: &mut Write) -> Result<(), io::Error> {
+    writeln!(w, "//! Core for {}.", mcu.device.name)?;
+    writeln!(w)?;
+    writeln!(w, "use {{HardwareSpi, Pin, Register}};")?;
+    writeln!(w)?;
+
+    gen::write_registers(mcu, w)?;
+    gen::write_pins(mcu, w)?;
+    gen::write_spi_modules(mcu, w)?;
+
+    writeln!(w)
+}
+
+mod gen {
+    use avr_mcu::*;
+    use std::io;
+    use std::io::prelude::*;
+
+    pub fn write_registers(mcu: &Mcu, w: &mut Write) -> Result<(), io::Error> {
+        for register in mcu.registers() {
+            let ty = if register.size == 1 { "u8" } else { "u16" };
+
+            // HACK: Skip, atmeg328p pack defines two of these.
+            if register.name == "GTCCR" { continue; }
+
+            writeln!(w, "pub struct {};", register.name)?;
+            writeln!(w, "impl Register<{}> for {} {{", ty, register.name)?;
+            writeln!(w, "    const ADDR: *mut {} = 0x{:x} as *mut {};", ty, register.offset, ty)?;
+            writeln!(w, "}}")?;
+        }
+
+        Ok(())
+    }
+
+    pub fn write_pins(mcu: &Mcu, w: &mut Write) -> Result<(), io::Error> {
+        if let Some(port) = mcu.peripheral("PORT") {
+            for instance in port.instances.iter() {
+                for signal in instance.signals.iter() {
+                    let idx = signal.index.expect("signal with no index");
+                    let struct_name = pin_name(instance, signal);
+
+                    let io_module = mcu.modules.iter().find(|m| m.name == "PORT")
+                        .expect("no port io module defined for this port");
+                    let register_group = io_module.register_groups.iter()
+                        .find(|rg| rg.name == instance.name)
+                        .expect("no register group defined for this port");
+
+                    writeln!(w, "pub struct {};", struct_name)?;
+                    writeln!(w)?;
+                    writeln!(w, "impl Pin for {} {{", struct_name)?;
+                    for reg in register_group.registers.iter() {
+                        let mut const_name = reg.name.clone();
+                        const_name.pop(); // Pop port character from register name (DDRB/PORTB/etc)..
+
+                        writeln!(w, "    /// {}.", reg.caption)?;
+                        writeln!(w, "    type {} = {};", const_name, reg.name)?;
+                    }
+                    writeln!(w, "    /// {}", signal.pad)?;
+                    writeln!(w, "    const MASK: u8 = 1<<{};", idx)?;
+                    writeln!(w, "}}")?;
+                    writeln!(w)?;
+                }
+            }
+        }
+        Ok(())
+    }
+
+    pub fn write_spi_modules(mcu: &Mcu, w: &mut Write) -> Result<(), io::Error> {
+        if let Some(module) = mcu.module("SPI") {
+            let peripheral = mcu.peripheral("SPI").expect("found SPI module but no peripheral");
+            let port_peripheral = mcu.port_peripheral();
+
+            writeln!(w, "pub struct Spi;")?;
+            writeln!(w)?;
+            writeln!(w, "impl HardwareSpi for Spi {{")?;
+
+            for spi_signal in peripheral.signals() {
+                let spi_signal_name = spi_signal.group.clone().expect("spi signal does not have group name");
+                let (port_instance, port_signal) = port_peripheral.instance_signal_with_pad(&spi_signal.pad)
+                    .expect("no port signal associated with the spi signal pad");
+                let pin_name = self::pin_name(port_instance, port_signal);
+
+                writeln!(w, "    type {} = {};", spi_signal_name, pin_name)?;
+            }
+
+            for reg in module.registers() {
+                let const_name = match &reg.caption[..] {
+                    "SPI Data Register" => "SPDR",
+                    "SPI Status Register" => "SPSR",
+                    "SPI Control Register" => "SPCR",
+                    _ => panic!("unknown SPI module register: '{}'", reg.caption),
+                };
+
+
+                writeln!(w, "    /// {}.", reg.caption)?;
+                writeln!(w, "    type {} = {};", const_name, reg.name)?;
+            }
+            writeln!(w, "}}")?;
+        }
+        Ok(())
+    }
+
+    /// Gets the name of a pin.
+    fn pin_name(instance: &Instance, signal: &Signal) -> String {
+        let idx = signal.index.expect("signal with no index");
+        format!("{}{}", instance.name, idx)
+    }
+}
+

build.sh

@@ -0,0 +1,2 @@
+#! /bin/sh
+xargo build --target avr-atmega328p

src/cores/.gitignore

@@ -0,0 +1 @@
+*.rs

src/cores/.gitkeep

@@ -1,15 +1,28 @@
 //! Definitions of register addresses and bits within those registers
 
 #![feature(asm)]
-#![feature(no_core)]
-#![no_core]
+#![feature(associated_consts)]
 
-extern crate core;
+#![no_std]
+
+pub use self::reg::Register;
+pub use self::pin::Pin;
+pub use self::spi::HardwareSpi;
 
 pub mod prelude;
+pub mod serial;
 pub mod timer0;
 pub mod timer1;
-pub mod serial;
+pub mod cores;
+
+mod reg;
+mod pin;
+mod spi;
+
+pub enum DataDirection {
+    Input,
+    Output,
+}
 
 macro_rules! bit {
     (-, $pos:expr) => {};

src/lib.rs

@@ -0,0 +1,73 @@
+use {DataDirection, Register};
+
+/// An IO pin.
+pub trait Pin {
+    /// The associated data direction registerr.
+    type DDR: Register<u8>;
+    /// The associated port register.
+    type PORT: Register<u8>;
+    /// The associated pin register.
+    ///
+    /// Reads from the register will read input bits.
+    /// Writes to the register will toggle bits.
+    type PIN: Register<u8>;
+    /// The mask of the pin used for accessing registers.
+    const MASK: u8;
+
+    /// Sets the data direction of the pin.
+    fn set_direction(direction: DataDirection) {
+        match direction {
+            DataDirection::Input => Self::set_input(),
+            DataDirection::Output => Self::set_output(),
+        }
+    }
+
+    /// Sets the pin up as an input.
+    fn set_input() {
+        Self::DDR::unset(Self::MASK);
+    }
+
+    /// Sets the pin up as an output.
+    fn set_output() {
+        Self::DDR::set(Self::MASK);
+    }
+
+    /// Set the pin to high.
+    ///
+    /// The pin must be configured as an output.
+    fn set_high() {
+        Self::PORT::set(Self::MASK);
+    }
+
+    /// Set the pin to low.
+    ///
+    /// The pin must be configured as an output.
+    fn set_low() {
+        Self::PORT::unset(Self::MASK);
+    }
+
+    /// Toggles the pin.
+    ///
+    /// The pin must be configured as an output.
+    fn toggle() {
+        // FIXME: We can optimise this on post-2006 AVRs.
+        // http://www.avrfreaks.net/forum/toggle-state-output-pin
+        // set(Self::PIN, Self::MASK);
+        Self::PORT::toggle(Self::MASK);
+    }
+
+    /// Check if the pin is currently high.
+    ///
+    /// The pin must be configured as an input.
+    fn is_high() -> bool {
+        Self::PIN::is_set(Self::MASK)
+    }
+
+    /// Checks if the pin is currently low.
+    ///
+    /// The pin must be configured as an input.
+    fn is_low() -> bool {
+        Self::PIN::is_clear(Self::MASK)
+    }
+}
+

src/pin.rs

@@ -0,0 +1,86 @@
+use core::{cmp, convert, ops};
+
+pub trait RegVal : Copy + Clone +
+               ops::BitAnd<Output=Self> +
+               ops::BitAndAssign +
+               ops::BitOr<Output=Self> +
+               ops::BitOrAssign +
+               ops::BitXor<Output=Self> +
+               ops::BitXorAssign +
+               ops::Not<Output=Self> +
+               cmp::PartialEq + cmp::Eq +
+               cmp::PartialOrd + cmp::Ord +
+               convert::From<u8> {
+}
+
+/// A register.
+pub trait Register<T: RegVal> {
+    /// The address of the register.
+    const ADDR: *mut T;
+
+    /// Writes a value to the register.
+    fn write(value: T) {
+        unsafe {
+            *Self::ADDR = value;
+        }
+    }
+
+    /// Reads the value of the register.
+    fn read() -> T {
+        unsafe { *Self::ADDR }
+    }
+
+    /// Sets a bitmask in a register.
+    fn set(mask: T) {
+        unsafe {
+            *Self::ADDR |= mask;
+        }
+    }
+
+    /// Clears a bitmask from a register.
+    fn unset(mask: T) {
+        unsafe {
+            *Self::ADDR &= !mask;
+        }
+    }
+
+    /// Toggles a mask in the register.
+    fn toggle(mask: T) {
+        unsafe {
+            *Self::ADDR ^= mask;
+        }
+    }
+
+    /// Checks if a mask is set in the register.
+    fn is_set(mask: T) -> bool {
+        unsafe {
+            (*Self::ADDR & mask) == mask
+        }
+    }
+
+    /// Checks if a mask is clear in the register.
+    fn is_clear(mask: T) -> bool {
+        unsafe {
+            (*Self::ADDR & mask) == T::from(0)
+        }
+    }
+
+    /// Waits until some condition is true of the register.
+    fn wait_until<F>(mut f: F)
+        where F: FnMut() -> bool {
+        loop {
+            if f() {
+                break;
+            }
+        }
+    }
+
+    /// Waits until a mask is set.
+    fn wait_until_set(mask: T) {
+        Self::wait_until(|| Self::is_set(mask))
+    }
+}
+
+impl RegVal for u8 { }
+impl RegVal for u16 { }
+