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

/** \file

    31

 * EtherCAT master state machine.

    32

 */

    33

    34

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

    35

    36

#include "globals.h"

    37

#include "master.h"

    38

#include "mailbox.h"

    39

#include "slave_config.h"

    40

#ifdef EC_EOE

    41

#include "ethernet.h"

    42

#endif

    43

    44

#include "fsm_master.h"

    45

#include "fsm_foe.h"

    46

    47

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

    48

    49

void ec_fsm_master_state_start(ec_fsm_master_t *);

    50

void ec_fsm_master_state_broadcast(ec_fsm_master_t *);

    51

void ec_fsm_master_state_read_state(ec_fsm_master_t *);

    52

void ec_fsm_master_state_acknowledge(ec_fsm_master_t *);

    53

void ec_fsm_master_state_configure_slave(ec_fsm_master_t *);

    54

void ec_fsm_master_state_clear_addresses(ec_fsm_master_t *);

    55

void ec_fsm_master_state_scan_slave(ec_fsm_master_t *);

    56

void ec_fsm_master_state_write_sii(ec_fsm_master_t *);

    57

void ec_fsm_master_state_sdo_dictionary(ec_fsm_master_t *);

    58

void ec_fsm_master_state_sdo_request(ec_fsm_master_t *);

    59

void ec_fsm_master_state_reg_request(ec_fsm_master_t *);

    60

void ec_fsm_master_state_foe_request(ec_fsm_master_t *);

    61

    62

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

    63

    64

/** Constructor.

    65

 */

    66

void ec_fsm_master_init(

    67

        ec_fsm_master_t *fsm, /**< Master state machine. */

    68

        ec_master_t *master, /**< EtherCAT master. */

    69

        ec_datagram_t *datagram /**< Datagram object to use. */

    70

        )

    71

{

    72

    fsm->master = master;

    73

    fsm->datagram = datagram;

    74

    fsm->state = ec_fsm_master_state_start;

    75

    fsm->idle = 0;

    76

    fsm->slaves_responding = 0;

    77

    fsm->topology_change_pending = 0;

    78

    fsm->slave_states = EC_SLAVE_STATE_UNKNOWN;

    79

    80

    // init sub-state-machines

    81

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

    82

    ec_fsm_foe_init(&fsm->fsm_foe, fsm->datagram);

    83

    ec_fsm_pdo_init(&fsm->fsm_pdo, &fsm->fsm_coe);

    84

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

    85

    ec_fsm_slave_config_init(&fsm->fsm_slave_config, fsm->datagram,

    86

            &fsm->fsm_change, &fsm->fsm_coe, &fsm->fsm_pdo);

    87

    ec_fsm_slave_scan_init(&fsm->fsm_slave_scan, fsm->datagram,

    88

            &fsm->fsm_slave_config, &fsm->fsm_pdo);

    89

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

    90

}

    91

    92

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

    93

    94

/** Destructor.

    95

 */

    96

void ec_fsm_master_clear(

    97

        ec_fsm_master_t *fsm /**< Master state machine. */

    98

        )

    99

{

   100

    // clear sub-state machines

   101

    ec_fsm_coe_clear(&fsm->fsm_coe);

   102

    ec_fsm_foe_clear(&fsm->fsm_foe);

   103

    ec_fsm_pdo_clear(&fsm->fsm_pdo);

   104

    ec_fsm_change_clear(&fsm->fsm_change);

   105

    ec_fsm_slave_config_clear(&fsm->fsm_slave_config);

   106

    ec_fsm_slave_scan_clear(&fsm->fsm_slave_scan);

   107

    ec_fsm_sii_clear(&fsm->fsm_sii);

   108

}

   109

   110

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

   111

   112

/** Executes the current state of the state machine.

   113

 *

   114

 * If the state machine's datagram is not sent or received yet, the execution

   115

 * of the state machine is delayed to the next cycle.

   116

 */

   117

void ec_fsm_master_exec(

   118

        ec_fsm_master_t *fsm /**< Master state machine. */

   119

        )

   120

{

   121

    if (fsm->datagram->state == EC_DATAGRAM_SENT

   122

        || fsm->datagram->state == EC_DATAGRAM_QUEUED) {

   123

        // datagram was not sent or received yet.

   124

        return;

   125

    }

   126

   127

    fsm->state(fsm);

   128

}

   129

   130

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

   131

   132

