https://github.com/qu1x/mif
Memory Initialization File
https://github.com/qu1x/mif
intel-quartus-prime mif mif-dump mif-join rust-lang
Last synced: 4 months ago
JSON representation
Memory Initialization File
- Host: GitHub
- URL: https://github.com/qu1x/mif
- Owner: qu1x
- Created: 2020-08-11T11:00:49.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-08-24T18:29:18.000Z (almost 5 years ago)
- Last Synced: 2025-02-03T19:40:17.485Z (4 months ago)
- Topics: intel-quartus-prime, mif, mif-dump, mif-join, rust-lang
- Language: Rust
- Homepage:
- Size: 43 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[![Build Status][]](https://travis-ci.org/qu1x/mif)
[![Downloads][]](https://crates.io/crates/mif)
[![Rust][]](https://www.rust-lang.org)
[![Version][]](https://crates.io/crates/mif)
[![Documentation][]](https://docs.rs/mif)
[![License][]](https://opensource.org/licenses)
[Build Status]: https://travis-ci.org/qu1x/mif.svg
[Downloads]: https://img.shields.io/crates/d/mif.svg
[Rust]: https://img.shields.io/badge/rust-stable-brightgreen.svg
[Version]: https://img.shields.io/crates/v/mif.svg
[Documentation]: https://docs.rs/mif/badge.svg
[License]: https://img.shields.io/badge/License-MIT%20OR%20Apache--2.0-blue.svg
# mif
Memory Initialization File
## Features
* Native MIF representation as `Vec<(word: T, bulk: usize)>`.
* Detects single-word sequence `[first..last]: word` but does **not**
detect multi-word sequence `[first..last]: words..` in binary data.
* Verifies word fits into MIF's word width in bits.
* Joins multiple MIFs of different word widths as long as words fit.
* Optionally comments join offsets in words with given (file) names.
* Provides simple `mif dump` subcommand.
* Provides reproducible `mif join` subcommand via TOML instruction file.
## Library
MIF creation and serialization is implemented for the `Mif` structure.
Disable default features like `cli` and `bin` to reduce dependencies:
```toml
[dependencies]
mif = { version = "0.3", default-features = false }
```
Default features:
* `cli`: Provides command-line interface functionality of `mif` binary.
Requires: `anyhow`, `indexmap`, `serde`, `toml`
* `bin`: Enables compilation of `mif` binary.
Requires: `cli`, `clap`
## Command-line Interface
Install via `cargo install mif`.
Provides two subcommands, `dump` and `join`.
```text
mif 0.3.0
Rouven Spreckels
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 1 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.