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 char *backup_devices[MAX_MASTERS]; /**< Backup devices parameter. */

    59

    60

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

    61

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

    62

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

    63

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

    64

    65

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

    66

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

    67

    68

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

    69

    70

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

    71

    72

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

    73

    74

/** \cond */

    75

    76

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

    77

MODULE_DESCRIPTION("EtherCAT master driver module");

    78

MODULE_LICENSE("GPL");

    79

MODULE_VERSION(EC_MASTER_VERSION);

    80

    81

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

    82

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

    83

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

    84

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

    85

    86

/** \endcond */

    87

    88

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

    89

    90

/** Module initialization.

    91

 *

    92

 * Initializes \a master_count masters.

    93

 * \return 0 on success, else < 0

    94

 */

    95

int __init ec_init_module(void)

    96

{

    97

    int i, ret = 0;

    98

    99

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

   100

   101

    init_MUTEX(&master_sem);

   102

   103

    if (master_count) {

   104

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

   105

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

   106

            ret = -EBUSY;

   107

            goto out_return;

   108

        }

   109

    }

   110

   111

    class = class_create(THIS_MODULE, "EtherCAT");

   112

    if (IS_ERR(class)) {

   113

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

   114

        ret = PTR_ERR(class);

   115

        goto out_cdev;

   116

    }

   117

   118

    // zero MAC addresses

   119

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

   120

   121

    // process MAC parameters

   122

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

   123

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

   124

        if (ret)

   125

            goto out_class;

   126

   127

        if (i < backup_count) {

   128

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

   129

            if (ret)

   130

                goto out_class;

   131

        }

   132

    }

   133

   134

    // initialize static master variables

   135

    ec_master_init_static();

   136

   137

    if (master_count) {

   138

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

   139

                        GFP_KERNEL))) {

   140

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

   141

            ret = -ENOMEM;

   142

            goto out_class;

   143

        }

   144

    }

   145

   146

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

   147

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

   148

                    device_number, class);

   149

        if (ret)

   150

            goto out_free_masters;

   151

    }

   152

   153

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

   154

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

   155

    return ret;

   156

   157

out_free_masters:

   158

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

   159

        ec_master_clear(&masters[i]);

   160

    kfree(masters);

   161

out_class:

   162

    class_destroy(class);

   163

out_cdev:

   164

    if (master_count)

   165

        unregister_chrdev_region(device_number, master_count);

   166

out_return:

   167

    return ret;

   168

}

   169

   170

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

   171

   172

/** Module cleanup.

   173

 *

   174

 * Clears all master instances.

   175

 */

   176

void __exit ec_cleanup_module(void)

   177

{

   178

    unsigned int i;

   179

   180

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

   181

        ec_master_clear(&masters[i]);

   182

    }

   183

   184

    if (master_count)

   185

        kfree(masters);

   186

   187

    class_destroy(class);

   188

   189

    if (master_count)

   190

        unregister_chrdev_region(device_number, master_count);

   191

   192

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

   193

}

   194

   195

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

   196

 * MAC address functions

   197

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

   198

   199

/**

   200

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

   201

 */

   202

int ec_mac_equal(

   203

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

   204

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

   205

        )

   206

{

   207

    unsigned int i;

   208

   209

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

   210

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

   211

            return 0;

   212

   213

    return 1;

   214

}

   215

   216

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

   217

   218

/** Print a MAC address to a buffer.

   219

 *

   220

 * \return number of bytes written.

   221

 */

   222

ssize_t ec_mac_print(

   223

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

   224

        char *buffer /**< target buffer */

   225

        )

   226

{

   227

    off_t off = 0;

   228

    unsigned int i;

   229

   230

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

   231

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

   232

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

   233

    }

   234

   235

    return off;

   236

}

   237

   238

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

   239

   240

/**

   241

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

   242

 */

   243

int ec_mac_is_zero(

   244

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

   245

        )

   246

{

   247

    unsigned int i;

   248

   249

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

   250

        if (mac[i])

   251

            return 0;

   252

   253

    return 1;

   254

}

   255

   256

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

   257

   258

/**

   259

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

   260

 */

   261

int ec_mac_is_broadcast(

   262

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

   263

        )

   264

{

   265

    unsigned int i;

   266

   267

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

   268

        if (mac[i] != 0xff)

   269

            return 0;

   270

   271

    return 1;

   272

}

   273

   274

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

   275

   276

