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 state machine.

    32

 */

    33

    34

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

    35

    36

#include "globals.h"

    37

#include "master.h"

    38

#include "mailbox.h"

    39

#include "slave_config.h"

    40

#ifdef EC_EOE

    41

#include "ethernet.h"

    42

#endif

    43

    44

#include "fsm_master.h"

    45

#include "fsm_foe.h"

    46

    47

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

    48

    49

/** Time difference [ns] to tolerate without setting a new system time offset.

    50

 */

    51

#define EC_SYSTEM_TIME_TOLERANCE_NS 100000000

    52

    53

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

    54

    55

void ec_fsm_master_state_start(ec_fsm_master_t *);

    56

void ec_fsm_master_state_broadcast(ec_fsm_master_t *);

    57

void ec_fsm_master_state_read_state(ec_fsm_master_t *);

    58

void ec_fsm_master_state_acknowledge(ec_fsm_master_t *);

    59

void ec_fsm_master_state_configure_slave(ec_fsm_master_t *);

    60

void ec_fsm_master_state_clear_addresses(ec_fsm_master_t *);

    61

void ec_fsm_master_state_dc_measure_delays(ec_fsm_master_t *);

    62

void ec_fsm_master_state_scan_slave(ec_fsm_master_t *);

    63

void ec_fsm_master_state_dc_read_offset(ec_fsm_master_t *);

    64

void ec_fsm_master_state_dc_write_offset(ec_fsm_master_t *);

    65

void ec_fsm_master_state_write_sii(ec_fsm_master_t *);

    66

void ec_fsm_master_state_sdo_dictionary(ec_fsm_master_t *);

    67

void ec_fsm_master_state_sdo_request(ec_fsm_master_t *);

    68

void ec_fsm_master_state_reg_request(ec_fsm_master_t *);

    69

    70

void ec_fsm_master_enter_write_system_times(ec_fsm_master_t *);

    71

    72

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

    73

    74

/** Constructor.

    75

 */

    76

void ec_fsm_master_init(

    77

        ec_fsm_master_t *fsm, /**< Master state machine. */

    78

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

    79

        ec_datagram_t *datagram /**< Datagram object to use. */

    80

        )

    81

{

    82

    fsm->master = master;

    83

    fsm->datagram = datagram;

    84

    fsm->state = ec_fsm_master_state_start;

    85

    fsm->idle = 0;

    86

    fsm->link_state = 0;

    87

    fsm->slaves_responding = 0;

    88

    fsm->topology_change_pending = 0;

    89

    fsm->slave_states = EC_SLAVE_STATE_UNKNOWN;

    90

    91

    // init sub-state-machines

    92

    ec_fsm_coe_init(&fsm->fsm_coe, fsm->datagram);

    93

    ec_fsm_pdo_init(&fsm->fsm_pdo, &fsm->fsm_coe);

    94

    ec_fsm_change_init(&fsm->fsm_change, fsm->datagram);

    95

    ec_fsm_slave_config_init(&fsm->fsm_slave_config, fsm->datagram,

    96

            &fsm->fsm_change, &fsm->fsm_coe, &fsm->fsm_pdo);

    97

    ec_fsm_slave_scan_init(&fsm->fsm_slave_scan, fsm->datagram,

    98

            &fsm->fsm_slave_config, &fsm->fsm_pdo);

    99

    ec_fsm_sii_init(&fsm->fsm_sii, fsm->datagram);

   100

}

   101

   102

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

   103

   104

/** Destructor.

   105

 */

   106

void ec_fsm_master_clear(

   107

        ec_fsm_master_t *fsm /**< Master state machine. */

   108

        )

   109

{

   110

    // clear sub-state machines

   111

    ec_fsm_coe_clear(&fsm->fsm_coe);

   112

    ec_fsm_pdo_clear(&fsm->fsm_pdo);

   113

    ec_fsm_change_clear(&fsm->fsm_change);

   114

    ec_fsm_slave_config_clear(&fsm->fsm_slave_config);

   115

    ec_fsm_slave_scan_clear(&fsm->fsm_slave_scan);

   116

    ec_fsm_sii_clear(&fsm->fsm_sii);

   117

}

   118

   119

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

   120

   121

/** Executes the current state of the state machine.

   122

 *

   123

 * If the state machine's datagram is not sent or received yet, the execution

   124

 * of the state machine is delayed to the next cycle.

   125

 *

   126

 * \return true, if the state machine was executed

   127

 */

   128

