1

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

     2

 *

     3

 *  $Id$

     4

 *

     5

 *  Copyright (C) 2008  Olav Zarges, imc Messsysteme GmbH

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

    33

*/

    34

    35

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

    36

    37

#include "globals.h"

    38

#include "master.h"

    39

#include "mailbox.h"

    40

#include "fsm_foe.h"

    41

#include "foe.h"

    42

    43

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

    44

    45

/** Maximum time in ms to wait for responses when reading out the dictionary.

    46

 */

    47

#define EC_FSM_FOE_TIMEOUT 3000

    48

    49

#define EC_MBOX_TYPE_FILEACCESS 0x04

    50

    51

#define EC_FOE_HEADER_SIZE 6

    52

// uint8_t  OpCode

    53

// uint8_t  reserved

    54

// uint32_t PacketNo, Password, ErrorCode

    55

    56

//#define DEBUG_FOE

    57

    58

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

    59

    60

/** FoE OpCodes.

    61

 */

    62

enum {

    63

    EC_FOE_OPCODE_RRQ  = 1, /**< Read request. */

    64

    EC_FOE_OPCODE_WRQ  = 2, /**< Write request. */

    65

    EC_FOE_OPCODE_DATA = 3, /**< Data. */

    66

    EC_FOE_OPCODE_ACK  = 4, /**< Acknowledge. */

    67

    EC_FOE_OPCODE_ERR  = 5, /**< Error. */

    68

    EC_FOE_OPCODE_BUSY = 6  /**< Busy. */

    69

} ec_foe_opcode_t;

    70

    71

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

    72

    73

int ec_foe_prepare_data_send(ec_fsm_foe_t *);

    74

int ec_foe_prepare_wrq_send(ec_fsm_foe_t *);

    75

int ec_foe_prepare_rrq_send(ec_fsm_foe_t *);

    76

int ec_foe_prepare_send_ack(ec_fsm_foe_t *);

    77

    78

void ec_foe_set_tx_error(ec_fsm_foe_t *, uint32_t);

    79

void ec_foe_set_rx_error(ec_fsm_foe_t *, uint32_t);

    80

    81

void ec_fsm_foe_write(ec_fsm_foe_t *);

    82

void ec_fsm_foe_read(ec_fsm_foe_t *);

    83

void ec_fsm_foe_end(ec_fsm_foe_t *);

    84

void ec_fsm_foe_error(ec_fsm_foe_t *);

    85

    86

void ec_fsm_foe_state_wrq_sent(ec_fsm_foe_t *);

    87

void ec_fsm_foe_state_rrq_sent(ec_fsm_foe_t *);

    88

    89

void ec_fsm_foe_state_ack_check(ec_fsm_foe_t *);

    90

void ec_fsm_foe_state_ack_read(ec_fsm_foe_t *);

    91

    92

void ec_fsm_foe_state_data_sent(ec_fsm_foe_t *);

    93

    94

void ec_fsm_foe_state_data_check(ec_fsm_foe_t *);

    95

void ec_fsm_foe_state_data_read(ec_fsm_foe_t *);

    96

void ec_fsm_foe_state_sent_ack(ec_fsm_foe_t *);

    97

    98

void ec_fsm_foe_write_start(ec_fsm_foe_t *);

    99

void ec_fsm_foe_read_start(ec_fsm_foe_t *);

   100

   101

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

   102

   103

/**

   104

   Constructor.

   105

*/

   106

   107

void ec_fsm_foe_init(ec_fsm_foe_t *fsm, /**< finite state machine */

   108

                     ec_datagram_t *datagram /**< datagram */

   109

                     )

   110

{

   111

    fsm->state     = NULL;

   112

    fsm->datagram  = datagram;

   113

    fsm->rx_errors = 0;

   114

    fsm->tx_errors = 0;

   115

}

   116

   117

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

   118

   119

/**

   120

   Destructor.

   121

*/

   122

   123

void ec_fsm_foe_clear(ec_fsm_foe_t *fsm /**< finite state machine */)

   124

{

   125

}

   126

   127

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

   128

   129

/**

   130

   Executes the current state of the state machine.

   131

   \return false, if state machine has terminated

   132

*/

   133

   134

int ec_fsm_foe_exec(ec_fsm_foe_t *fsm /**< finite state machine */)

   135

{

   136

    fsm->state(fsm);

   137

   138

    return fsm->state != ec_fsm_foe_end && fsm->state != ec_fsm_foe_error;

   139

}

   140

   141

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

   142

   143

/**

   144

   Returns, if the state machine terminated with success.

   145

   \return non-zero if successful.

   146

*/

   147

   148

int ec_fsm_foe_success(ec_fsm_foe_t *fsm /**< Finite state machine */)

   149

