... | @@ -56,21 +56,21 @@ complex modules. |
... | @@ -56,21 +56,21 @@ complex modules. |
|
- Follow the naming convention from the
|
|
- Follow the naming convention from the
|
|
[guidelines](https://www.ohwr.org/project/hdl-core-lib/wikis/Documents/VHDL-coding-guidelines), at minimum check
|
|
[guidelines](https://www.ohwr.org/project/hdl-core-lib/wikis/Documents/VHDL-coding-guidelines), at minimum check
|
|
that
|
|
that
|
|
- the inputs/outputs signals in your module(s) finish with
|
|
- the names of inputs/output signals of your module(s) finish with
|
|
\_i/\_o, bidirectional with \_b, asynchronous signals have \_a
|
|
"\_i"/"\_o", bidirectional with "\_b", asynchronous signals have
|
|
before \_i/\_o/\_b in their names, and pulses have *pX* in their
|
|
"*a*" before "\_i"/"\_o"/"\_b", and pulses have "*pX*" in their
|
|
names(where X is the width of the pulse, e.g. single-cycle pulse
|
|
names (where X is the width of the pulse, e.g. single-cycle
|
|
should have \_p1 in its name)
|
|
pulse should have \_p1 in its name)
|
|
- do not end names of the signals in your modules with *i/\_o/\_b
|
|
- the names of the signals inside your module(s) do not finish
|
|
and do not begin signal names with s* (the optional naming
|
|
with "\_i"/"\_o"/"*b" and do not begin with "s*" (the optional
|
|
convention from the guidelines that is not recommended)
|
|
naming convention from the guidelines that is not recommended)
|
|
- whenever it is known/fixed, indicate the clock frequency in its
|
|
- whenever it is known/fixed, indicate the clock frequency in its
|
|
name, i.e.: clk\_125m\_pllref, clk\_80m\_ADC, clk\_20m\_vcxo\_i
|
|
name, i.e.: clk\_125m\_pllref, clk\_80m\_ADC, clk\_20m\_vcxo\_i
|
|
- make sure that only needed signals are in sensitivity list of a
|
|
- make sure that only needed signals are in sensitivity list of a
|
|
process (e.g. if you use process with synchronous reset, make
|
|
process (e.g. if you use process with synchronous reset, make sure
|
|
sure reset is not in sensitivity list)
|
|
reset is not in sensitivity list)
|
|
- do not use "new" and "old" in the names (the new will become old
|
|
- do not use "new" and "old" in the names (the new will become old
|
|
very fast and the name will mean nothing)
|
|
very fast and the name will mean nothing)
|
|
- before starting to implement a module/function that is not specific
|
|
- before starting to implement a module/function that is not specific
|
|
to your project (say, it deals with Endianess or calculate CRC,
|
|
to your project (say, it deals with Endianess or calculate CRC,
|
|
check whether such a function is already in general-cores)
|
|
check whether such a function is already in general-cores)
|
... | | ... | |