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

 *  Using the EtherCAT technology and brand is permitted in compliance with

    23

 *  the industrial property and similar rights of Beckhoff Automation GmbH.

    24

 *

    25

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

    26

    27

/**

    28

   \file

    29

   EtherCAT master methods.

    30

*/

    31

    32

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

    33

    34

#include <linux/module.h>

    35

#include <linux/kernel.h>

    36

#include <linux/string.h>

    37

#include <linux/slab.h>

    38

#include <linux/delay.h>

    39

#include <linux/device.h>

    40

#include <linux/version.h>

    41

    42

#include "../include/ecrt.h"

    43

#include "globals.h"

    44

#include "slave.h"

    45

#include "slave_config.h"

    46

#include "device.h"

    47

#include "datagram.h"

    48

#ifdef EC_EOE

    49

#include "ethernet.h"

    50

#endif

    51

#include "master.h"

    52

    53

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

    54

    55

#ifdef EC_HAVE_CYCLES

    56

    57

/** Frame timeout in cycles.

    58

 */

    59

static cycles_t timeout_cycles;

    60

    61

#else

    62

    63

/** Frame timeout in jiffies.

    64

 */

    65

static unsigned long timeout_jiffies;

    66

    67

#endif

    68

    69

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

    70

    71

void ec_master_clear_slave_configs(ec_master_t *);

    72

void ec_master_clear_domains(ec_master_t *);

    73

static int ec_master_idle_thread(void *);

    74

static int ec_master_operation_thread(void *);

    75

#ifdef EC_EOE

    76

void ec_master_eoe_run(unsigned long);

    77

#endif

    78

    79

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

    80

    81

/** Static variables initializer.

    82

*/

    83

void ec_master_init_static(void)

    84

{

    85

#ifdef EC_HAVE_CYCLES

    86

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

    87

#else

    88

    // one jiffy may always elapse between time measurement

    89

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

    90

#endif

    91

}

    92

    93

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

    94

    95

/**

    96

   Master constructor.

    97

   \return 0 in case of success, else < 0

    98

*/

    99

   100

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

   101

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

   102

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

   103

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

   104

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

   105

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

   106

        )

   107

