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 master driver module.

    32

 */

    33

    34

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

    35

    36

#include <linux/module.h>

    37

#include <linux/device.h>

    38

#include <linux/err.h>

    39

    40

#include "globals.h"

    41

#include "master.h"

    42

#include "device.h"

    43

    44

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

    45

    46

#define MAX_MASTERS 5 /**< Maximum number of masters. */

    47

    48

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

    49

    50

int __init ec_init_module(void);

    51

void __exit ec_cleanup_module(void);

    52

    53

static int ec_mac_parse(uint8_t *, const char *, int);

    54

    55

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

    56

    57

static char *main_devices[MAX_MASTERS]; /**< Main devices parameter. */

    58

static unsigned int master_count; /**< Number of masters. */

    59

static char *backup_devices[MAX_MASTERS]; /**< Backup devices parameter. */

    60

static unsigned int backup_count; /**< Number of backup devices. */

    61

static unsigned int debug_level;  /**< Debug level parameter. */

    62

    63

static ec_master_t *masters; /**< Array of masters. */

    64

static struct semaphore master_sem; /**< Master semaphore. */

    65

    66

dev_t device_number; /**< Device number for master cdevs. */

    67

struct class *class; /**< Device class. */

    68

    69

static uint8_t macs[MAX_MASTERS][2][ETH_ALEN]; /**< MAC addresses. */

    70

    71

char *ec_master_version_str = EC_MASTER_VERSION; /**< Version string. */

    72

    73

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

    74

    75

/** \cond */

    76

    77

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

    78

MODULE_DESCRIPTION("EtherCAT master driver module");

    79

MODULE_LICENSE("GPL");

    80

MODULE_VERSION(EC_MASTER_VERSION);

    81

    82

module_param_array(main_devices, charp, &master_count, S_IRUGO);

    83

MODULE_PARM_DESC(main_devices, "MAC addresses of main devices");

    84

module_param_array(backup_devices, charp, &backup_count, S_IRUGO);

    85

MODULE_PARM_DESC(backup_devices, "MAC addresses of backup devices");

    86

module_param_named(debug_level, debug_level, uint, S_IRUGO);

    87

MODULE_PARM_DESC(debug_level, "Debug level");

    88

    89

/** \endcond */

    90

    91

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

    92

    93

/** Module initialization.

    94

 *

    95

 * Initializes \a master_count masters.

    96

 * \return 0 on success, else < 0

    97

 */

    98

int __init ec_init_module(void)

    99

{

   100

    int i, ret = 0;

   101

   102

    EC_INFO("Master driver %s\n", EC_MASTER_VERSION);

   103

   104

    init_MUTEX(&master_sem);

   105

   106

    if (master_count) {

   107

        if (alloc_chrdev_region(&device_number, 0, master_count, "EtherCAT")) {

   108

            EC_ERR("Failed to obtain device number(s)!\n");

   109

            ret = -EBUSY;

   110

            goto out_return;

   111

        }

   112

    }

   113

   114

    class = class_create(THIS_MODULE, "EtherCAT");

   115

    if (IS_ERR(class)) {

   116

        EC_ERR("Failed to create device class.\n");

   117

        ret = PTR_ERR(class);

   118

        goto out_cdev;

   119

    }

   120

   121

    // zero MAC addresses

   122

    memset(macs, 0x00, sizeof(uint8_t) * MAX_MASTERS * 2 * ETH_ALEN);

   123

   124

    // process MAC parameters

   125

    for (i = 0; i < master_count; i++) {

   126

        ret = ec_mac_parse(macs[i][0], main_devices[i], 0);

   127

        if (ret)

   128

            goto out_class;

   129

   130

        if (i < backup_count) {

   131

            ret = ec_mac_parse(macs[i][1], backup_devices[i], 1);

   132

            if (ret)

   133

                goto out_class;

   134

        }

   135

    }

   136

   137

    // initialize static master variables

   138

    ec_master_init_static();

   139

   140

    if (master_count) {

   141

        if (!(masters = kmalloc(sizeof(ec_master_t) * master_count,

   142

                        GFP_KERNEL))) {

   143

            EC_ERR("Failed to allocate memory for EtherCAT masters.\n");

   144

            ret = -ENOMEM;

   145

            goto out_class;

   146

        }

   147

    }

   148

   149

    for (i = 0; i < master_count; i++) {

   150

        ret = ec_master_init(&masters[i], i, macs[i][0], macs[i][1],

   151

                    device_number, class, debug_level);

   152

        if (ret)

   153

            goto out_free_masters;

   154

    }

   155

   156

    EC_INFO("%u master%s waiting for devices.\n",

   157

            master_count, (master_count == 1 ? "" : "s"));

   158

    return ret;

   159

   160

out_free_masters:

   161

    for (i--; i >= 0; i--)

   162

        ec_master_clear(&masters[i]);

   163

    kfree(masters);

   164

out_class:

   165

    class_destroy(class);

   166

out_cdev:

   167

    if (master_count)

   168

        unregister_chrdev_region(device_number, master_count);

   169

out_return:

   170

    return ret;

   171

}

   172

   173

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

   174

   175

