include/ecrt.h
changeset 1239 b50b93faaf3e
parent 1226 afb189516fcf
child 1244 0b70040d3daa
equal deleted inserted replaced
1238:02711963a059 1239:b50b93faaf3e
    39  *
    39  *
    40  * EtherCAT interface for realtime applications. This interface is designed
    40  * EtherCAT interface for realtime applications. This interface is designed
    41  * for realtime modules that want to use EtherCAT. There are functions to
    41  * for realtime modules that want to use EtherCAT. There are functions to
    42  * request a master, to map process data, to communicate with slaves via CoE
    42  * request a master, to map process data, to communicate with slaves via CoE
    43  * and to configure and activate the bus.
    43  * and to configure and activate the bus.
       
    44  *
       
    45  * Changes in version 1.5:
       
    46  *
       
    47  * - Changed the return value of ecrt_request_master().
    44  *
    48  *
    45  * Changes in Version 1.4:
    49  * Changes in Version 1.4:
    46  *
    50  *
    47  * - Replaced ec_slave_t with ec_slave_config_t, separating the bus
    51  * - Replaced ec_slave_t with ec_slave_config_t, separating the bus
    48  *   configuration from the actual slaves. Therefore, renamed
    52  *   configuration from the actual slaves. Therefore, renamed
   338  * This function has to be the first function an application has to call to
   342  * This function has to be the first function an application has to call to
   339  * use EtherCAT. The function takes the index of the master as its argument.
   343  * use EtherCAT. The function takes the index of the master as its argument.
   340  * The first master has index 0, the n-th master has index n - 1. The number
   344  * The first master has index 0, the n-th master has index n - 1. The number
   341  * of masters has to be specified when loading the master module.
   345  * of masters has to be specified when loading the master module.
   342  *
   346  *
   343  * \return Pointer to reserved master, or \a NULL on error.
   347  * \attention In kernel context, the returned pointer has to be checked for
       
   348  * errors using the IS_ERR() macro.
       
   349  *
       
   350  * \return If \a IS_ERR() returns zero, the result is a pointer to the
       
   351  * reserved master, otherwise, the result is an error code.
   344  */
   352  */
   345 ec_master_t *ecrt_request_master(
   353 ec_master_t *ecrt_request_master(
   346         unsigned int master_index /**< Index of the master to request. */
   354         unsigned int master_index /**< Index of the master to request. */
   347         );
   355         );
   348 
   356