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                   developed by EnjoyDigital
  11
  12 [> Intro
  13 ---------
  14 LiteEthernet provides a small footprint and configurable Ethernet core.
  15
  16 LiteEthernet is part of LiteX libraries whose aims are to lower entry level of
  17 complex FPGA IP cores by providing simple, elegant and efficient implementations
  18 ofcomponents used in today's SoC such as Ethernet, SATA, PCIe, SDRAM Controller...
  19
  20 The core uses simple and specific streaming buses and will provides in the future
  21 adapters to use standardized AXI or Avalon-ST streaming buses.
  22
  23 Since Python is used to describe the HDL, the core is highly and easily
  24 configurable.
  25
  26 LiteEthernet uses technologies developed in partnership with M-Labs Ltd:
  27  - Migen enables generating HDL with Python in an efficient way.
  28  - MiSoC provides the basic blocks to build a powerful and small footprint SoC.
  29
  30 LiteEthernet can be used as a Migen/MiSoC library (by simply installing  it
  31 with the provided setup.py) or can be integrated with your standard design flow
  32 by generating the verilog rtl that you will use as a standard core.
  33
  34 [> Features
  35 -----------
  36 - Ethernet MAC with various internface and various PHYs (GMII, MII, Loopback)
  37
  38 [> Possibles improvements
  39 -------------------------
  40 - add standardized interfaces (AXI, Avalon-ST)
  41 - add DMA interface to MAC
  42 - add hardware ARP table
  43 - add hardware IP layer
  44 - add hardware UDP layer
  45 - add hardware Etherbone support
  46 - ... See below Support and Consulting :)
  47
  48 If you want to support these features, please contact us at florent [AT]
  49 enjoy-digital.fr. You can also contact our partner on the public mailing list
  50 devel [AT] lists.m-labs.hk.
  51
  52
  53 [> Getting started
  54 ------------------
  55   XXX
  56
  57 [> Simulations:
  58   XXX
  59
  60 [> Tests :
  61   XXX
  62
  63 [> License
  64 -----------
  65 LiteEthernet is released under the very permissive two-clause BSD license. Under
  66 the terms of this license, you are authorized to use LiteEthernet for closed-source
  67 proprietary designs.
  68 Even though we do not require you to do so, those things are awesome, so please
  69 do them if possible:
  70  - tell us that you are using LiteEthernet
  71  - cite LiteEthernet in publications related to research it has helped
  72  - send us feedback and suggestions for improvements
  73  - send us bug reports when something goes wrong
  74  - send us the modifications and improvements you have done to LiteEthernet.
  75
  76 [> Support and Consulting
  77 --------------------------
  78 We love open-source hardware and like sharing our designs with others.
  79
  80 LiteEthernet is developed and maintained by EnjoyDigital.
  81
  82 If you would like to know more about LiteEthernet or if you are already a happy
  83 user and would like to extend it for your needs, EnjoyDigital can provide standard
  84 commercial support as well as consulting services.
  85
  86 So feel free to contact us, we'd love to work with you! (and eventually shorten
  87 the list of the possible improvements :)
  88
  89 [> Contact
  90 E-mail: florent [AT] enjoy-digital.fr