include/ecrt.h
branchstable-1.5
changeset 2109 755e6ce823f0
parent 2009 b5391b329b5d
child 2124 c4afc5fede19
--- a/include/ecrt.h	Thu Sep 15 16:31:43 2011 +0200
+++ b/include/ecrt.h	Thu Sep 15 16:33:13 2011 +0200
@@ -635,14 +635,16 @@
         ec_pdo_entry_info_t *entry /**< Pointer to output structure. */
         );
 
-/** Executes an SDO write request to download data.
- *
- * This function operates aside of the normal way to request SDOs. Before the
- * activation of the master, these requests are processed by the master state
- * machine itself. After activation the user has to ensure cyclic processing.
+#endif /* #ifndef __KERNEL__ */
+
+/** Executes an SDO download request to write data to a slave.
+ *
+ * This request is processed by the master state machine. This method blocks,
+ * until the request has been processed and may not be called in realtime
+ * context.
  *
  * \retval  0 Success.
- * \retval -1 An error occured.
+ * \retval <0 Error code.
  */
 int ecrt_master_sdo_download(
         ec_master_t *master, /**< EtherCAT master. */
@@ -654,15 +656,14 @@
         uint32_t *abort_code /**< Abort code of the SDO download. */
         );
 
-/** Executes a SDO read request to upload data.
- *
- * This function operates aside of the normal way to request SDOs. Before the
- * activation of the master, these requests are processed by the master state
- * machine itself. After activation the user have to ensure cyclic
- * processing.
+/** Executes an SDO upload request to read data from a slave.
+ *
+ * This request is processed by the master state machine. This method blocks,
+ * until the request has been processed and may not be called in realtime
+ * context.
  *
  * \retval  0 Success.
- * \retval -1 Error occurred.
+ * \retval <0 Error code.
  */
 int ecrt_master_sdo_upload(
         ec_master_t *master, /**< EtherCAT master. */
@@ -675,8 +676,6 @@
         uint32_t *abort_code /**< Abort code of the SDO upload. */
         );
 
-#endif /* #ifndef __KERNEL__ */
-
 /** Executes an SoE write request.
  *
  * Starts writing an IDN and blocks until the request was processed, or an