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

/**

    35

   \file

    36

   EtherCAT slave information interface FSM.

    37

*/

    38

    39

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

    40

    41

#include "globals.h"

    42

#include "mailbox.h"

    43

#include "master.h"

    44

#include "fsm_sii.h"

    45

    46

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

    47

    48

void ec_fsm_sii_start_reading(ec_fsm_sii_t *);

    49

void ec_fsm_sii_read_check(ec_fsm_sii_t *);

    50

void ec_fsm_sii_read_fetch(ec_fsm_sii_t *);

    51

void ec_fsm_sii_start_writing(ec_fsm_sii_t *);

    52

void ec_fsm_sii_write_check(ec_fsm_sii_t *);

    53

void ec_fsm_sii_write_check2(ec_fsm_sii_t *);

    54

void ec_fsm_sii_end(ec_fsm_sii_t *);

    55

void ec_fsm_sii_error(ec_fsm_sii_t *);

    56

    57

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

    58

    59

/**

    60

   Constructor.

    61

*/

    62

    63

void ec_fsm_sii_init(ec_fsm_sii_t *fsm, /**< finite state machine */

    64

                     ec_datagram_t *datagram /**< datagram structure to use */

    65

                     )

    66

{

    67

    fsm->state = NULL;

    68

    fsm->datagram = datagram;

    69

}

    70

    71

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

    72

    73

/**

    74

   Destructor.

    75

*/

    76

    77

void ec_fsm_sii_clear(ec_fsm_sii_t *fsm /**< finite state machine */)

    78

{

    79

}

    80

    81

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

    82

    83

/**

    84

   Initializes the SII read state machine.

    85

*/

    86

    87

void ec_fsm_sii_read(ec_fsm_sii_t *fsm, /**< finite state machine */

    88

                     ec_slave_t *slave, /**< slave to read from */

    89

                     uint16_t offset, /**< offset to read from */

    90

                     ec_fsm_sii_addressing_t mode /**< addressing scheme */

    91

                     )

    92

{

    93

    fsm->state = ec_fsm_sii_start_reading;

    94

    fsm->slave = slave;

    95

    fsm->offset = offset;

    96

    fsm->mode = mode;

    97

}

    98

    99

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

   100

   101

/**

   102

   Initializes the SII write state machine.

   103

*/

   104

   105

void ec_fsm_sii_write(ec_fsm_sii_t *fsm, /**< finite state machine */

   106

                      ec_slave_t *slave, /**< slave to read from */

   107

                      uint16_t offset, /**< offset to read from */

   108

                      const uint16_t *value, /**< pointer to 2 bytes of data */

   109

                      ec_fsm_sii_addressing_t mode /**< addressing scheme */

   110

                      )

   111

{

   112

    fsm->state = ec_fsm_sii_start_writing;

   113

    fsm->slave = slave;

   114

    fsm->offset = offset;

   115

    fsm->mode = mode;

   116

    memcpy(fsm->value, value, 2);

   117

}

   118

   119

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

   120

   121

/**

   122

   Executes the SII state machine.

   123

   \return false, if the state machine has terminated

   124

*/

   125

   126

int ec_fsm_sii_exec(ec_fsm_sii_t *fsm /**< finite state machine */)

   127

{

   128

    fsm->state(fsm);

   129

   130

    return fsm->state != ec_fsm_sii_end && fsm->state != ec_fsm_sii_error;

   131

}

   132

   133

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

   134

   135

/**

   136

   Returns, if the master startup state machine terminated with success.

   137

   \return non-zero if successful.

   138

*/

   139

   140

int ec_fsm_sii_success(ec_fsm_sii_t *fsm /**< Finite state machine */)

   141

{

   142

    return fsm->state == ec_fsm_sii_end;

   143

}

   144

   145

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

   146

 *  SII state machine

   147

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

   148

   149

/**

   150

   SII state: START READING.

   151

   Starts reading the slave information interface.

   152

*/

   153

   154

void ec_fsm_sii_start_reading(ec_fsm_sii_t *fsm /**< finite state machine */)

   155

{

   156

    ec_datagram_t *datagram = fsm->datagram;

   157

   158

    // initiate read operation

   159

    switch (fsm->mode) {

   160

        case EC_FSM_SII_POSITION:

   161

            ec_datagram_apwr(datagram, fsm->slave->ring_position, 0x502, 4);

   162

            break;

   163

        case EC_FSM_SII_NODE:

   164

            ec_datagram_npwr(datagram, fsm->slave->station_address, 0x502, 4);

   165

            break;

   166

    }

   167

   168

    EC_WRITE_U8 (datagram->data,     0x00); // read-only access

   169

    EC_WRITE_U8 (datagram->data + 1, 0x01); // request read operation

   170

    EC_WRITE_U16(datagram->data + 2, fsm->offset);

   171

    fsm->retries = EC_FSM_RETRIES;

   172

    fsm->state = ec_fsm_sii_read_check;

   173

}

   174

   175

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

   176

   177

