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 finite state machines.

    37

*/

    38

    39

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

    40

    41

#include "globals.h"

    42

#include "fsm.h"

    43

#include "master.h"

    44

#include "mailbox.h"

    45

    46

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

    47

    48

void ec_fsm_master_start(ec_fsm_t *);

    49

void ec_fsm_master_broadcast(ec_fsm_t *);

    50

void ec_fsm_master_read_states(ec_fsm_t *);

    51

void ec_fsm_master_acknowledge(ec_fsm_t *);

    52

void ec_fsm_master_validate_vendor(ec_fsm_t *);

    53

void ec_fsm_master_validate_product(ec_fsm_t *);

    54

void ec_fsm_master_rewrite_addresses(ec_fsm_t *);

    55

void ec_fsm_master_configure_slave(ec_fsm_t *);

    56

void ec_fsm_master_scan_slaves(ec_fsm_t *);

    57

void ec_fsm_master_write_eeprom(ec_fsm_t *);

    58

void ec_fsm_master_sdodict(ec_fsm_t *);

    59

void ec_fsm_master_sdo_request(ec_fsm_t *);

    60

void ec_fsm_master_end(ec_fsm_t *);

    61

void ec_fsm_master_error(ec_fsm_t *);

    62

    63

void ec_fsm_slavescan_start(ec_fsm_t *);

    64

void ec_fsm_slavescan_address(ec_fsm_t *);

    65

void ec_fsm_slavescan_state(ec_fsm_t *);

    66

void ec_fsm_slavescan_base(ec_fsm_t *);

    67

void ec_fsm_slavescan_datalink(ec_fsm_t *);

    68

void ec_fsm_slavescan_eeprom_size(ec_fsm_t *);

    69

void ec_fsm_slavescan_eeprom_data(ec_fsm_t *);

    70

    71

void ec_fsm_slaveconf_state_start(ec_fsm_t *);

    72

void ec_fsm_slaveconf_state_init(ec_fsm_t *);

    73

void ec_fsm_slaveconf_state_clear_fmmus(ec_fsm_t *);

    74

void ec_fsm_slaveconf_state_sync(ec_fsm_t *);

    75

void ec_fsm_slaveconf_state_preop(ec_fsm_t *);

    76

void ec_fsm_slaveconf_state_sync2(ec_fsm_t *);

    77

void ec_fsm_slaveconf_state_fmmu(ec_fsm_t *);

    78

void ec_fsm_slaveconf_state_sdoconf(ec_fsm_t *);

    79

void ec_fsm_slaveconf_state_saveop(ec_fsm_t *);

    80

void ec_fsm_slaveconf_state_op(ec_fsm_t *);

    81

    82

void ec_fsm_slaveconf_enter_sync(ec_fsm_t *);

    83

void ec_fsm_slaveconf_enter_preop(ec_fsm_t *);

    84

void ec_fsm_slaveconf_enter_sync2(ec_fsm_t *);

    85

void ec_fsm_slaveconf_enter_fmmu(ec_fsm_t *);

    86

void ec_fsm_slaveconf_enter_sdoconf(ec_fsm_t *);

    87

void ec_fsm_slaveconf_enter_saveop(ec_fsm_t *);

    88

    89

void ec_fsm_slave_state_end(ec_fsm_t *);

    90

void ec_fsm_slave_state_error(ec_fsm_t *);

    91

    92

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

    93

    94

/**

    95

   Constructor.

    96

*/

    97

    98

int ec_fsm_init(ec_fsm_t *fsm, /**< finite state machine */

    99

                ec_master_t *master /**< EtherCAT master */

   100

                )

   101

{

   102

    fsm->master = master;

   103

    fsm->master_state = ec_fsm_master_start;

   104

    fsm->master_slaves_responding = 0;

   105

    fsm->master_slave_states = EC_SLAVE_STATE_UNKNOWN;

   106

    fsm->master_validation = 0;

   107

   108

    ec_datagram_init(&fsm->datagram);

   109

    if (ec_datagram_prealloc(&fsm->datagram, EC_MAX_DATA_SIZE)) {

   110

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

   111

        return -1;

   112

    }

   113

   114

    // init sub-state-machines

   115

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

   116

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

   117

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

   118

   119

    return 0;

   120

}

   121

   122

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

   123

   124

/**

   125

   Destructor.

   126

*/

   127

   128

void ec_fsm_clear(ec_fsm_t *fsm /**< finite state machine */)

   129

