From bdc27bb46e8c68fbacf4bfd8671f622a9998a9cf Mon Sep 17 00:00:00 2001
From: Alessandro Rubini <rubini@gnudd.com>
Date: Tue, 24 Jul 2012 18:35:44 +0200
Subject: [PATCH] doc: documented spec.ko parameters
---
doc/spec-sw.in | 23 +++++++++++++++++++++++
1 file changed, 23 insertions(+)
diff --git a/doc/spec-sw.in b/doc/spec-sw.in
index 14201a4..1a6b0f6 100644
--- a/doc/spec-sw.in
+++ b/doc/spec-sw.in
@@ -151,6 +151,29 @@ following steps:
Failure of any of those steps is fatal.
+The module can receive the following parameters to customize its operation:
+
+@table @code
+
+@item test_irq
+
+ IF not zero, this parameter requests to self-test interrupt
+ generation, using the Gennum registers. This usually does not
+ work on my host, for yet unknown reasons (and that's why it is
+ disabled by default).
+
+@item i2c_dump
+
+ If not zero, this parameter requests to @i{printk} the content
+ of the FMC eeprom, for diagnostic purposes.
+
+@item fw_name
+
+ This string parameter can be used to override the default name
+ for the initialization binary file.
+
+@end table
+
Any mezzanine-specific action must be performed by the driver for the
specific FMC card, including reprograming the FPGA with the final
gateware file. Similarly, the @i{spec} driver is not concerned with
--
GitLab