1

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

     2

 *

     3

 *  $Id$

     4

 *

     5

 *  Copyright (C) 2006  Florian Pose, Ingenieurgemeinschaft IgH

     6

 *

     7

 *  This file is part of the IgH EtherCAT Master.

     8

 *

     9

 *  The IgH EtherCAT Master is free software; you can redistribute it

    10

 *  and/or modify it under the terms of the GNU General Public License

    11

 *  as published by the Free Software Foundation; either version 2 of the

    12

 *  License, or (at your option) any later version.

    13

 *

    14

 *  The IgH EtherCAT Master is distributed in the hope that it will be

    15

 *  useful, but WITHOUT ANY WARRANTY; without even the implied warranty of

    16

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    17

 *  GNU General Public License for more details.

    18

 *

    19

 *  You should have received a copy of the GNU General Public License

    20

 *  along with the IgH EtherCAT Master; if not, write to the Free Software

    21

 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

    22

 *

    23

 *  The right to use EtherCAT Technology is granted and comes free of

    24

 *  charge under condition of compatibility of product made by

    25

 *  Licensee. People intending to distribute/sell products based on the

    26

 *  code, have to sign an agreement to guarantee that products using

    27

 *  software based on IgH EtherCAT master stay compatible with the actual

    28

 *  EtherCAT specification (which are released themselves as an open

    29

 *  standard) as the (only) precondition to have the right to use EtherCAT

    30

 *  Technology, IP and trade marks.

    31

 *

    32

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

    33

    34

/**

    35

   \file

    36

   EtherCAT device structure.

    37

*/

    38

    39

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

    40

    41

#ifndef _EC_DEVICE_H_

    42

#define _EC_DEVICE_H_

    43

    44

#include <linux/interrupt.h>

    45

    46

#include "../include/ecrt.h"

    47

#include "../devices/ecdev.h"

    48

#include "globals.h"

    49

    50

#ifdef EC_DBG_IF

    51

#include "debug.h"

    52

#endif

    53

    54

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

    55

    56

/**

    57

   EtherCAT device.

    58

   An EtherCAT device is a network interface card, that is owned by an

    59

   EtherCAT master to send and receive EtherCAT frames with.

    60

*/

    61

    62

struct ec_device

    63

{

    64

    ec_master_t *master; /**< EtherCAT master */

    65

    struct net_device *dev; /**< pointer to the assigned net_device */

    66

    ec_pollfunc_t poll; /**< pointer to the device's poll function */

    67

    struct module *module; /**< pointer to the device's owning module */

    68

    uint8_t open; /**< true, if the net_device has been opened */

    69

    uint8_t link_state; /**< device link state */

    70

    struct sk_buff *tx_skb; /**< transmit socket buffer */

    71

    struct ethhdr *eth; /**< pointer to ethernet header in socket buffer */

    72

    cycles_t cycles_poll; /**< cycles of last poll */

    73

    unsigned long jiffies_poll; /**< jiffies of last poll */

    74

    unsigned int tx_count; /**< number of frames sent */

    75

    unsigned int rx_count; /**< number of frames received */

    76

#ifdef EC_DBG_IF

    77

    ec_debug_t dbg; /**< debug device */

    78

#endif

    79

};

    80

    81

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

    82

    83

int ec_device_init(ec_device_t *, ec_master_t *);

    84

void ec_device_clear(ec_device_t *);

    85

    86

void ec_device_attach(ec_device_t *, struct net_device *, ec_pollfunc_t,

    87

        struct module *);

    88

void ec_device_detach(ec_device_t *);

    89

    90

int ec_device_open(ec_device_t *);

    91

int ec_device_close(ec_device_t *);

    92

    93

void ec_device_poll(ec_device_t *);

    94

uint8_t *ec_device_tx_data(ec_device_t *);

    95

void ec_device_send(ec_device_t *, size_t);

    96

    97

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

    98

    99

#endif