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_fmmu(ec_fsm_t *);

    77

void ec_fsm_slaveconf_state_sdoconf(ec_fsm_t *);

    78

void ec_fsm_slaveconf_state_saveop(ec_fsm_t *);

    79

void ec_fsm_slaveconf_state_op(ec_fsm_t *);

    80

    81

void ec_fsm_slaveconf_enter_sync(ec_fsm_t *);

    82

void ec_fsm_slaveconf_enter_preop(ec_fsm_t *);

    83

void ec_fsm_slaveconf_enter_sdoconf(ec_fsm_t *);

    84

void ec_fsm_slaveconf_enter_saveop(ec_fsm_t *);

    85

    86

void ec_fsm_slave_state_end(ec_fsm_t *);

    87

void ec_fsm_slave_state_error(ec_fsm_t *);

    88

    89

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

    90

    91

/**

    92

   Constructor.

    93

*/

    94

    95

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

    96

                ec_master_t *master /**< EtherCAT master */

    97

                )

    98

{

    99

    fsm->master = master;

   100

    fsm->master_state = ec_fsm_master_start;

   101

    fsm->master_slaves_responding = 0;

   102

    fsm->master_slave_states = EC_SLAVE_STATE_UNKNOWN;

   103

    fsm->master_validation = 0;

   104

   105

    ec_datagram_init(&fsm->datagram);

   106

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

   107

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

   108

        return -1;

   109

    }

   110

   111

    // init sub-state-machines

   112

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

   113

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

   114

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

   115

   116

    return 0;

   117

}

   118

   119

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

   120

   121

/**

   122

   Destructor.

   123

*/

   124

   125

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

   126

{

   127

    // clear sub-state machines

   128

    ec_fsm_sii_clear(&fsm->fsm_sii);

   129

    ec_fsm_change_clear(&fsm->fsm_change);

   130

    ec_fsm_coe_clear(&fsm->fsm_coe);

   131

   132

    ec_datagram_clear(&fsm->datagram);

   133

}

   134

   135

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

   136

   137

/**

   138

   Executes the current state of the state machine.

   139

   \return false, if state machine has terminated

   140

*/

   141

   142

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

   143

{

   144

    fsm->master_state(fsm);

   145

   146

    return ec_fsm_running(fsm);

   147

}

   148

   149

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

   150

   151

/**

   152

   \return false, if state machine has terminated

   153

*/

   154

   155

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

   156

{

   157

    return fsm->master_state != ec_fsm_master_end

   158

        && fsm->master_state != ec_fsm_master_error;

   159

}

   160

   161

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

   162

   163

/**

   164

   \return true, if the master state machine terminated gracefully

   165

*/

   166

   167

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

   168

{

   169

    return fsm->master_state == ec_fsm_master_end;

   170

}

   171

   172

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

   173

 *  operation/idle state machine

   174

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

   175

   176

/**

   177

   Master state: START.

   178

   Starts with getting slave count and slave states.

   179

*/

   180

   181

void ec_fsm_master_start(ec_fsm_t *fsm)

   182

{

   183

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

   184

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

   185

    fsm->master_state = ec_fsm_master_broadcast;

   186

}

   187

   188

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

   189

   190

/**

   191

   Master state: BROADCAST.

   192

   Processes the broadcast read slave count and slaves states.

   193

*/

   194

   195

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

   196

