1

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

     2

 *

     3

 *  $Id$

     4

 *

     5

 *  Copyright (C) 2006-2012  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

 *  vim: expandtab

    29

 *

    30

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

    31

    32

/**

    33

   \file

    34

   EtherCAT master methods.

    35

*/

    36

    37

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

    38

    39

#include <linux/module.h>

    40

#include <linux/kernel.h>

    41

#include <linux/string.h>

    42

#include <linux/slab.h>

    43

#include <linux/delay.h>

    44

#include <linux/device.h>

    45

#include <linux/version.h>

    46

#include <linux/hrtimer.h>

    47

#include "globals.h"

    48

#include "slave.h"

    49

#include "slave_config.h"

    50

#include "device.h"

    51

#include "datagram.h"

    52

#ifdef EC_EOE

    53

#include "ethernet.h"

    54

#endif

    55

#include "master.h"

    56

    57

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

    58

    59

/** Set to 1 to enable external datagram injection debugging.

    60

 */

    61

#define DEBUG_INJECT 0

    62

    63

#ifdef EC_HAVE_CYCLES

    64

    65

/** Frame timeout in cycles.

    66

 */

    67

static cycles_t timeout_cycles;

    68

    69

/** Timeout for external datagram injection [cycles].

    70

 */

    71

static cycles_t ext_injection_timeout_cycles;

    72

    73

#else

    74

    75

/** Frame timeout in jiffies.

    76

 */

    77

static unsigned long timeout_jiffies;

    78

    79

/** Timeout for external datagram injection [jiffies].

    80

 */

    81

static unsigned long ext_injection_timeout_jiffies;

    82

    83

#endif

    84

    85

/** List of intervals for statistics [s].

    86

 */

    87

const unsigned int rate_intervals[] = {

    88

    1, 10, 60

    89

};

    90

    91

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

    92

    93

void ec_master_clear_slave_configs(ec_master_t *);

    94

void ec_master_clear_domains(ec_master_t *);

    95

static int ec_master_idle_thread(void *);

    96

static int ec_master_operation_thread(void *);

    97

#ifdef EC_EOE

    98

static int ec_master_eoe_thread(void *);

    99

#endif

   100

void ec_master_find_dc_ref_clock(ec_master_t *);

   101

void ec_master_clear_device_stats(ec_master_t *);

   102

void ec_master_update_device_stats(ec_master_t *);

   103

   104

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

   105

   106

/** Static variables initializer.

   107

*/

   108

void ec_master_init_static(void)

   109

{

   110

#ifdef EC_HAVE_CYCLES

   111

    timeout_cycles = (cycles_t) EC_IO_TIMEOUT /* us */ * (cpu_khz / 1000);

   112

    ext_injection_timeout_cycles =

   113

        (cycles_t) EC_SDO_INJECTION_TIMEOUT /* us */ * (cpu_khz / 1000);

   114

#else

   115

    // one jiffy may always elapse between time measurement

   116

    timeout_jiffies = max(EC_IO_TIMEOUT * HZ / 1000000, 1);

   117

    ext_injection_timeout_jiffies =

   118

        max(EC_SDO_INJECTION_TIMEOUT * HZ / 1000000, 1);

   119

#endif

   120

}

   121

   122

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

   123

   124

/**

   125

   Master constructor.

   126

   \return 0 in case of success, else < 0

   127

*/

   128

   129

int ec_master_init(ec_master_t *master, /**< EtherCAT master */

   130

        unsigned int index, /**< master index */

   131

        const uint8_t *main_mac, /**< MAC address of main device */

   132

        const uint8_t *backup_mac, /**< MAC address of backup device */

   133

        dev_t device_number, /**< Character device number. */

   134

        struct class *class, /**< Device class. */

   135

        unsigned int debug_level /**< Debug level (module parameter). */

   136

        )

   137

