... | ... | @@ -4,16 +4,16 @@ |
|
|
|
|
|
## Intro
|
|
|
|
|
|
Current Master is a great job with great improvements over previous
|
|
|
Current Master is a great job with powerful improvements over previous
|
|
|
hdlmake releases, but it remains unstable and most of the projects in
|
|
|
OHR rely on the older ISYP/v1.0 versions.
|
|
|
|
|
|
Bring the current Master to a stable and well documented status is the
|
|
|
primary target of this action.
|
|
|
Bringing the current Master to a stable and well documented status is
|
|
|
the primary target of the action covered by this document.
|
|
|
|
|
|
This wiki page is a working document containing the outcomes derived
|
|
|
from the analysis/test of the Master hdlmake and a set of proposals
|
|
|
intended to improve and stabilize the hdlmake tool.
|
|
|
This wiki page contains the outcomes derived from the analysis of the
|
|
|
Master branch current status and a set of proposals intended to improve
|
|
|
and stabilize the hdlmake tool.
|
|
|
|
|
|
### Repository
|
|
|
|
... | ... | @@ -43,7 +43,7 @@ are ISYP related. |
|
|
as System Verilog.
|
|
|
- **hdlmake\_quick\_start.pdf**: this is old, related with ISYP.
|
|
|
|
|
|
The source file in La(tex) format.
|
|
|
It also includes a document source file in La(tex) format.
|
|
|
|
|
|
- **hdlmake.tex**: this is supposed to be the actual user document
|
|
|
specific for current Master code, but it seems to be targeted to
|
... | ... | @@ -54,25 +54,22 @@ The source file in La(tex) format. |
|
|
The ISYP and current Masted related info is mixed across the wiki.
|
|
|
|
|
|
- [Manifest-variables-description](Manifest-variables-description):
|
|
|
this is from ISYP. Some of the critical variables for current Master
|
|
|
are not listed: e.g. syn\_tool
|
|
|
this content is from ISYP. Some of the critical variables for
|
|
|
current Master are not listed: e.g. syn\_tool
|
|
|
- [Run-arguments-summary](Run-arguments-summary): the argument syntax
|
|
|
is from ISYP, but the argument set doesn't match with the actual
|
|
|
code/binary.
|
|
|
|
|
|
### Proposal
|
|
|
|
|
|
Separation between older releases stuff and current master.
|
|
|
|
|
|
- Compile all the stuff related with ISYP/v1.0 and set a clear wiki
|
|
|
section for this stuff.
|
|
|
- Write a new user document in both wiki and texinfo.
|
|
|
- Write a new user documentation for Master in texinfo format:
|
|
|
- Complete feature list and related parameters/arguments/options.
|
|
|
- Full set of example tutorials covering the most important
|
|
|
features.
|
|
|
|
|
|
*Developer doc**: Include python comments and a Python generation
|
|
|
(tested with "epydoc").
|
|
|
- Generate developer doc by using a standard code documentation tool
|
|
|
(Epydoc or Sphinx)
|
|
|
|
|
|
## Demos
|
|
|
|
... | ... | @@ -227,9 +224,9 @@ included in master and follows an older software design (2 years old). |
|
|
In order to generate an ISE or a Quartus project, the device family is
|
|
|
required. In the current master, the family support is very limited.
|
|
|
|
|
|
The way in wich xise calculates the family requires a constant database
|
|
|
update as new device families are introduced in the market (e.g. Zynq
|
|
|
family)
|
|
|
The way in which hdlmake calculates the family requires a constant
|
|
|
database update as new device families are introduced in the market
|
|
|
(e.g. Zynq family).
|
|
|
|
|
|
Some naming schemes are not supported in the current automatic
|
|
|
calculation (e.g. Spartan3E, Spartan3AN...). A more complex mechanism is
|
... | ... | @@ -237,7 +234,7 @@ required in order to manage some devices. Even worse, if new naming |
|
|
schemes are introduced in the future, the algorithm will need to be
|
|
|
upgraded again.
|
|
|
|
|
|
### Xilinx
|
|
|
### Xilinx supported families
|
|
|
|
|
|
<table>
|
|
|
<tbody>
|
... | ... | @@ -276,7 +273,7 @@ upgraded again. |
|
|
</tbody>
|
|
|
</table>
|
|
|
|
|
|
### Altera
|
|
|
### Altera supported families
|
|
|
|
|
|
<table>
|
|
|
<tbody>
|
... | ... | @@ -308,7 +305,8 @@ upgraded again. |
|
|
|
|
|
## New Features
|
|
|
|
|
|
Current status?
|
|
|
These are the new features that are listed as not or partially
|
|
|
implemented in the following wiki entry: [NewFeatures](NewFeatures).
|
|
|
|
|
|
<table>
|
|
|
<tbody>
|
... | ... | @@ -351,18 +349,25 @@ Current status? |
|
|
</tbody>
|
|
|
</table>
|
|
|
|
|
|
### Proposal
|
|
|
|
|
|
- Implement the new features
|
|
|
|
|
|
## Issues
|
|
|
|
|
|
Some of the issues marked as solved are not applied in master -- may
|
|
|
they be on a branch?.
|
|
|
|
|
|
The following are a couple of examples I've already fixed in 2014
|
|
|
The following are a couple of examples that are now fixed in 2014
|
|
|
branch:
|
|
|
|
|
|
e.g. Binary configuration file generation \#637
|
|
|
e.g. Add binary configuration file generation property in synthesis
|
|
|
\#637
|
|
|
|
|
|
e.g. Hierachy Separator property. This was reported to the mailing list
|
|
|
but a issue was not filled. Current status is not solved.
|
|
|
|
|
|
Should we re-check issues?
|
|
|
### Proposal
|
|
|
|
|
|
- Mantain the current status and reopen
|
|
|
|