{

   130

    // clear sub-state machines

   131

    ec_fsm_sii_clear(&fsm->fsm_sii);

   132

    ec_fsm_change_clear(&fsm->fsm_change);

   133

    ec_fsm_coe_clear(&fsm->fsm_coe);

   134

   135

    ec_datagram_clear(&fsm->datagram);

   136

}

   137

   138

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

   139

   140

/**

   141

   Executes the current state of the state machine.

   142

   \return false, if state machine has terminated

   143

*/

   144

   145

int ec_fsm_exec(ec_fsm_t *fsm /**< finite state machine */)

   146

{

   147

    fsm->master_state(fsm);

   148

   149

    return ec_fsm_running(fsm);

   150

}

   151

   152

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

   153

   154

/**

   155

   \return false, if state machine has terminated

   156

*/

   157

   158

int ec_fsm_running(ec_fsm_t *fsm /**< finite state machine */)

   159

{

   160

    return fsm->master_state != ec_fsm_master_end

   161

        && fsm->master_state != ec_fsm_master_error;

   162

}

   163

   164

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

   165

   166

/**

   167

   \return true, if the master state machine terminated gracefully

   168

*/

   169

   170

int ec_fsm_success(ec_fsm_t *fsm /**< finite state machine */)

   171

{

   172

    return fsm->master_state == ec_fsm_master_end;

   173

}

   174

   175

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

   176

 *  operation/idle state machine

   177

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

   178

   179

/**

   180

   Master state: START.

   181

   Starts with getting slave count and slave states.

   182

*/

   183

   184

void ec_fsm_master_start(ec_fsm_t *fsm)

   185

{

   186

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

   187

    ec_master_queue_datagram(fsm->master, &fsm->datagram);

   188

    fsm->master_state = ec_fsm_master_broadcast;

   189

}

   190

   191

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

   192

   193

/**

   194

   Master state: BROADCAST.

   195

   Processes the broadcast read slave count and slaves states.

   196

*/

   197

   198

void ec_fsm_master_broadcast(ec_fsm_t *fsm /**< finite state machine */)

   199

{

   200

    ec_datagram_t *datagram = &fsm->datagram;

   201

    unsigned int topology_change, states_change, i;

   202

    ec_slave_t *slave;

   203

    ec_master_t *master = fsm->master;

   204

   205

    if (datagram->state != EC_DATAGRAM_RECEIVED) {

   206

        if (!master->device->link_state) {

   207

            fsm->master_slaves_responding = 0;

   208

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

   209

                slave->online = 0;

   210

            }

   211

        }

   212

        else {

   213

            EC_ERR("Failed to receive broadcast datagram.\n");

   214

        }

   215

        fsm->master_state = ec_fsm_master_error;

   216

        return;

   217

    }

   218

   219

    topology_change = (datagram->working_counter !=

   220

                       fsm->master_slaves_responding);

   221

    states_change = (EC_READ_U8(datagram->data) != fsm->master_slave_states);

   222

   223

    fsm->master_slave_states = EC_READ_U8(datagram->data);

   224

    fsm->master_slaves_responding = datagram->working_counter;

   225

   226

    if (topology_change) {

   227

        EC_INFO("%i slave%s responding.\n",

   228

                fsm->master_slaves_responding,

   229

                fsm->master_slaves_responding == 1 ? "" : "s");

   230

   231

        if (master->mode == EC_MASTER_MODE_OPERATION) {

   232

            if (fsm->master_slaves_responding == master->slave_count) {

   233

                fsm->master_validation = 1; // start validation later

   234

            }

   235

            else {

   236

                EC_WARN("Invalid slave count. Bus in tainted state.\n");

   237

            }

   238

        }

   239

    }

   240

   241

    if (states_change) {

   242

        char states[EC_STATE_STRING_SIZE];

   243

        ec_state_string(fsm->master_slave_states, states);

   244

        EC_INFO("Slave states: %s.\n", states);

   245

    }

   246

   247

    // topology change in idle mode: clear all slaves and scan the bus

   248

    if (topology_change && master->mode == EC_MASTER_MODE_IDLE) {

   249

   250

        ec_master_eoe_stop(master);

   251

        ec_master_destroy_slaves(master);

   252

   253

        master->slave_count = datagram->working_counter;

   254

   255

        if (!master->slave_count) {

   256

            // no slaves present -> finish state machine.

   257

            fsm->master_state = ec_fsm_master_end;

   258

            return;

   259

        }

   260

   261

        // init slaves

   262

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

   263

            if (!(slave = (ec_slave_t *) kmalloc(sizeof(ec_slave_t),

   264

                                                 GFP_ATOMIC))) {

   265

                EC_ERR("Failed to allocate slave %i!\n", i);

   266

                ec_master_destroy_slaves(master);

   267

                fsm->master_state = ec_fsm_master_error;

   268

                return;

   269

            }

   270

   271

            if (ec_slave_init(slave, master, i, i + 1)) {

   272

                // freeing of "slave" already done

   273

                ec_master_destroy_slaves(master);

   274

                fsm->master_state = ec_fsm_master_error;

   275

                return;

   276

            }

   277

   278

            list_add_tail(&slave->list, &master->slaves);

   279

        }

   280

   281

        EC_INFO("Scanning bus.\n");

   282

   283

        // begin scanning of slaves

   284

        fsm->slave = list_entry(master->slaves.next, ec_slave_t, list);

   285

        fsm->slave_state = ec_fsm_slavescan_start;

   286

        fsm->master_state = ec_fsm_master_scan_slaves;

   287

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

   288

        return;

   289

    }

   290

   291

    // fetch state from each slave

   292

    fsm->slave = list_entry(master->slaves.next, ec_slave_t, list);

   293

    ec_datagram_nprd(&fsm->datagram, fsm->slave->station_address, 0x0130, 2);

   294

    ec_master_queue_datagram(master, &fsm->datagram);

   295

    fsm->master_state = ec_fsm_master_read_states;

   296

}

   297

   298

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

   299

   300