{

   108

    master->index = index;

   109

    master->reserved = 0;

   110

   111

    init_MUTEX(&master->master_sem);

   112

   113

    master->main_mac = main_mac;

   114

    master->backup_mac = backup_mac;

   115

    init_MUTEX(&master->device_sem);

   116

   117

    master->phase = EC_ORPHANED;

   118

    master->injection_seq_fsm = 0;

   119

    master->injection_seq_rt = 0;

   120

   121

    master->slaves = NULL;

   122

    master->slave_count = 0;

   123

   124

    INIT_LIST_HEAD(&master->configs);

   125

   126

    master->scan_busy = 0;

   127

    master->allow_scan = 1;

   128

    init_MUTEX(&master->scan_sem);

   129

    init_waitqueue_head(&master->scan_queue);

   130

   131

    master->config_busy = 0;

   132

    master->allow_config = 1;

   133

    init_MUTEX(&master->config_sem);

   134

    init_waitqueue_head(&master->config_queue);

   135

   136

    INIT_LIST_HEAD(&master->datagram_queue);

   137

    master->datagram_index = 0;

   138

   139

    INIT_LIST_HEAD(&master->domains);

   140

   141

    master->debug_level = 0;

   142

    master->stats.timeouts = 0;

   143

    master->stats.corrupted = 0;

   144

    master->stats.unmatched = 0;

   145

    master->stats.output_jiffies = 0;

   146

    master->frames_timed_out = 0;

   147

   148

    master->thread = NULL;

   149

   150

#ifdef EC_EOE

   151

    init_timer(&master->eoe_timer);

   152

    master->eoe_timer.function = ec_master_eoe_run;

   153

    master->eoe_timer.data = (unsigned long) master;

   154

    master->eoe_running = 0;

   155

    INIT_LIST_HEAD(&master->eoe_handlers);

   156

#endif

   157

   158

    master->internal_lock = SPIN_LOCK_UNLOCKED;

   159

    master->request_cb = NULL;

   160

    master->release_cb = NULL;

   161

    master->cb_data = NULL;

   162

   163

    INIT_LIST_HEAD(&master->sii_requests);

   164

    init_waitqueue_head(&master->sii_queue);

   165

   166

    INIT_LIST_HEAD(&master->slave_sdo_requests);

   167

    init_waitqueue_head(&master->sdo_queue);

   168

   169

    INIT_LIST_HEAD(&master->foe_requests);

   170

    init_waitqueue_head(&master->foe_queue);

   171

   172

    // init devices

   173

    if (ec_device_init(&master->main_device, master))

   174

        goto out_return;

   175

   176

    if (ec_device_init(&master->backup_device, master))

   177

        goto out_clear_main;

   178

   179

    // init state machine datagram

   180

    ec_datagram_init(&master->fsm_datagram);

   181

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

   182

    if (ec_datagram_prealloc(&master->fsm_datagram, EC_MAX_DATA_SIZE)) {

   183

        EC_ERR("Failed to allocate FSM datagram.\n");

   184

        goto out_clear_backup;

   185

    }

   186

   187

    // create state machine object

   188

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

   189

   190

    // init character device

   191

    if (ec_cdev_init(&master->cdev, master, device_number))

   192

        goto out_clear_fsm;

   193

   194

#if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 15)

   195

    master->class_device = class_device_create(class,

   196

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

   197

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

   198

#else

   199

    master->class_device = class_device_create(class, NULL,

   200

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

   201

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

   202

#endif

   203

    if (IS_ERR(master->class_device)) {

   204

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

   205

        goto out_clear_cdev;

   206

    }

   207

   208

    return 0;

   209

   210

out_clear_cdev:

   211

    ec_cdev_clear(&master->cdev);

   212

out_clear_fsm:

   213

    ec_fsm_master_clear(&master->fsm);

   214

    ec_datagram_clear(&master->fsm_datagram);

   215

out_clear_backup:

   216

    ec_device_clear(&master->backup_device);

   217

out_clear_main:

   218

    ec_device_clear(&master->main_device);

   219

out_return:

   220

    return -1;

   221

}

   222

   223

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

   224

   225

/** Destructor.

   226

*/

   227

void ec_master_clear(

   228

        ec_master_t *master /**< EtherCAT master */

   229

        )

   230

{

   231

    class_device_unregister(master->class_device);

   232

    ec_cdev_clear(&master->cdev);

   233

#ifdef EC_EOE

   234

    ec_master_clear_eoe_handlers(master);

   235

#endif

   236

    ec_master_clear_domains(master);

   237

    ec_master_clear_slave_configs(master);

   238

    ec_master_clear_slaves(master);

   239

    ec_fsm_master_clear(&master->fsm);

   240

    ec_datagram_clear(&master->fsm_datagram);

   241

    ec_device_clear(&master->backup_device);

   242

    ec_device_clear(&master->main_device);

   243

}

   244

   245

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

   246

   247

#ifdef EC_EOE

   248

/** Clear and free all EoE handlers.

   249

 */

   250

void ec_master_clear_eoe_handlers(

   251

        ec_master_t *master /**< EtherCAT master */

   252

        )

   253

{

   254

    ec_eoe_t *eoe, *next;

   255

   256

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

   257

        list_del(&eoe->list);

   258

        ec_eoe_clear(eoe);

   259

        kfree(eoe);

   260

    }

   261

}

   262

#endif

   263

   264

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

   265

   266

/** Clear all slave configurations.

   267

 */

   268

void ec_master_clear_slave_configs(ec_master_t *master)

   269

{

   270

    ec_slave_config_t *sc, *next;

   271

   272

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

   273

        list_del(&sc->list);

   274

        ec_slave_config_clear(sc);

   275

        kfree(sc);

   276

    }

   277

}

   278

   279

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

   280

   281

/** Clear all slaves.

   282

 */

   283

void ec_master_clear_slaves(ec_master_t *master)

   284

{

   285

    ec_slave_t *slave;

   286

   287

    for (slave = master->slaves;

   288

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

   289

            slave++) {

   290

        ec_slave_clear(slave);

   291

    }

   292

   293

    if (master->slaves) {

   294

        kfree(master->slaves);

   295

        master->slaves = NULL;

   296

    }

   297

   298

    master->slave_count = 0;

   299

}

   300

   301

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

   302

   303

/** Clear all domains.

   304

 */

   305

void ec_master_clear_domains(ec_master_t *master)

   306

{

   307

    ec_domain_t *domain, *next;

   308

   309

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

   310

        list_del(&domain->list);

   311

        ec_domain_clear(domain);

   312

        kfree(domain);

   313

    }

   314

}

   315

   316

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

   317

   318

/** Internal locking callback.

   319

 */

   320

int ec_master_request_cb(void *master /**< callback data */)

   321

{

   322

    spin_lock(&((ec_master_t *) master)->internal_lock);

   323

    return 0;

   324

}

   325

   326

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

   327

   328

/** Internal unlocking callback.

   329

 */

   330

void ec_master_release_cb(void *master /**< callback data */)

   331

{

   332

    spin_unlock(&((ec_master_t *) master)->internal_lock);

   333

}

   334

   335

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

   336

   337

/** Starts the master thread.

   338

 */

   339

int ec_master_thread_start(

   340

        ec_master_t *master, /**< EtherCAT master */

   341

        int (*thread_func)(void *), /**< thread function to start */

   342

        const char *name /**< Thread name. */

   343

        )

   344

