firmware: add DRTIO aux packet library (WIP)

artiq/firmware/libdrtioaux/Cargo.toml

@@ -0,0 +1,14 @@
+[package]
+authors = ["M-Labs"]
+name = "drtioaux"
+version = "0.0.0"
+
+[lib]
+name = "drtioaux"
+path = "lib.rs"
+
+[dependencies]
+log = { version = "0.3", default-features = false }
+std_artiq = { path = "../libstd_artiq", features = ["alloc"] }
+board = { path = "../libboard" }
+byteorder = { version = "1.0", default-features = false }

artiq/firmware/libdrtioaux/crc32.rs

@@ -0,0 +1,49 @@
+// Based on crc 1.4.0 by mrhooray
+
+static IEEE_TABLE: [u32; 256] = [
+    0x00000000, 0x77073096, 0xee0e612c, 0x990951ba, 0x076dc419, 0x706af48f, 0xe963a535, 0x9e6495a3,
+    0x0edb8832, 0x79dcb8a4, 0xe0d5e91e, 0x97d2d988, 0x09b64c2b, 0x7eb17cbd, 0xe7b82d07, 0x90bf1d91,
+    0x1db71064, 0x6ab020f2, 0xf3b97148, 0x84be41de, 0x1adad47d, 0x6ddde4eb, 0xf4d4b551, 0x83d385c7,
+    0x136c9856, 0x646ba8c0, 0xfd62f97a, 0x8a65c9ec, 0x14015c4f, 0x63066cd9, 0xfa0f3d63, 0x8d080df5,
+    0x3b6e20c8, 0x4c69105e, 0xd56041e4, 0xa2677172, 0x3c03e4d1, 0x4b04d447, 0xd20d85fd, 0xa50ab56b,
+    0x35b5a8fa, 0x42b2986c, 0xdbbbc9d6, 0xacbcf940, 0x32d86ce3, 0x45df5c75, 0xdcd60dcf, 0xabd13d59,
+    0x26d930ac, 0x51de003a, 0xc8d75180, 0xbfd06116, 0x21b4f4b5, 0x56b3c423, 0xcfba9599, 0xb8bda50f,
+    0x2802b89e, 0x5f058808, 0xc60cd9b2, 0xb10be924, 0x2f6f7c87, 0x58684c11, 0xc1611dab, 0xb6662d3d,
+    0x76dc4190, 0x01db7106, 0x98d220bc, 0xefd5102a, 0x71b18589, 0x06b6b51f, 0x9fbfe4a5, 0xe8b8d433,
+    0x7807c9a2, 0x0f00f934, 0x9609a88e, 0xe10e9818, 0x7f6a0dbb, 0x086d3d2d, 0x91646c97, 0xe6635c01,
+    0x6b6b51f4, 0x1c6c6162, 0x856530d8, 0xf262004e, 0x6c0695ed, 0x1b01a57b, 0x8208f4c1, 0xf50fc457,
+    0x65b0d9c6, 0x12b7e950, 0x8bbeb8ea, 0xfcb9887c, 0x62dd1ddf, 0x15da2d49, 0x8cd37cf3, 0xfbd44c65,
+    0x4db26158, 0x3ab551ce, 0xa3bc0074, 0xd4bb30e2, 0x4adfa541, 0x3dd895d7, 0xa4d1c46d, 0xd3d6f4fb,
+    0x4369e96a, 0x346ed9fc, 0xad678846, 0xda60b8d0, 0x44042d73, 0x33031de5, 0xaa0a4c5f, 0xdd0d7cc9,
+    0x5005713c, 0x270241aa, 0xbe0b1010, 0xc90c2086, 0x5768b525, 0x206f85b3, 0xb966d409, 0xce61e49f,
+    0x5edef90e, 0x29d9c998, 0xb0d09822, 0xc7d7a8b4, 0x59b33d17, 0x2eb40d81, 0xb7bd5c3b, 0xc0ba6cad,
+    0xedb88320, 0x9abfb3b6, 0x03b6e20c, 0x74b1d29a, 0xead54739, 0x9dd277af, 0x04db2615, 0x73dc1683,
+    0xe3630b12, 0x94643b84, 0x0d6d6a3e, 0x7a6a5aa8, 0xe40ecf0b, 0x9309ff9d, 0x0a00ae27, 0x7d079eb1,
+    0xf00f9344, 0x8708a3d2, 0x1e01f268, 0x6906c2fe, 0xf762575d, 0x806567cb, 0x196c3671, 0x6e6b06e7,
+    0xfed41b76, 0x89d32be0, 0x10da7a5a, 0x67dd4acc, 0xf9b9df6f, 0x8ebeeff9, 0x17b7be43, 0x60b08ed5,
+    0xd6d6a3e8, 0xa1d1937e, 0x38d8c2c4, 0x4fdff252, 0xd1bb67f1, 0xa6bc5767, 0x3fb506dd, 0x48b2364b,
+    0xd80d2bda, 0xaf0a1b4c, 0x36034af6, 0x41047a60, 0xdf60efc3, 0xa867df55, 0x316e8eef, 0x4669be79,
+    0xcb61b38c, 0xbc66831a, 0x256fd2a0, 0x5268e236, 0xcc0c7795, 0xbb0b4703, 0x220216b9, 0x5505262f,
+    0xc5ba3bbe, 0xb2bd0b28, 0x2bb45a92, 0x5cb36a04, 0xc2d7ffa7, 0xb5d0cf31, 0x2cd99e8b, 0x5bdeae1d,
+    0x9b64c2b0, 0xec63f226, 0x756aa39c, 0x026d930a, 0x9c0906a9, 0xeb0e363f, 0x72076785, 0x05005713,
+    0x95bf4a82, 0xe2b87a14, 0x7bb12bae, 0x0cb61b38, 0x92d28e9b, 0xe5d5be0d, 0x7cdcefb7, 0x0bdbdf21,
+    0x86d3d2d4, 0xf1d4e242, 0x68ddb3f8, 0x1fda836e, 0x81be16cd, 0xf6b9265b, 0x6fb077e1, 0x18b74777,
+    0x88085ae6, 0xff0f6a70, 0x66063bca, 0x11010b5c, 0x8f659eff, 0xf862ae69, 0x616bffd3, 0x166ccf45,
+    0xa00ae278, 0xd70dd2ee, 0x4e048354, 0x3903b3c2, 0xa7672661, 0xd06016f7, 0x4969474d, 0x3e6e77db,
+    0xaed16a4a, 0xd9d65adc, 0x40df0b66, 0x37d83bf0, 0xa9bcae53, 0xdebb9ec5, 0x47b2cf7f, 0x30b5ffe9,
+    0xbdbdf21c, 0xcabac28a, 0x53b39330, 0x24b4a3a6, 0xbad03605, 0xcdd70693, 0x54de5729, 0x23d967bf,
+    0xb3667a2e, 0xc4614ab8, 0x5d681b02, 0x2a6f2b94, 0xb40bbe37, 0xc30c8ea1, 0x5a05df1b, 0x2d02ef8d, 
+];
+
+pub fn update(mut value: u32, table: &[u32; 256], bytes: &[u8]) -> u32 {
+    value = !value;
+    for &i in bytes.iter() {
+        value = table[((value as u8) ^ i) as usize] ^ (value >> 8)
+    }
+    !value
+}
+
+pub fn checksum_ieee(bytes: &[u8]) -> u32 {
+    return update(0, &IEEE_TABLE, bytes);
+}
+