{

   197

    ec_datagram_t *datagram = &fsm->datagram;

   198

    unsigned int topology_change, states_change, i;

   199

    ec_slave_t *slave;

   200

    ec_master_t *master = fsm->master;

   201

   202

    if (datagram->state != EC_DATAGRAM_RECEIVED) {

   203

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

   204

            fsm->master_slaves_responding = 0;

   205

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

   206

                slave->online = 0;

   207

            }

   208

        }

   209

        else {

   210

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

   211

        }

   212

        fsm->master_state = ec_fsm_master_error;

   213

        return;

   214

    }

   215

   216

    topology_change = (datagram->working_counter !=

   217

                       fsm->master_slaves_responding);

   218

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

   219

   220

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

   221

    fsm->master_slaves_responding = datagram->working_counter;

   222

   223

    if (topology_change) {

   224

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

   225

                fsm->master_slaves_responding,

   226

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

   227

   228

        if (master->mode == EC_MASTER_MODE_OPERATION) {

   229

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

   230

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

   231

            }

   232

            else {

   233

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

   234

            }

   235

        }

   236

    }

   237

   238

    if (states_change) {

   239

        char states[EC_STATE_STRING_SIZE];

   240

        ec_state_string(fsm->master_slave_states, states);

   241

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

   242

    }

   243

   244

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

   245

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

   246

   247

        ec_master_eoe_stop(master);

   248

        ec_master_destroy_slaves(master);

   249

   250

        master->slave_count = datagram->working_counter;

   251

   252

        if (!master->slave_count) {

   253

            // no slaves present -> finish state machine.

   254

            fsm->master_state = ec_fsm_master_end;

   255

            return;

   256

        }

   257

   258

        // init slaves

   259

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

   260

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

   261

                                                 GFP_ATOMIC))) {

   262

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

   263

                ec_master_destroy_slaves(master);

   264

                fsm->master_state = ec_fsm_master_error;

   265

                return;

   266

            }

   267

   268

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

   269

                // freeing of "slave" already done

   270

                ec_master_destroy_slaves(master);

   271

                fsm->master_state = ec_fsm_master_error;

   272

                return;

   273

            }

   274

   275

            if (kobject_add(&slave->kobj)) {

   276

                EC_ERR("Failed to add kobject.\n");

   277

                kobject_put(&slave->kobj); // free

   278

                ec_master_destroy_slaves(master);

   279

                fsm->master_state = ec_fsm_master_error;

   280

                return;

   281

            }

   282

   283

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

   284

        }

   285

   286

        EC_INFO("Scanning bus.\n");

   287

   288

        // begin scanning of slaves

   289

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

   290

        fsm->slave_state = ec_fsm_slavescan_start;

   291

        fsm->master_state = ec_fsm_master_scan_slaves;

   292

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

   293

        return;

   294

    }

   295

   296

    // fetch state from each slave

   297

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

   298

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

   299

    ec_master_queue_datagram(master, &fsm->datagram);

   300

    fsm->master_state = ec_fsm_master_read_states;

   301

}

   302

   303

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

   304

   305

/**

   306

   Master action: PROC_STATES.

   307

   Processes the slave states.

   308

*/

   309

   310

void ec_fsm_master_action_process_states(ec_fsm_t *fsm

   311

                                         /**< finite state machine */

   312

                                         )

   313

