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

	if (slave->master->debug_level)

    66

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

    67

	fsm->state = ec_fsm_slave_state_idle;

    68

    69

    // init sub-state-machines

    70

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

    71

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

    72

}

    73

    74

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

    75

    76

/** Destructor.

    77

 */

    78

void ec_fsm_slave_clear(

    79

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

    80

        )

    81

{

    82

    // clear sub-state machines

    83

    ec_fsm_coe_clear(&fsm->fsm_coe);

    84

    ec_fsm_foe_clear(&fsm->fsm_foe);

    85

}

    86

    87

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

    88

    89

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

    90

 *

    91

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

    92

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

    93

 */

    94

void ec_fsm_slave_exec(

    95

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

    96

        )

    97

{

    98

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

    99

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

   100

        // datagram was not sent or received yet.

   101

        return;

   102

    }

   103

   104

    fsm->state(fsm);

   105

    return;

   106

}

   107

   108

   109

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

   110

   111

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

   112

 *

   113

 */

   114

void ec_fsm_slave_ready(

   115

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

   116

		)

   117

{

   118

	if (fsm->state == ec_fsm_slave_state_idle) {

   119

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

   120

			EC_DBG("Slave %u ready for SDO/FOE.\n",fsm->slave->ring_position);

   121

		}

   122

		fsm->state = ec_fsm_slave_state_ready;

   123

	}

   124

	return;

   125

}

   126

   127

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

   128

 * Slave state machine

   129

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

   130

   131

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

   132

   133

/** Slave state: IDLE.

   134

 *

   135

 *

   136

 */

   137

void ec_fsm_slave_state_idle(

   138

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

   139

        )

   140

{

   141

	// do nothing

   142

}

   143

   144

   145

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

   146

   147

/** Slave state: READY.

   148

 *

   149

 *

   150

 */

   151

void ec_fsm_slave_state_ready(

   152

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

   153

		)

   154

{

   155

	// Check for pending external SDO requests

   156

	if (ec_fsm_slave_action_process_sdo(fsm))

   157

		return;

   158

	// Check for pending FOE requests

   159

	if (ec_fsm_slave_action_process_foe(fsm))

   160

		return;

   161

   162

}

   163

   164

   165

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

   166

   167

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

   168

 *

   169

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

   170

 */

   171

int ec_fsm_slave_action_process_sdo(

   172

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

   173

        )

   174

{

   175

    ec_slave_t *slave = fsm->slave;

   176

    ec_master_t *master = slave->master;

   177

    ec_master_sdo_request_t *request, *next;

   178

   179

    // search the first external request to be processed

   180

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

   181

   182

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

   183

		if (slave->current_state & EC_SLAVE_STATE_ACK_ERR) {

   184

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

   185

					slave->ring_position);

   186

			request->req.state = EC_INT_REQUEST_FAILURE;

   187

			wake_up(&slave->sdo_queue);

   188

			fsm->sdo_request = NULL;

   189

			fsm->state = ec_fsm_slave_state_idle;

   190

			return 0;

   191

		}

   192

		if (slave->current_state == EC_SLAVE_STATE_INIT) {

   193

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

   194

					slave->ring_position);

   195

			request->req.state = EC_INT_REQUEST_FAILURE;

   196

			wake_up(&slave->sdo_queue);

   197

			fsm->sdo_request = NULL;

   198

			fsm->state = ec_fsm_slave_state_idle;

   199

			return 0;

   200

		}

   201

		request->req.state = EC_INT_REQUEST_BUSY;

   202

   203

        // Found pending SDO request. Execute it!

   204

        if (master->debug_level)

   205

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

   206

                    slave->ring_position);

   207

   208

        // Start SDO transfer

   209

        fsm->sdo_request = &request->req;

   210

        fsm->state = ec_fsm_slave_state_sdo_request;

   211

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

   212

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

   213

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

   214

        return 1;

   215

    }

   216

    return 0;

   217

}

   218

   219

   220

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

   221

   222

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

   223

 *

   224

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

   225

 */

   226

int ec_fsm_slave_action_process_foe(

   227

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

   228

        )

   229

{

   230

    ec_slave_t *slave = fsm->slave;

   231

    ec_master_t *master = slave->master;

   232

    ec_master_foe_request_t *request, *next;

   233

   234

    // search the first request to be processed

   235

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

   236

		if (slave->current_state & EC_SLAVE_STATE_ACK_ERR) {

   237

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

   238

					slave->ring_position);

   239

			request->req.state = EC_INT_REQUEST_FAILURE;

   240

			wake_up(&slave->sdo_queue);

   241

			fsm->sdo_request = NULL;

   242

			fsm->state = ec_fsm_slave_state_idle;

   243

			return 0;

   244

		}

   245

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

   246

        request->req.state = EC_INT_REQUEST_BUSY;

   247

   248

        if (master->debug_level)

   249

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

   250

                    slave->ring_position);

   251

   252

        fsm->foe_request = &request->req;

   253

        fsm->state = ec_fsm_slave_state_foe_request;

   254

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

   255

        ec_fsm_foe_exec(&fsm->fsm_foe);

   256

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

   257

        return 1;

   258

    }

   259

    return 0;

   260

}

   261

   262

   263

   264

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

   265

   266

/** Slave state: SDO_REQUEST.

   267

 */

   268

void ec_fsm_slave_state_sdo_request(

   269

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

   270

        )

   271

{

   272

    ec_slave_t *slave = fsm->slave;

   273

    ec_master_t *master = slave->master;

   274

    ec_sdo_request_t *request = fsm->sdo_request;

   275

   276

    if (ec_fsm_coe_exec(&fsm->fsm_coe))

   277

    {

   278

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

   279

        return;

   280

    }

   281

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

   282

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

   283

                fsm->slave->ring_position);

   284

        request->state = EC_INT_REQUEST_FAILURE;

   285

		wake_up(&slave->sdo_queue);

   286

		fsm->sdo_request = NULL;

   287

		fsm->state = ec_fsm_slave_state_idle;

   288

        return;

   289

    }

   290

   291

    if (master->debug_level)

   292

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

   293

                fsm->slave->ring_position);

   294

   295

    // SDO request finished

   296

    request->state = EC_INT_REQUEST_SUCCESS;

   297

    wake_up(&slave->sdo_queue);

   298

   299

    fsm->sdo_request = NULL;

   300

	fsm->state = ec_fsm_slave_state_ready;

   301

}

   302

   303

   304

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

   305

   306

/** Slave state: FOE REQUEST.

   307

 */

   308

void ec_fsm_slave_state_foe_request(

   309

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

   310

        )

   311

{

   312

    ec_slave_t *slave = fsm->slave;

   313

    ec_master_t *master = slave->master;

   314

    ec_foe_request_t *request = fsm->foe_request;

   315

   316

    if (ec_fsm_foe_exec(&fsm->fsm_foe))

   317

    {

   318

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

   319

        return;

   320

    }

   321

   322

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

   323

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

   324

                slave->ring_position);

   325

        request->state = EC_INT_REQUEST_FAILURE;

   326

        wake_up(&slave->foe_queue);

   327

        fsm->foe_request = NULL;

   328

        fsm->state = ec_fsm_slave_state_idle;

   329

        return;

   330

    }

   331

   332

    // finished transferring FoE

   333

    if (master->debug_level)

   334

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

   335

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

   336

   337

    request->state = EC_INT_REQUEST_SUCCESS;

   338

    wake_up(&slave->foe_queue);

   339

   340

    fsm->foe_request = NULL;

   341

	fsm->state = ec_fsm_slave_state_ready;

   342

}

   343