fp@104: /******************************************************************************
fp@104:  *
fp@195:  *  $Id$
fp@104:  *
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@104:  *****************************************************************************/
fp@104: 
fp@199: /**
fp@199:    \file
fp@199:    EtherCAT interface for EtherCAT device drivers.
fp@199: */
fp@199: 
fp@199: /**
fp@199:    \defgroup DeviceInterface EtherCAT device interface
fp@199:    Master interface for EtherCAT-capable network device drivers.
fp@199:    Through the EtherCAT device interface, EtherCAT-capable network device
fp@199:    drivers are able to connect their device(s) to the master, pass received
fp@199:    frames and notify the master about status changes. The master on his part,
fp@199:    can send his frames through connected devices.
fp@199: */
fp@199: 
fp@199: /*****************************************************************************/
fp@199: 
fp@104: #ifndef _ETHERCAT_DEVICE_H_
fp@104: #define _ETHERCAT_DEVICE_H_
fp@104: 
fp@104: #include <linux/netdevice.h>
fp@104: 
fp@104: /*****************************************************************************/
fp@104: 
fp@104: struct ec_device;
fp@286: typedef struct ec_device ec_device_t; /**< \see ec_device */
fp@286: 
fp@286: /**
fp@1739:    Device poll function type.
fp@286: */
fp@104: 
fp@1739: typedef void (*ec_pollfunc_t)(struct net_device *);
fp@104: 
fp@104: /*****************************************************************************/
fp@1744: // Offering/withdrawal functions
fp@104: 
fp@1744: int ecdev_offer(struct net_device *net_dev, ec_pollfunc_t poll,
fp@1744:         struct module *module, ec_device_t **);
fp@1744: void ecdev_withdraw(ec_device_t *device);
fp@104: 
fp@104: /*****************************************************************************/
fp@104: // Device methods
fp@104: 
fp@1739: int ecdev_open(ec_device_t *device);
fp@1739: void ecdev_close(ec_device_t *device);
fp@104: void ecdev_receive(ec_device_t *device, const void *data, size_t size);
fp@1744: void ecdev_set_link(ec_device_t *device, uint8_t state);
fp@1744: uint8_t ecdev_get_link(ec_device_t *device);
fp@104: 
fp@104: /*****************************************************************************/
fp@104: 
fp@104: #endif