1

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

     2

 *

     3

 *  $Id$

     4

 *

     5

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

    10

 *  and/or modify it under the terms of the GNU General Public License

    11

 *  as published by the Free Software Foundation; either version 2 of the

    12

 *  License, or (at your option) any later version.

    13

 *

    14

 *  The IgH EtherCAT Master is distributed in the hope that it will be

    15

 *  useful, but WITHOUT ANY WARRANTY; without even the implied warranty of

    16

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    17

 *  GNU General Public License for more details.

    18

 *

    19

 *  You should have received a copy of the GNU General Public License

    20

 *  along with the IgH EtherCAT Master; if not, write to the Free Software

    21

 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

    22

 *

    23

 *  The right to use EtherCAT Technology is granted and comes free of

    24

 *  charge under condition of compatibility of product made by

    25

 *  Licensee. People intending to distribute/sell products based on the

    26

 *  code, have to sign an agreement to guarantee that products using

    27

 *  software based on IgH EtherCAT master stay compatible with the actual

    28

 *  EtherCAT specification (which are released themselves as an open

    29

 *  standard) as the (only) precondition to have the right to use EtherCAT

    30

 *  Technology, IP and trade marks.

    31

 *

    32

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

    33

    34

/**

    35

   \file

    36

   EtherCAT master methods.

    37

*/

    38

    39

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

    40

    41

#include <linux/module.h>

    42

#include <linux/kernel.h>

    43

#include <linux/string.h>

    44

#include <linux/slab.h>

    45

#include <linux/delay.h>

    46

    47

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

    48

#include "globals.h"

    49

#include "slave.h"

    50

#include "slave_config.h"

    51

#include "device.h"

    52

#include "datagram.h"

    53

#ifdef EC_EOE

    54

#include "ethernet.h"

    55

#endif

    56

#include "master.h"

    57

    58

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

    59

    60

void ec_master_destroy_slave_configs(ec_master_t *);

    61

void ec_master_destroy_domains(ec_master_t *);

    62

static int ec_master_idle_thread(ec_master_t *);

    63

static int ec_master_operation_thread(ec_master_t *);

    64

#ifdef EC_EOE

    65

void ec_master_eoe_run(unsigned long);

    66

#endif

    67

ssize_t ec_show_master_attribute(struct kobject *, struct attribute *, char *);

    68

ssize_t ec_store_master_attribute(struct kobject *, struct attribute *,

    69

                                  const char *, size_t);

    70

    71

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

    72

    73

/** \cond */

    74

    75

EC_SYSFS_READ_ATTR(info);

    76

EC_SYSFS_READ_WRITE_ATTR(debug_level);

    77

    78

static struct attribute *ec_def_attrs[] = {

    79

    &attr_info,

    80

    &attr_debug_level,

    81

    NULL,

    82

};

    83

    84

static struct sysfs_ops ec_sysfs_ops = {

    85

    .show = &ec_show_master_attribute,

    86

    .store = ec_store_master_attribute

    87

};

    88

    89

static struct kobj_type ktype_ec_master = {

    90

    .release = NULL,

    91

    .sysfs_ops = &ec_sysfs_ops,

    92

    .default_attrs = ec_def_attrs

    93

};

    94

    95

/** \endcond */

    96

    97

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

    98

    99

/**

   100

   Master constructor.

   101

   \return 0 in case of success, else < 0

   102

*/

   103

   104

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

   105

        struct kobject *module_kobj, /**< kobject of the master module */

   106

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

   107

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

   108

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

   109

        )

   110

{

   111

    unsigned int i;

   112

   113

    master->index = index;

   114

    master->reserved = 0;

   115

   116

    master->main_mac = main_mac;

   117

    master->backup_mac = backup_mac;

   118

    init_MUTEX(&master->device_sem);

   119

   120

    master->mode = EC_MASTER_MODE_ORPHANED;

   121

    master->injection_seq_fsm = 0;

   122

    master->injection_seq_rt = 0;

   123

   124

    INIT_LIST_HEAD(&master->slaves);

   125

    master->slave_count = 0;

   126

   127

    INIT_LIST_HEAD(&master->configs);

   128

   129

    master->scan_busy = 0;

   130

    master->allow_scan = 1;

   131

    init_MUTEX(&master->scan_sem);

   132

    init_waitqueue_head(&master->scan_queue);

   133

   134

    master->config_busy = 0;

   135

    master->allow_config = 1;

   136

    init_MUTEX(&master->config_sem);

   137

    init_waitqueue_head(&master->config_queue);

   138

   139

    INIT_LIST_HEAD(&master->datagram_queue);

   140

    master->datagram_index = 0;

   141

   142

    INIT_LIST_HEAD(&master->domains);

   143

   144

    master->debug_level = 0;

   145

    master->stats.timeouts = 0;

   146

    master->stats.corrupted = 0;

   147

    master->stats.unmatched = 0;

   148

    master->stats.output_jiffies = 0;

   149

    master->frames_timed_out = 0;

   150

   151

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

   152

        master->idle_cycle_times[i] = 0;

   153

#ifdef EC_EOE

   154

        master->eoe_cycle_times[i] = 0;

   155

#endif

   156

    }

   157

    master->idle_cycle_time_pos = 0;

   158