artiq/firmware/libdrtioaux/lib.rs

@@ -0,0 +1,147 @@
+#![no_std]
+
+#[macro_use]
+extern crate std_artiq as std;
+#[macro_use]
+extern crate log;
+extern crate board;
+extern crate byteorder;
+
+mod proto;
+mod crc32;
+
+use std::io::{self, Cursor, Read, Write};
+use core::slice;
+use proto::*;
+
+#[derive(Debug)]
+pub enum Packet {
+    EchoRequest,
+    EchoReply,
+    //MonitorRequest,
+    //MonitorReply
+}
+
+impl Packet {
+    pub fn read_from(reader: &mut Read) -> io::Result<Packet> {
+        Ok(match read_u8(reader)? {
+            0 => Packet::EchoRequest,
+            1 => Packet::EchoReply,
+            _ => return Err(io::Error::new(io::ErrorKind::InvalidData, "unknown packet type"))
+        })
+    }
+
+    pub fn write_to(&self, writer: &mut Write) -> io::Result<()> {
+        match *self {
+            Packet::EchoRequest => write_u8(writer, 0)?,
+            Packet::EchoReply => write_u8(writer, 1)?
+        }
+        Ok(())
+    }
+}
+
+const AUX_TX_BASE: usize = board::mem::DRTIO_AUX_BASE;
+const AUX_TX_SIZE: usize = board::mem::DRTIO_AUX_SIZE/2;
+const AUX_RX_BASE: usize = AUX_TX_BASE + AUX_TX_SIZE;
+
+fn rx_has_error() -> bool {
+    unsafe {
+        let error = board::csr::drtio::aux_rx_error_read() != 0;
+        if error {
+            board::csr::drtio::aux_rx_error_write(1)
+        }
+        error
+    }
+}
+
+pub struct RxBuffer(&'static [u8]);
+
+impl Drop for RxBuffer {
+    fn drop(&mut self) {
+        unsafe {
+            board::csr::drtio::aux_rx_present_write(1);
+        }
+    }
+}
+
+fn rx_get_buffer() -> Option<RxBuffer> {
+    unsafe {
+        if board::csr::drtio::aux_rx_present_read() == 1 {
+            let length = board::csr::drtio::aux_rx_length_read();
+            let sl = slice::from_raw_parts(AUX_RX_BASE as *mut u8, length as usize);
+            Some(RxBuffer(sl))
+        } else {
+            None
+        }
+    }
+}
+
+pub fn recv_packet() -> io::Result<Option<Packet>> {
+    if rx_has_error() {
+        return Err(io::Error::new(io::ErrorKind::Other, "gateware reported error"))
+    }
+    let buffer = rx_get_buffer();
+    match buffer {
+        Some(rxb) => {
+            let slice = rxb.0;
+            let mut reader = Cursor::new(slice);
+
+            let len = slice.len();
+            if len < 8 {
+                return Err(io::Error::new(io::ErrorKind::InvalidData, "packet too short"))
+            }
+            let computed_crc = crc32::checksum_ieee(&reader.get_ref()[0..len-4]);
+            reader.set_position((len-4) as u64);
+            let crc = read_u32(&mut reader)?;
+            if crc != computed_crc {
+                return Err(io::Error::new(io::ErrorKind::InvalidData, "packet CRC failed"))
+            }
+            reader.set_position(0);
+
+            let packet_r = Packet::read_from(&mut reader);
+            match packet_r {
+                Ok(packet) => Ok(Some(packet)),
+                Err(e) => Err(e)
+            }
+        }
+        None => Ok(None)
+    }
+}
+
+fn tx_get_buffer() -> &'static mut [u8] {
+    unsafe {
+        while board::csr::drtio::aux_tx_read() != 0 {}
+        slice::from_raw_parts_mut(AUX_TX_BASE as *mut u8, AUX_TX_SIZE)
+    }
+}
+
+fn tx_ack_buffer(length: u16) {
+    unsafe {
+        board::csr::drtio::aux_tx_length_write(length);
+        board::csr::drtio::aux_tx_write(1)
+    }
+}
+
+pub fn send_packet(packet: &Packet) -> io::Result<()> {
+    let sl = tx_get_buffer();
+
+    let mut writer = Cursor::new(sl);
+    packet.write_to(&mut writer)?;
+    let mut len = writer.position();
+
+    let padding = 4 - (len % 4);
+    if padding != 4 {
+        for _ in 0..padding {
+            write_u8(&mut writer, 0)?;
+        }
+        len += padding;
+    }
+
+    let crc = crc32::checksum_ieee(&writer.get_ref()[0..len as usize]);
+    write_u32(&mut writer, crc)?;
+    len += 4;
+
+    tx_ack_buffer(len as u16);
+
+    Ok(())
+}

