Package declaration and body in VHDL - Step-by-Step Execution

Concept Flow - Package declaration and body

Start

↓

Declare Package

↓

Declare Types, Constants, Subprograms

↓

End Package Declaration

↓

Define Package Body

↓

Implement Subprograms

↓

End Package Body

↓

Use Package in Design

↓

End

First, you declare the package with types and subprograms, then you define the package body with implementations.

Execution Sample

VHDL

package MyPkg is
  function add(a: integer; b: integer) return integer;
end MyPkg;

package body MyPkg is
  function add(a: integer; b: integer) return integer is
  begin
    return a + b;
  end add;
end MyPkg;

This code declares a package with a function prototype and then defines the function in the package body.

Execution Table

Step	Action	Evaluation	Result
1	Start package declaration 'MyPkg'	N/A	Package declared with function prototype
2	Declare function 'add' prototype	N/A	Function signature stored
3	End package declaration	N/A	Package interface ready for use
4	Start package body 'MyPkg'	N/A	Package body begins for implementation
5	Define function 'add' implementation	N/A	Function code ready
6	Function 'add' returns a + b	add(2,3)	5
7	End package body	N/A	Package body complete
8	Use package in design	call add(2,3)	5
9	End	N/A	Execution complete

💡 Package declaration and body complete; function can be used in design.

Variable Tracker

Variable	Start	After 5	After 6	Final
a	N/A	2	2	2
b	N/A	3	3	3
add result	N/A	N/A	5	5

Key Moments - 2 Insights

Why do we need both a package declaration and a package body?

The declaration tells what is available (like a menu), and the body provides the actual code (the recipe). See steps 1-3 for declaration and 4-7 for body.

Can we use the function before the package body is defined?

No, the declaration alone only tells the function exists. The body must be defined to run the function. See step 8 where the function is called after body is complete.

Visual Quiz - 3 Questions

Look at the execution table, at which step is the function 'add' implementation defined?

A Step 5

B Step 2

C Step 3

D Step 8

💡 Hint

Check the 'Action' column for 'Define function' in the execution_table.

According to the variable tracker, what is the value of 'add result' after step 6?

A 2

B 3

C 5

D N/A

💡 Hint

Look at the 'add result' row under 'After 6' column in variable_tracker.

If the package body was missing, what would happen when calling 'add' in step 8?

A Function runs normally

B Compilation error due to missing implementation

C Returns zero by default

D Returns garbage value

💡 Hint

Refer to key_moments about needing both declaration and body for function use.

Concept Snapshot

Package declaration defines interface (types, functions).
Package body implements declared functions.
Declaration and body must match names.
Use package in design after body is complete.
Separates interface from implementation for reuse.

Full Transcript

In VHDL, a package declaration lists what is available, like function prototypes or types. The package body contains the actual code for those functions. First, you declare the package with the function signature. Then you define the function in the package body. You cannot use the function until the body is complete. This separation helps organize code and reuse it easily. The execution table shows each step from declaration to using the function. The variable tracker shows inputs and outputs of the function call. Key moments clarify why both declaration and body are needed. The quiz tests understanding of these steps.

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