From: Luke Kenneth Casson Leighton <lkcl@lkcl.net>
Date: Sat, 24 Nov 2018 01:36:42 +0000 (+0000)
Subject: document decode functions
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=6b5967ce33bc95294345894a864afee188f9410a;p=rv32.git

document decode functions
---

diff --git a/cpu_decoder.py b/cpu_decoder.py
index 995a04c..3cb0701 100644
--- a/cpu_decoder.py
+++ b/cpu_decoder.py
@@ -154,7 +154,7 @@ class CPUDecoder(Module):
         return self._decode_funct3(DA.jalr, [F3.jalr, ])
 
     def calculate_op_action(self):
-        """ decode op action
+        """ decode op action: the arith ops, and, or, add, xor, sr/sl etc.
         """
         c = {}
         immz = Constant(0, 12)
@@ -178,7 +178,7 @@ class CPUDecoder(Module):
         return Case(self.funct3, c)
 
     def calculate_misc_action(self):
-        """ decode misc mem action
+        """ decode misc mem action: fence and fence_i
         """
         c = {}
         immz = Constant(0, 12)
@@ -203,7 +203,7 @@ class CPUDecoder(Module):
         return Case(self.funct3, c)
 
     def calculate_system_action(self):
-        """ decode system action
+        """ decode opcode system: ebreak and csrs
         """
         c = {}
         b1 = Constant(1, 32)