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

[c4m-jtag.git] / sim / cocotb / c4m_jtag.py

diff --git a/sim/cocotb/c4m_jtag.py b/sim/cocotb/c4m_jtag.py
index 5deb89a1362f05293fecfac467ca24d2baa5b63a..48d2677cc5920daa1423d4c6cf82d7efaa8f537f 100644 (file)
--- 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):
 
     @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()
         tms_copy = list(tms_list)
         while tms_copy:
             self.tms <= tms_copy.pop()