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

/** \file

    31

 * EtherCAT generic Ethernet device module.

    32

 */

    33

    34

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

    35

    36

#include <linux/module.h>

    37

#include <linux/device.h>

    38

#include <linux/err.h>

    39

#include <linux/version.h>

    40

#include <linux/if_arp.h> /* ARPHRD_ETHER */

    41

#include <linux/etherdevice.h>

    42

    43

#include "../globals.h"

    44

#include "ecdev.h"

    45

    46

#define PFX "ec_generic: "

    47

    48

#define ETH_P_ETHERCAT 0x88A4

    49

    50

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

    51

    52

int __init ec_gen_init_module(void);

    53

void __exit ec_gen_cleanup_module(void);

    54

    55

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

    56

    57

/** \cond */

    58

    59

MODULE_AUTHOR("Florian Pose <fp@igh-essen.com>");

    60

MODULE_DESCRIPTION("EtherCAT master generic Ethernet device module");

    61

MODULE_LICENSE("GPL");

    62

MODULE_VERSION(EC_MASTER_VERSION);

    63

    64

/** \endcond */

    65

    66

struct list_head generic_devices;

    67

    68

typedef struct {

    69

    struct list_head list;

    70

    struct net_device *netdev;

    71

    struct socket *socket;

    72

    ec_device_t *ecdev;

    73

} ec_gen_device_t;

    74

    75

int ec_gen_device_open(ec_gen_device_t *);

    76

int ec_gen_device_stop(ec_gen_device_t *);

    77

int ec_gen_device_start_xmit(ec_gen_device_t *, struct sk_buff *);

    78

void ec_gen_device_poll(ec_gen_device_t *);

    79

    80

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

    81

    82

static int ec_gen_netdev_open(struct net_device *dev)

    83

{

    84

    ec_gen_device_t *gendev = *((ec_gen_device_t **) netdev_priv(dev));

    85

    return ec_gen_device_open(gendev);

    86

}

    87

    88

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

    89

    90

static int ec_gen_netdev_stop(struct net_device *dev)

    91

{

    92

    ec_gen_device_t *gendev = *((ec_gen_device_t **) netdev_priv(dev));

    93

    return ec_gen_device_stop(gendev);

    94

}

    95

    96

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

    97

    98

static int ec_gen_netdev_start_xmit(

    99

        struct sk_buff *skb,

   100

        struct net_device *dev

   101

        )

   102

{

   103

    ec_gen_device_t *gendev = *((ec_gen_device_t **) netdev_priv(dev));

   104

    return ec_gen_device_start_xmit(gendev, skb);

   105

}

   106

   107

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

   108

   109

void ec_gen_poll(struct net_device *dev)

   110

{

   111

    ec_gen_device_t *gendev = *((ec_gen_device_t **) netdev_priv(dev));

   112

    ec_gen_device_poll(gendev);

   113

}

   114

   115

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

   116

   117

static const struct net_device_ops ec_gen_netdev_ops = {

   118

	.ndo_open		= ec_gen_netdev_open,

   119

	.ndo_stop		= ec_gen_netdev_stop,

   120

	.ndo_start_xmit	= ec_gen_netdev_start_xmit,

   121

};

   122

   123

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

   124

   125

/** Init generic device.

   126

 */

   127

int ec_gen_device_init(

   128

        ec_gen_device_t *dev,

   129

        struct net_device *real_netdev

   130

        )

   131

{

   132

    ec_gen_device_t **priv;

   133

    char null = 0x00;

   134

   135

    dev->ecdev = NULL;

   136

    dev->socket = NULL;

   137

   138

	dev->netdev = alloc_netdev(sizeof(ec_gen_device_t *), &null, ether_setup);

   139

	if (!dev->netdev) {

   140

		return -ENOMEM;

   141

	}

   142

    memcpy(dev->netdev->dev_addr, real_netdev->dev_addr, ETH_ALEN);

   143

    dev->netdev->netdev_ops = &ec_gen_netdev_ops;

   144

    priv = netdev_priv(dev->netdev);

   145

    *priv = dev;

   146

   147

    return 0;

   148

}

   149

   150

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

   151

   152

