README

   1                 __   _ __      ______  __
   2                / /  (_) /____ / __/ /_/ /
   3               / /__/ / __/ -_) _// __/ _ \
   4              /____/_/\__/\__/___/\__/_//_/
   5
   6            Copyright 2012-2015 / EnjoyDigital
   7                 florent@enjoy-digital.fr
   8
   9        A small footprint and configurable Ethernet core
  10          with UDP/IP hw stack and Etherbone frontend
  11                   powered by Migen
  12
  13 [> Doc
  14 ---------
  15 HTML : www.enjoy-digital.fr/litex/liteeth/
  16 PDF  : www.enjoy-digital.fr/litex/liteeth.pdf
  17
  18 [> Intro
  19 ---------
  20 LiteEth provides a small footprint and configurable Ethernet core.
  21
  22 LiteEth is part of LiteX libraries whose aims are to lower entry level of
  23 complex FPGA cores by providing simple, elegant and efficient implementations
  24 ofcomponents used in today's SoC such as Ethernet, SATA, PCIe, SDRAM Controller...
  25
  26 The core uses simple and specific streaming buses and will provides in the future
  27 adapters to use standardized AXI or Avalon-ST streaming buses.
  28
  29 Since Python is used to describe the HDL, the core is highly and easily
  30 configurable.
  31
  32 LiteEth uses technologies developed in partnership with M-Labs Ltd:
  33  - Migen enables generating HDL with Python in an efficient way.
  34  - MiSoC provides the basic blocks to build a powerful and small footprint SoC.
  35
  36 LiteEth can be used as a Migen/MiSoC library (by simply installing  it
  37 with the provided setup.py) or can be integrated with your standard design flow
  38 by generating the verilog rtl that you will use as a standard core.
  39
  40 [> Features
  41 -----------
  42 - Ethernet MAC with various interfaces and various PHYs (GMII, MII, Loopback)
  43 - Hardware UDP/IP stack with ARP and ICMP
  44
  45 [> Possible improvements
  46 -------------------------
  47 - add standardized interfaces (AXI, Avalon-ST)
  48 - add DMA interface to MAC
  49 - add RGMII/SGMII PHYs
  50 - ... See below Support and consulting :)
  51
  52 If you want to support these features, please contact us at florent [AT]
  53 enjoy-digital.fr. You can also contact our partner on the public mailing list
  54 devel [AT] lists.m-labs.hk.
  55
  56
  57 [> Getting started
  58 ------------------
  59 1. Install Python3 and your vendor's software
  60
  61 2. Obtain Migen and install it:
  62   git clone https://github.com/m-labs/migen
  63   cd migen
  64   python3 setup.py install
  65   cd ..
  66
  67 Note: in case you have issues with Migen, please retry
  68 with our fork at:
  69   https://github.com/enjoy-digital/misoc
  70 until new features are merged.
  71
  72 3. Obtain LiteScope and install it:
  73   git clone https://github.com/enjoy-digital/litescope
  74   cd litescope
  75   python3 setup.py install
  76   cd ..
  77
  78 4. Obtain LiteEth
  79   git clone https://github.com/enjoy-digital/liteeth
  80
  81 5. Build and load UDP loopback design (only for KC705 for now):
  82   python3 make.py -t udp all
  83
  84 6. Test design (only for KC705 for now):
  85   try to ping 192.168.1.40
  86   go to ./test directory:
  87   change com port in config.py to your com port
  88   run make test_udp
  89
  90 7. Build and load Etherbone design (only for KC705 for now):
  91   python3 make.py -t etherbone all
  92
  93 8. Test design (only for KC705 for now):
  94   try to ping 192.168.1.40
  95   go to ./test directory run:
  96   run make test_etherbone
  97
  98 [> Simulations:
  99   Simulations are available in ./liteth/test/:
 100     - mac_core_tb
 101     - mac_wishbone_tb
 102     - arp_tb
 103     - ip_tb
 104     - icmp_tb
 105     - udp_tb
 106   All ethernet layers have their own model tested against real Ethernet dumps (dumps.py)
 107   To run a simulation, move to ./liteeth/test and run:
 108     make simulation_name
 109
 110 [> Tests :
 111   An UDP loopback example is provided and be controlled with: ./test/test_udp.py
 112   An Etherbone example with Wishbone SRAM is provided and can be controlled with:
 113   ./test/test_etherbone.py
 114
 115 [> License
 116 -----------
 117 LiteEth is released under the very permissive two-clause BSD license. Under
 118 the terms of this license, you are authorized to use LiteEth for closed-source
 119 proprietary designs.
 120 Even though we do not require you to do so, those things are awesome, so please
 121 do them if possible:
 122  - tell us that you are using LiteEth
 123  - cite LiteEth in publications related to research it has helped
 124  - send us feedback and suggestions for improvements
 125  - send us bug reports when something goes wrong
 126  - send us the modifications and improvements you have done to LiteEth.
 127
 128 [> Support and consulting
 129 --------------------------
 130 We love open-source hardware and like sharing our designs with others.
 131
 132 LiteEth is developed and maintained by EnjoyDigital.
 133
 134 If you would like to know more about LiteEth or if you are already a happy
 135 user and would like to extend it for your needs, EnjoyDigital can provide standard
 136 commercial support as well as consulting services.
 137
 138 So feel free to contact us, we'd love to work with you! (and eventually shorten
 139 the list of the possible improvements :)
 140
 141 [> Contact
 142 E-mail: florent [AT] enjoy-digital.fr