style: apply codespell

Signed-off-by: Alon Bar-Lev <alon.barlev@gmail.com>
This commit is contained in:
Alon Bar-Lev 2024-03-16 15:40:10 +02:00
parent 451af45ded
commit f9c2653e54
114 changed files with 160 additions and 149 deletions

8
.codespell-ignore Normal file
View File

@ -0,0 +1,8 @@
dentity
din
dout
elemente
inout
leary
synopsys
toi

View File

@ -56,8 +56,10 @@ repos:
- repo: https://github.com/codespell-project/codespell
rev: v2.2.6
hooks: []
#- id: codespell
hooks:
- id: codespell
args:
- -I.codespell-ignore
- repo: https://github.com/PyCQA/flake8
rev: 7.0.0

View File

@ -1,5 +1,6 @@
exclude setup.cfg
include *.properties
include .codespell-ignore
include .flake8
include .gitattributes
include .gitignore

View File

@ -6,7 +6,7 @@ Attribute Rules
attribute_001
#############
This rule has been superceeded by:
This rule has been superseded by:
* `attribute_declaration_300 <attribute_declaration_rules.html#attribute-declaration-300>`_
* `attribute_specification_300 <attribute_specification_rules.html#attribute-specification-300>`_
@ -14,7 +14,7 @@ This rule has been superceeded by:
attribute_002
#############
This rule has been superceeded by:
This rule has been superseded by:
* `attribute_declaration_500 <attribute_declaration_rules.html#attribute-declaration-500>`_
* `attribute_specification_500 <attribute_specification_rules.html#attribute-specification-500>`_

View File

@ -38,7 +38,7 @@ This rule checks the indent lines starting with comments.
.. code-block:: vhdl
-- Libraries
libary ieee;
library ieee;
-- Define architecture
architecture rtl of fifo is
@ -54,7 +54,7 @@ This rule checks the indent lines starting with comments.
.. code-block:: vhdl
-- Libraries
libary ieee;
library ieee;
-- Define architecture
architecture rtl of fifo is

View File

@ -433,7 +433,7 @@ component_019
|phase_1| |error| |structure|
This rule checks for comments at the end of the port and generic clauses in component declarations.
These comments represent additional maintainence.
These comments represent additional maintenance.
They will be out of sync with the entity at some point.
Refer to the entity for port types, port directions and purpose.

View File

@ -59,7 +59,7 @@ concurrent_003
|phase_5| |error| |alignment|
This rule checks alignment of multiline concurrent simple signal assignments.
Succesive lines should align to the space after the assignment operator.
Successive lines should align to the space after the assignment operator.
However, there is a special case if there are parenthesis in the assignment.
If the parenthesis are not closed on the same line, then the next line will be aligned to the parenthesis.
Aligning to the parenthesis improves readability.

View File

@ -5,7 +5,7 @@ Configuring Indentation
-----------------------
VSG follows a predefined set of rules when indenting VHDL code.
The indenting alogrithm is driven by a YAML file.
The indenting algorithm is driven by a YAML file.
The indent values feeding the algorithm can be obtained by using the **-oc** command line argument.
There will be a section starting with **indent**.

View File

@ -22,7 +22,7 @@ Use the following configuration to change the line length to 180.
length_001 :
length : 180
Overridding File Line Length
Overriding File Line Length
############################
Limiting the length of a VHDL file can improve readability.
@ -37,7 +37,7 @@ Use the following configuration to change the file length to 5000.
length_002 :
length : 5000
Overridding Process Line Length
Overriding Process Line Length
###############################
Limiting the length of a VHDL processes can improve readability.

View File

@ -93,7 +93,7 @@ would result in the following format being enforced:
O_OUTPUT : out std_logic;
IO_INOUT : inout std_logic;
Rules Enforcing Aligment
Rules Enforcing Alignment
########################
* `port_007 <port_rules.html#port-007>`_

View File

@ -5,7 +5,7 @@ Configuring Pragmas
-------------------
Pragmas are comments with meta data used by various vendors.
These pragmas communicate information which can change how vendor tools interprate code.
These pragmas communicate information which can change how vendor tools interpret code.
There does not appear to be a standard for defining pragmas.
This presents a challenge to detecting them across all vendor tools.

View File

@ -7,10 +7,10 @@ Configuring Simple Multiline Structure Rules
:code:`new_line_after_assign`
.. |new_line_after_assign__yes| replace::
:code:`yes` = Adds a carriage return (alias "new line") after the assigment operator.
:code:`yes` = Adds a carriage return (alias "new line") after the assignment operator.
.. |new_line_after_assign__no| replace::
:code:`no` = Removes a carriage return (alias "new line") after the assigment operator.
:code:`no` = Removes a carriage return (alias "new line") after the assignment operator.
.. |new_line_after_assign__ignore| replace::
:code:`ignore` = Ignores any formatting after the assignment operator.

View File

@ -173,7 +173,7 @@ Having a space makes it clearer where the assignment occurs on the line.
constant_011
############
The function of this rule has been superceeded by the following rules:
The function of this rule has been superseded by the following rules:
* ieee_500
* subtype_002

View File

@ -17,7 +17,7 @@ JUnit Report
VSG can generate a report of an analysis in JUnit XML format.
This report will include the filename along with any errors detected.
The rule which was violated, the line number where the violation occured, and the proposed solution are provided.
The rule which was violated, the line number where the violation occurred, and the proposed solution are provided.
This report can be used in most CI server applications to create a test report.
Refer to the documentation of your CI server application for how to integrate the JUnit report.
@ -62,7 +62,7 @@ The following items in the spec are populated.
A relative path to the file with code quality issues.
.. |location_lines_begin| replace::
The line number where the code quality issue occured.
The line number where the code quality issue occurred.
+----------------------+------------------------+
| Code Climate Spec | Description |

View File