/** Clear generic device.

   153

 */

   154

void ec_gen_device_clear(

   155

        ec_gen_device_t *dev

   156

        )

   157

{

   158

    if (dev->ecdev) {

   159

        ecdev_close(dev->ecdev);

   160

        ecdev_withdraw(dev->ecdev);

   161

    }

   162

    if (dev->socket) {

   163

        sock_release(dev->socket);

   164

    }

   165

    free_netdev(dev->netdev);

   166

}

   167

   168

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

   169

   170

/** Creates a network socket.

   171

 */

   172

int ec_gen_device_create_socket(

   173

        ec_gen_device_t *dev,

   174

        struct net_device *real_netdev

   175

        )

   176

{

   177

    int ret;

   178

    struct sockaddr_ll sa;

   179

   180

    ret = sock_create_kern(PF_PACKET, SOCK_RAW, htons(ETH_P_ETHERCAT), &dev->socket);

   181

    if (ret) {

   182

        printk(KERN_ERR PFX "Failed to create socket.\n");

   183

        return ret;

   184

    }

   185

   186

    printk(KERN_ERR PFX "Binding socket to interface %i (%s).\n",

   187

            real_netdev->ifindex, real_netdev->name);

   188

   189

    memset(&sa, 0x00, sizeof(sa));

   190

    sa.sll_family = AF_PACKET;

   191

    sa.sll_protocol = htons(ETH_P_ETHERCAT);

   192

    sa.sll_ifindex = real_netdev->ifindex;

   193

    ret = kernel_bind(dev->socket, (struct sockaddr *) &sa, sizeof(sa));

   194

    if (ret) {

   195

        printk(KERN_ERR PFX "Failed to bind() socket to interface.\n");

   196

        sock_release(dev->socket);

   197

        dev->socket = NULL;

   198

        return ret;

   199

    }

   200

   201

    return 0;

   202

}

   203

   204

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

   205

   206

/** Offer generic device to master.

   207

 */

   208

int ec_gen_device_offer(

   209

        ec_gen_device_t *dev,

   210

        struct net_device *real_netdev

   211

        )

   212

{

   213

    int ret = 0;

   214

   215

	dev->ecdev = ecdev_offer(dev->netdev, ec_gen_poll, THIS_MODULE);

   216

    if (dev->ecdev) {

   217

        if (ec_gen_device_create_socket(dev, real_netdev)) {

   218

            ecdev_withdraw(dev->ecdev);

   219

            dev->ecdev = NULL;

   220

        } else if (ecdev_open(dev->ecdev)) {

   221

            ecdev_withdraw(dev->ecdev);

   222

            dev->ecdev = NULL;

   223

        } else {

   224

            ecdev_set_link(dev->ecdev, 1); // FIXME

   225

            ret = 1;

   226

        }

   227

    }

   228

   229

    return ret;

   230

}

   231

   232

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

   233

   234

/** Open the device.

   235

 */

   236

int ec_gen_device_open(

   237

        ec_gen_device_t *dev

   238

        )

   239

{

   240

    return 0;

   241

}

   242

   243

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

   244

   245

/** Stop the device.

   246

 */

   247

int ec_gen_device_stop(

   248

        ec_gen_device_t *dev

   249

        )

   250

{

   251

    return 0;

   252

}

   253

   254

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

   255

   256

int ec_gen_device_start_xmit(

   257

        ec_gen_device_t *dev,

   258

        struct sk_buff *skb

   259

        )

   260

{

   261

    struct msghdr msg;

   262

    struct kvec iov;

   263

    size_t len = skb->len;

   264

    int ret;

   265

   266

    iov.iov_base = skb->data;

   267

    iov.iov_len = len;

   268

    memset(&msg, 0, sizeof(msg));

   269

   270

    ret = kernel_sendmsg(dev->socket, &msg, &iov, 1, len);

   271

   272

    return ret == len ? NETDEV_TX_OK : NETDEV_TX_BUSY;

   273

}

   274

   275

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

   276

   277

