Skip to content

Commit d50bb8c

Browse files
sbourdeauducqsbourdeauducq
committedMay 26, 2015
litesata: more doc fixes
·
0.120.1
1 parent 1e47cfc commit d50bb8c

File tree

13 files changed

+38
-37
lines changed

13 files changed

+38
-37
lines changed
 

Diff for: ‎misoclib/mem/litesata/doc/source/_themes/enjoydigital_sphinx_rtd_theme/footer.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@
8484
{% trans path=pathto('copyright'), copyright=copyright|e %}&copy; <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}
8585
{%- else %}
8686
<!-- {% trans copyright=copyright|e %}&copy; Copyright {{ copyright }}.{% endtrans %} -->
87-
&copy; Copyright {{ copyright }} <a href="{{ pathto("docs\contributing\AUTHORS") }}">EnjoyDigital and M-Labs Contributors</a>.
87+
&copy; Copyright {{ copyright }} <a href="{{ pathto("docs\contributing\AUTHORS") }}">HKU</a>.
8888
<!-- update theme to remove the translation stuff here - it was breaking due to link to AUTHORS file. This is a cludge to allow specific link to my authors file -->
8989
{%- endif %}
9090
{%- endif %}

Diff for: ‎misoclib/mem/litesata/doc/source/docs/getting_started/bug_reports.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,5 @@ Bug Reporting
66
- send us feedback and suggestions for improvements
77
- send us bug reports when something goes wrong
88
- send us the modifications and improvements you have done to LiteSATA.
9-
The use of "git format-patch" is recommended. If your submission is large and
10-
complex and/or you are not sure how to proceed, feel free to discuss it with us.
9+
The use of "git format-patch" is recommended. If your submission is large and
10+
complex and/or you are not sure how to proceed, feel free to discuss it with us.

Diff for: ‎misoclib/mem/litesata/doc/source/docs/getting_started/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Getting Started
66

77
Now that you know why LiteSATA is the :ref:`core for you <about>`, it's time to *get started*.
88

9-
This section explains the procedure for :ref:`downloading and installing the tools`.
9+
This section explains the procedure for downloading and installing the tools.
1010

1111
.. toctree::
1212
:maxdepth: 1

Diff for: ‎misoclib/mem/litesata/doc/source/docs/intro/about.rst

+1-3
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Core:
5151
Frontend:
5252
- Configurable crossbar (simply declare your crossbar and use core.crossbar.get_port() to add a new port!)
5353
- Ports arbitration transparent to the user
54-
- Synthetizable BIST
54+
- Synthesizable BIST
5555
- Striping module to segment data on multiple HDDs and increase write/read speed and capacity. (RAID0 equivalent)
5656
- Mirroring module for data redundancy and increase read speeds. (RAID1 equivalent)
5757

@@ -85,5 +85,3 @@ the list of the possible improvements :)
8585
Contact
8686
=======
8787
E-mail: florent [AT] enjoy-digital.fr
88-
89-

Diff for: ‎misoclib/mem/litesata/doc/source/docs/intro/license.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ terms of this license, you are authorized to use LiteSATA for closed-source
99
proprietary designs.
1010
Even though we do not require you to do so, those things are awesome, so please
1111
do them if possible:
12+
1213
- tell us that you are using LiteSATA
1314
- cite LiteSATA in publications related to research it has helped
1415
- send us feedback and suggestions for improvements
@@ -17,7 +18,7 @@ do them if possible:
1718

1819
::
1920

20-
Unless otherwise noted, LiteSATA is copyright (C) 2015 HKU.
21+
Unless otherwise noted, LiteSATA is copyright (C) 2014-2015 HKU.
2122

2223
Redistribution and use in source and binary forms, with or without modification,
2324
are permitted provided that the following conditions are met:

Diff for: ‎misoclib/mem/litesata/doc/source/docs/intro/release_notes.rst

-1
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,3 @@ ChangeLog
1010
=========
1111
0.9.0:
1212
- First release supporting Xilinx Kintex7.
13-

Diff for: ‎misoclib/mem/litesata/doc/source/docs/intro/talks_and_publications.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@
44
Talks and Publications
55
======================
66

7-
- Migen / MiSoC documentation:
8-
- `User guide <http://m-labs.hk/migen.pdf>`_ (`m-labs <https://github.com/m-labs>`_)
9-
- `Tutorial: An introduction to Migen <http://m-labs.hk/migen-tutorial.pdf>`_ (`m-labs <https://github.com/m-labs>`_)
7+
- Migen / MiSoC documentation:
8+
- `User guide <http://m-labs.hk/migen.pdf>`_ (`m-labs <https://github.com/m-labs>`_)
9+
- `Tutorial: An introduction to Migen <http://m-labs.hk/migen-tutorial.pdf>`_ (`m-labs <https://github.com/m-labs>`_)
1010

