diff options
author | umarcor <unai.martinezcorral@ehu.eus> | 2020-05-08 11:17:36 +0200 |
---|---|---|
committer | tgingold <tgingold@users.noreply.github.com> | 2020-05-08 17:40:30 +0200 |
commit | 763e2444798682f39e1e43397b549629372b47d8 (patch) | |
tree | 70c2874844735df13a320eeb0511e42ebda6c681 /doc/examples/quick_start/heartbeat | |
parent | 203564db51bb4db5b9009f122ac4823d6c499e9c (diff) | |
download | ghdl-763e2444798682f39e1e43397b549629372b47d8.tar.gz ghdl-763e2444798682f39e1e43397b549629372b47d8.tar.bz2 ghdl-763e2444798682f39e1e43397b549629372b47d8.zip |
doc: move 'examples/quick_start' to 'quick_start'
Diffstat (limited to 'doc/examples/quick_start/heartbeat')
-rw-r--r-- | doc/examples/quick_start/heartbeat/README.rst | 42 | ||||
-rw-r--r-- | doc/examples/quick_start/heartbeat/heartbeat.vhdl | 20 |
2 files changed, 0 insertions, 62 deletions
diff --git a/doc/examples/quick_start/heartbeat/README.rst b/doc/examples/quick_start/heartbeat/README.rst deleted file mode 100644 index e95145095..000000000 --- a/doc/examples/quick_start/heartbeat/README.rst +++ /dev/null @@ -1,42 +0,0 @@ -.. program:: ghdl -.. _QuickStart:heartbeat: - -`Heartbeat` module -================== - -Although :ref:`Hello world <QuickStart:hello>` illustrates that `VHDL` is supported as a general purpose language, the main use case -of `GHDL` is to simulate hardware descriptions. The following block, which is saved in a file named -:file:`heartbeat.vhdl`, is an example of how to generate a 100 MHz clock signal with non-synthesisable VHDL: - -.. literalinclude:: heartbeat.vhdl - :language: vhdl - -It can be :ref:`analysed <Analysis:command>`, :ref:`elaborated <Elaboration:command>` and :ref:`run <Run:command>`, as you already know: - -.. code-block:: shell - - ghdl -a heartbeat.vhdl - ghdl -e heartbeat - ghdl -r heartbeat - -However, execution of the design does not terminate. At the same time, no output is shown on screen. This is because, -traditionally, hardware designs are continuously running devices which do not have a screen where to print. In this -context, inspection and verification of the behaviour is done through `waveforms <https://en.wikipedia.org/wiki/Waveform_viewer>`_, -which is supported by `GHDL` (see :ref:`export_waves`). You can use either :option:`--wave`, :option:`--vcd`, -:option:`--vcdgz` or :option:`--fst` to save the signals of the simulation to a file. Then, terminate the execution -(:kbd:`C-c`) and you can inspect the wave with a viewer, such as `GtkWave <http://gtkwave.sourceforge.net/>`_. As -explained in the `manual <http://gtkwave.sourceforge.net/gtkwave.pdf>`_, GtkWave *'relies on a post-mortem approach -through the use of dumpfiles'*. Therefore, you should first simulate your design and dump a waveform file, say GHW: - -.. code-block:: shell - - ghdl -r heartbeat --wave=wave.ghw - -Then, you can view the dump: - -.. code-block:: shell - - gtkwave wave.ghw - -Of course, manually terminating the simulation is for illustration purposes only. In :ref:`Full adder <QuickStart:adder>` and -:ref:`QuickStart:DLX`, you will see how to write a testbench to terminate the simulation programmatically. diff --git a/doc/examples/quick_start/heartbeat/heartbeat.vhdl b/doc/examples/quick_start/heartbeat/heartbeat.vhdl deleted file mode 100644 index 0a312641e..000000000 --- a/doc/examples/quick_start/heartbeat/heartbeat.vhdl +++ /dev/null @@ -1,20 +0,0 @@ -library ieee; -use ieee.std_logic_1164.all; - -entity heartbeat is - port ( clk: out std_logic); -end heartbeat; - -architecture behaviour of heartbeat -is - constant clk_period : time := 10 ns; -begin - -- Clock process definition - clk_process: process - begin - clk <= '0'; - wait for clk_period/2; - clk <= '1'; - wait for clk_period/2; - end process; -end behaviour; |