{

   314

    ec_master_t *master = fsm->master;

   315

    ec_slave_t *slave;

   316

    char old_state[EC_STATE_STRING_SIZE], new_state[EC_STATE_STRING_SIZE];

   317

   318

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

   319

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

   320

        if (slave->error_flag

   321

            || !slave->online

   322

            || slave->requested_state == EC_SLAVE_STATE_UNKNOWN

   323

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

   324

                && slave->configured)) continue;

   325

   326

        if (master->debug_level) {

   327

            ec_state_string(slave->current_state, old_state);

   328

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

   329

                ec_state_string(slave->requested_state, new_state);

   330

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

   331

                       slave->ring_position, old_state, new_state);

   332

            }

   333

            else if (!slave->configured) {

   334

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

   335

                       slave->ring_position, old_state);

   336

            }

   337

        }

   338

   339

        fsm->master_state = ec_fsm_master_configure_slave;

   340

        fsm->slave = slave;

   341

        fsm->slave_state = ec_fsm_slaveconf_state_start;

   342

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

   343

        return;

   344

    }

   345

   346

    // Check, if EoE processing has to be started

   347

    ec_master_eoe_start(master);

   348

   349

    if (master->mode == EC_MASTER_MODE_IDLE) {

   350

   351

        // Check for a pending SDO request

   352

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

   353

            if (master->debug_level)

   354

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

   355

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

   356

            if (slave->current_state == EC_SLAVE_STATE_INIT

   357

                || !slave->online

   358

                || slave->error_flag) {

   359

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

   360

                       slave->ring_position);

   361

                master->sdo_request->return_code = -1;

   362

                master->sdo_seq_master++;

   363

            }

   364

            else {

   365

                // start uploading SDO

   366

                fsm->slave = slave;

   367

                fsm->master_state = ec_fsm_master_sdo_request;

   368

                fsm->sdo_request = master->sdo_request;

   369

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

   370

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

   371

                return;

   372

            }

   373

        }

   374

   375

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

   376

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

   377

            if (!(slave->sii_mailbox_protocols & EC_MBOX_COE)

   378

                || slave->sdo_dictionary_fetched

   379

                || slave->current_state == EC_SLAVE_STATE_INIT

   380

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

   381

                || !slave->online

   382

                || slave->error_flag) continue;

   383

   384

            if (master->debug_level) {

   385

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

   386

                       slave->ring_position);

   387

            }

   388

   389

            if (kobject_add(&slave->sdo_kobj)) {

   390

                EC_ERR("Failed to add SDO kobj of slave %i.\n",

   391

                       slave->ring_position);

   392

                slave->error_flag = 1;

   393

                fsm->master_state = ec_fsm_master_error;

   394

                return;

   395

            }

   396

   397

            slave->sdo_dictionary_fetched = 1;

   398

   399

            // start fetching SDO dictionary

   400

            fsm->slave = slave;

   401

            fsm->master_state = ec_fsm_master_sdodict;

   402

            ec_fsm_coe_dictionary(&fsm->fsm_coe, slave);

   403

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

   404

            return;

   405

        }

   406

   407

        // check for pending EEPROM write operations.

   408

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

   409

            if (!slave->new_eeprom_data) continue;

   410

   411

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

   412

                kfree(slave->new_eeprom_data);

   413

                slave->new_eeprom_data = NULL;

   414

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

   415

                       slave->ring_position);

   416

                continue;

   417

            }

   418

   419

            // found pending EEPROM write operation. execute it!

   420

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

   421

            fsm->slave = slave;

   422

            fsm->sii_offset = 0x0000;

   423

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

   424

                             slave->new_eeprom_data, EC_FSM_SII_NODE);

   425

            fsm->master_state = ec_fsm_master_write_eeprom;

   426

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

   427

            return;

   428

        }

   429

    }

   430

   431

    fsm->master_state = ec_fsm_master_end;

   432

}

   433

   434

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

   435

   436

/**

   437

   Master action: Get state of next slave.

   438

*/

   439

   440

void ec_fsm_master_action_next_slave_state(ec_fsm_t *fsm

   441

                                           /**< finite state machine */)

   442

{

   443

    ec_master_t *master = fsm->master;

   444

    ec_slave_t *slave = fsm->slave;

   445

   446

    // is there another slave to query?

   447

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

   448

        // process next slave

   449

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

   450

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

   451

                         0x0130, 2);

   452

        ec_master_queue_datagram(master, &fsm->datagram);

   453

        fsm->master_state = ec_fsm_master_read_states;

   454

        return;

   455

    }

   456

   457

    // all slave states read

   458

   459

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

   460

    if (fsm->master_validation) {

   461

        fsm->master_validation = 0;

   462

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

   463

            if (slave->online) continue;

   464

   465

            // At least one slave is offline. validate!

   466

            EC_INFO("Validating bus.\n");

   467

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

   468

            fsm->master_state = ec_fsm_master_validate_vendor;

   469

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

   470

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

   471

            return;

   472

        }

   473

    }

   474

   475

    ec_fsm_master_action_process_states(fsm);

   476

}

   477

   478

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

   479

   480

/**

   481

   Master state: READ STATES.

   482

   Fetches the AL- and online state of a slave.

   483

*/

   484

   485

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

   486

{

   487

    ec_slave_t *slave = fsm->slave;

   488

    ec_datagram_t *datagram = &fsm->datagram;

   489

    uint8_t new_state;

   490

   491

    if (datagram->state != EC_DATAGRAM_RECEIVED) {