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; version 2 of the License.

    12

 *

    13

 *  The IgH EtherCAT Master is distributed in the hope that it will be

    14

 *  useful, but WITHOUT ANY WARRANTY; without even the implied warranty of

    15

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    16

 *  GNU General Public License for more details.

    17

 *

    18

 *  You should have received a copy of the GNU General Public License

    19

 *  along 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

/**

    25

   \file

    26

   EtherCAT master methods.

    27

*/

    28

    29

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

    30

    31

#include <linux/module.h>

    32

#include <linux/kernel.h>

    33

#include <linux/string.h>

    34

#include <linux/slab.h>

    35

#include <linux/delay.h>

    36

    37

#include "../include/ecrt.h"

    38

#include "globals.h"

    39

#include "master.h"

    40

#include "slave.h"

    41

#include "types.h"

    42

#include "device.h"

    43

#include "command.h"

    44

#include "ethernet.h"

    45

    46

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

    47

    48

void ec_master_freerun(void *);

    49

#ifdef EOE_TIMER

    50

void ec_master_run_eoe(unsigned long);

    51

#else

    52

void ec_master_run_eoe(void *);

    53

#endif

    54

ssize_t ec_show_master_attribute(struct kobject *, struct attribute *, char *);

    55

void ec_master_process_watch_command(ec_master_t *);

    56

    57

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

    58

    59

/** \cond */

    60

    61

EC_SYSFS_READ_ATTR(slave_count);

    62

EC_SYSFS_READ_ATTR(mode);

    63

    64

static struct attribute *ec_def_attrs[] = {

    65

    &attr_slave_count,

    66

    &attr_mode,

    67

    NULL,

    68

};

    69

    70

static struct sysfs_ops ec_sysfs_ops = {

    71

    .show = &ec_show_master_attribute,

    72

    .store = NULL

    73

};

    74

    75

static struct kobj_type ktype_ec_master = {

    76

    .release = ec_master_clear,

    77

    .sysfs_ops = &ec_sysfs_ops,

    78

    .default_attrs = ec_def_attrs

    79

};

    80

    81

/** \endcond */

    82

    83

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

    84

    85

/**

    86

   Master constructor.

    87

   \return 0 in case of success, else < 0

    88

*/

    89

    90

int ec_master_init(ec_master_t *master, /**< EtherCAT master */

    91

                   unsigned int index /**< master index */

    92

                   )

    93

{

    94

    EC_INFO("Initializing master %i.\n", index);

    95

   103

    master->index = index;

   104

    master->device = NULL;

   105

    master->reserved = 0;

   106

    INIT_LIST_HEAD(&master->slaves);

   107

    INIT_LIST_HEAD(&master->command_queue);

   108

    INIT_LIST_HEAD(&master->domains);

   109

    INIT_LIST_HEAD(&master->eoe_slaves);

   110

    ec_command_init(&master->simple_command);

   111

    INIT_WORK(&master->freerun_work, ec_master_freerun, (void *) master);

   112

   113

    // init eoe timer

   114

#ifdef EOE_TIMER

   115

    init_timer(&master->eoe_timer);

   116

    master->eoe_timer.function = ec_master_run_eoe;

   117

    master->eoe_timer.data = (unsigned long) master;

   118

#else

   119

    INIT_WORK(&master->eoe_work, ec_master_run_eoe, (void *) master);

   120

#endif

   121

   122

    // init kobject and add it to the hierarchy

   123

    memset(&master->kobj, 0x00, sizeof(struct kobject));

   124

    kobject_init(&master->kobj);

   125

    master->kobj.ktype = &ktype_ec_master;

   126

    if (kobject_set_name(&master->kobj, "ethercat%i", index)) {

   127

        EC_ERR("Failed to set kobj name.\n");

   130

    }

   131

   132

    ec_master_reset(master);

   133

    return 0;

   134

   137

 out_return:

   138

    return -1;

   139

}

   140

   141

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

   142

   143

