From: Staf Verhaegen <staf@stafverhaegen.be>
Date: Sat, 14 Apr 2018 09:17:45 +0000 (+0200)
Subject: JTAG_master class: document need for manual setting of state after using change_state... 
X-Git-Tag: 24jan2021ls180~63
X-Git-Url: https://git.libre-soc.org/?p=c4m-jtag.git;a=commitdiff_plain;h=c2d23669441fa7e61fc23e11afec04cdc8cd0544

JTAG_master class: document need for manual setting of state after using change_state method
---

diff --git a/sim/cocotb/c4m_jtag.py b/sim/cocotb/c4m_jtag.py
index 5deb89a..48d2677 100644
--- a/sim/cocotb/c4m_jtag.py
+++ b/sim/cocotb/c4m_jtag.py
@@ -84,6 +84,12 @@ class JTAG_Master(object):
 
     @cocotb.coroutine
     def change_state(self, tms_list):
+        """
+        Put TAP in other state by giving a TMS sequence
+        This function does not detect if one ends up in reset or run
+        state afterwards, self.state has to be updated by caller
+        if that is the case.
+        """
         tms_copy = list(tms_list)
         while tms_copy:
             self.tms <= tms_copy.pop()