README

   1              __   _ __      ____
   2             / /  (_) /____ / __/______  ___  ___
   3            / /__/ / __/ -_)\ \/ __/ _ \/ _ \/ -_)
   4           /____/_/\__/\__/___/\__/\___/ .__/\__/
   5                                      /_/
   6            Copyright 2012-2015 / EnjoyDigital
   7                 florent@enjoy-digital.fr
   8
   9        A small footprint and configurable embedded FPGA
  10          logic analyzer core developed by EnjoyDigital
  11
  12 [> Doc
  13 ---------
  14 HTML : www.enjoy-digital.fr/litex/litescope/
  15 PDF  : www.enjoy-digital.fr/litex/litescope.pdf
  16
  17 [> Intro
  18 ---------
  19 LiteScope is small footprint and configurable embedded logic analyzer that you
  20 can use in your FPGA and aims to provide a a free, portable and flexible
  21 alternatve to vendor's solutions!
  22
  23 LiteScope is part of LiteX libraries whose aims are to lower entry level of complex
  24 FPGA IP cores by providing simple, elegant and efficient implementations of
  25 components used in today's SoC such as Ethernet, SATA, PCIe, SDRAM Controller...
  26
  27 The core uses simple and specific streaming buses and will provides in the future
  28 adapters to use standardized AXI or Avalon-ST streaming buses.
  29
  30 Since Python is used to describe the HDL, the core is highly and easily
  31 configurable.
  32
  33 LiteScope uses technologies developed in partnership with M-Labs Ltd:
  34  - Migen enables generating HDL with Python in an efficient way.
  35  - MiSoC provides the basic blocks to build a powerful and small footprint SoC.
  36
  37 LiteScope can be used as a Migen/MiSoC library (by simply installing  it
  38 with the provided setup.py) or can be integrated with your standard design flow
  39 by generating the verilog rtl that you will use as a standard core.
  40
  41 LiteScope produces "vcd" files that can be read in your regular waveforms viewer.
  42
  43 Since LiteScope also provides a UART <--> Wishbone brige so you only need 2
  44 external Rx/Tx pins to be ready to debug or control all your Wishbone peripherals!
  45
  46 [> Features
  47 -----------
  48 - IO peek and poke with LiteScopeIO
  49 - Logic analyser with LiteScopeLA:
  50   - Various triggering modules: Term, Range, Edge (add yours! :)
  51   - Run Length Encoder to "compress" data and increase recording depth
  52   - Subsampling
  53   - Storage qualifier
  54   - Data storage in block rams
  55
  56 [> Possible improvements
  57 -------------------------
  58 - add standardized interfaces (AXI, Avalon-ST)
  59 - add protocols analyzers
  60 - add signals injection/generation
  61 - add storage in DRAM
  62 - add storage in HDD with LiteSATA core (to be released soon!)
  63 - add Ethernet Wishbone bridge
  64 - add PCIe Wishbone bridge with LitePCIe (to be released soon!)
  65 - ... See below Support and consulting :)
  66
  67 If you want to support these features, please contact us at florent [AT]
  68 enjoy-digital.fr. You can also contact our partner on the public mailing list
  69 devel [AT] lists.m-labs.hk.
  70
  71
  72 [> Getting started
  73 ------------------
  74 1. Install Python3 and your vendor's software
  75
  76 2. Obtain Migen and install it:
  77   git clone https://github.com/m-labs/migen
  78   cd migen
  79   python3 setup.py install
  80   cd ..
  81
  82 3. Obtain MiSoC and install it:
  83   git clone https://github.com/m-labs/misoc --recursive
  84   cd misoc
  85   python3 setup.py install
  86   cd ..
  87
  88 Note: in case you have issues with Migen/MiSoC, please retry
  89 with our forks at:
  90   https://github.com/enjoy-digital/misoc
  91   https://github.com/enjoy-digital/migen
  92 until new features are merged.
  93
  94 4. Obtain LiteScope and install it:
  95   git clone https://github.com/enjoy-digital/litescope
  96
  97 5. Build and load test design:
  98   python3 make.py -s [platform] all
  99   Supported platforms are the one altready supported by Mibuild:
 100   de0nano, m1, mixxeo, kc705, zedboard...
 101
 102 6. Test design:
 103   go to ./test directory and run:
 104   python3 test_io.py
 105   python3 test_la.py
 106
 107 [> Simulations:
 108   XXX convert simulations
 109
 110 [> Tests :
 111   XXX convert tests
 112
 113 [> License
 114 -----------
 115 LiteScope is released under the very permissive two-clause BSD license. Under the
 116 terms of this license, you are authorized to use LiteScope for closed-source
 117 proprietary designs.
 118 Even though we do not require you to do so, those things are awesome, so please
 119 do them if possible:
 120  - tell us that you are using LiteScope
 121  - cite LiteScope in publications related to research it has helped
 122  - send us feedback and suggestions for improvements
 123  - send us bug reports when something goes wrong
 124  - send us the modifications and improvements you have done to LiteScope.
 125
 126 [> Support and consulting
 127 --------------------------
 128 We love open-source hardware and like sharing our designs with others.
 129
 130 LiteScope is developed and maintained by EnjoyDigital.
 131
 132 If you would like to know more about LiteScope or if you are already a happy user
 133 and would like to extend it for your needs, EnjoyDigital can provide standard
 134 commercial support as well as consulting services.
 135
 136 So feel free to contact us, we'd love to work with you! (and eventually shorten
 137 the list of the possible improvements :)
 138
 139 [> Contact
 140 E-mail: florent [AT] enjoy-digital.fr