LinCAN driver structured comments updated.

[lincan.git] / lincan / src / devcommon.c

diff --git a/lincan/src/devcommon.c b/lincan/src/devcommon.c
index c0b602886f49a8a64abf7552aae9ad73262732c2..e17a0618d7709a3ebc5c801077904c605fdab2d5 100644 (file)
--- a/lincan/src/devcommon.c
+++ b/lincan/src/devcommon.c
@@ -12,6 +12,17 @@
 #include "../include/main.h"
 #include "../include/devcommon.h"
 
+/**
+ * canqueue_notify_chip - notification callback handler for CAN chips ends of queues
+ * @qends: pointer to the callback side ends structure
+ * @qedge: edge which invoked notification 
+ * @what: notification type
+ *
+ * This function has to deal with more possible cases. It can be called from
+ * the kernel or interrupt context for Linux only compilation of driver.
+ * The function can be called from kernel context or RT-Linux thread context
+ * for mixed mode Linux/RT-Linux compilation.
+ */
 void canqueue_notify_chip(struct canque_ends_t *qends, struct canque_edge_t *qedge, int what)
 {
        struct chip_t *chip=qends->endinfo.chipinfo.chip;
@@ -56,6 +67,12 @@ void canqueue_notify_chip(struct canque_ends_t *qends, struct canque_edge_t *qed
 }
 
 
+/**
+ * canqueue_ends_init_chip - CAN chip specific ends initialization
+ * @qends: pointer to the ends structure
+ * @chip: pointer to the corresponding CAN chip structure
+ * @obj: pointer to the corresponding message object structure
+ */
 int canqueue_ends_init_chip(struct canque_ends_t *qends, struct chip_t *chip, struct msgobj_t *obj)
 {
        int ret;
@@ -75,6 +92,12 @@ int canqueue_ends_init_chip(struct canque_ends_t *qends, struct chip_t *chip, st
 }
 
 
+/**
+ * canqueue_ends_done_chip - finalizing of the ends structure for CAN chips
+ * @qends: pointer to ends structure
+ *
+ * Return Value: Function should be designed such way to not fail.
+ */
 int canqueue_ends_done_chip(struct canque_ends_t *qends)
 {
        int delayed;