add comment about draft instructions
authorJacob Lifshay <programmerjake@gmail.com>
Wed, 8 Dec 2021 01:55:46 +0000 (17:55 -0800)
committerJacob Lifshay <programmerjake@gmail.com>
Wed, 8 Dec 2021 01:55:46 +0000 (17:55 -0800)
src/soc/fu/pipe_data.py

index ec6d240c89e3f75ff152a8a1d615b3b5f910b2dd..b43244b387a38eec951095a40cc9cfbdcc475307 100644 (file)
@@ -85,5 +85,12 @@ class CommonPipeSpec:
 
 
 def get_pspec_draft_bitmanip(pspec):
+    """ True if the draft bitmanip instructions are enabled in the provided
+    pspec. The instructions enabled by this are draft instructions -- they are
+    not official OpenPower instructions, they are intended to be eventually
+    submitted to the OpenPower ISA WG.
+
+    https://libre-soc.org/openpower/sv/bitmanip/
+    """
     # use `is True` to account for Mock absurdities
     return getattr(pspec, "draft_bitmanip", False) is True