11-
- Migen / MiSoC presentations:
12-
- `Lecture slides <http://m-labs.hk/migen-slides.pdf>`_ (`sbourdeauducq <https://github.com/sbourdeauducq>`_)
13-
- `EHSM 2012 presentation <https://www.youtube.com/watch?v=yxKMsAi_WEA>`_ (`sbourdeauducq <https://github.com/sbourdeauducq>`_)
14-
- `ORCONF2014 <https://www.youtube.com/watch?v=AfEPbw4nREo>`_ (`fallen <https://github.com/fallen>`_)
11+
- Migen / MiSoC presentations:
12+
- `Lecture slides <http://m-labs.hk/migen-slides.pdf>`_ (`sbourdeauducq <https://github.com/sbourdeauducq>`_)
13+
- `EHSM 2012 presentation <https://www.youtube.com/watch?v=yxKMsAi_WEA>`_ (`sbourdeauducq <https://github.com/sbourdeauducq>`_)
14+
- `ORCONF2014 <https://www.youtube.com/watch?v=AfEPbw4nREo>`_ (`fallen <https://github.com/fallen>`_)

Diff for: ‎misoclib/mem/litesata/doc/source/docs/phy/index.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _phy-index:
22

3-
========================
3+
===
44
PHY
5-
========================
5+
===
66
.. note::
77
Please contribute to this document, or support us financially to write it.

Diff for: ‎misoclib/mem/litesata/doc/source/docs/simulation/index.rst

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
.. _simulation-index:
22

3-
========================
3+
==========
44
Simulation
5-
========================
5+
==========
66

77
.. note::
88
Please contribute to this document, or support us financially to write it.
99

1010
Simulations are available in ./test:
11+
1112
- :code:`crc_tb`
1213
- :code:`scrambler_tb`
1314
- :code:`phy_datapath_tb`
@@ -19,4 +20,5 @@ Simulations are available in ./test:
1920

2021
Models for all the layers of SATA and a simplified HDD model are provided.
2122
To run a simulation, go to ./test and run:
22-
- :code:`make <simulation_name>`
23+
24+
- :code:`make <simulation_name>`

Diff for: ‎misoclib/mem/litesata/doc/source/docs/specification/index.rst

+8-4
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ SATA Specification
55
========================
66

77
.. note::
8-
This chapter is a lightly modified version of the excellent SATA summerization found in Chapter 2 of Erik Landström's Thesis_.
8+
This chapter is a lightly modified version of the excellent SATA summary found in Chapter 2 of Erik Landström's Thesis_.
99

1010
Serial Advanced Technology Attachment (SATA) is a serial link replacement of
1111
Parallel ATA (PATA), both standards for communication with mass storage devices.
@@ -20,7 +20,7 @@ data stream
2020

2121
SATA layers.
2222

23-
SATA’s architecture consists of four layers, Application, Transport, Link, and Physical.
23+
SATA's architecture consists of four layers, Application, Transport, Link, and Physical.
2424
The Application layer is responsible for overall ATA commands and of controlling SATA
2525
register accesses. The transport layer places control information and data to be transferred between
2626
the host and corresponding SATA device in a data packets. One such packet is called a frame
@@ -111,6 +111,7 @@ Physical Layer
111111
==============
112112
This section describes the physical interface towards the actual SATA link.
113113
The features of the phy can be summarized to:
114+
114115
- Transmit/Receive a 1.5 Gbps, 3.0 or 6.0 Gbps differential signal
115116
- Speed negotiation
116117
- OOB detection and transmission
@@ -132,6 +133,7 @@ Link Layer
132133
==========
133134
This section describes the SATA link layer.
134135
The link layer’s major tasks are:
136+
135137
- Flow control
136138
- Encapsulate FISes received from transport layer
137139
- CRC generation and CRC check
@@ -175,6 +177,7 @@ Transport Layer
175177
===============
176178
The main task for the SATA transport layer is to handle FISes and a brief description
177179
of the layer’s features follows:
180+
178181
- Flow control
179182
- Error control
180183
- Error reporting
@@ -189,6 +192,7 @@ there are bytes or bits missing for an entire Dword.
189192
The flow control in this case is only to report to the link layer that the data buffers
190193
are close to over- or underflow. Errors detected are supposed to be reported to
191194
the application layer and the detectable errors are:
195+
192196
- Errors from lower layers like 8b/10b disparity error or CRC errors.
193197
- SATA state or protocol errors caused by standard violation.
194198
- Frame errors like malformed header.
@@ -201,11 +205,11 @@ bytes (maximum supported FIS size). The max sized non-data FIS is 28 bytes so
201205
the costs of a large buffer can be spared.
202206

