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 state change FSM.

    37

*/

    38

    39

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

    40

    41

#include "globals.h"

    42

#include "master.h"

    43

#include "fsm_change.h"

    44

    45

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

    46

    47

void ec_fsm_change_state_start(ec_fsm_change_t *);

    48

void ec_fsm_change_state_check(ec_fsm_change_t *);

    49

void ec_fsm_change_state_status(ec_fsm_change_t *);

    50

void ec_fsm_change_state_code(ec_fsm_change_t *);

    51

void ec_fsm_change_state_start_ack(ec_fsm_change_t *);

    52

void ec_fsm_change_state_ack(ec_fsm_change_t *);

    53

void ec_fsm_change_state_check_ack(ec_fsm_change_t *);

    54

void ec_fsm_change_state_end(ec_fsm_change_t *);

    55

void ec_fsm_change_state_error(ec_fsm_change_t *);

    56

    57

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

    58

    59

/**

    60

   Constructor.

    61

*/

    62

    63

void ec_fsm_change_init(ec_fsm_change_t *fsm, /**< finite state machine */

    64

                        ec_datagram_t *datagram /**< datagram */

    65

                        )

    66

{

    67

    fsm->state = NULL;

    68

    fsm->datagram = datagram;

    69

}

    70

    71

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

    72

    73

/**

    74

   Destructor.

    75

*/

    76

    77

void ec_fsm_change_clear(ec_fsm_change_t *fsm /**< finite state machine */)

    78

{

    79

}

    80

    81

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

    82

    83

/**

    84

   Starts the change state machine.

    85

*/

    86

    87

void ec_fsm_change_start(ec_fsm_change_t *fsm, /**< finite state machine */

    88

                         ec_slave_t *slave, /**< EtherCAT slave */

    89

                         ec_slave_state_t state /**< requested state */

    90

                         )

    91

{

    92

    fsm->mode = EC_FSM_CHANGE_MODE_FULL;

    93

    fsm->slave = slave;

    94

    fsm->requested_state = state;

    95

    fsm->state = ec_fsm_change_state_start;

    96

}

    97

    98

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

    99

   100

/**

   101

   Starts the change state machine to only acknowlegde a slave's state.

   102

*/

   103

   104

void ec_fsm_change_ack(ec_fsm_change_t *fsm, /**< finite state machine */

   105

                       ec_slave_t *slave /**< EtherCAT slave */

   106

                       )

   107

{

   108

    fsm->mode = EC_FSM_CHANGE_MODE_ACK_ONLY;

   109

    fsm->slave = slave;

   110

    fsm->requested_state = EC_SLAVE_STATE_UNKNOWN;

   111

    fsm->state = ec_fsm_change_state_start_ack;

   112

}

   113

   114

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

   115

   116

/**

   117

   Executes the current state of the state machine.

   118

   \return false, if the state machine has terminated

   119

*/

   120

   121

int ec_fsm_change_exec(ec_fsm_change_t *fsm /**< finite state machine */)

   122

{

   123

    fsm->state(fsm);

   124

   125

    return fsm->state != ec_fsm_change_state_end

   126

        && fsm->state != ec_fsm_change_state_error;

   127

}

   128

   129

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

   130

   131

/**

   132

   Returns, if the state machine terminated with success.

   133

   \return non-zero if successful.

   134

*/

   135

   136

int ec_fsm_change_success(ec_fsm_change_t *fsm /**< Finite state machine */)

   137

{

   138

    return fsm->state == ec_fsm_change_state_end;

   139

}

   140

   141

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

   142

 *  state change state machine

   143

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

   144

   145

/**

   146

   Change state: START.

   147

*/

   148

   149

void ec_fsm_change_state_start(ec_fsm_change_t *fsm

   150

                               /**< finite state machine */)

   151

{

   152

    ec_datagram_t *datagram = fsm->datagram;

   153

    ec_slave_t *slave = fsm->slave;

   154

   155

    fsm->take_time = 1;

   156

    fsm->old_state = fsm->slave->current_state;

   157

   158

    // write new state to slave

   159

    ec_datagram_npwr(datagram, slave->station_address, 0x0120, 2);

   160

    EC_WRITE_U16(datagram->data, fsm->requested_state);

   161

    fsm->retries = EC_FSM_RETRIES;

   162

    fsm->state = ec_fsm_change_state_check;

   163

}

   164

   165

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

   166

   167

/**

   168

   Change state: CHECK.

   169

*/

   170

   171

void ec_fsm_change_state_check(ec_fsm_change_t *fsm

   172

                               /**< finite state machine */)

   173

