Fix zbs and DecoderManager docstrings (#470)

Assumptions.html

@@ -104,7 +104,7 @@ <h1>List of assumptions made during development<a class="headerlink" href="#list
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 16:15 2023-11-02.
+      <span class="lastupdated">Last updated on 20:30 2023-11-05.
       </span></p>
   </div>
 

Current_graph.html

@@ -105,16 +105,16 @@ <h1>Full transaction-method graph<a class="headerlink" href="#full-transaction-m
                     BasicFifo_read[&quot;read&quot;]
                 end
                 subgraph SimpleWBCacheRefiller[&quot;icache_refiller SimpleWBCacheRefiller&quot;]
+                    SimpleWBCacheRefiller_start_refill[&quot;start_refill&quot;]
                     SimpleWBCacheRefiller_accept_refill[&quot;accept_refill&quot;]
                     SimpleWBCacheRefiller_SimpleWBCacheRefiller[&quot;SimpleWBCacheRefiller&quot;]
-                    SimpleWBCacheRefiller_start_refill[&quot;start_refill&quot;]
                 end
                 subgraph ICache[&quot;icache ICache&quot;]
+                    ICache_issue_req[&quot;issue_req&quot;]
                     ICache_ICache[&quot;ICache&quot;]
+                    ICache_accept_res[&quot;accept_res&quot;]
                     ICache_ICache1[&quot;ICache&quot;]
                     ICache_ICache2[&quot;ICache&quot;]
-                    ICache_accept_res[&quot;accept_res&quot;]
-                    ICache_issue_req[&quot;issue_req&quot;]
                     subgraph FIFO1[&quot;req_fifo FIFO&quot;]
                         FIFO1_write[&quot;write&quot;]
                         FIFO1_read[&quot;read&quot;]
@@ -142,19 +142,19 @@ <h1>Full transaction-method graph<a class="headerlink" href="#full-transaction-m
                 subgraph RegisterFile[&quot;RF RegisterFile&quot;]
                     RegisterFile_write[&quot;write&quot;]
                     RegisterFile_read1[&quot;read1&quot;]
-                    RegisterFile_read2[&quot;read2&quot;]
                     RegisterFile_free[&quot;free&quot;]
+                    RegisterFile_read2[&quot;read2&quot;]
                 end
                 subgraph ReorderBuffer[&quot;ROB ReorderBuffer&quot;]
+                    ReorderBuffer_put[&quot;put&quot;]
+                    ReorderBuffer_get_indices[&quot;get_indices&quot;]
                     ReorderBuffer_mark_done[&quot;mark_done&quot;]
                     ReorderBuffer_peek[&quot;peek&quot;]
                     ReorderBuffer_retire[&quot;retire&quot;]
-                    ReorderBuffer_put[&quot;put&quot;]
-                    ReorderBuffer_get_indices[&quot;get_indices&quot;]
                 end
                 subgraph ExceptionCauseRegister[&quot;exception_cause_register ExceptionCauseRegister&quot;]
-                    ExceptionCauseRegister_report[&quot;report&quot;]
                     ExceptionCauseRegister_get[&quot;get&quot;]
+                    ExceptionCauseRegister_report[&quot;report&quot;]
                 end
                 subgraph FuncBlocksUnifier[&quot;func_blocks_unifier FuncBlocksUnifier&quot;]
                     subgraph Collector[&quot;result_collector Collector&quot;]
@@ -176,34 +176,34 @@ <h1>Full transaction-method graph<a class="headerlink" href="#full-transaction-m
                         MethodProduct_method[&quot;method&quot;]
                     end
                     subgraph RSFuncBlock[&quot;rs_block_0 RSFuncBlock&quot;]
-                        RSFuncBlock_insert[&quot;insert&quot;]
-                        RSFuncBlock_select[&quot;select&quot;]
                         RSFuncBlock_update[&quot;update&quot;]
                         RSFuncBlock_get_result[&quot;get_result&quot;]
+                        RSFuncBlock_select[&quot;select&quot;]
+                        RSFuncBlock_insert[&quot;insert&quot;]
                         subgraph RS[&quot;rs RS&quot;]
                             RS_RS[&quot;RS&quot;]
-                            RS_RS1[&quot;RS&quot;]
                             RS_update[&quot;update&quot;]
+                            RS_RS1[&quot;RS&quot;]
                             RS_RS2[&quot;RS&quot;]
                             RS_RS3[&quot;RS&quot;]
                             RS_take[&quot;take&quot;]
                             RS_insert[&quot;insert&quot;]
                             RS_select[&quot;select&quot;]
                         end
                         subgraph AluFuncUnit[&quot;func_unit_0 AluFuncUnit&quot;]
-                            AluFuncUnit_issue[&quot;issue&quot;]
                             AluFuncUnit_accept[&quot;accept&quot;]
+                            AluFuncUnit_issue[&quot;issue&quot;]
                             subgraph FIFO2[&quot;fifo FIFO&quot;]
-                                FIFO2_read[&quot;read&quot;]
                                 FIFO2_write[&quot;write&quot;]
+                                FIFO2_read[&quot;read&quot;]
                             end
                         end
                         subgraph WakeupSelect[&quot;wakeup_select_0 WakeupSelect&quot;]
                             WakeupSelect_WakeupSelect[&quot;WakeupSelect&quot;]
                         end
                         subgraph ShiftFuncUnit[&quot;func_unit_1 ShiftFuncUnit&quot;]
-                            ShiftFuncUnit_accept[&quot;accept&quot;]
                             ShiftFuncUnit_issue[&quot;issue&quot;]
+                            ShiftFuncUnit_accept[&quot;accept&quot;]
                             subgraph FIFO3[&quot;fifo FIFO&quot;]
                                 FIFO3_read[&quot;read&quot;]
                                 FIFO3_write[&quot;write&quot;]
@@ -217,12 +217,12 @@ <h1>Full transaction-method graph<a class="headerlink" href="#full-transaction-m
                             JumpBranchFuncUnit_accept[&quot;accept&quot;]
                             JumpBranchFuncUnit_issue[&quot;issue&quot;]
                             subgraph FIFO4[&quot;fifo_res FIFO&quot;]
-                                FIFO4_read[&quot;read&quot;]
                                 FIFO4_write[&quot;write&quot;]
+                                FIFO4_read[&quot;read&quot;]
                             end
                             subgraph FIFO5[&quot;fifo_branch FIFO&quot;]
-                                FIFO5_read[&quot;read&quot;]
                                 FIFO5_write[&quot;write&quot;]
+                                FIFO5_read[&quot;read&quot;]
                             end
                         end
                         subgraph WakeupSelect2[&quot;wakeup_select_2 WakeupSelect&quot;]
@@ -286,15 +286,15 @@ <h1>Full transaction-method graph<a class="headerlink" href="#full-transaction-m
                             CSRRegister_read[&quot;read&quot;]
                         end
                         subgraph CSRRegister1[&quot;register_high CSRRegister&quot;]
-                            CSRRegister1_write[&quot;write&quot;]
                             CSRRegister1_read[&quot;read&quot;]
+                            CSRRegister1_write[&quot;write&quot;]
                         end
                     end
                     subgraph DoubleCounterCSR1[&quot;csr_time DoubleCounterCSR&quot;]
                         DoubleCounterCSR1_increment[&quot;increment&quot;]
                         subgraph CSRRegister2[&quot;register_low CSRRegister&quot;]
-                            CSRRegister2_read[&quot;read&quot;]
                             CSRRegister2_write[&quot;write&quot;]
+                            CSRRegister2_read[&quot;read&quot;]
                         end
                         subgraph CSRRegister3[&quot;register_high CSRRegister&quot;]
                             CSRRegister3_read[&quot;read&quot;]
@@ -306,23 +306,23 @@ <h1>Full transaction-method graph<a class="headerlink" href="#full-transaction-m
                     end
                 end
                 subgraph FIFO7[&quot;fifo_decode FIFO&quot;]
-                    FIFO7_write[&quot;write&quot;]
                     FIFO7_read[&quot;read&quot;]
+                    FIFO7_write[&quot;write&quot;]
                 end
                 subgraph Decode[&quot;decode Decode&quot;]
                     Decode_Decode[&quot;Decode&quot;]
                 end
                 subgraph Scheduler[&quot;scheduler Scheduler&quot;]
                     subgraph FIFO8[&quot;alloc_rename_buf FIFO&quot;]
-                        FIFO8_write[&quot;write&quot;]
                         FIFO8_read[&quot;read&quot;]
+                        FIFO8_write[&quot;write&quot;]
                     end
                     subgraph RegAllocation[&quot;reg_alloc RegAllocation&quot;]
                         RegAllocation_RegAllocation[&quot;RegAllocation&quot;]
                     end
                     subgraph FIFO9[&quot;rename_out_buf FIFO&quot;]
-                        FIFO9_write[&quot;write&quot;]
                         FIFO9_read[&quot;read&quot;]
+                        FIFO9_write[&quot;write&quot;]
                     end
                     subgraph Renaming[&quot;renaming Renaming&quot;]
                         Renaming_Renaming[&quot;Renaming&quot;]
@@ -364,8 +364,8 @@ <h1>Full transaction-method graph<a class="headerlink" href="#full-transaction-m
                             CSRRegister5_write[&quot;write&quot;]
                         end
                         subgraph CSRRegister6[&quot;register_high CSRRegister&quot;]
-                            CSRRegister6_read[&quot;read&quot;]
                             CSRRegister6_write[&quot;write&quot;]
+                            CSRRegister6_read[&quot;read&quot;]
                         end
                     end
                 end
@@ -383,12 +383,12 @@ <h1>Full transaction-method graph<a class="headerlink" href="#full-transaction-m
         end
     end
 Core_InitFreeRFFifo --&gt; BasicFifo_write
-Retirement_Retirement1 --&gt; BasicFifo_write
+Retirement_Retirement --&gt; BasicFifo_write
 SimpleWBCacheRefiller_SimpleWBCacheRefiller --&gt; WishboneMaster_request
-ICache_ICache --&gt; Forwarder_write
+ICache_ICache2 --&gt; Forwarder_write
 ICache_ICache1 --&gt; SimpleWBCacheRefiller_start_refill
-SimpleWBCacheRefiller_accept_refill --&gt; ICache_ICache2
-WishboneMaster_result --&gt; ICache_ICache2
+SimpleWBCacheRefiller_accept_refill --&gt; ICache_ICache
+WishboneMaster_result --&gt; ICache_ICache
 Fetch_Fetch --&gt; ICache_issue_req
 Fetch_Fetch --&gt; FIFO1_write
 Fetch_Fetch --&gt; BasicFifo1_write
@@ -409,15 +409,15 @@ <h1>Full transaction-method graph<a class="headerlink" href="#full-transaction-m
 FIFO9_read --&gt; ROBAllocation_ROBAllocation
 ROBAllocation_ROBAllocation --&gt; ReorderBuffer_put
 ROBAllocation_ROBAllocation --&gt; FIFO10_write
-FIFO10_read --&gt; RSSelection_RSSelection1
-RSSelection_RSSelection1 --&gt; Forwarder3_write
+FIFO10_read --&gt; RSSelection_RSSelection2
+RSSelection_RSSelection2 --&gt; Forwarder3_write
 Forwarder3_read --&gt; RSSelection_RSSelection
-Forwarder3_read --&gt; RSSelection_RSSelection2
+Forwarder3_read --&gt; RSSelection_RSSelection1
 RSFuncBlock_select --&gt; RSSelection_RSSelection
 RS_select --&gt; RSSelection_RSSelection
 RSSelection_RSSelection --&gt; FIFO11_write
-RSSelection_RSSelection2 --&gt; FIFO11_write
-RSSelection_RSSelection2 &lt;--&gt; LSUDummy_select
+RSSelection_RSSelection1 --&gt; FIFO11_write
+RSSelection_RSSelection1 &lt;--&gt; LSUDummy_select
 FIFO11_read --&gt; RSInsertion_RSInsertion
 RegisterFile_read1 --&gt; RSInsertion_RSInsertion
 RegisterFile_read2 --&gt; RSInsertion_RSInsertion
@@ -443,19 +443,19 @@ <h1>Full transaction-method graph<a class="headerlink" href="#full-transaction-m
 RS_take --&gt; WakeupSelect3_WakeupSelect
 WakeupSelect_WakeupSelect --&gt; AluFuncUnit_issue
 WakeupSelect_WakeupSelect --&gt; FIFO2_write
-RS_RS1 --&gt; WakeupSelect1_WakeupSelect
+RS_RS3 --&gt; WakeupSelect1_WakeupSelect
 WakeupSelect1_WakeupSelect --&gt; ShiftFuncUnit_issue
 WakeupSelect1_WakeupSelect --&gt; FIFO3_write
-RS_RS3 --&gt; WakeupSelect2_WakeupSelect
+RS_RS1 --&gt; WakeupSelect2_WakeupSelect
 WakeupSelect2_WakeupSelect --&gt; JumpBranchFuncUnit_issue
 WakeupSelect2_WakeupSelect --&gt; ExceptionCauseRegister_report
 WakeupSelect3_WakeupSelect --&gt; ExceptionCauseRegister_report
-LSUDummyInternals_LSUDummyInternals1 --&gt; ExceptionCauseRegister_report
 LSUDummyInternals_LSUDummyInternals --&gt; ExceptionCauseRegister_report
+LSUDummyInternals_LSUDummyInternals1 --&gt; ExceptionCauseRegister_report
 ReorderBuffer_get_indices --&gt; WakeupSelect2_WakeupSelect
 ReorderBuffer_get_indices --&gt; WakeupSelect3_WakeupSelect
-ReorderBuffer_get_indices --&gt; LSUDummyInternals_LSUDummyInternals1
 ReorderBuffer_get_indices --&gt; LSUDummyInternals_LSUDummyInternals
+ReorderBuffer_get_indices --&gt; LSUDummyInternals_LSUDummyInternals1
 WakeupSelect2_WakeupSelect --&gt; FIFO4_write
 WakeupSelect2_WakeupSelect --&gt; FIFO5_write
 RS_RS --&gt; WakeupSelect3_WakeupSelect
@@ -474,25 +474,25 @@ <h1>Full transaction-method graph<a class="headerlink" href="#full-transaction-m
 ExceptionFuncUnit_accept --&gt; ConnectTrans5_ConnectTrans
 FIFO6_read --&gt; ConnectTrans5_ConnectTrans
 LSUDummyInternals_LSUDummyInternals2 --&gt; WishboneMaster1_request
-WishboneMaster1_result --&gt; LSUDummyInternals_LSUDummyInternals
+WishboneMaster1_result --&gt; LSUDummyInternals_LSUDummyInternals1
 ConnectTrans_ConnectTrans --&gt; Forwarder1_write
 ConnectTrans1_ConnectTrans --&gt; Forwarder1_write
 RSFuncBlock_get_result --&gt; ConnectTrans_ConnectTrans
 Collector1_method --&gt; ConnectTrans_ConnectTrans
 Forwarder2_read --&gt; ConnectTrans_ConnectTrans
 LSUDummy_get_result --&gt; ConnectTrans1_ConnectTrans
-ReorderBuffer_peek --&gt; Retirement_Retirement
-Retirement_Retirement --&gt; LSUDummy_precommit
-ReorderBuffer_retire --&gt; Retirement_Retirement1
-ExceptionCauseRegister_get --&gt; Retirement_Retirement1
-Retirement_Retirement1 --&gt; CSRRegister4_write
-Retirement_Retirement1 --&gt; RRAT_commit
-Retirement_Retirement1 --&gt; RegisterFile_free
-Retirement_Retirement1 &lt;--&gt; DoubleCounterCSR2_increment
-CSRRegister5_read --&gt; Retirement_Retirement1
-Retirement_Retirement1 --&gt; CSRRegister5_write
-CSRRegister6_read --&gt; Retirement_Retirement1
-Retirement_Retirement1 --&gt; CSRRegister6_write
+ReorderBuffer_peek --&gt; Retirement_Retirement1
+Retirement_Retirement1 --&gt; LSUDummy_precommit
+ReorderBuffer_retire --&gt; Retirement_Retirement
+ExceptionCauseRegister_get --&gt; Retirement_Retirement
+Retirement_Retirement --&gt; CSRRegister4_write
+Retirement_Retirement --&gt; RRAT_commit
+Retirement_Retirement --&gt; RegisterFile_free
+Retirement_Retirement &lt;--&gt; DoubleCounterCSR2_increment
+CSRRegister5_read --&gt; Retirement_Retirement
+Retirement_Retirement --&gt; CSRRegister5_write
+CSRRegister6_read --&gt; Retirement_Retirement
+Retirement_Retirement --&gt; CSRRegister6_write
 GenericCSRRegisters_GenericCSRRegisters &lt;--&gt; DoubleCounterCSR_increment
 CSRRegister_read --&gt; GenericCSRRegisters_GenericCSRRegisters
 GenericCSRRegisters_GenericCSRRegisters --&gt; CSRRegister_write
@@ -517,7 +517,7 @@ <h1>Full transaction-method graph<a class="headerlink" href="#full-transaction-m
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 16:15 2023-11-02.
+      <span class="lastupdated">Last updated on 20:30 2023-11-05.
       </span></p>
   </div>
 

Development_environment.html

@@ -178,7 +178,7 @@ <h3>build_docs.sh<a class="headerlink" href="#build-docs-sh" title="Permalink to
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 16:15 2023-11-02.
+      <span class="lastupdated">Last updated on 20:30 2023-11-05.
       </span></p>
   </div>
 

Home.html

@@ -129,7 +129,7 @@ <h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 16:15 2023-11-02.
+      <span class="lastupdated">Last updated on 20:30 2023-11-05.
       </span></p>
   </div>
 

Problem-checklist.html

@@ -105,7 +105,7 @@ <h1>Problem checklist<a class="headerlink" href="#problem-checklist" title="Perm
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 16:15 2023-11-02.
+      <span class="lastupdated">Last updated on 20:30 2023-11-05.
       </span></p>
   </div>
 

Transactions.html

@@ -409,7 +409,7 @@ <h3>Transaction and method nesting<a class="headerlink" href="#transaction-and-m
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 16:15 2023-11-02.
+      <span class="lastupdated">Last updated on 20:30 2023-11-05.
       </span></p>
   </div>