GitHub - sirop/hostmot2-firmware: HostMot2 FPGA firmware

Branches Tags

Name		Name	Last commit message	Last commit date
Latest commit History 168 Commits
debian		debian
scripts		scripts
.gitignore		.gitignore
4i65.ucf		4i65.ucf
4i65ss.ucf		4i65ss.ucf
4i68.ucf		4i68.ucf
4i69.ucf		4i69.ucf
4i74.ucf		4i74.ucf
5i20.ucf		5i20.ucf
5i20ss.ucf		5i20ss.ucf
5i21.ucf		5i21.ucf
5i22.ucf		5i22.ucf
5i23.ucf		5i23.ucf
5i24.ucf		5i24.ucf
5i25.ucf		5i25.ucf
6i25.ucf		6i25.ucf
7i43.ucf		7i43.ucf
7i43u.ucf		7i43u.ucf
7i61.ucf		7i61.ucf
7i61p.ucf		7i61p.ucf
7i61u.ucf		7i61u.ucf
7i68.ucf		7i68.ucf
7i76e.ucf		7i76e.ucf
7i80db.ucf		7i80db.ucf
7i80hd.ucf		7i80hd.ucf
7i90.ucf		7i90.ucf
7i90serhm2.ucf		7i90serhm2.ucf
7i90spi.ucf		7i90spi.ucf
7i90ssremote.ucf		7i90ssremote.ucf
7i91spi.ucf		7i91spi.ucf
CountPinsInRange.vhd		CountPinsInRange.vhd
DESCRIBE		DESCRIBE
IDROMConst.vhd		IDROMConst.vhd
InputPinsPerModule.vhd		InputPinsPerModule.vhd
Makefile		Makefile
MaxIOPinsPerModule.vhd		MaxIOPinsPerModule.vhd
MaxInputPinsPerModule.vhd		MaxInputPinsPerModule.vhd
MaxOutputPinsPerModule.vhd		MaxOutputPinsPerModule.vhd
MaxPinsPerModule.vhd		MaxPinsPerModule.vhd
ModuleExists.vhd		ModuleExists.vhd
NumberOfModules.vhd		NumberOfModules.vhd
OutputInteg.vhd		OutputInteg.vhd
PIN_24XQCTRONLY_72.vhd		PIN_24XQCTRONLY_72.vhd
PIN_2X7I65_72.vhd		PIN_2X7I65_72.vhd
PIN_2X7I65_7I44_72.vhd		PIN_2X7I65_7I44_72.vhd
PIN_3x7I65_1x7I44_96.vhd		PIN_3x7I65_1x7I44_96.vhd
PIN_4x7I65_96.vhd		PIN_4x7I65_96.vhd
PIN_7I65_7I44_72.vhd		PIN_7I65_7I44_72.vhd
PIN_7I74_7I76_34.vhd		PIN_7I74_7I76_34.vhd
PIN_7I74_7I77_34.vhd		PIN_7I74_7I77_34.vhd
PIN_7I74x2_34.vhd		PIN_7I74x2_34.vhd
PIN_7I74x4_68.vhd		PIN_7I74x4_68.vhd
PIN_7I76E_51.vhd		PIN_7I76E_51.vhd
PIN_7I76P_7I76_34.vhd		PIN_7I76P_7I76_34.vhd
PIN_7I76_34.vhd		PIN_7I76_34.vhd
PIN_7I76_7I74_34.vhd		PIN_7I76_7I74_34.vhd
PIN_7I76_7I78_34.vhd		PIN_7I76_7I78_34.vhd
PIN_7I76_7I85S_34.vhd		PIN_7I76_7I85S_34.vhd
PIN_7I76_7I85_34.vhd		PIN_7I76_7I85_34.vhd
PIN_7I76x2R_34.vhd		PIN_7I76x2R_34.vhd
PIN_7I76x2_34.vhd		PIN_7I76x2_34.vhd
PIN_7I76x2_7I74x2_68.vhd		PIN_7I76x2_7I74x2_68.vhd
PIN_7I76x2_7I77x2_68.vhd		PIN_7I76x2_7I77x2_68.vhd
PIN_7I76x2_biss_34.vhd		PIN_7I76x2_biss_34.vhd
PIN_7I76x2_ssi_34.vhd		PIN_7I76x2_ssi_34.vhd
PIN_7I76x3_68.vhd		PIN_7I76x3_68.vhd
PIN_7I76x3_7I74_68.vhd		PIN_7I76x3_7I74_68.vhd
PIN_7I77E_51.vhd		PIN_7I77E_51.vhd
PIN_7I77_72.vhd		PIN_7I77_72.vhd
PIN_7I77_7I74_34.vhd		PIN_7I77_7I74_34.vhd
PIN_7I77_7I74_34_toromatic.vhd		PIN_7I77_7I74_34_toromatic.vhd
PIN_7I77_7I74_SSI_34.vhd		PIN_7I77_7I74_SSI_34.vhd
PIN_7I77_7I74_SSI_FANUC_34.vhd		PIN_7I77_7I74_SSI_FANUC_34.vhd
PIN_7I77_7I76P_34.vhd		PIN_7I77_7I76P_34.vhd
PIN_7I77_7I76_34.vhd		PIN_7I77_7I76_34.vhd
PIN_7I77_7I78_34.vhd		PIN_7I77_7I78_34.vhd
PIN_7I77_7I85SP_34.vhd		PIN_7I77_7I85SP_34.vhd
PIN_7I77_SSI_7I74_34.vhd		PIN_7I77_SSI_7I74_34.vhd
PIN_7I77x2R_34.vhd		PIN_7I77x2R_34.vhd
PIN_7I77x2_34.vhd		PIN_7I77x2_34.vhd
PIN_7I77x2_7I74x2_68.vhd		PIN_7I77x2_7I74x2_68.vhd
PIN_7I77x2_ssi_34.vhd		PIN_7I77x2_ssi_34.vhd
PIN_7I77x4_68.vhd		PIN_7I77x4_68.vhd
PIN_7I78_34.vhd		PIN_7I78_34.vhd
PIN_7I78x2_34.vhd		PIN_7I78x2_34.vhd
PIN_7I85SPx2_34.vhd		PIN_7I85SPx2_34.vhd
PIN_7I85Sx2_34.vhd		PIN_7I85Sx2_34.vhd
PIN_7I85Sx7I78_34.vhd		PIN_7I85Sx7I78_34.vhd
PIN_7I85x2_34.vhd		PIN_7I85x2_34.vhd
PIN_7I90SPIHost_72.vhd		PIN_7I90SPIHost_72.vhd
PIN_Andy1_72.vhd		PIN_Andy1_72.vhd
PIN_BASACKWARDS_SVSS6_8_72.vhd		PIN_BASACKWARDS_SVSS6_8_72.vhd
PIN_BI1_72.vhd		PIN_BI1_72.vhd
PIN_BISSTEST_34.vhd		PIN_BISSTEST_34.vhd
PIN_BOSSV.vhd		PIN_BOSSV.vhd
PIN_DA2_72.vhd		PIN_DA2_72.vhd
PIN_DA2_ADO_72.vhd		PIN_DA2_ADO_72.vhd
PIN_DMMBOB1x2_34.vhd		PIN_DMMBOB1x2_34.vhd
PIN_FA1_72.vhd		PIN_FA1_72.vhd
PIN_FALLBACK_34.vhd		PIN_FALLBACK_34.vhd

