From d50bb8c55ee709d52910a6b993bbe53a39950b47 Mon Sep 17 00:00:00 2001 From: Sebastien Bourdeauducq Date: Tue, 26 May 2015 14:13:13 +0800 Subject: [PATCH] litesata: more doc fixes --- .../enjoydigital_sphinx_rtd_theme/footer.html | 2 +- .../source/docs/getting_started/bug_reports.rst | 4 ++-- .../doc/source/docs/getting_started/index.rst | 2 +- .../mem/litesata/doc/source/docs/intro/about.rst | 4 +--- .../mem/litesata/doc/source/docs/intro/license.rst | 3 ++- .../doc/source/docs/intro/release_notes.rst | 1 - .../source/docs/intro/talks_and_publications.rst | 14 +++++++------- .../mem/litesata/doc/source/docs/phy/index.rst | 4 ++-- .../litesata/doc/source/docs/simulation/index.rst | 8 +++++--- .../doc/source/docs/specification/index.rst | 12 ++++++++---- .../mem/litesata/doc/source/docs/test/index.rst | 8 ++++---- .../mem/litesata/doc/source/home_page_layout.html | 11 +++++------ misoclib/mem/litesata/doc/source/index.rst | 2 -- 13 files changed, 38 insertions(+), 37 deletions(-) diff --git a/misoclib/mem/litesata/doc/source/_themes/enjoydigital_sphinx_rtd_theme/footer.html b/misoclib/mem/litesata/doc/source/_themes/enjoydigital_sphinx_rtd_theme/footer.html index fd017c5c0..0b3f79278 100644 --- a/misoclib/mem/litesata/doc/source/_themes/enjoydigital_sphinx_rtd_theme/footer.html +++ b/misoclib/mem/litesata/doc/source/_themes/enjoydigital_sphinx_rtd_theme/footer.html @@ -84,7 +84,7 @@ {% trans path=pathto('copyright'), copyright=copyright|e %}© Copyright {{ copyright }}.{% endtrans %} {%- else %} - © Copyright {{ copyright }} EnjoyDigital and M-Labs Contributors. + © Copyright {{ copyright }} HKU. {%- endif %} {%- endif %} diff --git a/misoclib/mem/litesata/doc/source/docs/getting_started/bug_reports.rst b/misoclib/mem/litesata/doc/source/docs/getting_started/bug_reports.rst index d9dfce0f6..5b5b75a7e 100644 --- a/misoclib/mem/litesata/doc/source/docs/getting_started/bug_reports.rst +++ b/misoclib/mem/litesata/doc/source/docs/getting_started/bug_reports.rst @@ -6,5 +6,5 @@ Bug Reporting - 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 LiteSATA. -The use of "git format-patch" is recommended. If your submission is large and -complex and/or you are not sure how to proceed, feel free to discuss it with us. + The use of "git format-patch" is recommended. If your submission is large and + complex and/or you are not sure how to proceed, feel free to discuss it with us. diff --git a/misoclib/mem/litesata/doc/source/docs/getting_started/index.rst b/misoclib/mem/litesata/doc/source/docs/getting_started/index.rst index 4cfd73845..c812e9cea 100644 --- a/misoclib/mem/litesata/doc/source/docs/getting_started/index.rst +++ b/misoclib/mem/litesata/doc/source/docs/getting_started/index.rst @@ -6,7 +6,7 @@ Getting Started Now that you know why LiteSATA is the :ref:`core for you `, it's time to *get started*. -This section explains the procedure for :ref:`downloading and installing the tools`. +This section explains the procedure for downloading and installing the tools. .. toctree:: :maxdepth: 1 diff --git a/misoclib/mem/litesata/doc/source/docs/intro/about.rst b/misoclib/mem/litesata/doc/source/docs/intro/about.rst index 5e8580524..d1c8afd8b 100644 --- a/misoclib/mem/litesata/doc/source/docs/intro/about.rst +++ b/misoclib/mem/litesata/doc/source/docs/intro/about.rst @@ -51,7 +51,7 @@ Core: Frontend: - Configurable crossbar (simply declare your crossbar and use core.crossbar.get_port() to add a new port!) - Ports arbitration transparent to the user - - Synthetizable BIST + - Synthesizable BIST - Striping module to segment data on multiple HDDs and increase write/read speed and capacity. (RAID0 equivalent) - Mirroring module for data redundancy and increase read speeds. (RAID1 equivalent) @@ -85,5 +85,3 @@ the list of the possible improvements :) Contact ======= E-mail: florent [AT] enjoy-digital.fr - - diff --git a/misoclib/mem/litesata/doc/source/docs/intro/license.rst b/misoclib/mem/litesata/doc/source/docs/intro/license.rst index 86a41c88f..3c72a7c20 100644 --- a/misoclib/mem/litesata/doc/source/docs/intro/license.rst +++ b/misoclib/mem/litesata/doc/source/docs/intro/license.rst @@ -9,6 +9,7 @@ terms of this license, you are authorized to use LiteSATA 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 LiteSATA - cite LiteSATA in publications related to research it has helped - send us feedback and suggestions for improvements @@ -17,7 +18,7 @@ do them if possible: :: - Unless otherwise noted, LiteSATA is copyright (C) 2015 HKU. + Unless otherwise noted, LiteSATA is copyright (C) 2014-2015 HKU. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: diff --git a/misoclib/mem/litesata/doc/source/docs/intro/release_notes.rst b/misoclib/mem/litesata/doc/source/docs/intro/release_notes.rst index 28801943b..00d464042 100644 --- a/misoclib/mem/litesata/doc/source/docs/intro/release_notes.rst +++ b/misoclib/mem/litesata/doc/source/docs/intro/release_notes.rst @@ -10,4 +10,3 @@ ChangeLog ========= 0.9.0: - First release supporting Xilinx Kintex7. - diff --git a/misoclib/mem/litesata/doc/source/docs/intro/talks_and_publications.rst b/misoclib/mem/litesata/doc/source/docs/intro/talks_and_publications.rst index 071a4e6a9..c782b77c5 100644 --- a/misoclib/mem/litesata/doc/source/docs/intro/talks_and_publications.rst +++ b/misoclib/mem/litesata/doc/source/docs/intro/talks_and_publications.rst @@ -4,11 +4,11 @@ Talks and Publications ====================== -- Migen / MiSoC documentation: - - `User guide `_ (`m-labs `_) - - `Tutorial: An introduction to Migen `_ (`m-labs `_) + - Migen / MiSoC documentation: + - `User guide `_ (`m-labs `_) + - `Tutorial: An introduction to Migen `_ (`m-labs `_) -- Migen / MiSoC presentations: - - `Lecture slides `_ (`sbourdeauducq `_) - - `EHSM 2012 presentation `_ (`sbourdeauducq `_) - - `ORCONF2014 `_ (`fallen `_) + - Migen / MiSoC presentations: + - `Lecture slides `_ (`sbourdeauducq `_) + - `EHSM 2012 presentation `_ (`sbourdeauducq `_) + - `ORCONF2014 `_ (`fallen `_) diff --git a/misoclib/mem/litesata/doc/source/docs/phy/index.rst b/misoclib/mem/litesata/doc/source/docs/phy/index.rst index c1193cad8..7f2468a42 100644 --- a/misoclib/mem/litesata/doc/source/docs/phy/index.rst +++ b/misoclib/mem/litesata/doc/source/docs/phy/index.rst @@ -1,7 +1,7 @@ .. _phy-index: -======================== +=== PHY -======================== +=== .. note:: Please contribute to this document, or support us financially to write it. \ No newline at end of file diff --git a/misoclib/mem/litesata/doc/source/docs/simulation/index.rst b/misoclib/mem/litesata/doc/source/docs/simulation/index.rst index e75d259de..66f4727f5 100644 --- a/misoclib/mem/litesata/doc/source/docs/simulation/index.rst +++ b/misoclib/mem/litesata/doc/source/docs/simulation/index.rst @@ -1,13 +1,14 @@ .. _simulation-index: -======================== +========== Simulation -======================== +========== .. note:: Please contribute to this document, or support us financially to write it. Simulations are available in ./test: + - :code:`crc_tb` - :code:`scrambler_tb` - :code:`phy_datapath_tb` @@ -19,4 +20,5 @@ Simulations are available in ./test: Models for all the layers of SATA and a simplified HDD model are provided. To run a simulation, go to ./test and run: - - :code:`make ` \ No newline at end of file + + - :code:`make ` diff --git a/misoclib/mem/litesata/doc/source/docs/specification/index.rst b/misoclib/mem/litesata/doc/source/docs/specification/index.rst index 660ea3842..39b73562a 100644 --- a/misoclib/mem/litesata/doc/source/docs/specification/index.rst +++ b/misoclib/mem/litesata/doc/source/docs/specification/index.rst @@ -5,7 +5,7 @@ SATA Specification ======================== .. note:: - This chapter is a lightly modified version of the excellent SATA summerization found in Chapter 2 of Erik Landström's Thesis_. + This chapter is a lightly modified version of the excellent SATA summary found in Chapter 2 of Erik Landström's Thesis_. Serial Advanced Technology Attachment (SATA) is a serial link replacement of Parallel ATA (PATA), both standards for communication with mass storage devices. @@ -20,7 +20,7 @@ data stream SATA layers. -SATA’s architecture consists of four layers, Application, Transport, Link, and Physical. +SATA's architecture consists of four layers, Application, Transport, Link, and Physical. The Application layer is responsible for overall ATA commands and of controlling SATA register accesses. The transport layer places control information and data to be transferred between the host and corresponding SATA device in a data packets. One such packet is called a frame @@ -111,6 +111,7 @@ Physical Layer ============== This section describes the physical interface towards the actual SATA link. The features of the phy can be summarized to: + - Transmit/Receive a 1.5 Gbps, 3.0 or 6.0 Gbps differential signal - Speed negotiation - OOB detection and transmission @@ -132,6 +133,7 @@ Link Layer ========== This section describes the SATA link layer. The link layer’s major tasks are: + - Flow control - Encapsulate FISes received from transport layer - CRC generation and CRC check @@ -175,6 +177,7 @@ Transport Layer =============== The main task for the SATA transport layer is to handle FISes and a brief description of the layer’s features follows: + - Flow control - Error control - Error reporting @@ -189,6 +192,7 @@ there are bytes or bits missing for an entire Dword. The flow control in this case is only to report to the link layer that the data buffers are close to over- or underflow. Errors detected are supposed to be reported to the application layer and the detectable errors are: + - Errors from lower layers like 8b/10b disparity error or CRC errors. - SATA state or protocol errors caused by standard violation. - Frame errors like malformed header. @@ -201,11 +205,11 @@ bytes (maximum supported FIS size). The max sized non-data FIS is 28 bytes so the costs of a large buffer can be spared. Command Layer -================= +============= The command layer tells the transport layer what kind of FISes to send and receive for each specific command and in which order those FISes are expexted to be delivered. .. note:: - This chapter is a lightly modified version of the excellent SATA summerization found in Chapter 2 of Erik Landström's Thesis_. + This chapter is a lightly modified version of the excellent SATA summary found in Chapter 2 of Erik Landström's Thesis_. .. _Thesis: http://www.diva-portal.org/smash/get/diva2:207798/FULLTEXT01.pdf diff --git a/misoclib/mem/litesata/doc/source/docs/test/index.rst b/misoclib/mem/litesata/doc/source/docs/test/index.rst index bce2c82f0..ec46e69e7 100644 --- a/misoclib/mem/litesata/doc/source/docs/test/index.rst +++ b/misoclib/mem/litesata/doc/source/docs/test/index.rst @@ -1,13 +1,13 @@ .. _test-index: -======================== +==== Test -======================== +==== .. note:: Please contribute to this document, or support us financially to write it. A synthetizable BIST is provided and can be controlled with ./test/bist.py. By using LiteScope and the provided ./test/test_link.py example you are able to -visualize the internal logic of the design and even inject the captured data in -the HDD model! \ No newline at end of file +visualize the internal logic of the design and even inject the captured data into +the HDD model! diff --git a/misoclib/mem/litesata/doc/source/home_page_layout.html b/misoclib/mem/litesata/doc/source/home_page_layout.html index d0fa7c252..9c168b145 100644 --- a/misoclib/mem/litesata/doc/source/home_page_layout.html +++ b/misoclib/mem/litesata/doc/source/home_page_layout.html @@ -1,27 +1,26 @@ ./_static/LiteSATA_logo_full.png -

