From: Luke Kenneth Casson Leighton <lkcl@lkcl.net>
Date: Mon, 8 Jun 2020 18:26:51 +0000 (+0100)
Subject: add comment docstring about POWER9 simulator
X-Git-Tag: div_pipeline~464
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=14def506c45c4d0616bc135421ac1fcf17fceca1;p=soc.git

add comment docstring about POWER9 simulator
---

diff --git a/src/soc/decoder/isa/caller.py b/src/soc/decoder/isa/caller.py
index 6541a56c..532957e8 100644
--- a/src/soc/decoder/isa/caller.py
+++ b/src/soc/decoder/isa/caller.py
@@ -1,3 +1,10 @@
+"""core of the python-based POWER9 simulator
+
+this is part of a cycle-accurate POWER9 simulator.  its primary purpose is
+not speed, it is for both learning and educational purposes, as well as
+a method of verifying the HDL.
+"""
+
 from functools import wraps
 from soc.decoder.orderedset import OrderedSet
 from soc.decoder.selectable_int import (FieldSelectableInt, SelectableInt,