#ifdef EC_EOE

   159

    master->eoe_cycle_time_pos = 0;

   160

   161

    init_timer(&master->eoe_timer);

   162

    master->eoe_timer.function = ec_master_eoe_run;

   163

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

   164

    master->eoe_running = 0;

   165

    INIT_LIST_HEAD(&master->eoe_handlers);

   166

#endif

   167

   168

    master->internal_lock = SPIN_LOCK_UNLOCKED;

   169

    master->request_cb = NULL;

   170

    master->release_cb = NULL;

   171

    master->cb_data = NULL;

   172

   173

    INIT_LIST_HEAD(&master->sii_requests);

   174

    init_MUTEX(&master->sii_sem);

   175

    init_waitqueue_head(&master->sii_queue);

   176

   177

    INIT_LIST_HEAD(&master->slave_sdo_requests);

   178

    init_MUTEX(&master->sdo_sem);

   179

    init_waitqueue_head(&master->sdo_queue);

   180

   181

    // init devices

   182

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

   183

        goto out_return;

   184

   185

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

   186

        goto out_clear_main;

   187

   188

    // init state machine datagram

   189

    ec_datagram_init(&master->fsm_datagram);

   190

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

   191

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

   192

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

   193

        goto out_clear_backup;

   194

    }

   195

   196

    // create state machine object

   197

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

   198

   199

    // init kobject and add it to the hierarchy

   200

    memset(&master->kobj, 0x00, sizeof(struct kobject));

   201

    kobject_init(&master->kobj);

   202

    master->kobj.ktype = &ktype_ec_master;

   203

    master->kobj.parent = module_kobj;

   204

   205

    if (kobject_set_name(&master->kobj, "master%i", index)) {

   206

        EC_ERR("Failed to set master kobject name.\n");

   207

        kobject_put(&master->kobj);

   208

        goto out_clear_fsm;

   209

    }

   210

   211

    if (kobject_add(&master->kobj)) {

   212

        EC_ERR("Failed to add master kobject.\n");

   213

        kobject_put(&master->kobj);

   214

        goto out_clear_fsm;

   215

    }

   216

   217

    return 0;

   218

   219

out_clear_fsm:

   220

    ec_fsm_master_clear(&master->fsm);

   221

out_clear_backup:

   222

    ec_device_clear(&master->backup_device);

   223

out_clear_main:

   224

    ec_device_clear(&master->main_device);

   225

out_return:

   226

    return -1;

   227

}

   228

   229

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

   230

   231

/**

   232

   Clear and free master.

   233

   This method is called by the kobject,

   234

   once there are no more references to it.

   235

*/

   236

   237

void ec_master_clear(

   238

        ec_master_t *master /**< EtherCAT master */

   239

        )

   240

{

   241

#ifdef EC_EOE

   242

    ec_master_clear_eoe_handlers(master);

   243

#endif

   244

    ec_master_destroy_slave_configs(master);

   245

    ec_master_destroy_slaves(master);

   246

    ec_master_destroy_domains(master);

   247

    ec_fsm_master_clear(&master->fsm);

   248

    ec_datagram_clear(&master->fsm_datagram);

   249

    ec_device_clear(&master->backup_device);

   250

    ec_device_clear(&master->main_device);

   251

   252

    // destroy self

   253

    kobject_del(&master->kobj);

   254

    kobject_put(&master->kobj);

   255

}

   256

   257

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

   258

   259

#ifdef EC_EOE

   260

/** Clear and free all EoE handlers.

   261

 */

   262

void ec_master_clear_eoe_handlers(

   263

        ec_master_t *master /**< EtherCAT master */

   264

        )

   265

{

   266

    ec_eoe_t *eoe, *next;

   267

   268

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

   269

        list_del(&eoe->list);

   270

        ec_eoe_clear(eoe);

   271

        kfree(eoe);

   272

    }

   273

}

   274

#endif

   275

   276

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

   277

   278

/** Destroy all slave configurations.

   279

 */

   280

void ec_master_destroy_slave_configs(ec_master_t *master)

   281

{

   282

    ec_slave_config_t *sc, *next;

   283

   284

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

   285

        list_del(&sc->list);

   286

        ec_slave_config_destroy(sc);

   287

    }

   288

}

   289

   290

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

   291

   292

/** Destroy all slaves.

   293

 */

   294

void ec_master_destroy_slaves(ec_master_t *master)

   295

