fp@42: /******************************************************************************
fp@42:  *
fp@42:  *  $Id$
fp@42:  *
fp@1326:  *  Copyright (C) 2006-2008  Florian Pose, Ingenieurgemeinschaft IgH
fp@197:  *
fp@197:  *  This file is part of the IgH EtherCAT Master.
fp@197:  *
fp@1326:  *  The IgH EtherCAT Master is free software; you can redistribute it and/or
fp@1326:  *  modify it under the terms of the GNU General Public License version 2, as
fp@1326:  *  published by the Free Software Foundation.
fp@197:  *
fp@1326:  *  The IgH EtherCAT Master is distributed in the hope that it will be useful,
fp@1326:  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
fp@1326:  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
fp@1326:  *  Public License for more details.
fp@197:  *
fp@1326:  *  You should have received a copy of the GNU General Public License along
fp@1326:  *  with the IgH EtherCAT Master; if not, write to the Free Software
fp@197:  *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
fp@197:  *
fp@1363:  *  ---
fp@1363:  *
fp@1363:  *  The license mentioned above concerns the source code only. Using the
fp@1363:  *  EtherCAT technology and brand is only permitted in compliance with the
fp@1363:  *  industrial property and similar rights of Beckhoff Automation GmbH.
fp@246:  *
fp@42:  *****************************************************************************/
fp@42: 
fp@199: /**
fp@199:    \file
fp@199:    EtherCAT domain structure.
fp@199: */
fp@199: 
fp@199: /*****************************************************************************/
fp@199: 
fp@883: #ifndef __EC_DOMAIN_H__
fp@883: #define __EC_DOMAIN_H__
fp@42: 
fp@73: #include <linux/list.h>
fp@73: 
fp@54: #include "globals.h"
fp@293: #include "datagram.h"
fp@325: #include "master.h"
fp@818: #include "fmmu_config.h"
fp@42: 
fp@42: /*****************************************************************************/
fp@42: 
fp@993: /** EtherCAT domain.
fp@993:  *
fp@993:  * Handles the process data and the therefore needed datagrams of a certain
fp@993:  * group of slaves.
fp@993:  */
fp@73: struct ec_domain
fp@42: {
fp@792:     struct list_head list; /**< List item. */
fp@809:     ec_master_t *master; /**< EtherCAT master owning the domain. */
fp@792:     unsigned int index; /**< Index (just a number). */
fp@985: 
fp@985:     struct list_head fmmu_configs; /**< FMMU configurations contained. */
fp@792:     size_t data_size; /**< Size of the process data. */
fp@809:     uint8_t *data; /**< Memory for the process data. */
fp@809:     ec_origin_t data_origin; /**< Origin of the \a data memory. */
fp@809:     uint32_t logical_base_address; /**< Logical offset address of the
fp@809:                                      process data. */
fp@2269:     struct list_head datagram_pairs; /**< Datagrams pairs (main/backup) for
fp@2269:                                        process data exchange. */
fp@2453:     uint16_t working_counter[EC_MAX_NUM_DEVICES]; /**< Last working counter
fp@2368:                                                 values. */
fp@985:     uint16_t expected_working_counter; /**< Expected working counter. */
fp@792:     unsigned int working_counter_changes; /**< Working counter changes
fp@792:                                              since last notification. */
fp@2368:     unsigned int redundancy_active; /**< Non-zero, if redundancy is in use. */
fp@792:     unsigned long notify_jiffies; /**< Time of last notification. */
fp@73: };
fp@42: 
fp@42: /*****************************************************************************/
fp@42: 
fp@993: void ec_domain_init(ec_domain_t *, ec_master_t *, unsigned int);
fp@993: void ec_domain_clear(ec_domain_t *);
fp@446: 
fp@818: void ec_domain_add_fmmu_config(ec_domain_t *, ec_fmmu_config_t *);
fp@792: int ec_domain_finish(ec_domain_t *, uint32_t);
fp@42: 
fp@950: unsigned int ec_domain_fmmu_count(const ec_domain_t *);
fp@950: const ec_fmmu_config_t *ec_domain_find_fmmu(const ec_domain_t *, unsigned int);
fp@950: 
fp@42: /*****************************************************************************/
fp@42: 
fp@42: #endif