Commit 05a07392 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Jonathan Corbet

xillybus.txt: standardize document format

Each text file under Documentation follows a different
format. Some doesn't even have titles!

Change its representation to follow the adopted standard,
using ReST markups for it to be parseable by Sphinx:
- Adjust indentation;
- Mark authorship;
- Comment internal contents table;
- Mark literal blocks;
- Don't use all-upercase titles.
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent c6f4d413
==========================================
Xillybus driver for generic FPGA interface
==========================================
========================================== :Author: Eli Billauer, Xillybus Ltd. (http://xillybus.com)
Xillybus driver for generic FPGA interface :Email: eli.billauer@gmail.com or as advertised on Xillybus' site.
==========================================
Author: Eli Billauer, Xillybus Ltd. (http://xillybus.com) .. Contents:
Email: eli.billauer@gmail.com or as advertised on Xillybus' site.
Contents:
- Introduction - Introduction
-- Background -- Background
...@@ -17,7 +16,7 @@ Contents: ...@@ -17,7 +16,7 @@ Contents:
-- Synchronization -- Synchronization
-- Seekable pipes -- Seekable pipes
- Internals - Internals
-- Source code organization -- Source code organization
-- Pipe attributes -- Pipe attributes
-- Host never reads from the FPGA -- Host never reads from the FPGA
...@@ -29,7 +28,7 @@ Contents: ...@@ -29,7 +28,7 @@ Contents:
-- The "nonempty" message (supporting poll) -- The "nonempty" message (supporting poll)
INTRODUCTION Introduction
============ ============
Background Background
...@@ -105,7 +104,7 @@ driver is used to work out of the box with any Xillybus IP core. ...@@ -105,7 +104,7 @@ driver is used to work out of the box with any Xillybus IP core.
The data structure just mentioned should not be confused with PCI's The data structure just mentioned should not be confused with PCI's
configuration space or the Flattened Device Tree. configuration space or the Flattened Device Tree.
USAGE Usage
===== =====
User interface User interface
...@@ -117,11 +116,11 @@ names of these files depend on the IP core that is loaded in the FPGA (see ...@@ -117,11 +116,11 @@ names of these files depend on the IP core that is loaded in the FPGA (see
Probing below). To communicate with the FPGA, open the device file that Probing below). To communicate with the FPGA, open the device file that
corresponds to the hardware FIFO you want to send data or receive data from, corresponds to the hardware FIFO you want to send data or receive data from,
and use plain write() or read() calls, just like with a regular pipe. In and use plain write() or read() calls, just like with a regular pipe. In
particular, it makes perfect sense to go: particular, it makes perfect sense to go::
$ cat mydata > /dev/xillybus_thisfifo $ cat mydata > /dev/xillybus_thisfifo
$ cat /dev/xillybus_thatfifo > hisdata $ cat /dev/xillybus_thatfifo > hisdata
possibly pressing CTRL-C as some stage, even though the xillybus_* pipes have possibly pressing CTRL-C as some stage, even though the xillybus_* pipes have
the capability to send an EOF (but may not use it). the capability to send an EOF (but may not use it).
...@@ -178,7 +177,7 @@ the attached memory is done by seeking to the desired address, and calling ...@@ -178,7 +177,7 @@ the attached memory is done by seeking to the desired address, and calling
read() or write() as required. read() or write() as required.
INTERNALS Internals
========= =========
Source code organization Source code organization
...@@ -365,7 +364,7 @@ into that page. It can be shown that all pages requested from the kernel ...@@ -365,7 +364,7 @@ into that page. It can be shown that all pages requested from the kernel
(except possibly for the last) are 100% utilized this way. (except possibly for the last) are 100% utilized this way.
The "nonempty" message (supporting poll) The "nonempty" message (supporting poll)
--------------------------------------- ----------------------------------------
In order to support the "poll" method (and hence select() ), there is a small In order to support the "poll" method (and hence select() ), there is a small
catch regarding the FPGA to host direction: The FPGA may have filled a DMA catch regarding the FPGA to host direction: The FPGA may have filled a DMA
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment