include/ecrt.h
changeset 878 40c379697ebf
parent 869 6c2f4130ed46
child 879 9b395c5646ab
--- a/include/ecrt.h	Wed Mar 19 10:51:18 2008 +0000
+++ b/include/ecrt.h	Mon Mar 31 09:42:37 2008 +0000
@@ -120,6 +120,14 @@
  */
 #define ECRT_VERSION_MAGIC ECRT_VERSION(ECRT_VER_MAJOR, ECRT_VER_MINOR)
 
+/*****************************************************************************/
+
+/** End of mapping.
+ *
+ * This is used in ecrt_slave_config_mapping().
+ */
+#define EC_MAP_END ~0U
+
 /******************************************************************************
  * Data types 
  *****************************************************************************/
@@ -467,6 +475,12 @@
  *     return -1; // error
  * \endcode
  *
+ * Processing of \a pdo_infos will stop, if
+ * - the number of processed items reaches \a n_infos, or
+ * - the \a dir member of an ec_pdo_info_t item is EC_MAP_END. In this case,
+ *   \a n_infos should set to a number greater than the number of list items;
+ *   using EC_MAP_END is recommended.
+ *
  * \return zero on success, else non-zero
  */
 int ecrt_slave_config_mapping(