comment on CoreState

diff --git a/src/soc/config/state.py b/src/soc/config/state.py
index ebc5bb861053713e430d077a44a5f6efb5b45cce..a3972ef1da9126cf0b74ba828c80944b6b95ac13 100644 (file)
--- a/src/soc/config/state.py
+++ b/src/soc/config/state.py
@@ -4,6 +4,13 @@ from soc.sv.svstate import SVSTATERec
 
 
 class CoreState(RecordObject):
+    """contains "Core State Information" which says exactly where things are
+
+    example: eint says to PowerDecoder that it should fire an exception
+    rather than let the current decoded instruction proceed.  likewise
+    if dec goes negative.  MSR contains LE/BE and Priv state.  PC contains
+    the Program Counter, and SVSTATE is the Sub-Program-Counter.
+    """
     def __init__(self, name):
         super().__init__(name=name)
         self.pc = Signal(64)      # Program Counter (CIA, NIA)