Entity Rules ------------ entity_001 ########## This rule checks the indent of the **entity** keyword. **Violation** .. code-block:: vhdl library ieee; entity FIFO is **Fix** .. code-block:: vhdl library ieee; entity FIFO is entity_002 ########## This rule checks for a single space after the **entity** keyword. **Violation** .. code-block:: vhdl entity FIFO is **Fix** .. code-block:: vhdl entity FIFO is entity_003 ########## This rule checks for a blank line above the entity keyword. **Violation** .. code-block:: vhdl library ieee; entity FIFO is **Fix** .. code-block:: vhdl library ieee; entity FIFO is entity_004 ########## This rule checks the **entity** keyword has proper case. .. NOTE:: The default is lowercase. Refer to the section `Configuring Uppercase and Lowercase Rules `_ for information on changing the default case. **Violation** .. code-block:: vhdl ENTITY FIFO is **Fix** .. code-block:: vhdl entity FIFO is entity_005 ########## This rule checks the **is** keyword is on the same line as the **entity** keyword. **Violation** .. code-block:: vhdl entity FIFO entity FIFO is **Fix** .. code-block:: vhdl entity FIFO is entity FIFO is entity_006 ########## This rule checks the **is** keyword has proper case in the entity declaration. .. NOTE:: The default is lowercase. Refer to the section `Configuring Uppercase and Lowercase Rules `_ for information on changing the default case. **Violation** .. code-block:: vhdl entity FIFO IS **Fix** .. code-block:: vhdl entity FIFO is entity_007 ########## This rule checks for a single space before the **is** keyword. **Violation** .. code-block:: vhdl entity FIFO is **Fix** .. code-block:: vhdl entity FIFO is entity_008 ########## This rule checks the entity name has proper case in the entity declaration. .. NOTE:: The default is uppercase. Refer to the section `Configuring Uppercase and Lowercase Rules `_ for information on changing the default case. **Violation** .. code-block:: vhdl entity fifo is **Fix** .. code-block:: vhdl entity FIFO is entity_009 ########## This rule checks the indent of the **end** keyword. **Violation** .. code-block:: vhdl WR_EN : in std_logic; RD_EN : in std_logic ); end entity FIFO; **Fix** .. code-block:: vhdl WR_EN : in std_logic; RD_EN : in std_logic ); end entity FIFO; entity_010 ########## This rule checks the **end** keyword has proper case. .. NOTE:: The default is lowercase. Refer to the section `Configuring Uppercase and Lowercase Rules `_ for information on changing the default case. **Violation** .. code-block:: vhdl END entity FIFO; **Fix** .. code-block:: vhdl end entity FIFO; entity_011 ########## This rule checks for a single space after the **end** keyword. **Violation** .. code-block:: vhdl end entity FIFO; **Fix** .. code-block:: vhdl end entity FIFO; entity_012 ########## This rule checks the case of the entity name in the **end entity** statement. .. NOTE:: The default is uppercase. Refer to the section `Configuring Uppercase and Lowercase Rules `_ for information on changing the default case. **Violation** .. code-block:: vhdl end entity fifo; **Fix** .. code-block:: vhdl end entity FIFO; entity_013 ########## This rule checks for a single space after the **entity** keyword in the closing of the entity declaration. **Violation** .. code-block:: vhdl end entity FIFO; **Fix** .. code-block:: vhdl end entity FIFO; entity_014 ########## This rule checks the **entity** keyword has proper case in the closing of the entity declaration. .. NOTE:: The default is lowercase. Refer to the section `Configuring Uppercase and Lowercase Rules `_ for information on changing the default case. **Violation** .. code-block:: vhdl end ENTITY FIFO; **Fix** .. code-block:: vhdl end entity FIFO; entity_015 ########## This rule checks for the keyword **entity** in the **end entity** statement. **Violation** .. code-block:: vhdl end FIFO; end; **Fix** .. code-block:: vhdl end entity FIFO; end entity; entity_016 ########## This rule checks for blank lines above the **end entity** keywords. **Violation** .. code-block:: vhdl WR_EN : in std_logic; RD_EN : in std_logic ); end entity FIFO; **Fix** .. code-block:: vhdl WR_EN : in std_logic; RD_EN : in std_logic ); end entity FIFO; entity_017 ########## This rule checks the alignment of the **:** for each generic and port in the entity declaration. Following extra configurations are supported: * :code:`separate_generic_port_alignment`. Refer to the section `Configuring Keyword Alignment Rules `_ for information on changing the configurations. **Violation** .. code-block:: vhdl 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** .. code-block:: vhdl 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 ########## This rule checks the alignment of **:=** operator for each generic and port in the entity declaration. Following extra configurations are supported: * :code:`separate_generic_port_alignment`. Refer to the section `Configuring Keyword Alignment Rules `_ for information on changing the configurations. **Violation** .. code-block:: vhdl 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** .. code-block:: vhdl 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 ########## This rule checks for the entity name in the **end entity** statement. **Violation** .. code-block:: vhdl end entity; **Fix** .. code-block:: vhdl end entity ENTITY_NAME; entity_020 ########## This rule checks for alignment of inline comments in the entity declaration. Following extra configurations are supported: * :code:`separate_generic_port_alignment`. Refer to the section `Configuring Keyword Alignment Rules `_ for information on changing the configurations. **Violation** .. code-block:: vhdl 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** .. code-block:: vhdl 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 );