From: Jacob Lifshay <programmerjake@gmail.com>
Date: Wed, 8 Dec 2021 01:55:46 +0000 (-0800)
Subject: add comment about draft instructions
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=6dfe443174d838c5ded40dc3e889a123725d4727;p=soc.git

add comment about draft instructions
---

diff --git a/src/soc/fu/pipe_data.py b/src/soc/fu/pipe_data.py
index ec6d240c..b43244b3 100644
--- a/src/soc/fu/pipe_data.py
+++ b/src/soc/fu/pipe_data.py
@@ -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