<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>README.md - fork/raki @ master</title>
<meta name="description" content="README.md in fork/raki at master.">
<meta property="og:title" content="README.md - fork/raki @ master">
<meta property="og:description" content="README.md in fork/raki at master.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="master" data-tip="3f238306fc4f1784aaeade9381cf144a1c95aaa4">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/raki</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/raki</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">Norimasa Takana</span><span class="commit-message" data-commit="54d784b9da7655220c42ef9fd2899b57db0d9375">Merge pull request #28 from Alignof/develop</span><span class="snapshot-sha sha" data-commit="54d784b9da7655220c42ef9fd2899b57db0d9375">54d784b</span><time datetime="2024-10-02T14:21:54+09:00" title="2024-10-02 14:21:54 +0900">2024-10-02</time></p>
<header class="topbar"><details class="switcher"><summary>master</summary><div class="menu"><strong>branches</strong><a class="current" href="/fork/raki/ref/master/">master</a><a class="all" href="/fork/raki/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/raki/">raki</a> / <span class="cur">README.md</span></nav>
<span class="view-stats"><span>1.2 KiB</span><span>51 lines</span></span><span class="actions"><a class="raw" href="/fork/raki/raw/b3c3f0bc39ea77d99c50db241ed7126b30c2e22f/README.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1>raki</h1>
<p><a href="https://github.com/Alignof/raki/actions/workflows/rust.yml"><img src="https://github.com/Alignof/raki/actions/workflows/rust.yml/badge.svg" alt="Rust" /></a><br />
RISC-V instruction decoder written in Rust.</p>
<ul>
<li>Both 32/64bit support.</li>
<li>Support <code>rv32/64imac</code>, <code>Zicsr</code>, <code>Zifencei</code> extensions.</li>
<li>Implement Display trait for formatting.</li>
</ul>
<h2>Usage</h2>
<p>Call the <code>decode</code> as u16/u32 method.</p>
<pre class="language-rust"><a-k>use</a-k> raki<a-p>::{</a-p><a-cr>BaseIOpcode</a-cr><a-p>,</a-p> <a-cr>Decode</a-cr><a-p>,</a-p> <a-cr>Instruction</a-cr><a-p>,</a-p> <a-cr>Isa</a-cr><a-p>,</a-p> <a-cr>OpcodeKind</a-cr><a-p>};</a-p>

