sdio 0.2.0

SD host protocol library
Documentation
use embedded_hal::delay::DelayNs;
use embedded_hal::digital::OutputPin;
use embedded_hal::spi::SpiBus;

use crate::{
    BlockReadCommand, BlockWriteCommand, BusWidth, ByteReadCommand, ByteWriteCommand, Command,
    ControlCommand, MmcBus, MmcError, Response, ResponseLen,
};

/// Trait that allows setting SPI freq.
pub trait SetHz {
    fn set_hz(&mut self, hz: u32);
}

/// Simple SPI-backed MMC/SD bus in SPI mode.
///
/// This is currently implemented using blocking SPI.
/// It has also not been tested. Users are welcome to
/// implement a version that uses async SPI and/or
/// fix any issues with this impl.
pub struct SpiMmcBus<SPI, CS, DLY> {
    spi: SPI,
    cs: CS,
    delay: DLY,
}

impl<SPI, CS, DLY> SpiMmcBus<SPI, CS, DLY> {
    pub fn new(spi: SPI, cs: CS, delay: DLY) -> Self {
        Self { spi, cs, delay }
    }

    fn select(&mut self) -> Result<(), MmcError>
    where
        CS: OutputPin,
    {
        self.cs.set_low().map_err(|_| MmcError::Io)
    }

    fn deselect(&mut self) -> Result<(), MmcError>
    where
        CS: OutputPin,
        SPI: SpiBus<u8>,
    {
        self.cs.set_high().map_err(|_| MmcError::Io)?;
        // One extra 8 clocks after CS high is recommended
        let _ = self.spi.write(&[0xFF]);
        Ok(())
    }

    fn crc7(mut v: u32) -> u8 {
        // Compute CRC7 over 40 bits: [cmd | arg]
        let mut crc: u8 = 0;
        for _ in 0..40 {
            crc <<= 1;
            if ((v & 0x8000_0000) != 0) ^ ((crc & 0x80) != 0) {
                crc ^= 0x09;
            }
            v <<= 1;
        }
        (crc << 1) | 1
    }

    fn send_cmd_header<C: Command>(&mut self, cmd: &C) -> Result<(), MmcError>
    where
        SPI: SpiBus<u8>,
        CS: OutputPin,
    {
        self.select()?;

        // Command frame: [0b01xxxxxx, arg(4), crc]
        let idx = cmd.index() & 0x3F;
        let arg = cmd.arg();
        let header = ((0x40u32 | idx as u32) << 24) | (arg >> 8);
        let crc = Self::crc7(header);

        let buf = [
            0x40 | idx,
            (arg >> 24) as u8,
            (arg >> 16) as u8,
            (arg >> 8) as u8,
            arg as u8,
            crc,
        ];

        self.spi.write(&buf).map_err(|_| MmcError::Io)
    }

    fn read_r1(&mut self) -> Result<u8, MmcError>
    where
        SPI: SpiBus<u8>,
    {
        // Response is signaled by a non-0xFF byte within 8 bytes
        let mut b = [0xFF];
        for _ in 0..8 {
            self.spi.read(&mut b).map_err(|_| MmcError::Io)?;
            if b[0] != 0xFF {
                return Ok(b[0]);
            }
        }
        Err(MmcError::Timeout)
    }

    fn read_response_words<R: Response>(&mut self) -> Result<R, MmcError>
    where
        SPI: SpiBus<u8>,
    {
        // First byte is R1; the rest depends on LEN
        let r1 = self.read_r1()?;

        let total_bytes = match R::LEN {
            ResponseLen::Zero => 0,
            ResponseLen::R48 => 5,   // R1 + 4 data bytes
            ResponseLen::R136 => 16, // R1 + 15 data bytes
        };

        let mut raw = [0u8; 1 + 16];
        raw[0] = r1;

        if total_bytes > 0 {
            let mut tmp = [0xFFu8; 16];
            self.spi
                .read(&mut tmp[..total_bytes])
                .map_err(|_| MmcError::Io)?;
            raw[1..=total_bytes].copy_from_slice(&tmp[..total_bytes]);
        }

        // Pack into 4 u32 words, big-endian
        let mut words = [0u32; 4];
        for (i, chunk) in raw[..=total_bytes].chunks(4).enumerate() {
            let mut w = 0u32;
            for &b in chunk {
                w = (w << 8) | b as u32;
            }
            words[i] = w;
        }

        // Optionally wait for busy release
        if R::BUSY {
            self.wait_not_busy()?;
        }

        Ok(R::from_words(&words))
    }

    fn wait_not_busy(&mut self) -> Result<(), MmcError>
    where
        SPI: SpiBus<u8>,
    {
        let mut b = [0xFF];
        for _ in 0..65_536 {
            self.spi.read(&mut b).map_err(|_| MmcError::Io)?;
            if b[0] == 0xFF {
                return Ok(());
            }
        }
        Err(MmcError::Busy)
    }

