README

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