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

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

    23

 *  the industrial property and similar rights of Beckhoff Automation GmbH.

    24

 *

    25

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

    26

    27

/**

    28

   \file

    29

   Ethernet interface for debugging purposes.

    30

*/

    31

    32

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

    33

    34

#include <linux/netdevice.h>

    35

#include <linux/etherdevice.h>

    36

    37

#include "globals.h"

    38

#include "debug.h"

    39

    40

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

    41

    42

// net_device functions

    43

int ec_dbgdev_open(struct net_device *);

    44

int ec_dbgdev_stop(struct net_device *);

    45

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

    46

struct net_device_stats *ec_dbgdev_stats(struct net_device *);

    47

    48

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

    49

    50

/** Debug interface constructor.

    51

 *

    52

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

    53

 *

    54

 * \retval  0 Success.

    55

 * \retval <0 Error code.

    56

 */

    57

int ec_debug_init(

    58

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

    59

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

    60

        )

    61

{

    62

    dbg->registered = 0;

    63

    dbg->opened = 0;

    64

    65

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

    66

    67

    if (!(dbg->dev =

    68

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

    69

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

    70

        return -ENODEV;

    71

    }

    72

    73

    // initialize net_device

    74

    dbg->dev->open = ec_dbgdev_open;

    75

    dbg->dev->stop = ec_dbgdev_stop;

    76

    dbg->dev->hard_start_xmit = ec_dbgdev_tx;

    77

    dbg->dev->get_stats = ec_dbgdev_stats;

    78

    79

    // initialize private data

    80

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

    81

    82

    return 0;

    83

}

    84

    85

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

    86

    87

/** Debug interface destructor.

    88

 *

    89

 * Unregisters the net_device and frees allocated memory.

    90

 */

    91

void ec_debug_clear(

    92

        ec_debug_t *dbg /**< debug object */

    93

        )

    94

{

    95

    ec_debug_unregister(dbg);

    96

    free_netdev(dbg->dev);

    97

}

    98

    99

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

   100

   101

/** Register debug interface.

   102

 */

   103

void ec_debug_register(

   104

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

   105

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

   106

        )

   107

{

   108

    int result;

   109

   110

    ec_debug_unregister(dbg);

   111

   112

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

   113

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

   114

   115

    // connect the net_device to the kernel

   116

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

   117

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

   118

    } else {

   119

        dbg->registered = 1;

   120

    }

   121

}

   122

   123

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

   124

   125

/** Unregister debug interface.

   126

 */

   127

void ec_debug_unregister(

   128

        ec_debug_t *dbg /**< debug object */

   129

        )

   130

{

   131

    if (dbg->registered) {

   132

        dbg->opened = 0;

   133

        dbg->registered = 0;

   134

        unregister_netdev(dbg->dev);

   135

    }

   136

}

   137

   138

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

   139

   140

/** Sends frame data to the interface.

   141

 */

   142

void ec_debug_send(

   143

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

   144

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

   145

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

   146

        )

   147

{

   148

    struct sk_buff *skb;

   149

   150

    if (!dbg->opened)

   151

        return;

   152

   153

    // allocate socket buffer

   154

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

   155

        dbg->stats.rx_dropped++;

   156

        return;

   157

    }

   158

   159

    // copy frame contents into socket buffer

   160

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

   161

   162

    // update device statistics

   163

    dbg->stats.rx_packets++;

   164

    dbg->stats.rx_bytes += size;

   165

   166

    // pass socket buffer to network stack

   167

    skb->dev = dbg->dev;

   168

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

   169

    skb->ip_summed = CHECKSUM_UNNECESSARY;

   170

    netif_rx(skb);

   171

}

   172

   173

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

   174

 *  NET_DEVICE functions

   175

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

   176

   177

/** Opens the virtual network device.

   178

 */

   179

int ec_dbgdev_open(

   180

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

   181

        )

   182

{

   183

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

   184

    dbg->opened = 1;

   185

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

   186

    return 0;

   187

}

   188

   189

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

   190

   191

/** Stops the virtual network device.

   192

 */

   193

int ec_dbgdev_stop(

   194

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

   195

        )

   196

{

   197

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

   198

    dbg->opened = 0;

   199

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

   200

    return 0;

   201

}

   202

   203

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

   204

   205

/** Transmits data via the virtual network device.

   206

 */

   207

int ec_dbgdev_tx(

   208

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

   209

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

   210

        )

   211

{

   212

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

   213

   214

    dev_kfree_skb(skb);

   215

    dbg->stats.tx_dropped++;

   216

    return 0;

   217

}

   218

   219

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

   220

   221

/** Gets statistics about the virtual network device.

   222

 */

   223

struct net_device_stats *ec_dbgdev_stats(

   224

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

   225

        )

   226

{

   227

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

   228

    return &dbg->stats;

   229

}

   230

   231

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