entity_rules.rst

Entity Rules

entity_001

|phase_4| |error| |indent|

This rule checks the indent of the entity keyword.

Violation

library ieee;

  entity fifo is

Fix

library ieee;

entity fifo is

entity_002

|phase_2| |error| |whitespace|

This rule checks for a single space after the entity keyword.

|configuring_whitespace_rules_link|

Violation

entity    fifo is

Fix

entity fifo is

entity_003

|phase_3| |error| |blank_line|

This rule checks for blank lines or comments above the entity keyword.

|configuring_previous_line_rules_link|

Violation

library ieee;
entity fifo is

Fix

library ieee;

entity fifo is

entity_004

|phase_6| |error| |case| |case_keyword|

This rule checks the entity keyword has proper case.

|configuring_uppercase_and_lowercase_rules_link|

Violation

ENTITY fifo is

Fix

entity fifo is

entity_005

|phase_1| |error| |structure|

This rule checks the is keyword is on the same line as the entity keyword.

Violation

entity fifo

entity fifo
  is

Fix

entity fifo is

entity fifo is

entity_006

|phase_6| |error| |case| |case_keyword|

This rule checks the is keyword has proper case in the entity declaration.

|configuring_uppercase_and_lowercase_rules_link|

Violation

entity fifo IS

Fix

entity fifo is

entity_007

|phase_2| |error| |whitespace|

This rule checks for a single space before the is keyword.

|configuring_whitespace_rules_link|

Violation

entity fifo    is

Fix

entity fifo is

entity_008

|phase_6| |error| |case| |case_name|

This rule checks the entity name has proper case in the entity declaration.

|configuring_uppercase_and_lowercase_rules_link|

Violation

entity Fifo is

Fix

entity fifo is

entity_009

|phase_4| |error| |indent|

This rule checks the indent of the end keyword.

Violation

  wr_en : in    std_logic;
  rd_en : in    std_logic
);
  end entity fifo;

Fix

    wr_en : in    std_logic;
    rd_en : in    std_logic
  );
end entity fifo;

entity_010

|phase_6| |error| |case| |case_keyword|

This rule checks the end keyword has proper case.

|configuring_uppercase_and_lowercase_rules_link|

Violation

END entity fifo;

Fix

end entity fifo;

entity_011

|phase_2| |error| |whitespace|

This rule checks for a single space after the end keyword.

|configuring_whitespace_rules_link|

Violation

end    entity fifo;

Fix

end entity fifo;

entity_012

|phase_6| |error| |case| |case_name|

This rule checks the case of the entity name in the end entity statement.

|configuring_uppercase_and_lowercase_rules_link|

Violation

end entity FIFO;

Fix

end entity fifo;

entity_013

|phase_2| |error| |whitespace|

This rule checks for a single space after the entity keyword in the closing of the entity declaration.

|configuring_whitespace_rules_link|

Violation

end entity    fifo;

Fix

end entity fifo;

entity_014

|phase_6| |error| |case| |case_keyword|

This rule checks the entity keyword has proper case in the closing of the entity declaration.

|configuring_uppercase_and_lowercase_rules_link|

Violation

end ENTITY fifo;

Fix

end entity fifo;

entity_015

|phase_1| |error| |structure| |structure_optional|

This rule checks for the keyword entity in the end entity statement.

|configuring_optional_items_link|

Violation

end fifo;

end;

Fix

end entity fifo;

end entity;

entity_016

|phase_3| |error| |blank_line|

This rule checks for blank lines above the end entity keywords.

|configuring_blank_lines_link|

Violation

    wr_en : in    std_logic;
    rd_en : in    std_logic
  );


end entity fifo;

Fix

    wr_en : in    std_logic;
    rd_en : in    std_logic
  );
end entity fifo;

entity_017

|phase_5| |error| |alignment|

This rule checks the alignment of the colon for each generic and port in the entity declaration.

Following extra configurations are supported:

• separate_generic_port_alignment.

|configuring_keyword_alignment_rules_link|

Violation

generic (
    g_width : positive;
    g_output_delay : positive
);
port (
    clk_i : in std_logic;
    data_i : in std_logic;
    data_o : in std_logic
);

Fix

generic (
    g_width        : positive;
    g_output_delay : positive
);
port (
    clk_i  : in std_logic;
    data_i : in std_logic;
    data_o : in std_logic
);

entity_018

|phase_5| |error| |alignment|

This rule checks the alignment of := operator for each generic and port in the entity declaration.

Following extra configurations are supported:

• separate_generic_port_alignment.

|configuring_keyword_alignment_rules_link|

Violation

generic (
    g_width        : positive := 8;
    g_output_delay : positive      := 5
);
port (
    clk_i   : in std_logic;
    data1_i : in std_logic  := 'X';
    data2_i : in std_logic      := 'X';
    data_o  : in std_logic
);

