fp@42: /******************************************************************************
fp@42:  *
fp@42:  *  $Id$
fp@42:  *
fp@197:  *  Copyright (C) 2006  Florian Pose, Ingenieurgemeinschaft IgH
fp@197:  *
fp@197:  *  This file is part of the IgH EtherCAT Master.
fp@197:  *
fp@197:  *  The IgH EtherCAT Master is free software; you can redistribute it
fp@197:  *  and/or modify it under the terms of the GNU General Public License
fp@246:  *  as published by the Free Software Foundation; either version 2 of the
fp@246:  *  License, or (at your option) any later version.
fp@197:  *
fp@197:  *  The IgH EtherCAT Master is distributed in the hope that it will be
fp@197:  *  useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
fp@197:  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
fp@197:  *  GNU General Public License for more details.
fp@197:  *
fp@197:  *  You should have received a copy of the GNU General Public License
fp@197:  *  along 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@246:  *  The right to use EtherCAT Technology is granted and comes free of
fp@246:  *  charge under condition of compatibility of product made by
fp@246:  *  Licensee. People intending to distribute/sell products based on the
fp@246:  *  code, have to sign an agreement to guarantee that products using
fp@246:  *  software based on IgH EtherCAT master stay compatible with the actual
fp@246:  *  EtherCAT specification (which are released themselves as an open
fp@246:  *  standard) as the (only) precondition to have the right to use EtherCAT
fp@246:  *  Technology, IP and trade marks.
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@178: #include <linux/kobject.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@42: /**
fp@195:    EtherCAT domain.
fp@293:    Handles the process data and the therefore needed datagrams of a certain
fp@195:    group of slaves.
fp@42: */
fp@42: 
fp@73: struct ec_domain
fp@42: {
fp@792:     struct kobject kobj; /**< kobject. */
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@792:     size_t data_size; /**< Size of the process data. */
fp@818:     unsigned int expected_working_counter; /**< Expected working counter. */
fp@809:     uint8_t *data; /**< Memory for the process data. */
fp@809:     ec_origin_t data_origin; /**< Origin of the \a data memory. */
fp@792:     struct list_head datagrams; /**< Datagrams for process data exchange. */
fp@809:     uint32_t logical_base_address; /**< Logical offset address of the
fp@809:                                      process data. */
fp@792:     unsigned int working_counter; /**< Last working counter value. */
fp@792:     unsigned int working_counter_changes; /**< Working counter changes
fp@792:                                              since last notification. */
fp@792:     unsigned long notify_jiffies; /**< Time of last notification. */
fp@73: };
fp@42: 
fp@42: /*****************************************************************************/
fp@42: 
fp@178: int ec_domain_init(ec_domain_t *, ec_master_t *, unsigned int);
fp@448: void ec_domain_destroy(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@42: /*****************************************************************************/
fp@42: 
fp@42: #endif