/**

   144

   Master destructor.

   145

   Removes all pending commands, clears the slave list, clears all domains

   146

   and frees the device.

   147

*/

   148

   149

void ec_master_clear(struct kobject *kobj /**< kobject of the master */)

   150

{

   151

    ec_master_t *master = container_of(kobj, ec_master_t, kobj);

   152

   153

    EC_INFO("Clearing master %i...\n", master->index);

   154

   155

    ec_master_reset(master);

   159

   160

    if (master->device) {

   161

        ec_device_clear(master->device);

   162

        kfree(master->device);

   163

    }

   164

   165

    EC_INFO("Master %i cleared.\n", master->index);

   166

}

   167

   168

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

   169

   170

/**

   171

   Resets the master.

   172

   Note: This function has to be called, everytime ec_master_release() is

   173

   called, to free the slave list, domains etc.

   174

*/

   175

   176

void ec_master_reset(ec_master_t *master /**< EtherCAT master */)

   177

{

   178

    ec_command_t *command, *next_c;

   179

    ec_domain_t *domain, *next_d;

   180

    ec_eoe_t *eoe, *next_eoe;

   181

   182

    // stop EoE processing

   183

#ifdef EOE_TIMER

   184

    del_timer_sync(&master->eoe_timer);

   185

#else

   186

    if (!cancel_delayed_work(&master->eoe_work)) {

   187

        flush_workqueue(master->eoe_workqueue);

   188

    }

   189

#endif

   190

   191

    // stop free-run mode

   192

    ec_master_freerun_stop(master);

   193

   195

   196

    // empty command queue

   197

    list_for_each_entry_safe(command, next_c, &master->command_queue, queue) {

   198

        list_del_init(&command->queue);

   199

        command->state = EC_CMD_ERROR;

   200

    }

   201

   202

    // clear domains

   203

    list_for_each_entry_safe(domain, next_d, &master->domains, list) {

   204

        list_del(&domain->list);

   205

        kobject_del(&domain->kobj);

   206

        kobject_put(&domain->kobj);

   207

    }

   208

   209

    // clear EoE objects

   210

    list_for_each_entry_safe(eoe, next_eoe, &master->eoe_slaves, list) {

   211

        list_del(&eoe->list);

   212

        ec_eoe_clear(eoe);

   213

        kfree(eoe);

   214

    }

   215

   216

    master->command_index = 0;

   217

    master->debug_level = 0;

   218

    master->timeout = 500; // 500us

   219

   220

    master->stats.timeouts = 0;

   221

    master->stats.delayed = 0;

   222

    master->stats.corrupted = 0;

   223

    master->stats.unmatched = 0;

   224

    master->stats.t_last = 0;

   225

   226

    master->mode = EC_MASTER_MODE_IDLE;

   227

   228

    master->request_cb = NULL;

   229

    master->release_cb = NULL;

   230

    master->cb_data = NULL;

   251

}

   252

   253

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

   254

   255

/**

   256

   Places a command in the command queue.

   257

*/

   258

   259

void ec_master_queue_command(ec_master_t *master, /**< EtherCAT master */

   260

                             ec_command_t *command /**< command */

   261

                             )

   262

{

   263

    ec_command_t *queued_command;

   264

   265

    // check, if the command is already queued

   266

    list_for_each_entry(queued_command, &master->command_queue, queue) {

   267

        if (queued_command == command) {

   268

            command->state = EC_CMD_QUEUED;

   269

            if (unlikely(master->debug_level))

   270

                EC_WARN("command already queued.\n");

   271

            return;

   272

        }

   273

    }

   274

   275

    list_add_tail(&command->queue, &master->command_queue);

   276

    command->state = EC_CMD_QUEUED;

   277

}

   278

   279

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

   280

   281

/**

   282

   Sends the commands in the queue.

   283

   \return 0 in case of success, else < 0

   284

*/

   285

   286