/** Module cleanup.

   176

 *

   177

 * Clears all master instances.

   178

 */

   179

void __exit ec_cleanup_module(void)

   180

{

   181

    unsigned int i;

   182

   183

    for (i = 0; i < master_count; i++) {

   184

        ec_master_clear(&masters[i]);

   185

    }

   186

   187

    if (master_count)

   188

        kfree(masters);

   189

   190

    class_destroy(class);

   191

   192

    if (master_count)

   193

        unregister_chrdev_region(device_number, master_count);

   194

   195

    EC_INFO("Master module cleaned up.\n");

   196

}

   197

   198

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

   199

 * MAC address functions

   200

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

   201

   202

/**

   203

 * \return true, if two MAC addresses are equal.

   204

 */

   205

int ec_mac_equal(

   206

        const uint8_t *mac1, /**< First MAC address. */

   207

        const uint8_t *mac2 /**< Second MAC address. */

   208

        )

   209

{

   210

    unsigned int i;

   211

   212

    for (i = 0; i < ETH_ALEN; i++)

   213

        if (mac1[i] != mac2[i])

   214

            return 0;

   215

   216

    return 1;

   217

}

   218

   219

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

   220

   221

/** Print a MAC address to a buffer.

   222

 *

   223

 * \return number of bytes written.

   224

 */

   225

ssize_t ec_mac_print(

   226

        const uint8_t *mac, /**< MAC address */

   227

        char *buffer /**< target buffer */

   228

        )

   229

{

   230

    off_t off = 0;

   231

    unsigned int i;

   232

   233

    for (i = 0; i < ETH_ALEN; i++) {

   234

        off += sprintf(buffer + off, "%02X", mac[i]);

   235

        if (i < ETH_ALEN - 1) off += sprintf(buffer + off, ":");

   236

    }

   237

   238

    return off;

   239

}

   240

   241

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

   242

   243

/**

   244

 * \return true, if the MAC address is all-zero.

   245

 */

   246

int ec_mac_is_zero(

   247

        const uint8_t *mac /**< MAC address. */

   248

        )

   249

{

   250

    unsigned int i;

   251

   252

    for (i = 0; i < ETH_ALEN; i++)

   253

        if (mac[i])

   254

            return 0;

   255

   256

    return 1;

   257

}

   258

   259

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

   260

   261

/**

   262

 * \return true, if the given MAC address is the broadcast address.

   263

 */

   264

int ec_mac_is_broadcast(

   265

        const uint8_t *mac /**< MAC address. */

   266

        )

   267

{

   268

    unsigned int i;

   269

   270

    for (i = 0; i < ETH_ALEN; i++)

   271

        if (mac[i] != 0xff)

   272

            return 0;

   273

   274

    return 1;

   275

}

   276

   277

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

   278

   279