{

   150

    return fsm->state == ec_fsm_foe_end;

   151

}

   152

   153

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

   154

   155

void ec_fsm_foe_transfer(

   156

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

   157

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

   158

        ec_foe_request_t *request /**< Sdo request. */

   159

        )

   160

{

   161

    fsm->slave = slave;

   162

    fsm->request = request;

   163

    if (request->dir == EC_DIR_OUTPUT) {

   164

        fsm->state = ec_fsm_foe_write;

   165

    }

   166

    else {

   167

        fsm->state = ec_fsm_foe_read;

   168

    }

   169

}

   170

   171

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

   172

   173

/**

   174

   State: ERROR.

   175

*/

   176

   177

void ec_fsm_foe_error(ec_fsm_foe_t *fsm /**< finite state machine */)

   178

{

   179

#ifdef DEBUG_FOE

   180

    printk("ec_fsm_foe_error()\n");

   181

#endif

   182

}

   183

   184

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

   185

   186

/**

   187

   State: END.

   188

*/

   189

   190

void ec_fsm_foe_end(ec_fsm_foe_t *fsm /**< finite state machine */)

   191

{

   192

#ifdef DEBUG_FOE

   193

    printk("ec_fsm_foe_end\n");

   194

#endif

   195

}

   196

   197

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

   198

/**

   199

   Sends a file or the next fragment.

   200

*/

   201

   202

int ec_foe_prepare_data_send( ec_fsm_foe_t *fsm ) {

   203

    size_t       remaining_size, current_size;

   204

    uint8_t*     data;

   205

   206

    remaining_size = fsm->tx_buffer_size - fsm->tx_buffer_offset;

   207

   208

    if (remaining_size < fsm->slave->configured_tx_mailbox_size

   209

            - EC_MBOX_HEADER_SIZE - EC_FOE_HEADER_SIZE) {

   210

        current_size = remaining_size;

   211

        fsm->tx_last_packet = 1;

   212

    } else {

   213

        current_size = fsm->slave->configured_tx_mailbox_size

   214

            - EC_MBOX_HEADER_SIZE - EC_FOE_HEADER_SIZE;

   215

    }

   216

   217

    if (!(data = ec_slave_mbox_prepare_send(fsm->slave, fsm->datagram,

   218

                    EC_MBOX_TYPE_FILEACCESS,

   219

                    current_size + EC_FOE_HEADER_SIZE)))

   220

        return -1;

   221

   222

    EC_WRITE_U8 ( data, EC_FOE_OPCODE_DATA );    // OpCode = DataBlock req.

   223

    EC_WRITE_U32( data + 2, fsm->tx_packet_no ); // PacketNo, Password

   224

   225

    memcpy(data + EC_FOE_HEADER_SIZE,

   226

            fsm->tx_buffer + fsm->tx_buffer_offset, current_size);

   227

    fsm->tx_current_size = current_size;

   228

   229

    return 0;

   230

}

   231

   232

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

   233

/**

   234

   Prepare a write request (WRQ) with filename

   235

*/

   236

   237

int ec_foe_prepare_wrq_send( ec_fsm_foe_t *fsm ) {

   238

    size_t current_size;

   239

    uint8_t *data;

   240

   241

    fsm->tx_buffer_offset = 0;

   242

    fsm->tx_current_size = 0;

   243

    fsm->tx_packet_no = 0;

   244

    fsm->tx_last_packet = 0;

   245

   246

    current_size = fsm->tx_filename_len;

   247

   248

    if (!(data = ec_slave_mbox_prepare_send(fsm->slave, fsm->datagram,

   249

                    EC_MBOX_TYPE_FILEACCESS, current_size + EC_FOE_HEADER_SIZE)))

   250

        return -1;

   251

   252

    EC_WRITE_U16( data, EC_FOE_OPCODE_WRQ); // fsm write request

   253

    EC_WRITE_U32( data + 2, fsm->tx_packet_no );

   254

   255

    memcpy(data + EC_FOE_HEADER_SIZE, fsm->tx_filename, current_size);

   256

   257

    return 0;

   258

}

   259

   260

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

   261

   262

void ec_fsm_foe_write(ec_fsm_foe_t *fsm /**< finite state machine */)

   263

{

   264

    fsm->tx_buffer = fsm->request->buffer;

   265

    fsm->tx_buffer_size = fsm->request->data_size;

   266

    fsm->tx_buffer_offset = 0;

   267

   268

    fsm->tx_filename = fsm->request->file_name;

   269

    fsm->tx_filename_len = strlen(fsm->tx_filename);

   270

   271

    fsm->state = ec_fsm_foe_write_start;

   272

}

   273

   274

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

   275

