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

#define EC_GEN_RX_BUF_SIZE 1600

    51

    52

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

    53

    54

int __init ec_gen_init_module(void);

    55

void __exit ec_gen_cleanup_module(void);

    56

    57

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

    58

    59

/** \cond */

    60

    61

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

    62

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

    63

MODULE_LICENSE("GPL");

    64

MODULE_VERSION(EC_MASTER_VERSION);

    65

    66

/** \endcond */

    67

    68

struct list_head generic_devices;

    69

    70

typedef struct {

    71

    struct list_head list;

    72

    struct net_device *netdev;

    73

    struct net_device *used_netdev;

    74

    struct socket *socket;

    75

    ec_device_t *ecdev;

    76

    uint8_t *rx_buf;

    77

} ec_gen_device_t;

    78

    79

typedef struct {

    80

    struct list_head list;

    81

    struct net_device *netdev;

    82

    char name[IFNAMSIZ];

    83

    int ifindex;

    84

    uint8_t dev_addr[ETH_ALEN];

    85

} ec_gen_interface_desc_t;

    86

    87

int ec_gen_device_open(ec_gen_device_t *);

    88

int ec_gen_device_stop(ec_gen_device_t *);

    89

int ec_gen_device_start_xmit(ec_gen_device_t *, struct sk_buff *);

    90

void ec_gen_device_poll(ec_gen_device_t *);

    91

    92

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

    93

    94

static int ec_gen_netdev_open(struct net_device *dev)

    95

{

    96

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

    97

    return ec_gen_device_open(gendev);

    98

}

    99

   100

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

   101

   102

static int ec_gen_netdev_stop(struct net_device *dev)

   103

{

   104

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

   105

    return ec_gen_device_stop(gendev);

   106

}

   107

   108

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

   109

   110

static int ec_gen_netdev_start_xmit(

   111

        struct sk_buff *skb,

   112

        struct net_device *dev

   113

        )

   114

{

   115

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

   116

    return ec_gen_device_start_xmit(gendev, skb);

   117

}

   118

   119

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

   120

   121

void ec_gen_poll(struct net_device *dev)

   122

{

   123

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

   124

    ec_gen_device_poll(gendev);

   125

}

   126

   127

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

   128

   129

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

   130

static const struct net_device_ops ec_gen_netdev_ops = {

   131

    .ndo_open       = ec_gen_netdev_open,

   132

    .ndo_stop       = ec_gen_netdev_stop,

   133

    .ndo_start_xmit = ec_gen_netdev_start_xmit,

   134

};

   135

#endif

   136

   137

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

   138

   139

/** Init generic device.

   140

 */

   141

int ec_gen_device_init(

   142

        ec_gen_device_t *dev

   143

        )

   144

{

   145

    ec_gen_device_t **priv;

   146

    char null = 0x00;

   147

   148

    dev->ecdev = NULL;

   149

    dev->socket = NULL;

   150

    dev->rx_buf = NULL;

   151

   152

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

   153

    if (!dev->netdev) {

   154

        return -ENOMEM;

   155

    }

   156

   157

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

   158

    dev->netdev->netdev_ops = &ec_gen_netdev_ops;

   159

#else

   160

    dev->netdev->open = ec_gen_netdev_open;

   161

    dev->netdev->stop = ec_gen_netdev_stop;

   162

    dev->netdev->hard_start_xmit = ec_gen_netdev_start_xmit;

   163

#endif

   164

   165

    priv = netdev_priv(dev->netdev);

   166

    *priv = dev;

   167

   168

    return 0;

   169

}

   170

   171

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

   172

   173

/** Clear generic device.

   174

 */

   175

void ec_gen_device_clear(

   176

        ec_gen_device_t *dev

   177

        )

   178