artiq/firmware/libdrtioaux/proto.rs

@@ -0,0 +1,76 @@
+#![allow(dead_code)]
+
+use std::io::{self, Read, Write};
+use std::vec::Vec;
+use std::string::String;
+use byteorder::{ByteOrder, NetworkEndian};
+
+// FIXME: replace these with byteorder core io traits once those are in
+pub fn read_u8(reader: &mut Read) -> io::Result<u8> {
+    let mut bytes = [0; 1];
+    reader.read_exact(&mut bytes)?;
+    Ok(bytes[0])
+}
+
+pub fn write_u8(writer: &mut Write, value: u8) -> io::Result<()> {
+    let bytes = [value; 1];
+    writer.write_all(&bytes)
+}
+
+pub fn read_u16(reader: &mut Read) -> io::Result<u16> {
+    let mut bytes = [0; 2];
+    reader.read_exact(&mut bytes)?;
+    Ok(NetworkEndian::read_u16(&bytes))
+}
+
+pub fn write_u16(writer: &mut Write, value: u16) -> io::Result<()> {
+    let mut bytes = [0; 2];
+    NetworkEndian::write_u16(&mut bytes, value);
+    writer.write_all(&bytes)
+}
+
+pub fn read_u32(reader: &mut Read) -> io::Result<u32> {
+    let mut bytes = [0; 4];
+    reader.read_exact(&mut bytes)?;
+    Ok(NetworkEndian::read_u32(&bytes))
+}
+
+pub fn write_u32(writer: &mut Write, value: u32) -> io::Result<()> {
+    let mut bytes = [0; 4];
+    NetworkEndian::write_u32(&mut bytes, value);
+    writer.write_all(&bytes)
+}
+
+pub fn read_u64(reader: &mut Read) -> io::Result<u64> {
+    let mut bytes = [0; 8];
+    reader.read_exact(&mut bytes)?;
+    Ok(NetworkEndian::read_u64(&bytes))
+}
+
+pub fn write_u64(writer: &mut Write, value: u64) -> io::Result<()> {
+    let mut bytes = [0; 8];
+    NetworkEndian::write_u64(&mut bytes, value);
+    writer.write_all(&bytes)
+}
+
+pub fn read_bytes(reader: &mut Read) -> io::Result<Vec<u8>> {
+    let length = read_u32(reader)?;
+    let mut value = vec![0; length as usize];
+    reader.read_exact(&mut value)?;
+    Ok(value)
+}
+
+pub fn write_bytes(writer: &mut Write, value: &[u8]) -> io::Result<()> {
+    write_u32(writer, value.len() as u32)?;
+    writer.write_all(value)
+}
+
+pub fn read_string(reader: &mut Read) -> io::Result<String> {
+    let bytes = read_bytes(reader)?;
+    String::from_utf8(bytes)
+           .map_err(|_| io::Error::new(io::ErrorKind::InvalidData, "invalid UTF-8"))
+}
+
+pub fn write_string(writer: &mut Write, value: &str) -> io::Result<()> {
+    write_bytes(writer, value.as_bytes())
+}