int ec_fsm_master_exec(

   129

        ec_fsm_master_t *fsm /**< Master state machine. */

   130

        )

   131

{

   132

    if (fsm->datagram->state == EC_DATAGRAM_SENT

   133

        || fsm->datagram->state == EC_DATAGRAM_QUEUED) {

   134

        // datagram was not sent or received yet.

   135

        return 0;

   136

    }

   137

   138

    fsm->state(fsm);

   139

    return 1;

   140

}

   141

   142

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

   143

   144

/**

   145

 * \return true, if the state machine is in an idle phase

   146

 */

   147

int ec_fsm_master_idle(

   148

        const ec_fsm_master_t *fsm /**< Master state machine. */

   149

        )

   150

{

   151

    return fsm->idle;

   152

}

   153

   154

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

   155

   156

/** Restarts the master state machine.

   157

 */

   158

void ec_fsm_master_restart(

   159

        ec_fsm_master_t *fsm /**< Master state machine. */

   160

        )

   161

{

   162

    fsm->state = ec_fsm_master_state_start;

   163

    fsm->state(fsm); // execute immediately

   164

}

   165

   166

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

   167

 * Master state machine

   168

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

   169

   170

/** Master state: START.

   171

 *

   172

 * Starts with getting slave count and slave states.

   173

 */

   174

void ec_fsm_master_state_start(

   175

        ec_fsm_master_t *fsm /**< Master state machine. */

   176

        )

   177

{

   178

    fsm->idle = 1;

   179

    ec_datagram_brd(fsm->datagram, 0x0130, 2);

   180

    ec_datagram_zero(fsm->datagram);

   181

    fsm->state = ec_fsm_master_state_broadcast;

   182

}

   183

   184

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

   185

   186

/** Master state: BROADCAST.

   187

 *

   188

 * Processes the broadcast read slave count and slaves states.

   189

 */

   190

void ec_fsm_master_state_broadcast(

   191

        ec_fsm_master_t *fsm /**< Master state machine. */

   192

        )

   193