{

   174

    ec_datagram_t *datagram = fsm->datagram;

   175

    ec_slave_t *slave = fsm->slave;

   176

   177

    if (datagram->state == EC_DATAGRAM_TIMED_OUT && fsm->retries--)

   178

        return;

   179

   180

    if (datagram->state != EC_DATAGRAM_RECEIVED) {

   181

        fsm->state = ec_fsm_change_state_error;

   182

        EC_ERR("Failed to receive state datagram from slave %i"

   183

                " (datagram state %i)!\n",

   184

               fsm->slave->ring_position, datagram->state);

   185

        return;

   186

    }

   187

   188

    if (fsm->take_time) {

   189

        fsm->take_time = 0;

   190

        fsm->jiffies_start = datagram->jiffies_sent;

   191

    }

   192

   193

    if (datagram->working_counter != 1) {

   194

        if (datagram->jiffies_received - fsm->jiffies_start >= 3 * HZ) {

   195

            char state_str[EC_STATE_STRING_SIZE];

   196

            ec_state_string(fsm->requested_state, state_str);

   197

            fsm->state = ec_fsm_change_state_error;

   198

            EC_ERR("Failed to set state %s on slave %i: Slave did not"

   199

                   " respond.\n", state_str, fsm->slave->ring_position);

   200

            return;

   201

        }

   202

   203

        // repeat writing new state to slave

   204

        ec_datagram_npwr(datagram, slave->station_address, 0x0120, 2);

   205

        EC_WRITE_U16(datagram->data, fsm->requested_state);

   206

        fsm->retries = EC_FSM_RETRIES;

   207

        return;

   208

    }

   209

   210

    fsm->take_time = 1;

   211

   212

    // read AL status from slave

   213

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

   214

    fsm->retries = EC_FSM_RETRIES;

   215

    fsm->state = ec_fsm_change_state_status;

   216

}

   217

   218

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

   219

   220

/**

   221

   Change state: STATUS.

   222

*/

   223

   224

void ec_fsm_change_state_status(ec_fsm_change_t *fsm

   225

                                /**< finite state machine */)

   226

{

   227

    ec_datagram_t *datagram = fsm->datagram;

   228

    ec_slave_t *slave = fsm->slave;

   229

   230

    if (datagram->state == EC_DATAGRAM_TIMED_OUT && fsm->retries--)

   231

        return;

   232

   233

    if (datagram->state != EC_DATAGRAM_RECEIVED) {

   234

        fsm->state = ec_fsm_change_state_error;

   235

        EC_ERR("Failed to receive state checking datagram from slave %i"

   236

                " (datagram state %i).\n",

   237

               slave->ring_position, datagram->state);

   238

        return;

   239

    }

   240

   241

    if (datagram->working_counter != 1) {

   242

        char req_state[EC_STATE_STRING_SIZE];

   243

        ec_state_string(fsm->requested_state, req_state);

   244

        fsm->state = ec_fsm_change_state_error;

   245

        EC_ERR("Failed to check state %s on slave %i.\n",

   246

               req_state, slave->ring_position);

   247

        return;

   248

    }

   249

   250

    if (fsm->take_time) {

   251

        fsm->take_time = 0;

   252

        fsm->jiffies_start = datagram->jiffies_sent;

   253

    }

   254

   255

    slave->current_state = EC_READ_U8(datagram->data);

   256

   257

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

   258

        // state has been set successfully

   259

        fsm->state = ec_fsm_change_state_end;

   260

        return;

   261

    }

   262

   263

    if (slave->current_state != fsm->old_state) { // state changed

   264

        char req_state[EC_STATE_STRING_SIZE], cur_state[EC_STATE_STRING_SIZE];

   265

   266

        ec_state_string(slave->current_state, cur_state);

   267

   268

        if ((slave->current_state & 0x0F) != (fsm->old_state & 0x0F)) {

   269

            // Slave spontaneously changed its state just before the new state

   270

            // was written. Accept current state as old state and wait for

   271

            // state change

   272

            fsm->old_state = slave->current_state;

   273

            EC_WARN("Slave %i changed to %s in the meantime.\n",

   274

                    slave->ring_position, cur_state);

   275

            goto again;

   276

        }

   277

   278

        // state change error

   279

   280

        slave->error_flag = 1;

   281

        ec_state_string(fsm->requested_state, req_state);

   282

   283

        EC_ERR("Failed to set %s state, slave %i refused state change (%s).\n",

   284

               req_state, slave->ring_position, cur_state);

   285

        // fetch AL status error code

   286

        ec_datagram_nprd(datagram, slave->station_address, 0x0134, 2);

   287

        fsm->retries = EC_FSM_RETRIES;

   288

        fsm->state = ec_fsm_change_state_code;

   289

        return;

   290

    }

   291

   292

    // still old state

   293

   294

    if (datagram->jiffies_received - fsm->jiffies_start >= HZ) { // 1s

   295

        // timeout while checking

   296

        char state_str[EC_STATE_STRING_SIZE];

   297

        ec_state_string(fsm->requested_state, state_str);

   298

        fsm->state = ec_fsm_change_state_error;

   299

        EC_ERR("Timeout while setting state %s on slave %i.\n",

   300

               state_str, slave->ring_position);

   301

        return;

   302

    }

   303

   304

 again:

   305

    // no timeout yet. check again

   306

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

   307

    fsm->retries = EC_FSM_RETRIES;

   308

}

   309

   310

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

   311

   312