    fn read_block(&mut self, buf: &mut [u8]) -> Result<(), MmcError>
    where
        SPI: SpiBus<u8>,
    {
        // Wait for data token 0xFE
        let mut b = [0xFF];
        for _ in 0..65_536 {
            self.spi.read(&mut b).map_err(|_| MmcError::Io)?;
            if b[0] == 0xFE {
                break;
            }
        }
        if b[0] != 0xFE {
            return Err(MmcError::Timeout);
        }

        // Read data
        let mut tmp = [0xFFu8; 512];
        let len = buf.len().min(512);
        self.spi.read(&mut tmp[..len]).map_err(|_| MmcError::Io)?;
        buf.copy_from_slice(&tmp[..len]);

        // Discard CRC
        let mut crc = [0xFFu8; 2];
        self.spi.read(&mut crc).map_err(|_| MmcError::Io)?;

        Ok(())
    }

    fn write_block(&mut self, buf: &[u8]) -> Result<(), MmcError>
    where
        SPI: SpiBus<u8>,
    {
        // Start token for single block write
        self.spi.write(&[0xFE]).map_err(|_| MmcError::Io)?;

        // Write data
        self.spi.write(buf).map_err(|_| MmcError::Io)?;

        // Dummy CRC
        self.spi.write(&[0xFF, 0xFF]).map_err(|_| MmcError::Io)?;

        // Data response token
        let mut resp = [0xFF];
        self.spi.read(&mut resp).map_err(|_| MmcError::Io)?;
        if (resp[0] & 0x1F) != 0x05 {
            return Err(MmcError::Crc);
        }

        // Wait until not busy
        self.wait_not_busy()
    }
}

impl<SPI, CS, DLY, E> MmcBus for SpiMmcBus<SPI, CS, DLY>
where
    SPI: SpiBus<u8, Error = E> + SetHz,
    CS: OutputPin,
    DLY: DelayNs,
{
    async fn send_command<'a, C>(&'a mut self, cmd: C) -> Result<C::Resp<'a>, MmcError>
    where
        C: ControlCommand + 'a,
    {
        self.send_cmd_header(&cmd)?;
        let resp = self.read_response_words::<C::Resp<'_>>()?;
        self.deselect()?;
        Ok(resp)
    }

    async fn read_blocks<'a, C>(&mut self, mut cmd: C) -> Result<C::Resp<'a>, MmcError>
    where
        C: BlockReadCommand + 'a,
    {
        self.send_cmd_header(&cmd)?;
        let block_size = cmd.block_size();
        let total = cmd.block_size() as usize * cmd.block_count() as usize;
        let buf = cmd.buf();
        let slice = &mut buf[..total];

        for chunk in slice.chunks_mut(block_size as usize) {
            self.read_block(chunk)?;
        }

        let resp = self.read_response_words::<C::Resp<'_>>()?;
        self.deselect()?;
        Ok(resp)
    }

    async fn write_blocks<'a, C>(&mut self, cmd: C) -> Result<C::Resp<'a>, MmcError>
    where
        C: BlockWriteCommand + 'a,
    {
        self.send_cmd_header(&cmd)?;
        let total = cmd.block_size() as usize * cmd.block_count() as usize;
        let buf = cmd.buf();
        let slice = &buf[..total];

        for chunk in slice.chunks(cmd.block_size() as usize) {
            self.write_block(chunk)?;
        }

        let resp = self.read_response_words::<C::Resp<'_>>()?;
        self.deselect()?;
        Ok(resp)
    }

    async fn read_bytes<'a, C>(&mut self, mut cmd: C) -> Result<C::Resp<'a>, MmcError>
    where
        C: ByteReadCommand + 'a,
    {
        self.send_cmd_header(&cmd)?;
        let len = cmd.byte_count();
        let buf = cmd.buf();
        let slice = &mut buf[..len];

        // For SPI multi-byte reads, many controllers just stream after a token.
        // Here we reuse the block read helper but with arbitrary length.
        self.read_block(slice)?;

        let resp = self.read_response_words::<C::Resp<'_>>()?;
        self.deselect()?;
        Ok(resp)
    }

    async fn write_bytes<'a, C>(&mut self, cmd: C) -> Result<C::Resp<'a>, MmcError>
    where
        C: ByteWriteCommand + 'a,
    {
        self.send_cmd_header(&cmd)?;
        let len = cmd.byte_count();
        let buf = cmd.buf();
        let slice = &buf[..len];

        self.write_block(slice)?;

        let resp = self.read_response_words::<C::Resp<'_>>()?;
        self.deselect()?;
        Ok(resp)
    }

    async fn init_idle(&mut self, hz: u32) -> Result<(), MmcError> {
        self.spi.set_hz(hz);

        // CS high, 74+ clocks with MOSI high
        self.cs.set_high().map_err(|_| MmcError::Io)?;
        let dummy = [0xFFu8; 10];
        self.spi.write(&dummy).map_err(|_| MmcError::Io)?;
        self.delay.delay_us(1000);
        Ok(())
    }

    async fn set_bus(&mut self, _width: BusWidth, hz: u32) -> Result<(), MmcError> {
        self.spi.set_hz(hz);

        Ok(())
    }
}