litejesd204b by enjoy-digital

     __   _ __         _____________  ___  ___  ____ ___
    / /  (_) /____ __ / / __/ __/ _ \|_  |/ _ \/ / // _ )
   / /__/ / __/ -_) // / _/_\ \/ // / __// // /_  _/ _  |
  /____/_/\__/\__/\___/___/___/____/____/\___/ /_//____/

             Copyright 2016-2018 / EnjoyDigital
             Copyright 2016-2018 / M-Labs Ltd

    A small footprint and configurable JESD204B core
                powered by LiteX & Migen

[> Intro
--------
LiteJESD204B provides a small footprint and configurable JESD204B core.

LiteJESD204B is part of LiteX libraries whose aims are to lower entry level of
complex FPGA cores by providing simple, elegant and efficient implementations
of components used in today's SoC such as Ethernet, SATA, PCIe, SDRAM Controller...

Using Migen to describe the HDL allows the core to be highly and easily configurable.

LiteJESD204B can be used as LiteX library or can be integrated with your standard
design flow by generating the verilog rtl that you will use as a standard core.

[> Features
-----------
PHY:
 - PRBS7/PRBS15/PRBS31 to check link integrity.
 - 8B/10B encoding
 - 32 bits interface
 - Kintex7 support (CPLL up to 5Gbps, QPLL for higher linerates)
 - Kintex Ultrascale support (CPLL up to 6.25Gbps, QPLL for higher linerates)
Core:
 Link:
  - Scrambling to reduce EMI
  - Special characters insertion
  - CGS/ILAS
 Transport:
  - converters <--> lanes mapping

[> FPGA Proven
---------------
LiteDRAM is already used in commercial and open-source designs:
- ARTIQ: http://m-labs.hk/artiq/index.html
- and others commercial designs...

[> Possible improvements
------------------------
- add support for RX (ADC)
- add support for non scrambled mode
- add support for Altera PHYs
- add support for Lattice PHYs
- add support for others Xilinx transceivers
- ... See below Support and consulting :)

If you want to support these features, please contact us at florent [AT]
enjoy-digital.fr.

[> Getting started
------------------
1. Install Python 3.5, Migen and FPGA vendor's development tools.
   Get Migen from: https://github.com/m-labs/migen

2. Obtain LiteX and install it:
  git clone https://github.com/enjoy-digital/litex --recursive
  cd litex
  python3 setup.py develop
  cd ..

3. TODO: add/describe examples

[> Tests
--------
Unit tests are available in ./test/.
To run all the unit tests:
  ./setup.py test
Tests can also be run individually:
  python3 -m unittest test.test_name

[> License
----------
LiteJESD204B is released under the very permissive two-clause BSD license. Under
the terms of this license, you are authorized to use LiteJESD204B for closed-source
proprietary designs.
Even though we do not require you to do so, those things are awesome, so please
do them if possible:
 - tell us that you are using LiteJESD204B
 - cite LiteJESD204B in publications related to research it has helped
 - send us feedback and suggestions for improvements
 - send us bug reports when something goes wrong
 - send us the modifications and improvements you have done to LiteJESD204B.

[> Support and consulting
-------------------------
We love open-source hardware and like sharing our designs with others.

LiteJESD204B is developed and maintained by EnjoyDigital.

If you would like to know more about LiteJESD204B or if you are already a happy user
and would like to extend it for your needs, EnjoyDigital can provide standard
commercial support as well as consulting services.

So feel free to contact us, we'd love to work with you! (and eventually shorten
the list of the possible improvements :)

[> Contact
----------
E-mail: florent [AT] enjoy-digital.fr