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

void ec_fsm_master_state_start(ec_fsm_master_t *);

    50

void ec_fsm_master_state_broadcast(ec_fsm_master_t *);

    51

void ec_fsm_master_state_read_state(ec_fsm_master_t *);

    52

void ec_fsm_master_state_acknowledge(ec_fsm_master_t *);

    53

void ec_fsm_master_state_configure_slave(ec_fsm_master_t *);

    54

void ec_fsm_master_state_clear_addresses(ec_fsm_master_t *);

    55

void ec_fsm_master_state_dc_measure_delays(ec_fsm_master_t *);

    56

void ec_fsm_master_state_scan_slave(ec_fsm_master_t *);

    57

void ec_fsm_master_state_write_sii(ec_fsm_master_t *);

    58

void ec_fsm_master_state_sdo_dictionary(ec_fsm_master_t *);

    59

void ec_fsm_master_state_sdo_request(ec_fsm_master_t *);

    60

void ec_fsm_master_state_reg_request(ec_fsm_master_t *);

    61

    62

    63

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

    64

    65

/** Constructor.

    66

 */

    67

void ec_fsm_master_init(

    68

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

    69

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

    70

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

    71

        )

    72

{

    73

    fsm->master = master;

    74

    fsm->datagram = datagram;

    75

    fsm->state = ec_fsm_master_state_start;

    76

    fsm->idle = 0;

    77

    fsm->link_state = 0;

    78

    fsm->slaves_responding = 0;

    79

    fsm->topology_change_pending = 0;

    80

    fsm->slave_states = EC_SLAVE_STATE_UNKNOWN;

    81

    82

    // init sub-state-machines

    83

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

    84

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

    85

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

    86

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

    87

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

    88

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

    89

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

    90

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

    91

}

    92

    93

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

    94

    95

/** Destructor.

    96

 */

    97

void ec_fsm_master_clear(

    98

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

    99

        )

   100

{

   101

    // clear sub-state machines

   102

    ec_fsm_coe_clear(&fsm->fsm_coe);

   103

    ec_fsm_pdo_clear(&fsm->fsm_pdo);

   104

    ec_fsm_change_clear(&fsm->fsm_change);

   105

    ec_fsm_slave_config_clear(&fsm->fsm_slave_config);

   106

    ec_fsm_slave_scan_clear(&fsm->fsm_slave_scan);

   107

    ec_fsm_sii_clear(&fsm->fsm_sii);

   108

}

   109

   110

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

   111

   112

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

   113

 *

   114

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

   115

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

   116

 *

   117

 * \return true, if the state machine was executed

   118

 */

   119

int ec_fsm_master_exec(

   120

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

   121

        )

   122

{

   123

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

   124

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

   125

        // datagram was not sent or received yet.

   126

        return 0;

   127

    }

   128

   129

    fsm->state(fsm);

   130

    return 1;

   131

}

   132

   133

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

   134

   135

/**

   136

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

   137

 */

   138

int ec_fsm_master_idle(

   139

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

   140

        )

   141

{

   142

    return fsm->idle;

   143

}

   144

   145

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

   146

   147

/** Restarts the master state machine.

   148

 */

   149

void ec_fsm_master_restart(

   150

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

   151

        )

   152

{

   153

    fsm->state = ec_fsm_master_state_start;

   154

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

   155

}

   156

   157

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

   158

 * Master state machine

   159

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

   160

   161

/** Master state: START.

   162

 *

   163

 * Starts with getting slave count and slave states.

   164

 */

   165

void ec_fsm_master_state_start(

   166

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

   167

        )

   168

{

   169

    fsm->idle = 1;

   170

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

   171

    ec_datagram_zero(fsm->datagram);

   172

    fsm->state = ec_fsm_master_state_broadcast;

   173

}

   174

   175

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

   176

   177

/** Master state: BROADCAST.

   178

 *

   179

 * Processes the broadcast read slave count and slaves states.

   180

 */

   181

void ec_fsm_master_state_broadcast(

   182

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

   183

        )

   184

{

   185

    ec_datagram_t *datagram = fsm->datagram;

   186

    unsigned int i, size;

   187

    ec_slave_t *slave;

   188

    ec_master_t *master = fsm->master;

   189

   190

    if (datagram->state == EC_DATAGRAM_TIMED_OUT)

   191

        return; // always retry

   192

   193

    // bus topology change?

   194

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

   195

        fsm->topology_change_pending = 1;

   196

        fsm->slaves_responding = datagram->working_counter;

   197

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

   198

                fsm->slaves_responding);

   199

    }

   200

   201

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

   202

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

   203

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

   204

   205