{

   194

    ec_datagram_t *datagram = fsm->datagram;

   195

    unsigned int i, size;

   196

    ec_slave_t *slave;

   197

    ec_master_t *master = fsm->master;

   198

   199

    if (datagram->state == EC_DATAGRAM_TIMED_OUT)

   200

        return; // always retry

   201

   202

    // bus topology change?

   203

    if (datagram->working_counter != fsm->slaves_responding) {

   204

        fsm->topology_change_pending = 1;

   205

        fsm->slaves_responding = datagram->working_counter;

   206

        EC_MASTER_INFO(master, "%u slave(s) responding.\n",

   207

                fsm->slaves_responding);

   208

    }

   209

   210

    if (fsm->link_state && !master->main_device.link_state) { // link went down

   211

        EC_MASTER_DBG(master, 1, "Master state machine detected "

   212

                "link down. Clearing slave list.\n");

   213

   214

#ifdef EC_EOE

   215

        ec_master_eoe_stop(master);

   216

        ec_master_clear_eoe_handlers(master);

   217

#endif

   218

        ec_master_clear_slaves(master);

   219

        fsm->slave_states = 0x00;

   220

    }

   221

    fsm->link_state = master->main_device.link_state;

   222

   223

    if (datagram->state != EC_DATAGRAM_RECEIVED) {

   224

        ec_fsm_master_restart(fsm);

   225

        return;

   226

    }

   227

   228

    if (fsm->slaves_responding) {

   229

        uint8_t states = EC_READ_U8(datagram->data);

   230

        if (states != fsm->slave_states) { // slave states changed?

   231

            char state_str[EC_STATE_STRING_SIZE];

   232

            fsm->slave_states = states;

   233

            ec_state_string(fsm->slave_states, state_str, 1);

   234

            EC_MASTER_INFO(master, "Slave states: %s.\n", state_str);

   235

        }

   236

    } else {

   237

        fsm->slave_states = 0x00;

   238

    }

   239

   240

    if (fsm->topology_change_pending) {

   241

        down(&master->scan_sem);

   242

        if (!master->allow_scan) {

   243

            up(&master->scan_sem);

   244

        } else {

   245

            master->scan_busy = 1;

   246

            up(&master->scan_sem);

   247

   248

            // topology change when scan is allowed:

   249

            // clear all slaves and scan the bus

   250

            fsm->topology_change_pending = 0;

   251

            fsm->idle = 0;

   252

            fsm->scan_jiffies = jiffies;

   253

   254

#ifdef EC_EOE

   255

            ec_master_eoe_stop(master);

   256

            ec_master_clear_eoe_handlers(master);

   257

#endif

   258

            ec_master_clear_slaves(master);

   259

   260

            master->slave_count = fsm->slaves_responding;

   261

   262

            if (!master->slave_count) {

   263

                // no slaves present -> finish state machine.

   264

                master->scan_busy = 0;

   265

                wake_up_interruptible(&master->scan_queue);

   266

                ec_fsm_master_restart(fsm);

   267

                return;

   268

            }

   269

   270

            size = sizeof(ec_slave_t) * master->slave_count;

   271

            if (!(master->slaves = (ec_slave_t *) kmalloc(size, GFP_KERNEL))) {

   272

                EC_MASTER_ERR(master, "Failed to allocate %u bytes"

   273

                        " of slave memory!\n", size);

   274

                master->slave_count = 0; // TODO avoid retrying scan!

   275

                master->scan_busy = 0;

   276

                wake_up_interruptible(&master->scan_queue);

   277

                ec_fsm_master_restart(fsm);

   278

                return;

   279

            }

   280

   281

            // init slaves

   282

            for (i = 0; i < master->slave_count; i++) {

   283

                slave = master->slaves + i;

   284

                ec_slave_init(slave, master, i, i + 1);

   285

   286

                // do not force reconfiguration in operation phase to avoid

   287

                // unnecesssary process data interruptions

   288

                if (master->phase != EC_OPERATION)

   289

                    slave->force_config = 1;

   290

            }

   291

   292

            // broadcast clear all station addresses

   293

            ec_datagram_bwr(datagram, 0x0010, 2);

   294

            EC_WRITE_U16(datagram->data, 0x0000);

   295

            fsm->retries = EC_FSM_RETRIES;

   296

            fsm->state = ec_fsm_master_state_clear_addresses;

   297

            return;

   298

        }

   299

    }

   300

   301

    if (master->slave_count) {

   302

   303

        // application applied configurations

   304

        if (master->config_changed) {

   305

            master->config_changed = 0;

   306

   307

            EC_MASTER_DBG(master, 1, "Configuration changed.\n");

   308

   309

            fsm->slave = master->slaves; // begin with first slave

   310

            ec_fsm_master_enter_write_system_times(fsm);

   311

   312

        } else {

   313

            // fetch state from first slave

   314

            fsm->slave = master->slaves;

   315

            ec_datagram_fprd(fsm->datagram, fsm->slave->station_address,

   316

                    0x0130, 2);

   317

            ec_datagram_zero(datagram);

   318

            fsm->retries = EC_FSM_RETRIES;

   319

            fsm->state = ec_fsm_master_state_read_state;

   320

        }

   321

    } else {

   322

        ec_fsm_master_restart(fsm);

   323

    }

   324

}

   325

   326

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

   327

   328

/** Check for pending SII write requests and process one.

   329

 *

   330

 * \return non-zero, if an SII write request is processed.

   331

 */

   332

int ec_fsm_master_action_process_sii(

   333

        ec_fsm_master_t *fsm /**< Master state machine. */

   334

        )

   335

{

   336

    ec_master_t *master = fsm->master;

   337

    ec_sii_write_request_t *request;

   338

   339

    // search the first request to be processed

   340

    while (1) {

   341

        if (list_empty(&master->sii_requests))

   342

            break;

   343

   344

        // get first request

   345

        request = list_entry(master->sii_requests.next,

   346

                ec_sii_write_request_t, list);

   347

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

   348

        request->state = EC_INT_REQUEST_BUSY;

   349

   350

        // found pending SII write operation. execute it!

   351

        EC_SLAVE_DBG(request->slave, 1, "Writing SII data...\n");

   352

        fsm->sii_request = request;

   353

        fsm->sii_index = 0;

   354

        ec_fsm_sii_write(&fsm->fsm_sii, request->slave, request->offset,

   355

                request->words, EC_FSM_SII_USE_CONFIGURED_ADDRESS);

   356

        fsm->state = ec_fsm_master_state_write_sii;

   357

        fsm->state(fsm); // execute immediately

   358

        return 1;

   359

    }

   360

   361

    return 0;

   362

}

   363

   364

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

   365

   366

