From 62c4bdd1024b606edac2658c0a569ff22806abe3 Mon Sep 17 00:00:00 2001 From: Florent Kermarrec Date: Thu, 22 Feb 2018 10:18:17 +0100 Subject: [PATCH] uniformize litex cores --- LICENSE | 2 +- README | 48 +++++++++++++++++++++--------------------------- 2 files changed, 22 insertions(+), 28 deletions(-) diff --git a/LICENSE b/LICENSE index 95ac4a6..bb5c10d 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Unless otherwise noted, LiteScope is copyright (C) 2015 Florent Kermarrec. +Unless otherwise noted, LiteScope is Copyright 2012-2018 / EnjoyDigital Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: diff --git a/README b/README index 9420fd6..a3908af 100644 --- a/README +++ b/README @@ -3,14 +3,14 @@ / /__/ / __/ -_)\ \/ __/ _ \/ _ \/ -_) /____/_/\__/\__/___/\__/\___/ .__/\__/ /_/ - Copyright 2012-2017 / EnjoyDigital + Copyright 2015-2018 / EnjoyDigital - A small footprint and configurable embedded FPGA - logic analyzer core powered by LiteX + A small footprint and configurable Logic Analyzer + core powered by LiteX [> Intro -------- -LiteScope is a small footprint and configurable embedded logic analyzer that you +LiteScope provides a small footprint and configurable embedded logic analyzer that you can use in your FPGA and aims to provide a free, portable and flexible alternative to vendor's solutions! @@ -18,9 +18,6 @@ LiteScope 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. @@ -40,13 +37,14 @@ design flow by generating the verilog rtl that you will use as a standard core. - Data storage in block rams - Bridges: - UART2Wishbone (provided by LiteX) - - Ethernet2Wishbone ("Etherbone") (when used with LiteEth) - - PCIe2Wishbone (when used with LitePCIe) + - Ethernet2Wishbone ("Etherbone") (provided by LiteEth) + - PCIe2Wishbone (provided by LitePCIe) - Exports formats: .vcd, .sr(sigrok), .csv, .py, etc... [> Proven --------- -LiteScope has already been used to investigate issues on commercial and open-source designs. +LiteScope has already been used to investigate issues on several commercial or +open-source designs. [> Possible improvements ------------------------ @@ -58,9 +56,7 @@ LiteScope has already been used to investigate issues on commercial and open-sou - ... 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. - +enjoy-digital.fr. [> Getting started ------------------ @@ -69,20 +65,18 @@ devel [AT] lists.m-labs.hk. 2. Obtain LiteX and install it: git clone https://github.com/enjoy-digital/litex --recursive cd litex - python3 setup.py install + python3 setup.py develop cd .. -3. Build and load test design: - go to example_designs/ - ./make.py -p [your_platform] all load-bitstream - Supported platforms are the ones already supported by Mibuild: - de0nano, m1, mixxeo, kc705, zedboard... +3. TODO: add/describe example design(s) -4. Test design: - go to test and run: - litex_server --port your_serial_port - python3 test_io.py (led blinker) - python3 test_analyzer.py (capture counter with analyzer) +[> Tests +-------- +Unit tests are available in ./test/. +To run all the unit tests: + ./setup.py test +Tests can also be run individually: + python3 -m unittest test.test_name [> License ---------- @@ -101,10 +95,10 @@ do them if possible: ------------------------- We love open-source hardware and like sharing our designs with others. -LiteScope is mainly developed and maintained by EnjoyDigital. +LiteScope is developed and maintained by EnjoyDigital. -If you would like to know more about LiteScope or if you are already a happy user -and would like to extend it for your needs, EnjoyDigital can provide standard +If you would like to know more about LiteScope 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