Design Plan
============================

Note
---------

- This is originally a project documentation, some files mentioned in this series can be found at `this GitHub repo of mine`_

.. _this GitHub repo of mine: https://github.com/tesla-cat/Works-Done-In-Dzmitry-s-Lab-At-CQT/tree/master/Cyclone%20V%20SoC%20Control%20System


What are we gonna do?
-------------------------

- The Cyclone V SoC FPGA can be used as **sequencer, counter** etc. for the lab
- The FPGA passes the data it collected to the HPS processor via FIFO, the processor has a server running on it, so any client can get the data via XML http request etc.
- The client can also send data, through processor server, to control the FPGA
- We will use DE10-NANO Dev Board to do the above:

.. figure:: imgs/DE10_NANO_Dev_Board.webp



Front End
---------------

Technologies Used:

- Bootstrap 4
- Plotly.js

Notes:

- If the project scales, I will use **React.js** or **Vue.js**, but currently there is no such need

Back End
----------------

Technologies Used:

- Node.js / Python as server

Quartus Project
----------------------

Uses Cyclone V SoC: HPS (processor) + FPGA

What I'm already familiar with:

- C
- Verilog
- Quartus

What I need to learn:

- Communication between HPS and FPGA 

Tutorials
-----------------

- `DE10 Nano User Manual Chapter 7 Examples for using both HPS SoC and FGPA`_
- `DE1 SoC ARM HPS and FPGA Addresses and Communication Cornell ece5760`_
- **Main page of the above:** `ece5760 Reading Material`_ 
- **YouTube series of the above:** `Cyclone 5 and memory mapping`_

.. _DE10 Nano User Manual Chapter 7 Examples for using both HPS SoC and FGPA: https://github.com/tesla-cat/Works-Done-In-Dzmitry-s-Lab-At-CQT/blob/master/Cyclone%20V%20SoC%20Control%20System/Quartus%20Project/DE10-Nano_User_manual_a_b.pdf

.. _DE1 SoC ARM HPS and FPGA Addresses and Communication Cornell ece5760: https://people.ece.cornell.edu/land/courses/ece5760/DE1_SOC/HPS_peripherials/FPGA_addr_index.html
.. _ece5760 Reading Material: https://people.ece.cornell.edu/land/courses/ece5760/#reading
.. _Cyclone 5 and memory mapping: https://www.youtube.com/watch?v=0XRn5KbnzYA&list=PLKcjQ_UFkrd7UcOVMm39A6VdMbWWq-e_c&index=2