{

   138

    int ret;

   139

   140

    master->index = index;

   141

    master->reserved = 0;

   142

   143

    sema_init(&master->master_sem, 1);

   144

   145

    master->macs[EC_DEVICE_MAIN] = main_mac;

   146

    master->macs[EC_DEVICE_BACKUP] = backup_mac;

   147

    ec_master_clear_device_stats(master);

   148

   149

    sema_init(&master->device_sem, 1);

   150

   151

    master->phase = EC_ORPHANED;

   152

    master->active = 0;

   153

    master->config_changed = 0;

   154

    master->injection_seq_fsm = 0;

   155

    master->injection_seq_rt = 0;

   156

   157

    master->slaves = NULL;

   158

    master->slave_count = 0;

   159

   160

    INIT_LIST_HEAD(&master->configs);

   161

    INIT_LIST_HEAD(&master->domains);

   162

   163

    master->app_time = 0ULL;

   164

    master->app_start_time = 0ULL;

   165

    master->has_app_time = 0;

   166

   167

    master->scan_busy = 0;

   168

    master->allow_scan = 1;

   169

    sema_init(&master->scan_sem, 1);

   170

    init_waitqueue_head(&master->scan_queue);

   171

   172

    master->config_busy = 0;

   173

    sema_init(&master->config_sem, 1);

   174

    init_waitqueue_head(&master->config_queue);

   175

   176

    INIT_LIST_HEAD(&master->datagram_queue);

   177

    master->datagram_index = 0;

   178

   179

    INIT_LIST_HEAD(&master->ext_datagram_queue);

   180

    sema_init(&master->ext_queue_sem, 1);

   181

   182

    INIT_LIST_HEAD(&master->external_datagram_queue);

   183

   184

    // send interval in IDLE phase

   185

    ec_master_set_send_interval(master, 1000000 / HZ);

   186

   187

    master->debug_level = debug_level;

   188

    master->stats.timeouts = 0;

   189

    master->stats.corrupted = 0;

   190

    master->stats.unmatched = 0;

   191

    master->stats.output_jiffies = 0;

   192

   193

    master->thread = NULL;

   194

   195

#ifdef EC_EOE

   196

    master->eoe_thread = NULL;

   197

    INIT_LIST_HEAD(&master->eoe_handlers);

   198

#endif

   199

   200

    sema_init(&master->io_sem, 1);

   201

    master->send_cb = NULL;

   202

    master->receive_cb = NULL;

   203

    master->cb_data = NULL;

   204

    master->app_send_cb = NULL;

   205

    master->app_receive_cb = NULL;

   206

    master->app_cb_data = NULL;

   207

   208

    INIT_LIST_HEAD(&master->sii_requests);

   209

    init_waitqueue_head(&master->sii_queue);

   210

   211

    INIT_LIST_HEAD(&master->reg_requests);

   212

    init_waitqueue_head(&master->reg_queue);

   213

   214

    // init devices

   215

    ret = ec_device_init(&master->devices[EC_DEVICE_MAIN], master);

   216

    if (ret < 0)

   217

        goto out_return;

   218

   219

    ret = ec_device_init(&master->devices[EC_DEVICE_BACKUP], master);

   220

    if (ret < 0)

   221

        goto out_clear_main;

   222

   223

    // init state machine datagram

   224

    ec_datagram_init(&master->fsm_datagram);

   225

    snprintf(master->fsm_datagram.name, EC_DATAGRAM_NAME_SIZE, "master-fsm");

   226

    ret = ec_datagram_prealloc(&master->fsm_datagram, EC_MAX_DATA_SIZE);

   227

    if (ret < 0) {

   228

        ec_datagram_clear(&master->fsm_datagram);

   229

        EC_MASTER_ERR(master, "Failed to allocate FSM datagram.\n");

   230

        goto out_clear_backup;

   231

    }

   232

   233

    // create state machine object

   234

    ec_fsm_master_init(&master->fsm, master, &master->fsm_datagram);

   235

   236

    // init reference sync datagram

   237

    ec_datagram_init(&master->ref_sync_datagram);

   238

    snprintf(master->ref_sync_datagram.name, EC_DATAGRAM_NAME_SIZE,

   239

            "refsync");

   240

    ret = ec_datagram_apwr(&master->ref_sync_datagram, 0, 0x0910, 8);

   241

    if (ret < 0) {

   242

        ec_datagram_clear(&master->ref_sync_datagram);

   243

        EC_MASTER_ERR(master, "Failed to allocate reference"

   244

                " synchronisation datagram.\n");

   245

        goto out_clear_fsm;

   246

    }

   247

   248

    // init sync datagram

   249

    ec_datagram_init(&master->sync_datagram);

   250

    snprintf(master->sync_datagram.name, EC_DATAGRAM_NAME_SIZE, "sync");

   251

    ret = ec_datagram_prealloc(&master->sync_datagram, 4);

   252

    if (ret < 0) {

   253

        ec_datagram_clear(&master->sync_datagram);

   254

        EC_MASTER_ERR(master, "Failed to allocate"

   255

                " synchronisation datagram.\n");

   256

        goto out_clear_ref_sync;

   257

    }

   258

   259

    // init sync monitor datagram

   260

    ec_datagram_init(&master->sync_mon_datagram);

   261

    snprintf(master->sync_mon_datagram.name, EC_DATAGRAM_NAME_SIZE,

   262

            "syncmon");

   263

    ret = ec_datagram_brd(&master->sync_mon_datagram, 0x092c, 4);

   264

    if (ret < 0) {

   265

        ec_datagram_clear(&master->sync_mon_datagram);

   266

        EC_MASTER_ERR(master, "Failed to allocate sync"

   267

                " monitoring datagram.\n");

   268

        goto out_clear_sync;

   269

    }

   270

   271

    ec_master_find_dc_ref_clock(master);

   272

   273

    // init character device

   274

    ret = ec_cdev_init(&master->cdev, master, device_number);

   275

    if (ret)

   276

        goto out_clear_sync_mon;

   277

   278

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

   279

    master->class_device = device_create(class, NULL,

   280

            MKDEV(MAJOR(device_number), master->index), NULL,

   281

            "EtherCAT%u", master->index);

   282

#elif LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 26)

   283

    master->class_device = device_create(class, NULL,

   284

            MKDEV(MAJOR(device_number), master->index),

   285

            "EtherCAT%u", master->index);

   286

#elif LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 15)

   287

    master->class_device = class_device_create(class, NULL,

   288

            MKDEV(MAJOR(device_number), master->index), NULL,

   289

            "EtherCAT%u", master->index);

   290

#else

   291

    master->class_device = class_device_create(class,

   292

            MKDEV(MAJOR(device_number), master->index), NULL,

   293

            "EtherCAT%u", master->index);

   294

#endif

   295

    if (IS_ERR(master->class_device)) {

   296

        EC_MASTER_ERR(master, "Failed to create class device!\n");

   297

        ret = PTR_ERR(master->class_device);

   298

        goto out_clear_cdev;

   299

    }

   300

   301

#ifdef EC_RTDM

   302

    // init RTDM device

   303

    ret = ec_rtdm_dev_init(&master->rtdm_dev, master);

   304

    if (ret) {

   305

        goto out_unregister_class_device;

   306

    }

   307

#endif

   308

   309

    return 0;

   310

   311

#ifdef EC_RTDM

   312

out_unregister_class_device:

   313

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

   314

    device_unregister(master->class_device);

   315

#else

   316

    class_device_unregister(master->class_device);

   317

#endif

   318

#endif

   319

out_clear_cdev:

   320

    ec_cdev_clear(&master->cdev);

   321

out_clear_sync_mon:

   322

    ec_datagram_clear(&master->sync_mon_datagram);

   323

out_clear_sync:

   324

    ec_datagram_clear(&master->sync_datagram);

   325

out_clear_ref_sync:

   326

    ec_datagram_clear(&master->ref_sync_datagram);

   327

out_clear_fsm:

   328

    ec_fsm_master_clear(&master->fsm);

   329

    ec_datagram_clear(&master->fsm_datagram);

   330

out_clear_backup:

   331

    ec_device_clear(&master->devices[EC_DEVICE_BACKUP]);

   332

out_clear_main:

   333

    ec_device_clear(&master->devices[EC_DEVICE_MAIN]);

   334

out_return:

   335

    return ret;

   336

}

   337

   338

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

   339

   340