void ec_master_send_commands(ec_master_t *master /**< EtherCAT master */)

   287

{

   288

    ec_command_t *command;

   289

    size_t command_size;

   290

    uint8_t *frame_data, *cur_data;

   291

    void *follows_word;

   292

    cycles_t t_start, t_end;

   293

    unsigned int frame_count, more_commands_waiting;

   294

   295

    frame_count = 0;

   296

    t_start = get_cycles();

   297

   298

    if (unlikely(master->debug_level > 0))

   299

        EC_DBG("ec_master_send_commands\n");

   300

   301

    do {

   302

        // fetch pointer to transmit socket buffer

   303

        frame_data = ec_device_tx_data(master->device);

   304

        cur_data = frame_data + EC_FRAME_HEADER_SIZE;

   305

        follows_word = NULL;

   306

        more_commands_waiting = 0;

   307

   308

        // fill current frame with commands

   309

        list_for_each_entry(command, &master->command_queue, queue) {

   310

            if (command->state != EC_CMD_QUEUED) continue;

   311

   312

            // does the current command fit in the frame?

   313

            command_size = EC_COMMAND_HEADER_SIZE + command->data_size

   314

                + EC_COMMAND_FOOTER_SIZE;

   315

            if (cur_data - frame_data + command_size > ETH_DATA_LEN) {

   316

                more_commands_waiting = 1;

   317

                break;

   318

            }

   319

   320

            command->state = EC_CMD_SENT;

   321

            command->t_sent = t_start;

   322

            command->index = master->command_index++;

   323

   324

            if (unlikely(master->debug_level > 0))

   325

                EC_DBG("adding command 0x%02X\n", command->index);

   326

   327

            // set "command following" flag in previous frame

   328

            if (follows_word)

   329

                EC_WRITE_U16(follows_word, EC_READ_U16(follows_word) | 0x8000);

   330

   331

            // EtherCAT command header

   332

            EC_WRITE_U8 (cur_data,     command->type);

   333

            EC_WRITE_U8 (cur_data + 1, command->index);

   334

            EC_WRITE_U32(cur_data + 2, command->address.logical);

   335

            EC_WRITE_U16(cur_data + 6, command->data_size & 0x7FF);

   336

            EC_WRITE_U16(cur_data + 8, 0x0000);

   337

            follows_word = cur_data + 6;

   338

            cur_data += EC_COMMAND_HEADER_SIZE;

   339

   340

            // EtherCAT command data

   341

            memcpy(cur_data, command->data, command->data_size);

   342

            cur_data += command->data_size;

   343

   344

            // EtherCAT command footer

   345

            EC_WRITE_U16(cur_data, 0x0000); // reset working counter

   346

            cur_data += EC_COMMAND_FOOTER_SIZE;

   347

        }

   348

   349

        if (cur_data - frame_data == EC_FRAME_HEADER_SIZE) {

   350

            if (unlikely(master->debug_level > 0))

   351

                EC_DBG("nothing to send.\n");

   352

            break;

   353

        }

   354

   355

        // EtherCAT frame header

   356

        EC_WRITE_U16(frame_data, ((cur_data - frame_data

   357

                                   - EC_FRAME_HEADER_SIZE) & 0x7FF) | 0x1000);

   358

   359

        // pad frame

   360

        while (cur_data - frame_data < ETH_ZLEN - ETH_HLEN)

   361

            EC_WRITE_U8(cur_data++, 0x00);

   362

   363

        if (unlikely(master->debug_level > 0))

   364

            EC_DBG("frame size: %i\n", cur_data - frame_data);

   365

   366

        // send frame

   367

        ec_device_send(master->device, cur_data - frame_data);

   368

        frame_count++;

   369

    }

   370

    while (more_commands_waiting);

   371

   372

    if (unlikely(master->debug_level > 0)) {

   373

        t_end = get_cycles();

   374

        EC_DBG("ec_master_send_commands sent %i frames in %ius.\n",

   375

               frame_count, (u32) (t_end - t_start) * 1000 / cpu_khz);

   376

    }

   377

}

   378

   379

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

   380

   381