/** Parse a MAC address from a string.

   277

 *

   278

 * The MAC address must follow the regexp

   279

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

   280

 *

   281

 * \return 0 on success, else < 0

   282

 */

   283

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

   284

{

   285

    unsigned int i, value;

   286

    const char *orig = src;

   287

    char *rem;

   288

   289

    if (!strlen(src)) {

   290

        if (allow_empty){

   291

            return 0;

   292

        }

   293

        else {

   294

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

   295

            return -EINVAL;

   296

        }

   297

    }

   298

   299

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

   300

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

   301

        if (rem != src + 2

   302

                || value > 0xFF

   303

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

   304

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

   305

            return -EINVAL;

   306

        }

   307

        mac[i] = value;

   308

        if (i < ETH_ALEN - 1)

   309

            src = rem + 1; // skip colon

   310

    }

   311

   312

    return 0;

   313

}

   314

   315

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

   316

   317

/** Outputs frame contents for debugging purposes.

   318

 */

   319

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

   320

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

   321

                   )

   322

{

   323

    unsigned int i;

   324

   325

    EC_DBG("");

   326

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

   327

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

   328

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

   329

            printk("\n");

   330

            EC_DBG("");

   331

        }

   332

    }

   333

    printk("\n");

   334

}

   335

   336

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

   337

   338

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

   339

 */

   340

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

   341

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

   342

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

   343

                        )

   344

{

   345

    unsigned int i;

   346

   347

    EC_DBG("");

   348

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

   349

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

   350

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

   351

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

   352

            printk("\n");

   353

            EC_DBG("");

   354

        }

   355

    }

   356

    printk("\n");

   357

}

   358

   359

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

   360

   361

/** Prints slave states in clear text.

   362

 */

   363

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

   364

                       char *buffer, /**< target buffer

   365

                                       (min. EC_STATE_STRING_SIZE bytes) */

   366

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

   367

                       )

   368

{

   369

    off_t off = 0;

   370

    unsigned int first = 1;

   371

   372

    if (!states) {

   373

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

   374

        return off;

   375

    }

   376

   377

    if (multi) { // multiple slaves

   378

        if (states & EC_SLAVE_STATE_INIT) {

   379

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

   380

            first = 0;

   381

        }

   382

        if (states & EC_SLAVE_STATE_PREOP) {

   383

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

   384

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

   385

            first = 0;

   386

        }

   387

        if (states & EC_SLAVE_STATE_SAFEOP) {

   388

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

   389

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

   390

            first = 0;

   391

        }

   392

        if (states & EC_SLAVE_STATE_OP) {

   393

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

   394

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

   395

        }

   396

    } else { // single slave

   397

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

   398

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

   399

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

   400

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

   401

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

   402

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

   403

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

   404

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

   405

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

   406

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

   407

        } else {

   408

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

   409

        }

   410

        first = 0;

   411

    }

   412

   413

    if (states & EC_SLAVE_STATE_ACK_ERR) {

   414

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

   415

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

   416

    }

   417

   418

    return off;

   419

}

   420

   421

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

   422

 *  Device interface

   423

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

   424

   425

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

   426

 *

   427

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

   428

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

   429

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

   430

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

   431

 *

   432

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

   433

 * \ingroup DeviceInterface

   434

 */

   435

ec_device_t *ecdev_offer(

   436

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

   437

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

   438

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

   439

        )

   440

{

   441

    ec_master_t *master;

   442

    char str[20];

   443

    unsigned int i;

   444

   445

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

   446

        master = &masters[i];

   447

   448

        down(&master->device_sem);

   449

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

   450

            up(&master->device_sem);

   451

            continue;

   452

        }

   453

   454

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

   455

                || ec_mac_is_broadcast(master->main_mac)) {

   456

            ec_mac_print(net_dev->dev_addr, str);

   457

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

   458

                    str, master->index);

   459

   460

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

   461

            up(&master->device_sem);

   462

   463

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

   464

            return &master->main_device; // offer accepted

   465

        }

   466

        else {

   467

            up(&master->device_sem);

   468

   469

            if (master->debug_level) {

   470

                ec_mac_print(net_dev->dev_addr, str);

   471

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

   472

            }

   473

        }

   474

    }

   475

   476

    return NULL; // offer declined

   477

}

   478

   479

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

   480

 *  Realtime interface

   481

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

   482

   483

/** Request a master.

   484

 *

   485

 * Same as ecrt_request_master(), but with ERR_PTR() return value.

   486

 */

   487

ec_master_t *ecrt_request_master_err(