203207
Command Layer
204-
=================
208+
=============
205209
The command layer tells the transport layer what kind of FISes to send and receive
206210
for each specific command and in which order those FISes are expexted to be delivered.
207211

208212
.. note::
209-
This chapter is a lightly modified version of the excellent SATA summerization found in Chapter 2 of Erik Landström's Thesis_.
213+
This chapter is a lightly modified version of the excellent SATA summary found in Chapter 2 of Erik Landström's Thesis_.
210214

211215
.. _Thesis: http://www.diva-portal.org/smash/get/diva2:207798/FULLTEXT01.pdf

Diff for: ‎misoclib/mem/litesata/doc/source/docs/test/index.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
.. _test-index:
22

3-
========================
3+
====
44
Test
5-
========================
5+
====
66

77
.. note::
88
Please contribute to this document, or support us financially to write it.
99

1010
A synthetizable BIST is provided and can be controlled with ./test/bist.py.
1111
By using LiteScope and the provided ./test/test_link.py example you are able to
12-
visualize the internal logic of the design and even inject the captured data in
13-
the HDD model!
12+
visualize the internal logic of the design and even inject the captured data into
13+
the HDD model!

Diff for: ‎misoclib/mem/litesata/doc/source/home_page_layout.html

+5-6
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,26 @@
11
<img alt="./_static/LiteSATA_logo_full.png" src="_static/LiteSATA_logo_full.png">
22

3-
<h3>LiteSATA provides a <b>small footprint and configurable FPGA SATA gen1/2/3 core</b>.</h3>
3+
<h3>LiteSATA provides a <b>small footprint and configurable FPGA SATA gen1/2 core</b>.</h3>
44

55
<div class="container" style="width:100%;margin-bottom:10px;">
66

77
<div class="one-third-container" style="width:32%; display:inline-block;">
88
<div class="signpost" style="display:inline-block; vertical-align:text-top; margin-left:5px;margin-right:5px;">
99
<div class="signpost-heading" style="font-size:2em; font-style:bold; margin-bottom:10px;">Small footprint</div>
10-
<div class="signpost-body" style=""><p>Thanks to simple and efficient Migen's building blocks and the KISS principe used to develop this core, LiteSATA footprint is really small!</p></div>
10+
<div class="signpost-body" style=""><p>Thanks to simple and efficient Migen building blocks and the KISS principe used to develop this core, LiteSATA footprint is really small!</p></div>
1111
</div>
1212
</div>
1313
<div class="one-third-container" style="width:32%; display:inline-block; font-style:bold;">
1414
<div class="signpost" style="display:inline-block; vertical-align:text-top; margin-left:5px;margin-right:5px;">
1515
<div class="signpost-heading" style="font-size:2em; font-style:bold; margin-bottom:10px;">Configurable</div>
16-
<div class="signpost-body" style=""><p>LiteSATA generates HDL using Migen as a Python meta-language. The core is then easily configurable to fit
17-
user's needs! (Number of crossbar ports, included BIST and so on...)</p></div>
16+
<div class="signpost-body" style=""><p>LiteSATA generates HDL using Migen, a Python-based logic design system. The core is easily configurable to fit
17+
user's needs! (number of crossbar ports, RAID configuration, included BIST and so on...)</p></div>
1818
</div>
1919
</div>
2020
<div class="one-third-container" style="width:32%; display:inline-block; font-style:bold;">
2121
<div class="signpost" style="display:inline-block; vertical-align:text-top; margin-left:5px; margin-right:5px;">
2222
<div class="signpost-heading" style="font-size:2em; font-style:bold; margin-bottom:10px;">Portable</div>
23-
<div class="signpost-body" style=""><p>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.</p></div>
23+
<div class="signpost-body" style=""><p>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.</p></div>
2424
</div>
2525
</div>
2626
</div>
27-

Diff for: ‎misoclib/mem/litesata/doc/source/index.rst

-2
Original file line numberDiff line numberDiff line change
@@ -24,5 +24,3 @@ News
2424
docs/frontend/index
2525
docs/simulation/index
2626
docs/test/index
27-
docs/site/about
28-

0 commit comments

Comments
 (0)
Please sign in to comment.