/**

   382

   Processes a received frame.

   383

   This function is called by the network driver for every received frame.

   384

   \return 0 in case of success, else < 0

   385

*/

   386

   387

void ec_master_receive(ec_master_t *master, /**< EtherCAT master */

   388

                       const uint8_t *frame_data, /**< received data */

   389

                       size_t size /**< size of the received data */

   390

                       )

   391

{

   392

    size_t frame_size, data_size;

   393

    uint8_t command_type, command_index;

   394

    unsigned int cmd_follows, matched;

   395

    const uint8_t *cur_data;

   396

    ec_command_t *command;

   397

   398

    if (unlikely(size < EC_FRAME_HEADER_SIZE)) {

   399

        master->stats.corrupted++;

   400

        ec_master_output_stats(master);

   401

        return;

   402

    }

   403

   404

    cur_data = frame_data;

   405

   406

    // check length of entire frame

   407

    frame_size = EC_READ_U16(cur_data) & 0x07FF;

   408

    cur_data += EC_FRAME_HEADER_SIZE;

   409

   410

    if (unlikely(frame_size > size)) {

   411

        master->stats.corrupted++;

   412

        ec_master_output_stats(master);

   413

        return;

   414

    }

   415

   416

    cmd_follows = 1;

   417

    while (cmd_follows) {

   418

        // process command header

   419

        command_type  = EC_READ_U8 (cur_data);

   420

        command_index = EC_READ_U8 (cur_data + 1);

   421

        data_size     = EC_READ_U16(cur_data + 6) & 0x07FF;

   422

        cmd_follows   = EC_READ_U16(cur_data + 6) & 0x8000;

   423

        cur_data += EC_COMMAND_HEADER_SIZE;

   424

   425

        if (unlikely(cur_data - frame_data

   426

                     + data_size + EC_COMMAND_FOOTER_SIZE > size)) {

   427

            master->stats.corrupted++;

   428

            ec_master_output_stats(master);

   429

            return;

   430

        }

   431

   432

        // search for matching command in the queue

   433

        matched = 0;

   434

        list_for_each_entry(command, &master->command_queue, queue) {

   435

            if (command->state == EC_CMD_SENT

   436

                && command->type == command_type

   437

                && command->index == command_index

   438

                && command->data_size == data_size) {

   439

                matched = 1;

   440

                break;

   441

            }

   442

        }

   443

   444

        // no matching command was found

   445

        if (!matched) {

   446

            master->stats.unmatched++;

   447

            ec_master_output_stats(master);

   448

            cur_data += data_size + EC_COMMAND_FOOTER_SIZE;

   449

            continue;

   450

        }

   451

   452

        // copy received data in the command memory

   453

        memcpy(command->data, cur_data, data_size);

   454

        cur_data += data_size;

   455

   456

        // set the command's working counter

   457

        command->working_counter = EC_READ_U16(cur_data);

   458

        cur_data += EC_COMMAND_FOOTER_SIZE;

   459

   460

        // dequeue the received command

   461

        command->state = EC_CMD_RECEIVED;

   462

        list_del_init(&command->queue);

   463

    }

   464

}

   465

   466

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

   467

   468

/**

   469

   Sends a single command and waits for its reception.

   470

   If the slave doesn't respond, the command is sent again.

   471

   \return 0 in case of success, else < 0

   472

*/

   473

   474

int ec_master_simple_io(ec_master_t *master, /**< EtherCAT master */

   475

                        ec_command_t *command /**< command */

   476

                        )

   477

{

   478

    unsigned int response_tries_left;

   479

   480

    response_tries_left = 10;

   481

   482

    while (1)

   483

    {

   484

        ec_master_queue_command(master, command);

   485

        ecrt_master_sync_io(master);

   486

   487