/** Check for pending register requests and process one.

   367

 *

   368

 * \return non-zero, if a register request is processed.

   369

 */

   370

int ec_fsm_master_action_process_register(

   371

        ec_fsm_master_t *fsm /**< Master state machine. */

   372

        )

   373

{

   374

    ec_master_t *master = fsm->master;

   375

    ec_reg_request_t *request;

   376

   377

    // search the first request to be processed

   378

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

   379

   380

        // get first request

   381

        request = list_entry(master->reg_requests.next,

   382

                ec_reg_request_t, list);

   383

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

   384

        request->state = EC_INT_REQUEST_BUSY;

   385

   386

        // found pending request; process it!

   387

        EC_SLAVE_DBG(request->slave, 1, "Processing register request, "

   388

                "offset 0x%04x, length %zu...\n",

   389

                request->offset, request->length);

   390

   391

        if (request->length > fsm->datagram->mem_size) {

   392

            EC_MASTER_ERR(master, "Request length (%zu) exceeds maximum "

   393

                    "datagram size (%zu)!\n", request->length,

   394

                    fsm->datagram->mem_size);

   395

            request->state = EC_INT_REQUEST_FAILURE;

   396

            wake_up(&master->reg_queue);

   397

            continue;

   398

        }

   399

   400

        fsm->reg_request = request;

   401

   402

        if (request->dir == EC_DIR_INPUT) {

   403

            ec_datagram_fprd(fsm->datagram, request->slave->station_address,

   404

                    request->offset, request->length);

   405

            ec_datagram_zero(fsm->datagram);

   406

        } else {

   407

            ec_datagram_fpwr(fsm->datagram, request->slave->station_address,

   408

                    request->offset, request->length);

   409

            memcpy(fsm->datagram->data, request->data, request->length);

   410

        }

   411

        fsm->retries = EC_FSM_RETRIES;

   412

        fsm->state = ec_fsm_master_state_reg_request;

   413

        return 1;

   414

    }

   415

   416

    return 0;

   417

}

   418

   419

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

   420

   421

/** Check for pending SDO requests and process one.

   422

 *

   423

 * \return non-zero, if an SDO request is processed.

   424

 */

   425

int ec_fsm_master_action_process_sdo(

   426

        ec_fsm_master_t *fsm /**< Master state machine. */

   427

        )

   428

{

   429

    ec_master_t *master = fsm->master;

   430

    ec_slave_t *slave;

   431

    ec_sdo_request_t *req;

   432

   433

    // search for internal requests to be processed

   434

    for (slave = master->slaves;

   435

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

   436

            slave++) {

   437

        if (!slave->config)

   438

            continue;

   439

        list_for_each_entry(req, &slave->config->sdo_requests, list) {

   440

            if (req->state == EC_INT_REQUEST_QUEUED) {

   441

   442

                if (ec_sdo_request_timed_out(req)) {

   443

                    req->state = EC_INT_REQUEST_FAILURE;

   444

                    EC_SLAVE_DBG(slave, 1, "Internal SDO request"

   445

                            " timed out.\n");

   446

                    continue;

   447

                }

   448

   449

                if (slave->current_state == EC_SLAVE_STATE_INIT) {

   450

                    req->state = EC_INT_REQUEST_FAILURE;

   451

                    continue;

   452

                }

   453

   454

                req->state = EC_INT_REQUEST_BUSY;

   455

                EC_SLAVE_DBG(slave, 1, "Processing internal"

   456

                        " SDO request...\n");

   457

                fsm->idle = 0;

   458

                fsm->sdo_request = req;

   459

                fsm->slave = slave;

   460

                fsm->state = ec_fsm_master_state_sdo_request;

   461

                ec_fsm_coe_transfer(&fsm->fsm_coe, slave, req);

   462

                ec_fsm_coe_exec(&fsm->fsm_coe); // execute immediately

   463

                return 1;

   464

            }

   465

        }

   466

    }

   467

    return 0;

   468

}

   469

   470

   471

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

   472

   473

/** Master action: IDLE.

   474

 *

   475

 * Does secondary work.

   476

 */

   477

void ec_fsm_master_action_idle(

   478

        ec_fsm_master_t *fsm /**< Master state machine. */

   479

        )

   480

{

   481

    ec_master_t *master = fsm->master;

   482

    ec_slave_t *slave;

   483

   484

    // Check for pending internal SDO requests

   485