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

    fsm->state = ec_fsm_slave_state_idle;

    66

    67

    // init sub-state-machines

    68

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

    69

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

    70

}

    71

    72

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

    73

    74

/** Destructor.

    75

 */

    76

void ec_fsm_slave_clear(

    77

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

    78

        )

    79

{

    80

    // clear sub-state machines

    81

    ec_fsm_coe_clear(&fsm->fsm_coe);

    82

    ec_fsm_foe_clear(&fsm->fsm_foe);

    83

}

    84

    85

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

    86

    87

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

    88

 *

    89

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

    90

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

    91

 */

    92

void ec_fsm_slave_exec(

    93

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

    94

        )

    95

{

    96

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

    97

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

    98

        // datagram was not sent or received yet.

    99

        return;

   100

    }

   101

   102

    fsm->state(fsm);

   103

    return;

   104

}

   105

   106

   107

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

   108

   109

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

   110

 *

   111

 */

   112

void ec_fsm_slave_ready(

   113

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

   114

		)

   115

{

   116

	if (fsm->state == ec_fsm_slave_state_idle) {

   117

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

   118

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

   119

		}

   120

		fsm->state = ec_fsm_slave_state_ready;

   121

	}

   122

	return;

   123

}

   124

   125

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

   126

 * Slave state machine

   127

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

   128

   129

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

   130

   131

/** Slave state: IDLE.

   132

 *

   133

 *

   134

 */

   135

void ec_fsm_slave_state_idle(

   136

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

   137

        )

   138

{

   139

	// do nothing

   140

}

   141

   142

   143

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

   144

   145

/** Slave state: READY.

   146

 *

   147

 *

   148

 */

   149

void ec_fsm_slave_state_ready(

   150

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

   151

		)

   152

{

   153

	// Check for pending external SDO requests

   154

	if (ec_fsm_slave_action_process_sdo(fsm))

   155

		return;

   156

	// Check for pending FOE requests

   157

	if (ec_fsm_slave_action_process_foe(fsm))

   158

		return;

   159

   160

}

   161

   162

   163

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

   164

   165

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

   166

 *

   167

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

   168

 */

   169

int ec_fsm_slave_action_process_sdo(

   170

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

   171

        )

   172

{

   173

    ec_slave_t *slave = fsm->slave;

   174

    ec_master_t *master = slave->master;

   175

    ec_master_sdo_request_t *request, *next;

   176

   177

    // search the first external request to be processed

   178

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

   179

   180

		if (slave->current_state & EC_SLAVE_STATE_ACK_ERR) {

   181

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

   182

					slave->ring_position);

   183

			fsm->state = ec_fsm_slave_state_idle;

   184

			return 0;

   185

		}

   186

		if (slave->current_state == EC_SLAVE_STATE_INIT) {

   187

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

   188

                    slave->ring_position);

   189

			fsm->state = ec_fsm_slave_state_idle;

   190

			return 0;

   191

        }

   192

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

   193

        request->req.state = EC_INT_REQUEST_BUSY;

   194

   195

        // Found pending SDO request. Execute it!

   196

        if (master->debug_level)

   197

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

   198

                    slave->ring_position);

   199

   200

        // Start SDO transfer

   201

        fsm->sdo_request = &request->req;

   202

        fsm->state = ec_fsm_slave_state_sdo_request;

   203

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

   204

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

   205

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

   206

        return 1;

   207

    }

   208

    return 0;

   209

}

   210

   211

   212

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

   213

   214

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

   215

 *

   216

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

   217

 */

   218

int ec_fsm_slave_action_process_foe(

   219

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

   220

        )

   221

{

   222

    ec_slave_t *slave = fsm->slave;

   223

    ec_master_t *master = slave->master;

   224

    ec_master_foe_request_t *request, *next;

   225

   226

    // search the first request to be processed

   227

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

   228

		if (slave->current_state & EC_SLAVE_STATE_ACK_ERR) {

   229

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

   230

					slave->ring_position);

   231

			fsm->state = ec_fsm_slave_state_idle;

   232

			return 0;

   233

		}

   234

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

   235

        request->req.state = EC_INT_REQUEST_BUSY;

   236

   237

        if (master->debug_level)

   238

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

   239

                    slave->ring_position);

   240

   241

        fsm->foe_request = &request->req;

   242

        fsm->state = ec_fsm_slave_state_foe_request;

   243

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

   244

        ec_fsm_foe_exec(&fsm->fsm_foe);

   245

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

   246

        return 1;

   247

    }

   248

    return 0;

   249

}

   250

   251

   252

   253

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

   254

   255

/** Slave state: SDO_REQUEST.

   256

 */

   257

void ec_fsm_slave_state_sdo_request(

   258

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

   259

        )

   260

{

   261

    ec_slave_t *slave = fsm->slave;

   262

    ec_master_t *master = slave->master;

   263

    ec_sdo_request_t *request = fsm->sdo_request;

   264

   265

    if (ec_fsm_coe_exec(&fsm->fsm_coe))

   266

    {

   267

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

   268

        return;

   269

    }

   270

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

   271

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

   272

                fsm->slave->ring_position);

   273

        request->state = EC_INT_REQUEST_FAILURE;

   274

        wake_up(&slave->sdo_queue);

   275

        fsm->sdo_request = NULL;

   276

        fsm->state = ec_fsm_slave_state_idle;

   277

        return;

   278

    }

   279

   280

    if (master->debug_level)

   281

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

   282

                fsm->slave->ring_position);

   283

   284

    // SDO request finished

   285

    request->state = EC_INT_REQUEST_SUCCESS;

   286

    wake_up(&slave->sdo_queue);

   287

   288

    fsm->sdo_request = NULL;

   289

	fsm->state = ec_fsm_slave_state_ready;

   290

}

   291

   292

   293

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

   294

   295

/** Slave state: FOE REQUEST.

   296

 */

   297

void ec_fsm_slave_state_foe_request(

   298

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

   299

        )

   300

{

   301

    ec_slave_t *slave = fsm->slave;

   302

    ec_master_t *master = slave->master;

   303

    ec_foe_request_t *request = fsm->foe_request;

   304

   305

    if (ec_fsm_foe_exec(&fsm->fsm_foe))

   306

    {

   307

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

   308

        return;

   309

    }

   310

   311

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

   312

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

   313

                slave->ring_position);

   314

        request->state = EC_INT_REQUEST_FAILURE;

   315

        wake_up(&slave->foe_queue);

   316

        fsm->foe_request = NULL;

   317

        fsm->state = ec_fsm_slave_state_idle;

   318

        return;

   319

    }

   320

   321

    // finished transferring FoE

   322

    if (master->debug_level)

   323

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

   324

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

   325

   326

    request->state = EC_INT_REQUEST_SUCCESS;

   327

    wake_up(&slave->foe_queue);

   328

   329

    fsm->foe_request = NULL;

   330

	fsm->state = ec_fsm_slave_state_ready;

   331

}

   332