add README skeleton
This commit is contained in:
Florent Kermarrec
commit
4bdb1ffda2
|
|
@ -0,0 +1,28 @@
|
|||
Unless otherwise noted, LiteUSB is copyright (C) 2015 Florent Kermarrec.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without modification,
|
||||
are permitted provided that the following conditions are met:
|
||||
|
||||
1. Redistributions of source code must retain the above copyright notice, this
|
||||
list of conditions and the following disclaimer.
|
||||
2. Redistributions in binary form must reproduce the above copyright notice,
|
||||
this list of conditions and the following disclaimer in the documentation
|
||||
and/or other materials provided with the distribution.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
||||
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
||||
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
|
||||
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
||||
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
||||
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
|
||||
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
||||
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
|
||||
Other authors retain ownership of their contributions. If a submission can
|
||||
reasonably be considered independently copyrightable, it's yours and we
|
||||
encourage you to claim it with appropriate copyright notices. This submission
|
||||
then falls under the "otherwise noted" category. All submissions are strongly
|
||||
encouraged to use the two-clause BSD license reproduced above.
|
||||
|
|
@ -0,0 +1,91 @@
|
|||
__ _ __ __ _________
|
||||
/ / (_) /____ / / / / __/ _ )
|
||||
/ /__/ / __/ -_) /_/ /\ \/ _ |
|
||||
/____/_/\__/\__/\____/___/____/
|
||||
|
||||
Copyright 2015 / EnjoyDigital
|
||||
florent@enjoy-digital.fr
|
||||
|
||||
A small footprint and configurable USB core
|
||||
powered by Migen
|
||||
|
||||
[> Doc
|
||||
---------
|
||||
XXX
|
||||
|
||||
[> 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 IP cores by providing simple, elegant and efficient implementations
|
||||
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.
|
||||
|
||||
LiteUSB 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 a Migen/MiSoC library (by simply installing it
|
||||
with the provided setup.py) 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
|
||||
------------------
|
||||
XXX
|
||||
|
||||
[> Simulations:
|
||||
XXX
|
||||
|
||||
[> Tests :
|
||||
XXX
|
||||
|
||||
[> 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
|
||||
Loading…
Reference in New Issue