/**

   133

 * \return true, if the state machine is in an idle phase

   134

 */

   135

int ec_fsm_master_idle(

   136

        const ec_fsm_master_t *fsm /**< Master state machine. */

   137

        )

   138

{

   139

    return fsm->idle;

   140

}

   141

   142

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

   143

   144

/** Restarts the master state machine.

   145

 */

   146

void ec_fsm_master_restart(

   147

        ec_fsm_master_t *fsm /**< Master state machine. */

   148

        )

   149

{

   150

    fsm->state = ec_fsm_master_state_start;

   151

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

   152

}

   153

   154

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

   155

 * Master state machine

   156

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

   157

   158

/** Master state: START.

   159

 *

   160

 * Starts with getting slave count and slave states.

   161

 */

   162

void ec_fsm_master_state_start(

   163

        ec_fsm_master_t *fsm /**< Master state machine. */

   164

        )

   165

{

   166

    fsm->idle = 1;

   167

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

   168

    ec_datagram_zero(fsm->datagram);

   169

    fsm->state = ec_fsm_master_state_broadcast;

   170

}

   171

   172

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

   173

   174

/** Master state: BROADCAST.

   175

 *

   176

 * Processes the broadcast read slave count and slaves states.

   177

 */

   178

void ec_fsm_master_state_broadcast(

   179

        ec_fsm_master_t *fsm /**< Master state machine. */

   180

        )

   181

{

   182

    ec_datagram_t *datagram = fsm->datagram;

   183

    unsigned int i, size;

   184

    ec_slave_t *slave;

   185

    ec_master_t *master = fsm->master;

   186

   187

    if (datagram->state == EC_DATAGRAM_TIMED_OUT)

   188

        return; // always retry

   189

   190

    // bus topology change?

   191

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

   192

        fsm->topology_change_pending = 1;

   193

        fsm->slaves_responding = datagram->working_counter;

   194

        EC_INFO("%u slave(s) responding.\n", fsm->slaves_responding);

   195

    }

   196

   197

    if (datagram->state != EC_DATAGRAM_RECEIVED) { // link is down

   198

        ec_fsm_master_restart(fsm);

   199

        return;

   200

    }

   201

   202

    if (fsm->slaves_responding) {

   203

        uint8_t states = EC_READ_U8(datagram->data);

   204

        if (states != fsm->slave_states) { // slave states changed?

   205

            char state_str[EC_STATE_STRING_SIZE];

   206

            fsm->slave_states = states;

   207

            ec_state_string(fsm->slave_states, state_str, 1);

   208

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

   209

        }

   210

    } else {

   211

        fsm->slave_states = 0x00;

   212

    }

   213

   214

    if (fsm->topology_change_pending) {

   215

        down(&master->scan_sem);

   216

        if (!master->allow_scan) {

   217

            up(&master->scan_sem);

   218

        } else {

   219

            master->scan_busy = 1;

   220

            up(&master->scan_sem);

   221

   222

            // topology change when scan is allowed:

   223

            // clear all slaves and scan the bus

   224

            fsm->topology_change_pending = 0;

   225

            fsm->idle = 0;

   226

            fsm->scan_jiffies = jiffies;

   227

   228

#ifdef EC_EOE

   229

            ec_master_eoe_stop(master);

   230

            ec_master_clear_eoe_handlers(master);

   231

#endif

   232

            ec_master_clear_slaves(master);

   233

   234

            master->slave_count = fsm->slaves_responding;

   235

   236

            if (!master->slave_count) {

   237

                // no slaves present -> finish state machine.

   238

                master->scan_busy = 0;

   239

                wake_up_interruptible(&master->scan_queue);

   240

                ec_fsm_master_restart(fsm);

   241

                return;

   242

            }

   243

   244

            size = sizeof(ec_slave_t) * master->slave_count;

   245

            if (!(master->slaves = (ec_slave_t *) kmalloc(size, GFP_KERNEL))) {

   246

                EC_ERR("Failed to allocate %u bytes of slave memory!\n",

   247

                        size);

   248

                master->slave_count = 0; // TODO avoid retrying scan!

   249

                master->scan_busy = 0;

   250

                wake_up_interruptible(&master->scan_queue);

   251

                ec_fsm_master_restart(fsm);

   252

                return;

   253

            }

   254

   255

            // init slaves

   256

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

   257

                slave = master->slaves + i;

   258

                ec_slave_init(slave, master, i, i + 1);

   259

   260

                // do not force reconfiguration in operation phase to avoid

   261

                // unnecesssary process data interruptions

   262

                if (master->phase != EC_OPERATION)

   263

                    slave->force_config = 1;

   264

            }

   265

   266

            // broadcast clear all station addresses

   267

            ec_datagram_bwr(datagram, 0x0010, 2);

   268

            EC_WRITE_U16(datagram->data, 0x0000);

   269

            fsm->retries = EC_FSM_RETRIES;

   270

            fsm->state = ec_fsm_master_state_clear_addresses;

   271

            return;

   272

        }

   273

    }

   274

   275

    if (master->slave_count) {

   276

        // fetch state from first slave

   277

        fsm->slave = master->slaves;

   278

        ec_datagram_fprd(fsm->datagram, fsm->slave->station_address,

   279

                0x0130, 2);

   280

        ec_datagram_zero(datagram);

   281

        fsm->retries = EC_FSM_RETRIES;

   282

        fsm->state = ec_fsm_master_state_read_state;

   283

    } else {

   284

        ec_fsm_master_restart(fsm);

   285

    }

   286

}

   287

   288

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

   289

   290