/**

   313

   Application layer status messages.

   314

*/

   315

   316

const ec_code_msg_t al_status_messages[] = {

   317

    {0x0001, "Unspecified error"},

   318

    {0x0011, "Invalud requested state change"},

   319

    {0x0012, "Unknown requested state"},

   320

    {0x0013, "Bootstrap not supported"},

   321

    {0x0014, "No valid firmware"},

   322

    {0x0015, "Invalid mailbox configuration"},

   323

    {0x0016, "Invalid mailbox configuration"},

   324

    {0x0017, "Invalid sync manager configuration"},

   325

    {0x0018, "No valid inputs available"},

   326

    {0x0019, "No valid outputs"},

   327

    {0x001A, "Synchronisation error"},

   328

    {0x001B, "Sync manager watchdog"},

   329

    {0x001C, "Invalid sync manager types"},

   330

    {0x001D, "Invalid output configuration"},

   331

    {0x001E, "Invalid input configuration"},

   332

    {0x001F, "Invalid watchdog configuration"},

   333

    {0x0020, "Slave needs cold start"},

   334

    {0x0021, "Slave needs INIT"},

   335

    {0x0022, "Slave needs PREOP"},

   336

    {0x0023, "Slave needs SAVEOP"},

   337

    {0x0030, "Invalid DC SYNCH configuration"},

   338

    {0x0031, "Invalid DC latch configuration"},

   339

    {0x0032, "PLL error"},

   340

    {0x0033, "Invalid DC IO error"},

   341

    {0x0034, "Invalid DC timeout error"},

   342

    {0x0042, "MBOX EOE"},

   343

    {0x0043, "MBOX COE"},

   344

    {0x0044, "MBOX FOE"},

   345

    {0x0045, "MBOX SOE"},

   346

    {0x004F, "MBOX VOE"},

   347

    {}

   348

};

   349

   350

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

   351

   352

/**

   353

   Change state: CODE.

   354

*/

   355

   356

void ec_fsm_change_state_code(ec_fsm_change_t *fsm

   357

                              /**< finite state machine */)

   358

{

   359

    ec_datagram_t *datagram = fsm->datagram;

   360

    uint32_t code;

   361

    const ec_code_msg_t *al_msg;

   362

   363

    if (datagram->state == EC_DATAGRAM_TIMED_OUT && fsm->retries--)

   364

        return;

   365

   366

    if (datagram->state != EC_DATAGRAM_RECEIVED) {

   367

        fsm->state = ec_fsm_change_state_error;

   368

        EC_ERR("Failed to receive AL status code datagram from slave %i"

   369

                " (datagram state %i).\n",

   370

               fsm->slave->ring_position, datagram->state);

   371

        return;

   372

    }

   373

   374

    if (datagram->working_counter != 1) {

   375

        EC_WARN("Reception of AL status code datagram failed.\n");

   376

    }

   377

    else {

   378

        if ((code = EC_READ_U16(datagram->data))) {

   379

            for (al_msg = al_status_messages; al_msg->code; al_msg++) {

   380

                if (al_msg->code != code) continue;

   381

                EC_ERR("AL status message 0x%04X: \"%s\".\n",

   382

                       al_msg->code, al_msg->message);

   383

                break;

   384

            }

   385

            if (!al_msg->code)

   386

                EC_ERR("Unknown AL status code 0x%04X.\n", code);

   387

        }

   388

    }

   389

   390

    // acknowledge "old" slave state

   391

    ec_fsm_change_state_start_ack(fsm); // execute immediately

   392

}

   393

   394

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

   395

   396