LiteSATA provides a small footprint and configurable FPGA SATA gen1/2/3 core.

+

LiteSATA provides a small footprint and configurable FPGA SATA gen1/2 core.

Small footprint
-

Thanks to simple and efficient Migen's building blocks and the KISS principe used to develop this core, LiteSATA footprint is really small!

+

Thanks to simple and efficient Migen building blocks and the KISS principe used to develop this core, LiteSATA footprint is really small!

Configurable
-

LiteSATA generates HDL using Migen as a Python meta-language. The core is then easily configurable to fit - user's needs! (Number of crossbar ports, included BIST and so on...)

+

LiteSATA generates HDL using Migen, a Python-based logic design system. The core is easily configurable to fit + user's needs! (number of crossbar ports, RAID configuration, included BIST and so on...)

Portable
-

Porting the core to another vendor or family only require adapting or adding a new PHY. All others building blocks of the core are generic.

+

Porting the core to another vendor or family only requires adapting or adding a new PHY. All others building blocks of the core are generic.

- diff --git a/misoclib/mem/litesata/doc/source/index.rst b/misoclib/mem/litesata/doc/source/index.rst index 846392d06..094ff281e 100644 --- a/misoclib/mem/litesata/doc/source/index.rst +++ b/misoclib/mem/litesata/doc/source/index.rst @@ -24,5 +24,3 @@ News docs/frontend/index docs/simulation/index docs/test/index - docs/site/about -