<a-k>fn</a-k> <a-f>main</a-f><a-p>()</a-p> <a-p>{</a-p>
    <a-k>let</a-k> inst_bytes<a-p>:</a-p> <a-t>u32</a-t> = <a-co>0b1110_1110_1100_0010_1000_0010_1001_0011</a-co><a-p>;</a-p>
    <a-k>let</a-k> inst<a-p>:</a-p> <a-t>Instruction</a-t> = <a-k>match</a-k> inst_bytes<a-p>.</a-p><a-f>decode</a-f><a-p>(</a-p><a-t>Isa</a-t><a-p>::</a-p><a-cr>Rv32</a-cr><a-p>)</a-p> <a-p>{</a-p>
        <a-cr>Ok</a-cr><a-p>(</a-p>inst<a-p>)</a-p> =&gt; inst<a-p>,</a-p>
        <a-cr>Err</a-cr><a-p>(</a-p>e<a-p>)</a-p> =&gt; <a-m>panic!</a-m><a-p>(</a-p><a-s>&quot;decoding failed due to {e:?}&quot;</a-s><a-p>),</a-p>
    <a-p>};</a-p>

    <a-m>assert_eq!</a-m><a-p>(</a-p>inst<a-p>.</a-p><a-pr>opc</a-pr><a-p>,</a-p> <a-t>OpcodeKind</a-t><a-p>::</a-p><a-f>BaseI</a-f><a-p>(</a-p><a-t>BaseIOpcode</a-t><a-p>::</a-p><a-cr>ADDI</a-cr><a-p>));</a-p>
    <a-m>println!</a-m><a-p>(</a-p><a-s>&quot;{inst}&quot;</a-s><a-p>);</a-p>
<a-p>}</a-p>
<a-c>// --output--</a-c>
<a-c>// addi t0, t0, -276</a-c></pre>
<h2>Support</h2>
<ul>
<li><input disabled="" type="checkbox" checked=""/>
BaseI (RV32I, RV64I)</li>
<li><input disabled="" type="checkbox" checked=""/>
M</li>
<li><input disabled="" type="checkbox" checked=""/>
A</li>
<li><input disabled="" type="checkbox"/>
D</li>
<li><input disabled="" type="checkbox"/>
Q</li>
<li><input disabled="" type="checkbox" checked=""/>
C</li>
<li><input disabled="" type="checkbox"/>
B</li>
<li><input disabled="" type="checkbox"/>
P</li>
<li><input disabled="" type="checkbox"/>
V</li>
<li><input disabled="" type="checkbox"/>
H</li>
<li><input disabled="" type="checkbox" checked=""/>
Zicsr</li>
<li><input disabled="" type="checkbox" checked=""/>
Zifencei</li>
<li><input disabled="" type="checkbox" checked=""/>
Zicntr</li>
<li><input disabled="" type="checkbox" checked=""/>
Zicfiss</li>
<li><input disabled="" type="checkbox"/>
Priv (Now only supports <code>mret</code>, <code>sret</code>, <code>wfi</code>, <code>sfence.vma</code>)</li>
</ul>
<h2>License</h2>
<p>This crate is licensed under MIT.<br />
See <code>LICENSE</code> for details.</p>
<h2>Contribution</h2>
<p>All contributions are welcome, including issues, pull requests, questions, etc...
See <code>CONTRIBUTING.md</code> for details.</p>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>#</a-p> <a-tt>raki</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text">[![Rust](https://github.com/Alignof/raki/actions/workflows/rust.yml/badge.svg)](https://github.com/Alignof/raki/actions/workflows/rust.yml)  </span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">RISC-V instruction decoder written in Rust.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"><a-p>- </a-p>Both 32/64bit support.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"><a-p>- </a-p>Support `rv32/64imac`, `Zicsr`, `Zifencei` extensions.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"><a-p>- </a-p>Implement Display trait for formatting.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"><a-p>## </a-p><a-tt>Usage</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"><a-p>Call the `decode` as u16/u32 method.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"><a-p>```</a-p><a-tl>rust</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"><a-p>use raki::{</a-p><a-cr>BaseIOpcode</a-cr><a-p>, </a-p><a-cr>Decode</a-cr><a-p>, </a-p><a-cr>Instruction</a-cr><a-p>, </a-p><a-cr>Isa</a-cr><a-p>, </a-p><a-cr>OpcodeKind</a-cr><a-p>};</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"><a-p>fn </a-p><a-f>main</a-f><a-p>() {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-p>    </a-p><a-k>let</a-k><a-p> inst_bytes: </a-p><a-t>u32</a-t><a-p> = </a-p><a-co>0b1110_1110_1100_0010_1000_0010_1001_0011</a-co><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>    </a-p><a-k>let</a-k><a-p> inst: </a-p><a-t>Instruction</a-t><a-p> = </a-p><a-k>match</a-k><a-p> inst_bytes.</a-p><a-f>decode</a-f><a-p>(</a-p><a-t>Isa</a-t><a-p>::</a-p><a-cr>Rv32</a-cr><a-p>) {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"><a-p>        </a-p><a-cr>Ok</a-cr><a-p>(inst) =&gt; inst,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"><a-p>        </a-p><a-cr>Err</a-cr><a-p>(e) =&gt; </a-p><a-m>panic!</a-m><a-p>(</a-p><a-s>&quot;decoding failed due to {e:?}&quot;</a-s><a-p>),</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"><a-p>    };</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"><a-p>    </a-p><a-m>assert_eq!</a-m><a-p>(inst.</a-p><a-pr>opc</a-pr><a-p>, </a-p><a-t>OpcodeKind</a-t><a-p>::</a-p><a-f>BaseI</a-f><a-p>(</a-p><a-t>BaseIOpcode</a-t><a-p>::</a-p><a-cr>ADDI</a-cr><a-p>));</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"><a-p>    </a-p><a-m>println!</a-m><a-p>(</a-p><a-s>&quot;{inst}&quot;</a-s><a-p>);</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"><a-p>// --output--</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"><a-p>// addi t0, t0, -276</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"><a-p>## </a-p><a-tt>Support</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"><a-p>- [x] BaseI (RV32I, RV64I)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"><a-p>- [x] M</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"><a-p>- [x] A</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"><a-p>- [ ] D</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"><a-p>- [ ] Q</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"><a-p>- [x] C</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"><a-p>- [ ] B</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"><a-p>- [ ] P</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"><a-p>- [ ] V</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"><a-p>- [ ] H</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"><a-p>- [x] Zicsr</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"><a-p>- [x] Zifencei</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"><a-p>- [x] Zicntr</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"><a-p>- [x] Zicfiss</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"><a-p>- [ ] Priv (Now only supports `mret`, `sret`, `wfi`, `sfence.vma`)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"><a-p>## </a-p><a-tt>License</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"><a-p>This crate is licensed under MIT.  </a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"><a-p>See `LICENSE` for details.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"><a-p>## </a-p><a-tt>Contribution</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text">All contributions are welcome, including issues, pull requests, questions, etc...</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text">See `CONTRIBUTING.md` for details.</span></span></pre></div></div>
</main>
</body>
</html>
