Added slave_info documentation.
authorFlorian Pose <fp@igh-essen.com>
Tue, 10 Jan 2012 10:10:58 +0100
changeset 2248 82afd3a5bab1
parent 2247 00e3937e0f0a
child 2249 6dbd7594dd1d
Added slave_info documentation.
include/ecrt.h
--- a/include/ecrt.h	Tue Jan 10 10:13:13 2012 +0100
+++ b/include/ecrt.h	Tue Jan 10 10:10:58 2012 +0100
@@ -269,12 +269,14 @@
     uint16_t alias; /**< The slaves alias if not equal to 0. */
     int16_t current_on_ebus; /**< Used current in mA. */
     struct {
-        ec_slave_port_desc_t desc;
-        ec_slave_port_link_t link;
-        uint32_t receive_time;
-        uint16_t next_slave;
-        uint32_t delay_to_next_dc;
-    } ports[EC_MAX_PORTS];
+        ec_slave_port_desc_t desc; /**< Physical port type. */
+        ec_slave_port_link_t link; /**< Port link state. */
+        uint32_t receive_time; /**< Receive time on DC transmission delay
+                                 measurement. */
+        uint16_t next_slave; /**< Ring position of next DC slave on that
+                               port.  */
+        uint32_t delay_to_next_dc; /**< Delay [ns] to next DC slave. */
+    } ports[EC_MAX_PORTS]; /**< Port information. */
     uint8_t al_state; /**< Current state of the slave. */
     uint8_t error_flag; /**< Error flag for that slave. */
     uint8_t sync_count; /**< Number of sync managers. */