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 slave (SDO) state machine.

    32

 */

    33

    34

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

    35

    36

#include "globals.h"

    37

#include "master.h"

    38

#include "mailbox.h"

    39

    40

#include "fsm_slave.h"

    41

    42

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

    43

    44

void ec_fsm_slave_state_idle(ec_fsm_slave_t *);

    45

void ec_fsm_slave_state_ready(ec_fsm_slave_t *);

    46

int ec_fsm_slave_action_process_sdo(ec_fsm_slave_t *);

    47

int ec_fsm_slave_action_process_foe(ec_fsm_slave_t *);

    48

void ec_fsm_slave_state_sdo_request(ec_fsm_slave_t *);

    49

void ec_fsm_slave_state_foe_request(ec_fsm_slave_t *);

    50

    51

    52

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

    53

    54

/** Constructor.

    55

 */

    56

void ec_fsm_slave_init(

    57

        ec_fsm_slave_t *fsm, /**< Slave state machine. */

    58

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

    59

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

    60

        )

    61

{

    62

    fsm->slave = slave;

    63

    fsm->datagram = datagram;

    64

    fsm->datagram->data_size = 0;

    65

    66

    if (slave->master->debug_level)

    67

        EC_DBG("Init FSM for slave %u...\n", slave->ring_position);

    68

    69

    fsm->state = ec_fsm_slave_state_idle;

    70

    71

    // init sub-state-machines

    72

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

    73

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

    74

}

    75

    76

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

    77

    78

/** Destructor.

    79

 */

    80

void ec_fsm_slave_clear(

    81

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

    82

        )

    83

{

    84

    // clear sub-state machines

    85

    ec_fsm_coe_clear(&fsm->fsm_coe);

    86

    ec_fsm_foe_clear(&fsm->fsm_foe);

    87

}

    88

    89

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

    90

    91

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

    92

 *

    93

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

    94

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

    95

 */

    96

void ec_fsm_slave_exec(

    97

        ec_fsm_slave_t *fsm /**< Slave state machine. */

    98

        )

    99

{

   100

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

   101

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

   102

        // datagram was not sent or received yet.

   103

        return;

   104

    }

   105

   106

    fsm->state(fsm);

   107

    return;

   108

}

   109

   110

   111

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

   112

   113

/** Sets the current state of the state machine to READY

   114

 *

   115

 */

   116

void ec_fsm_slave_ready(

   117

        ec_fsm_slave_t *fsm /**< Slave state machine. */

   118

        )

   119

{

   120

    if (fsm->state == ec_fsm_slave_state_idle) {

   121

        if (fsm->slave->master->debug_level) {

   122

            EC_DBG("Slave %u ready for SDO/FOE.\n",

   123

                    fsm->slave->ring_position);

   124

        }

   125

        fsm->state = ec_fsm_slave_state_ready;

   126

    }

   127

    return;

   128

}

   129

   130

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

   131

 * Slave state machine

   132

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

   133

   134

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

   135

   136

/** Slave state: IDLE.

   137

 *

   138

 *

   139

 */

   140

void ec_fsm_slave_state_idle(

   141

        ec_fsm_slave_t *fsm /**< Slave state machine. */

   142

        )

   143

{

   144

    // do nothing

   145

}

   146

   147

   148

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

   149

   150

/** Slave state: READY.

   151

 *

   152

 *

   153

 */

   154

void ec_fsm_slave_state_ready(

   155

        ec_fsm_slave_t *fsm /**< Slave state machine. */

   156

        )

   157

{

   158

    // Check for pending external SDO requests

   159

    if (ec_fsm_slave_action_process_sdo(fsm))

   160

        return;

   161

   162

    // Check for pending FOE requests

   163

    if (ec_fsm_slave_action_process_foe(fsm))

   164

        return;

   165

}

   166

   167

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

   168

   169

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

   170

 *

   171

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

   172

 */

   173

int ec_fsm_slave_action_process_sdo(

   174

        ec_fsm_slave_t *fsm /**< Slave state machine. */

   175

        )

   176

{

   177

    ec_slave_t *slave = fsm->slave;

   178

    ec_master_t *master = slave->master;

   179

    ec_master_sdo_request_t *request, *next;

   180

   181

    // search the first external request to be processed

   182

    list_for_each_entry_safe(request, next, &slave->slave_sdo_requests, list) {

   183

   184

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

   185

        if (slave->current_state & EC_SLAVE_STATE_ACK_ERR) {

   186

            EC_WARN("Aborting SDO request, slave %u has ERROR.\n",

   187

                    slave->ring_position);

   188

            request->req.state = EC_INT_REQUEST_FAILURE;

   189

            wake_up(&slave->sdo_queue);

   190

            fsm->sdo_request = NULL;

   191

            fsm->state = ec_fsm_slave_state_idle;

   192

            return 0;

   193

        }

   194

   195

        if (slave->current_state == EC_SLAVE_STATE_INIT) {

   196

            EC_WARN("Aborting SDO request, slave %u is in INIT.\n",

   197

                    slave->ring_position);

   198

            request->req.state = EC_INT_REQUEST_FAILURE;

   199

            wake_up(&slave->sdo_queue);

   200

            fsm->sdo_request = NULL;

   201

            fsm->state = ec_fsm_slave_state_idle;

   202

            return 0;

   203

        }

   204

   205

        request->req.state = EC_INT_REQUEST_BUSY;

   206

   207

        // Found pending SDO request. Execute it!

   208

        if (master->debug_level)

   209

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

   210

                    slave->ring_position);

   211

   212

        // Start SDO transfer

   213

        fsm->sdo_request = &request->req;

   214

        fsm->state = ec_fsm_slave_state_sdo_request;

   215

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

   216

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

   217

        ec_master_queue_external_datagram(fsm->slave->master,fsm->datagram);

   218

        return 1;

   219

    }

   220

    return 0;

   221

}

   222

   223

   224

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

   225

   226

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

   227

 *

   228

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

   229

 */

   230