/** Check for pending SII write requests and process one.

   291

 *

   292

 * \return non-zero, if an SII write request is processed.

   293

 */

   294

int ec_fsm_master_action_process_sii(

   295

        ec_fsm_master_t *fsm /**< Master state machine. */

   296

        )

   297

{

   298

    ec_master_t *master = fsm->master;

   299

    ec_sii_write_request_t *request;

   300

   301

    // search the first request to be processed

   302

    while (1) {

   303

        if (list_empty(&master->sii_requests))

   304

            break;

   305

   306

        // get first request

   307

        request = list_entry(master->sii_requests.next,

   308

                ec_sii_write_request_t, list);

   309

        list_del_init(&request->list); // dequeue

   310

        request->state = EC_INT_REQUEST_BUSY;

   311

   312

        // found pending SII write operation. execute it!

   313

        if (master->debug_level)

   314

            EC_DBG("Writing SII data to slave %u...\n",

   315

                    request->slave->ring_position);

   316

        fsm->sii_request = request;

   317

        fsm->sii_index = 0;

   318

        ec_fsm_sii_write(&fsm->fsm_sii, request->slave, request->offset,

   319

                request->words, EC_FSM_SII_USE_CONFIGURED_ADDRESS);

   320

        fsm->state = ec_fsm_master_state_write_sii;

   321

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

   322

        return 1;

   323

    }

   324

   325

    return 0;

   326

}

   327

   328

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

   329

   330

/** Check for pending register requests and process one.

   331

 * 

   332

 * \return non-zero, if a register request is processed.

   333

 */

   334

int ec_fsm_master_action_process_register(

   335

        ec_fsm_master_t *fsm /**< Master state machine. */

   336

        )

   337

{

   338

    ec_master_t *master = fsm->master;

   339

    ec_reg_request_t *request;

   340

   341

    // search the first request to be processed

   342

    while (!list_empty(&master->reg_requests)) {

   343

   344

        // get first request

   345

        request = list_entry(master->reg_requests.next,

   346

                ec_reg_request_t, list);

   347

        list_del_init(&request->list); // dequeue

   348

        request->state = EC_INT_REQUEST_BUSY;

   349

   350

        // found pending request; process it!

   351

        if (master->debug_level)

   352

            EC_DBG("Processing register request for slave %u, "

   353

                    "offset 0x%04x, length %u...\n",

   354

                    request->slave->ring_position,

   355

                    request->offset, request->length);

   356

   357

        if (request->length > fsm->datagram->mem_size) {

   358

            EC_ERR("Request length (%u) exceeds maximum "

   359

                    "datagram size (%u)!\n", request->length,

   360

                    fsm->datagram->mem_size);

   361

            request->state = EC_INT_REQUEST_FAILURE;

   362

            wake_up(&master->reg_queue);

   363

            continue;

   364

        }

   365

   366

        fsm->reg_request = request;

   367

   368

        if (request->dir == EC_DIR_INPUT) {

   369

            ec_datagram_fprd(fsm->datagram, request->slave->station_address,

   370

                    request->offset, request->length);

   371

            ec_datagram_zero(fsm->datagram);

   372

        } else {

   373

            ec_datagram_fpwr(fsm->datagram, request->slave->station_address,

   374

                    request->offset, request->length);

   375

            memcpy(fsm->datagram->data, request->data, request->length);

   376

        }

   377

        fsm->retries = EC_FSM_RETRIES;

   378

        fsm->state = ec_fsm_master_state_reg_request;

   379

        return 1;

   380

    }

   381

   382

    return 0;

   383

}

   384

   385

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

   386

   387

