Struct Command 

pub struct Command;

Implementations

impl Command

pub fn chain_inactive() -> [u8; 7]

Chain Inactive Command

This disable the relay ability of every chip on the chain (CI signal is no more relayed to CO pin). Usually done before setting each chip address individually using Command::set_chip_addr.

Example

use bm1397_protocol::Command;

let cmd = Command::chain_inactive();
assert_eq!(cmd, [0x55, 0xAA, 0x53, 0x05, 0x00, 0x00, 0x03]);

pub fn set_chip_addr(addr: u8) -> [u8; 7]

Set Chip Address Command

Give a logical ChipAddress to the chip on the chain that does not have one yet. Usually done after sending Command::chain_inactive so only the first chip in the chain will receive it’s chip address, then it will start relaying CI signal to CO pin and subsequent Command::set_chip_addr will be received by the next chip only. This way all chips will be addressed one by one and will received differents ChipAddress.

This logical ChipAddress have 2 utilities :

• sending command to a specific chip on the chain, using Destination::Chip(ChipAddress).
• when mining, the nonce space (u32) will be divided evenly according to ChipAddress : each chip will add it’s own ChipAddress to the MSB of the starting nonce for a job.

Example

use bm1397_protocol::Command;

let cmd = Command::set_chip_addr(0x00);
assert_eq!(cmd, [0x55, 0xAA, 0x40, 0x05, 0x00, 0x00, 0x1C]);

let cmd = Command::set_chip_addr(0x08);
assert_eq!(cmd, [0x55, 0xAA, 0x40, 0x05, 0x08, 0x00, 0x07]);

pub fn read_reg(reg: Register, dest: Destination) -> [u8; 7]

Read Register Command

Used to send a Read Register command on the chain.

All chips on the chain or only a specific one can be addressed by this command using the dest parameter.

Usually the first command sent by a driver to the chain is the Read Register command of Register::ChipAddress to all chips on the chain, this is usefull to enumerate all chips on the chain.

Example

use bm1397_protocol::{Command, Destination, Register};

// Enumerate the chain
let cmd = Command::read_reg(Register::ChipAddress, Destination::All);
assert_eq!(cmd, [0x55, 0xAA, 0x52, 0x05, 0x00, 0x00, 0x0A]);

// Read I2CControl on chip with ChipAddress@64
let cmd = Command::read_reg(Register::I2CControl, Destination::Chip(64));
assert_eq!(cmd, [0x55, 0xAA, 0x42, 0x05, 0x40, 0x1C, 0x0B]);

pub fn write_reg(reg: Register, dest: Destination, val: u32) -> [u8; 11]

Write Register Command

Used to send a Write Register command on the chain.

All chips on the chain or only a specific one can be addressed by this command using the dest parameter.

Example

use bm1397_protocol::{Command, Destination, Register};

// Write ClockOrderControl0 value 0x0000_0000 on All chip of the chain
let cmd = Command::write_reg(Register::ClockOrderControl0, Destination::All, 0x0000_0000);
assert_eq!(cmd, [0x55, 0xAA, 0x51, 0x09, 0x00, 0x80, 0x00, 0x00, 0x00, 0x00, 0x1C]);

// Write MiscControl value 0x0000_7A31 on chip with ChipAddress@64
let cmd = Command::write_reg(Register::MiscControl, Destination::Chip(64), 0x0000_7A31);
assert_eq!(cmd, [0x55, 0xAA, 0x41, 0x09, 0x40, 0x18, 0x00, 0x00, 0x7A, 0x31, 0x11]);

pub fn job_1_midstate( job_id: u8, n_bits: u32, n_time: u32, merkle_root: u32, midstates: [&Midstate; 1], ) -> [u8; 56]

Job with 1 Midstate Command

Example

use bm1397_protocol::{Command, Midstate};

let midstates: [&Midstate; 1] = [
    &[
        0xDE, 0x60, 0x4A, 0x09, 0xE9, 0x30, 0x1D, 0xE1, 0x25, 0x6D, 0x7E, 0xB8, 0x0E, 0xA1,
        0xE6, 0x43, 0x82, 0xDF, 0x61, 0x14, 0x15, 0x03, 0x96, 0x6C, 0x18, 0x5F, 0x50, 0x2F,
        0x55, 0x74, 0xD4, 0xBA,
    ],
];
let cmd = Command::job_1_midstate(0, 0x1707_9E15, 0x638E_3275, 0x706A_B3A2, midstates);
assert_eq!(
    cmd,
    [
        0x55, 0xAA, 0x21, 0x36, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x15, 0x9E, 0x07, 0x17,
        0x75, 0x32, 0x8E, 0x63, 0xA2, 0xB3, 0x6A, 0x70, 0xDE, 0x60, 0x4A, 0x09, 0xE9, 0x30,
        0x1D, 0xE1, 0x25, 0x6D, 0x7E, 0xB8, 0x0E, 0xA1, 0xE6, 0x43, 0x82, 0xDF, 0x61, 0x14,
        0x15, 0x03, 0x96, 0x6C, 0x18, 0x5F, 0x50, 0x2F, 0x55, 0x74, 0xD4, 0xBA, 0xD3, 0xDC
    ]
);

