Add pages for cocotb setup and use.
authorR Veera Kumar <vklr@vkten.in>
Mon, 24 May 2021 09:19:57 +0000 (14:49 +0530)
committerR Veera Kumar <vklr@vkten.in>
Mon, 24 May 2021 09:19:57 +0000 (14:49 +0530)
HDL_workflow.mdwn
HDL_workflow/cocotb.mdwn [new file with mode: 0644]

index 17ff8af2e971e20d0b8a4161c605877993efdd07..3b41fac5601861fb5290fd290966eb2beb93e149 100644 (file)
@@ -564,6 +564,12 @@ Icarus Verilog is a Verilog simulation and synthesis tool. It operates as a comp
 
 See [[HDL_workflow/iverilog]] page for installation instructions.
 
+## Cocotb
+
+cocotb is a COroutine based COsimulation TestBench environment for verifying VHDL and SystemVerilog RTL using Python.
+
+See [[HDL_workflow/cocotb]] page for installation instructions.
+
 # Registering for git repository access
 
 After going through the onboarding process and having agreed to take
diff --git a/HDL_workflow/cocotb.mdwn b/HDL_workflow/cocotb.mdwn
new file mode 100644 (file)
index 0000000..4446d4c
--- /dev/null
@@ -0,0 +1,37 @@
+# Installation instructions for cocotb
+
+## Setting up new debootstrap and chroot into it
+
+Run the following if you wish to isolate the cocotb build
+from other software (reproducible builds) or use the schroot
+auto-preparation script here:
+<https://git.libre-soc.org/?p=dev-env-setup.git;a=blob;f=mk-deb-chroot;hb=HEAD>
+
+    export MY_CHROOT=/opt/chroot/cocotb
+    mkdir $MY_CHROOT
+    debootstrap stable $MY_CHROOT http://deb.debian.org/debian/
+    mount -t proc proc $MY_CHROOT/proc
+    mount -t sysfs sysfs $MY_CHROOT/sys
+    mount -t devpts devpts $MY_CHROOT/dev/pts/
+    chroot $MY_CHROOT /bin/bash
+
+The dev-env-setup chroot script is a little more sophisticated
+than the above
+
+## Steps to compile cocotb
+
+### Necessary software to install
+
+    apt-get install git python3 python3-dev g++ make \
+                    python3-setuptools python3-pytest
+
+### Build cocotb
+
+    git clone https://github.com/cocotb/cocotb.git
+
+    cd cocotb
+    git checkout v1.5.2
+    python3 setup.py install
+
+Please adjust the install paths for cocotb.
+