/** Destructor.

   341

*/

   342

void ec_master_clear(

   343

        ec_master_t *master /**< EtherCAT master */

   344

        )

   345

{

   346

#ifdef EC_RTDM

   347

    ec_rtdm_dev_clear(&master->rtdm_dev);

   348

#endif

   349

   350

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

   351

    device_unregister(master->class_device);

   352

#else

   353

    class_device_unregister(master->class_device);

   354

#endif

   355

   356

    ec_cdev_clear(&master->cdev);

   357

   358

#ifdef EC_EOE

   359

    ec_master_clear_eoe_handlers(master);

   360

#endif

   361

    ec_master_clear_domains(master);

   362

    ec_master_clear_slave_configs(master);

   363

    ec_master_clear_slaves(master);

   364

   365

    ec_datagram_clear(&master->sync_mon_datagram);

   366

    ec_datagram_clear(&master->sync_datagram);

   367

    ec_datagram_clear(&master->ref_sync_datagram);

   368

    ec_fsm_master_clear(&master->fsm);

   369

    ec_datagram_clear(&master->fsm_datagram);

   370

    ec_device_clear(&master->devices[EC_DEVICE_BACKUP]);

   371

    ec_device_clear(&master->devices[EC_DEVICE_MAIN]);

   372

}

   373

   374

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

   375

   376

