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),

   211

            &dev->socket);

   212

    if (ret) {

   213

        printk(KERN_ERR PFX "Failed to create socket (ret = %i).\n", ret);

   214

        return ret;

   215

    }

   216

   217

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

   218

            desc->ifindex, desc->name);

   219

   220

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

   221

    sa.sll_family = AF_PACKET;

   222

    sa.sll_protocol = htons(ETH_P_ETHERCAT);

   223

    sa.sll_ifindex = desc->ifindex;

   224

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

   225

    if (ret) {

   226

        printk(KERN_ERR PFX "Failed to bind() socket to interface"

   227

                " (ret = %i).\n", ret);

   228

        sock_release(dev->socket);

   229

        dev->socket = NULL;

   230

        return ret;

   231

    }

   232

   233

    return 0;

   234

}

   235

   236

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

   237

   238

/** Offer generic device to master.

   239

 */

   240

int ec_gen_device_offer(

   241

        ec_gen_device_t *dev,

   242

        ec_gen_interface_desc_t *desc

   243

        )

   244

{

   245

    int ret = 0;

   246

   247

    dev->used_netdev = desc->netdev;

   248

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

   249

   250

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

   251

    if (dev->ecdev) {

   252

        if (ec_gen_device_create_socket(dev, desc)) {

   253

            ecdev_withdraw(dev->ecdev);

   254

            dev->ecdev = NULL;

   255

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

   256

            ecdev_withdraw(dev->ecdev);

   257

            dev->ecdev = NULL;

   258

        } else {

   259

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

   260

            ret = 1;

   261

        }

   262

    }

   263

   264

    return ret;

   265

}

   266

   267

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

   268

   269

/** Open the device.

   270

 */

   271

int ec_gen_device_open(

   272

        ec_gen_device_t *dev

   273

        )

   274

{

   275

    return 0;

   276

}

   277

   278

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

   279

   280

/** Stop the device.

   281

 */

   282

int ec_gen_device_stop(

   283

        ec_gen_device_t *dev

   284

        )

   285

{

   286

    return 0;

   287

}

   288

   289

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

   290

   291

int ec_gen_device_start_xmit(

   292

        ec_gen_device_t *dev,

   293

        struct sk_buff *skb

   294

        )

   295

{

   296

    struct msghdr msg;

   297

    struct kvec iov;

   298

    size_t len = skb->len;

   299

    int ret;

   300

   301

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

   302

   303

    iov.iov_base = skb->data;

   304

    iov.iov_len = len;

   305

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

   306

   307

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

   308

   309

    return ret == len ? NETDEV_TX_OK : NETDEV_TX_BUSY;

   310

}

   311

   312

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

   313

   314

/** Polls the device.

   315

 */

   316

void ec_gen_device_poll(

   317

        ec_gen_device_t *dev

   318

        )

   319

{

   320

    struct msghdr msg;

   321

    struct kvec iov;

   322

    int ret, budget = 10; // FIXME

   323

   324

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

   325

   326

    do {

   327

        iov.iov_base = dev->rx_buf;

   328

        iov.iov_len = EC_GEN_RX_BUF_SIZE;

   329

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

   330

   331

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

   332

                MSG_DONTWAIT);

   333

        if (ret > 0) {

   334

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

   335

        } else if (ret < 0) {

   336

            break;

   337

        }

   338

        budget--;

   339

    } while (budget);

   340

}

   341

   342

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

   343

   344

/** Offer device.

   345

 */

   346

int offer_device(

   347

        ec_gen_interface_desc_t *desc

   348

        )

   349

{

   350

    ec_gen_device_t *gendev;

   351

    int ret = 0;

   352

   353

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

   354

    if (!gendev) {

   355

        return -ENOMEM;

   356

    }

   357

   358

    ret = ec_gen_device_init(gendev);

   359

    if (ret) {

   360

        kfree(gendev);

   361

        return ret;

   362

    }

   363

   364

    if (ec_gen_device_offer(gendev, desc)) {

   365

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

   366

    } else {

   367

        ec_gen_device_clear(gendev);

   368

        kfree(gendev);

   369

    }

   370

   371

    return ret;

   372

}

   373

   374

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

   375

   376

/** Clear devices.

   377

 */

   378

void clear_devices(void)

   379

{

   380

    ec_gen_device_t *gendev, *next;

   381

   382

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

   383

        list_del(&gendev->list);

   384

        ec_gen_device_clear(gendev);

   385

        kfree(gendev);

   386

    }

   387

}

   388

   389

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

   390

   391

/** Module initialization.

   392

 *

   393

 * Initializes \a master_count masters.

   394

 * \return 0 on success, else < 0

   395

 */

   396

int __init ec_gen_init_module(void)

   397

{

   398

    int ret = 0;

   399

    struct list_head descs;

   400

    struct net_device *netdev;

   401

    ec_gen_interface_desc_t *desc, *next;

   402

   403

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

   404

            EC_MASTER_VERSION);

   405

   406

    INIT_LIST_HEAD(&generic_devices);

   407

    INIT_LIST_HEAD(&descs);

   408

   409

    read_lock(&dev_base_lock);

   410

    for_each_netdev(&init_net, netdev) {

   411

        if (netdev->type != ARPHRD_ETHER)

   412

            continue;

   413

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

   414

        if (!desc) {

   415

            ret = -ENOMEM;

   416

            read_unlock(&dev_base_lock);

   417

            goto out_err;

   418

        }

   419

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

   420

        desc->netdev = netdev;

   421

        desc->ifindex = netdev->ifindex;

   422

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

   423

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

   424

    }

   425

    read_unlock(&dev_base_lock);

   426

   427

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

   428

        ret = offer_device(desc);

   429

        if (ret) {

   430

            goto out_err;

   431

        }

   432

        kfree(desc);

   433

    }

   434

    return ret;

   435

   436

out_err:

   437

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

   438

        list_del(&desc->list);

   439

        kfree(desc);

   440

    }

   441

    clear_devices();

   442

    return ret;

   443

}

   444

   445

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

   446

   447

/** Module cleanup.

   448

 *

   449

 * Clears all master instances.

   450

 */

   451

void __exit ec_gen_cleanup_module(void)

   452

{

   453

    clear_devices();

   454

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

   455

}

   456

   457

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

   458

   459

/** \cond */

   460

   461

module_init(ec_gen_init_module);

   462

module_exit(ec_gen_cleanup_module);

   463

   464

/** \endcond */

   465

   466

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