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

 *  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 fsm datagram injection [cycles].

    70

 */

    71

static cycles_t fsm_injection_timeout_cycles;

    72

    73

#else

    74

    75

/** Frame timeout in jiffies.

    76

 */

    77

static unsigned long timeout_jiffies;

    78

    79

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

    80

 */

    81

static unsigned long fsm_injection_timeout_jiffies;

    82

    83

#endif

    84

    85

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

    86

    87

void ec_master_clear_slave_configs(ec_master_t *);

    88

void ec_master_clear_domains(ec_master_t *);

    89

static int ec_master_idle_thread(void *);

    90

static int ec_master_operation_thread(void *);

    91

#ifdef EC_EOE

    92

static int ec_master_eoe_processing(ec_master_t *);

    93

#endif

    94

void ec_master_find_dc_ref_clock(ec_master_t *);

    95

    96

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

    97

    98

/** Static variables initializer.

    99

*/

   100

void ec_master_init_static(void)

   101

{

   102

#ifdef EC_HAVE_CYCLES

   103

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

   104

    fsm_injection_timeout_cycles = (cycles_t) EC_FSM_INJECTION_TIMEOUT /* us */ * (cpu_khz / 1000);

   105

#else

   106

    // one jiffy may always elapse between time measurement

   107

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

   108

    fsm_injection_timeout_jiffies = max(EC_FSM_INJECTION_TIMEOUT * HZ / 1000000, 1);

   109

#endif

   110

}

   111

   112

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

   113

   114

/**

   115

   Master constructor.

   116

   \return 0 in case of success, else < 0

   117

*/

   118

   119

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

   120

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

   121

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

   122

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

   123

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

   124

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

   125

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

   126

        )

   127

