Using Library Modules

in Verilog Designs
For Quartus II 12.0
1 Introduction
This tutorial explains how Alteras library modules can be included in Verilog-based designs, which are implemented
by using the Quartus

II software.
Contents:
Example Circuit
Library of Parameterized Modules
Augmented Circuit with an LPM
Results for the Augmented Design
Altera Corporation - University Program
May 2012
1
USING LIBRARY MODULES IN VERILOG DESIGNS For Quartus II 12.0
2 Background
Practical designs often include commonly used circuit blocks such as adders, subtractors, multipliers, decoders,
counters, and shifters. Altera provides efcient implementations of such blocks in the form of library modules that
can be instantiated in Verilog designs. The compiler may recognize that a standard function specied in Verilog code
can be realized using a library module, in which case it may automatically infer this module. However, many library
modules provide functionality that is too complex to be recognized automatically by the compiler. These modules
have to be instantiated in the design explicitly by the user. Quartus

II software includes a library of parameterized

modules (LPM). The modules are general in structure and they are tailored to a specic application by specifying
the values of general parameters.
Doing this tutorial, the reader will learn about:
Library of parameterized modules (LPMs)
Conguring an LPM for use in a circuit
Instantiating an LPM in a designed circuit
The detailed examples in the tutorial were obtained using the Quartus II version 12.0, but other versions of the
software can also be used. When selecting a device within Quartus II, use the device names associated with FPGA
chip on the DE-series board by referring to Table 1.
Board Device Name
DE0 Cyclone III EP3C16F484C6
DE0-Nano Cyclone IVE EP4CE22F17C6
DE1 Cyclone II EP2C20F484C7
DE2 Cyclone II EP2C35F672C6
DE2-70 Cyclone II EP2C70F896C6
DE2-115 Cyclone IVE EP4CE115F29C7
Table 1. DE-series FPGA device names
3 Example Circuit
As an example, we will use the adder/subtractor circuit shown in Figure 1. It can add, subtract, and accumulate n-bit
numbers using the 2s complement number representation. The two primary inputs are numbers A =a
n1
a
n2
a
0
and B = b
n1
b
n2
b
0
, and the primary output is Z = z
n1
z
n2
z
0
. Another input is the AddSub control signal
which causes Z = A+B to be performed when AddSub = 0 and Z = AB when AddSub = 1. A second control input,
Sel, is used to select the accumulator mode of operation. If Sel = 0, the operation Z = AB is performed, but if Sel
= 1, then B is added to or subtracted from the current value of Z. If the addition or subtraction operations result in
arithmetic overow, an output signal, Overow, is asserted.
2 Altera Corporation - University Program
May 2012
USING LIBRARY MODULES IN VERILOG DESIGNS For Quartus II 12.0
To make it easier to deal with asynchronous input signals, they are loaded into ip-ops on a positive edge of the
clock. Thus, inputs A and B will be loaded into registers Areg and Breg, while Sel and AddSub will be loaded into
ip-ops SelR and AddSubR, respectively. The adder/subtractor circuit places the result into register Zreg.
Figure 1. The adder/subtractor circuit.
The required circuit is described by the Verilog code in Figure 2. For our example, we use a 16-bit circuit as specied
by n =16. Implement this circuit as follows:
Create a project addersubtractor.
Include a le addersubtractor.v, which corresponds to Figure 2, in the project. For convenience, this le is
provided in the design_les subdirectory within the tutorials folder, which is included on the CD-ROM that
accompanies the DE-series board and can also be found on Alteras DE-series web pages.
Select the FPGA chip that is on the DE-series board. A list of device names on DE-series boards can be found
in Table 1.
Compile the design.
Simulate the design by applying some typical inputs.
Altera Corporation - University Program
May 2012
3
USING LIBRARY MODULES IN VERILOG DESIGNS For Quartus II 12.0
// Top-level module
module addersubtractor (A, B, Clock, Reset, Sel, AddSub, Z, Overow);
parameter n = 16;
input [n1:0] A, B;
input Clock, Reset, Sel, AddSub;
output [n1:0] Z;
output Overow;
reg SelR, AddSubR, Overow;
reg [n1:0] Areg, Breg, Zreg;
wire [n1:0] G, H, M, Z;
wire carry_out, over_ow;
// Dene combinational logic circuit
assign H = Breg

