/******************************************************************************
 *
 *  $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; either version 2 of the
 *  License, or (at your option) any later version.
 *
 *  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
 *
 *  The right to use EtherCAT Technology is granted and comes free of
 *  charge under condition of compatibility of product made by
 *  Licensee. People intending to distribute/sell products based on the
 *  code, have to sign an agreement to guarantee that products using
 *  software based on IgH EtherCAT master stay compatible with the actual
 *  EtherCAT specification (which are released themselves as an open
 *  standard) as the (only) precondition to have the right to use EtherCAT
 *  Technology, IP and trade marks.
 *
 *****************************************************************************/

/**
   \file
   Ethernet-over-EtherCAT (EoE)
*/

/*****************************************************************************/

#include <linux/list.h>
#include <linux/netdevice.h>

#include "../include/ecrt.h"
#include "globals.h"
#include "slave.h"
#include "command.h"

/*****************************************************************************/

/**
   Queued frame structure.
*/

typedef struct
{
    struct list_head queue; /**< list item */
    struct sk_buff *skb; /**< socket buffer */
}
ec_eoe_frame_t;

/*****************************************************************************/

typedef struct ec_eoe ec_eoe_t;

/**
   Ethernet-over-EtherCAT (EoE) handler.
   The master creates one of these objects for each slave that supports the
   EoE protocol.
*/

struct ec_eoe
{
    struct list_head list; /**< list item */
    ec_slave_t *slave; /**< pointer to the corresponding slave */
    void (*state)(ec_eoe_t *); /**< state function for the state machine */
    struct net_device *dev; /**< net_device for virtual ethernet device */
    struct net_device_stats stats; /**< device statistics */
    unsigned int opened; /**< net_device is opened */
    struct sk_buff *rx_skb; /**< current rx socket buffer */
    off_t rx_skb_offset; /**< current write pointer in the socket buffer */
    size_t rx_skb_size; /**< size of the allocated socket buffer memory */
    uint8_t rx_expected_fragment; /**< next expected fragment number */
    struct list_head tx_queue; /**< queue for frames to send */
    unsigned int tx_queue_active; /**< kernel netif queue started */
    unsigned int tx_queued_frames; /**< number of frames in the queue */
    spinlock_t tx_queue_lock; /**< spinlock for the send queue */
    ec_eoe_frame_t *tx_frame; /**< current TX frame */
    uint8_t tx_frame_number; /**< number of the transmitted frame */
    uint8_t tx_fragment_number; /**< number of the fragment */
    size_t tx_offset; /**< number of octets sent */
};

/*****************************************************************************/

int ec_eoe_init(ec_eoe_t *);
void ec_eoe_clear(ec_eoe_t *);
void ec_eoe_run(ec_eoe_t *);
unsigned int ec_eoe_active(const ec_eoe_t *);
void ec_eoe_print(const ec_eoe_t *);

/*****************************************************************************/