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

   Ethernet interface for debugging purposes.

    37

*/

    38

    39

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

    40

    41

#include <linux/netdevice.h>

    42

#include <linux/etherdevice.h>

    43

    44

#include "globals.h"

    45

#include "debug.h"

    46

    47

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

    48

    49

// net_device functions

    50

int ec_dbgdev_open(struct net_device *);

    51

int ec_dbgdev_stop(struct net_device *);

    52

int ec_dbgdev_tx(struct sk_buff *, struct net_device *);

    53

struct net_device_stats *ec_dbgdev_stats(struct net_device *);

    54

    55

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

    56

    57

/**

    58

   Debug constructor.

    59

   Initializes the debug object, creates a net_device and registeres it.

    60

*/

    61

    62

int ec_debug_init(

    63

        ec_debug_t *dbg, /**< debug object */

    64

        const char *name /**< interface name */

    65

        )

    66

{

    67

    int result;

    68

    69

    dbg->opened = 0;

    70

    memset(&dbg->stats, 0, sizeof(struct net_device_stats));

    71

    72

    if (!(dbg->dev =

    73

          alloc_netdev(sizeof(ec_debug_t *), name, ether_setup))) {

    74

        EC_ERR("Unable to allocate net_device for debug object!\n");

    75

        goto out_return;

    76

    }

    77

    78

    // initialize net_device

    79

    dbg->dev->open = ec_dbgdev_open;

    80

    dbg->dev->stop = ec_dbgdev_stop;

    81

    dbg->dev->hard_start_xmit = ec_dbgdev_tx;

    82

    dbg->dev->get_stats = ec_dbgdev_stats;

    83

    84

    // initialize private data

    85

    *((ec_debug_t **) netdev_priv(dbg->dev)) = dbg;

    86

    87

    // connect the net_device to the kernel

    88

    if ((result = register_netdev(dbg->dev))) {

    89

        EC_ERR("Unable to register net_device: error %i\n", result);

    90

        goto out_free;

    91

    }

    92

    93

    return 0;

    94

    95

 out_free:

    96

    free_netdev(dbg->dev);

    97

    dbg->dev = NULL;

    98

 out_return:

    99

    return -1;

   100

}

   101

   102

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

   103

   104

/**

   105

   Debug destructor.

   106

   Unregisteres the net_device and frees allocated memory.

   107

*/

   108

   109

void ec_debug_clear(ec_debug_t *dbg /**< debug object */)

   110

{

   111

    if (dbg->dev) {

   112

        unregister_netdev(dbg->dev);

   113

        free_netdev(dbg->dev);

   114

    }

   115

}

   116

   117

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

   118

   119

/**

   120

   Sends frame data to the interface.

   121

*/

   122

   123

void ec_debug_send(ec_debug_t *dbg, /**< debug object */

   124

                   const uint8_t *data, /**< frame data */

   125

                   size_t size /**< size of the frame data */

   126

                   )

   127

{

   128

    struct sk_buff *skb;

   129

   130

    if (!dbg->opened) return;

   131

   132

    // allocate socket buffer

   133

    if (!(skb = dev_alloc_skb(size))) {

   134

        dbg->stats.rx_dropped++;

   135

        return;

   136

    }

   137

   138

    // copy frame contents into socket buffer

   139

    memcpy(skb_put(skb, size), data, size);

   140

   141

    // update device statistics

   142

    dbg->stats.rx_packets++;

   143

    dbg->stats.rx_bytes += size;

   144

   145

    // pass socket buffer to network stack

   146

    skb->dev = dbg->dev;

   147

    skb->protocol = eth_type_trans(skb, dbg->dev);

   148

    skb->ip_summed = CHECKSUM_UNNECESSARY;

   149

    netif_rx(skb);

   150

}

   151

   152

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

   153

 *  NET_DEVICE functions

   154

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

   155

   156

/**

   157

   Opens the virtual network device.

   158

*/

   159

   160

int ec_dbgdev_open(struct net_device *dev /**< debug net_device */)

   161

{

   162

    ec_debug_t *dbg = *((ec_debug_t **) netdev_priv(dev));

   163

    dbg->opened = 1;

   164

    EC_INFO("Debug interface %s opened.\n", dev->name);

   165

    return 0;

   166

}

   167

   168

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

   169

   170

/**

   171

   Stops the virtual network device.

   172

*/

   173

   174

int ec_dbgdev_stop(struct net_device *dev /**< debug net_device */)

   175

{

   176

    ec_debug_t *dbg = *((ec_debug_t **) netdev_priv(dev));

   177

    dbg->opened = 0;

   178

    EC_INFO("Debug interface %s stopped.\n", dev->name);

   179

    return 0;

   180

}

   181

   182

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

   183

   184

/**

   185

   Transmits data via the virtual network device.

   186

*/

   187

   188

int ec_dbgdev_tx(struct sk_buff *skb, /**< transmit socket buffer */

   189

                 struct net_device *dev /**< EoE net_device */

   190

                 )

   191

{

   192

    ec_debug_t *dbg = *((ec_debug_t **) netdev_priv(dev));

   193

   194

    dev_kfree_skb(skb);

   195

    dbg->stats.tx_dropped++;

   196

    return 0;

   197

}

   198

   199

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

   200

   201

/**

   202

   Gets statistics about the virtual network device.

   203

*/

   204

   205

struct net_device_stats *ec_dbgdev_stats(struct net_device *dev

   206

                                         /**< debug net_device */)

   207

{

   208

    ec_debug_t *dbg = *((ec_debug_t **) netdev_priv(dev));

   209

    return &dbg->stats;

   210

}

   211

   212

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