Module: xenomai-jki
Branch: for-upstream
Commit: cad01f889a082e1143089ce22ecb9fec4082a232
URL:    
http://git.xenomai.org/?p=xenomai-jki.git;a=commit;h=cad01f889a082e1143089ce22ecb9fec4082a232

Author: Jan Kiszka <jan.kis...@siemens.com>
Date:   Fri Nov 12 15:41:09 2010 +0100

RTDM: Clarfiy and sharpen semantic and usage of rtdm_irq services

Signed-off-by: Jan Kiszka <jan.kis...@siemens.com>

---

 ksrc/skins/rtdm/drvlib.c |   17 +++++++++++++++++
 1 files changed, 17 insertions(+), 0 deletions(-)

diff --git a/ksrc/skins/rtdm/drvlib.c b/ksrc/skins/rtdm/drvlib.c
index 3495e63..a692e05 100644
--- a/ksrc/skins/rtdm/drvlib.c
+++ b/ksrc/skins/rtdm/drvlib.c
@@ -1651,6 +1651,11 @@ EXPORT_SYMBOL(rtdm_irq_request);
  *
  * @return 0 on success, otherwise negative error code
  *
+ * @note The caller is responsible for shutting down the IRQ source at device
+ * level before invoking this service. In turn, rtdm_irq_free ensures that any
+ * pending event on the given IRQ line is fully processed on return from this
+ * service.
+ *
  * Environments:
  *
  * This service can be called from:
@@ -1670,6 +1675,12 @@ int rtdm_irq_free(rtdm_irq_t *irq_handle);
  *
  * @return 0 on success, otherwise negative error code
  *
+ * @note This service is for exceptional use only. Drivers should always prefer
+ * interrupt masking at device level (via corresponding control registers etc.)
+ * over masking at line level. Keep in mind that the latter is incompatible
+ * with IRQ line sharing and can also be more costly as interrupt controller
+ * access requires broader synchronization.
+ *
  * Environments:
  *
  * This service can be called from:
@@ -1690,6 +1701,12 @@ int rtdm_irq_enable(rtdm_irq_t *irq_handle);
  *
  * @return 0 on success, otherwise negative error code
  *
+ * @note This service is for exceptional use only. Drivers should always prefer
+ * interrupt masking at device level (via corresponding control registers etc.)
+ * over masking at line level. Keep in mind that the latter is incompatible
+ * with IRQ line sharing and can also be more costly as interrupt controller
+ * access requires broader synchronization.
+ *
  * Environments:
  *
  * This service can be called from:


_______________________________________________
Xenomai-git mailing list
Xenomai-git@gna.org
https://mail.gna.org/listinfo/xenomai-git

Reply via email to