550 lines
10 KiB
ReStructuredText
550 lines
10 KiB
ReStructuredText
.. include:: icons.rst
|
|
|
|
Procedure Rules
|
|
---------------
|
|
|
|
There are three forms a procedure: with parameters, without parameters, and a package declaration:
|
|
|
|
**with parameters**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
procedure average_samples (
|
|
constant a : in integer;
|
|
signal b : in std_logic;
|
|
variable c : in std_logic_vector(3 downto 0);
|
|
signal d : out std_logic) is
|
|
begin
|
|
end procedure average_samples;
|
|
|
|
**without parameters**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
procedure average_samples is
|
|
begin
|
|
end procedure average_samples;
|
|
|
|
**package declaration**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
procedure average_samples;
|
|
|
|
procedure average_samples (
|
|
constant a : in integer;
|
|
signal b : in std_logic;
|
|
variable c : in std_logic_vector(3 downto 0);
|
|
signal d : out std_logic);
|
|
|
|
procedure_001
|
|
#############
|
|
|
|
|phase_4| |error|
|
|
|
|
This rule checks the indent of the **procedure** keyword.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
procedure average_samples (
|
|
constant a : in integer;
|
|
signal b : in std_logic;
|
|
variable c : in std_logic_vector(3 downto 0);
|
|
signal d : out std_logic ) is
|
|
begin
|
|
end procedure average_samples;
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
procedure average_samples (
|
|
constant a : in integer;
|
|
signal b : in std_logic;
|
|
variable c : in std_logic_vector(3 downto 0);
|
|
signal d : out std_logic ) is
|
|
begin
|
|
end procedure average_samples;
|
|
|
|
procedure_002
|
|
#############
|
|
|
|
|phase_4| |error|
|
|
|
|
This rule checks the indent of the **begin** keyword.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
procedure average_samples (
|
|
constant a : in integer;
|
|
signal b : in std_logic;
|
|
variable c : in std_logic_vector(3 downto 0);
|
|
signal d : out std_logic ) is
|
|
begin
|
|
end procedure average_samples;
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
procedure average_samples (
|
|
constant a : in integer;
|
|
signal b : in std_logic;
|
|
variable c : in std_logic_vector(3 downto 0);
|
|
signal d : out std_logic ) is
|
|
begin
|
|
end procedure average_samples;
|
|
|
|
procedure_003
|
|
#############
|
|
|
|
|phase_4| |error|
|
|
|
|
This rule checks the indent of the **end** keyword.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
procedure average_samples (
|
|
constant a : in integer;
|
|
signal b : in std_logic;
|
|
variable c : in std_logic_vector(3 downto 0);
|
|
signal d : out std_logic ) is
|
|
begin
|
|
end procedure average_samples;
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
procedure average_samples (
|
|
constant a : in integer;
|
|
signal b : in std_logic;
|
|
variable c : in std_logic_vector(3 downto 0);
|
|
signal d : out std_logic ) is
|
|
begin
|
|
end procedure average_samples;
|
|
|
|
procedure_004
|
|
#############
|
|
|
|
|phase_4| |error|
|
|
|
|
This rule checks the indent of parameters.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
procedure average_samples (
|
|
constant a : in integer;
|
|
signal b : in std_logic;
|
|
variable c : in std_logic_vector(3 downto 0);
|
|
signal d : out std_logic ) is
|
|
begin
|
|
end procedure average_samples;
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
procedure average_samples (
|
|
constant a : in integer;
|
|
signal b : in std_logic;
|
|
variable c : in std_logic_vector(3 downto 0);
|
|
signal d : out std_logic ) is
|
|
begin
|
|
end procedure average_samples;
|
|
|
|
procedure_005
|
|
#############
|
|
|
|
|phase_4| |error|
|
|
|
|
This rule checks the indent of line between the **is** and **begin** keywords
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
procedure average_samples (
|
|
constant a : in integer;
|
|
signal d : out std_logic ) is
|
|
variable var_1 : integer;
|
|
variable var_1 : integer;
|
|
begin
|
|
end procedure average_samples;
|
|
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
procedure average_samples (
|
|
constant a : in integer;
|
|
signal b : in std_logic;
|
|
variable c : in std_logic_vector(3 downto 0);
|
|
signal d : out std_logic ) is
|
|
variable var_1 : integer;
|
|
variable var_1 : integer;
|
|
begin
|
|
end procedure average_samples;
|
|
|
|
procedure_006
|
|
#############
|
|
|
|
|phase_4| |error|
|
|
|
|
This rule checks the indent of the closing parenthesis if it is on it's own line.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
procedure average_samples (
|
|
constant a : in integer;
|
|
signal d : out std_logic
|
|
) is
|
|
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
procedure average_samples (
|
|
constant a : in integer;
|
|
signal d : out std_logic
|
|
) is
|
|
|
|
procedure_007
|
|
#############
|
|
|
|
|phase_6| |error|
|
|
|
|
This rule checks for consistent capitalization of procedure names.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
architecture rtl of entity1 is
|
|
|
|
procedure average_samples (
|
|
constant a : in integer;
|
|
signal d : out std_logic
|
|
) is
|
|
|
|
begin
|
|
|
|
proc1 : process () is
|
|
begin
|
|
|
|
Average_samples();
|
|
|
|
end process proc1;
|
|
|
|
end architecture rtl;
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
architecture rtl of entity1 is
|
|
|
|
procedure average_samples (
|
|
constant a : in integer;
|
|
signal d : out std_logic
|
|
) is
|
|
|
|
begin
|
|
|
|
proc1 : process () is
|
|
begin
|
|
|
|
average_samples();
|
|
|
|
end process proc1;
|
|
|
|
end architecture RTL;
|
|
|
|
procedure_008
|
|
#############
|
|
|
|
|phase_6| |error|
|
|
|
|
This rule checks the **end** keyword has proper case.
|
|
|
|
Refer to the section `Configuring Uppercase and Lowercase Rules <configuring.html#configuring-uppercase-and-lowercase-rules>`_ for information on changing the default case.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
END;
|
|
|
|
End procedure proc;
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
end;
|
|
|
|
end procedure proc;
|
|
|
|
procedure_009
|
|
#############
|
|
|
|
|phase_6| |error|
|
|
|
|
This rule checks the **procedure** keyword in the **end procedure** has proper case.
|
|
|
|
Refer to the section `Configuring Uppercase and Lowercase Rules <configuring.html#configuring-uppercase-and-lowercase-rules>`_ for information on changing the default case.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
end PROCEDURE;
|
|
|
|
end Procedure proc;
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
end procedure;
|
|
|
|
end procedure proc;
|
|
|
|
procedure_010
|
|
#############
|
|
|
|
|phase_5| |error|
|
|
|
|
This rule checks the identifiers for all declarations are aligned in the procedure declarative part.
|
|
|
|
Refer to the section `Configuring Identifier Alignment Rules <configuring.html#configuring-identifier-alignment-rules>`_ for information on changing the configurations.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
variable var1 : natural;
|
|
signal sig1 : natural;
|
|
constant c_period : time;
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
variable var1 : natural;
|
|
signal sig1 : natural;
|
|
constant c_period : time;
|
|
|
|
procedure_100
|
|
#############
|
|
|
|
|phase_2| |error|
|
|
|
|
This rule checks for a single space between the following procedure elements: **procedure** keyword, procedure designator, open parenthesis, close parenthesis, and **is** keywords.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
procedure average_samples (
|
|
constant a : in integer;
|
|
signal d : out std_logic
|
|
) is
|
|
procedure average_samples is
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
procedure average_samples (
|
|
constant a : in integer;
|
|
signal d : out std_logic
|
|
) is
|
|
procedure average_samples is
|
|
|
|
procedure_101
|
|
#############
|
|
|
|
|phase_2| |error|
|
|
|
|
This rule checks for a single space between the **end** and **procedure** keywords and procedure designator.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
end procedure average_samples;
|
|
end procedure;
|
|
end average_samples;
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
end procedure average_samples;
|
|
end procedure;
|
|
end average_samples;
|
|
|
|
procedure_500
|
|
#############
|
|
|
|
|phase_6| |error|
|
|
|
|
This rule checks the **procedure** keyword has proper case.
|
|
|
|
Refer to the section `Configuring Uppercase and Lowercase Rules <configuring.html#configuring-uppercase-and-lowercase-rules>`_ for information on changing the default case.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
PROCEDURE average_samples is
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
procedure average_samples is
|
|
|
|
procedure_501
|
|
#############
|
|
|
|
|phase_6| |error|
|
|
|
|
This rule checks the procedure designator has proper case.
|
|
|
|
Refer to the section `Configuring Uppercase and Lowercase Rules <configuring.html#configuring-uppercase-and-lowercase-rules>`_ for information on changing the default case.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
procedure AVERAGE_SAMPLES is
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
procedure average_samples is
|
|
|
|
procedure_502
|
|
#############
|
|
|
|
|phase_6| |error|
|
|
|
|
This rule checks the **is** keyword has proper case.
|
|
|
|
Refer to the section `Configuring Uppercase and Lowercase Rules <configuring.html#configuring-uppercase-and-lowercase-rules>`_ for information on changing the default case.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
procedure average_samples IS
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
procedure average_samples is
|
|
|
|
procedure_503
|
|
#############
|
|
|
|
|phase_6| |error|
|
|
|
|
This rule checks the **begin** keyword has proper case.
|
|
|
|
Refer to the section `Configuring Uppercase and Lowercase Rules <configuring.html#configuring-uppercase-and-lowercase-rules>`_ for information on changing the default case.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
procedure average_samples is
|
|
BEGIN
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
procedure average_samples is
|
|
begin
|
|
|
|
procedure_504
|
|
#############
|
|
|
|
|phase_6| |error|
|
|
|
|
This rule checks the **end** keyword has proper case.
|
|
|
|
Refer to the section `Configuring Uppercase and Lowercase Rules <configuring.html#configuring-uppercase-and-lowercase-rules>`_ for information on changing the default case.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
END procedure average_samples;
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
end procedure average_samples;
|
|
|
|
procedure_505
|
|
#############
|
|
|
|
|phase_6| |error|
|
|
|
|
This rule checks the **procedure** keyword in the **end procedure** has proper case.
|
|
|
|
Refer to the section `Configuring Uppercase and Lowercase Rules <configuring.html#configuring-uppercase-and-lowercase-rules>`_ for information on changing the default case.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
end PROCEDURE average_samples;
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
end procedure average_samples;
|
|
|
|
procedure_506
|
|
#############
|
|
|
|
|phase_6| |error|
|
|
|
|
This rule checks the procedure designator has proper case on the end procedure declaration.
|
|
|
|
Refer to the section `Configuring Uppercase and Lowercase Rules <configuring.html#configuring-uppercase-and-lowercase-rules>`_ for information on changing the default case.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
end procedure AVERAGE_SAMPLES;
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
end procedure average_samples;
|
|
|
|
|