int ec_fsm_slave_action_process_foe(

   231

        ec_fsm_slave_t *fsm /**< Slave state machine. */

   232

        )

   233

{

   234

    ec_slave_t *slave = fsm->slave;

   235

    ec_master_t *master = slave->master;

   236

    ec_master_foe_request_t *request, *next;

   237

   238

    // search the first request to be processed

   239

    list_for_each_entry_safe(request, next, &slave->foe_requests, list) {

   240

        if (slave->current_state & EC_SLAVE_STATE_ACK_ERR) {

   241

            EC_WARN("Aborting FOE request, slave %u has ERROR.\n",

   242

                    slave->ring_position);

   243

            request->req.state = EC_INT_REQUEST_FAILURE;

   244

            wake_up(&slave->sdo_queue);

   245

            fsm->sdo_request = NULL;

   246

            fsm->state = ec_fsm_slave_state_idle;

   247

            return 0;

   248

        }

   249

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

   250

        request->req.state = EC_INT_REQUEST_BUSY;

   251

   252

        if (master->debug_level)

   253

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

   254

                    slave->ring_position);

   255

   256

        fsm->foe_request = &request->req;

   257

        fsm->state = ec_fsm_slave_state_foe_request;

   258

        ec_fsm_foe_transfer(&fsm->fsm_foe, slave, &request->req);

   259

        ec_fsm_foe_exec(&fsm->fsm_foe);

   260

        ec_master_queue_external_datagram(fsm->slave->master,fsm->datagram);

   261

        return 1;

   262

    }

   263

    return 0;

   264

}

   265

   266

   267

   268

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

   269

   270

/** Slave state: SDO_REQUEST.

   271

 */

   272

void ec_fsm_slave_state_sdo_request(

   273

        ec_fsm_slave_t *fsm /**< Slave state machine. */

   274

        )

   275

{

   276

    ec_slave_t *slave = fsm->slave;

   277

    ec_master_t *master = slave->master;

   278

    ec_sdo_request_t *request = fsm->sdo_request;

   279

   280

    if (ec_fsm_coe_exec(&fsm->fsm_coe))

   281

    {

   282

        ec_master_queue_external_datagram(fsm->slave->master,fsm->datagram);

   283

        return;

   284

    }

   285

    if (!ec_fsm_coe_success(&fsm->fsm_coe)) {

   286

        EC_DBG("Failed to process SDO request for slave %u.\n",

   287

                fsm->slave->ring_position);

   288

        request->state = EC_INT_REQUEST_FAILURE;

   289

        wake_up(&slave->sdo_queue);

   290

        fsm->sdo_request = NULL;

   291

        fsm->state = ec_fsm_slave_state_idle;

   292

        return;

   293

    }

   294

   295

    if (master->debug_level)

   296

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

   297

                fsm->slave->ring_position);

   298

   299

    // SDO request finished

   300

    request->state = EC_INT_REQUEST_SUCCESS;

   301

    wake_up(&slave->sdo_queue);

   302

   303

    fsm->sdo_request = NULL;

   304

    fsm->state = ec_fsm_slave_state_ready;

   305

}

   306

   307

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

   308

   309

/** Slave state: FOE REQUEST.

   310

 */

   311

void ec_fsm_slave_state_foe_request(

   312

        ec_fsm_slave_t *fsm /**< Slave state machine. */

   313

        )

   314

{

   315

    ec_slave_t *slave = fsm->slave;

   316

    ec_master_t *master = slave->master;

   317

    ec_foe_request_t *request = fsm->foe_request;

   318

   319

    if (ec_fsm_foe_exec(&fsm->fsm_foe))

   320

    {

   321

        ec_master_queue_external_datagram(fsm->slave->master,fsm->datagram);

   322

        return;

   323

    }

   324

   325

    if (!ec_fsm_foe_success(&fsm->fsm_foe)) {

   326

        EC_ERR("Failed to handle FoE request to slave %u.\n",

   327

                slave->ring_position);

   328

        request->state = EC_INT_REQUEST_FAILURE;

   329

        wake_up(&slave->foe_queue);

   330

        fsm->foe_request = NULL;

   331

        fsm->state = ec_fsm_slave_state_idle;

   332

        return;

   333

    }

   334

   335

    // finished transferring FoE

   336

    if (master->debug_level)

   337

        EC_DBG("Successfully transferred %u bytes of FoE data from/to"

   338

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

   339

   340

    request->state = EC_INT_REQUEST_SUCCESS;

   341

    wake_up(&slave->foe_queue);

   342

   343

    fsm->foe_request = NULL;

   344

    fsm->state = ec_fsm_slave_state_ready;

   345

}

   346

   347

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