Documentation/zio: added modules.txt, to show what's there

Signed-off-by: Alessandro Rubini <rubini@gnudd.com> Signed-off-by: Federico Vaga <federico.vaga@gmail.com>

Documentation/zio: added modules.txt, to show what's there
Signed-off-by: Alessandro Rubini <rubini@gnudd.com> Signed-off-by: Federico Vaga <federico.vaga@gmail.com>
28a862c2 · Alessandro Rubini · 50af44a6 · 28a862c2 · 28a862c2
Commit 28a862c2 authored Oct 12, 2011 by Alessandro Rubini
Hide whitespace changes
Inline Side-by-side

Showing with 47 additions and 0 deletions

00-INDEX Documentation/zio/00-INDEX +2 -0

modules.txt Documentation/zio/modules.txt +45 -0

No files found.
--- a/Documentation/zio/00-INDEX
+++ b/Documentation/zio/00-INDEX
@@ -6,5 +6,7 @@ buffer.txt
 	- description of the buffer, it's methods and how it is used.
 trigger.txt
 	- what is a trigger and what's its role in ZIO.
+modules.txt
+	- list of modules (and description) found in the first ZIO package
 tools/
 	- useful and simple user-space programs 
\ No newline at end of file
--- a/Documentation/zio/modules.txt
+++ b/Documentation/zio/modules.txt
+This is the list of ZIO modules, at the time of writing. It is there
+to help new users understanding how the parts stick together.
+  drivers/zio/zio-core.ko
+This module (which is linked from several source files) includes the
+core sysfs and attribute management. It exports the register and
+unregister functions for top-level objects. Moreover, it includes the
+default buffer, called "kmalloc" and default trigger, called
+"app-request".
+  drivers/zio/trigger/trig-ktimer.ko
+  drivers/zio/trigger/trig-hrt.ko
+  drivers/zio/trigger/trig-irq.ko
+Three other generic triggers. Two of them are time-based, and the
+third hooks to an external interrupt (or more than one) as source of
+trigger that can be used be any zio cset).
+  drivers/zio/dev/zio-null.ko
+  drivers/zio/dev/zio-parport.ko
+  drivers/zio/dev/zio-ad7888.ko
+  drivers/zio/dev/zio-uart.ko
+These modules are examples. "null" does nothing: it discards output
+data and returns zeroes as input data. It can be used to experiment
+with generic triggers and as a sandbox for local modifications and
+testing.
+The parport driver registers two output csets and two input cset.
+In each group one cset is byte-oriented and the other is bit-oriented.
+The ad7888 is an SPI ADC we mounted on an ARM board. It's a real
+8-channel ADC we are using for internal development, and this is a
+real driver for a real thing. Over time it will handle its own buffer
+type (our SPI master uses DMA) and its own data-driven trigger (even
+if the data will be scanned by the CPU, so it can only work at low
+data rates).
+The uart driver is a line discpline that can receive data from a
+serial port. The first implementation expects to receive an endless
+stream of 16-bit data, big endian (we used this to run on-board ADC on
+cortex-m3), but we plan to extend it as a serious test case. You can
+drive it from a pty slave, for example.