liteeth/README

                __   _ __      ______  __
               / /  (_) /____ / __/ /_/ /
              / /__/ / __/ -_) _// __/ _ \
             /____/_/\__/\__/___/\__/_//_/

           Copyright 2012-2015 / EnjoyDigital

       A small footprint and configurable Ethernet core
         with UDP/IP hw stack and Etherbone frontend
                  powered by Migen

[> Intro
---------
LiteEth provides a small footprint and configurable Ethernet core.

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

The core uses simple and specific streaming buses and will provides in the future
adapters to use standardized AXI or Avalon-ST streaming buses.

Since Python is used to describe the HDL, the core is highly and easily
configurable.

LiteEth is built using LiteX and uses technologies developed in partnership with
M-Labs Ltd:
 - Migen enables generating HDL with Python in an efficient way.
 - MiSoC provides the basic blocks to build a powerful and small footprint SoC.

LiteEth 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
------------
- Ethernet MAC with various interfaces and various PHYs (GMII, MII, RGMII, etc)
- Hardware UDP/IP stack with ARP and ICMP
- lwIP and uIP TCP/IP stacks ported and tested on lm32 and mor1kx

[> FPGA Proven
---------------
LiteEth is already used in commercial and open-source designs:
- MiSoC: http://m-labs.hk/gateware.html
- ARTIQ: http://m-labs.hk/artiq/index.html
- HDMI2USB: http://hdmi2usb.tv/home/
- and others commercial designs...

[> Possible improvements
-------------------------
- optimize ressources on HW ICMP and Etherbone (parameters buffering)
- add standardized interfaces (AXI, Avalon-ST)
- add DMA interface to MAC
- add RGMII/SGMII PHYs
- add more documentation
- ... See below Support and consulting :)

If you want to support these features, please contact us at florent [AT]
enjoy-digital.fr. You can also contact our partner on the public mailing list
devel [AT] lists.m-labs.hk.


[> Getting started
-------------------
1. Install Python3 and your vendor's software

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

3. Build and load UDP loopback design (only for KC705 for now):
  go to example_designs/
  run ./make.py -t udp all load-bitstream

4. Test design (only for KC705 for now):
  try to ping 192.168.1.50
  go to example_designs/test/
  run ./test_udp.py

5. Build and load Etherbone design (only for KC705 for now):
  python3 make.py -t etherbone all load-bitstream

6. Test design (only for KC705 for now):
  try to ping 192.168.1.50
  go to example_designs/test/
  run ./test_etherbone.py

[> Simulations
---------------
  Simulations are available in test/:
    - mac_core_tb
    - mac_wishbone_tb
    - arp_tb
    - ip_tb
    - icmp_tb
    - udp_tb
  All ethernet layers have their own model tested against real ethernet dumps (dumps.py)
  To run a simulation:
    go to test/
    make <simulation_name>

[> Tests
---------
  An Etherbone example with Wishbone SRAM and an UDP loopback example are provided.
  Please goto to Getting Started section to see how to run the tests.

[> License
-----------
LiteEth is released under the very permissive two-clause BSD license. Under
the terms of this license, you are authorized to use LiteEth 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 LiteEth
 - cite LiteEth 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 LiteEth.

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

LiteEth is mainly developed and maintained by EnjoyDigital.

If you would like to know more about LiteEth 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