/**

   178

   SII state: READ CHECK.

   179

   Checks, if the SII-read-datagram has been sent and issues a fetch datagram.

   180

*/

   181

   182

void ec_fsm_sii_read_check(ec_fsm_sii_t *fsm /**< finite state machine */)

   183

{

   184

    ec_datagram_t *datagram = fsm->datagram;

   185

   186

    if (datagram->state == EC_DATAGRAM_TIMED_OUT && fsm->retries--)

   187

        return;

   188

   189

    if (datagram->state != EC_DATAGRAM_RECEIVED) {

   190

        fsm->state = ec_fsm_sii_error;

   191

        EC_ERR("Failed to receive SII read datagram from slave %i"

   192

                " (datagram state %i).\n",

   193

               fsm->slave->ring_position, datagram->state);

   194

        return;

   195

    }

   196

   197

    if (datagram->working_counter != 1) {

   198

        fsm->state = ec_fsm_sii_error;

   199

        EC_ERR("Reception of SII read datagram failed - slave %i did not"

   200

               " respond.\n", fsm->slave->ring_position);

   201

        return;

   202

    }

   203

   204

    fsm->cycles_start = datagram->cycles_sent;

   205

    fsm->check_once_more = 1;

   206

   207

    // issue check/fetch datagram

   208

    switch (fsm->mode) {

   209

        case EC_FSM_SII_POSITION:

   210

            ec_datagram_aprd(datagram, fsm->slave->ring_position, 0x502, 10);

   211

            break;

   212

        case EC_FSM_SII_NODE:

   213

            ec_datagram_nprd(datagram, fsm->slave->station_address, 0x502, 10);

   214

            break;

   215

    }

   216

   217

    fsm->retries = EC_FSM_RETRIES;

   218

    fsm->state = ec_fsm_sii_read_fetch;

   219

}

   220

   221

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

   222

   223

/**

   224

   SII state: READ FETCH.

   225

   Fetches the result of an SII-read datagram.

   226

*/

   227

   228

void ec_fsm_sii_read_fetch(ec_fsm_sii_t *fsm /**< finite state machine */)

   229

{

   230

    ec_datagram_t *datagram = fsm->datagram;

   231

   232

    if (datagram->state == EC_DATAGRAM_TIMED_OUT && fsm->retries--)

   233

        return;

   234

   235

    if (datagram->state != EC_DATAGRAM_RECEIVED) {

   236

        fsm->state = ec_fsm_sii_error;

   237

        EC_ERR("Failed to receive SII check/fetch datagram from slave %i"

   238

                " (datagram state %i).\n",

   239

               fsm->slave->ring_position, datagram->state);

   240

        return;

   241

    }

   242

   243

    if (datagram->working_counter != 1) {

   244

        fsm->state = ec_fsm_sii_error;

   245

        EC_ERR("Reception of SII check/fetch datagram failed - slave %i did"

   246

               " not respond\n", fsm->slave->ring_position);

   247

        return;

   248

    }

   249

   250

    // check "busy bit"

   251

    if (EC_READ_U8(datagram->data + 1) & 0x81) {

   252

        // still busy... timeout?

   253

        if (datagram->cycles_received

   254

            - fsm->cycles_start >= (cycles_t) 10 * cpu_khz) {

   255

            if (!fsm->check_once_more) {

   256

                EC_ERR("SII: Read timeout.\n");

   257

                fsm->state = ec_fsm_sii_error;

   258

#if 0

   259

                EC_DBG("SII busy: %02X %02X %02X %02X\n",

   260

                       EC_READ_U8(datagram->data + 0),

   261

                       EC_READ_U8(datagram->data + 1),

   262

                       EC_READ_U8(datagram->data + 2),

   263

                       EC_READ_U8(datagram->data + 3));

   264

#endif

   265

                return;

   266

            }

   267

            fsm->check_once_more = 0;

   268

        }

   269

   270

        // issue check/fetch datagram again

   271

        switch (fsm->mode) {

   272

            case EC_FSM_SII_POSITION:

   273

                ec_datagram_aprd(datagram, fsm->slave->ring_position, 0x502, 10);

   274

                break;

   275

            case EC_FSM_SII_NODE:

   276

                ec_datagram_nprd(datagram, fsm->slave->station_address, 0x502, 10);

   277

                break;

   278

        }

   279

        fsm->retries = EC_FSM_RETRIES;

   280

        return;

   281

    }

   282

   283

#if 0

   284

    EC_DBG("SII rec: %02X %02X %02X %02X - %02X %02X %02X %02X\n",

   285

           EC_READ_U8(datagram->data + 0), EC_READ_U8(datagram->data + 1),

   286

           EC_READ_U8(datagram->data + 2), EC_READ_U8(datagram->data + 3),

   287

           EC_READ_U8(datagram->data + 6), EC_READ_U8(datagram->data + 7),

   288

           EC_READ_U8(datagram->data + 8), EC_READ_U8(datagram->data + 9));

   289

#endif

   290

   291

    // SII value received.

   292

    memcpy(fsm->value, datagram->data + 6, 4);

   293

    fsm->state = ec_fsm_sii_end;

   294

}

   295

   296

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

   297

   298