/** Parse a MAC address from a string.

   280

 *

   281

 * The MAC address must follow the regexp

   282

 * "([0-9a-fA-F]{2}:){5}[0-9a-fA-F]{2}".

   283

 *

   284

 * \return 0 on success, else < 0

   285

 */

   286

static int ec_mac_parse(uint8_t *mac, const char *src, int allow_empty)

   287

{

   288

    unsigned int i, value;

   289

    const char *orig = src;

   290

    char *rem;

   291

   292

    if (!strlen(src)) {

   293

        if (allow_empty){

   294

            return 0;

   295

        }

   296

        else {

   297

            EC_ERR("MAC address may not be empty.\n");

   298

            return -EINVAL;

   299

        }

   300

    }

   301

   302

    for (i = 0; i < ETH_ALEN; i++) {

   303

        value = simple_strtoul(src, &rem, 16);

   304

        if (rem != src + 2

   305

                || value > 0xFF

   306

                || (i < ETH_ALEN - 1 && *rem != ':')) {

   307

            EC_ERR("Invalid MAC address \"%s\".\n", orig);

   308

            return -EINVAL;

   309

        }

   310

        mac[i] = value;

   311

        if (i < ETH_ALEN - 1)

   312

            src = rem + 1; // skip colon

   313

    }

   314

   315

    return 0;

   316

}

   317

   318

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

   319

   320

/** Outputs frame contents for debugging purposes.

   321

 */

   322

void ec_print_data(const uint8_t *data, /**< pointer to data */

   323

                   size_t size /**< number of bytes to output */

   324

                   )

   325

{

   326

    unsigned int i;

   327

   328

    EC_DBG("");

   329

    for (i = 0; i < size; i++) {

   330

        printk("%02X ", data[i]);

   331

        if ((i + 1) % 16 == 0 && i < size - 1) {

   332

            printk("\n");

   333

            EC_DBG("");

   334

        }

   335

    }

   336

    printk("\n");

   337

}

   338

   339

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

   340

   341

/** Outputs frame contents and differences for debugging purposes.

   342

 */

   343

void ec_print_data_diff(const uint8_t *d1, /**< first data */

   344

                        const uint8_t *d2, /**< second data */

   345

                        size_t size /** number of bytes to output */

   346

                        )

   347

{

   348

    unsigned int i;

   349

   350

    EC_DBG("");

   351

    for (i = 0; i < size; i++) {

   352

        if (d1[i] == d2[i]) printk(".. ");

   353

        else printk("%02X ", d2[i]);

   354

        if ((i + 1) % 16 == 0) {

   355

            printk("\n");

   356

            EC_DBG("");

   357

        }

   358

    }

   359

    printk("\n");

   360

}

   361

   362

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

   363

   364

/** Prints slave states in clear text.

   365

 */

   366

size_t ec_state_string(uint8_t states, /**< slave states */

   367

                       char *buffer, /**< target buffer

   368

                                       (min. EC_STATE_STRING_SIZE bytes) */

   369

                       uint8_t multi /**< Show multi-state mask. */

   370

                       )

   371