#ifdef EC_EOE

   206

        ec_master_eoe_stop(master);

   207

        ec_master_clear_eoe_handlers(master);

   208

#endif

   209

        ec_master_clear_slaves(master);

   210

        fsm->slave_states = 0x00;

   211

    }

   212

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

   213

   214

    if (datagram->state != EC_DATAGRAM_RECEIVED) {

   215

        ec_fsm_master_restart(fsm);

   216

        return;

   217

    }

   218

   219

    if (fsm->slaves_responding) {

   220

        uint8_t states = EC_READ_U8(datagram->data);

   221

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

   222

            char state_str[EC_STATE_STRING_SIZE];

   223

            fsm->slave_states = states;

   224

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

   225

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

   226

        }

   227

    } else {

   228

        fsm->slave_states = 0x00;

   229

    }

   230

   231

    if (fsm->topology_change_pending) {

   232

        down(&master->scan_sem);

   233

        if (!master->allow_scan) {

   234

            up(&master->scan_sem);

   235

        } else {

   236

            master->scan_busy = 1;

   237

            up(&master->scan_sem);

   238

   239

            // topology change when scan is allowed:

   240

            // clear all slaves and scan the bus

   241

            fsm->topology_change_pending = 0;

   242

            fsm->idle = 0;

   243

            fsm->scan_jiffies = jiffies;

   244

   245

#ifdef EC_EOE

   246

            ec_master_eoe_stop(master);

   247

            ec_master_clear_eoe_handlers(master);

   248

#endif

   249

            ec_master_clear_slaves(master);

   250

   251

            master->slave_count = fsm->slaves_responding;

   252

   253

            if (!master->slave_count) {

   254

                // no slaves present -> finish state machine.

   255

                master->scan_busy = 0;

   256

                wake_up_interruptible(&master->scan_queue);

   257

                ec_fsm_master_restart(fsm);

   258

                return;

   259

            }

   260

   261

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

   262

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

   263

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

   264

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

   265

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

   266

                master->scan_busy = 0;

   267

                wake_up_interruptible(&master->scan_queue);

   268

                ec_fsm_master_restart(fsm);

   269

                return;

   270

            }

   271

   272

            // init slaves

   273

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

   274

                slave = master->slaves + i;

   275

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

   276

   277

                // do not force reconfiguration in operation phase to avoid

   278

                // unnecesssary process data interruptions

   279

                if (master->phase != EC_OPERATION)

   280

                    slave->force_config = 1;

   281

            }

   282

   283

            // broadcast clear all station addresses

   284

            ec_datagram_bwr(datagram, 0x0010, 2);

   285

            EC_WRITE_U16(datagram->data, 0x0000);

   286

            fsm->retries = EC_FSM_RETRIES;

   287

            fsm->state = ec_fsm_master_state_clear_addresses;

   288

            return;

   289

        }

   290

    }

   291

   292

    if (master->slave_count) {

   293

        // fetch state from first slave

   294

        fsm->slave = master->slaves;

   295

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

   296

                0x0130, 2);

   297

        ec_datagram_zero(datagram);

   298

        fsm->retries = EC_FSM_RETRIES;

   299

        fsm->state = ec_fsm_master_state_read_state;

   300

    } else {

   301

        ec_fsm_master_restart(fsm);

   302

    }

   303

}

   304

   305

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

   306

   307

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

   308

 *

   309

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

   310

 */

   311

int ec_fsm_master_action_process_sii(

   312

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

   313

        )

   314

{

   315

    ec_master_t *master = fsm->master;

   316

    ec_sii_write_request_t *request;

   317

   318

    // search the first request to be processed

   319

    while (1) {

   320

        if (list_empty(&master->sii_requests))

   321

            break;

   322

   323

        // get first request

   324

        request = list_entry(master->sii_requests.next,

   325

                ec_sii_write_request_t, list);

   326

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

   327

        request->state = EC_INT_REQUEST_BUSY;

   328

   329

        // found pending SII write operation. execute it!

   330

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

   331

        fsm->sii_request = request;

   332

        fsm->sii_index = 0;

   333

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

   334

                request->words, EC_FSM_SII_USE_CONFIGURED_ADDRESS);

   335

        fsm->state = ec_fsm_master_state_write_sii;

   336

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

   337

        return 1;

   338

    }

   339

   340

    return 0;

   341

}

   342

   343

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

   344

   345

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

   346

 *

   347

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

   348

 */

   349