Fix

generic (
    g_width        : positive := 8;
    g_output_delay : positive := 5
);
port (
    clk_i   : in std_logic;
    data1_i : in std_logic := 'X';
    data2_i : in std_logic := 'X';
    data_o  : in std_logic
);

entity_019

|phase_1| |error| |structure| |structure_optional|

This rule checks for the entity name in the end entity statement.

|configuring_optional_items_link|

Violation

end entity;

Fix

end entity entity_name;

entity_020

|phase_5| |error| |alignment|

This rule checks for alignment of inline comments in the entity declaration.

Following extra configurations are supported:

• separate_generic_port_alignment.

|configuring_keyword_alignment_rules_link|

Violation

generic (
    g_width        : positive;  -- Data width
    g_output_delay : positive -- Delay at output
);
port (
    clk_i  : in std_logic; -- Input clock
    data_i : in std_logic;   -- Data input
    data_o : in std_logic -- Data output
);

Fix

generic (
    g_width        : positive; -- Data width
    g_output_delay : positive  -- Delay at output
);
port (
    clk_i  : in std_logic; -- Input clock
    data_i : in std_logic; -- Data input
    data_o : in std_logic  -- Data output
);

entity_021

|phase_1| |error| |structure|

This rule checks the end keyword is on its own line.

Violation

port (
   ...
); end entity;

Fix

port (
   ...
);
end entity;

entity_022

|phase_1| |error| |structure|

This rule checks the identifier is on the same line as the entity keyword.

Violation

entity fifo is

entity
  fifo is

Fix

entity fifo is

entity fifo is

entity_023

|phase_1| |error| |structure|

This rule checks the end entity keyword is on the same line as the end keyword.

Violation

end entity;

end
  entity;

Fix

end entity;

end entity;

entity_024

|phase_1| |error| |structure|

This rule checks the end entity simple name is not on its own line.

Violation

end entity FIFO;

end entity
  FIFO;

Fix

end entity FIFO;

end entity FIFO;

entity_025

|phase_1| |error| |structure|

This rule checks the semicolon is not on its own line.

Violation

end entity;

end entity
;

Fix

end entity;

end entity;

entity_026

|phase_1| |error| |structure|

This rule checks for code after the is keyword.

Violation

entity FIFO is port (

Fix

entity FIFO is
  port (

entity_027

|phase_1| |error| |structure|

This rule checks for code after the begin keyword.

Violation

begin end entity;

Fix

begin
end entity;

entity_028

|phase_1| |error| |structure|

This rule checks for code after the semicolon.

Violation

end entity; architecture

Fix

end entity;
architecture

entity_029

|phase_1| |error| |structure|

This rule checks the begin keyword is on its own line.

Violation

entity FIFO is
  port (
    I_INPUT : in std_logic
  ); begin
end entity;

Fix

entity FIFO is
  port (
    I_INPUT : in std_logic
  );
begin
end entity;

entity_200

|phase_3| |error| |blank_line|

This rule checks for blank lines above the generic keyword in entity specifications.

|configuring_blank_lines_link|

Violation

entity fifo is



  generic (

Fix

entity fifo is
  generic (

entity_201

|phase_3| |error| |blank_line|

This rule ensures no blank lines after the is keyword.

Violation

entity fifo is


  port (

Fix

entity fifo is
  port (

entity_202

|phase_3| |error| |blank_line|

This rule checks for blank lines above the port keyword in entity specifications.

|configuring_blank_lines_link|

Violation

entity fifo is



  port (

Fix

entity fifo is
  port (

entity_203

|phase_3| |error| |blank_line|

This rule checks for blank lines below the semicolon in entity specifications.

|configuring_blank_lines_link|

Violation

end entity;
library ieee;

Fix

end entity;

library ieee;

entity_300

|phase_4| |error| |indent|

This rule checks the indent of the begin keyword.

Violation

entity FIFO is

     begin

Fix

entity FIFO is

begin

entity_500

|phase_6| |error| |case| |case_keyword|

This rule checks the begin keyword has proper case.

|configuring_uppercase_and_lowercase_rules_link|

Violation

entity fifo is

BEGIN

end entity;

Fix

entity fifo is

begin

end entity;

entity_600

|phase_6| |error| |case|

This rule checks for consistent capitalization of generic names in entity declarations.

Violation

entity FIFO is
  generic (
    G_WIDTH : natural := 16
  );
  port (
    I_DATA : std_logic_vector(g_width - 1 downto 0);
    O_DATA : std_logic_vector(g_width - 1 downto 0)
  );
end entity fifo;

Fix

entity FIFO is
  generic (
    G_WIDTH : natural := 16
  );
  port (
    I_DATA : std_logic_vector(G_WIDTH - 1 downto 0);
    O_DATA : std_logic_vector(G_WIDTH - 1 downto 0)
  );
end entity fifo;