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->rescan_required = 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->rescan_required = 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) {

   211

        // link went down

   212

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

   213

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

   214

   215

#ifdef EC_EOE

   216

        ec_master_eoe_stop(master);

   217

        ec_master_clear_eoe_handlers(master);

   218

#endif

   219

        ec_master_clear_slaves(master);

   220

        fsm->slave_states = 0x00;

   221

        fsm->slaves_responding = 0; /* reset to trigger rescan on next link

   222

                                       up. */

   223

    }

   224

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

   225

   226

    if (datagram->state != EC_DATAGRAM_RECEIVED) {

   227

        ec_fsm_master_restart(fsm);

   228

        return;

   229

    }

   230

   231

    if (fsm->slaves_responding) {

   232

        uint8_t states = EC_READ_U8(datagram->data);

   233

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

   234

            char state_str[EC_STATE_STRING_SIZE];

   235

            fsm->slave_states = states;

   236

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

   237

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

   238

        }

   239

    } else {

   240

        fsm->slave_states = 0x00;

   241

    }

   242

   243

    if (fsm->rescan_required) {

   244

        down(&master->scan_sem);

   245

        if (!master->allow_scan) {

   246

            up(&master->scan_sem);

   247

        } else {

   248

            master->scan_busy = 1;

   249

            up(&master->scan_sem);

   250

   251

            // clear all slaves and scan the bus

   252

            fsm->rescan_required = 0;

   253

            fsm->idle = 0;

   254

            fsm->scan_jiffies = jiffies;

   255

   256

#ifdef EC_EOE

   257

            ec_master_eoe_stop(master);

   258

            ec_master_clear_eoe_handlers(master);

   259

#endif

   260

            ec_master_clear_slaves(master);

   261

   262

            master->slave_count = fsm->slaves_responding;

   263

   264

            if (!master->slave_count) {

   265

                // no slaves present -> finish state machine.

   266

                master->scan_busy = 0;

   267

                wake_up_interruptible(&master->scan_queue);

   268

                ec_fsm_master_restart(fsm);

   269

                return;

   270

            }

   271

   272

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

   273

            if (!(master->slaves =

   274

                        (ec_slave_t *) kmalloc(size, GFP_KERNEL))) {

   275

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

   276

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

   277

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

   278

                master->scan_busy = 0;

   279

                wake_up_interruptible(&master->scan_queue);

   280

                ec_fsm_master_restart(fsm);

   281

                return;

   282

            }

   283

   284

            // init slaves

   285

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

   286

                slave = master->slaves + i;

   287

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

   288

   289

                // do not force reconfiguration in operation phase to avoid

   290

                // unnecesssary process data interruptions

   291

                if (master->phase != EC_OPERATION)

   292

                    slave->force_config = 1;

   293

            }

   294

   295

            // broadcast clear all station addresses

   296

            ec_datagram_bwr(datagram, 0x0010, 2);

   297

            EC_WRITE_U16(datagram->data, 0x0000);

   298

            fsm->retries = EC_FSM_RETRIES;

   299

            fsm->state = ec_fsm_master_state_clear_addresses;

   300

            return;

   301

        }

   302

    }

   303

   304

    if (master->slave_count) {

   305

   306

        // application applied configurations

   307

        if (master->config_changed) {

   308

            master->config_changed = 0;

   309

   310

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

   311

   312

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

   313

            ec_fsm_master_enter_write_system_times(fsm);

   314

   315

        } else {

   316

            // fetch state from first slave

   317

            fsm->slave = master->slaves;

   318

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

   319

                    0x0130, 2);

   320

            ec_datagram_zero(datagram);

   321

            fsm->retries = EC_FSM_RETRIES;

   322

            fsm->state = ec_fsm_master_state_read_state;

   323

        }

   324

    } else {

   325

        ec_fsm_master_restart(fsm);

   326

    }

   327

}

   328

   329

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

   330

   331

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

   332

 *

   333

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

   334

 */

   335

int ec_fsm_master_action_process_sii(

   336

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

   337

        )

   338