{

   372

    off_t off = 0;

   373

    unsigned int first = 1;

   374

   375

    if (!states) {

   376

        off += sprintf(buffer + off, "(unknown)");

   377

        return off;

   378

    }

   379

   380

    if (multi) { // multiple slaves

   381

        if (states & EC_SLAVE_STATE_INIT) {

   382

            off += sprintf(buffer + off, "INIT");

   383

            first = 0;

   384

        }

   385

        if (states & EC_SLAVE_STATE_PREOP) {

   386

            if (!first) off += sprintf(buffer + off, ", ");

   387

            off += sprintf(buffer + off, "PREOP");

   388

            first = 0;

   389

        }

   390

        if (states & EC_SLAVE_STATE_SAFEOP) {

   391

            if (!first) off += sprintf(buffer + off, ", ");

   392

            off += sprintf(buffer + off, "SAFEOP");

   393

            first = 0;

   394

        }

   395

        if (states & EC_SLAVE_STATE_OP) {

   396

            if (!first) off += sprintf(buffer + off, ", ");

   397

            off += sprintf(buffer + off, "OP");

   398

        }

   399

    } else { // single slave

   400

        if ((states & EC_SLAVE_STATE_MASK) == EC_SLAVE_STATE_INIT) {

   401

            off += sprintf(buffer + off, "INIT");

   402

        } else if ((states & EC_SLAVE_STATE_MASK) == EC_SLAVE_STATE_PREOP) {

   403

            off += sprintf(buffer + off, "PREOP");

   404

        } else if ((states & EC_SLAVE_STATE_MASK) == EC_SLAVE_STATE_BOOT) {

   405

            off += sprintf(buffer + off, "BOOT");

   406

        } else if ((states & EC_SLAVE_STATE_MASK) == EC_SLAVE_STATE_SAFEOP) {

   407

            off += sprintf(buffer + off, "SAFEOP");

   408

        } else if ((states & EC_SLAVE_STATE_MASK) == EC_SLAVE_STATE_OP) {

   409

            off += sprintf(buffer + off, "OP");

   410

        } else {

   411

            off += sprintf(buffer + off, "(invalid)");

   412

        }

   413

        first = 0;

   414

    }

   415

   416

    if (states & EC_SLAVE_STATE_ACK_ERR) {

   417

        if (!first) off += sprintf(buffer + off, " + ");

   418

        off += sprintf(buffer + off, "ERROR");

   419

    }

   420

   421

    return off;

   422

}

   423

   424

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

   425

 *  Device interface

   426

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

   427

   428

/** Offers an EtherCAT device to a certain master.

   429

 *

   430

 * The master decides, if it wants to use the device for EtherCAT operation,

   431

 * or not. It is important, that the offered net_device is not used by the

   432

 * kernel IP stack. If the master, accepted the offer, the address of the

   433

 * newly created EtherCAT device is returned, else \a NULL is returned.

   434

 *

   435

 * \return Pointer to device, if accepted, or NULL if declined.

   436

 * \ingroup DeviceInterface

   437

 */

   438

ec_device_t *ecdev_offer(

   439

        struct net_device *net_dev, /**< net_device to offer */

   440

        ec_pollfunc_t poll, /**< device poll function */

   441

        struct module *module /**< pointer to the module */

   442

        )

   443

{

   444

    ec_master_t *master;

   445

    char str[20];

   446

    unsigned int i;

   447

   448

    for (i = 0; i < master_count; i++) {

   449

        master = &masters[i];

   450

   451

        down(&master->device_sem);

   452

        if (master->main_device.dev) { // master already has a device

   453

            up(&master->device_sem);

   454

            continue;

   455

        }

   456

   457

        if (ec_mac_equal(master->main_mac, net_dev->dev_addr)

   458

                || ec_mac_is_broadcast(master->main_mac)) {

   459

            ec_mac_print(net_dev->dev_addr, str);

   460

            EC_INFO("Accepting device %s for master %u.\n",

   461

                    str, master->index);

   462

   463

            ec_device_attach(&master->main_device, net_dev, poll, module);

   464

            up(&master->device_sem);

   465

   466

            sprintf(net_dev->name, "ec%u", master->index);

   467

            return &master->main_device; // offer accepted

   468

        }

   469

        else {

   470

            up(&master->device_sem);

   471

   472

            if (master->debug_level) {

   473

                ec_mac_print(net_dev->dev_addr, str);

   474

                EC_DBG("Master %u declined device %s.\n", master->index, str);

   475

            }

   476

        }

   477

    }

   478

   479

    return NULL; // offer declined

   480

}

   481

   482

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

   483

 *  Realtime interface

   484

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

   485

   486

/** Request a master.