Repository files navigation

hostmot2-firmware: build assorted hostmot2 FPGA firmwares automatically

== Overview ==

This package includes the hostmot2 source files along with Makefiles and
other scripts to automatically build all the desired variants of the
firmwares.

It requires the no-cost version of Xilinx ISE. I build with ISE 9.2. This
version supports all FPGAs on Mesa cards with the exception of the 3x20-2M.
Newer versions appear to work, but with caveats (see below)

It also requires ghdl for building PIN and xml files. The PIN file
format is intended to be human readable (not machine readable) so it is
not a requirement that it exactly match the format of existing PIN
files. There is also an experimental xml description format.

== ISE Version Requirements

Refer to `cards.py` for information about required ISE versions for
particular cards. Currently, by installing ISE 13.4 and ISE 9.2, firmware
can be built for all supported cards.

=== Obtaining ISE 9.2 WebPack ===

Xilinx still offers older versions of ISE free of charge. At the time
of writing, the location is
http://www.xilinx.com/webpack/classics/wpclassic/index.htm
and can also be reached from the xilinx.com front page by going to
"Products & Services", "Design Tools", "Logic Design Tools", "ISE
Classics", "Previous versions of ISE WebPack".

== Building ==

If necessary, create a set of symlinks to the required versions of ise. For
32-bit versions up to 13.3 installed to /opt, settings will generally be found
automatically. If they are not, you can create symlinks e.g.,
settings9.sh -> /opt/Xilinx19/settings32.sh
settings13.sh -> /opt/Xilinx13.4/settings32.sh

To build all bitfiles, pinfiles, and xmlfiles:
make -j4 # -j setting depends on RAM and # CPU cores
On my system (quad core AMD Phenom 9600) building the full set of
firmwares took about 75 minutes wall time with the -j4 setting shown
above.

To build just a subset of firmwares, create a file `firmwares-local.txt` to list the firmware(s) you want to build.
This list is used instead of the list in `firmwares.txt`.
The first word in each line specifies the hostmot2 card, and the remaining words specify the pinfiles.
For example, to build just the 'SV12' firmware for the '5i23' card, put just this line in 'firmwares-local.txt':
i23 SV12

To build Debian packages:
debian/gencontrol
export MAKEFLAGS=-j4 dpkg-buildpackage
# -j setting depends on RAM and # CPU cores

To build tar packages (must be in a git checkout):
make -j4 # -j setting depends on RAM and # CPU cores
make dist
# or make dist-force if your working tree is dirty

== Testing ==

A representative firmware for each supported board type has been tested:
* 5i20, 5i22-1M, 5i23 (PCI)
* 7i43-400 (EPP)
* 3x20-1M (PCI-Express)
* 4i65, 4i68 (PC104+)
The 5i22-1.5M and 7i43-200 are not tested, but are expected to work.

== Incorporating new upstream source ==

Primary development of the hostmot2 fpga firmware is done by Mesa Electronics, who releases source in .zip format.
This repository integrates that source with a Linux-centric build infrastructure to produce Debian packages.
When incorporating upstream changes from Mesa, the following procedure should be used:
1. Put the new source code release on the "upstream" branch as a single large commit
1. Merge upstream and master into a (possibly local) testing branch
1. Make additional commits to add new card support, adjust for changed filenames, etc
1. Test on a representative set of boards
1. When the result of testing is satisfactory, merge to master branch. Push new master and upstream branches to git.linuxcnc.org.

In the rare cases that we make a change to a .vhd, .pin, or other file that comes from Mesa, this strategy with an upstream branch lets us retain that change
(or have it appear as a merge conflict, if it cannot be automatically applied),
instead of losing it when we receive a new set of base source files.