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

/** Debug interface constructor.

    58

 *

    59

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

    60

 *

    61

 * \retval  0 Success.

    62

 * \retval <0 Error code.

    63

 */

    64

int ec_debug_init(

    65

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

    66

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

    67

        )

    68

{

    69

    dbg->registered = 0;

    70

    dbg->opened = 0;

    71

    72

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

    73

    74

    if (!(dbg->dev =

    75

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

    76

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

    77

        return -ENODEV;

    78

    }

    79

    80

    // initialize net_device

    81

    dbg->dev->open = ec_dbgdev_open;

    82

    dbg->dev->stop = ec_dbgdev_stop;

    83

    dbg->dev->hard_start_xmit = ec_dbgdev_tx;

    84

    dbg->dev->get_stats = ec_dbgdev_stats;

    85

    86

    // initialize private data

    87

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

    88

    89

    return 0;

    90

}

    91

    92

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

    93

    94

/** Debug interface destructor.

    95

 *

    96

 * Unregisters the net_device and frees allocated memory.

    97

 */

    98

void ec_debug_clear(

    99

        ec_debug_t *dbg /**< debug object */

   100

        )

   101

{

   102

    ec_debug_unregister(dbg);

   103

    free_netdev(dbg->dev);

   104

}

   105

   106

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

   107

   108

/** Register debug interface.

   109

 */

   110

void ec_debug_register(

   111

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

   112

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

   113

        )

   114

{

   115

    int result;

   116

   117

    ec_debug_unregister(dbg);

   118

   119

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

   120

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

   121

   122

    // connect the net_device to the kernel

   123

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

   124

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

   125

    } else {

   126

        dbg->registered = 1;

   127

    }

   128

}

   129

   130

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

   131

   132

/** Unregister debug interface.

   133

 */

   134

void ec_debug_unregister(

   135

        ec_debug_t *dbg /**< debug object */

   136

        )

   137

{

   138

    if (dbg->registered) {

   139

        dbg->opened = 0;

   140

        dbg->registered = 0;

   141

        unregister_netdev(dbg->dev);

   142

    }

   143

}

   144

   145

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

   146

   147

/** Sends frame data to the interface.

   148

 */

   149

void ec_debug_send(

   150

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

   151

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

   152

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

   153

        )

   154

{

   155

    struct sk_buff *skb;

   156

   157

    if (!dbg->opened)

   158

        return;

   159

   160

    // allocate socket buffer

   161

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

   162

        dbg->stats.rx_dropped++;

   163

        return;

   164

    }

   165

   166

    // copy frame contents into socket buffer

   167

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

   168

   169

    // update device statistics

   170

    dbg->stats.rx_packets++;

   171

    dbg->stats.rx_bytes += size;

   172

   173

    // pass socket buffer to network stack

   174

    skb->dev = dbg->dev;

   175

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

   176

    skb->ip_summed = CHECKSUM_UNNECESSARY;

   177

    netif_rx(skb);

   178

}

   179

   180

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

   181

 *  NET_DEVICE functions

   182

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

   183

   184

/** Opens the virtual network device.

   185

 */

   186

int ec_dbgdev_open(

   187

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

   188

        )

   189

{

   190

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

   191

    dbg->opened = 1;

   192

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

   193

    return 0;

   194

}

   195

   196

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

   197

   198

/** Stops the virtual network device.

   199

 */

   200

int ec_dbgdev_stop(

   201

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

   202

        )

   203

{

   204

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

   205

    dbg->opened = 0;

   206

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

   207

    return 0;

   208

}

   209

   210

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

   211

   212

/** Transmits data via the virtual network device.

   213

 */

   214

int ec_dbgdev_tx(

   215

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

   216

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

   217

        )

   218

{

   219

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

   220

   221

    dev_kfree_skb(skb);

   222

    dbg->stats.tx_dropped++;

   223

    return 0;

   224

}

   225

   226

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

   227

   228

/** Gets statistics about the virtual network device.

   229

 */

   230

struct net_device_stats *ec_dbgdev_stats(

   231

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

   232

        )

   233

{

   234

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

   235

    return &dbg->stats;

   236

}

   237

   238

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