From: lkcl <lkcl@web>
Date: Sat, 23 Jul 2022 13:07:25 +0000 (+0100)
Subject: (no commit message)
X-Git-Tag: opf_rfc_ls005_v1~1079
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=d92970b3f3b4b38c1971b87e96d6261923a3eb31;p=libreriscv.git

---

diff --git a/docs/pypowersim.mdwn b/docs/pypowersim.mdwn
index 32e659115..f59183db8 100644
--- a/docs/pypowersim.mdwn
+++ b/docs/pypowersim.mdwn
@@ -11,9 +11,17 @@
 These are multimedia tests intended to cover the inner loops of various
 Audio/Video CODECs (such as MP3).
 
-**Note:** There's no GUI, UART, or console. To check that the tests ran
+**Note 1:** There's no GUI, UART, or console. To check that the tests ran
 succesfully, you need to dump the memory contents and inspect the output.
 
+**Note 2:** pypowersim is designed for ease-of-understanding of the Power
+ISA and as a tool to check that the Power ISA Specification itself is
+correct. For example, a python class
+[SelectableInt](https://git.libre-soc.org/?p=openpower-isa.git;a=blob;f=src/openpower/decoder/selectable_int.py;hb=HEAD)
+has been created which understands IBM MSB0 ordering. This
+*deliberate and conscious* design choice to focus on readability
+and understanding makes pypowersim extremely slow: an Intel i9 running
+at 4.8 ghz is only capable of 2,500 instructions per second.
 
 # Pypowersim - PowerISA Simulator