1

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

     2

 *

     3

 *  $Id: fsm_master.c,v afb40fd6018e 2011/09/16 12:10:23 fp $

     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

#ifdef EC_HAVE_CYCLES

    52

#define EC_SYSTEM_TIME_TOLERANCE_NS 10000

    53

#else

    54

#define EC_SYSTEM_TIME_TOLERANCE_NS 100000000

    55

#endif

    56

    57

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

    58

    59

void ec_fsm_master_state_start(ec_fsm_master_t *);

    60

void ec_fsm_master_state_broadcast(ec_fsm_master_t *);

    61

void ec_fsm_master_state_read_state(ec_fsm_master_t *);

    62

void ec_fsm_master_state_acknowledge(ec_fsm_master_t *);

    63

void ec_fsm_master_state_configure_slave(ec_fsm_master_t *);

    64

void ec_fsm_master_state_clear_addresses(ec_fsm_master_t *);

    65

void ec_fsm_master_state_dc_measure_delays(ec_fsm_master_t *);

    66

void ec_fsm_master_state_scan_slave(ec_fsm_master_t *);

    67

void ec_fsm_master_state_dc_read_offset(ec_fsm_master_t *);

    68

void ec_fsm_master_state_dc_write_offset(ec_fsm_master_t *);

    69

void ec_fsm_master_state_write_sii(ec_fsm_master_t *);

    70

void ec_fsm_master_state_sdo_dictionary(ec_fsm_master_t *);

    71

void ec_fsm_master_state_sdo_request(ec_fsm_master_t *);

    72

void ec_fsm_master_state_reg_request(ec_fsm_master_t *);

    73

    74

void ec_fsm_master_enter_write_system_times(ec_fsm_master_t *);

    75

    76

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

    77

    78

/** Constructor.

    79

 */

    80

void ec_fsm_master_init(

    81

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

    82

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

    83

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

    84

        )

    85

{

    86

    fsm->master = master;

    87

    fsm->datagram = datagram;

    88

    fsm->mbox = &master->fsm_mbox;

    89

    fsm->state = ec_fsm_master_state_start;

    90

    fsm->idle = 0;

    91

    fsm->link_state = 0;

    92

    fsm->slaves_responding = 0;

    93

    fsm->rescan_required = 0;

    94

    fsm->slave_states = EC_SLAVE_STATE_UNKNOWN;

    95

    96

    // init sub-state-machines

    97

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

    98

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

    99

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

   100

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

   101

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

   102

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

   103

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

   104

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

   105

}

   106

   107

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

   108

   109

/** Destructor.

   110

 */

   111

void ec_fsm_master_clear(

   112

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

   113

        )

   114

{

   115

    // clear sub-state machines

   116

    ec_fsm_coe_clear(&fsm->fsm_coe);

   117

    ec_fsm_pdo_clear(&fsm->fsm_pdo);

   118

    ec_fsm_change_clear(&fsm->fsm_change);

   119

    ec_fsm_slave_config_clear(&fsm->fsm_slave_config);

   120

    ec_fsm_slave_scan_clear(&fsm->fsm_slave_scan);

   121

    ec_fsm_sii_clear(&fsm->fsm_sii);

   122

}

   123

   124

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

   125

   126

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

   127

 *

   128

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

   129

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

   130

 *

   131

 * \return true, if the state machine was executed

   132

 */

   133

int ec_fsm_master_exec(

   134

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

   135

        )

   136

{

   137

    if (ec_mbox_is_datagram_state(fsm->mbox, EC_DATAGRAM_QUEUED)

   138

        || ec_mbox_is_datagram_state(fsm->mbox, EC_DATAGRAM_SENT)) {

   139

        // datagram was not sent or received yet.

   140

        return 0;

   141

    }

   142

   143

    fsm->state(fsm);

   144

    return 1;

   145

}

   146

   147

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

   148

   149

/**

   150

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

   151

 */

   152

int ec_fsm_master_idle(

   153

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

   154

        )

   155

{

   156

    return fsm->idle;

   157

}

   158

   159

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

   160

   161

/** Restarts the master state machine.

   162

 */

   163

void ec_fsm_master_restart(

   164

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

   165

        )

   166

{

   167

    fsm->state = ec_fsm_master_state_start;

   168

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

   169

}

   170

   171

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

   172

 * Master state machine

   173

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

   174

   175

/** Master state: START.

   176

 *

   177

 * Starts with getting slave count and slave states.

   178

 */

   179

void ec_fsm_master_state_start(

   180

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

   181

        )

   182

{

   183

    fsm->idle = 1;

   184

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

   185

    ec_datagram_zero(fsm->datagram);

   186

    fsm->state = ec_fsm_master_state_broadcast;

   187

}

   188

   189

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

   190

   191