/**

   397

   Change state: START ACK.

   398

*/

   399

   400

void ec_fsm_change_state_start_ack(ec_fsm_change_t *fsm

   401

                                   /**< finite state machine */)

   402

{

   403

    ec_slave_t *slave = fsm->slave;

   404

    ec_datagram_t *datagram = fsm->datagram;

   405

   406

    ec_datagram_npwr(datagram, slave->station_address, 0x0120, 2);

   407

    EC_WRITE_U16(datagram->data, slave->current_state);

   408

    fsm->retries = EC_FSM_RETRIES;

   409

    fsm->state = ec_fsm_change_state_ack;

   410

}

   411

   412

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

   413

   414

/**

   415

   Change state: ACK.

   416

*/

   417

   418

void ec_fsm_change_state_ack(ec_fsm_change_t *fsm /**< finite state machine */)

   419

{

   420

    ec_datagram_t *datagram = fsm->datagram;

   421

    ec_slave_t *slave = fsm->slave;

   422

   423

    if (datagram->state == EC_DATAGRAM_TIMED_OUT && fsm->retries--)

   424

        return;

   425

   426

    if (datagram->state != EC_DATAGRAM_RECEIVED) {

   427

        fsm->state = ec_fsm_change_state_error;

   428

        EC_ERR("Failed to receive state ack datagram for slave %i"

   429

                " (datagram state %i).\n",

   430

               slave->ring_position, datagram->state);

   431

        return;

   432

    }

   433

   434

    if (datagram->working_counter != 1) {

   435

        fsm->state = ec_fsm_change_state_error;

   436

        EC_ERR("Reception of state ack datagram failed - slave %i did not"

   437

               " respond.\n", slave->ring_position);

   438

        return;

   439

    }

   440

   441

    fsm->take_time = 1;

   442

   443

    // read new AL status

   444

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

   445

    fsm->retries = EC_FSM_RETRIES;

   446

    fsm->state = ec_fsm_change_state_check_ack;

   447

}

   448

   449

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

   450

   451

/**

   452

   Change state: CHECK ACK.

   453

*/

   454

   455

void ec_fsm_change_state_check_ack(ec_fsm_change_t *fsm

   456

                                   /**< finite state machine */)

   457

{

   458

    ec_datagram_t *datagram = fsm->datagram;

   459

    ec_slave_t *slave = fsm->slave;

   460

   461

    if (datagram->state == EC_DATAGRAM_TIMED_OUT && fsm->retries--)

   462

        return;

   463

   464

    if (datagram->state != EC_DATAGRAM_RECEIVED) {

   465

        fsm->state = ec_fsm_change_state_error;

   466

        EC_ERR("Failed to receive state ack check datagram from slave %i"

   467

                " (datagram state %i).\n",

   468

               slave->ring_position, datagram->state);

   469

        return;

   470

    }

   471

   472

    if (datagram->working_counter != 1) {

   473

        fsm->state = ec_fsm_change_state_error;

   474

        EC_ERR("Reception of state ack check datagram failed - slave %i did"

   475

               " not respond.\n", slave->ring_position);

   476

        return;

   477

    }

   478

   479

    if (fsm->take_time) {

   480

        fsm->take_time = 0;

   481

        fsm->jiffies_start = datagram->jiffies_sent;

   482

    }

   483

   484

    slave->current_state = EC_READ_U8(datagram->data);

   485

   486

    if (!(slave->current_state & EC_SLAVE_STATE_ACK_ERR)) {

   487

        char state_str[EC_STATE_STRING_SIZE];

   488

        ec_state_string(slave->current_state, state_str);

   489

        if (fsm->mode == EC_FSM_CHANGE_MODE_FULL) {

   490

            fsm->state = ec_fsm_change_state_error;

   491

        }

   492

        else { // EC_FSM_CHANGE_MODE_ACK_ONLY

   493

            fsm->state = ec_fsm_change_state_end;

   494

        }

   495

        EC_INFO("Acknowledged state %s on slave %i.\n",

   496

                state_str, slave->ring_position);

   497

        return;

   498

    }

   499

   500

    if (datagram->jiffies_received - fsm->jiffies_start >= HZ) { // 1s

   501

        // timeout while checking

   502

        char state_str[EC_STATE_STRING_SIZE];

   503

        ec_state_string(slave->current_state, state_str);

   504

        fsm->state = ec_fsm_change_state_error;

   505

        EC_ERR("Timeout while acknowledging state %s on slave %i.\n",

   506

               state_str, slave->ring_position);

   507

        return;

   508

    }