From a41f102a763f25631fba4ac1fc4964fbfd1e467c Mon Sep 17 00:00:00 2001
From: Holger Hans Peter Freyther <zecke@selfish.org>
Date: Sun, 14 Aug 2011 14:47:21 +0200
Subject: [PATCH] doc: Document the known firmware issues and if they have a
 workaround

---
 docs/chapters/using.xml | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/docs/chapters/using.xml b/docs/chapters/using.xml
index baca423..a20f4e7 100644
--- a/docs/chapters/using.xml
+++ b/docs/chapters/using.xml
@@ -48,4 +48,20 @@ simtrace - GSM SIM and smartcard tracing
          </mediaobject>
          </figure>
     </section>
+
+    <section id="known_firmware_issues">
+        <title>Known Firmware Issues</title>
+        <para>The current firmware has two known bugs that limit the usage
+        of the device. The first one is with enumeration on USB 3.0 controllers
+        and the second one with baudrate selection of some SIM cards.</para>
+
+        <para>The firmware does not properly enumerate on systems with USB 3.0
+        controllers. The issue has not been analyzed and the workaround is to
+        use a USB &lt; 3.0 port or put a USB &lt; 3.0 hub between.</para>
+
+        <para>The firmware has issues with selecting the right baudrate of
+        some SIMcards. The microcontroller will call the parity error interrupt
+        handler and the watchdog will reset the device. There is no workaround
+        for this issue yet.</para>
+    </section>
 </chapter>