File size: 9,556 Bytes
cb65407 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 | .. _refcard:
**************
Reference Card
**************
..
Document "best practice"; leave out detail.
Keep format as 1/3rd width of A4/Letter for taping to monitor frames.
The "| " syntax is a "Line Block", see
https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#line-blocks
.. spelling:word-list::
coro
coros
func
metavalue
TestFactory
*coro*: a coroutine; *task*: a running coroutine
+------------------------+-----------------------------------------------------------------+
| Assign | ``dut.mysignal.value = 0xFF00`` |
+------------------------+-----------------------------------------------------------------+
| Assign immediately | ``dut.mysignal.setimmediatevalue(0xFF00)`` |
+------------------------+-----------------------------------------------------------------+
| Assign metavalue | | ``dut.mysignal.value = Logic("X")`` |
| | | ``dut.mysignal.value = LogicArray("01XZ")`` |
+------------------------+-----------------------------------------------------------------+
| Read | | ``val = dut.mysignal.value`` |
| | | (``mysig = dut.mysignal`` *creates an alias/reference*) |
+------------------------+-----------------------------------------------------------------+
| Bit slice | | ``mybit = dut.myarray[0].value`` |
| | | ``mybits = dut.mysignal.value[0]`` |
+------------------------+-----------------------------------------------------------------+
| Convert | | ``val = dut.mysignal.value.integer`` |
| | | ``val = dut.mysignal.value.binstr`` |
+------------------------+-----------------------------------------------------------------+
| Vector length | ``num_bits = len(dut.mysignal)`` |
+------------------------+-----------------------------------------------------------------+
| Check | ``assert dut.mysignal.value == exp, "Not as expected!"`` |
+------------------------+---------------+-------------------------------------------------+
| Access Extended / Escaped Identifiers | ``dut["\\!Hello!\\"]`` |
+------------------------+---------------+-------------------------------------------------+
| Logging | ``dut._log.info("Value is", dut.mysignal.value)`` |
+------------------------+-----------------------------------------------------------------+
| |
+------------------------+-----------------------------------------------------------------+
| Wait time | ``await cocotb.triggers.Timer(12, "ns")`` |
+------------------------+-----------------------------------------------------------------+
| Generate clock | ``clk = await cocotb.start(Clock(dut.clk, 12, "ns").start())`` |
+------------------------+-----------------------------------------------------------------+
| Wait for signal edge | | ``await cocotb.triggers.RisingEdge(dut.mysignal)`` |
| | | ``await cocotb.triggers.FallingEdge(dut.mysignal)`` |
| | | ``await cocotb.triggers.Edge(dut.mysignal)`` |
+------------------------+-----------------------------------------------------------------+
| Run coros concurrently | | ``task_0 = await cocotb.start(coro_0())`` (start coro now) |
| | | ``task_1 = cocotb.start_soon(coro)`` |
| | | ``result = await task_0`` |
+------------------------+-----------------------------------------------------------------+
| Resume on Task 0 or 1 | ``await cocotb.triggers.First(task_0, task_1)`` |
+------------------------+-----------------------------------------------------------------+
| Resume on Task 0 and 1 | ``await cocotb.triggers.Combine(task_0, task_1)`` |
+------------------------+-----------------------------------------------------------------+
| Kill coro | ``task_0.kill()`` |
+------------------------+-----------------------------------------------------------------+
| |
+------------------------+-----------------------------------------------------------------+
| Queue write | | ``await cocotb.queue.Queue.put(item)`` |
| | | ``cocotb.queue.Queue.put_nowait(item)`` |
+------------------------+-----------------------------------------------------------------+
| Queue read | | ``item = await cocotb.queue.Queue.get()`` |
| | | ``item = cocotb.queue.Queue.get_nowait()`` |
+------------------------+-----------------------------------------------------------------+
| Queue attributes | | ``queue.maxsize`` (``None`` *== unlimited*) |
| | | ``queue.qsize()`` |
| | | ``queue.empty()`` |
| | | ``queue.full()`` |
+------------------------+-----------------------------------------------------------------+
| Specialized queues | ``.PriorityQueue``, ``.LifoQueue`` |
+------------------------+-----------------------------------------------------------------+
| |
+------------------------+-----------------------------------------------------------------+
| Set up event | ``e = cocotb.triggers.Event()`` |
+------------------------+-----------------------------------------------------------------+
| Wake up waiters | ``e.set()`` |
+------------------------+-----------------------------------------------------------------+
| Wait until ``set()`` | ``await e.wait()`` |
+------------------------+-----------------------------------------------------------------+
| Reset after ``set()`` | ``e.clear()`` |
+------------------------+-----------------------------------------------------------------+
| Timeout | ``await cocotb.triggers.with_timeout(coro, 1, "us")`` |
+------------------------+-----------------------------------------------------------------+
| |
+------------------------+-----------------------------------------------------------------+
| Force value | ``dut.mysignal.value = cocotb.handle.Force(0xFF00)`` |
+------------------------+-----------------------------------------------------------------+
| Keep value | ``dut.mysignal.value = cocotb.handle.Freeze()`` |
+------------------------+-----------------------------------------------------------------+
| Release Force/Freeze | ``dut.mysignal.value = cocotb.handle.Release()`` |
+------------------------+-----------------------------------------------------------------+
| *Normal assignment is a "deposit"* (``cocotb.handle.Deposit()``) |
+------------------------+-----------------------------------------------------------------+
| |
+------------------------+-----------------------------------------------------------------+
| Mark as test | ``@cocotb.test(skip, expect_fail, timeout_time, timeout_unit)`` |
+------------------------+-----------------------------------------------------------------+
| Normal func → coro | ``@cocotb.external()`` |
+------------------------+-----------------------------------------------------------------+
| Allow func to block | ``@cocotb.function()`` |
+------------------------+-----------------------------------------------------------------+
| |
+------------------------+-----------------------------------------------------------------+
| Set up TestFactory | ``tf = cocotb.regression.TestFactory(coro)`` |
+------------------------+-----------------------------------------------------------------+
| Add test option | ``tf.add_option("arg", ["val0", "val1"])`` |
+------------------------+-----------------------------------------------------------------+
| Generate tests | ``tf.generate_tests()`` |
+------------------------+-----------------------------------------------------------------+
|