Project home: https://bues.ch Original repository at: https://git.bues.ch/git/crcgen.git

Michael Buesch c2f1431dea Bump version 3 months ago
libcrcgen c2f1431dea Bump version 3 months ago
maintenance 804da5ded3 Fix release script 3 months ago
.gitignore cca0da812c Update .gitignore 2 years ago
COPYING 55e6f6b691 Initial commit 2 years ago
MANIFEST.in 7843ea9702 Add examples to Readme 3 months ago
README.rst 7843ea9702 Add examples to Readme 3 months ago
crcgen d4496951ff Rename main module to libcrcgen 3 months ago
crcgen_test.py d4496951ff Rename main module to libcrcgen 3 months ago
setup.py 6af398eca5 setup: Update keywords 3 months ago

README.rst

CRC algorithm code generator
============================

This tool generates synthesizable Verilog, VHDL or MyHDL code for use in FPGAs to calculate CRC (Cyclic Redundancy Check) checksums.


Example usage
=============

Display all options:

.. code:: sh

crcgen -h


Generate Verilog code for CRC-32:

.. code:: sh

crcgen -a CRC-32 -v


Generate VHDL code for CRC-32:

.. code:: sh

crcgen -a CRC-32 -V


Generate Verilog code for a custom non-standard CRC or any standard algorithm that's not included in crcgen's -a list:

.. code:: sh

crcgen -P "x^8 + x^7 + x^5 + x^4 + x^2 + x + 1" -B16 -R -v


License
=======

Copyright (c) 2019-2021 Michael Buesch

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.