ethernet.h

Go to the documentation of this file.

/******************************************************************************
 *
 *  $Id$
 *
 *  Copyright (C) 2006-2008  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 version 2, as
 *  published by the Free Software Foundation.
 *
 *  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 license mentioned above concerns the source code only. Using the
 *  EtherCAT technology and brand is only permitted in compliance with the
 *  industrial property and similar rights of Beckhoff Automation GmbH.
 *
 *****************************************************************************/

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

#ifndef __EC_ETHERNET_H__
#define __EC_ETHERNET_H__

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

#include "globals.h"
#include "locks.h"
#include "slave.h"
#include "datagram.h"

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

enum {
    EC_EOE_TYPE_FRAME_FRAG =      0x00, 
    EC_EOE_TYPE_TIMESTAMP_RES =   0x01, 
    EC_EOE_TYPE_INIT_REQ =        0x02, 
    EC_EOE_TYPE_INIT_RES =        0x03, 
    EC_EOE_TYPE_MACFILTER_REQ =   0x04, 
    EC_EOE_TYPE_MACFILTER_RES =   0x05, 
};

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

typedef struct ec_eoe ec_eoe_t; 
struct ec_eoe
{
    struct list_head list; 
    ec_master_t *master; 
    ec_slave_t *slave; 
    ec_datagram_t datagram; 
    unsigned int queue_datagram; 
    void (*state)(ec_eoe_t *); 
    struct net_device *dev; 
    struct net_device_stats stats; 
    unsigned int opened; 
    unsigned long rate_jiffies; 
    unsigned int have_mbox_lock; 
    unsigned int auto_created; 
    struct sk_buff *rx_skb; 
    off_t rx_skb_offset; 
    size_t rx_skb_size; 
    uint8_t rx_expected_fragment; 
    uint32_t rx_counter; 
    uint32_t rx_rate; 
    unsigned int rx_idle; 
    struct sk_buff **tx_ring; 
    unsigned int tx_ring_count; 
    unsigned int tx_ring_size; 
    unsigned int tx_next_to_use; 
    unsigned int tx_next_to_clean; 
    unsigned int tx_queue_active; 
    struct sk_buff *tx_skb; 
    uint8_t tx_frame_number; 
    uint8_t tx_fragment_number; 
    size_t tx_offset; 
    uint32_t tx_counter; 
    uint32_t tx_rate; 
    unsigned int tx_idle; 
    unsigned int tries; 
};

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

int ec_eoe_parse(const char *, int *, uint16_t *, uint16_t *);

int ec_eoe_init(ec_master_t *, ec_eoe_t *, uint16_t/*alias*/, uint16_t/*posn*/);
int ec_eoe_auto_init(ec_eoe_t *, ec_slave_t *);
void ec_eoe_link_slave(ec_eoe_t *, ec_slave_t *);
void ec_eoe_clear_slave(ec_eoe_t *);
void ec_eoe_clear(ec_eoe_t *);
void ec_eoe_run(ec_eoe_t *);
void ec_eoe_queue(ec_eoe_t *);
int ec_eoe_is_open(const ec_eoe_t *);
int ec_eoe_is_idle(const ec_eoe_t *);
char *ec_eoe_name(const ec_eoe_t *);
unsigned int ec_eoe_tx_queued_frames(const ec_eoe_t *);

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

#endif

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