{n{AddSubR}};
mux2to1 multiplexer (Areg, Z, SelR, G);
defparam multiplexer.k = n;
adderk nbit_adder (AddSubR, G, H, M, carryout);
defparam nbit_adder.k = n;
assign over_ow = carryout

G[n-1]

H[n-1]

M[n-1];
assign Z = Zreg;
// Dene ip-ops and registers
always @(posedge Reset or posedge Clock)
if (Reset == 1)
begin
Areg <= 0; Breg <= 0; Zreg <= 0;
SelR <= 0; AddSubR <= 0; Overow <= 0;
end
else
begin
Areg <= A; Breg <= B; Zreg <= M;
SelR <= Sel; AddSubR <= AddSub; Overow <= over_ow;
end
endmodule
// k-bit 2-to-1 multiplexer
module mux2to1 (V, W, Sel, F);
parameter k = 8;
... continued in Part b
Figure 2. Verilog code for the circuit in Figure 1 (Part a)
4 Altera Corporation - University Program
May 2012
USING LIBRARY MODULES IN VERILOG DESIGNS For Quartus II 12.0
input [k1:0] V, W;
input Sel;
output [k1:0] F;
reg [k1:0] F;
always @(V or W or Sel)
if (Sel == 0)
F = V;
else
F = W;
endmodule
// k-bit adder
module adderk (carryin, X, Y, S, carryout);
parameter k = 8;
input [k1:0] X, Y;
input carryin;
output [k1:0] S;
output carryout;
reg [k1:0] S;
reg carryout;
always @(X or Y or carryin)
{carryout, S} = X + Y + carryin;
endmodule
Figure 2. Verilog code for the circuit in Figure 1 (Part b).
4 Library of Parameterized Modules
The LPMs in the library of parameterized modules are general in structure and they can be congured to suit a
specic application by specifying the values of various parameters. Select Help > Search and type Megafunction-
s/LPM in the search box. Click Megafunctions/LPMin the search results to see a listing of the available LPMs. One
of them is an adder/subtractor module called lpm_add_sub. Select this module to see its description. The module
has a number of inputs and outputs, some of which may be omitted in a given application. Several parameters can
be dened to specify a particular mode of operation. For example, the number of bits in the operands is specied
in the parameter LPM_WIDTH. The LPM_REPRESENTATION parameter species whether the operands are to be
interpreted as signed or unsigned numbers, and so on. Templates on how an LPM can be instantiated in a hardware
description language are given in the description of the module. Using these templates is somewhat cumbersome, so
Quartus II software provides a wizard that makes the instantiation of LPMs easy.
We will use the lpm_add_sub module to simplify our adder/subtractor circuit dened in Figures 1 and 2. The
augmented circuit is given in Figure 3. The lpm_add_sub module, instantiated under the name megaddsub, replaces
the adder circuit as well as the XOR gates that provide the input H to the adder. Since arithmetic overow is one of
Altera Corporation - University Program
May 2012
5
USING LIBRARY MODULES IN VERILOG DESIGNS For Quartus II 12.0
the outputs that the LPM provides, it is not necessary to generate this output with a separate XOR gate.
To implement this adder/subtractor circuit, create a new directory named tutorial_lpm, and then create a project
addersubtractor2. Choose the same device as we previously selected (Refer to Table 1) to allow a direct comparison
of implemented designs.
Figure 3. The augmented adder/subtractor circuit.
The new design will include the desired LPM subcircuit specied as a Verilog module that will be instantiated in
the top-level Verilog design module. The Verilog module for the LPM subcircuit is generated by using a wizard as
follows:
1. Select Tools > MegaWizard Plug-in Manager, which leads to a sequence of seven pop-up boxes in which
the user can specify the details of the desired LPM.
2. In the box shown in Figure 4 indicate Create a new custom megafunction variation and click Next.
6 Altera Corporation - University Program
May 2012
USING LIBRARY MODULES IN VERILOG DESIGNS For Quartus II 12.0
Figure 4. Choose to dene an LPM.
Figure 5. Choose an LPM from the available library.
3. The box in Figure 5 provides a list of the available LPMs. Expand the arithmetic sublist and select
Altera Corporation - University Program
May 2012
7
USING LIBRARY MODULES IN VERILOG DESIGNS For Quartus II 12.0
LPM_ADD_SUB. Choose Verilog HDL as the type of output le that should be created. The output le
must be given a name; choose the name megaddsub.v and indicate that the le should be placed in the direc-
tory tutorial_lpm as shown in the gure. Press Next.
Figure 6. Specify the size of data inputs.
4. In the box in Figure 6 specify that the width of the data inputs is 16 bits. Also, specify the operating mode
in which one of the ports allows performing both addition and subtraction of the input operand, under the
control of the add_sub input. A symbol for the resulting LPM is shown in the top left corner. Note that if
add_sub = 1 then result = A +B; otherwise, result = A B. This interpretation of the control input and the
operation performed is different from our original design in Figures 1 and 2, which we have to account for in
the modied design. Observe that we have included this change in the circuit in Figure 3. Click Next.
8 Altera Corporation - University Program
May 2012
USING LIBRARY MODULES IN VERILOG DESIGNS For Quartus II 12.0
Figure 7. Further specication of inputs.
5. In the box in Figure 7, specify that the values of both inputs may vary and select Signed for the type of
addition/subtraction. Click Next.
Altera Corporation - University Program
May 2012
9
USING LIBRARY MODULES IN VERILOG DESIGNS For Quartus II 12.0
Figure 8. Specify the Overow output.
6. The box in Figure 8 allows the designer to indicate optional inputs and outputs that may be specied. Since
we need the overow signal, make the Create an overow output choice and press Next.
10 Altera Corporation - University Program
May 2012
USING LIBRARY MODULES IN VERILOG DESIGNS For Quartus II 12.0
Figure 9. Refuse the pipelining option.
7. In the box in Figure 9 say No to the pipelining option and click Next.
8. Figure 10 shows the simulation model les needed to simulate the generated design. Press Next to proceed to
the nal page.
Altera Corporation - University Program
May 2012
11
USING LIBRARY MODULES IN VERILOG DESIGNS For Quartus II 12.0
Figure 10. Simulation model les.
9. Figure 11 gives a summary which shows the les that the wizard will create. Press Finish to complete the
process.
12 Altera Corporation - University Program
May 2012
USING LIBRARY MODULES IN VERILOG DESIGNS For Quartus II 12.0
Figure 11. Files created by the wizard.
10. The box in Figure 12 may pop up. If it does, press Yes to add the newly generated les to the project.
Figure 12. Add the new les to the project.
Altera Corporation - University Program
May 2012
13
USING LIBRARY MODULES IN VERILOG DESIGNS For Quartus II 12.0
5 Augmented Circuit with an LPM
We will use the le megaddsub.v in our modied design. Figure 13 depicts the Verilog code in this le; note that we
have not shown the comments in order to keep the gure small.
// Adder/subtractor module created by the MegaWizard
module megaddsub (
add_sub,
dataa,
datab,
overow,
result);
input add_sub;
input [15:0] dataa;
input [15:0] datab;
output overow;
output [15:0] result;
wire sub_wire0;
wire [15:0] sub_wire1;
wire overow = sub_wire0;
wire [15:0] result = sub_wire1[15:0];
lpm_add_sub lpm_add_sub_component (
.dataa (dataa),
.add_sub (add_sub),
.datab (datab),
.overow (sub_wire0),
.result (sub_wire1));
defparam
lpm_add_sub_component.lpm_direction = "UNUSED",
lpm_add_sub_component.lpm_hint = "ONE_INPUT_IS_CONSTANT=NO,CIN_USED=NO",
lpm_add_sub_component.lpm_representation = "SIGNED",
lpm_add_sub_component.lpm_type = "LPM_ADD_SUB",
lpm_add_sub_component.lpm_width = 16,
endmodule
Figure 13. Verilog code for the ADD_SUB LPM.
The modied Verilog code for the adder/subtractor design is given in Figure 14. Put this code into a le addersub-
tractor2.v under the directory tutorial_lpm. For convenience, this le is provided in the design_les subdirectory
14 Altera Corporation - University Program
May 2012
USING LIBRARY MODULES IN VERILOG DESIGNS For Quartus II 12.0
within the tutorials folder, which is included on the CD-ROM that accompanies the DE-series board and can also be
found on Alteras DE-series web pages. The differences between this code and Figure 2 are:
The assign statements that dene the over_ow signal and the XOR gates (along with the signal dened as
wire H) are no longer needed.
The adderk instance of the adder circuit is replaced by megaddsub. Note that the dataa and datab inputs shown
in Figure 6 are driven by the G and Breg vectors, respectively. Also, the inverted version of the AddSubR signal
is specied to conform with the usage of this control signal in the LPM.
The adderk module is deleted from the code.
// Top-level module
module addersubtractor2 (A, B, Clock, Reset, Sel, AddSub, Z, Overow);
parameter n = 16;
input [n1:0] A, B;
input Clock, Reset, Sel, AddSub;
output [n1:0] Z;
output Overow;
reg SelR, AddSubR, Overow;
reg [n1:0] Areg, Breg, Zreg;
wire [n1:0] G, M, Z;
wire over_ow;
// Dene combinational logic circuit
mux2to1 multiplexer (Areg, Z, SelR, G);
defparam multiplexer.k = n;
megaddsub nbit_adder (AddSubR, G, Breg, M, over_ow);
assign Z = Zreg;
// Dene ip-ops and registers
always @(posedge Reset or posedge Clock)
begin
... continued in Part b
Figure 14. Verilog code for the circuit in Figure 3 (Part a)
Altera Corporation - University Program
May 2012
15
USING LIBRARY MODULES IN VERILOG DESIGNS For Quartus II 12.0
if (Reset == 1)
begin
Areg <= 0; Breg <= 0; Zreg <= 0;
SelR <= 0; AddSubR <= 0; Overow <= 0;
end
else
begin
Areg <= A; Breg <= B; Zreg <= M;
SelR <= Sel; AddSubR <= AddSub; Overow <= over_ow;
end
end
endmodule
// k-bit 2-to-1 multiplexer
module mux2to1 (V, W, Selm, F);
parameter k = 8;
input [k1:0] V, W;
input Selm;
output [k1:0] F;
reg [k1:0] F;
always @(V or W or Selm)
if (Selm == 0)
F = V;
else
F = W;
endmodule
Figure 14. Verilog code for the circuit in Figure 3 (Part b).
If the megaddsub.v le has not been included in the project (e.g. if you answered No in the box in Figure 12, or
possibly if the box did not show up at all), you need to include it manually. To include the megaddsub.v le in the
project, select Project > Add/Remove Files in Project to reach the window in Figure 15. The le addersubtrac-
tor2.v should already be listed as being included in the project. Browse for the other les by clicking the button
File name: ... to reach the window in Figure 16. Select the le megaddsub.v and click Open, which returns to the
window in Figure 15. Click Add to include the le and then click OK. Now, the modied design can be compiled
and simulated in the usual way.
16 Altera Corporation - University Program
May 2012
USING LIBRARY MODULES IN VERILOG DESIGNS For Quartus II 12.0
Figure 15. Inclusion of the new le in the project.
Altera Corporation - University Program
May 2012
17
USING LIBRARY MODULES IN VERILOG DESIGNS For Quartus II 12.0
Figure 16. Specify the megaddsub.v le.
6 Results for the Augmented Design
Compile the design and look at the summary, which is depicted in Figure 17. Observe that the modied design is
implemented with a similar number of logic elements compared to using the code in Figure 2.
18 Altera Corporation - University Program
May 2012
USING LIBRARY MODULES IN VERILOG DESIGNS For Quartus II 12.0
Figure 17. Compilation Results for the Augmented Circuit.
Altera Corporation - University Program
May 2012
19
USING LIBRARY MODULES IN VERILOG DESIGNS For Quartus II 12.0
Copyright 1991-2012 Altera Corporation. All rights reserved. Altera, The Programmable Solutions Company, the
stylized Altera logo, specic device designations, and all other words and logos that are identied as trademarks
and/or service marks are, unless noted otherwise, the trademarks and service marks of Altera Corporation in the
U.S. and other countries. All other product or service names are the property of their respective holders. Altera
products are protected under numerous U.S. and foreign patents and pending applications, mask work rights, and
copyrights. Altera warrants performance of its semiconductor products to current specications in accordance with
Alteras standard warranty, but reserves the right to make changes to any products and services at any time without
notice. Altera assumes no responsibility or liability arising out of the application or use of any information, product,
or service described herein except as expressly agreed to in writing by Altera Corporation. Altera customers are
advised to obtain the latest version of device specications before relying on any published information and before
placing orders for products or services.
This document is being provided on an as-is basis and as an accommodation and therefore all warranties, repre-
sentations or guarantees of any kind (whether express, implied or statutory) including, without limitation, warranties
of merchantability, non-infringement, or tness for a particular purpose, are specically disclaimed.
20 Altera Corporation - University Program
May 2012