{

   128

    int ret;

   129

   130

    master->index = index;

   131

    master->reserved = 0;

   132

   133

    sema_init(&master->master_sem, 1);

   134

   135

    master->main_mac = main_mac;

   136

    master->backup_mac = backup_mac;

   137

   138

    sema_init(&master->device_sem, 1);

   139

   140

    master->phase = EC_ORPHANED;

   141

    master->active = 0;

   142

    master->config_changed = 0;

   143

    master->injection_seq_fsm = 0;

   144

    master->injection_seq_rt = 0;

   145

   146

    master->slaves = NULL;

   147

    master->slave_count = 0;

   148

   149

    INIT_LIST_HEAD(&master->configs);

   150

   151

    master->app_time = 0ULL;

   152

#ifdef EC_HAVE_CYCLES

   153

    master->dc_cycles_app_start_time = 0;

   154

#endif

   155

    master->dc_jiffies_app_start_time = 0;

   156

    master->app_start_time = 0ULL;

   157

    master->has_app_time = 0;

   158

   159

    master->scan_busy = 0;

   160

    master->allow_scan = 1;

   161

    sema_init(&master->scan_sem, 1);

   162

    init_waitqueue_head(&master->scan_queue);

   163

   164

    master->config_busy = 0;

   165

    master->allow_config = 1;

   166

    sema_init(&master->config_sem, 1);

   167

    init_waitqueue_head(&master->config_queue);

   168

   169

    INIT_LIST_HEAD(&master->datagram_queue);

   170

    master->datagram_index = 0;

   171

   172

    sema_init(&master->fsm_queue_sem, 1);

   173

    INIT_LIST_HEAD(&master->fsm_datagram_queue);

   174

   175

    // send interval in IDLE phase

   176

    ec_master_set_send_interval(master, 1000000 / HZ);

   177

   178

    INIT_LIST_HEAD(&master->domains);

   179

   180

    master->debug_level = debug_level;

   181

    master->stats.timeouts = 0;

   182

    master->stats.corrupted = 0;

   183

    master->stats.unmatched = 0;

   184

    master->stats.output_jiffies = 0;

   185

   186

    master->thread = NULL;

   187

   188

#ifdef EC_EOE

   189

    master->eoe_thread = NULL;

   190

    INIT_LIST_HEAD(&master->eoe_handlers);

   191

#endif

   192

   193

    sema_init(&master->io_sem, 1);

   194

    master->send_cb = NULL;

   195

    master->receive_cb = NULL;

   196

    master->cb_data = NULL;

   197

    master->app_send_cb = NULL;

   198

    master->app_receive_cb = NULL;

   199

    master->app_cb_data = NULL;

   200

   201

    INIT_LIST_HEAD(&master->sii_requests);

   202

    init_waitqueue_head(&master->sii_queue);

   203

   204

    INIT_LIST_HEAD(&master->reg_requests);

   205

    init_waitqueue_head(&master->reg_queue);

   206

   207

    // init devices

   208

    ret = ec_device_init(&master->main_device, master);

   209

    if (ret < 0)

   210

        goto out_return;

   211

   212

    ret = ec_device_init(&master->backup_device, master);

   213

    if (ret < 0)

   214

        goto out_clear_main;

   215

   216

    // init state machine datagram

   217

    ec_datagram_init(&master->fsm_datagram);

   218

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

   219

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

   220

    if (ret < 0) {

   221

        ec_datagram_clear(&master->fsm_datagram);

   222

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

   223

        goto out_clear_backup;

   224

    }

   225

   226

    // create state machine object

   227

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

   228

   229

    // init reference sync datagram

   230

    ec_datagram_init(&master->ref_sync_datagram);

   231

    snprintf(master->ref_sync_datagram.name, EC_DATAGRAM_NAME_SIZE, "refsync");

   232

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

   233

    if (ret < 0) {

   234

        ec_datagram_clear(&master->ref_sync_datagram);

   235

        EC_MASTER_ERR(master, "Failed to allocate reference"

   236

                " synchronisation datagram.\n");

   237

        goto out_clear_fsm;

   238

    }

   239

   240

    // init sync datagram

   241

    ec_datagram_init(&master->sync_datagram);

   242

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

   243

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

   244

    if (ret < 0) {

   245

        ec_datagram_clear(&master->sync_datagram);

   246

        EC_MASTER_ERR(master, "Failed to allocate"

   247

                " synchronisation datagram.\n");

   248

        goto out_clear_ref_sync;

   249

    }

   250

   251

    // init sync monitor datagram

   252

    ec_datagram_init(&master->sync_mon_datagram);

   253

    snprintf(master->sync_mon_datagram.name, EC_DATAGRAM_NAME_SIZE, "syncmon");

   254

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

   255

    if (ret < 0) {

   256

        ec_datagram_clear(&master->sync_mon_datagram);

   257

        EC_MASTER_ERR(master, "Failed to allocate sync"

   258

                " monitoring datagram.\n");

   259

        goto out_clear_sync;

   260

    }

   261

   262

    ec_master_find_dc_ref_clock(master);

   263

   264

    // init character device

   265

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

   266

    if (ret)

   267

        goto out_clear_sync_mon;

   268

   269

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

   270

    master->class_device = device_create(class, NULL,

   271

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

   272

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

   273

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

   274

    master->class_device = device_create(class, NULL,

   275

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

   276

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

   277

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

   278

    master->class_device = class_device_create(class, NULL,

   279

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

   280

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

   281

#else

   282

    master->class_device = class_device_create(class,

   283

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

   284

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

   285

#endif

   286

    if (IS_ERR(master->class_device)) {

   287

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

   288

        ret = PTR_ERR(master->class_device);

   289

        goto out_clear_cdev;

   290

    }

   291

   292

    return 0;

   293

   294

out_clear_cdev:

   295

    ec_cdev_clear(&master->cdev);

   296

out_clear_sync_mon:

   297

    ec_datagram_clear(&master->sync_mon_datagram);

   298

out_clear_sync:

   299

    ec_datagram_clear(&master->sync_datagram);

   300

out_clear_ref_sync:

   301

    ec_datagram_clear(&master->ref_sync_datagram);

   302

out_clear_fsm:

   303

    ec_fsm_master_clear(&master->fsm);

   304

    ec_datagram_clear(&master->fsm_datagram);

   305

out_clear_backup:

   306

    ec_device_clear(&master->backup_device);

   307

out_clear_main:

   308

    ec_device_clear(&master->main_device);

   309

out_return:

   310

    return ret;

   311

}

   312

   313

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

   314

   315

/** Destructor.

   316

*/

   317

void ec_master_clear(

   318

        ec_master_t *master /**< EtherCAT master */

   319

        )

   320

{

   321

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

   322

    device_unregister(master->class_device);

   323

#else

   324

    class_device_unregister(master->class_device);

   325

#endif

   326

   327

    ec_cdev_clear(&master->cdev);

   328

   329

#ifdef EC_EOE

   330

    ec_master_clear_eoe_handlers(master);

   331

#endif

   332

    ec_master_clear_domains(master);

   333

    ec_master_clear_slave_configs(master);

   334

    ec_master_clear_slaves(master);

   335

   336

    ec_datagram_clear(&master->sync_mon_datagram);

   337

    ec_datagram_clear(&master->sync_datagram);

   338

    ec_datagram_clear(&master->ref_sync_datagram);

   339

    ec_fsm_master_clear(&master->fsm);

   340

    ec_datagram_clear(&master->fsm_datagram);

   341

    ec_device_clear(&master->backup_device);

   342

    ec_device_clear(&master->main_device);

   343

}

   344

   345

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

   346

   347

#ifdef EC_EOE

   348

/** Clear and free all EoE handlers.

   349

 */

   350

void ec_master_clear_eoe_handlers(

   351

        ec_master_t *master /**< EtherCAT master */

   352

        )

   353

{

   354

    ec_eoe_t *eoe, *next;

   355

   356

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

   357

        list_del(&eoe->list);

   358

        ec_eoe_clear(eoe);

   359

        kfree(eoe);

   360

    }

   361

}

   362

#endif

   363

   364

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

   365

   366

/** Clear all slave configurations.

   367

 */

   368

void ec_master_clear_slave_configs(ec_master_t *master)

   369

{

   370

    ec_slave_config_t *sc, *next;

   371

   372

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

   373

        list_del(&sc->list);

   374

        ec_slave_config_clear(sc);

   375

        kfree(sc);

   376

    }

   377

}

   378

   379

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

   380

   381

/** Clear all slaves.

   382

 */

   383

void ec_master_clear_slaves(ec_master_t *master)

   384

{

   385

    ec_slave_t *slave;

   386

   387

    master->dc_ref_clock = NULL;

   388

   389

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

   390

    // them from the list

   391

   392

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

   393

        ec_sii_write_request_t *request =

   394

            list_entry(master->sii_requests.next,

   395

                    ec_sii_write_request_t, list);

   396

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

   397

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

   398

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

   399

        request->state = EC_INT_REQUEST_FAILURE;

   400

        wake_up(&master->sii_queue);

   401

    }

   402

   403

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

   404

        ec_reg_request_t *request =

   405

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

   406

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

   407

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

   408

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

   409

        request->state = EC_INT_REQUEST_FAILURE;

   410

        wake_up(&master->reg_queue);

   411

    }

   412

   413

    for (slave = master->slaves;

   414

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

   415

            slave++) {

   416

        ec_slave_clear(slave);

   417

    }

   418

   419

    if (master->slaves) {

   420

        kfree(master->slaves);

   421

        master->slaves = NULL;

   422

    }

   423

   424

    master->slave_count = 0;

   425

}

   426

   427

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

   428

   429

