Documentation: document all g_serial module parameters

Message ID 1376601446-16044-1-git-send-email-matt.porter@linaro.org
State New
Headers show

Commit Message

Matt Porter Aug. 15, 2013, 9:17 p.m.
Add a table explaining the module parameters that g_serial
digests.

Signed-off-by: Matt Porter <matt.porter@linaro.org>
---
 Documentation/usb/gadget_serial.txt |   13 +++++++++++++
 1 file changed, 13 insertions(+)

Patch

diff --git a/Documentation/usb/gadget_serial.txt b/Documentation/usb/gadget_serial.txt
index 61e67f6..d5eb27b 100644
--- a/Documentation/usb/gadget_serial.txt
+++ b/Documentation/usb/gadget_serial.txt
@@ -125,6 +125,19 @@  controller driver.  This must be done each time you reboot the gadget
 side Linux system.  You can add this to the start up scripts, if
 desired.
 
+Additionally, there are several module parameters to change g_serial
+behavior:
+
+	Parameter	Default		Description
+	---------	-------		-----------
+	use_acm		1		CDC ACM device
+	use_obex	0		CDC OBEX device
+	n_ports		1		Ports to instantiate
+
+To load g_serial as two ACM ports do this:
+
+  modprobe g_serial n_ports=2
+
 Your system should use mdev (from busybox) or udev to make the
 device nodes.  After this gadget driver has been set up you should
 then see a /dev/ttyGS0 node: