Documented idn parameter.
authorFlorian Pose <fp@igh-essen.com>
Tue, 09 Mar 2010 11:51:02 +0100
changeset 1861 5b285964b4e7
parent 1860 abdf7731c050
child 1862 05d224a66270
Documented idn parameter.
include/ecrt.h
--- a/include/ecrt.h	Tue Mar 09 11:50:44 2010 +0100
+++ b/include/ecrt.h	Tue Mar 09 11:51:02 2010 +0100
@@ -1143,8 +1143,13 @@
  * activation, but can be repeated subsequently, for example after the slave's
  * power supply failed.
  *
+ * The \a idn parameter can be separated into serveral sections:
+ *  - Bit 15: Standard data (0) or Product data (1)
+ *  - Bit 14 - 12: Parameter set (0 - 7)
+ *  - Bit 11 - 0: Data block number (0 - 4095)
+ *
  * Please note that the this function does not do any endianess correction.
- * Data have to be passed in EtherCAT endianess (little-endian).
+ * Multi-byte data have to be passed in EtherCAT endianess (little-endian).
  *
  * \retval  0 Success.
  * \retval <0 Error code.