Package declaration and body in VHDL - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of a package declaration in VHDL?

A package declaration defines the interface of a package. It declares types, constants, signals, and subprograms that can be shared and used by multiple design units.

beginner

What does the package body contain in VHDL?

The package body contains the implementation of subprograms (procedures and functions) declared in the package declaration. It provides the actual code behind the interface.

intermediate

Can a package declaration exist without a package body in VHDL?

Yes, if the package only declares constants, types, or signals without subprograms, a package body is not required.

beginner

How do you use a package in a VHDL design unit?

You use the use clause to make the package's contents visible, for example: use work.my_package.all;.

intermediate

Why is it good practice to separate package declaration and body in VHDL?

Separating declaration and body improves code organization, allows multiple units to share interfaces, and hides implementation details inside the body.

What does a VHDL package declaration NOT contain?

A Subprogram implementations

B Type declarations

C Constant declarations

D Signal declarations

Package declarations declare subprograms but do not contain their implementations; implementations go in the package body.

Where do you write the code for a function declared in a VHDL package?

A In the package declaration

B In the package body

C In the architecture

D In the entity

The function's code is written in the package body, which implements the subprograms declared in the package declaration.

Which statement is true about VHDL packages?

A Packages cannot contain constants

B Package bodies are always mandatory

C Package declarations can include subprogram declarations

D Packages replace entities

Package declarations can include declarations of subprograms, constants, types, and signals.

How do you make a package's contents available in a VHDL design unit?

A By copying the package code into the design unit

B By compiling the package separately

C By declaring the package inside the design unit

D By using the <code>use</code> clause

The use clause imports the package's contents so they can be referenced in the design unit.

If a package only declares types and constants, what is true?

A A package body is optional

B A package body is required

C The package cannot be used

D The package must include subprograms

If no subprograms are declared, the package body is optional.

Explain the difference between a package declaration and a package body in VHDL.

Think about what you see versus what you do behind the scenes.

Describe how you would share a set of types and functions across multiple VHDL design units using packages.

Consider how to organize reusable code.

Practice

1. What is the main purpose of a package declaration in VHDL?

easy

A. To define the entity and architecture of a design

B. To list constants, types, and function headers available for reuse

C. To implement the internal logic of functions

D. To simulate the behavior of a circuit

Solution

1. Step 1: Understand the role of package declaration

   The package declaration specifies what items (constants, types, function headers) are available to other parts of the design.

2. Step 2: Differentiate from package body

   The package body contains the actual implementation of functions, not the declaration.

3. Final Answer:

   To list constants, types, and function headers available for reuse -> Option B

4. Quick Check:

   Package declaration = lists available items [OK]

Hint: Declaration lists items; body defines them [OK]

Common Mistakes:

• Confusing package declaration with package body
• Thinking package declaration implements functions
• Mixing entity/architecture with packages

2. Which of the following is the correct syntax to start a package declaration named MyPackage in VHDL?

easy

A. package MyPackage is

B. package body MyPackage is

C. entity MyPackage is

D. architecture MyPackage of package is

Solution

1. Step 1: Identify package declaration syntax

   The correct syntax to declare a package is package PackageName is.

2. Step 2: Eliminate other options

   package body is for the package body, entity and architecture are unrelated to package declaration.

3. Final Answer:

   package MyPackage is -> Option A

4. Quick Check:

   Package declaration starts with 'package Name is' [OK]

Hint: Package declaration starts with 'package Name is' [OK]

Common Mistakes:

• Using 'package body' instead of 'package' for declaration
• Confusing entity/architecture keywords with package
• Incorrect order of keywords

3. Given the following package declaration and body, what will be the output of TestFunc(3)?

package MathPkg is
  function TestFunc(x : integer) return integer;
end package MathPkg;

package body MathPkg is
  function TestFunc(x : integer) return integer is
  begin
    return x * x;
  end TestFunc;
end package body MathPkg;

medium

A. Compilation error

B. 3

C. 6

D. 9

Solution

1. Step 1: Understand function implementation in package body

   The function TestFunc returns the square of the input x (x * x).

2. Step 2: Calculate output for input 3

   Input 3 squared is 3 * 3 = 9.

3. Final Answer:

   9 -> Option D

4. Quick Check:

   3 squared = 9 [OK]

Hint: Function returns x squared; input 3 -> 9 [OK]

Common Mistakes:

• Confusing declaration with implementation
• Assuming function returns input unchanged
• Thinking package body is optional for function

4. Identify the error in the following VHDL package code:

package Utils is
  function Add(a : integer; b : integer) return integer;
end package Utils;

package body Utils is
  function Add(a : integer; b : integer) return integer is
  begin
    return a + b
  end Add;
end package body Utils;

medium

A. Missing semicolon after return statement in function body

B. Package declaration missing 'body' keyword

C. Function parameters must be declared in package body only

D. Package body cannot contain function implementations

Solution

1. Step 1: Check function body syntax

   The return statement return a + b is missing a semicolon at the end.

2. Step 2: Verify other parts

   Package declaration and body keywords are correct; parameters are correctly declared in both places; package body can contain function implementations.

3. Final Answer:

   Missing semicolon after return statement in function body -> Option A

4. Quick Check:

   Statements need semicolons in VHDL [OK]

Hint: Check semicolons after statements in function body [OK]

Common Mistakes:

• Omitting semicolon after return statement
• Confusing package declaration with package body syntax
• Thinking function parameters only go in body

5. You want to create a package that shares a constant array and a function that returns the sum of its elements. Which of the following correctly shows the package declaration and body structure?

hard

A. package DataPkg is
constant Arr : integer_array := (1, 2, 3);
function SumArray return integer;
end package DataPkg;

package body DataPkg is
function SumArray return integer is
begin
return 6;
end SumArray;
end package body DataPkg;

B. package body DataPkg is
constant Arr : integer_array := (1, 2, 3);
function SumArray(a : integer_array) return integer;
end package body DataPkg;

package DataPkg is
function SumArray(a : integer_array) return integer is
begin
return 0;
end SumArray;
end package DataPkg;

C. package DataPkg is
constant Arr : integer_array := (1, 2, 3);
function SumArray(a : integer_array) return integer;
end package DataPkg;

package body DataPkg is
function SumArray(a : integer_array) return integer is
variable total : integer := 0;
begin
for i in a'range loop
total := total + a(i);
end loop;
return total;
end SumArray;
end package body DataPkg;

D. package DataPkg is
constant Arr : integer_array := (1, 2, 3);
function SumArray(a : integer_array) return integer;
end package DataPkg;

package body DataPkg is
function SumArray(a : integer_array) return integer is
begin
return a(1) + a(2);
end SumArray;
end package body DataPkg;

Solution

1. Step 1: Package declaration

   The declaration must contain the constant array definition constant Arr : integer_array := (1, 2, 3); and the function prototype function SumArray(a : integer_array) return integer;. This allows reuse across designs.

2. Step 2: Package body

   The body implements the function with a loop to sum all elements: variable total : integer := 0; for i in a'range loop total := total + a(i); end loop; return total;. Distractors lack proper structure, parameters, or dynamic summation.

3. Final Answer:

   Correct structure: constant and prototype in declaration, dynamic sum loop in body -> Option C

4. Quick Check:

   Declaration lists; body defines function logic [OK]

Hint: Declaration lists constants and function headers; body implements functions [OK]

Common Mistakes:

• Swapping package and package body order
• Omitting function parameters in declaration
• Incorrect function implementation missing loop or summation