aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--Documentation/xillybus.txt29
1 files changed, 14 insertions, 15 deletions
diff --git a/Documentation/xillybus.txt b/Documentation/xillybus.txt
index 1660145b9969..2446ee303c09 100644
--- a/Documentation/xillybus.txt
+++ b/Documentation/xillybus.txt
@@ -1,12 +1,11 @@
1==========================================
2Xillybus driver for generic FPGA interface
3==========================================
1 4
2 ========================================== 5:Author: Eli Billauer, Xillybus Ltd. (http://xillybus.com)
3 Xillybus driver for generic FPGA interface 6:Email: eli.billauer@gmail.com or as advertised on Xillybus' site.
4 ==========================================
5 7
6Author: Eli Billauer, Xillybus Ltd. (http://xillybus.com) 8.. Contents:
7Email: eli.billauer@gmail.com or as advertised on Xillybus' site.
8
9Contents:
10 9
11 - Introduction 10 - Introduction
12 -- Background 11 -- Background
@@ -17,7 +16,7 @@ Contents:
17 -- Synchronization 16 -- Synchronization
18 -- Seekable pipes 17 -- Seekable pipes
19 18
20- Internals 19 - Internals
21 -- Source code organization 20 -- Source code organization
22 -- Pipe attributes 21 -- Pipe attributes
23 -- Host never reads from the FPGA 22 -- Host never reads from the FPGA
@@ -29,7 +28,7 @@ Contents:
29 -- The "nonempty" message (supporting poll) 28 -- The "nonempty" message (supporting poll)
30 29
31 30
32INTRODUCTION 31Introduction
33============ 32============
34 33
35Background 34Background
@@ -105,7 +104,7 @@ driver is used to work out of the box with any Xillybus IP core.
105The data structure just mentioned should not be confused with PCI's 104The data structure just mentioned should not be confused with PCI's
106configuration space or the Flattened Device Tree. 105configuration space or the Flattened Device Tree.
107 106
108USAGE 107Usage
109===== 108=====
110 109
111User interface 110User interface
@@ -117,11 +116,11 @@ names of these files depend on the IP core that is loaded in the FPGA (see
117Probing below). To communicate with the FPGA, open the device file that 116Probing below). To communicate with the FPGA, open the device file that
118corresponds to the hardware FIFO you want to send data or receive data from, 117corresponds to the hardware FIFO you want to send data or receive data from,
119and use plain write() or read() calls, just like with a regular pipe. In 118and use plain write() or read() calls, just like with a regular pipe. In
120particular, it makes perfect sense to go: 119particular, it makes perfect sense to go::
121 120
122$ cat mydata > /dev/xillybus_thisfifo 121 $ cat mydata > /dev/xillybus_thisfifo
123 122
124$ cat /dev/xillybus_thatfifo > hisdata 123 $ cat /dev/xillybus_thatfifo > hisdata
125 124
126possibly pressing CTRL-C as some stage, even though the xillybus_* pipes have 125possibly pressing CTRL-C as some stage, even though the xillybus_* pipes have
127the capability to send an EOF (but may not use it). 126the 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
178read() or write() as required. 177read() or write() as required.
179 178
180 179
181INTERNALS 180Internals
182========= 181=========
183 182
184Source code organization 183Source code organization
@@ -365,7 +364,7 @@ into that page. It can be shown that all pages requested from the kernel
365(except possibly for the last) are 100% utilized this way. 364(except possibly for the last) are 100% utilized this way.
366 365
367The "nonempty" message (supporting poll) 366The "nonempty" message (supporting poll)
368--------------------------------------- 367----------------------------------------
369 368
370In order to support the "poll" method (and hence select() ), there is a small 369In order to support the "poll" method (and hence select() ), there is a small
371catch regarding the FPGA to host direction: The FPGA may have filled a DMA 370catch regarding the FPGA to host direction: The FPGA may have filled a DMA