/**

   301

   Master action: PROC_STATES.

   302

   Processes the slave states.

   303

*/

   304

   305

void ec_fsm_master_action_process_states(ec_fsm_t *fsm

   306

                                         /**< finite state machine */

   307

                                         )

   308

{

   309

    ec_master_t *master = fsm->master;

   310

    ec_slave_t *slave;

   311

    char old_state[EC_STATE_STRING_SIZE], new_state[EC_STATE_STRING_SIZE];

   312

   313

    // check if any slaves are not in the state, they're supposed to be

   314

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

   315

        if (slave->error_flag

   316

            || !slave->online

   317

            || slave->requested_state == EC_SLAVE_STATE_UNKNOWN

   318

            || (slave->current_state == slave->requested_state

   319

                && slave->configured)) continue;

   320

   321

        if (master->debug_level) {

   322

            ec_state_string(slave->current_state, old_state);

   323

            if (slave->current_state != slave->requested_state) {

   324

                ec_state_string(slave->requested_state, new_state);

   325

                EC_DBG("Changing state of slave %i (%s -> %s).\n",

   326

                       slave->ring_position, old_state, new_state);

   327

            }

   328

            else if (!slave->configured) {

   329

                EC_DBG("Reconfiguring slave %i (%s).\n",

   330

                       slave->ring_position, old_state);

   331

            }

   332

        }

   333

   334

        fsm->master_state = ec_fsm_master_configure_slave;

   335

        fsm->slave = slave;

   336

        fsm->slave_state = ec_fsm_slaveconf_state_start;

   337

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

   338

        return;

   339

    }

   340

   341

    // Check, if EoE processing has to be started

   342

    ec_master_eoe_start(master);

   343

   344

    if (master->mode == EC_MASTER_MODE_IDLE) {

   345

   346

        // Check for a pending SDO request

   347

        if (master->sdo_seq_master != master->sdo_seq_user) {

   348

            if (master->debug_level)

   349

                EC_DBG("Processing SDO request...\n");

   350

            slave = master->sdo_request->sdo->slave;

   351

            if (slave->current_state == EC_SLAVE_STATE_INIT

   352

                || !slave->online) {

   353

                EC_ERR("Failed to process SDO request, slave %i not ready.\n",

   354

                       slave->ring_position);

   355

                master->sdo_request->return_code = -1;

   356

                master->sdo_seq_master++;

   357

            }

   358

            else {

   359

                // start uploading SDO

   360

                fsm->slave = slave;

   361

                fsm->master_state = ec_fsm_master_sdo_request;

   362

                fsm->sdo_request = master->sdo_request;

   363

                ec_fsm_coe_upload(&fsm->fsm_coe, slave, fsm->sdo_request);

   364

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

   365

                return;

   366

            }

   367

        }

   368

   369

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

   370

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

   371

            if (!(slave->sii_mailbox_protocols & EC_MBOX_COE)

   372

                || slave->sdo_dictionary_fetched

   373

                || slave->current_state == EC_SLAVE_STATE_INIT

   374

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

   375

                || !slave->online

   376

                || slave->error_flag) continue;

   377

   378

            if (master->debug_level) {

   379

                EC_DBG("Fetching SDO dictionary from slave %i.\n",

   380

                       slave->ring_position);

   381

            }

   382

   383

            slave->sdo_dictionary_fetched = 1;

   384

   385

            // start fetching SDO dictionary

   386

            fsm->slave = slave;

   387

            fsm->master_state = ec_fsm_master_sdodict;

   388

            ec_fsm_coe_dictionary(&fsm->fsm_coe, slave);

   389

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

   390

            return;

   391

        }

   392

   393

        // check for pending EEPROM write operations.

   394

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

   395

            if (!slave->new_eeprom_data) continue;

   396

   397

            if (!slave->online || slave->error_flag) {

   398

                kfree(slave->new_eeprom_data);

   399

                slave->new_eeprom_data = NULL;

   400

                EC_ERR("Discarding EEPROM data, slave %i not ready.\n",

   401

                       slave->ring_position);

   402

                continue;

   403

            }

   404

   405

            // found pending EEPROM write operation. execute it!

   406

            EC_INFO("Writing EEPROM of slave %i...\n", slave->ring_position);

   407

            fsm->slave = slave;

   408

            fsm->sii_offset = 0x0000;

   409

            ec_fsm_sii_write(&fsm->fsm_sii, slave, fsm->sii_offset,

   410

                             slave->new_eeprom_data, EC_FSM_SII_NODE);

   411

            fsm->master_state = ec_fsm_master_write_eeprom;

   412

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

   413

            return;

   414

        }

   415

    }

   416

   417

    fsm->master_state = ec_fsm_master_end;

   418

}

   419

   420

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

   421

   422

