Module: xenomai-3
Branch: master
Commit: 8c03657e9a26fd72d48349d8c3d6d99c21051dde
URL:    
http://git.xenomai.org/?p=xenomai-3.git;a=commit;h=8c03657e9a26fd72d48349d8c3d6d99c21051dde

Author: Philippe Gerum <r...@xenomai.org>
Date:   Fri Apr 24 11:23:07 2015 +0200

rtdm/irq: clarify documentation about masking/unmasking

---

 kernel/cobalt/rtdm/drvlib.c |   30 ++++++++++++++++--------------
 1 file changed, 16 insertions(+), 14 deletions(-)

diff --git a/kernel/cobalt/rtdm/drvlib.c b/kernel/cobalt/rtdm/drvlib.c
index 329bf18..6c4bc0d 100644
--- a/kernel/cobalt/rtdm/drvlib.c
+++ b/kernel/cobalt/rtdm/drvlib.c
@@ -1376,13 +1376,14 @@ 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. Also, certain IRQ types may not
- * allow the invocation over RT and interrupt contexts. The caller is
- * responsible for excluding such conflicts.
+ * @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. Also, such service is solely available from
+ * secondary mode. The caller is responsible for excluding such
+ * conflicts.
  *
  * @coretags{secondary-only}
  */
@@ -1395,13 +1396,14 @@ 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. Also, certain IRQ types may not
- * allow the invocation over RT and interrupt contexts. The caller is
- * responsible for excluding such conflicts.
+ * @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.  Also, such service is solely available from
+ * secondary mode.  The caller is responsible for excluding such
+ * conflicts.
  *
  * @coretags{secondary-only}
  */


_______________________________________________
Xenomai-git mailing list
Xenomai-git@xenomai.org
http://www.xenomai.org/mailman/listinfo/xenomai-git

Reply via email to