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

/**

    31

   \file

    32

   EtherCAT SoE state machines.

    33

*/

    34

    35

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

    36

    37

#include "globals.h"

    38

#include "master.h"

    39

#include "mailbox.h"

    40

#include "fsm_soe.h"

    41

    42

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

    43

    44

/** Mailbox type for SoE.

    45

 */

    46

#define EC_MBOX_TYPE_SOE 0x05

    47

    48

#define EC_SOE_OPCODE_READ_REQUEST   0x01

    49

#define EC_SOE_OPCODE_READ_RESPONSE  0x02

    50

#define EC_SOE_OPCODE_WRITE_REQUEST  0x03

    51

#define EC_SOE_OPCODE_WRITE_RESPONSE 0x04

    52

    53

#define EC_SOE_READ_REQUEST_SIZE   0x04

    54

#define EC_SOE_READ_RESPONSE_SIZE  0x04

    55

#define EC_SOE_WRITE_REQUEST_SIZE  0x04

    56

#define EC_SOE_WRITE_RESPONSE_SIZE 0x04

    57

    58

#define EC_SOE_RESPONSE_TIMEOUT 1000

    59

    60

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

    61

    62

void ec_fsm_soe_read_start(ec_fsm_soe_t *);

    63

void ec_fsm_soe_read_request(ec_fsm_soe_t *);

    64

void ec_fsm_soe_read_check(ec_fsm_soe_t *);

    65

void ec_fsm_soe_read_response(ec_fsm_soe_t *);

    66

    67

void ec_fsm_soe_write_start(ec_fsm_soe_t *);

    68

void ec_fsm_soe_write_request(ec_fsm_soe_t *);

    69

void ec_fsm_soe_write_check(ec_fsm_soe_t *);

    70

void ec_fsm_soe_write_response(ec_fsm_soe_t *);

    71

    72

void ec_fsm_soe_end(ec_fsm_soe_t *);

    73

void ec_fsm_soe_error(ec_fsm_soe_t *);

    74

    75

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

    76

    77

/** Constructor.

    78

 */

    79