int ec_fsm_master_action_process_register(

   350

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

   351

        )

   352

{

   353

    ec_master_t *master = fsm->master;

   354

    ec_reg_request_t *request;

   355

   356

    // search the first request to be processed

   357

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

   358

   359

        // get first request

   360

        request = list_entry(master->reg_requests.next,

   361

                ec_reg_request_t, list);

   362

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

   363

        request->state = EC_INT_REQUEST_BUSY;

   364

   365

        // found pending request; process it!

   366

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

   367

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

   368

                request->offset, request->length);

   369

   370

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

   371

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

   372

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

   373

                    fsm->datagram->mem_size);

   374

            request->state = EC_INT_REQUEST_FAILURE;

   375

            wake_up(&master->reg_queue);

   376

            continue;

   377

        }

   378

   379

        fsm->reg_request = request;

   380

   381

        if (request->dir == EC_DIR_INPUT) {

   382

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

   383

                    request->offset, request->length);

   384

            ec_datagram_zero(fsm->datagram);

   385

        } else {

   386

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

   387

                    request->offset, request->length);

   388

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

   389

        }

   390

        fsm->retries = EC_FSM_RETRIES;

   391

        fsm->state = ec_fsm_master_state_reg_request;

   392

        return 1;

   393

    }

   394

   395

    return 0;

   396

}

   397

   398

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

   399

   400

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

   401

 *

   402

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

   403

 */

   404

int ec_fsm_master_action_process_sdo(

   405

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

   406

        )

   407

{

   408

    ec_master_t *master = fsm->master;

   409

    ec_slave_t *slave;

   410

    ec_sdo_request_t *req;

   411

   412

    // search for internal requests to be processed

   413

    for (slave = master->slaves;

   414

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

   415

            slave++) {

   416

        if (!slave->config)

   417

            continue;

   418

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

   419

            if (req->state == EC_INT_REQUEST_QUEUED) {

   420

   421

                if (ec_sdo_request_timed_out(req)) {

   422

                    req->state = EC_INT_REQUEST_FAILURE;

   423

                    EC_SLAVE_DBG(slave, 1, "Internal SDO request"

   424

                            " timed out.\n");

   425

                    continue;

   426

                }

   427

   428

                if (slave->current_state == EC_SLAVE_STATE_INIT) {

   429

                    req->state = EC_INT_REQUEST_FAILURE;

   430

                    continue;

   431

                }

   432

   433

                req->state = EC_INT_REQUEST_BUSY;

   434

                EC_SLAVE_DBG(slave, 1, "Processing internal"

   435

                        " SDO request...\n");

   436

                fsm->idle = 0;

   437

                fsm->sdo_request = req;

   438

                fsm->slave = slave;

   439

                fsm->state = ec_fsm_master_state_sdo_request;

   440

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

   441

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

   442

                return 1;

   443

            }

   444

        }

   445

    }

   446

    return 0;

   447

}

   448

   449

   450

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

   451

   452

/** Master action: IDLE.

   453

 *

   454

 * Does secondary work.

   455

 */

   456

void ec_fsm_master_action_idle(

   457

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

   458

        )

   459

{

   460

    ec_master_t *master = fsm->master;

   461

    ec_slave_t *slave;

   462

   463

    // Check for pending internal SDO requests

   464

    if (ec_fsm_master_action_process_sdo(fsm))

   465

        return;

   466

   467

    // enable processing of requests

   468

    for (slave = master->slaves;

   469

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

   470

            slave++) {

   471

        ec_fsm_slave_ready(&slave->fsm);

   472

    }

   473

   474

    // check, if slaves have an SDO dictionary to read out.

   475

    for (slave = master->slaves;

   476

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

   477

            slave++) {

   478

        if (!(slave->sii.mailbox_protocols & EC_MBOX_COE)

   479

                || (slave->sii.has_general

   480

                    && !slave->sii.coe_details.enable_sdo_info)

   481

                || slave->sdo_dictionary_fetched

   482

                || slave->current_state == EC_SLAVE_STATE_INIT

   483

                || slave->current_state == EC_SLAVE_STATE_UNKNOWN

   484

                || jiffies - slave->jiffies_preop < EC_WAIT_SDO_DICT * HZ