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

/** \file

    35

 * EtherCAT master state machine.

    36

 */

    37

    38

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

    39

    40

#include "globals.h"

    41

#include "master.h"

    42

#include "mailbox.h"

    43

#include "slave_config.h"

    44

#ifdef EC_EOE

    45

#include "ethernet.h"

    46

#endif

    47

    48

#include "fsm_master.h"

    49

    50

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

    51

    52

void ec_fsm_master_state_start(ec_fsm_master_t *);

    53

void ec_fsm_master_state_broadcast(ec_fsm_master_t *);

    54

void ec_fsm_master_state_read_state(ec_fsm_master_t *);

    55

void ec_fsm_master_state_acknowledge(ec_fsm_master_t *);

    56

void ec_fsm_master_state_configure_slave(ec_fsm_master_t *);

    57

void ec_fsm_master_state_clear_addresses(ec_fsm_master_t *);

    58

void ec_fsm_master_state_scan_slave(ec_fsm_master_t *);

    59

void ec_fsm_master_state_write_sii(ec_fsm_master_t *);

    60

void ec_fsm_master_state_sdo_dictionary(ec_fsm_master_t *);

    61

void ec_fsm_master_state_sdo_request(ec_fsm_master_t *);

    62

void ec_fsm_master_state_end(ec_fsm_master_t *);

    63

void ec_fsm_master_state_error(ec_fsm_master_t *);

    64

    65

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

    66

    67

/** Constructor.

    68

 */

    69

void ec_fsm_master_init(

    70

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

    71

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

    72

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

    73

        )

    74

{

    75

    fsm->master = master;

    76

    fsm->datagram = datagram;

    77

    fsm->state = ec_fsm_master_state_start;

    78

    fsm->idle = 0;

    79

    fsm->slaves_responding = 0;

    80

    fsm->topology_change_pending = 0;

    81

    fsm->slave_states = EC_SLAVE_STATE_UNKNOWN;

    82

    83

    // init sub-state-machines

    84

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

    85

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

    86

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

    87

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

    88

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

    89

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

    90

    ec_fsm_coe_map_init(&fsm->fsm_coe_map, &fsm->fsm_coe);

    91

}

    92

    93

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

    94

    95

/** Destructor.

    96

 */

    97

void ec_fsm_master_clear(

    98

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

    99

        )

   100

{

   101

    // clear sub-state machines

   102

    ec_fsm_slave_config_clear(&fsm->fsm_slave_config);

   103

    ec_fsm_slave_scan_clear(&fsm->fsm_slave_scan);

   104

    ec_fsm_sii_clear(&fsm->fsm_sii);

   105

    ec_fsm_change_clear(&fsm->fsm_change);

   106

    ec_fsm_coe_clear(&fsm->fsm_coe);

   107

    ec_fsm_coe_map_clear(&fsm->fsm_coe_map);

   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

 * \return false, if state machine has terminated

   118

 */

   119

int ec_fsm_master_exec(

   120

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

   121

        )

   122

{

   123

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

   124

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

   125

        // datagram was not sent or received yet.

   126

        return ec_fsm_master_running(fsm);

   127

    }

   128

   129

    fsm->state(fsm);

   130

    return ec_fsm_master_running(fsm);

   131

}

   132

   133

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

   134

   135

/**

   136

 * \return false, if state machine has terminated

   137

 */

   138

int ec_fsm_master_running(

   139

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

   140

        )

   141

{

   142

    return fsm->state != ec_fsm_master_state_end

   143

        && fsm->state != ec_fsm_master_state_error;

   144

}

   145

   146

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

   147

   148

/**

   149

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

   150

 */

   151

int ec_fsm_master_idle(

   152

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

   153

        )

   154

{

   155

    return fsm->idle;

   156

}

   157

   158

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

   159

 * Master state machine

   160

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

   161

   162

/** Master state: START.

   163

 *

   164

 * Starts with getting slave count and slave states.

   165

 */

   166

void ec_fsm_master_state_start(

   167

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

   168

        )

   169

{

   170

    fsm->idle = 1;

   171

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

   172

    fsm->state = ec_fsm_master_state_broadcast;

   173

}

   174

   175

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

   176

   177

/** Master state: BROADCAST.

   178

 *

   179

 * Processes the broadcast read slave count and slaves states.

   180

 */

   181

void ec_fsm_master_state_broadcast(

   182

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

   183

        )

   184

