mif

Memory Initialization File

Library

MIF creation and serialization is implemented via the Mif structure.

Disable default features like cli to reduce dependencies:

toml [dependencies] mif = { version = "0.1", default-features = false }

Command-line Utility

Provides two subcommands, dump and join.

```text mif 0.1.0 Rouven Spreckels rs@qu1x.dev Memory Initialization File

USAGE: mif

OPTIONS: -h, --help Prints help information -V, --version Prints version information

SUBCOMMANDS: dump Dumps binary as MIF join Joins binaries' memory areas to MIFs help Prints this message or the help of the given subcommand(s) ```

Dump Subcommand

```text mif-dump Dumps binary as MIF

USAGE: mif dump [input]

ARGS: Input file or standard input (-) [default: -]

OPTIONS: -w, --width Word width in bits from 8 to 128 [default: 16] -f, --first LSB/MSB first (little/big-endian) [default: lsb] -h, --help Prints help information -V, --version Prints version information ```

Join Subcommand

```text mif-join Joins binaries' memory areas to MIFs

USAGE: mif join [OPTIONS] [toml]

ARGS: TOML file or standard input (-) [default: -]

OPTIONS: -i, --bins Input directory [default: .] -o, --mifs Output directory [default: .] -n, --no-comments No comments in MIFs -h, --help Prints help information -V, --version Prints version information ```

Join Example

Assuming two ROM dumps, a.rom and b.rom, whose program and data areas are concatenated as in:

• cat a.program.rom a.data.rom > a.rom
• cat b.program.rom b.data.rom > b.rom

Following TOML file defines how to join both program areas to one MIF and both data areas to another MIF, assuming 24-bit program words of depth 1267 and 1747 and 16-bit data words of depth 1024 each. Additionally, every area is dumped to its own separate MIF for verification. Then, between program and data area is supposed to be an unused area of 0xffffff words, which should be skipped. Listing them in the skips instruction will verify that this area only contains these words.

```toml [["a.rom"]] first = "lsb" # Least-significant byte first. Default, can be omitted. width = 24 depth = 1267 joins = ["a.prog.mif", "ab.prog.mif"] [["a.rom"]] first = "lsb" # Least-significant byte first. Default, can be omitted. width = 24 depth = 781 skips = [0xffffff] # Empty [] for skipping without verification. [["a.rom"]] first = "msb" width = 16 # Default, can be omitted. depth = 1024 joins = ["a.data.mif", "ab.data.mif"]

[["b.rom"]] width = 24 depth = 1747 joins = ["b.prog.mif", "ab.prog.mif"] [["b.rom"]] width = 24 depth = 301 skips = [0xffffff] [["b.rom"]] depth = 1024 joins = ["b.data.mif", "ab.data.mif"] ```

License

Dual-licensed under MIT OR Apache-2.0.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the works by you shall be licensed as above, without any additional terms or conditions.