diff --git a/docs/building-examples.rst b/docs/building-examples.rst
index 8f0a547..82454a2 100644
--- a/docs/building-examples.rst
+++ b/docs/building-examples.rst
@@ -29,6 +29,13 @@ Select your FPGA family:
export FPGA_FAM="eos-s3"
+ .. group-tab:: K4N8
+
+ .. code-block:: bash
+ :name: fpga-fam-qlf_k4n8
+
+ export FPGA_FAM="qlf_k4n8"
+
Next, prepare the environment:
.. code-block:: bash
@@ -98,3 +105,20 @@ Then, follow the guidelines for each example:
.. toctree::
eos-s3/btn_counter
+
+
+QuickLogic K4N8
+===============
+
+Enter the directory that contains examples for QuickLogic K4N8:
+
+.. code-block:: bash
+ :name: enter-dir-qlf_k4n8
+
+ cd qlf_k4n8
+
+Then, follow the guidelines for each example:
+
+.. toctree::
+
+ qlf_k4n8/btn_counter
diff --git a/docs/collect_readmes.py b/docs/collect_readmes.py
index 82c396d..2f1cd8c 100644
--- a/docs/collect_readmes.py
+++ b/docs/collect_readmes.py
@@ -10,7 +10,7 @@ full_name_lut = {
'zybo': 'Zybo Z7',
'nexys_video': 'Nexys Video',
}
-families = ('xc7', 'eos-s3')
+families = ('xc7', 'eos-s3', 'qlf_k4n8')
inlines = ('literal', 'strong', 'reference')
diff --git a/docs/development/running-ci-locally.rst b/docs/development/running-ci-locally.rst
index 9fbe1c4..dc7a190 100644
--- a/docs/development/running-ci-locally.rst
+++ b/docs/development/running-ci-locally.rst
@@ -9,7 +9,7 @@ For this, you will need `tuttest `_, which
pip install git+https://github.com/antmicro/tuttest
-* ```` is one of ``{eos-s3, xc7}`` (the two currently covered platforms - EOS-S3 and Xilinx series 7).
+* ```` is one of ``{eos-s3, xc7, qlf_k4n8}`` (the three currently covered platforms - EOS-S3, K4N8 and Xilinx series 7).
* ```` is one of ``{ubuntu, debian, centos}`` (currently supported operating systems).
diff --git a/docs/getting.rst b/docs/getting.rst
index 27bb98e..b548d81 100644
--- a/docs/getting.rst
+++ b/docs/getting.rst
@@ -107,6 +107,13 @@ Select your target FPGA family:
export FPGA_FAM=eos-s3
+ .. group-tab:: K4N8
+
+ .. code-block:: bash
+ :name: fpga-fam-qlf_k4n8
+
+ export FPGA_FAM=qlf_k4n8
+
Next, setup Conda and your system's environment, and download architecture definitions:
.. NOTE::
@@ -137,6 +144,13 @@ Next, setup Conda and your system's environment, and download architecture defin
export F4PGA_PACKAGES='install-ql ql-eos-s3_wlcsp'
+ .. group-tab:: K4N8
+
+ .. code-block:: bash
+ :name: packages-qlf_k4n8
+
+ export F4PGA_PACKAGES='install-ql qlf_k4n8-qlf_k4n8_umc22_fast_qlf_k4n8-qlf_k4n8_umc22_fast qlf_k4n8-qlf_k4n8_umc22_qlf_k4n8-qlf_k4n8_umc22 qlf_k4n8-qlf_k4n8_umc22_slow_qlf_k4n8-qlf_k4n8_umc22_slow'
+
.. code-block:: bash
:name: get-packages
@@ -157,6 +171,7 @@ If the above commands exited without errors, you have successfully installed and
* Subdir :ghsrc:`xc7` for the Artix-7 devices
* Subdir :ghsrc:`eos-s3` for the EOS S3 devices
+ * Subdir :ghsrc:`qlf_k4n8` for the K4N8 devices
.. HINT::
Sometimes it may be preferable to get the latest versions of the tools before the pinned versions in this repository
diff --git a/docs/index.rst b/docs/index.rst
index b1b5cfe..bbe9d3b 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -7,6 +7,7 @@ It currently focuses on the following FPGA families:
- Artix-7 from Xilinx,
- EOS-S3 from QuickLogic.
+- K4N8 from QuickLogic.
Follow this guide to:
@@ -24,7 +25,7 @@ F4PGA is a fully open source toolchain for the development of FPGAs, currently t
- Xilinx's 7-Series.
- Lattice's ICE40 and ECP5.
-- QuickLogic's EOS-S3.
+- QuickLogic's EOS-S3 and K4N8.
Gain valuable information about the flows and the tools in section :ref:`Design Flows ` at
:doc:`F4PGA Documentation `.
diff --git a/docs/qlf_k4n8/btn_counter.rst b/docs/qlf_k4n8/btn_counter.rst
new file mode 100644
index 0000000..a1db10a
--- /dev/null
+++ b/docs/qlf_k4n8/btn_counter.rst
@@ -0,0 +1,2 @@
+.. jinja:: qlf_k4n8_btn_counter
+ :file: templates/example.jinja