{

   185

    ec_datagram_t *datagram = fsm->datagram;

   186

    unsigned int i, size;

   187

    ec_slave_t *slave;

   188

    ec_master_t *master = fsm->master;

   189

   190

    if (datagram->state == EC_DATAGRAM_TIMED_OUT)

   191

        return; // always retry

   192

   193

    // bus topology change?

   194

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

   195

        fsm->topology_change_pending = 1;

   196

        fsm->slaves_responding = datagram->working_counter;

   197

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

   198

    }

   199

   200

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

   201

        fsm->state = ec_fsm_master_state_error;

   202

        return;

   203

    }

   204

   205

    if (fsm->slaves_responding) {

   206

        uint8_t states = EC_READ_U8(datagram->data);

   207

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

   208

            char state_str[EC_STATE_STRING_SIZE];

   209

            fsm->slave_states = states;

   210

            ec_state_string(fsm->slave_states, state_str);

   211

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

   212

        }

   213

    } else {

   214

        fsm->slave_states = 0x00;

   215

    }

   216

   217

    if (fsm->topology_change_pending) {

   218

        down(&master->scan_sem);

   219

        if (!master->allow_scan) {

   220

            up(&master->scan_sem);

   221

        } else {

   222

            master->scan_busy = 1;

   223

            up(&master->scan_sem);

   224

   225

            // topology change when scan is allowed:

   226

            // clear all slaves and scan the bus

   227

            fsm->topology_change_pending = 0;

   228

            fsm->idle = 0;

   229

            fsm->scan_jiffies = jiffies;

   230

   231

#ifdef EC_EOE

   232

            ec_master_eoe_stop(master);

   233

            ec_master_clear_eoe_handlers(master);

   234

#endif

   235

            ec_master_clear_slaves(master);

   236

            master->configs_attached = 0;

   237

   238

            master->slave_count = fsm->slaves_responding;

   239

   240

            if (!master->slave_count) {

   241

                // no slaves present -> finish state machine.

   242

                master->scan_busy = 0;

   243

                wake_up_interruptible(&master->scan_queue);

   244

                fsm->state = ec_fsm_master_state_end;

   245

                return;

   246

            }

   247

   248

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

   249

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

   250

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

   251

                        size);

   252

                master->slave_count = 0; // FIXME avoid scanning!

   253

                master->scan_busy = 0;

   254

                wake_up_interruptible(&master->scan_queue);

   255

                fsm->state = ec_fsm_master_state_error;

   256

                return;

   257

            }

   258

   259

            // init slaves

   260

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

   261

                slave = master->slaves + i;

   262

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

   263

   264

                // do not force reconfiguration in operation mode to avoid

   265

                // unnecesssary process data interruptions

   266

                if (master->mode != EC_MASTER_MODE_OPERATION)

   267

                    slave->force_config = 1;

   268

            }

   269

   270

            // broadcast clear all station addresses

   271

            ec_datagram_bwr(datagram, 0x0010, 2);

   272

            EC_WRITE_U16(datagram->data, 0x0000);

   273

            fsm->retries = EC_FSM_RETRIES;

   274

            fsm->state = ec_fsm_master_state_clear_addresses;

   275

            return;

   276

        }

   277

    }

   278

   279

    if (master->slave_count) {

   280

        // fetch state from first slave

   281

        fsm->slave = master->slaves;

   282

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

   283

                0x0130, 2);

   284

        fsm->retries = EC_FSM_RETRIES;

   285

        fsm->state = ec_fsm_master_state_read_state;

   286

    } else {

   287

        fsm->state = ec_fsm_master_state_end;

   288

    }

   289

}

   290

   291

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

   292

   293

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

   294

 * 

   295

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

   296

 */

   297

int ec_fsm_master_action_process_sii(

   298

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

   299

        )

   300

{

   301

    ec_master_t *master = fsm->master;

   302

    ec_sii_write_request_t *request;

   303

   304

    // search the first request to be processed

   305

    while (1) {

   306

        down(&master->sii_sem);

   307

        if (list_empty(&master->sii_requests)) {

   308

            up(&master->sii_sem);

   309

            break;

   310

        }

   311

        // get first request

   312

        request = list_entry(master->sii_requests.next,

   313

                ec_sii_write_request_t, list);

   314

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

   315

        request->state = EC_REQUEST_BUSY;

   316

        up(&master->sii_sem);

   317

   318

        // found pending SII write operation. execute it!

   319

        if (master->debug_level)

   320

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

   321

                    request->slave->ring_position);

   322

        fsm->sii_request = request;

   323

        fsm->sii_index = 0;

   324

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

   325

                request->words, EC_FSM_SII_USE_CONFIGURED_ADDRESS);

   326

        fsm->state = ec_fsm_master_state_write_sii;

   327

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

   328

        return 1;

   329

    }

   330

   331

    return 0;

   332

}

   333

   334

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

   335

   336

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

   337

 * 

   338

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

   339

 */

   340