{

   339

    ec_master_t *master = fsm->master;

   340

    ec_sii_write_request_t *request;

   341

   342

    // search the first request to be processed

   343

    while (1) {

   344

        if (list_empty(&master->sii_requests))

   345

            break;

   346

   347

        // get first request

   348

        request = list_entry(master->sii_requests.next,

   349

                ec_sii_write_request_t, list);

   350

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

   351

        request->state = EC_INT_REQUEST_BUSY;

   352

   353

        // found pending SII write operation. execute it!

   354

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

   355

        fsm->sii_request = request;

   356

        fsm->sii_index = 0;

   357

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

   358

                request->words, EC_FSM_SII_USE_CONFIGURED_ADDRESS);

   359

        fsm->state = ec_fsm_master_state_write_sii;

   360

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

   361

        return 1;

   362

    }

   363

   364

    return 0;

   365

}

   366

   367

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

   368

   369

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

   370

 *

   371

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

   372

 */

   373

int ec_fsm_master_action_process_register(

   374

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

   375

        )

   376

{

   377

    ec_master_t *master = fsm->master;

   378

    ec_reg_request_t *request;

   379

   380

    // search the first request to be processed

   381

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

   382

   383

        // get first request

   384

        request = list_entry(master->reg_requests.next,

   385

                ec_reg_request_t, list);

   386

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

   387

        request->state = EC_INT_REQUEST_BUSY;

   388

   389

        // found pending request; process it!

   390

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

   391

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

   392

                request->offset, request->length);

   393

   394

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

   395

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

   396

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

   397

                    fsm->datagram->mem_size);

   398

            request->state = EC_INT_REQUEST_FAILURE;

   399

            wake_up(&master->reg_queue);

   400

            continue;

   401

        }

   402

   403

        fsm->reg_request = request;

   404

   405

        if (request->dir == EC_DIR_INPUT) {

   406

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

   407

                    request->offset, request->length);

   408

            ec_datagram_zero(fsm->datagram);

   409

        } else {

   410

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

   411

                    request->offset, request->length);

   412

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

   413

        }

   414

        fsm->retries = EC_FSM_RETRIES;

   415

        fsm->state = ec_fsm_master_state_reg_request;

   416

        return 1;

   417

    }

   418

   419

    return 0;

   420

}

   421

   422

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

   423

   424

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

   425

 *

   426

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

   427

 */

   428

int ec_fsm_master_action_process_sdo(

   429

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

   430

        )

   431

{

   432

    ec_master_t *master = fsm->master;

   433

    ec_slave_t *slave;

   434

    ec_sdo_request_t *req;

   435

   436

    // search for internal requests to be processed

   437

    for (slave = master->slaves;

   438

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

   439

            slave++) {

   440

        if (!slave->config)

   441

            continue;

   442

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

   443

            if (req->state == EC_INT_REQUEST_QUEUED) {

   444

   445

                if (ec_sdo_request_timed_out(req)) {

   446

                    req->state = EC_INT_REQUEST_FAILURE;

   447

                    EC_SLAVE_DBG(slave, 1, "Internal SDO request"

   448

                            " timed out.\n");

   449

                    continue;

   450

                }

   451

   452

                if (slave->current_state == EC_SLAVE_STATE_INIT) {

   453

                    req->state = EC_INT_REQUEST_FAILURE;

   454

                    continue;

   455

                }

   456

   457

                req->state = EC_INT_REQUEST_BUSY;

   458

                EC_SLAVE_DBG(slave, 1, "Processing internal"

   459

                        " SDO request...\n");

   460

                fsm->idle = 0;

   461

                fsm->sdo_request = req;

   462

                fsm->slave = slave;

   463

                fsm->state = ec_fsm_master_state_sdo_request;

   464

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

   465

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

   466

                return 1;

   467

            }

   468

        }

   469

    }

   470

    return 0;

   471

}

   472

   473

   474

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

   475

   476

/** Master action: IDLE.

   477

 *

   478

 * Does secondary work.

   479

 */

   480

void ec_fsm_master_action_idle(

   481

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

   482

        )

   483

{

   484

    ec_master_t *master = fsm->master;