/** Clear all domains.

   430

 */

   431

void ec_master_clear_domains(ec_master_t *master)

   432

{

   433

    ec_domain_t *domain, *next;

   434

   435

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

   436

        list_del(&domain->list);

   437

        ec_domain_clear(domain);

   438

        kfree(domain);

   439

    }

   440

}

   441

   442

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

   443

   444

/** Clear the configuration applied by the application.

   445

 */

   446

void ec_master_clear_config(

   447

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

   448

        )

   449

{

   450

    down(&master->master_sem);

   451

    ec_master_clear_domains(master);

   452

    ec_master_clear_slave_configs(master);

   453

    up(&master->master_sem);

   454

}

   455

   456

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

   457

   458

/** Internal sending callback.

   459

 */

   460

void ec_master_internal_send_cb(

   461

        void *cb_data /**< Callback data. */

   462

        )

   463

{

   464

    ec_master_t *master = (ec_master_t *) cb_data;

   465

    down(&master->io_sem);

   466

    ecrt_master_send_ext(master);

   467

    up(&master->io_sem);

   468

}

   469

   470

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

   471

   472

/** Internal receiving callback.

   473

 */

   474

void ec_master_internal_receive_cb(

   475

        void *cb_data /**< Callback data. */

   476

        )

   477

{

   478

    ec_master_t *master = (ec_master_t *) cb_data;

   479

    down(&master->io_sem);

   480

    ecrt_master_receive(master);

   481

    up(&master->io_sem);

   482