{

   179

    if (dev->ecdev) {

   180

        ecdev_close(dev->ecdev);

   181

        ecdev_withdraw(dev->ecdev);

   182

    }

   183

    if (dev->socket) {

   184

        sock_release(dev->socket);

   185

    }

   186

    free_netdev(dev->netdev);

   187

   188

    if (dev->rx_buf) {

   189

        kfree(dev->rx_buf);

   190

    }

   191

}

   192

   193

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

   194

   195

/** Creates a network socket.

   196

 */

   197

int ec_gen_device_create_socket(

   198

        ec_gen_device_t *dev,

   199

        ec_gen_interface_desc_t *desc

   200

        )

   201

{

   202

    int ret;

   203

    struct sockaddr_ll sa;

   204

   205

    dev->rx_buf = kmalloc(EC_GEN_RX_BUF_SIZE, GFP_KERNEL);

   206

    if (!dev->rx_buf) {

   207

        return -ENOMEM;

   208

    }

   209

   210

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

   211

    if (ret) {

   212

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

   213

        return ret;

   214

    }

   215

   216

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

   217

            desc->ifindex, desc->name);

   218

   219

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

   220

    sa.sll_family = AF_PACKET;

   221

    sa.sll_protocol = htons(ETH_P_ETHERCAT);

   222

    sa.sll_ifindex = desc->ifindex;

   223

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

   224

    if (ret) {

   225

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

   226

        sock_release(dev->socket);

   227

        dev->socket = NULL;

   228

        return ret;

   229

    }

   230

   231

    return 0;

   232

}

   233

   234

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

   235

   236

/** Offer generic device to master.

   237

 */

   238

int ec_gen_device_offer(

   239

        ec_gen_device_t *dev,

   240

        ec_gen_interface_desc_t *desc

   241

        )

   242

{

   243

    int ret = 0;

   244

   245

    dev->used_netdev = desc->netdev;

   246

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

   247

   248

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

   249

    if (dev->ecdev) {

   250

        if (ec_gen_device_create_socket(dev, desc)) {

   251

            ecdev_withdraw(dev->ecdev);

   252

            dev->ecdev = NULL;

   253

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

   254

            ecdev_withdraw(dev->ecdev);

   255

            dev->ecdev = NULL;

   256

        } else {

   257

            ecdev_set_link(dev->ecdev, netif_carrier_ok(dev->used_netdev)); // FIXME

   258

            ret = 1;

   259

        }

   260

    }

   261

   262

    return ret;

   263

}

   264

   265

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

   266

   267

/** Open the device.

   268

 */

   269

int ec_gen_device_open(

   270

        ec_gen_device_t *dev

   271

        )

   272

{

   273

    return 0;

   274

}

   275

   276

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

   277

   278

/** Stop the device.

   279

 */

   280

int ec_gen_device_stop(

   281

        ec_gen_device_t *dev

   282

        )

   283

{

   284

    return 0;

   285

}

   286

   287

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

   288

   289

int ec_gen_device_start_xmit(

   290

        ec_gen_device_t *dev,

   291

        struct sk_buff *skb

   292

        )

   293

{

   294

    struct msghdr msg;

   295

    struct kvec iov;

   296

    size_t len = skb->len;

   297

    int ret;

   298

   299

    ecdev_set_link(dev->ecdev, netif_carrier_ok(dev->used_netdev));

   300

   301

    iov.iov_base = skb->data;

   302

    iov.iov_len = len;

   303

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

   304

   305

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

   306

   307

    return ret == len ? NETDEV_TX_OK : NETDEV_TX_BUSY;

   308

}

   309

   310

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

   311

   312

/** Polls the device.

   313

 */

   314

void ec_gen_device_poll(

   315

        ec_gen_device_t *dev

   316

        )

   317

