include/ecrt.h
changeset 868 aaf175ef0171
parent 864 5b6992df2931
child 869 6c2f4130ed46
equal deleted inserted replaced
867:93a0180ee938 868:aaf175ef0171
   645         uint32_t timeout /**< Timeout in milliseconds. */
   645         uint32_t timeout /**< Timeout in milliseconds. */
   646         );
   646         );
   647 
   647 
   648 /** Access to the Sdo request's data.
   648 /** Access to the Sdo request's data.
   649  *
   649  *
       
   650  * This function returns a pointer to the request's internal Sdo data memory.
       
   651  *
       
   652  * - After a read operation was successful, integer data can be evaluated using
       
   653  *   the EC_READ_*() macros as usual. Example:
       
   654  *   \code
       
   655  *   uint16_t value = EC_READ_U16(ecrt_sdo_request_data(sdo)));
       
   656  *   \endcode
       
   657  * - If a write operation shall be triggered, the data have to be written to
       
   658  *   the internal memory. Use the EC_WRITE_*() macros, if you are writing
       
   659  *   integer data. Be sure, that the data fit into the memory. The memory size
       
   660  *   is a parameter of ecrt_slave_config_create_sdo_request().
       
   661  *   \code
       
   662  *   EC_WRITE_U16(ecrt_sdo_request_data(sdo), 0xFFFF);
       
   663  *   \endcode
       
   664  *
   650  * \attention The return value can be invalid during a read operation, because
   665  * \attention The return value can be invalid during a read operation, because
   651  * the internal Sdo data memory could be re-allocated if the read Sdo data do
   666  * the internal Sdo data memory could be re-allocated if the read Sdo data do
   652  * not fit inside.
   667  * not fit inside.
   653  *
   668  *
   654  * \return Pointer to the internal Sdo data memory.
   669  * \return Pointer to the internal Sdo data memory.