{

   345

    EC_INFO("Starting %s thread.\n", name);

   346

    master->thread = kthread_run(thread_func, master, name);

   347

    if (IS_ERR(master->thread)) {

   348

        EC_ERR("Failed to start master thread (error %i)!\n",

   349

                (int) PTR_ERR(master->thread));

   350

        master->thread = NULL;

   351

        return -1;

   352

    }

   353

   354

    return 0;

   355

}

   356

   357

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

   358

   359

/** Stops the master thread.

   360

 */

   361

void ec_master_thread_stop(

   362

        ec_master_t *master /**< EtherCAT master */

   363

        )

   364

{

   365

    unsigned long sleep_jiffies;

   366

   367

    if (!master->thread) {

   368

        EC_WARN("ec_master_thread_stop(): Already finished!\n");

   369

        return;

   370

    }

   371

   372

    if (master->debug_level)

   373

        EC_DBG("Stopping master thread.\n");

   374

   375

    kthread_stop(master->thread);

   376

    master->thread = NULL;

   377

    EC_INFO("Master thread exited.\n");

   378

   379

    if (master->fsm_datagram.state != EC_DATAGRAM_SENT)

   380

        return;

   381

   382

    // wait for FSM datagram

   383

    sleep_jiffies = max(HZ / 100, 1); // 10 ms, at least 1 jiffy

   384

    schedule_timeout(sleep_jiffies);

   385

}

   386

   387

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

   388

   389

/** Transition function from ORPHANED to IDLE phase.

   390

 */

   391

int ec_master_enter_idle_phase(

   392

        ec_master_t *master /**< EtherCAT master */

   393

        )

   394

{

   395

    if (master->debug_level)

   396

        EC_DBG("ORPHANED -> IDLE.\n");

   397

   398

    master->request_cb = ec_master_request_cb;

   399

    master->release_cb = ec_master_release_cb;

   400

    master->cb_data = master;

   401

   402

    master->phase = EC_IDLE;

   403

    if (ec_master_thread_start(master, ec_master_idle_thread,

   404

                "EtherCAT-IDLE")) {

   405

        master->phase = EC_ORPHANED;

   406

        return -1;

   407

    }

   408

   409

    return 0;

   410

}

   411

   412

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

   413

   414

/** Transition function from IDLE to ORPHANED phase.

   415

 */

   416

void ec_master_leave_idle_phase(ec_master_t *master /**< EtherCAT master */)

   417

{

   418

    if (master->debug_level)

   419

        EC_DBG("IDLE -> ORPHANED.\n");

   420

   421

    master->phase = EC_ORPHANED;

   422

   423

#ifdef EC_EOE

   424

    ec_master_eoe_stop(master);

   425

#endif

   426

    ec_master_thread_stop(master);

   427

   428

    down(&master->master_sem);

   429

    ec_master_clear_slaves(master);

   430

    up(&master->master_sem);

   431

}

   432

   433

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

   434

   435

/** Transition function from IDLE to OPERATION phase.

   436

 */

   437

int ec_master_enter_operation_phase(ec_master_t *master /**< EtherCAT master */)

   438

{

   439

    ec_slave_t *slave;

   440

#ifdef EC_EOE

   441

    ec_eoe_t *eoe;

   442

#endif

   443

   444

    if (master->debug_level)

   445

        EC_DBG("IDLE -> OPERATION.\n");

   446

   447

    down(&master->config_sem);

   448

    master->allow_config = 0; // temporarily disable slave configuration

   449

    if (master->config_busy) {

   450

        up(&master->config_sem);

   451

   452

        // wait for slave configuration to complete

   453

        if (wait_event_interruptible(master->config_queue,

   454

                    !master->config_busy)) {

   455

            EC_INFO("Finishing slave configuration interrupted by signal.\n");

   456

            goto out_allow;

   457

        }

   458

   459

        if (master->debug_level)

   460

            EC_DBG("Waiting for pending slave configuration returned.\n");

   461

    } else {

   462

        up(&master->config_sem);

   463

    }

   464

   465

    down(&master->scan_sem);

   466

    master->allow_scan = 0; // 'lock' the slave list

   467

    if (!master->scan_busy) {

   468

        up(&master->scan_sem);

   469

    } else {

   470

        up(&master->scan_sem);

   471

   472

        // wait for slave scan to complete

   473

        if (wait_event_interruptible(master->scan_queue, !master->scan_busy)) {

   474

            EC_INFO("Waiting for slave scan interrupted by signal.\n");

   475

            goto out_allow;

   476

        }

   477

   478

        if (master->debug_level)

   479

            EC_DBG("Waiting for pending slave scan returned.\n");

   480

    }

   481

   482

    // set states for all slaves

   483

    for (slave = master->slaves;