1

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

     2

 *

     3

 *  $Id$

     4

 *

     5

 *  Copyright (C) 2006-2008  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 and/or

    10

 *  modify it under the terms of the GNU General Public License version 2, as

    11

 *  published by the Free Software Foundation.

    12

 *

    13

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

    14

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

    15

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General

    16

 *  Public License for more details.

    17

 *

    18

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

    19

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

    20

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

    21

 *

    22

 *  ---

    23

 *

    24

 *  The license mentioned above concerns the source code only. Using the

    25

 *  EtherCAT technology and brand is only permitted in compliance with the

    26

 *  industrial property and similar rights of Beckhoff Automation GmbH.

    27

 *

    28

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

    29

    30

/**

    31

   \file

    32

   Ethernet interface for debugging purposes.

    33

*/

    34

    35

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

    36

    37

#include <linux/version.h>

    38

#include <linux/netdevice.h>

    39

#include <linux/etherdevice.h>

    40

    41

#include "globals.h"

    42

#include "debug.h"

    43

    44

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

    45

    46

// net_device functions

    47

int ec_dbgdev_open(struct net_device *);

    48

int ec_dbgdev_stop(struct net_device *);

    49

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

    50

struct net_device_stats *ec_dbgdev_stats(struct net_device *);

    51

    52

#if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 31)

    53

/** Device operations for debug interfaces.

    54

 */

    55

static const struct net_device_ops ec_dbg_netdev_ops =

    56

{

    57

    .ndo_open = ec_dbgdev_open,

    58

    .ndo_stop = ec_dbgdev_stop,

    59

    .ndo_start_xmit = ec_dbgdev_tx,

    60

    .ndo_get_stats = ec_dbgdev_stats,

    61

};

    62

#endif

    63

    64

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

    65

    66

/** Debug interface constructor.

    67

 *

    68

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

    69

 *

    70

 * \retval  0 Success.

    71

 * \retval <0 Error code.

    72

 */

    73

int ec_debug_init(

    74

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

    75

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

    76

        )

    77

{

    78

    dbg->registered = 0;

    79

    dbg->opened = 0;

    80

    81

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

    82

    83

    if (!(dbg->dev =

    84

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

    85

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

    86

        return -ENODEV;

    87

    }

    88

    89

    // initialize net_device

    90

#if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 31)

    91

    dbg->dev->netdev_ops = &ec_dbg_netdev_ops;

    92

#else

    93

    dbg->dev->open = ec_dbgdev_open;

    94

    dbg->dev->stop = ec_dbgdev_stop;

    95

    dbg->dev->hard_start_xmit = ec_dbgdev_tx;

    96

    dbg->dev->get_stats = ec_dbgdev_stats;

    97

#endif

    98

    99

    // initialize private data

   100

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

   101

   102

    return 0;

   103

}

   104

   105

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

   106

   107

/** Debug interface destructor.

   108

 *

   109

 * Unregisters the net_device and frees allocated memory.

   110

 */

   111

void ec_debug_clear(

   112

        ec_debug_t *dbg /**< debug object */

   113

        )

   114

{

   115

    ec_debug_unregister(dbg);

   116

    free_netdev(dbg->dev);

   117

}

   118

   119

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

   120

   121

/** Register debug interface.

   122

 */

   123

void ec_debug_register(

   124

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

   125

        const struct net_device *net_dev /**< 'Real' Ethernet device. */

   126

        )

   127

{

   128

    int result;

   129

   130

    ec_debug_unregister(dbg);

   131

   132

    // use the Ethernet address of the physical device for the debug device

   133

    memcpy(dbg->dev->dev_addr, net_dev->dev_addr, ETH_ALEN);

   134

   135

    // connect the net_device to the kernel

   136

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

   137

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

   138

    } else {

   139

        dbg->registered = 1;

   140

    }

   141

}

   142

   143

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

   144

   145

/** Unregister debug interface.

   146

 */

   147

void ec_debug_unregister(

   148

        ec_debug_t *dbg /**< debug object */

   149

        )

   150

{

   151

    if (dbg->registered) {

   152

        dbg->opened = 0;

   153

        dbg->registered = 0;

   154

        unregister_netdev(dbg->dev);

   155

    }

   156

}

   157

   158

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

   159

   160

/** Sends frame data to the interface.

   161

 */

   162

void ec_debug_send(

   163

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

   164

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

   165

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

   166

        )

   167

{

   168

    struct sk_buff *skb;

   169

   170

    if (!dbg->opened)

   171

        return;

   172

   173

    // allocate socket buffer

   174

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

   175

        dbg->stats.rx_dropped++;

   176

        return;

   177

    }

   178

   179

    // copy frame contents into socket buffer

   180

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

   181

   182

    // update device statistics

   183

    dbg->stats.rx_packets++;

   184

    dbg->stats.rx_bytes += size;

   185

   186

    // pass socket buffer to network stack

   187

    skb->dev = dbg->dev;

   188

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

   189

    skb->ip_summed = CHECKSUM_UNNECESSARY;

   190

    netif_rx(skb);

   191

}

   192

   193

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

   194

 *  NET_DEVICE functions

   195

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

   196

   197

/** Opens the virtual network device.

   198

 */

   199

int ec_dbgdev_open(

   200

        struct net_device *dev /**< debug net_device */

   201

        )

   202

{

   203

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

   204

    dbg->opened = 1;

   205

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

   206

    return 0;

   207

}

   208

   209

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

   210

   211

/** Stops the virtual network device.

   212

 */

   213

int ec_dbgdev_stop(

   214

        struct net_device *dev /**< debug net_device */

   215

        )

   216

{

   217

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

   218

    dbg->opened = 0;

   219

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

   220

    return 0;

   221

}

   222

   223

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

   224

   225

/** Transmits data via the virtual network device.

   226

 */

   227

int ec_dbgdev_tx(

   228

        struct sk_buff *skb, /**< transmit socket buffer */

   229

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

   230

        )

   231

{

   232

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

   233

   234

    dev_kfree_skb(skb);

   235

    dbg->stats.tx_dropped++;

   236

    return 0;

   237

}

   238

   239

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

   240

   241

/** Gets statistics about the virtual network device.

   242

 */

   243

struct net_device_stats *ec_dbgdev_stats(

   244

        struct net_device *dev /**< debug net_device */

   245

        )

   246

{

   247

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

   248

    return &dbg->stats;

   249

}

   250

   251

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