@ -104,7 +104,7 @@ This works by taking the current buffer's contents and passing it into the stand
groups = { 'severity', 'row', 'code', 'message' },
overrides = {
severities = {
-- 2 is for warnings, nvim showing as an erorr can be obnoxious. Change if desired
-- 2 is for warnings, nvim showing as an error can be obnoxious. Change if desired
["ERROR"] = 2,
["WARNING"] = 3,
["INFORMATION"] = 3,

View File

@ -78,7 +78,7 @@ Where:
+--------------+---------------------------------------------------------------+
| filename | The file being analyzed. |
+--------------+---------------------------------------------------------------+
| line_number | The line number the violation occured. |
| line_number | The line number the violation occurred. |
+--------------+---------------------------------------------------------------+
| rule | The rule id that detected the violation |
+--------------+---------------------------------------------------------------+

View File

@ -404,7 +404,7 @@ Following extra configurations are supported:
.. code-block:: vhdl
wr_en => write_enable, -- Wrte enable
wr_en => write_enable, -- Write enable
rd_en => read_enable, -- Read enable
overflow => overflow, -- FIFO has overflowed
@ -412,7 +412,7 @@ Following extra configurations are supported:
.. code-block:: vhdl
wr_en => write_enable, -- Wrte enable
wr_en => write_enable, -- Write enable
rd_en => read_enable, -- Read enable
overflow => overflow, -- FIFO has overflowed

View File

@ -144,7 +144,7 @@ We also need to provide a solution to the user so they will know how to fix the
self.fixable = False # User must split the file
self.solution = 'Split entity and architecture into seperate files.'
self.solution = 'Split entity and architecture into separate files.'
def analyze(self, oFile):
if oFile.hasEntity and oFile.hasArchitecture:
@ -164,7 +164,7 @@ Finally, we need to add a code tag check so the rule can be disabled via comment
self.name = 'localized'
self.phase = 1
self.fixable = False # User must split the file
self.solution = 'Split entity and architecture into seperate files.'
self.solution = 'Split entity and architecture into separate files.'
def analyze(self, oFile):
if not self.is_vsg_off(oLine):
@ -190,7 +190,7 @@ When we want to run with localized rules, use the **--local_rules** option.
File: RAM.vhd
==============
Phase 1... Reporting
localized_001 | 1 | Split entity and architecture into seperate files.
localized_001 | 1 | Split entity and architecture into separate files.
Phase 2... Not executed
Phase 3... Not executed
Phase 4... Not executed
@ -513,7 +513,7 @@ Use this to create the initial violation and add to it as necessary.
The **get_violation_line_number** will return the lines['number'] attribute of the violation.
Use this function to abstract away the line number from the underlying data structure.
The **get_violating_line** will return a line object at the line the violation occured.
The **get_violating_line** will return a line object at the line the violation occurred.
This is easier than manually indexing into the oFile list to pull out a line.
Rule creation guidelines

View File

@ -229,7 +229,7 @@ port_map_010
|phase_1| |error| |structure|
This rule checks for comments at the end of the port and generic assignments in instantiations.
These comments represent additional maintainence.
These comments represent additional maintenance.
They will be out of sync with the entity at some point.
Refer to the entity for port types, port directions and purpose.

View File

@ -265,13 +265,13 @@ This rule checks the label has proper case.
.. code-block:: vhdl
PROCEDURE_CALL_LABEL : WR_EN(paremeter);
PROCEDURE_CALL_LABEL : WR_EN(parameter);
**Fix**
.. code-block:: vhdl
procedure_call_label : WR_EN(paremeter);
procedure_call_label : WR_EN(parameter);
procedure_call_501
##################

View File

@ -543,7 +543,7 @@ This rule checks the alignment of **:=** operator for each parameter in the proc
procedure_412
#############
This rule has been superceeded by rule `architecture_027 <architecture_rules.html#architecture-027>`_.
This rule has been superseded by rule `architecture_027 <architecture_rules.html#architecture-027>`_.
procedure_500
#############

View File

@ -1,7 +1,7 @@
Rules
=====
The rules are divided into catagories depending on the part of the VHDL code being operated on.
The rules are divided into categories depending on the part of the VHDL code being operated on.
.. toctree::
:maxdepth: 2

View File

@ -183,7 +183,7 @@ The function of this rule has been moved to rule ieee_500.
signal_011
##########
The function of this rule has been superceeded by the following rules:
The function of this rule has been superseded by the following rules:
* ieee_500
* subtype_002

View File

@ -8,7 +8,7 @@ source_file_001
|phase_1| |error| |structure|
This rule checks for the existance of the source file passed to VSG.
This rule checks for the existence of the source file passed to VSG.
**Violation**

View File

@ -112,7 +112,7 @@ The classification of the opening portion of the production, from **architecture
After the **is** keyword, the detect function of the architecture_declarative_part is called to check if there is anything in that production.
If there are no more items in the architecture_declarative_part, then the begin keyword is classified.
After the **begin** keyword, the detect function of the architecture_statement_part is called to check if there is anything in that production.
If there are no more itmes in the architecture_statement_part, then the closing portion of the production, from **end** to the semicolon, is handled by the classify_closing_declaration function.
If there are no more items in the architecture_statement_part, then the closing portion of the production, from **end** to the semicolon, is handled by the classify_closing_declaration function.
The recursive nature is implemented by calling other productions and then those productions returning to the caller.

View File

@ -64,7 +64,7 @@ Everything else is another production:
Rules targetting the :code:`architecture_body` will only include those elements at that level of the production.
Rules targeting the :code:`architecture_body` will only include those elements at that level of the production.
For example:
@ -194,7 +194,7 @@ The following rules would be generated:
* signal_declaration_400 = indent of signal keyword
* signal_declaration_600 = case of signal keyword
* signal_declaration_601 = case of idenfiers in identifier_list
* signal_declaration_601 = case of identifiers in identifier_list
* signal_declaration_700 = naming restrictions on signal identifiers

View File

@ -17,7 +17,7 @@ VSG supports integration with other tools via several command line options.
VSG has a concept of phases, where violations in one phase should be addressed before moving to the next phase.
The **--all_phases** option will run an analysis over all the phases.
It will not stop if a violation has occured.
It will not stop if a violation has occurred.
This option can be useful when integrating VSG into an editor that supports linters.
It is important to note there are dependencies between some rules.

View File

@ -141,7 +141,7 @@ The command line tool can be invoked with:
| | default is the number of cores available. |
+-------------------------------+-------------------------------------------------+
| --debug | Print verbose debug information to assist with |
| | debuging errors with VSG. |
| | debugging errors with VSG. |
+-------------------------------+-------------------------------------------------+
@ -167,7 +167,7 @@ Here is an example output running against a test file:
----------------------------+------------+--------------------------------------
NOTE: Refer to online documentation at https://vhdl-style-guide.readthedocs.io/en/latest/index.html for more information.
VSG will report the rule which is violated and the line number or group of lines where the violation occured.
VSG will report the rule which is violated and the line number or group of lines where the violation occurred.
It also gives a suggestion on how to fix the violation.
The rules VSG uses are grouped together into :doc:`phases`.
These phases follow the order in which the user would take to address the violations.

View File

@ -152,7 +152,7 @@ This rule checks for default assignments in variable declarations.
variable_010
############
The function of this rule has been superceeded by the following rules:
The function of this rule has been superseded by the following rules:
* ieee_500
* subtype_002

View File

@ -11,7 +11,7 @@ when_001
|phase_1| |error| |structure|
This rule checks the **else** keyword is not at the beginning of a line.
The else should be at the end of the preceeding line.
The else should be at the end of the preceding line.
**Violation**

View File

@ -3,7 +3,7 @@ architecture RTL of FIFO is
begin
-- With no optional paramenters
-- With no optional parameters
BLOCK_LABEL : block
begin
end block;

View File

@ -3,7 +3,7 @@ architecture RTL of FIFO is
begin
-- With no optional paramenters
-- With no optional parameters
BLOCK_LABEL : block
begin
end block;

View File

@ -3,7 +3,7 @@ architecture RTL of FIFO is
begin
-- With no optional paramenters
-- With no optional parameters
BLOCK_LABEL : block
begin
end block;

View File

@ -58,7 +58,7 @@ begin
for_generate_label : for i in 0 to 200 generate -- for generate comment
ab <= bc; -- comment zz
ac <= ad; -- coment za
ac <= ad; -- comment za
ae <= af; -- comment ab
end generate; -- end for generate label

View File

@ -58,7 +58,7 @@ begin
for_generate_label : for i in 0 to 200 generate -- for generate comment
ab <= bc; -- comment zz
ac <= ad; -- coment za
ac <= ad; -- comment za
ae <= af; -- comment ab
end generate; -- end for generate label

View File

@ -52,7 +52,7 @@ architecture rtl of fifo is
others => false
);
-- Test hierarcical assignments
-- Test hierarchical assignments
-- Desired alignment
constant my_constant : my_type := (
ENUM_1 => (

View File

@ -52,7 +52,7 @@ architecture rtl of fifo is
others => false
);
-- Test hierarcical assignments
-- Test hierarchical assignments
-- Desired alignment
constant my_constant : my_type := (
ENUM_1 => (

View File

@ -52,7 +52,7 @@ architecture rtl of fifo is
others => false
);
-- Test hierarcical assignments
-- Test hierarchical assignments
-- Desired alignment
constant my_constant : my_type := (
ENUM_1 => (

View File

@ -52,7 +52,7 @@ architecture rtl of fifo is
others => false
);
-- Test hierarcical assignments
-- Test hierarchical assignments
-- Desired alignment
constant my_constant : my_type := (
ENUM_1 => (

View File

@ -52,7 +52,7 @@ architecture rtl of fifo is
others => false
);
-- Test hierarcical assignments
-- Test hierarchical assignments
-- Desired alignment
constant my_constant : my_type := (
ENUM_1 => (

View File

@ -52,7 +52,7 @@ architecture rtl of fifo is
others => false
);
-- Test hierarcical assignments
-- Test hierarchical assignments
-- Desired alignment
constant my_constant : my_type := (
ENUM_1 => (

View File

@ -52,7 +52,7 @@ architecture rtl of fifo is
others=> false
);
-- Test hierarcical assignments
-- Test hierarchical assignments
-- Desired alignment
constant my_constant : my_type := (
ENUM_1 => (

View File

@ -21,7 +21,7 @@ is
end context c1;
context c1 -- Yet another commet
context c1 -- Yet another comment, comment
-- Some comment
is

View File

@ -21,7 +21,7 @@ is
end context c1;
context -- Yet another commet
context -- Yet another comment, comment
c1 -- Some comment
is

View File

@ -21,7 +21,7 @@ context
end context c1;
context c1 is -- Yet another commet
context c1 is -- Yet another comment, comment
-- Some comment

View File

@ -21,7 +21,7 @@ is
end context c1;
context c1 -- Yet another commet
context c1 -- Yet another comment, comment
-- Some comment
is

View File

@ -24,7 +24,7 @@ end context -- Some comment
-- Some other comment
c1;
context c1 -- Yet another commet
context c1 -- Yet another comment, comment
-- Some comment
is

View File

@ -24,7 +24,7 @@ end -- Some comment
context -- Some other comment
c1;
context c1 -- Yet another commet
context c1 -- Yet another comment, comment
-- Some comment
is

View File

@ -25,7 +25,7 @@ context c1 -- Some other comment
-- other comments
;
context c1 -- Yet another commet
context c1 -- Yet another comment, comment
-- Some comment
is

View File

@ -25,7 +25,7 @@ context -- Some other comment
-- other comments
c1;
context c1 -- Yet another commet
context c1 -- Yet another comment, comment
-- Some comment
is

View File

@ -27,7 +27,7 @@ context c1; -- Some other comment
-- other comments
context c1 -- Yet another commet
context c1 -- Yet another comment, comment
-- Some comment
is

View File

@ -27,7 +27,7 @@ context c1 -- Some other comment
-- other comments
;
context c1 -- Yet another commet
context c1 -- Yet another comment, comment
-- Some comment
is

View File

@ -25,7 +25,7 @@ architecture RTL of FIFO is
begin
end procedure proc_name;
-- There must be an indent after the proctected type
-- There must be an indent after the protected type
type t_protected_fifo is protected
procedure reset_fifo (

View File

@ -25,7 +25,7 @@ procedure proc_name (
begin
end procedure proc_name;
-- There must be an indent after the proctected type
-- There must be an indent after the protected type
type t_protected_fifo is protected
procedure reset_fifo (

View File

@ -9,7 +9,7 @@ class rule_localized_001(rule.rule):
self.name = 'localized' # Force the rule's name, because it can't be extracted from the module
self.phase = 1
self.fixable = False # User must split the file
self.solution = 'Split entity and architecture into seperate files.'
self.solution = 'Split entity and architecture into separate files.'
def analyze(self, oFile):
if oFile.hasEntity and oFile.hasArchitecture:

View File

@ -37,7 +37,7 @@
-- Parallel load is controlled using 3 signals: 'di_i', 'di_req_o' and 'wren_i'. 'di_req_o' is a look ahead data request line,
-- that is set 'PREFETCH' clock cycles in advance to synchronize a pipelined memory or fifo to present the
-- next input data at 'di_i' in time to have continuous clock at the spi bus, to allow back-to-back continuous load.
-- For a pipelined sync RAM, a PREFETCH of 2 cycles allows an address generator to present the new adress to the RAM in one
-- For a pipelined sync RAM, a PREFETCH of 2 cycles allows an address generator to present the new address to the RAM in one
-- cycle, and the RAM to respond in one more cycle, in time for 'di_i' to be latched by the shifter.
-- If the user sequencer needs a different value for PREFETCH, the generic can be altered at instantiation time.
-- The 'wren_i' write enable strobe must be valid at least one setup time before the rising edge of the last SPI clock cycle,
@ -139,7 +139,7 @@
-- BUG: CPOL='0', CPHA='1' causes SCK to have one extra pulse with one sclk_i width at the end.
-- 2011/07/18 v1.12.0105 [JD] CHG: spi sck output register changed to remove glitch at last clock when CPHA='1'.
-- for CPHA='1', max spi clock is 25MHz. for CPHA= '0', max spi clock is >50MHz.
-- 2011/07/24 v1.13.0125 [JD] FIX: 'sck_ena_ce' is on half-cycle advanced to 'fsm_ce', elliminating CPHA='1' glitches.
-- 2011/07/24 v1.13.0125 [JD] FIX: 'sck_ena_ce' is on half-cycle advanced to 'fsm_ce', eliminating CPHA='1' glitches.
-- Core verified for all CPOL, CPHA at up to 50MHz, simulates to over 100MHz.
-- 2011/07/29 v1.14.0130 [JD] Removed global signal setting at the FSM, implementing exhaustive explicit signal attributions
-- for each state, to avoid reported inference problems in some synthesis engines.

View File

@ -37,7 +37,7 @@
-- Parallel load is controlled using 3 signals: 'di_i', 'di_req_o' and 'wren_i'. 'di_req_o' is a look ahead data request line,
-- that is set 'PREFETCH' clock cycles in advance to synchronize a pipelined memory or fifo to present the
-- next input data at 'di_i' in time to have continuous clock at the spi bus, to allow back-to-back continuous load.
-- For a pipelined sync RAM, a PREFETCH of 2 cycles allows an address generator to present the new adress to the RAM in one
-- For a pipelined sync RAM, a PREFETCH of 2 cycles allows an address generator to present the new address to the RAM in one
-- cycle, and the RAM to respond in one more cycle, in time for 'di_i' to be latched by the shifter.
-- If the user sequencer needs a different value for PREFETCH, the generic can be altered at instantiation time.
-- The 'wren_i' write enable strobe must be valid at least one setup time before the rising edge of the last SPI clock cycle,
@ -139,7 +139,7 @@
-- BUG: CPOL='0', CPHA='1' causes SCK to have one extra pulse with one sclk_i width at the end.
-- 2011/07/18 v1.12.0105 [JD] CHG: spi sck output register changed to remove glitch at last clock when CPHA='1'.
-- for CPHA='1', max spi clock is 25MHz. for CPHA= '0', max spi clock is >50MHz.
-- 2011/07/24 v1.13.0125 [JD] FIX: 'sck_ena_ce' is on half-cycle advanced to 'fsm_ce', elliminating CPHA='1' glitches.
-- 2011/07/24 v1.13.0125 [JD] FIX: 'sck_ena_ce' is on half-cycle advanced to 'fsm_ce', eliminating CPHA='1' glitches.
-- Core verified for all CPOL, CPHA at up to 50MHz, simulates to over 100MHz.
-- 2011/07/29 v1.14.0130 [JD] Removed global signal setting at the FSM, implementing exhaustive explicit signal attributions
-- for each state, to avoid reported inference problems in some synthesis engines.

View File

@ -29,7 +29,7 @@
-- The write to 'di_i' must occur at most one 'spi_sck_i' cycle before actual load to the core shift register, to avoid
-- race conditions at the register transfer.
-- The user circuit places data at the 'di_i' port and strobes the 'wren_i' line for one rising edge of 'clk_i'.
-- For a pipelined sync RAM, a PREFETCH of 3 cycles allows an address generator to present the new adress to the RAM in one
-- For a pipelined sync RAM, a PREFETCH of 3 cycles allows an address generator to present the new address to the RAM in one
-- cycle, and the RAM to respond in one more cycle, in time for 'di_i' to be latched by the interface one clock before transfer.
-- If the user sequencer needs a different value for PREFETCH, the generic can be altered at instantiation time.
-- The 'wren_i' write enable strobe must be valid at least one setup time before the rising edge of the last clock cycle,

View File

@ -77,7 +77,7 @@ elsif( rising_edge(CLK_I) ) then
flag <= INTA_I;
case next_s is
when reset_s =>
--initialze signals to zero.
--initialize signals to zero.
flag <= '0';
flag1 <= '0';
int_type <= "00";

View File

@ -37,7 +37,7 @@
-- Parallel load is controlled using 3 signals: 'di_i', 'di_req_o' and 'wren_i'. 'di_req_o' is a look ahead data request line,
-- that is set 'PREFETCH' clock cycles in advance to synchronize a pipelined memory or fifo to present the
-- next input data at 'di_i' in time to have continuous clock at the spi bus, to allow back-to-back continuous load.
-- For a pipelined sync RAM, a PREFETCH of 2 cycles allows an address generator to present the new adress to the RAM in one
-- For a pipelined sync RAM, a PREFETCH of 2 cycles allows an address generator to present the new address to the RAM in one
-- cycle, and the RAM to respond in one more cycle, in time for 'di_i' to be latched by the shifter.
-- If the user sequencer needs a different value for PREFETCH, the generic can be altered at instantiation time.
-- The 'wren_i' write enable strobe must be valid at least one setup time before the rising edge of the last SPI clock cycle,
@ -139,7 +139,7 @@
-- BUG: CPOL='0', CPHA='1' causes SCK to have one extra pulse with one sclk_i width at the end.
-- 2011/07/18 v1.12.0105 [JD] CHG: spi sck output register changed to remove glitch at last clock when CPHA='1'.
-- for CPHA='1', max spi clock is 25MHz. for CPHA= '0', max spi clock is >50MHz.
-- 2011/07/24 v1.13.0125 [JD] FIX: 'sck_ena_ce' is on half-cycle advanced to 'fsm_ce', elliminating CPHA='1' glitches.
-- 2011/07/24 v1.13.0125 [JD] FIX: 'sck_ena_ce' is on half-cycle advanced to 'fsm_ce', eliminating CPHA='1' glitches.
-- Core verified for all CPOL, CPHA at up to 50MHz, simulates to over 100MHz.
-- 2011/07/29 v1.14.0130 [JD] Removed global signal setting at the FSM, implementing exhaustive explicit signal attributions
-- for each state, to avoid reported inference problems in some synthesis engines.

View File

@ -29,7 +29,7 @@
-- The write to 'di_i' must occur at most one 'spi_sck_i' cycle before actual load to the core shift register, to avoid
-- race conditions at the register transfer.
-- The user circuit places data at the 'di_i' port and strobes the 'wren_i' line for one rising edge of 'clk_i'.
-- For a pipelined sync RAM, a PREFETCH of 3 cycles allows an address generator to present the new adress to the RAM in one
-- For a pipelined sync RAM, a PREFETCH of 3 cycles allows an address generator to present the new address to the RAM in one
-- cycle, and the RAM to respond in one more cycle, in time for 'di_i' to be latched by the interface one clock before transfer.
-- If the user sequencer needs a different value for PREFETCH, the generic can be altered at instantiation time.
-- The 'wren_i' write enable strobe must be valid at least one setup time before the rising edge of the last clock cycle,

View File

@ -77,7 +77,7 @@ begin
flag <= INTA_I;
case next_s is
when reset_s =>
--initialze signals to zero.
--initialize signals to zero.
flag <= '0';
flag1 <= '0';
int_type <= "00";

View File

@ -37,7 +37,7 @@
-- Parallel load is controlled using 3 signals: 'di_i', 'di_req_o' and 'wren_i'. 'di_req_o' is a look ahead data request line,
-- that is set 'PREFETCH' clock cycles in advance to synchronize a pipelined memory or fifo to present the
-- next input data at 'di_i' in time to have continuous clock at the spi bus, to allow back-to-back continuous load.
-- For a pipelined sync RAM, a PREFETCH of 2 cycles allows an address generator to present the new adress to the RAM in one
-- For a pipelined sync RAM, a PREFETCH of 2 cycles allows an address generator to present the new address to the RAM in one
-- cycle, and the RAM to respond in one more cycle, in time for 'di_i' to be latched by the shifter.
-- If the user sequencer needs a different value for PREFETCH, the generic can be altered at instantiation time.
-- The 'wren_i' write enable strobe must be valid at least one setup time before the rising edge of the last SPI clock cycle,
@ -139,7 +139,7 @@
-- BUG: CPOL='0', CPHA='1' causes SCK to have one extra pulse with one sclk_i width at the end.
-- 2011/07/18 v1.12.0105 [JD] CHG: spi sck output register changed to remove glitch at last clock when CPHA='1'.
-- for CPHA='1', max spi clock is 25MHz. for CPHA= '0', max spi clock is >50MHz.
-- 2011/07/24 v1.13.0125 [JD] FIX: 'sck_ena_ce' is on half-cycle advanced to 'fsm_ce', elliminating CPHA='1' glitches.
-- 2011/07/24 v1.13.0125 [JD] FIX: 'sck_ena_ce' is on half-cycle advanced to 'fsm_ce', eliminating CPHA='1' glitches.
-- Core verified for all CPOL, CPHA at up to 50MHz, simulates to over 100MHz.
-- 2011/07/29 v1.14.0130 [JD] Removed global signal setting at the FSM, implementing exhaustive explicit signal attributions
-- for each state, to avoid reported inference problems in some synthesis engines.

View File

@ -29,7 +29,7 @@
-- The write to 'di_i' must occur at most one 'spi_sck_i' cycle before actual load to the core shift register, to avoid
-- race conditions at the register transfer.
-- The user circuit places data at the 'di_i' port and strobes the 'wren_i' line for one rising edge of 'clk_i'.
-- For a pipelined sync RAM, a PREFETCH of 3 cycles allows an address generator to present the new adress to the RAM in one
-- For a pipelined sync RAM, a PREFETCH of 3 cycles allows an address generator to present the new address to the RAM in one
-- cycle, and the RAM to respond in one more cycle, in time for 'di_i' to be latched by the interface one clock before transfer.
-- If the user sequencer needs a different value for PREFETCH, the generic can be altered at instantiation time.
-- The 'wren_i' write enable strobe must be valid at least one setup time before the rising edge of the last clock cycle,

View File

@ -86,7 +86,7 @@ begin
case next_s is
when RESET_S =>
-- initialze signals to zero.
-- initialize signals to zero.
flag <= '0';
flag1 <= '0';
int_type <= "00";

View File

@ -37,7 +37,7 @@
-- Parallel load is controlled using 3 signals: 'di_i', 'di_req_o' and 'wren_i'. 'di_req_o' is a look ahead data request line,
-- that is set 'PREFETCH' clock cycles in advance to synchronize a pipelined memory or fifo to present the
-- next input data at 'di_i' in time to have continuous clock at the spi bus, to allow back-to-back continuous load.
-- For a pipelined sync RAM, a PREFETCH of 2 cycles allows an address generator to present the new adress to the RAM in one
-- For a pipelined sync RAM, a PREFETCH of 2 cycles allows an address generator to present the new address to the RAM in one
-- cycle, and the RAM to respond in one more cycle, in time for 'di_i' to be latched by the shifter.
-- If the user sequencer needs a different value for PREFETCH, the generic can be altered at instantiation time.
-- The 'wren_i' write enable strobe must be valid at least one setup time before the rising edge of the last SPI clock cycle,
@ -139,7 +139,7 @@
-- BUG: CPOL='0', CPHA='1' causes SCK to have one extra pulse with one sclk_i width at the end.
-- 2011/07/18 v1.12.0105 [JD] CHG: spi sck output register changed to remove glitch at last clock when CPHA='1'.
-- for CPHA='1', max spi clock is 25MHz. for CPHA= '0', max spi clock is >50MHz.
-- 2011/07/24 v1.13.0125 [JD] FIX: 'sck_ena_ce' is on half-cycle advanced to 'fsm_ce', elliminating CPHA='1' glitches.
-- 2011/07/24 v1.13.0125 [JD] FIX: 'sck_ena_ce' is on half-cycle advanced to 'fsm_ce', eliminating CPHA='1' glitches.
-- Core verified for all CPOL, CPHA at up to 50MHz, simulates to over 100MHz.
-- 2011/07/29 v1.14.0130 [JD] Removed global signal setting at the FSM, implementing exhaustive explicit signal attributions
-- for each state, to avoid reported inference problems in some synthesis engines.

View File

@ -29,7 +29,7 @@
-- The write to 'di_i' must occur at most one 'spi_sck_i' cycle before actual load to the core shift register, to avoid
-- race conditions at the register transfer.
-- The user circuit places data at the 'di_i' port and strobes the 'wren_i' line for one rising edge of 'clk_i'.
-- For a pipelined sync RAM, a PREFETCH of 3 cycles allows an address generator to present the new adress to the RAM in one
-- For a pipelined sync RAM, a PREFETCH of 3 cycles allows an address generator to present the new address to the RAM in one
-- cycle, and the RAM to respond in one more cycle, in time for 'di_i' to be latched by the interface one clock before transfer.
-- If the user sequencer needs a different value for PREFETCH, the generic can be altered at instantiation time.
-- The 'wren_i' write enable strobe must be valid at least one setup time before the rising edge of the last clock cycle,

View File

@ -94,7 +94,7 @@
20 |
<class 'vsg.parser.blank_line'>
--------------------------------------------------------------------------------
21 | -- with inertial delay machanism
21 | -- with inertial delay mechanism
<class 'vsg.parser.comment'>
--------------------------------------------------------------------------------
22 | a <= inertial b when 'a' else
@ -173,7 +173,7 @@
35 |
<class 'vsg.parser.blank_line'>
--------------------------------------------------------------------------------
36 | -- with guarded and inertial delay machanism
36 | -- with guarded and inertial delay mechanism
<class 'vsg.parser.comment'>
--------------------------------------------------------------------------------
37 | a <= guarded inertial b when 'a' else

View File

@ -18,7 +18,7 @@ begin
c when 'b' else
d;
-- with inertial delay machanism
-- with inertial delay mechanism
a <= inertial b when 'a' else
c when 'b' else
d;
@ -33,7 +33,7 @@ begin
c when 'b' else
d;
-- with guarded and inertial delay machanism
-- with guarded and inertial delay mechanism
a <= guarded inertial b when 'a' else
c when 'b' else
d;

View File

@ -58,7 +58,7 @@
14 |
<class 'vsg.parser.blank_line'>
--------------------------------------------------------------------------------
15 | -- with inertial delay machanism
15 | -- with inertial delay mechanism
<class 'vsg.parser.comment'>
--------------------------------------------------------------------------------
16 | a <= inertial b;
@ -101,7 +101,7 @@
23 |
<class 'vsg.parser.blank_line'>
--------------------------------------------------------------------------------
24 | -- with guarded and inertial delay machanism
24 | -- with guarded and inertial delay mechanism
<class 'vsg.parser.comment'>
--------------------------------------------------------------------------------
25 | a <= guarded inertial b;

View File

@ -12,7 +12,7 @@ begin
-- with transport delay mechanism
a <= transport b;
-- with inertial delay machanism
-- with inertial delay mechanism
a <= inertial b;
-- with reject delay mechanism
@ -21,7 +21,7 @@ begin
-- with guarded and transport delay mechanism
a <= guarded transport b;
-- with guarded and inertial delay machanism
-- with guarded and inertial delay mechanism
a <= guarded inertial b;
-- with guarded and reject delay mechanism

View File

@ -31,7 +31,7 @@ entity FIFO is
-- RTL_SYNTHESIS OFF
-- RTL_SYNTHESIS something
-- synopsys
-- synopsys
-- synopsys something
-- synopsys something else
-- synopsys something else entirely

View File

@ -124,7 +124,7 @@
23 |
<class 'vsg.parser.blank_line'>
--------------------------------------------------------------------------------
24 | type indentifier;
24 | type identifier;
<class 'vsg.token.incomplete_type_declaration.type_keyword'>
<class 'vsg.token.incomplete_type_declaration.identifier'>
<class 'vsg.token.incomplete_type_declaration.semicolon'>

View File

@ -21,7 +21,7 @@ architecture RTL of ENTITY_NAME is
package pack2 is new pack2_name;
type indentifier;
type identifier;
subtype identifier is integer;

View File

@ -11,7 +11,7 @@ class rule_001(rule.Rule):
self.name = 'localized' # Force the rule's name, because it can't be extracted from the module
self.phase = 1
self.fixable = False # User must split the file
self.solution = 'Split entity and architecture into seperate files.'
self.solution = 'Split entity and architecture into separate files.'
def analyze(self, oFile):
lToiEntity = oFile.get_tokens_matching([token.entity_declaration.entity_keyword])

View File

@ -232,7 +232,7 @@ class testMain(unittest.TestCase):
@mock.patch('sys.stdout')
def test_local_rules(self,mock_stdout):
lExpected = []
lExpected.append(mock.call('ERROR: tests/vsg/entity_architecture.vhd(1)localized_001 -- Split entity and architecture into seperate files.'))
lExpected.append(mock.call('ERROR: tests/vsg/entity_architecture.vhd(1)localized_001 -- Split entity and architecture into separate files.'))
lExpected.append(mock.call('\n'))
sys.argv = ['vsg']

View File

@ -131,7 +131,7 @@ class testVsg(unittest.TestCase):
self.assertEqual(sLine, lActual[iLineNumber])
def test_local_rules(self):
lExpected = ['ERROR: tests/vsg/entity_architecture.vhd(1)localized_001 -- Split entity and architecture into seperate files.']
lExpected = ['ERROR: tests/vsg/entity_architecture.vhd(1)localized_001 -- Split entity and architecture into separate files.']
lExpected.append('')
try:

View File

@ -262,10 +262,10 @@ dPragmas['single'].append('^\\s*--\\s+altera\\s+\\w+\\s*$' )
dPragmas['open'].append('^\\s*--\\s+RTL_SYNTHESIS\\s+OFF\\s*$' )
dPragmas['close'].append('^\\s*--\\s+RTL_SYNTHESIS\\s+ON\\s*$' )
dPragmas['single'].append('^\\s*--\\s+synopsys\\s+\\w+\\s*$')
dPragmas['single'].append('^\\s*--\\s+synopsys\\s+\\w+\\s+\\w+\\s*$')
dPragmas['single'].append('^\\s*--\\s+xilinx\\s+\\w+\\s*$')
dPragmas['single'].append('^\\s*--\\s+xilinx\\s+\\w+\\s+\\w+\\s*$')
dPragmas["single"].append("^\\s*--\\s+synopsys\\s+\\w+\\s*$")
dPragmas["single"].append("^\\s*--\\s+synopsys\\s+\\w+\\s+\\w+\\s*$")
dPragmas["single"].append("^\\s*--\\s+xilinx\\s+\\w+\\s*$")
dPragmas["single"].append("^\\s*--\\s+xilinx\\s+\\w+\\s+\\w+\\s*$")
def add_pragma_regular_expressions(dStyle):

View File

@ -48,7 +48,7 @@ class rule_026(Rule):
def __init__(self):
super().__init__(lAlign, token.architecture_body.is_keyword, token.architecture_body.begin_keyword, lUnless)
self.solution = 'Align identifer.'
self.solution = 'Align identifier.'
self.subphase = 3
self.configuration.append('include_type_is_keyword')
self.is_keyword = token.full_type_declaration.is_keyword

View File

@ -44,6 +44,6 @@ class rule_029(align_tokens_in_region_between_tokens_unless_between_tokens):
def __init__(self):
super().__init__(lAlign, token.architecture_body.is_keyword, token.architecture_body.begin_keyword, lUnless)
self.solution = 'Align identifer.'
self.solution = 'Align identifier.'
self.configuration_documentation_link = 'configuring_identifier_alignment_rules_link'
self.configuration.remove('separate_generic_port_alignment')

View File

@ -4,7 +4,7 @@ from vsg import deprecated_rule
class rule_001(deprecated_rule.Rule):
'''
This rule has been superceeded by:
This rule has been superseded by:
* `attribute_declaration_300 <attribute_declaration_rules.html#attribute-declaration-300>`_
* `attribute_specification_300 <attribute_specification_rules.html#attribute-specification-300>`_
@ -12,4 +12,4 @@ class rule_001(deprecated_rule.Rule):
def __init__(self):
super().__init__()
self.message.append('Rule ' + self.unique_id + ' has been superceeded by attribute_declaration_300 and attribute_specification_300.')
self.message.append('Rule ' + self.unique_id + ' has been superseded by attribute_declaration_300 and attribute_specification_300.')

View File

@ -4,7 +4,7 @@ from vsg import deprecated_rule
class rule_002(deprecated_rule.Rule):
'''
This rule has been superceeded by:
This rule has been superseded by:
* `attribute_declaration_500 <attribute_declaration_rules.html#attribute-declaration-500>`_
* `attribute_specification_500 <attribute_specification_rules.html#attribute-specification-500>`_
@ -12,4 +12,4 @@ class rule_002(deprecated_rule.Rule):
def __init__(self):
super().__init__()
self.message.append('Rule ' + self.unique_id + ' has been superceeded by attribute_declaration_500 and attribute_specification_500.')
self.message.append('Rule ' + self.unique_id + ' has been superseded by attribute_declaration_500 and attribute_specification_500.')

View File

@ -40,6 +40,6 @@ class rule_400(align_tokens_in_region_between_tokens_unless_between_tokens):
def __init__(self):
super().__init__(lAlign, token.block_statement.block_keyword, token.block_statement.begin_keyword, lUnless)
self.solution = 'Align identifer.'
self.solution = 'Align identifier.'
self.configuration_documentation_link = 'configuring_identifier_alignment_rules_link'
self.configuration.remove('separate_generic_port_alignment')

View File

@ -197,7 +197,7 @@ def does_not_contain_any_alpha_characters(sObjectValue):
return False
# Define mapping of case to checkers and comparitors
# Define mapping of case to checkers and comparators
dCase = {}
dCase['camelCase'] = {}
dCase['camelCase']['check'] = check_for_camelcase

View File

@ -21,7 +21,7 @@ class rule_010(token_indent_unless_between_tokens):
.. code-block:: vhdl
-- Libraries
libary ieee;
library ieee;
-- Define architecture
architecture rtl of fifo is
@ -37,7 +37,7 @@ class rule_010(token_indent_unless_between_tokens):
.. code-block:: vhdl
-- Libraries
libary ieee;
library ieee;
-- Define architecture
architecture rtl of fifo is

View File

@ -11,7 +11,7 @@ oEnd = token.component_declaration.semicolon
class rule_019(remove_comments_from_end_of_lines_bounded_by_tokens):
'''
This rule checks for comments at the end of the port and generic clauses in component declarations.
These comments represent additional maintainence.
These comments represent additional maintenance.
They will be out of sync with the entity at some point.
Refer to the entity for port types, port directions and purpose.

View File

@ -56,5 +56,5 @@ class rule_020(align_tokens_in_region_between_tokens_skipping_lines_starting_wit
def __init__(self):
super().__init__(lAlign, token.component_declaration.component_keyword, token.component_declaration.end_keyword, lSkip)
self.solution = 'Align identifer.'
self.solution = 'Align identifier.'
self.subphase = 2

View File

@ -10,7 +10,7 @@ lTokenPairs.append([token.concurrent_simple_signal_assignment.assignment, token.
class rule_003(multiline_alignment_between_tokens):
'''
This rule checks alignment of multiline concurrent simple signal assignments.
Succesive lines should align to the space after the assignment operator.
Successive lines should align to the space after the assignment operator.
However, there is a special case if there are parenthesis in the assignment.
If the parenthesis are not closed on the same line, then the next line will be aligned to the parenthesis.
Aligning to the parenthesis improves readability.

View File

@ -4,7 +4,7 @@ from vsg import deprecated_rule
class rule_011(deprecated_rule.Rule):
'''
The function of this rule has been superceeded by the following rules:
The function of this rule has been superseded by the following rules:
* ieee_500
* subtype_002
@ -12,7 +12,7 @@ class rule_011(deprecated_rule.Rule):
'''
def __init__(self):
super().__init__()
self.message.append('Rule ' + self.unique_id + ' has been superceeded by the following rules:')
self.message.append('Rule ' + self.unique_id + ' has been superseded by the following rules:')
self.message.append(' ieee_500')
self.message.append(' subtype_002')
self.message.append(' type_014')

View File

@ -42,6 +42,6 @@ class rule_015(align_tokens_in_region_between_tokens_unless_between_tokens):
def __init__(self):
super().__init__(lAlign, token.subprogram_body.is_keyword, token.subprogram_body.begin_keyword, lUnless)
self.solution = 'Align identifer.'
self.solution = 'Align identifier.'
self.configuration_documentation_link = 'configuring_identifier_alignment_rules_link'
self.configuration.remove('separate_generic_port_alignment')

View File

@ -46,7 +46,7 @@ class rule_400(align_tokens_in_region_between_tokens_when_between_tokens_unless_
def __init__(self):
super().__init__(lAlign, oStartToken, oEndToken, lBetweenTokens, lUnless)
self.solution = 'Align identifer.'
self.solution = 'Align identifier.'
self.configuration_documentation_link = 'configuring_identifier_alignment_rules_link'
self.configuration.remove('loop_control_statements_ends_group')
self.configuration.remove('separate_generic_port_alignment')

View File

@ -46,7 +46,7 @@ class rule_402(align_tokens_in_region_between_tokens_when_between_tokens_unless_
def __init__(self):
super().__init__(lAlign, oStartToken, oEndToken, lBetweenTokens, lUnless)
self.solution = 'Align identifer.'
self.solution = 'Align identifier.'
self.configuration_documentation_link = 'configuring_identifier_alignment_rules_link'
self.configuration.remove('loop_control_statements_ends_group')
self.configuration.remove('separate_generic_port_alignment')

View File

@ -46,7 +46,7 @@ class rule_404(align_tokens_in_region_between_tokens_when_between_tokens_unless_
def __init__(self):
super().__init__(lAlign, oStartToken, oEndToken, lBetweenTokens, lUnless)
self.solution = 'Align identifer.'
self.solution = 'Align identifier.'
self.configuration_documentation_link = 'configuring_identifier_alignment_rules_link'
self.configuration.remove('loop_control_statements_ends_group')
self.configuration.remove('separate_generic_port_alignment')

View File

@ -26,7 +26,7 @@ class rule_029(align_tokens_in_region_between_tokens_skipping_lines_starting_wit
.. code-block:: vhdl
wr_en => write_enable, -- Wrte enable
wr_en => write_enable, -- Write enable
rd_en => read_enable, -- Read enable
overflow => overflow, -- FIFO has overflowed
@ -34,7 +34,7 @@ class rule_029(align_tokens_in_region_between_tokens_skipping_lines_starting_wit
.. code-block:: vhdl
wr_en => write_enable, -- Wrte enable
wr_en => write_enable, -- Write enable
rd_en => read_enable, -- Read enable
overflow => overflow, -- FIFO has overflowed
'''

View File

@ -42,6 +42,6 @@ class rule_019(align_tokens_in_region_between_tokens_unless_between_tokens):
def __init__(self):
super().__init__(lAlign, token.package_declaration.is_keyword, token.package_declaration.end_keyword, lUnless)
self.solution = 'Align identifer.'
self.solution = 'Align identifier.'
self.configuration_documentation_link = 'configuring_identifier_alignment_rules_link'
self.configuration.remove('separate_generic_port_alignment')

View File

@ -39,6 +39,6 @@ class rule_400(align_tokens_in_region_between_tokens_unless_between_tokens):
def __init__(self):
super().__init__(lAlign, token.package_body.is_keyword, token.package_body.end_keyword, lUnless)
self.solution = 'Align identifer.'
self.solution = 'Align identifier.'
self.configuration_documentation_link = 'configuring_identifier_alignment_rules_link'
self.configuration.remove('separate_generic_port_alignment')

View File

@ -11,7 +11,7 @@ oEnd = token.component_instantiation_statement.semicolon
class rule_010(remove_comments_from_end_of_lines_bounded_by_tokens):
'''
This rule checks for comments at the end of the port and generic assignments in instantiations.
These comments represent additional maintainence.
These comments represent additional maintenance.
They will be out of sync with the entity at some point.
Refer to the entity for port types, port directions and purpose.

View File

@ -42,6 +42,6 @@ class rule_010(align_tokens_in_region_between_tokens_unless_between_tokens):
def __init__(self):
super().__init__(lAlign, token.subprogram_body.is_keyword, token.subprogram_body.begin_keyword, lUnless)
self.solution = 'Align identifer.'
self.solution = 'Align identifier.'
self.configuration_documentation_link = 'configuring_identifier_alignment_rules_link'
self.configuration.remove('separate_generic_port_alignment')

View File

@ -4,9 +4,9 @@ from vsg.deprecated_rule import Rule
class rule_412(Rule):
'''
This rule has been superceeded by rule `architecture_027 <architecture_rules.html#architecture-027>`_.
This rule has been superseded by rule `architecture_027 <architecture_rules.html#architecture-027>`_.
'''
def __init__(self):
Rule.__init__(self)
self.message.append('Rule ' + self.unique_id + ' has been superceeded by rule architecture_027.')
self.message.append('Rule ' + self.unique_id + ' has been superseded by rule architecture_027.')

View File

@ -18,13 +18,13 @@ class rule_500(token_case):
.. code-block:: vhdl
PROCEDURE_CALL_LABEL : WR_EN(paremeter);
PROCEDURE_CALL_LABEL : WR_EN(parameter);
**Fix**
.. code-block:: vhdl
procedure_call_label : WR_EN(paremeter);
procedure_call_label : WR_EN(parameter);
'''
def __init__(self):

Some files were not shown because too many files have changed in this diff Show More