start adding argument and response module

Author: robamu

src/sdcard/mod.rs

@@ -77,6 +77,386 @@ pub const ACMD41: u8 = 0x29;
 
 //==============================================================================
 
+/// Argument module. Arguments are additional command parameters.
+pub mod argument {
+    use arbitrary_int::u24;
+
+    /// Voltage settings supplied in CMD8.
+    #[bitbybit::bitenum(u4, exhaustive = false)]
+    #[derive(Debug, Default, PartialEq, Eq)]
+    pub enum VoltageSuppliedSelect {
+        /// Regular voltage range.
+        #[default]
+        _2_7To3_6V = 0b0001,
+        /// Reserved for low voltage.
+        LowVoltageRange = 0b0010,
+    }
+
+    /// CMD8 argument.
+    #[bitbybit::bitfield(u32, default = 0x0)]
+    pub struct Cmd8 {
+        /// PCIe v1.2 support.
+        #[bit(13, rw)]
+        pcie_1_2v_support: bool,
+        /// PCIe available.
+        #[bit(12, rw)]
+        pcie_availability: bool,
+        /// Voltage settings.
+        #[bits(8..=11, rw)]
+        voltage_supplied: Option<VoltageSuppliedSelect>,
+        /// Check pattern which is echoed.
+        #[bits(0..=7, rw)]
+        check_pattern: u8,
+    }
+
+    /// Power control (XPC) settings.
+    #[bitbybit::bitenum(u1, exhaustive = true)]
+    #[derive(Debug, PartialEq, Eq)]
+    pub enum PowerControl {
+        /// Power saving.
+        PowerSaving = 0,
+        /// Maximum performance.
+        MaximumPerformance = 1,
+    }
+
+    /// HPC.
+    #[bitbybit::bitenum(u1, exhaustive = true)]
+    #[derive(Debug, PartialEq, Eq)]
+    pub enum HostCapacitySupport {
+        /// SDSC only.
+        SdscOnly = 0,
+        /// Extended capacity - SDHC or SDXC.
+        SdhcOrSdxc = 1,
+    }
+
+    /// Lower OCR bits used to negotiate voltage capabilities.
+    #[bitbybit::bitfield(u24, default = 0x0, debug)]
+    pub struct OcrLower {
+        /// 3.5 to 3.6V
+        #[bit(23, rw)]
+        _3_5_to_3_6v: bool,
+        /// 3.4 to 3.5V
+        #[bit(22, rw)]
+        _3_4_to_3_5v: bool,
+        /// 3.3 to 3.4V
+        #[bit(21, rw)]
+        _3_3_to_3_4v: bool,
+        /// 3.2 to 3.3V
+        #[bit(20, rw)]
+        _3_2_to_3_3v: bool,
+        /// 3.1 to 3.2V
+        #[bit(19, rw)]
+        _3_1_to_3_2v: bool,
+        /// 3.0 to 3.1V
+        #[bit(18, rw)]
+        _3_0_to_3_1v: bool,
+        /// 2.9 to 3.0V
+        #[bit(17, rw)]
+        _2_9_to_3_0v: bool,
+        /// 2.8 to 2.9V
+        #[bit(16, rw)]
+        _2_8_to_2_9v: bool,
+        /// 2.7 to 2.8V
+        #[bit(15, rw)]
+        _2_7_to_2_8v: bool,
+        /// Reserved for low voltage
+        #[bit(7, rw)]
+        reserved_low_voltage: bool,
+    }
+
+    /// Bus width setting.
+    #[bitbybit::bitenum(u2, exhaustive = false)]
+    #[derive(Debug, PartialEq, Eq)]
+    pub enum BusWidth {
+        /// 1 bit bus.
+        _1bit = 0b00,
+        /// 4 bit bus.
+        _4bits = 0b10,
+    }
+
+    /// ACMD6 - Set bus width.
+    #[bitbybit::bitfield(u32, default = 0x0, debug, forbid_overlaps)]
+    pub struct Acmd6 {
+        /// Bus width.
+        #[bits(0..=1, rw)]
+        bus_width: Option<BusWidth>,
+    }
+
+    /// ACMD41 argument - Capability negotiation.
+    #[bitbybit::bitfield(u32, default = 0x0, debug, forbid_overlaps)]
+    pub struct Acmd41 {
+        /// HPC.
+        #[bit(30, rw)]
+        host_capacity_support: HostCapacitySupport,
+        /// FB.
+        #[bit(29, rw)]
+        fast_boot: bool,
+        /// XPC.
+        #[bit(28, rw)]
+        xpc: PowerControl,
+        /// Switch to 1.8V signal voltage request.
+        #[bit(24, rw)]
+        s18r: bool,
+        /// If this is set to 0. ACMD41 is called "inquire CMD41" that does not start
+        /// initialization and is used for getting OCR. Bits 24 to 31 are ignored.
+        #[bits(0..=23, rw)]
+        ocr: OcrLower,
+    }
+
+    /// Relative Card Address (RCA) select.
+    #[bitbybit::bitfield(u32, default = 0x0, debug)]
+    pub struct RcaSelect {
+        /// RCA.
+        #[bits(16..=31, rw)]
+        rca: u16,
+    }
+
+    /// CMD9 argument.
+    pub type Cmd9 = RcaSelect;
+    /// CMD7 argument.
+    pub type Cmd7 = RcaSelect;
+
+    /// CMD13 argument.
+    #[bitbybit::bitfield(u32, default = 0x0, debug, forbid_overlaps)]
+    pub struct Cmd13 {
+        /// RCA.
+        #[bits(16..=31, rw)]
+        rca: u16,
+        /// Send task status instead of regular card status.
+        #[bit(15, rw)]
+        send_task_status: bool,
+    }
+}
+
+/// Card response module.
+pub mod response {
+    use arbitrary_int::u2;
+
+    use super::argument::VoltageSuppliedSelect;
+
+    /// SD card state.
+    #[bitbybit::bitenum(u4, exhaustive = false)]
+    #[derive(Debug, PartialEq, Eq)]
+    pub enum State {
+        /// Idle state.
+        Idle = 0,
+        /// Ready state.
+        Ready = 1,
+        /// Identification state.
+        Ident = 2,
+        /// Standby state.
+        Stby = 3,
+        /// Transfer state.
+        Tran = 4,
+        /// Data state.
+        Data = 5,
+        /// Receive state.
+        Rcv = 6,
+        /// Programming state.
+        Prg = 7,
+        /// Disconnected state.
+        Dis = 8,
+        /// Reserved for IO mode.
+        ReservedIoMode = 15,
+    }
+
+    /// Card status (R1).
+    #[bitbybit::bitfield(u32, default = 0x0, debug, forbid_overlaps)]
+    pub struct CardStatus {
+        /// The command's argument was out range of the allowed range for this card.
+        #[bit(31, rw)]
+        out_of_range: bool,
+        /// A misaligned address which did not  match the block length was used in the command
+        #[bit(30, rw)]
+        address_error: bool,
+        /// The transferred block length is not allowed for this card, or the number of transferred
+        /// bytes does not match the block length.
+        #[bit(29, rw)]
+        block_len_error: bool,
+        /// An error in the sequence of erase commands occurred.
+        #[bit(28, rw)]
+        erase_seq_error: bool,
+        /// An invalid selection of write-blocks for erase occurred.
+        #[bit(27, rw)]
+        erase_param: bool,
+        /// Set when the host attempts to write to a protected block or to the temporary write
+        /// protected card or write protected until power cycle card or permanent write protected
+        /// card.
+        #[bit(26, rw)]
+        wp_violation: bool,
+        /// When set, signals that the card is locked by the host
+        #[bit(25, rw)]
+        card_is_locked: bool,
+        /// Set when a sequence or password error has been detected in lock/unlock card command.
+        #[bit(24, rw)]
+        lock_unlock_failed: bool,
+        /// The CRC check of the previous command failed.
+        #[bit(23, rw)]
+        com_crc_error: bool,
+        /// Command not legal for the card state
+        #[bit(22, rw)]
+        illegal_command: bool,
+        /// Card internal ECC was applied but failed to correct the data.
+        #[bit(21, rw)]
+        card_ecc_failed: bool,
+        /// Internal card controller error
+        #[bit(20, rw)]
+        cc_error: bool,
+        /// A general or an unknown error occurred during the operation.
+        #[bit(19, rw)]
+        error: bool,
+        /// Can be either one of the following errors:
+        /// - The read only section of the CSD does not match the card content.
+        /// - An attempt to reverse the copy (set as original) or permanent WP (unprotected) bits was made.
+        #[bit(16, rw)]
+        csd_overwrite: bool,
+        /// Set when only partial address space was erased due to existing write protected blocks
+        /// or the temporary write protected or write protected until power cycle or permanent write
+        /// protected card was erased.
+        #[bit(15, rw)]
+        wp_erase_skip: bool,
+        /// The command has been executed without using the internal ECC.
+        #[bit(14, rw)]
+        card_ecc_disabled: bool,
+        /// An erase sequence was cleared before executing because an out of erase sequence command
+        /// was received
+        #[bit(13, rw)]
+        erase_reset: bool,
+        /// CURRENT_STATE. The state of the card when receiving the command. If the command
+        /// execution causes a state change, it will be visible to the host in the response to the
+        /// next command.
+        #[bits(9..=12, rw)]
+        state: Option<State>,
+        /// Corresponds to buffer empty signaling on the bus
+        #[bit(8, rw)]
+        ready_for_data: bool,
+        /// FX_EVENT. Extension Functions may set this bit to get host to deal with events.
+        #[bit(6, rw)]
+        fx_event: bool,
+        /// '1': Enabled. The card will expect ACMD, or an indiication that the command has been
+        /// interpreted as ACMD.
+        #[bit(5, rw)]
+        app_cmd: bool,
+        /// Error in the sequence of the authentification process.
+        #[bit(3, rw)]
+        ake_seq_error: bool,
+        /// Reserved for application specific commands.
+        #[bit(2, rw)]
+        reserved_app_specific_cmd: bool,
+        /// Reserved for manufacturer test mode.
+        #[bits(0..=1, rw)]
+        reserved_manufactuere_test_mode: u2,
+    }
+
+    /// Operation Conditions Register (OCR).
+    #[bitbybit::bitfield(u32, default = 0x0, debug, forbid_overlaps)]
+    pub struct Ocr {
+        /// '0' if not finished yet.
+        #[bit(31, rw)]
+        initialization_complete: bool,
+        /// CCS. Only valid if power up status bit is set.
+        #[bit(30, rw)]
+        card_capacity_status: bool,
+        /// UHS-II Card Status. '1' if card supports UHS-II interface.
+        #[bit(29, rw)]
+        uhs_2_card_status: bool,
+        /// CO2T. Only supported by SDUC cards.
+        #[bit(27, rw)]
+        over_2_tb_support_status: bool,
+        /// Switching to 1.8V accepted. Only supported by UHS-I cards.
+        #[bit(24, rw)]
+        s18a: bool,
+        /// 3.5V-3.6V voltage window supported.
+        #[bit(23, rw)]
+        _3_5_to_3_6v: bool,
+        /// 3.4V-3.5V voltage window supported.
+        #[bit(22, rw)]
+        _3_4_to_3_5v: bool,
+        /// 3.3V-3.4V voltage window supported.
+        #[bit(21, rw)]
+        _3_3_to_3_4v: bool,
+        /// 3.2V-3.3V voltage window supported.
+        #[bit(20, rw)]
+        _3_2_to_3_3v: bool,
+        /// 3.1V-3.2V voltage window supported.
+        #[bit(19, rw)]
+        _3_1_to_3_2v: bool,
+        /// 3.0V-3.1V voltage window supported.
+        #[bit(18, rw)]
+        _3_0_to_3_1v: bool,
+        /// 2.9V-3.0V voltage window supported.
+        #[bit(17, rw)]
+        _2_9_to_3_0v: bool,
+        /// 2.8V-2.9V voltage window supported.
+        #[bit(16, rw)]
+        _2_8_to_2_9v: bool,
+        /// 2.7V-2.8V voltage window supported.
+        #[bit(15, rw)]
+        _2_7_to_2_8v: bool,
+        /// Reserved for low voltage range.
+        #[bit(7, rw)]
+        reserved_low_voltage: bool,
+    }
+
+    /// R1 is the card sate.
+    pub type R1 = CardStatus;
+
+    /// R3 is the OCR register.
+    pub type R3 = Ocr;
+
+    /// Published RCA response (R6).
+    #[bitbybit::bitfield(u32, default = 0x0, debug, forbid_overlaps)]
+    pub struct R6 {
+        /// Relative card address.
+        #[bits(16..=31, rw)]
+        rca: u16,
+        /// Status bit 23. The CRC check of the previous command failed.
+        #[bit(15, rw)]
+        com_crc_error: bool,
+        /// Status bit 22. Command not legal for the card state
+        #[bit(14, rw)]
+        illegal_command: bool,
+        /// Status bit 19. A general or an unknown error occurred during the operation.
+        #[bit(13, rw)]
+        error: bool,
+        /// CURRENT_STATE. The state of the card when receiving the command. If the command
+        /// execution causes a state change, it will be visible to the host in the response to the
+        /// next command.
+        #[bits(9..=12, rw)]
+        state: Option<State>,
+        /// Corresponds to buffer empty signaling on the bus
+        #[bit(8, rw)]
+        ready_for_data: bool,
+        /// FX_EVENT. Extension Functions may set this bit to get host to deal with events.
+        #[bit(6, rw)]
+        fx_event: bool,
+        /// '1': Enabled. The card will expect ACMD, or an indiication that the command has been
+        /// interpreted as ACMD.
+        #[bit(5, rw)]
+        app_cmd: bool,
+        /// Error in the sequence of the authentification process.
+        #[bit(3, rw)]
+        ake_seq_error: bool,
+    }
+
+    /// Card interface conditions (R7).
+    #[bitbybit::bitfield(u32, default = 0x0, debug, forbid_overlaps)]
+    pub struct R7 {
+        /// PCIe 1.2V support.
+        #[bit(13, rw)]
+        pcie_1_2v_support: bool,
+        /// PCIe response.
+        #[bit(12, rw)]
+        pcie_accepted: bool,
+        /// Voltage accepted.
+        #[bits(8..=11, rw)]
+        voltage_accepted: Option<VoltageSuppliedSelect>,
+        /// Echo-back of check pattern.
+        #[bits(0..=7, rw)]
+        echo_check_pattern: u8,
+    }
+}
+
 /// status for card in the ready state
 pub const R1_READY_STATE: u8 = 0x00;