void ec_fsm_soe_init(

    83

{

    84

    fsm->state = NULL;

    85

    fsm->datagram = datagram;

    86

}

    87

    88

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

    89

    90

/** Destructor.

    91

 */

    92

void ec_fsm_soe_clear(

    95

{

    96

}

    97

    98

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

    99

   100

/** Starts to transfer an IDN to/from a slave.

   101

 */

   102

void ec_fsm_soe_transfer(

   103

        ec_fsm_soe_t *fsm, /**< State machine. */

   104

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

   105

        ec_soe_request_t *request /**< SoE request. */

   106

        )

   107

{

   108

    fsm->slave = slave;

   109

    fsm->request = request;

   110

    if (request->dir == EC_DIR_OUTPUT) {

   111

        fsm->state = ec_fsm_soe_write_start;

   113

        fsm->state = ec_fsm_soe_read_start;

   115

}

   116

   117

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

   118

   119

/**

   120

   Executes the current state of the state machine.

   121

   \return false, if state machine has terminated

   122

*/

   123

   124

int ec_fsm_soe_exec(ec_fsm_soe_t *fsm /**< finite state machine */)

   125

{

   126

    fsm->state(fsm);

   127

   128

    return fsm->state != ec_fsm_soe_end && fsm->state != ec_fsm_soe_error;

   129

}

   130

   131

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

   132

   133

/**

   134

   Returns, if the state machine terminated with success.

   135

   \return non-zero if successful.

   136

*/

   137

   138

int ec_fsm_soe_success(ec_fsm_soe_t *fsm /**< Finite state machine */)

   139

{

   140

    return fsm->state == ec_fsm_soe_end;

   141

}

   142

   143

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

   144

 * SoE read state machine

   145

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

   146

   147

/** SoE state: READ START.

   148

 */

   149

void ec_fsm_soe_read_start(ec_fsm_soe_t *fsm /**< finite state machine */)

   150

{

   151

    ec_datagram_t *datagram = fsm->datagram;

   152

    ec_slave_t *slave = fsm->slave;

   153

    ec_master_t *master = slave->master;

   154

    ec_soe_request_t *request = fsm->request;

   155

    uint8_t *data;

   156

   157

    if (master->debug_level)

   158

        EC_DBG("Reading IDN 0x%04X from slave %u.\n",

   159

               request->idn, slave->ring_position);

   160

   161

    if (!(slave->sii.mailbox_protocols & EC_MBOX_SOE)) {

   162

        EC_ERR("Slave %u does not support SoE!\n", slave->ring_position);

   163

        fsm->state = ec_fsm_soe_error;

   164

        return;

   165

    }

   166

   167

    data = ec_slave_mbox_prepare_send(slave, datagram, EC_MBOX_TYPE_SOE,

   169

    if (IS_ERR(data)) {

   170

        fsm->state = ec_fsm_soe_error;

   171

        return;

   172

    }

   173

   174

    EC_WRITE_U8(data, EC_SOE_OPCODE_READ_REQUEST);

   175

    EC_WRITE_U8(data + 1, 1 << 6); // request value

   176

    EC_WRITE_U16(data + 2, request->idn);

   177

   178

    if (master->debug_level) {

   179

        EC_DBG("SCC read request:\n");

   180

        ec_print_data(data, EC_SOE_READ_REQUEST_SIZE);

   181

    }

   182

   183

    fsm->request->data_size = 0;

   184

    fsm->request->jiffies_sent = jiffies;

   185

    fsm->retries = EC_FSM_RETRIES;

   186

    fsm->state = ec_fsm_soe_read_request;

   187

}

   188

   189

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

   190

   191

/** SoE state: READ REQUEST.

   192

 */

   193

void ec_fsm_soe_read_request(ec_fsm_soe_t *fsm /**< finite state machine */)

   194

{

   195

    ec_datagram_t *datagram = fsm->datagram;

   196

    ec_slave_t *slave = fsm->slave;

   197

    unsigned long diff_ms;

   198

   199

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

   200

        return; // FIXME: check for response first?

   201

   202

    if (datagram->state != EC_DATAGRAM_RECEIVED) {

   203

        fsm->state = ec_fsm_soe_error;

   204

        EC_ERR("Failed to receive SoE read request for slave %u: ",

   205

               slave->ring_position);

   206

        ec_datagram_print_state(datagram);

   207

        return;

   208

    }

   209

   210

    diff_ms = (jiffies - fsm->request->jiffies_sent) * 1000 / HZ;

   211

   212

    if (datagram->working_counter != 1) {

   213

        if (!datagram->working_counter) {

   214

            if (diff_ms < EC_SOE_RESPONSE_TIMEOUT) {

   215

                // no response; send request datagram again

   216

                return;

   217

            }

   218

        }

   219

        fsm->state = ec_fsm_soe_error;

   220

        EC_ERR("Reception of SoE read request for IDN 0x%04x failed"

   221

                " after %u ms on slave %u: ",

   222

                fsm->request->idn, (u32) diff_ms,

   223

                fsm->slave->ring_position);

   224

        ec_datagram_print_wc_error(datagram);

   225

        return;

   226

    }

   227

   228

    fsm->jiffies_start = datagram->jiffies_sent;

   229

    ec_slave_mbox_prepare_check(slave, datagram); // can not fail.

   230

    fsm->retries = EC_FSM_RETRIES;

   231

    fsm->state = ec_fsm_soe_read_check;

   232

}

   233

   234

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

   235

   236

/** CoE state: READ CHECK.

   237

 */

   238

void ec_fsm_soe_read_check(ec_fsm_soe_t *fsm /**< finite state machine */)

   239

{

   240

    ec_datagram_t *datagram = fsm->datagram;

   241

    ec_slave_t *slave = fsm->slave;

   242

   243

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

   244

        return;

   245

   246

    if (datagram->state != EC_DATAGRAM_RECEIVED) {

   247

        fsm->state = ec_fsm_soe_error;

   248

        EC_ERR("Failed to receive SoE mailbox check datagram from slave %u: ",

   249

               slave->ring_position);

   250

        ec_datagram_print_state(datagram);

   251

        return;

   252

    }

   253

   254

    if (datagram->working_counter != 1) {

   255

        fsm->state = ec_fsm_soe_error;

   256

        EC_ERR("Reception of SoE mailbox check datagram failed on slave %u: ",

   258

        ec_datagram_print_wc_error(datagram);

   259

        return;

   260

    }

   261

   262

    if (!ec_slave_mbox_check(datagram)) {

   263

        unsigned long diff_ms =

   264

            (datagram->jiffies_received - fsm->jiffies_start) * 1000 / HZ;

   265

        if (diff_ms >= EC_SOE_RESPONSE_TIMEOUT) {

   266

            fsm->state = ec_fsm_soe_error;

   267

            EC_ERR("Timeout after %u ms while waiting for IDN 0x%04x"

   268

                    " read response on slave %u.\n", (u32) diff_ms,

   269

                    fsm->request->idn, slave->ring_position);

   270

            return;

   271

        }

   272

   273

        ec_slave_mbox_prepare_check(slave, datagram); // can not fail.

   274

        fsm->retries = EC_FSM_RETRIES;

   275

        return;

   276

    }

   277

   278

    // Fetch response

   279

    ec_slave_mbox_prepare_fetch(slave, datagram); // can not fail.

   280

    fsm->retries = EC_FSM_RETRIES;

   281

    fsm->state = ec_fsm_soe_read_response;

   282

}

   283

   284

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

   285

   286

/** SoE state: READ RESPONSE.

   287

 */

   288

void ec_fsm_soe_read_response(ec_fsm_soe_t *fsm /**< finite state machine */)

   289

{

   290

    ec_datagram_t *datagram = fsm->datagram;

   291

    ec_slave_t *slave = fsm->slave;

   292

    ec_master_t *master = slave->master;

   293

    uint8_t *data, mbox_prot, header, opcode, incomplete, error_flag,

   294

            value_included;

   295

    size_t rec_size, data_size;

   296

    ec_soe_request_t *req = fsm->request;

   297

   298

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

   299

        return; // FIXME: request again?

   300

   301

    if (datagram->state != EC_DATAGRAM_RECEIVED) {

   302

        fsm->state = ec_fsm_soe_error;

   303

        EC_ERR("Failed to receive SoE read response datagram for"

   304

               " slave %u: ", slave->ring_position);

   305

        ec_datagram_print_state(datagram);

   306

        return;

   307

    }

   308

   309

    if (datagram->working_counter != 1) {

   310

        fsm->state = ec_fsm_soe_error;

   311

        EC_ERR("Reception of SoE read response failed on slave %u: ",

   312

                slave->ring_position);

   313

        ec_datagram_print_wc_error(datagram);

   314

        return;

   315

    }

   316

   317

    data = ec_slave_mbox_fetch(slave, datagram, &mbox_prot, &rec_size);

   318

    if (IS_ERR(data)) {

   319

        fsm->state = ec_fsm_soe_error;

   320

        return;

   321

    }

   322

   323

    if (master->debug_level) {

   324

        EC_DBG("SCC read response:\n");

   325

        ec_print_data(data, rec_size);

   326

    }

   327

   328

    if (mbox_prot != EC_MBOX_TYPE_SOE) {

   329

        fsm->state = ec_fsm_soe_error;

   330

        EC_WARN("Received mailbox protocol 0x%02X as response.\n", mbox_prot);

   331

        return;

   332

    }

   333

   334

    if (rec_size < EC_SOE_READ_RESPONSE_SIZE) {

   335

        fsm->state = ec_fsm_soe_error;

   336

        EC_ERR("Received currupted SoE read response (%zu bytes)!\n",

   338

        ec_print_data(data, rec_size);

   339

        return;

   340

    }

   341

   342

    header = EC_READ_U8(data);

   344

    incomplete = (header >> 3) & 1;

   346

   347

    if (opcode != EC_SOE_OPCODE_READ_RESPONSE) {

   348

        EC_ERR("Received no read response (opcode %x).\n", opcode);

   349

        ec_print_data(data, rec_size);

   350

        fsm->state = ec_fsm_soe_error;

   351

        return;

   352

    }

   353

   373

                data + EC_SOE_READ_RESPONSE_SIZE, data_size)) {

   377

   378

    if (incomplete) {

   379

        if (master->debug_level) {

   380

            EC_DBG("SoE data incomplete. Waiting for fragment"

   381

                    " at offset %zu.\n", req->data_size);

   382

        }

   383

        fsm->jiffies_start = datagram->jiffies_sent;

   384

        ec_slave_mbox_prepare_check(slave, datagram); // can not fail.

   385

        fsm->retries = EC_FSM_RETRIES;

   386

        fsm->state = ec_fsm_soe_read_check;

   387

    } else {

   388

        if (master->debug_level) {

   389

            EC_DBG("IDN data:\n");

   390

            ec_print_data(req->data, req->data_size);

   391

        }

   392

   393

        fsm->state = ec_fsm_soe_end; // success

   394

    }

   395

}

   396

   397

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

   398

 * SoE write state machine

   399

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

   400

   401

/** Write next fragment.

   402

 */

   403

void ec_fsm_soe_write_next_fragment(

   404

        ec_fsm_soe_t *fsm /**< finite state machine */

   405

        )

   406

{

   407

    ec_datagram_t *datagram = fsm->datagram;

   408

    ec_slave_t *slave = fsm->slave;

   409

    ec_master_t *master = slave->master;

   410

    ec_soe_request_t *req = fsm->request;

   411

    uint8_t incomplete, *data;

   412

    size_t header_size, max_fragment_size, remaining_size, fragment_size;

   413

    uint16_t fragments_left;

   414

   415

    header_size = EC_MBOX_HEADER_SIZE + EC_SOE_WRITE_REQUEST_SIZE;

   416

    if (slave->configured_rx_mailbox_size <= header_size) {

   417

        EC_ERR("Mailbox size (%u) too small for SoE write.\n",

   418

                slave->configured_rx_mailbox_size);

   419

        fsm->state = ec_fsm_soe_error;

   420

        return;

   421

    }

   422

   423

    remaining_size = req->data_size - fsm->offset;

   424

    max_fragment_size = slave->configured_rx_mailbox_size - header_size;

   425

    incomplete = remaining_size > max_fragment_size;

   426

    fragment_size = incomplete ? max_fragment_size : remaining_size;

   427

    fragments_left = remaining_size / fragment_size - 1;

   428

    if (remaining_size % fragment_size) {

   429

        fragments_left++;

   430

    }

   431

   432

    data = ec_slave_mbox_prepare_send(slave, datagram, EC_MBOX_TYPE_SOE,

   434

    if (IS_ERR(data)) {

   435

        fsm->state = ec_fsm_soe_error;

   436

        return;

   437

    }

   438

   439

    EC_WRITE_U8(data, EC_SOE_OPCODE_WRITE_REQUEST | incomplete << 3);

   440

    EC_WRITE_U8(data + 1, 1 << 6); // only value included

   441

    EC_WRITE_U16(data + 2, incomplete ? fragments_left : req->idn);

   443

    fsm->offset += fragment_size;

   444

   445

    if (master->debug_level) {

   446

        EC_DBG("SCC write request:\n");

   447

        ec_print_data(data, EC_SOE_WRITE_REQUEST_SIZE + fragment_size);

   448

    }

   449

   450

    req->jiffies_sent = jiffies;

   451

    fsm->retries = EC_FSM_RETRIES;

   452

    fsm->state = ec_fsm_soe_write_request;

   453

}

   454

   455

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

   456

   457

/** SoE state: WRITE START.

   458

 */

   459

void ec_fsm_soe_write_start(ec_fsm_soe_t *fsm /**< finite state machine */)

   460

{

   461

    ec_slave_t *slave = fsm->slave;

   462

    ec_master_t *master = slave->master;

   463

    ec_soe_request_t *req = fsm->request;

   464

   465

    if (master->debug_level)

   466

        EC_DBG("Writing IDN 0x%04X (%zu byte) to slave %u.\n",

   467

               req->idn, req->data_size, slave->ring_position);

   468

   469

    if (!(slave->sii.mailbox_protocols & EC_MBOX_SOE)) {

   470

        EC_ERR("Slave %u does not support SoE!\n", slave->ring_position);

   471

        fsm->state = ec_fsm_soe_error;

   472

        return;

   473

    }

   474

   475

    fsm->offset = 0;

   476

    ec_fsm_soe_write_next_fragment(fsm);

   477

}

   478

   479

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

   480

   481

/** SoE state: WRITE REQUEST.

   482

 */

   483

void ec_fsm_soe_write_request(ec_fsm_soe_t *fsm /**< finite state machine */)

   484

{

   485

    ec_datagram_t *datagram = fsm->datagram;

   486

    ec_slave_t *slave = fsm->slave;

   487

    unsigned long diff_ms;

   488

   489

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

   490

        return; // FIXME: check for response first?

   491

   492

    if (datagram->state != EC_DATAGRAM_RECEIVED) {

   493

        fsm->state = ec_fsm_soe_error;

   494

        EC_ERR("Failed to receive SoE write request for slave %u: ",

   495

               slave->ring_position);

   496

        ec_datagram_print_state(datagram);

   497

        return;

   498

    }

   499

   500

    diff_ms = (jiffies - fsm->request->jiffies_sent) * 1000 / HZ;

   501

   502

    if (datagram->working_counter != 1) {

   503

        if (!datagram->working_counter) {

   504

            if (diff_ms < EC_SOE_RESPONSE_TIMEOUT) {

   505

                // no response; send request datagram again

   506

                return;

   507

            }

   508

        }

   509

        fsm->state = ec_fsm_soe_error;

   510

        EC_ERR("Reception of SoE write request for IDN 0x%04x failed"

   511

                " after %u ms on slave %u: ",

   512

                fsm->request->idn, (u32) diff_ms,

   513

                fsm->slave->ring_position);