litex/misoclib/com/liteeth/README

128 lines
4.3 KiB
Plaintext
Raw Normal View History

__ _ __ ______ __
/ / (_) /____ / __/ /_/ /
/ /__/ / __/ -_) _// __/ _ \
/____/_/\__/\__/___/\__/_//_/
2015-01-27 17:46:15 -05:00
2015-02-28 12:13:57 -05:00
Copyright 2012-2015 / EnjoyDigital / M-Labs Ltd
2015-01-27 17:46:15 -05:00
A small footprint and configurable Ethernet core
2015-02-12 15:39:34 -05:00
with UDP/IP hw stack and Etherbone frontend
2015-02-18 10:38:48 -05:00
powered by Migen
2015-01-27 17:46:15 -05:00
2015-02-09 17:05:59 -05:00
[> Doc
---------
2015-02-28 12:13:57 -05:00
HTML : www.enjoy-digital.fr/liteeth/
PDF : www.enjoy-digital.fr/liteeth.pdf
2015-02-09 17:05:59 -05:00
2015-01-27 17:46:15 -05:00
[> Intro
---------
LiteEth provides a small footprint and configurable Ethernet core.
2015-01-27 17:46:15 -05:00
2015-02-28 12:13:57 -05:00
LiteEth is part of MiSoC libraries whose aims are to lower entry level of
2015-02-21 17:33:21 -05:00
complex FPGA cores by providing simple, elegant and efficient implementations
2015-01-27 17:46:15 -05:00
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 uses technologies developed in partnership with M-Labs Ltd:
2015-01-27 17:46:15 -05:00
- Migen enables generating HDL with Python in an efficient way.
- MiSoC provides the basic blocks to build a powerful and small footprint SoC.
2015-02-28 12:13:57 -05:00
LiteEth can be used as MiSoC library or can be integrated with your standard
design flow by generating the verilog rtl that you will use as a standard core.
2015-01-27 17:46:15 -05:00
[> Features
-----------
- Ethernet MAC with various interfaces and various PHYs (GMII, MII, Loopback)
2015-02-09 17:05:59 -05:00
- Hardware UDP/IP stack with ARP and ICMP
2015-01-27 17:46:15 -05:00
2015-02-12 15:39:34 -05:00
[> Possible improvements
2015-01-27 17:46:15 -05:00
-------------------------
- add standardized interfaces (AXI, Avalon-ST)
- add DMA interface to MAC
2015-02-09 13:35:42 -05:00
- add RGMII/SGMII PHYs
2015-02-12 15:39:34 -05:00
- ... See below Support and consulting :)
2015-01-27 17:46:15 -05:00
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
------------------
2015-02-12 15:39:34 -05:00
1. Install Python3 and your vendor's software
2015-02-09 13:35:42 -05:00
2015-02-12 15:39:34 -05:00
2. Obtain Migen and install it:
git clone https://github.com/m-labs/migen
2015-02-09 13:35:42 -05:00
cd migen
python3 setup.py install
cd ..
2015-02-28 12:13:57 -05:00
3. Obtain MiSoC:
git clone https://github.com/m-labs/misoc --recursive
2015-02-12 15:39:34 -05:00
2015-02-28 12:13:57 -05:00
4. Build and load UDP loopback design (only for KC705 for now):
go to misoclib/com/liteeth/example_designs/
run ./make.py -t udp all load-bitstream
2015-02-09 13:35:42 -05:00
2015-02-28 12:13:57 -05:00
5. Test design (only for KC705 for now):
try to ping 192.168.0.42
2015-02-28 12:13:57 -05:00
go to [..]/example_designs/test/
run ./make.py test_udp
2015-02-12 15:39:34 -05:00
2015-02-28 12:13:57 -05:00
6. Build and load Etherbone design (only for KC705 for now):
python3 make.py -t etherbone all load-bitstream
2015-02-12 15:39:34 -05:00
2015-02-28 12:13:57 -05:00
7. Test design (only for KC705 for now):
try to ping 192.168.0.42
2015-02-28 12:13:57 -05:00
go to [..]/example_designs/test/
run ./make.py test_etherbone
2015-01-27 17:46:15 -05:00
[> Simulations:
2015-02-28 12:13:57 -05:00
Simulations are available in misoclib/com/liteeth/test/:
2015-02-09 13:35:42 -05:00
- mac_core_tb
- mac_wishbone_tb
- arp_tb
- ip_tb
- icmp_tb
- udp_tb
2015-02-28 12:13:57 -05:00
All ethernet layers have their own model tested against real ethernet dumps (dumps.py)
To run a simulation, move to misoclib/com/liteeth/test/ and run:
2015-02-09 13:35:42 -05:00
make simulation_name
2015-01-27 17:46:15 -05:00
[> Tests :
2015-02-28 12:13:57 -05:00
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.
2015-01-27 17:46:15 -05:00
[> 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
2015-01-27 17:46:15 -05:00
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
2015-01-27 17:46:15 -05:00
- 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.
2015-01-27 17:46:15 -05:00
2015-02-12 15:39:34 -05:00
[> Support and consulting
2015-01-27 17:46:15 -05:00
--------------------------
We love open-source hardware and like sharing our designs with others.
2015-02-28 12:13:57 -05:00
LiteEth is mainly developed and maintained by EnjoyDigital.
2015-01-27 17:46:15 -05:00
If you would like to know more about LiteEth or if you are already a happy
2015-01-27 17:46:15 -05:00
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