/**

   276

   Initializes the SII write state machine.

   277

*/

   278

   279

void ec_fsm_foe_write_start(ec_fsm_foe_t *fsm /**< finite state machine */)

   280

{

   281

    ec_slave_t *slave = fsm->slave;

   282

   283

    fsm->tx_buffer_offset = 0;

   284

    fsm->tx_current_size = 0;

   285

    fsm->tx_packet_no = 0;

   286

    fsm->tx_last_packet = 0;

   287

   288

#ifdef DEBUG_FOE

   289

    printk("ec_fsm_foe_write_start()\n");

   290

#endif

   291

   292

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

   293

        ec_foe_set_tx_error(fsm, FOE_MBOX_PROT_ERROR);

   294

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

   295

        return;

   296

    }

   297

   298

    if (ec_foe_prepare_wrq_send(fsm)) {

   299

        ec_foe_set_tx_error(fsm, FOE_PROT_ERROR);

   300

        return;

   301

    }

   302

   303

    fsm->state = ec_fsm_foe_state_wrq_sent;

   304

}

   305

   306

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

   307

   308

void ec_fsm_foe_state_ack_check( ec_fsm_foe_t *fsm ) {

   309

    ec_datagram_t *datagram = fsm->datagram;

   310

    ec_slave_t *slave = fsm->slave;

   311

   312

#ifdef DEBUG_FOE

   313

    printk("ec_fsm_foe_ack_check()\n");

   314

#endif

   315

   316

    if (datagram->state != EC_DATAGRAM_RECEIVED) {

   317

        ec_foe_set_rx_error(fsm, FOE_RECEIVE_ERROR);

   318

        EC_ERR("Failed to receive FoE mailbox check datagram for slave %u"

   319

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

   320

               slave->ring_position, datagram->state);

   321

        return;

   322

    }

   323

   324

    if (datagram->working_counter != 1) {

   325

        // slave did not put anything in the mailbox yet

   326

        ec_foe_set_rx_error(fsm, FOE_WC_ERROR);

   327

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

   328

               slave->ring_position);

   329

        ec_datagram_print_wc_error(datagram);

   330

        return;

   331

    }

   332

   333

    if (!ec_slave_mbox_check(datagram)) {

   334

        unsigned long diff_ms =

   335

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

   336

        if (diff_ms >= EC_FSM_FOE_TIMEOUT) {

   337

            ec_foe_set_tx_error(fsm, FOE_TIMEOUT_ERROR);

   338

            EC_ERR("Timeout while waiting for ack response "

   339

                    "on slave %u.\n", slave->ring_position);

   340

            return;

   341

        }

   342

   343

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

   344

        fsm->retries = EC_FSM_RETRIES;

   345

        return;

   346

    }

   347

   348

    // Fetch response

   349

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

   350

   351

    fsm->retries = EC_FSM_RETRIES;

   352

    fsm->state = ec_fsm_foe_state_ack_read;

   353

}

   354

   355

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

   356

   357

void ec_fsm_foe_state_ack_read( ec_fsm_foe_t *fsm ) {

   358

   359

    ec_datagram_t *datagram = fsm->datagram;

   360

    ec_slave_t *slave = fsm->slave;

   361

    uint8_t *data, mbox_prot;

   362

    uint8_t opCode;

   363

    size_t rec_size;

   364

   365

#ifdef DEBUG_FOE

   366

    printk("ec_fsm_foe_ack_read()\n");

   367

#endif

   368

   369

    if (datagram->state != EC_DATAGRAM_RECEIVED) {

   370

        ec_foe_set_rx_error(fsm, FOE_RECEIVE_ERROR);

   371

        EC_ERR("Failed to receive FoE ack response datagram for"

   372

               " slave %u (datagram state %u).\n",

   373

               slave->ring_position, datagram->state);

   374

        return;

   375

    }

   376

   377

    if (datagram->working_counter != 1) {

   378

        ec_foe_set_rx_error(fsm, FOE_WC_ERROR);

   379

        EC_ERR("Reception of FoE ack response failed on slave %u: ",

   380

                slave->ring_position);

   381

        ec_datagram_print_wc_error(datagram);

   382

        return;

   383

    }

   384

   385

    if (!(data = ec_slave_mbox_fetch(fsm->slave, datagram,

   386

                    &mbox_prot, &rec_size))) {

   387

        ec_foe_set_tx_error(fsm, FOE_PROT_ERROR);

   388

        return;

   389

    }

   390

   391

    if (mbox_prot != EC_MBOX_TYPE_FILEACCESS) { // FoE

   392

        ec_foe_set_tx_error(fsm, FOE_MBOX_PROT_ERROR);

   393

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

   394

        return;

   395

    }

   396

   397

    opCode = EC_READ_U8(data);

   398

   399

    if (opCode == EC_FOE_OPCODE_BUSY) {

   400

        // slave not ready

   401

        if (ec_foe_prepare_data_send(fsm)) {

   402

            ec_foe_set_tx_error(fsm, FOE_PROT_ERROR);

   403

            EC_ERR("Slave is busy.\n");

   404

            return;

   405

        }

   406

        fsm->state = ec_fsm_foe_state_data_sent;

   407

        return;

   408

    }

   409

   410

    if (opCode == EC_FOE_OPCODE_ACK) {

   411

        fsm->tx_packet_no++;

   412

        fsm->tx_buffer_offset += fsm->tx_current_size;

   413

   414

        if (fsm->tx_last_packet) {

   415

            fsm->state = ec_fsm_foe_end;

   416

            return;

   417

        }

   418

   419

        if (ec_foe_prepare_data_send(fsm)) {

   420

            ec_foe_set_tx_error(fsm, FOE_PROT_ERROR);

   421

            return;

   422

        }

   423

        fsm->state = ec_fsm_foe_state_data_sent;

   424

        return;

   425

    }

   426

    ec_foe_set_tx_error(fsm, FOE_ACK_ERROR);

   427

}

   428

   429

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

   430

