diff -r f8a1e9f364a3 -r b9a6e2c22745 master/domain.c --- a/master/domain.c Thu Apr 20 14:34:58 2006 +0000 +++ b/master/domain.c Fri Apr 21 12:35:17 2006 +0000 @@ -6,6 +6,23 @@ * * $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" @@ -42,6 +59,7 @@ /** Domain constructor. \return 0 in case of success, else < 0 + \ingroup Domain */ int ec_domain_init(ec_domain_t *domain, /**< EtherCAT domain */ @@ -75,6 +93,7 @@ /** Domain destructor. + \ingroup Domain */ void ec_domain_clear(struct kobject *kobj /**< kobject of the domain */) @@ -101,6 +120,7 @@ /** 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 */ @@ -138,6 +158,7 @@ /** Clears the list of the registered data fields. + \ingroup Domain */ void ec_domain_clear_field_regs(ec_domain_t *domain /**< EtherCAT domain */) @@ -155,6 +176,7 @@ /** 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 */ @@ -188,6 +210,7 @@ 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 */ @@ -281,6 +304,7 @@ 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 */ @@ -299,6 +323,7 @@ /** Formats attribute data for SysFS reading. \return number of bytes to read + \ingroup Domain */ ssize_t ec_show_domain_attribute(struct kobject *kobj, /**< kobject */ @@ -327,6 +352,7 @@ - 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, @@ -418,6 +444,7 @@ 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, @@ -443,6 +470,7 @@ /** Places all process data commands in the masters command queue. + \ingroup Domain */ void ecrt_domain_queue(ec_domain_t *domain /**< EtherCAT domain */) @@ -458,6 +486,7 @@ /** Processes received process data. + \ingroup Domain */ void ecrt_domain_process(ec_domain_t *domain /**< EtherCAT domain */) @@ -481,6 +510,7 @@ /** 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 */)