/** Check for pending SDO requests and process one.

   388

 *

   389

 * \return non-zero, if an SDO request is processed.

   390

 */

   391

int ec_fsm_master_action_process_sdo(

   392

        ec_fsm_master_t *fsm /**< Master state machine. */

   393

        )

   394

{

   395

    ec_master_t *master = fsm->master;

   396

    ec_slave_t *slave;

   397

    ec_sdo_request_t *req;

   398

    ec_master_sdo_request_t *request;

   399

   400

    // search for internal requests to be processed

   401

    for (slave = master->slaves;

   402

            slave < master->slaves + master->slave_count;

   403

            slave++) {

   404

        if (!slave->config)

   405

            continue;

   406

        list_for_each_entry(req, &slave->config->sdo_requests, list) {

   407

            if (req->state == EC_INT_REQUEST_QUEUED) {

   408

   409

                if (ec_sdo_request_timed_out(req)) {

   410

                    req->state = EC_INT_REQUEST_FAILURE;

   411

                    if (master->debug_level)

   412

                        EC_DBG("SDO request for slave %u timed out...\n",

   413

                                slave->ring_position);

   414

                    continue;

   415

                }

   416

   417

                if (slave->current_state == EC_SLAVE_STATE_INIT) {

   418

                    req->state = EC_INT_REQUEST_FAILURE;

   419

                    continue;

   420

                }

   421

   422

                req->state = EC_INT_REQUEST_BUSY;

   423

                if (master->debug_level)

   424

                    EC_DBG("Processing SDO request for slave %u...\n",

   425

                            slave->ring_position);

   426

   427

                fsm->idle = 0;

   428

                fsm->sdo_request = req;

   429

                fsm->slave = slave;

   430

                fsm->state = ec_fsm_master_state_sdo_request;

   431

                ec_fsm_coe_transfer(&fsm->fsm_coe, slave, req);

   432

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

   433

                return 1;

   434

            }

   435

        }

   436

    }

   437

   438

    // search the first external request to be processed

   439

    while (1) {

   440

        if (list_empty(&master->slave_sdo_requests))

   441

            break;

   442

   443

        // get first request

   444

        request = list_entry(master->slave_sdo_requests.next,

   445

                ec_master_sdo_request_t, list);

   446

        list_del_init(&request->list); // dequeue

   447

        request->req.state = EC_INT_REQUEST_BUSY;

   448

   449

        slave = request->slave;

   450

        if (slave->current_state == EC_SLAVE_STATE_INIT) {

   451

            EC_ERR("Discarding SDO request, slave %u is in INIT.\n",

   452

                    slave->ring_position);

   453

            request->req.state = EC_INT_REQUEST_FAILURE;

   454

            wake_up(&master->sdo_queue);

   455

            continue;

   456

        }

   457

   458

        // Found pending SDO request. Execute it!

   459

        if (master->debug_level)

   460

            EC_DBG("Processing SDO request for slave %u...\n",

   461

                    slave->ring_position);

   462

   463

        // Start uploading SDO

   464

        fsm->idle = 0;

   465

        fsm->sdo_request = &request->req;

   466

        fsm->slave = slave;

   467

        fsm->state = ec_fsm_master_state_sdo_request;

   468

        ec_fsm_coe_transfer(&fsm->fsm_coe, slave, &request->req);

   469

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

   470

        return 1;

   471

    }

   472

   473

    return 0;

   474

}

   475

   476

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

   477

   478

/** Check for pending FoE requests and process one.

   479

 *

   480

 * \return non-zero, if an FoE request is processed.

   481

 */

   482

int ec_fsm_master_action_process_foe(

   483

        ec_fsm_master_t *fsm /**< Master state machine. */

   484