/**

   423

   Master action: Get state of next slave.

   424

*/

   425

   426

void ec_fsm_master_action_next_slave_state(ec_fsm_t *fsm

   427

                                           /**< finite state machine */)

   428

{

   429

    ec_master_t *master = fsm->master;

   430

    ec_slave_t *slave = fsm->slave;

   431

   432

    // is there another slave to query?

   433

    if (slave->list.next != &master->slaves) {

   434

        // process next slave

   435

        fsm->slave = list_entry(fsm->slave->list.next, ec_slave_t, list);

   436

        ec_datagram_nprd(&fsm->datagram, fsm->slave->station_address,

   437

                         0x0130, 2);

   438

        ec_master_queue_datagram(master, &fsm->datagram);

   439

        fsm->master_state = ec_fsm_master_read_states;

   440

        return;

   441

    }

   442

   443

    // all slave states read

   444

   445

    // check, if a bus validation has to be done

   446

    if (fsm->master_validation) {

   447

        fsm->master_validation = 0;

   448

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

   449

            if (slave->online) continue;

   450

   451

            // At least one slave is offline. validate!

   452

            EC_INFO("Validating bus.\n");

   453

            fsm->slave = list_entry(master->slaves.next, ec_slave_t, list);

   454

            fsm->master_state = ec_fsm_master_validate_vendor;

   455

            ec_fsm_sii_read(&fsm->fsm_sii, slave, 0x0008, EC_FSM_SII_POSITION);

   456

            ec_fsm_sii_exec(&fsm->fsm_sii); // execute immediately

   457

            return;

   458

        }

   459

    }

   460

   461

    ec_fsm_master_action_process_states(fsm);

   462

}

   463

   464

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

   465

   466

/**

   467

   Master state: READ STATES.

   468

   Fetches the AL- and online state of a slave.

   469

*/

   470

   471

void ec_fsm_master_read_states(ec_fsm_t *fsm /**< finite state machine */)

   472

{

   473

    ec_slave_t *slave = fsm->slave;

   474

    ec_datagram_t *datagram = &fsm->datagram;

   475

    uint8_t new_state;

   476

   477

    if (datagram->state != EC_DATAGRAM_RECEIVED) {

   478

        EC_ERR("Failed to receive AL state datagram for slave %i!\n",

   479

               slave->ring_position);

   480

        fsm->master_state = ec_fsm_master_error;

   481

        return;

   482

    }

   483

   484

    // did the slave not respond to its station address?

   485

    if (datagram->working_counter != 1) {

   486

        if (slave->online) {

   487

            slave->online = 0;

   488

            if (slave->master->debug_level)

   489

                EC_DBG("Slave %i: offline.\n", slave->ring_position);

   490

        }

   491

        ec_fsm_master_action_next_slave_state(fsm);