Struct ecpdap::Bitstream

pub struct Bitstream { /* private fields */ }

ECP5 bitstream in-memory.

Can be loaded from a path or file, and modified as required to change IDCODE checks and SPI mode and frequency.

Implementations

impl Bitstream

pub fn from_path<P: AsRef<Path>>(path: P) -> Result<Self>

Open a bitstream from the provided path.

pub fn from_file(file: &mut File) -> Result<Self>

Open a bitstream from the provided open File.

pub fn from_data(data: &[u8]) -> Self

Load a bitstream from the provided raw bitstream data.

pub fn new(data: Vec<u8>) -> Self

Load a bitstream directly from a Vec<u8>.

pub fn data(&self) -> &[u8]

Get the underlying bitstream data.

pub fn check_and_fix_idcode(
    &mut self,
    idcode: ECP5IDCODE,
    fix: bool
) -> Result<()>

Check the provided IDCODE matches the IDCODE check in the bitstream.

If the bitstream does not contain an IDCODE check, no action is taken.

If the bitstream contains a compatible but different IDCODE, and fix is true, a warning is logged and the bitstream is patched to idcode.

If the bitstream contains an incompatible IDCODE, an error is logged and this method returns an error.

See ECP5IDCODE::compatible.

pub fn remove_idcode(&mut self) -> Result<()>

Replace the VERIFY_ID command, if any, with NOOPs.

If the bitstream does not contain an IDCODE check, no action is taken.

pub fn remove_spimode(&mut self) -> Result<()>

Replace the SPI_MODE command, if any, with NOOPs.

If the bitstream metadata parsing was not successful or no SPI_MODE command was found, no action is taken.