[Xenomai-git] Philippe Gerum : cobalt/udd: fix documentation

2015-06-29 Thread git repository hosting
Module: xenomai-3
Branch: master
Commit: 831a40791c6d15a057288b5116d3cac9231b80c9
URL:
http://git.xenomai.org/?p=xenomai-3.git;a=commit;h=831a40791c6d15a057288b5116d3cac9231b80c9

Author: Philippe Gerum r...@xenomai.org
Date:   Mon Jun 22 14:18:10 2015 +0200

cobalt/udd: fix documentation

---

 include/cobalt/kernel/rtdm/udd.h |5 +++--
 kernel/drivers/udd/udd.c |7 +--
 2 files changed, 4 insertions(+), 8 deletions(-)

diff --git a/include/cobalt/kernel/rtdm/udd.h b/include/cobalt/kernel/rtdm/udd.h
index 3838f6b..aa9e838 100644
--- a/include/cobalt/kernel/rtdm/udd.h
+++ b/include/cobalt/kernel/rtdm/udd.h
@@ -65,8 +65,9 @@
 #define UDD_IRQ_NONE 0
 /**
  * IRQ directly managed from the mini-driver on top of the UDD
- * core. The mini-driver is in charge of notifying the Cobalt threads
- * waiting for IRQ events by calling the udd_notify_event() service.
+ * core. The mini-driver is in charge of attaching the handler(s) to
+ * the IRQ(s) it manages, notifying the Cobalt threads waiting for IRQ
+ * events by calling the udd_notify_event() service.
  */
 #define UDD_IRQ_CUSTOM   (-1)
 /** @} */
diff --git a/kernel/drivers/udd/udd.c b/kernel/drivers/udd/udd.c
index d0ca846..6f12235 100644
--- a/kernel/drivers/udd/udd.c
+++ b/kernel/drivers/udd/udd.c
@@ -181,11 +181,6 @@ static int udd_irq_handler(rtdm_irq_t *irqh)
struct udd_device *udd;
int ret;
 
-   /*
-* CAUTION: irqh might live outside of the udd_device struct
-* (i.e. UDD_IRQ_CUSTOM), so we can't assume the latter is
-* the container of the former.
-*/
udd = rtdm_irq_get_arg(irqh, struct udd_device);
ret = udd-ops.interrupt(udd);
if (ret == RTDM_IRQ_HANDLED)
@@ -495,7 +490,7 @@ EXPORT_SYMBOL_GPL(udd_unregister_device);
  *
  * @coretags{coreirq-only}
  *
- * @note In case the ref udd_irq_handler IRQ handler from the
+ * @note In case the @ref udd_irq_handler IRQ handler from the
  * mini-driver requested the UDD core not to re-enable the interrupt
  * line, the application may later request the unmasking by issuing
  * the UDD_RTIOC_IRQEN ioctl(2) command. Writing a non-zero integer to


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


[Xenomai-git] Philippe Gerum : cobalt/udd: fix documentation

2015-06-22 Thread git repository hosting
Module: xenomai-3
Branch: next
Commit: 831a40791c6d15a057288b5116d3cac9231b80c9
URL:
http://git.xenomai.org/?p=xenomai-3.git;a=commit;h=831a40791c6d15a057288b5116d3cac9231b80c9

Author: Philippe Gerum r...@xenomai.org
Date:   Mon Jun 22 14:18:10 2015 +0200

cobalt/udd: fix documentation

---

 include/cobalt/kernel/rtdm/udd.h |5 +++--
 kernel/drivers/udd/udd.c |7 +--
 2 files changed, 4 insertions(+), 8 deletions(-)

diff --git a/include/cobalt/kernel/rtdm/udd.h b/include/cobalt/kernel/rtdm/udd.h
index 3838f6b..aa9e838 100644
--- a/include/cobalt/kernel/rtdm/udd.h
+++ b/include/cobalt/kernel/rtdm/udd.h
@@ -65,8 +65,9 @@
 #define UDD_IRQ_NONE 0
 /**
  * IRQ directly managed from the mini-driver on top of the UDD
- * core. The mini-driver is in charge of notifying the Cobalt threads
- * waiting for IRQ events by calling the udd_notify_event() service.
+ * core. The mini-driver is in charge of attaching the handler(s) to
+ * the IRQ(s) it manages, notifying the Cobalt threads waiting for IRQ
+ * events by calling the udd_notify_event() service.
  */
 #define UDD_IRQ_CUSTOM   (-1)
 /** @} */
diff --git a/kernel/drivers/udd/udd.c b/kernel/drivers/udd/udd.c
index d0ca846..6f12235 100644
--- a/kernel/drivers/udd/udd.c
+++ b/kernel/drivers/udd/udd.c
@@ -181,11 +181,6 @@ static int udd_irq_handler(rtdm_irq_t *irqh)
struct udd_device *udd;
int ret;
 
-   /*
-* CAUTION: irqh might live outside of the udd_device struct
-* (i.e. UDD_IRQ_CUSTOM), so we can't assume the latter is
-* the container of the former.
-*/
udd = rtdm_irq_get_arg(irqh, struct udd_device);
ret = udd-ops.interrupt(udd);
if (ret == RTDM_IRQ_HANDLED)
@@ -495,7 +490,7 @@ EXPORT_SYMBOL_GPL(udd_unregister_device);
  *
  * @coretags{coreirq-only}
  *
- * @note In case the ref udd_irq_handler IRQ handler from the
+ * @note In case the @ref udd_irq_handler IRQ handler from the
  * mini-driver requested the UDD core not to re-enable the interrupt
  * line, the application may later request the unmasking by issuing
  * the UDD_RTIOC_IRQEN ioctl(2) command. Writing a non-zero integer to


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