int ec_fsm_master_action_process_sdo(

   341

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

   342

        )

   343

{

   344

    ec_master_t *master = fsm->master;

   345

    ec_slave_t *slave;

   346

    ec_sdo_request_t *req;

   347

    ec_master_sdo_request_t *request;

   348

   349

    // search for internal requests to be processed

   350

    for (slave = master->slaves;

   351

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

   352

            slave++) {

   353

        if (!slave->config)

   354

            continue;

   355

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

   356

            if (req->state == EC_REQUEST_QUEUED) {

   357

   358

                if (ec_sdo_request_timed_out(req)) {

   359

                    req->state = EC_REQUEST_FAILURE;

   360

                    if (master->debug_level)

   361

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

   362

                                slave->ring_position);

   363

                    continue;

   364

                }

   365

   366

                if (slave->current_state == EC_SLAVE_STATE_INIT) {

   367

                    req->state = EC_REQUEST_FAILURE;

   368

                    continue;

   369

                }

   370

   371

                req->state = EC_REQUEST_BUSY;

   372

                if (master->debug_level)

   373

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

   374

                            slave->ring_position);

   375

   376

                fsm->idle = 0;

   377

                fsm->sdo_request = req;

   378

                fsm->slave = slave;

   379

                fsm->state = ec_fsm_master_state_sdo_request;

   380

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

   381

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

   382

                return 1;

   383

            }

   384

        }

   385

    }

   386

   387

    // search the first external request to be processed

   388

    while (1) {

   389

        down(&master->sdo_sem);

   390

        if (list_empty(&master->slave_sdo_requests)) {

   391

            up(&master->sdo_sem);

   392

            break;

   393

        }

   394

        // get first request

   395

        request = list_entry(master->slave_sdo_requests.next,

   396

                ec_master_sdo_request_t, list);

   397

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

   398

        request->req.state = EC_REQUEST_BUSY;

   399

        up(&master->sdo_sem);

   400

   401

        slave = request->slave;

   402

        if (slave->current_state == EC_SLAVE_STATE_INIT) {

   403

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

   404

                    slave->ring_position);

   405

            request->req.state = EC_REQUEST_FAILURE;

   406

            wake_up(&master->sdo_queue);

   407

            continue;

   408

        }

   409

   410

        // Found pending Sdo request. Execute it!

   411

        if (master->debug_level)

   412

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

   413

                    slave->ring_position);

   414

   415

        // Start uploading Sdo

   416

        fsm->idle = 0;

   417

        fsm->sdo_request = &request->req;

   418

        fsm->slave = slave;

   419

        fsm->state = ec_fsm_master_state_sdo_request;

   420

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

   421

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

   422

        return 1;

   423

    }

   424

   425

    return 0;

   426

}

   427

   428

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

   429

   430

/** Master action: IDLE.

   431

 *

   432

 * Does secondary work.

   433

 */

   434

void ec_fsm_master_action_idle(

   435

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

   436

        )

   437

{

   438

    ec_master_t *master = fsm->master;

   439

    ec_slave_t *slave;

   440

   441

    // Check for pending Sdo requests

   442

    if (ec_fsm_master_action_process_sdo(fsm))

   443

        return;

   444

   445

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

   446

    for (slave = master->slaves;

   447

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

   448

            slave++) {

   449

        if (!(slave->sii.mailbox_protocols & EC_MBOX_COE)

   450

                || slave->sdo_dictionary_fetched

   451

                || slave->current_state == EC_SLAVE_STATE_INIT

   452

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

   453

                ) continue;

   454

   455

        if (master->debug_level) {

   456

            EC_DBG("Fetching Sdo dictionary from slave %u.\n",

   457

                    slave->ring_position);

   458

        }

   459

   460

        slave->sdo_dictionary_fetched = 1;

   461

   462

        // start fetching Sdo dictionary

   463

        fsm->idle = 0;

   464

        fsm->slave = slave;

   465

        fsm->state = ec_fsm_master_state_sdo_dictionary;

   466

        ec_fsm_coe_dictionary(&fsm->fsm_coe, slave);

   467

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

   468

        return;

   469

    }

   470

   471

    // check for pending SII write operations.

   472

    if (ec_fsm_master_action_process_sii(fsm))

   473

        return; // SII write request found

   474

   475

    fsm->state = ec_fsm_master_state_end;

   476

}

   477

   478

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

   479

   480

/** Master action: Get state of next slave.

   481

 */

   482

void ec_fsm_master_action_next_slave_state(

   483

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

   484

        )

   485

{

   486

    ec_master_t *master = fsm->master;

   487