~uer-developers/ubuntuelectronicsremix/uer-docs-karmic

For this tutorial we will use Gedit, the default text editor in Gnome, to edit the VHDL code. Ubuntu has a number of different text editors available as shown on the <link href="http://mbmn.net/uer/tools/editors/">HDL Editors</link> page.

To make Gedit easier to use we will use a number of plugins. Plugins are small extensions to Gedit to allow Gedit to do some extra tricks. Alternatively use external programs instead of the plugins if desired.

Start Gedit (Accessories -> Text Editor) and select Edit -> Preferences and click the Plugins Tab. Click the box next to Code Comment, File Browser Pane and Embedded Terminal to active these plugins.

In the Left side panel of Gedit click the File Browser tab, this usually has a filing cabinet icon. Use the file browser (or if you wish use another file browser) to create a directory for this project and create three sub-directories: src, testbench and simulation.

To make using GHDL easier to use copy the following Makefile into Gedit and save it to the project directory and as a file named Makefile.

<code>

# vhdl files

FILES = src/*

VHDLEX = .vhd

# testbench

TESTBENCHPATH = testbench/${TESTBENCH}$(VHDLEX)

#GHDL CONFIG

GHDL_CMD = ghdl

GHDL_FLAGS = --ieee=synopsys --warn-no-vital-generic

SIMDIR = simulation

# Simulation break condition

#GHDL_SIM_OPT = --assert-level=error

GHDL_SIM_OPT = --stop-time=500ns

WAVEFORM_VIEWER = gtkwave

all: compile run view

new :

echo "Setting up project ${PROJECT}"

mkdir src testbench simulation

compile :

ifeq ($(strip $(TESTBENCH)),)

@echo "TESTBENCH not set. Use TESTBENCH=value to set it."

@exit 2

endif

mkdir -p simulation

$(GHDL_CMD) -i $(GHDL_FLAGS) --workdir=simulation --work=work $(TESTBENCHPATH) $(FILES)

$(GHDL_CMD) -m $(GHDL_FLAGS) --workdir=simulation --work=work $(TESTBENCH)

@mv $(TESTBENCH) simulation/$(TESTBENCH)

run :

@$(SIMDIR)/$(TESTBENCH) $(GHDL_SIM_OPT) --vcdgz=$(SIMDIR)/$(TESTBENCH).vcdgz

view :

gunzip --stdout $(SIMDIR)/$(TESTBENCH).vcdgz | $(WAVEFORM_VIEWER) --vcd

clean :

$(GHDL_CMD) --clean --workdir=simulation</code>

<section>Writing Code</section>

Create a new file and save it in the the src directory as counter.vhd in and copy the following VHDL code into the file and save the file. This file describes a simple 8-bit counter with a up / down selection, input, output and reset.

<code>

library ieee;

use ieee.std_logic_1164.all;

use ieee.std_logic_unsigned.all;

entity up_down_counter is

port (

cout :out std_logic_vector (7 downto 0);

up_down :in std_logic; -- up_down control for counter

clk :in std_logic; -- Input clock

reset :in std_logic -- Input reset

);

end entity;

architecture rtl of up_down_counter is

signal count :std_logic_vector (7 downto 0);

100

begin

101

process (clk, reset) begin

102

if (reset = '1') then

103

count <= (others=>'0');

104

elsif (rising_edge(clk)) then

105

if (up_down = '1') then

106

count <= count + 1;

107

else

108

count <= count - 1;

109

end if;

110

end if;

111

end process;

112

cout <= count;

113

end architecture;</code>

114

115

116

Create another new file and save it in the testbench directory as counter_tb.vhd and copy the code below into the file and save the file. This file is a simple test bench to test the counter.

117

118

<code>library ieee;

119

use ieee.std_logic_1164.all;

120

use ieee.std_logic_unsigned.all;

121

122

entity counter_tb is

123

end entity;

124

125

architecture TB of counter_tb is

126

127

component up_down_counter

128

port( cout: out std_logic_vector(7 downto 0);

129

up_down: in std_logic;

130

reset: in std_logic;

131

clk: in std_logic

132

133

);

134

end component;

135

136

signal cout: std_logic_vector(7 downto 0);

137

signal up_down: std_logic;

138

signal reset: std_logic;

139

signal clk: std_logic;

140

141

begin

142

143

dut: up_down_counter port map (cout, up_down, reset, clk);

144

145

process

146

begin

147

clk <= '0';

148

wait for 5 ns;

149

clk <= '1';

150

wait for 5 ns;

151

end process;

152

153

process

154

begin

155

up_down <= '1';

156

reset <= '1';

157

wait for 10 ns;

158

reset <= '0';

159

wait for 100 ns;

160

161

up_down <= '0';

162

wait for 100 ns;

163

end process;

164

end;</code>

165

166

<section>Simulation and Viewing the result</section>

167

168

Now we have created a simple counter and testbench it is time to simulate the design.

169

Select the terminal tab at the bottom of the Gedit window. To simulate the design first change to the top level project directory using the cd command, as shown below.

170

171

<code>cd /path/to/project/dir</code>

172

173

To simulate a design with gHDL three steps are needed, these are included in the Makefile given above, shown below, as we are using the make file don't run GHDL directly use the make commands shown below.

174

175

<code>ghdl -i FILES

176

ghdl -m TESTBENCH_NAME

177

ghdl -r TESTBENCH_NAME</code>

178

179

First GHDL is ran with the -i option and a list of all files in the design. This analysis all units in the design in the correct order, and will check for and errors in the VHDL code. Next GHDL is ran with the -m option and the name of the top unit which will usually be a testbench. This analysis and elaborates the design and creates an executable to run the simulation. The simulation is ran executing ghdl with the -r option.

180

181

The above flow is included in the Makefile to make it easier to simulate designs and view the result, as shown below. The first line runs the Ghdl twice once with -i and then with -m, the second line runs Ghdl -r and the final line shows results in the waveform viewer GTKWave.

182

183

<code>make compile TESTBENCH=counter_tb

184

make run TESTBENCH=counter_tb

185

make view</code>

186

187

All three steps above can be ran with the command

188

189

<code>make all TESTBENCH=counter_tb</code>

190

191

The Makefile is designed to make your life easier. But to do this it makes some assumptions, which are:

192

193

<list>

194

<item>The design files are in a sub-directory src.</item>

195

<item>The testbench is in a sub-directory called testbench.</item>

196

<item>The testbench entity has the same name as the testbench file.</item>

197

</list>

198

199

These assumptions are met in the above example, so if you have done everything right you should have no trouble.

200

201

202

After running the above commands GTKWave should open. To view signals from the design select the design from the top left side pane and select a signal from the bottom left side pane and click Insert at the bottom left of the GTKWave window.

203

204

<section>Further Information</section>

205

206

For more information on using GHDL and GTKWave see the project websites.

207

208

209

210

211

</page>