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

          Copyright 2015 / EnjoyDigital

      A small footprint and configurable USB core
                powered by Migen

[> Intro
--------
LiteUSB provides a small footprint and configurable USB core.

LiteUSB 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...

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.

LiteUSB 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.

LiteUSB 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
-----------
- FTDI2232 slave fifo core (DMA, virtual TTY) + host software

[> Possible improvements
------------------------
- add Cypress FX2 support
- add Cypress FX3 support
- add USB3 transceiver support and use Daisho's USB3 stack?
- ... 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. TODO: add example design(s)

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

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

LiteUSB is developed and maintained by EnjoyDigital.

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