/**

   299

   SII state: START WRITING.

   300

   Starts reading the slave information interface.

   301

*/

   302

   303

void ec_fsm_sii_start_writing(ec_fsm_sii_t *fsm /**< finite state machine */)

   304

{

   305

    ec_datagram_t *datagram = fsm->datagram;

   306

   307

    // initiate write operation

   308

    ec_datagram_npwr(datagram, fsm->slave->station_address, 0x502, 8);

   309

    EC_WRITE_U8 (datagram->data,     0x01); // enable write access

   310

    EC_WRITE_U8 (datagram->data + 1, 0x02); // request write operation

   311

    EC_WRITE_U32(datagram->data + 2, fsm->offset);

   312

    memcpy(datagram->data + 6, fsm->value, 2);

   313

   314

    fsm->retries = EC_FSM_RETRIES;

   315

    fsm->state = ec_fsm_sii_write_check;

   316

}

   317

   318

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

   319

   320

/**

   321

   SII state: WRITE CHECK.

   322

*/

   323

   324

void ec_fsm_sii_write_check(ec_fsm_sii_t *fsm /**< finite state machine */)

   325

{

   326

    ec_datagram_t *datagram = fsm->datagram;

   327

   328

    if (datagram->state == EC_DATAGRAM_TIMED_OUT && fsm->retries--)

   329

        return;

   330

   331

    if (datagram->state != EC_DATAGRAM_RECEIVED) {

   332

        fsm->state = ec_fsm_sii_error;

   333

        EC_ERR("Failed to receive SII write datagram for slave %i"

   334

                " (datagram state %i).\n",

   335

               fsm->slave->ring_position, datagram->state);

   336

        return;

   337

    }

   338

   339

    if (datagram->working_counter != 1) {

   340

        fsm->state = ec_fsm_sii_error;

   341

        EC_ERR("Reception of SII write datagram failed - slave %i did not"

   342

               " respond.\n", fsm->slave->ring_position);

   343

        return;

   344

    }

   345

   346

    fsm->cycles_start = datagram->cycles_sent;

   347

    fsm->check_once_more = 1;

   348

   349

    // issue check/fetch datagram

   350

    ec_datagram_nprd(datagram, fsm->slave->station_address, 0x502, 2);

   351

    fsm->retries = EC_FSM_RETRIES;

   352

    fsm->state = ec_fsm_sii_write_check2;

   353

}

   354

   355

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

   356

   357

/**

   358

   SII state: WRITE CHECK 2.

   359

*/

   360

   361

void ec_fsm_sii_write_check2(ec_fsm_sii_t *fsm /**< finite state machine */)

   362

{

   363

    ec_datagram_t *datagram = fsm->datagram;

   364

   365

    if (datagram->state == EC_DATAGRAM_TIMED_OUT && fsm->retries--)

   366

        return;

   367

   368

    if (datagram->state != EC_DATAGRAM_RECEIVED) {

   369

        fsm->state = ec_fsm_sii_error;

   370

        EC_ERR("Failed to receive SII write check datagram from slave %i"

   371

                " (datagram state %i).\n",

   372

               fsm->slave->ring_position, datagram->state);

   373

        return;

   374

    }

   375

   376

    if (datagram->working_counter != 1) {

   377

        fsm->state = ec_fsm_sii_error;

   378

        EC_ERR("Reception of SII write check datagram failed - slave %i did"

   379

               " not respond.\n", fsm->slave->ring_position);

   380

        return;

   381

    }

   382

   383

    if (EC_READ_U8(datagram->data + 1) & 0x82) {

   384

        // still busy... timeout?

   385

        if (datagram->cycles_received

   386

            - fsm->cycles_start >= (cycles_t) 10 * cpu_khz) {

   387

            if (!fsm->check_once_more) {

   388

                EC_ERR("SII: Write timeout.\n");

   389

                fsm->state = ec_fsm_sii_error;

   390

                return;

   391

            }

   392

            fsm->check_once_more = 0;

   393

        }

   394

   395

        // issue check/fetch datagram again

   396

        fsm->retries = EC_FSM_RETRIES;

   397

        return;

   398

    }

   399

   400

    if (EC_READ_U8(datagram->data + 1) & 0x40) {

   401

        EC_ERR("SII: Write operation failed!\n");

   402

        fsm->state = ec_fsm_sii_error;

   403

        return;

   404

    }

   405

   406

    // success

   407

    fsm->state = ec_fsm_sii_end;

   408

}

   409

   410

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

   411

   412

/**

   413

   State: ERROR.

   414

*/

   415

   416

void ec_fsm_sii_error(ec_fsm_sii_t *fsm /**< finite state machine */)

   417

{

   418

}

   419

   420

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

   421

   422

/**

   423

   State: END.

   424

*/

   425

   426

void ec_fsm_sii_end(ec_fsm_sii_t *fsm /**< finite state machine */)

   427

{

   428

}

   429

   430

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