{

   318

    struct msghdr msg;

   319

    struct kvec iov;

   320

    int ret, budget = 10; // FIXME

   321

   322

    ecdev_set_link(dev->ecdev, netif_carrier_ok(dev->used_netdev));

   323

   324

    do {

   325

        iov.iov_base = dev->rx_buf;

   326

        iov.iov_len = EC_GEN_RX_BUF_SIZE;

   327

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

   328

   329

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

   330

                MSG_DONTWAIT);

   331

        if (ret > 0) {

   332

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

   333

        } else if (ret < 0) {

   334

            break;

   335

        }

   336

        budget--;

   337

    } while (budget);

   338

}

   339

   340

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

   341

   342

/** Offer device.

   343

 */

   344

int offer_device(

   345

        ec_gen_interface_desc_t *desc

   346

        )

   347

{

   348

    ec_gen_device_t *gendev;

   349

    int ret = 0;

   350

   351

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

   352

    if (!gendev) {

   353

        return -ENOMEM;

   354

    }

   355

   356

    ret = ec_gen_device_init(gendev);

   357

    if (ret) {

   358

        kfree(gendev);

   359

        return ret;

   360

    }

   361

   362

    if (ec_gen_device_offer(gendev, desc)) {

   363

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

   364

    } else {

   365

        ec_gen_device_clear(gendev);

   366

        kfree(gendev);

   367

    }

   368

   369

    return ret;

   370

}

   371

   372

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

   373

   374

/** Clear devices.

   375

 */

   376

void clear_devices(void)

   377

{

   378

    ec_gen_device_t *gendev, *next;

   379

   380

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

   381

        list_del(&gendev->list);

   382

        ec_gen_device_clear(gendev);

   383

        kfree(gendev);

   384

    }

   385

}

   386

   387

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

   388

   389

/** Module initialization.

   390

 *

   391

 * Initializes \a master_count masters.

   392

 * \return 0 on success, else < 0

   393

 */

   394

int __init ec_gen_init_module(void)

   395

{

   396

    int ret = 0;

   397

    struct list_head descs;

   398

    struct net_device *netdev;

   399

    ec_gen_interface_desc_t *desc, *next;

   400

   401

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

   402

            EC_MASTER_VERSION);

   403

   404

    INIT_LIST_HEAD(&generic_devices);

   405

    INIT_LIST_HEAD(&descs);

   406

   407

    read_lock(&dev_base_lock);

   408

    for_each_netdev(&init_net, netdev) {

   409

        if (netdev->type != ARPHRD_ETHER)

   410

            continue;

   411

        desc = kmalloc(sizeof(ec_gen_interface_desc_t), GFP_ATOMIC);

   412

        if (!desc) {

   413

            ret = -ENOMEM;

   414

            read_unlock(&dev_base_lock);

   415

            goto out_err;

   416

        }

   417

        strncpy(desc->name, netdev->name, IFNAMSIZ);

   418

        desc->netdev = netdev;

   419

        desc->ifindex = netdev->ifindex;

   420

        memcpy(desc->dev_addr, netdev->dev_addr, ETH_ALEN);

   421

        list_add_tail(&desc->list, &descs);

   422

    }

   423

    read_unlock(&dev_base_lock);

   424

   425

    list_for_each_entry_safe(desc, next, &descs, list) {

   426

        ret = offer_device(desc);

   427

        if (ret) {

   428

            goto out_err;

   429

        }

   430

        kfree(desc);

   431

    }

   432

    return ret;

   433

   434

out_err:

   435

    list_for_each_entry_safe(desc, next, &descs, list) {

   436

        list_del(&desc->list);

   437

        kfree(desc);

   438

    }

   439

    clear_devices();

   440

    return ret;

   441

}

   442

   443

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

   444

   445

/** Module cleanup.

   446

 *

   447

 * Clears all master instances.

   448

 */

   449

void __exit ec_gen_cleanup_module(void)

   450

{

   451

    clear_devices();

   452

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

   453

}

   454

   455

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

   456

   457

/** \cond */

   458

   459

module_init(ec_gen_init_module);

   460

module_exit(ec_gen_cleanup_module);

   461

   462

/** \endcond */

   463

   464

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