master/canopen.c
changeset 758 8fa6f825eb7d
parent 740 68d83b45dfa2
child 814 a51f857b1b2d
--- a/master/canopen.c	Mon Sep 24 10:35:00 2007 +0000
+++ b/master/canopen.c	Mon Sep 24 12:12:11 2007 +0000
@@ -171,9 +171,14 @@
 
 /*****************************************************************************/
 
+/**
+ * Get and SDO entry from an SDO via its subindex.
+ * \return pointer to SDO entry, or NULL.
+ */
+
 ec_sdo_entry_t *ec_sdo_get_entry(
-        ec_sdo_t *sdo,
-        uint8_t subindex
+        ec_sdo_t *sdo, /**< SDO */
+        uint8_t subindex /**< entry subindex */
         )
 {
     ec_sdo_entry_t *entry;
@@ -188,6 +193,11 @@
 
 /*****************************************************************************/
 
+/**
+ * Print SDO information to a buffer.
+ * /return size of bytes written to buffer.
+ */ 
+
 ssize_t ec_sdo_info(ec_sdo_t *sdo, /**< SDO */
                     char *buffer /**< target buffer */
                     )
@@ -203,6 +213,11 @@
 
 /*****************************************************************************/
 
+/**
+ * Show an SDO as Sysfs attribute.
+ * /return size of bytes written to buffer.
+ */ 
+
 ssize_t ec_show_sdo_attribute(struct kobject *kobj, /**< kobject */
                               struct attribute *attr,
                               char *buffer
@@ -285,6 +300,11 @@
 }
 
 /*****************************************************************************/
+ 
+/**
+ * Print SDO entry information to a buffer.
+ * \return number of bytes written.
+ */
 
 ssize_t ec_sdo_entry_info(ec_sdo_entry_t *entry, /**< SDO entry */
                           char *buffer /**< target buffer */
@@ -303,6 +323,11 @@
 
 /*****************************************************************************/
 
+/**
+ * Format entry data based on the CANopen data type and print it to a buffer.
+ * \return number of bytes written.
+ */
+
 ssize_t ec_sdo_entry_format_data(ec_sdo_entry_t *entry, /**< SDO entry */
                                  ec_sdo_request_t *request, /**< SDO request */
                                  char *buffer /**< target buffer */
@@ -376,6 +401,13 @@
 
 /*****************************************************************************/
 
+/**
+ * Start SDO entry reading.
+ * This function blocks, until reading is finished, and is interruptible as
+ * long as the master state machine has not begun with reading.
+ * \return number of bytes written to buffer, or error code.
+ */
+
 ssize_t ec_sdo_entry_read_value(ec_sdo_entry_t *entry, /**< SDO entry */
                                 char *buffer /**< target buffer */
                                 )
@@ -419,6 +451,11 @@
 
 /*****************************************************************************/
 
+/**
+ * Show an SDO entry as Sysfs attribute.
+ * /return size of bytes written to buffer.
+ */ 
+
 ssize_t ec_show_sdo_entry_attribute(struct kobject *kobj, /**< kobject */
                                     struct attribute *attr,
                                     char *buffer