etherlabmaster: comparison master/domain.c

equal deleted inserted replaced

-:f8a1e9f364a3
+:b9a6e2c22745
 *  d o m a i n . c
 *
 *  EtherCAT domain methods.
 *
 *  $Id$
+*
+*  Copyright (C) 2006  Florian Pose, Ingenieurgemeinschaft IgH
+*
+*  This file is part of the IgH EtherCAT Master.
+*
+*  The IgH EtherCAT Master is free software; you can redistribute it
+*  and/or modify it under the terms of the GNU General Public License
+*  as published by the Free Software Foundation; version 2 of the License.
+*
+*  The IgH EtherCAT Master is distributed in the hope that it will be
+*  useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
+*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+*  GNU General Public License for more details.
+*
+*  You should have received a copy of the GNU General Public License
+*  along with the IgH EtherCAT Master; if not, write to the Free Software
+*  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 *****************************************************************************/
 #include "globals.h"
 #include "domain.h"
 /*****************************************************************************/
 /**
 Domain constructor.
 \return 0 in case of success, else < 0
+\ingroup Domain
 */
 int ec_domain_init(ec_domain_t *domain, /**< EtherCAT domain */
 ec_master_t *master, /**< owning master */
 unsigned int index /**< domain index */
 /*****************************************************************************/
 /**
 Domain destructor.
+\ingroup Domain
 */
 void ec_domain_clear(struct kobject *kobj /**< kobject of the domain */)
 {
 ec_command_t *command, *next;
 /*****************************************************************************/
 /**
 Registeres a data field in a domain.
 \return 0 in case of success, else < 0
+\ingroup Domain
 */
 int ec_domain_reg_field(ec_domain_t *domain, /**< EtherCAT domain */
 ec_slave_t *slave, /**< slave */
 const ec_sync_t *sync, /**< sync manager */
 /*****************************************************************************/
 /**
 Clears the list of the registered data fields.
+\ingroup Domain
 */
 void ec_domain_clear_field_regs(ec_domain_t *domain /**< EtherCAT domain */)
 {
 ec_field_reg_t *field_reg, *next;
 /*****************************************************************************/
 /**
 Allocates a process data command and appends it to the list.
 \return 0 in case of success, else < 0
+\ingroup Domain
 */
 int ec_domain_add_command(ec_domain_t *domain, /**< EtherCAT domain */
 uint32_t offset, /**< logical offset */
 size_t data_size /**< size of the command data */
 Creates a domain.
 Reserves domain memory, calculates the logical addresses of the
 corresponding FMMUs and sets the process data pointer of the registered
 data fields.
 \return 0 in case of success, else < 0
+\ingroup Domain
 */
 int ec_domain_alloc(ec_domain_t *domain, /**< EtherCAT domain */
 uint32_t base_address /**< Logische Basisadresse */
 )
 /**
 Sets the number of responding slaves and outputs it on demand.
 This number isn't really the number of responding slaves, but the sum of
 the working counters of all domain commands. Some slaves increase the
 working counter by 2, some by 1.
+\ingroup Domain
 */
 void ec_domain_response_count(ec_domain_t *domain, /**< EtherCAT domain */
 unsigned int count /**< new WC sum */
 )
 /*****************************************************************************/
 /**
 Formats attribute data for SysFS reading.
 \return number of bytes to read
+\ingroup Domain
 */
 ssize_t ec_show_domain_attribute(struct kobject *kobj, /**< kobject */
 struct attribute *attr, /**< attribute */
 char *buffer /**< memory to store data in */
 - If \a field_count is 0, it is assumed that one data field is to be
 registered.
 - If \a field_count is greater then 1, it is assumed that \a data_ptr
 is an array of the respective size.
 \return pointer to the slave on success, else NULL
+\ingroup Domain
 */
 ec_slave_t *ecrt_domain_register_field(ec_domain_t *domain,
 /**< EtherCAT domain */
 const char *address,
 /**
 Registeres a bunch of data fields.
 Caution! The list has to be terminated with a NULL structure ({})!
 \return 0 in case of success, else < 0
+\ingroup Domain
 */
 int ecrt_domain_register_field_list(ec_domain_t *domain,
 /**< EtherCAT domain */
 const ec_field_init_t *fields
 /*****************************************************************************/
 /**
 Places all process data commands in the masters command queue.
+\ingroup Domain
 */
 void ecrt_domain_queue(ec_domain_t *domain /**< EtherCAT domain */)
 {
 ec_command_t *command;
 /*****************************************************************************/
 /**
 Processes received process data.
+\ingroup Domain
 */
 void ecrt_domain_process(ec_domain_t *domain /**< EtherCAT domain */)
 {
 unsigned int working_counter_sum;
 /*****************************************************************************/
 /**
 Returns the state of a domain.
 \return 0 if all commands were received, else -1.
+\ingroup Domain
 */
 int ecrt_domain_state(ec_domain_t *domain /**< EtherCAT domain */)
 {
 ec_command_t *command;

changeset 197	b9a6e2c22745
parent 195	674071846ee3
child 199	04ecf40fc2e9