[cdi-devel] [PATCH] misc.h: Improved documentation of cdi_wait_irq

[Kevin Wolf <kevin@xxxxxxxxxx>]

Signed-off-by: Kevin Wolf <kevin@xxxxxxxxxx>
---
 include/cdi/misc.h |   17 +++++++++++++----
 1 files changed, 13 insertions(+), 4 deletions(-)

diff --git a/include/cdi/misc.h b/include/cdi/misc.h
index 2049c62..183d32b 100644
--- a/include/cdi/misc.h
+++ b/include/cdi/misc.h
@@ -39,10 +39,19 @@ void cdi_register_irq(uint8_t irq, void (*handler)(struct cdi_device*),
 int cdi_reset_wait_irq(uint8_t irq);
 
 /**
- * Wartet bis der IRQ aufgerufen wurde. Der interne Zaehler muss zuerst mit
- * cdi_reset_wait_irq zurueckgesetzt werden, damit auch die IRQs abgefangen
- * werden koennen, die kurz vor dem Aufruf von dieser Funktion aufgerufen
- * werden.
+ * Wartet bis der IRQ aufgerufen wurde. Der interne Zähler muss zuerst mit
+ * cdi_reset_wait_irq zurückgesetzt werden. Damit auch die IRQs abgefangen
+ * werden können, die kurz vor dem Aufruf von dieser Funktion aufgerufen
+ * werden, sieht der korrekte Ablauf wie folgt aus:
+ *
+ * -# cdi_reset_wait_irq
+ * -# Hardware ansprechen und Aktionen ausführen, die schlie�lich den IRQ
+ *    auslösen
+ * -# cdi_wait_irq
+ *
+ * Der entsprechende IRQ muss zuvor mit cdi_register_irq registriert worden
+ * sein. Der registrierte Handler wird ausgeführt, bevor diese Funktion
+ * erfolgreich zurückkehrt.
  *
  * @param irq       Nummer des IRQ auf den gewartet werden soll
  * @param timeout   Anzahl der Millisekunden, die maximal gewartet werden sollen
-- 
1.6.0.2