/** Polls the device.

   278

 */

   279

void ec_gen_device_poll(

   280

        ec_gen_device_t *dev

   281

        )

   282

{

   283

    struct msghdr msg;

   284

    struct kvec iov;

   285

    char buf[2000]; // FIXME

   286

    int ret, budget = 10; // FIXME

   287

   288

    iov.iov_base = buf;

   289

    iov.iov_len = 2000;

   290

    memset(&msg, 0, sizeof(msg));

   291

   292

    do {

   293

        ret = kernel_recvmsg(dev->socket, &msg, &iov, 1, iov.iov_len,

   294

                MSG_DONTWAIT);

   295

        if (ret > 0) {

   296

            ecdev_receive(dev->ecdev, buf, ret);

   297

        } else if (ret < 0) {

   298

            break;

   299

        }

   300

        budget--;

   301

    } while (budget);

   302

}

   303

   304

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

   305

   306

/** Offer device.

   307

 */

   308

int offer_device(

   309

        struct net_device *netdev

   310

        )

   311

{

   312

    ec_gen_device_t *gendev;

   313

    int ret = 0;

   314

   315

    gendev = kmalloc(sizeof(ec_gen_device_t), GFP_KERNEL);

   316

    if (!gendev) {

   317

        return -ENOMEM;

   318

    }

   319

   320

    ret = ec_gen_device_init(gendev, netdev);

   321

    if (ret) {

   322

        kfree(gendev);

   323

        return ret;

   324

    }

   325

   326

    if (ec_gen_device_offer(gendev, netdev)) {

   327

        list_add_tail(&gendev->list, &generic_devices);

   328

    } else {

   329

        ec_gen_device_clear(gendev);

   330

        kfree(gendev);

   331

    }

   332

   333

    return ret;

   334

}

   335

   336

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

   337

   338

/** Clear devices.

   339

 */

   340

void clear_devices(void)

   341

{

   342

    ec_gen_device_t *gendev, *next;

   343

   344

    list_for_each_entry_safe(gendev, next, &generic_devices, list) {

   345

        list_del(&gendev->list);

   346

        ec_gen_device_clear(gendev);

   347

        kfree(gendev);

   348

    }

   349

}

   350

   351

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

   352

   353

/** Module initialization.

   354

 *

   355

 * Initializes \a master_count masters.

   356

 * \return 0 on success, else < 0

   357

 */

   358

int __init ec_gen_init_module(void)

   359

{

   360

    int ret = 0;

   361

    struct net_device *netdev;

   362

   363

    printk(KERN_INFO PFX "EtherCAT master generic Ethernet device module %s\n",

   364

            EC_MASTER_VERSION);

   365

   366

    INIT_LIST_HEAD(&generic_devices);

   367

   368

    read_lock(&dev_base_lock);

   369

    for_each_netdev(&init_net, netdev) {

   370

        if (netdev->type != ARPHRD_ETHER)

   371

            continue;

   372

        ret = offer_device(netdev);

   373

        if (ret) {

   374

            read_unlock(&dev_base_lock);

   375

            goto out_err;

   376

        }

   377

    }

   378

    read_unlock(&dev_base_lock);

   379

    return ret;

   380

   381

out_err:

   382

    clear_devices();

   383

    return ret;

   384

}

   385

   386

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

   387

   388

/** Module cleanup.

   389

 *

   390

 * Clears all master instances.

   391

 */

   392

void __exit ec_gen_cleanup_module(void)

   393

{

   394

    clear_devices();

   395

    printk(KERN_INFO PFX "Unloading.\n");

   396

}

   397

   398

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

   399

   400

/** \cond */

   401

   402

module_init(ec_gen_init_module);

   403

module_exit(ec_gen_cleanup_module);

   404

   405

/** \endcond */

   406

   407

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