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

static const struct net_device_ops ec_dbg_netdev_ops =

    54

{

    55

    .ndo_open = ec_dbgdev_open,

    56

    .ndo_stop = ec_dbgdev_stop,

    57

    .ndo_start_xmit = ec_dbgdev_tx,

    58

    .ndo_get_stats = ec_dbgdev_stats,

    59

};

    60

#endif

    61

    62

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

    63

    64

/** Debug interface constructor.

    65

 *

    66

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

    67

 *

    68

 * \retval  0 Success.

    69

 * \retval <0 Error code.

    70

 */

    71

int ec_debug_init(

    72

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

    73

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

    74

        )

    75

{

    76

    dbg->registered = 0;

    77

    dbg->opened = 0;

    78

    79

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

    80

    81

    if (!(dbg->dev =

    82

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

    83

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

    84

        return -ENODEV;

    85

    }

    86

    87

    // initialize net_device

    88

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

    89

    dbg->dev->netdev_ops = &ec_dbg_netdev_ops;

    90

#else

    91

    dbg->dev->open = ec_dbgdev_open;

    92

    dbg->dev->stop = ec_dbgdev_stop;

    93

    dbg->dev->hard_start_xmit = ec_dbgdev_tx;

    94

    dbg->dev->get_stats = ec_dbgdev_stats;

    95

#endif

    96

    97

    // initialize private data

    98

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

    99

   100

    return 0;

   101

}

   102

   103

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

   104

   105

/** Debug interface destructor.

   106

 *

   107

 * Unregisters the net_device and frees allocated memory.

   108

 */

   109

void ec_debug_clear(

   110

        ec_debug_t *dbg /**< debug object */

   111

        )

   112

{

   113

    ec_debug_unregister(dbg);

   114

    free_netdev(dbg->dev);

   115

}

   116

   117

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

   118

   119

/** Register debug interface.

   120

 */

   121

void ec_debug_register(

   122

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

   123

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

   124

        )

   125

{

   126

    int result;

   127

   128

    ec_debug_unregister(dbg);

   129

   130

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

   131

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

   132

   133

    // connect the net_device to the kernel

   134

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

   135

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

   136

    } else {

   137

        dbg->registered = 1;

   138

    }

   139

}

   140

   141

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

   142

   143

/** Unregister debug interface.

   144

 */

   145

void ec_debug_unregister(

   146

        ec_debug_t *dbg /**< debug object */

   147

        )

   148

{

   149

    if (dbg->registered) {

   150

        dbg->opened = 0;

   151

        dbg->registered = 0;

   152

        unregister_netdev(dbg->dev);

   153

    }

   154

}

   155

   156

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

   157

   158

/** Sends frame data to the interface.

   159

 */

   160

void ec_debug_send(

   161

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

   162

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

   163

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

   164

        )

   165

{

   166

    struct sk_buff *skb;

   167

   168

    if (!dbg->opened)

   169

        return;

   170

   171

    // allocate socket buffer

   172

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

   173

        dbg->stats.rx_dropped++;

   174

        return;

   175

    }

   176

   177

    // copy frame contents into socket buffer

   178

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

   179

   180

    // update device statistics

   181

    dbg->stats.rx_packets++;

   182

    dbg->stats.rx_bytes += size;

   183

   184

    // pass socket buffer to network stack

   185

    skb->dev = dbg->dev;

   186

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

   187

    skb->ip_summed = CHECKSUM_UNNECESSARY;

   188

    netif_rx(skb);

   189

}

   190

   191

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

   192

 *  NET_DEVICE functions

   193

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

   194

   195

/** Opens the virtual network device.

   196

 */

   197

int ec_dbgdev_open(

   198

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

   199

        )

   200

{

   201

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

   202

    dbg->opened = 1;

   203

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

   204

    return 0;

   205

}

   206

   207

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

   208

   209

/** Stops the virtual network device.

   210

 */

   211

int ec_dbgdev_stop(

   212

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

   213

        )

   214

{

   215

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

   216

    dbg->opened = 0;

   217

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

   218

    return 0;

   219

}

   220

   221

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

   222

   223

/** Transmits data via the virtual network device.

   224

 */

   225

int ec_dbgdev_tx(

   226

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

   227

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

   228

        )

   229

{

   230

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

   231

   232

    dev_kfree_skb(skb);

   233

    dbg->stats.tx_dropped++;

   234

    return 0;

   235

}

   236

   237

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

   238

   239

/** Gets statistics about the virtual network device.

   240

 */

   241

struct net_device_stats *ec_dbgdev_stats(

   242

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

   243

        )

   244

{

   245

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

   246

    return &dbg->stats;

   247

}

   248

   249

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