#ifdef EC_EOE

   377

/** Clear and free all EoE handlers.

   378

 */

   379

void ec_master_clear_eoe_handlers(

   380

        ec_master_t *master /**< EtherCAT master */

   381

        )

   382

{

   383

    ec_eoe_t *eoe, *next;

   384

   385

    list_for_each_entry_safe(eoe, next, &master->eoe_handlers, list) {

   386

        list_del(&eoe->list);

   387

        ec_eoe_clear(eoe);

   388

        kfree(eoe);

   389

    }

   390

}

   391

#endif

   392

   393

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

   394

   395

/** Clear all slave configurations.

   396

 */

   397

void ec_master_clear_slave_configs(ec_master_t *master)

   398

{

   399

    ec_slave_config_t *sc, *next;

   400

   401

    list_for_each_entry_safe(sc, next, &master->configs, list) {

   402

        list_del(&sc->list);

   403

        ec_slave_config_clear(sc);

   404

        kfree(sc);

   405

    }

   406

}

   407

   408

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

   409

   410

/** Clear all slaves.

   411

 */

   412

void ec_master_clear_slaves(ec_master_t *master)

   413

{

   414

    ec_slave_t *slave;

   415

   416

    master->dc_ref_clock = NULL;

   417

   418

    // external requests are obsolete, so we wake pending waiters and remove

   419

    // them from the list

   420

   421

    while (!list_empty(&master->sii_requests)) {

   422

        ec_sii_write_request_t *request =

   423

            list_entry(master->sii_requests.next,

   424

                    ec_sii_write_request_t, list);

   425

        list_del_init(&request->list); // dequeue

   426

        EC_MASTER_WARN(master, "Discarding SII request, slave %u about"

   427

                " to be deleted.\n", request->slave->ring_position);

   428

        request->state = EC_INT_REQUEST_FAILURE;

   429

        wake_up(&master->sii_queue);

   430

    }

   431

   432

    while (!list_empty(&master->reg_requests)) {

   433

        ec_reg_request_t *request =

   434

            list_entry(master->reg_requests.next, ec_reg_request_t, list);

   435

        list_del_init(&request->list); // dequeue

   436

        EC_MASTER_WARN(master, "Discarding register request, slave %u"

   437

                " about to be deleted.\n", request->slave->ring_position);

   438

        request->state = EC_INT_REQUEST_FAILURE;

   439

        wake_up(&master->reg_queue);

   440

    }

   441

   442

    for (slave = master->slaves;

   443

            slave < master->slaves + master->slave_count;

   444

            slave++) {

   445

        ec_slave_clear(slave);

   446

    }

   447

   448

    if (master->slaves) {

   449

        kfree(master->slaves);

   450

        master->slaves = NULL;

   451

    }

   452

   453

    master->slave_count = 0;

   454

}

   455

   456

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

   457

   458

/** Clear all domains.

   459

 */

   460

void ec_master_clear_domains(ec_master_t *master)

   461

{

   462

    ec_domain_t *domain, *next;

   463

   464

    list_for_each_entry_safe(domain, next, &master->domains, list) {

   465

        list_del(&domain->list);

   466

        ec_domain_clear(domain);

   467

        kfree(domain);

   468

    }

   469

}

   470

   471

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

   472

   473

/** Clear the configuration applied by the application.

   474

 */

   475

void ec_master_clear_config(

   476

        ec_master_t *master /**< EtherCAT master. */

   477

        )

   478

{

   479

    down(&master->master_sem);

   480

    ec_master_clear_domains(master);

   481

    ec_master_clear_slave_configs(master);