/**

   431

   State: WRQ SENT.

   432

   Checks is the previous transmit datagram succeded and sends the next

   433

   fragment, if necessary.

   434

*/

   435

   436

void ec_fsm_foe_state_wrq_sent( ec_fsm_foe_t *fsm ) {

   437

    ec_datagram_t *datagram = fsm->datagram;

   438

    ec_slave_t *slave = fsm->slave;

   439

   440

#ifdef DEBUG_FOE

   441

    printk("ec_foe_state_sent_wrq()\n");

   442

#endif

   443

   444

    if (datagram->state != EC_DATAGRAM_RECEIVED) {

   445

        ec_foe_set_rx_error(fsm, FOE_RECEIVE_ERROR);

   446

        EC_ERR("Failed to send FoE WRQ for slave %u"

   447

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

   448

                slave->ring_position, datagram->state);

   449

        return;

   450

    }

   451

   452

    if (datagram->working_counter != 1) {

   453

        // slave did not put anything in the mailbox yet

   454

        ec_foe_set_rx_error(fsm, FOE_WC_ERROR);

   455

        EC_ERR("Reception of FoE WRQ failed on slave %u: ",

   456

                slave->ring_position);

   457

        ec_datagram_print_wc_error(datagram);

   458

        return;

   459

    }

   460

   461

    fsm->jiffies_start = datagram->jiffies_sent;

   462

   463

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

   464

   465

    fsm->retries = EC_FSM_RETRIES;

   466

    fsm->state = ec_fsm_foe_state_ack_check;

   467

}

   468

   469

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

   470

/**

   471

   State: WRQ SENT.

   472

   Checks is the previous transmit datagram succeded and sends the next

   473

   fragment, if necessary.

   474

*/

   475

   476

void ec_fsm_foe_state_data_sent( ec_fsm_foe_t *fsm ) {

   477

    ec_datagram_t *datagram = fsm->datagram;

   478

    ec_slave_t *slave = fsm->slave;

   479

   480

#ifdef DEBUG_FOE

   481

    printk("ec_fsm_foe_state_data_sent()\n");

   482

#endif

   483

   484

    if (fsm->datagram->state != EC_DATAGRAM_RECEIVED) {

   485

        ec_foe_set_tx_error(fsm, FOE_RECEIVE_ERROR);

   486

        EC_ERR("Failed to receive FoE ack response datagram for"

   487

               " slave %u (datagram state %u).\n",

   488

               slave->ring_position, datagram->state);

   489

        return;

   490

    }

   491

   492

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

   493

        ec_foe_set_tx_error(fsm, FOE_WC_ERROR);

   494

        EC_ERR("Reception of FoE data send failed on slave %u: ",

   495

                slave->ring_position);

   496

        ec_datagram_print_wc_error(datagram);

   497

        return;

   498

    }

   499

   500

    ec_slave_mbox_prepare_check(fsm->slave, fsm->datagram);

   501

    fsm->jiffies_start = jiffies;

   502

    fsm->retries = EC_FSM_RETRIES;

   503

    fsm->state = ec_fsm_foe_state_ack_check;

   504

}

   505

   506

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

   507

/**

   508

   Prepare a read request (RRQ) with filename

   509

*/

   510

   511

int ec_foe_prepare_rrq_send( ec_fsm_foe_t *fsm ) {

   512

    size_t current_size;

   513

    uint8_t *data;

   514