/** Master state: BROADCAST.

   192

 *

   193

 * Processes the broadcast read slave count and slaves states.

   194

 */

   195

void ec_fsm_master_state_broadcast(

   196

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

   197

        )

   198

{

   199

    ec_datagram_t *datagram = fsm->datagram;

   200

    unsigned int i, size;

   201

    ec_slave_t *slave;

   202

    ec_master_t *master = fsm->master;

   203

   204

    if (datagram->state == EC_DATAGRAM_TIMED_OUT)

   205

        return; // always retry

   206

   207

    // bus topology change?

   208

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

   209

        fsm->rescan_required = 1;

   210

        fsm->slaves_responding = datagram->working_counter;

   211

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

   212

                fsm->slaves_responding);

   213

    }

   214

   215

    if (fsm->link_state && !master->main_device.link_state) {

   216

        // link went down

   217

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

   218

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

   219

   220

        ec_master_clear_slaves(master);

   221

        fsm->slave_states = 0x00;

   222

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

   223

                                       up. */

   224

    }

   225

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

   226

   227

    if (datagram->state != EC_DATAGRAM_RECEIVED) {

   228

        ec_fsm_master_restart(fsm);

   229

        return;

   230

    }

   231

   232

    if (fsm->slaves_responding) {

   233

        uint8_t states = EC_READ_U8(datagram->data);

   234

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

   235

            char state_str[EC_STATE_STRING_SIZE];

   236

            fsm->slave_states = states;

   237

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

   238

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

   239

        }

   240

    } else {

   241

        fsm->slave_states = 0x00;

   242

    }

   243

   244

    if (fsm->rescan_required) {

   245

        ec_mutex_lock(&master->scan_mutex);

   246

        if (!master->allow_scan) {

   247

            ec_mutex_unlock(&master->scan_mutex);

   248

        } else {

   249

            master->scan_busy = 1;

   250

            ec_mutex_unlock(&master->scan_mutex);

   251

   252

            // clear all slaves and scan the bus

   253

            fsm->rescan_required = 0;

   254

            fsm->idle = 0;

   255

            fsm->scan_jiffies = jiffies;

   256

   257

#ifdef EC_EOE

   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

            kref_put(&request->refcount, ec_master_reg_request_release);

   400

            wake_up(&master->reg_queue);

   401

            continue;

   402

        }

   403

   404

        fsm->reg_request = request;

   405

   406

        if (request->dir == EC_DIR_INPUT) {

   407

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

   408

                    request->offset, request->length);

   409

            ec_datagram_zero(fsm->datagram);

   410

        } else {

   411

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

   412

                    request->offset, request->length);

   413

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

   414

        }

   415

        fsm->retries = EC_FSM_RETRIES;

   416

        fsm->state = ec_fsm_master_state_reg_request;

   417

        return 1;

   418

    }

   419

   420

    return 0;

   421

}

   422

   423

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

   424

   425

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

   426

 *

   427

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

   428

 */

   429

int ec_fsm_master_action_process_sdo(

   430

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

   431

        )

   432

{

   433

    ec_master_t *master = fsm->master;

   434

    ec_slave_t *slave;

   435

    ec_sdo_request_t *req;

   436

   437

    // search for internal requests to be processed

   438

    for (slave = master->slaves;

   439

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

   440

            slave++) {

   441

        if (!slave->config)

   442

            continue;

   443

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

   444

            if (req->state == EC_INT_REQUEST_QUEUED) {

   445

   446

                if (ec_sdo_request_timed_out(req)) {

   447

                    req->state = EC_INT_REQUEST_FAILURE;

   448

                    EC_SLAVE_DBG(slave, 1, "Internal SDO request"

   449

                            " timed out.\n");

   450

                    continue;

   451

                }

   452

   453

                if (slave->current_state == EC_SLAVE_STATE_INIT) {

   454

                    req->state = EC_INT_REQUEST_FAILURE;

   455

                    continue;

   456

                }

   457

   458

                req->state = EC_INT_REQUEST_BUSY;

   459

                EC_SLAVE_DBG(slave, 1, "Processing internal"

   460

                        " SDO request...\n");

   461

                fsm->idle = 0;

   462

                fsm->sdo_request = req;

   463

                fsm->slave = slave;

   464

                fsm->state = ec_fsm_master_state_sdo_request;

   465

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

   466

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

   467

                return 1;

   468

            }

   469

        }

   470

    }

   471

    return 0;

   472

}

   473

   474

   475

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

   476

   477

/** Master action: IDLE.

   478

 *

   479

 * Does secondary work.

   480

 */

   481

void ec_fsm_master_action_idle(

   482

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

   483

        )