pub fn job_4_midstate( job_id: u8, n_bits: u32, n_time: u32, merkle_root: u32, midstates: [&Midstate; 4], ) -> [u8; 152]

Job with 4 Midstate Command

Example

use bm1397_protocol::{Command, Midstate};

let midstates: [&Midstate; 4] = [
    &[
        0xDE, 0x60, 0x4A, 0x09, 0xE9, 0x30, 0x1D, 0xE1, 0x25, 0x6D, 0x7E, 0xB8, 0x0E, 0xA1,
        0xE6, 0x43, 0x82, 0xDF, 0x61, 0x14, 0x15, 0x03, 0x96, 0x6C, 0x18, 0x5F, 0x50, 0x2F,
        0x55, 0x74, 0xD4, 0xBA,
    ],
    &[
        0xAE, 0x2F, 0x3F, 0xC6, 0x02, 0xD9, 0xCD, 0x3B, 0x9E, 0x39, 0xAD, 0x97, 0x9C, 0xFD,
        0xFF, 0x3A, 0x40, 0x49, 0x4D, 0xB6, 0xD7, 0x8D, 0xA4, 0x51, 0x34, 0x99, 0x29, 0xD1,
        0xAD, 0x36, 0x66, 0x1D,
    ],
    &[
        0xDF, 0xFF, 0xC1, 0xCC, 0x89, 0x33, 0xEA, 0xF3, 0xE8, 0x3A, 0x91, 0x58, 0xA6, 0xD6,
        0xFA, 0x02, 0x0D, 0xCF, 0x60, 0xF8, 0xC1, 0x0E, 0x99, 0x36, 0xDE, 0x71, 0xDB, 0xD3,
        0xF7, 0xD2, 0x86, 0xAF,
    ],
    &[
        0xAD, 0x62, 0x59, 0x3A, 0x8D, 0xA3, 0x28, 0xAF, 0xEC, 0x09, 0x6D, 0x86, 0xB9, 0x8E,
        0x30, 0xE5, 0x79, 0xAE, 0xA4, 0x35, 0xE1, 0x4B, 0xB5, 0xD7, 0x09, 0xCC, 0xE1, 0x74,
        0x04, 0x3A, 0x7C, 0x2D,
    ],
];
let cmd = Command::job_4_midstate(0, 0x1707_9E15, 0x638E_3275, 0x706A_B3A2, midstates);
assert_eq!(
    cmd,
    [
        0x55, 0xAA, 0x21, 0x96, 0x00, 0x04, 0x00, 0x00, 0x00, 0x00, 0x15, 0x9E, 0x07, 0x17,
        0x75, 0x32, 0x8E, 0x63, 0xA2, 0xB3, 0x6A, 0x70, 0xDE, 0x60, 0x4A, 0x09, 0xE9, 0x30,
        0x1D, 0xE1, 0x25, 0x6D, 0x7E, 0xB8, 0x0E, 0xA1, 0xE6, 0x43, 0x82, 0xDF, 0x61, 0x14,
        0x15, 0x03, 0x96, 0x6C, 0x18, 0x5F, 0x50, 0x2F, 0x55, 0x74, 0xD4, 0xBA, 0xAE, 0x2F,
        0x3F, 0xC6, 0x02, 0xD9, 0xCD, 0x3B, 0x9E, 0x39, 0xAD, 0x97, 0x9C, 0xFD, 0xFF, 0x3A,
        0x40, 0x49, 0x4D, 0xB6, 0xD7, 0x8D, 0xA4, 0x51, 0x34, 0x99, 0x29, 0xD1, 0xAD, 0x36,
        0x66, 0x1D, 0xDF, 0xFF, 0xC1, 0xCC, 0x89, 0x33, 0xEA, 0xF3, 0xE8, 0x3A, 0x91, 0x58,
        0xA6, 0xD6, 0xFA, 0x02, 0x0D, 0xCF, 0x60, 0xF8, 0xC1, 0x0E, 0x99, 0x36, 0xDE, 0x71,
        0xDB, 0xD3, 0xF7, 0xD2, 0x86, 0xAF, 0xAD, 0x62, 0x59, 0x3A, 0x8D, 0xA3, 0x28, 0xAF,
        0xEC, 0x09, 0x6D, 0x86, 0xB9, 0x8E, 0x30, 0xE5, 0x79, 0xAE, 0xA4, 0x35, 0xE1, 0x4B,
        0xB5, 0xD7, 0x09, 0xCC, 0xE1, 0x74, 0x04, 0x3A, 0x7C, 0x2D, 0x1B, 0x5C
    ]
);