{

   296

    ec_slave_t *slave, *next;

   297

   298

    list_for_each_entry_safe(slave, next, &master->slaves, list) {

   299

        list_del(&slave->list);

   300

        ec_slave_destroy(slave);

   301

    }

   302

   303

    master->slave_count = 0;

   304

}

   305

   306

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

   307

   308

/**

   309

   Destroy all domains.

   310

*/

   311

   312

void ec_master_destroy_domains(ec_master_t *master)

   313

{

   314

    ec_domain_t *domain, *next;

   315

   316

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

   317

        list_del(&domain->list);

   318

        ec_domain_destroy(domain);

   319

    }

   320

}

   321

   322

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

   323

   324

/**

   325

   Internal locking callback.

   326

*/

   327

   328

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

   329

{

   330

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

   331

    return 0;

   332

}

   333

   334

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

   335

   336

/**

   337

   Internal unlocking callback.

   338

*/

   339

   340

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

   341

{

   342

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

   343

}

   344

   345

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

   346

   347

/**

   348

 * Starts the master thread.

   349

 */

   350

   351

int ec_master_thread_start(

   352

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

   353

        int (*thread_func)(ec_master_t *) /**< thread function to start */

   354

        )

   355

{

   356

    init_completion(&master->thread_exit);

   357

   358

    EC_INFO("Starting master thread.\n");

   359

    if (!(master->thread_id = kernel_thread((int (*)(void *)) thread_func,

   360

                    master, CLONE_KERNEL)))

   361

        return -1;

   362

   363

    return 0;

   364

}

   365

   366

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

   367

   368

/**

   369

 * Stops the master thread.

   370

 */

   371

   372

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

   373

{

   374

    if (!master->thread_id) {

   375

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

   376

        return;

   377

    }

   378

   379

    kill_proc(master->thread_id, SIGTERM, 1);

   380

    wait_for_completion(&master->thread_exit);

   381

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

   382

   383

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

   384

   385

    // wait for FSM datagram

   386

    while (get_cycles() - master->fsm_datagram.cycles_sent

   387

            < (cycles_t) EC_IO_TIMEOUT /* us */ * (cpu_khz / 1000))

   388

        schedule();

   389

}

   390

   391

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

   392

   393

/**

   394

 * Transition function from ORPHANED to IDLE mode.

   395

 */

   396

   397

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

   398

{

   399

    master->request_cb = ec_master_request_cb;

   400

    master->release_cb = ec_master_release_cb;

   401

    master->cb_data = master;

   402

   403

    master->mode = EC_MASTER_MODE_IDLE;

   404

    if (ec_master_thread_start(master, ec_master_idle_thread)) {

   405

        master->mode = EC_MASTER_MODE_ORPHANED;

   406

        return -1;

   407

    }

   408

   409

    return 0;

   410

}

   411

   412

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

   413

   414

/**

   415

 * Transition function from IDLE to ORPHANED mode.

   416

 */

   417

   418

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

   419

{

   420

    master->mode = EC_MASTER_MODE_ORPHANED;

   421

   422

#ifdef EC_EOE

   423

    ec_master_eoe_stop(master);

   424

#endif

   425

    ec_master_thread_stop(master);

   426

    ec_master_destroy_slaves(master);

   427

}

   428

   429

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

   430

   431

/**

   432

 * Transition function from IDLE to OPERATION mode.

   433

 */

   434

   435

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

   436

{

   437

    ec_slave_t *slave;

   438

#ifdef EC_EOE

   439

    ec_eoe_t *eoe;

   440

#endif

   441

   442

    down(&master->config_sem);

   443

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

   444

    if (master->config_busy) {

   445

        up(&master->config_sem);

   446

   447

        // wait for slave configuration to complete

   448

        if (wait_event_interruptible(master->config_queue,

   449

                    !master->config_busy)) {

   450

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

   451

            goto out_allow;

   452

        }

   453

   454

        if (master->debug_level)

   455

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

   456

    } else {

   457

        up(&master->config_sem);

   458

    }

   459

   460

    down(&master->scan_sem);

   461

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

   462

    if (!master->scan_busy) {

   463

        up(&master->scan_sem);

   464

    } else {

   465

        up(&master->scan_sem);

   466

   467

        // wait for slave scan to complete

   468

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

   469

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

   470

            goto out_allow;

   471

        }

   472

   473

        if (master->debug_level)

   474

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

   475

    }

   476

   477

    // set states for all slaves

   478

    list_for_each_entry(slave, &master->slaves, list) {

   479

        ec_slave_request_state(slave, EC_SLAVE_STATE_PREOP);

   480

    }

   481

#ifdef EC_EOE

   482

    // ... but set EoE slaves to OP

   483

    list_for_each_entry(eoe, &master->eoe_handlers, list) {

   484

        if (ec_eoe_is_open(eoe))