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(unsigned long);

    49

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

    50

void ec_master_process_watch_command(ec_master_t *);

    51

    52

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

    53

    54

/** \cond */

    55

    56

EC_SYSFS_READ_ATTR(slave_count);

    57

EC_SYSFS_READ_ATTR(mode);

    58

    59

static struct attribute *ec_def_attrs[] = {

    60

    &attr_slave_count,

    61

    &attr_mode,

    62

    NULL,

    63

};

    64

    65

static struct sysfs_ops ec_sysfs_ops = {

    66

    .show = &ec_show_master_attribute,

    67

    .store = NULL

    68

};

    69

    70

static struct kobj_type ktype_ec_master = {

    71

    .release = ec_master_clear,

    72

    .sysfs_ops = &ec_sysfs_ops,

    73

    .default_attrs = ec_def_attrs

    74

};

    75

    76

/** \endcond */

    77

    78

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

    79

    80

/**

    81

   Master constructor.

    82

   \return 0 in case of success, else < 0

    83

*/

    84

    85

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

    86

                   unsigned int index /**< master index */

    87

                   )

    88

{

    89

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

    90

    91

    master->index = index;

    92

    master->device = NULL;

    93

    master->reserved = 0;

    94

    95

    INIT_LIST_HEAD(&master->slaves);

    96

    INIT_LIST_HEAD(&master->command_queue);

    97

    INIT_LIST_HEAD(&master->domains);

    98

    INIT_LIST_HEAD(&master->eoe_slaves);

    99

   100

    // init kobject and add it to the hierarchy

   101

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

   102

    kobject_init(&master->kobj);

   103

    master->kobj.ktype = &ktype_ec_master;

   104

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

   105

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

   106

        kobject_put(&master->kobj);

   107

        return -1;

   108

    }

   109

   110

    // init freerun timer

   111

    init_timer(&master->freerun_timer);

   112

    master->freerun_timer.function = ec_master_freerun;

   113

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

   114

   115

    ec_command_init(&master->simple_command);

   116

    ec_command_init(&master->watch_command);

   117

   118

    ec_master_reset(master);

   119

    return 0;

   120

}

   121

   122

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

   123

   124

/**

   125

   Master destructor.

   126

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

   127

   and frees the device.

   128

*/

   129

   130

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

   131

{

   132

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

   133

   134

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

   135

   136

    del_timer_sync(&master->freerun_timer);

   137

   138

    ec_master_reset(master);

   139

   140

    if (master->device) {

   141

        ec_device_clear(master->device);

   142

        kfree(master->device);

   143

    }

   144

   145

    ec_command_clear(&master->simple_command);

   146

    ec_command_clear(&master->watch_command);

   147

   148

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

   149

}

   150

   151

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

   152

   153

/**

   154

   Resets the master.

   155

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

   156

   called, to free the slave list, domains etc.

   157

*/

   158

   159

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

   160

{

   161

    ec_slave_t *slave, *next_s;

   162

    ec_command_t *command, *next_c;

   163

    ec_domain_t *domain, *next_d;

   164

    ec_eoe_t *eoe, *next_eoe;

   165

   166

    ec_master_freerun_stop(master);

   167

   168

    // remove all slaves

   169

    list_for_each_entry_safe(slave, next_s, &master->slaves, list) {

   170

        list_del(&slave->list);

   171

        kobject_del(&slave->kobj);

   172

        kobject_put(&slave->kobj);

   173

    }

   174

    master->slave_count = 0;

   175

   176

    // empty command queue

   177

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

   178

        list_del_init(&command->queue);

   179

        command->state = EC_CMD_ERROR;

   180

    }

   181

   182

    // clear domains

   183

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

   184

        list_del(&domain->list);

   185

        kobject_del(&domain->kobj);

   186

        kobject_put(&domain->kobj);

   187

    }

   188

   189

    // clear EoE objects

   190

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

   191

        list_del(&eoe->list);

   192

        ec_eoe_clear(eoe);

   193

        kfree(eoe);

   194

    }

   195

   196

    master->command_index = 0;

   197

    master->debug_level = 0;

   198

    master->timeout = 500; // 500us

   199

   200

    master->slaves_responding = 0;

   201

    master->slave_states = EC_SLAVE_STATE_UNKNOWN;

   202

   203

    master->stats.timeouts = 0;

   204

    master->stats.delayed = 0;

   205

    master->stats.corrupted = 0;

   206

    master->stats.unmatched = 0;

   207

    master->stats.eoe_errors = 0;

   208

    master->stats.t_last = 0;

   209

   210

    master->mode = EC_MASTER_MODE_IDLE;

   211

}

   212

   213

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

   214

   215

/**

   216

   Places a command in the command queue.

   217

*/

   218

   219

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

   220

                             ec_command_t *command /**< command */

   221

                             )

   222

{

   223

    ec_command_t *queued_command;

   224

   225

    // check, if the command is already queued

   226

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

   227

        if (queued_command == command) {

   228

            command->state = EC_CMD_QUEUED;

   229

            if (unlikely(master->debug_level))

   230

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

   231

            return;

   232

        }

   233

    }

   234

   235

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

   236

    command->state = EC_CMD_QUEUED;

   237

}

   238

   239

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

   240

   241

/**

   242

   Sends the commands in the queue.

   243

   \return 0 in case of success, else < 0

   244

*/

   245

   246

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

   247

{

   248

    ec_command_t *command;

   249

    size_t command_size;

   250

    uint8_t *frame_data, *cur_data;

   251

    void *follows_word;

   252

    cycles_t start = 0, end;

   253

    unsigned int frame_count, more_commands_waiting;

   254

   255

    frame_count = 0;

   256

   257

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

   258

        EC_DBG("ec_master_send_commands\n");

   259

        start = get_cycles();

   260

    }

   261

   262

    do {

   263

        // fetch pointer to transmit socket buffer

   264

        frame_data = ec_device_tx_data(master->device);

   265

        cur_data = frame_data + EC_FRAME_HEADER_SIZE;

   266

        follows_word = NULL;

   267

        more_commands_waiting = 0;

   268

   269

        // fill current frame with commands

   270

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

   271

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

   272

   273

            // does the current command fit in the frame?

   274

            command_size = EC_COMMAND_HEADER_SIZE + command->data_size

   275

                + EC_COMMAND_FOOTER_SIZE;

   276

            if (cur_data - frame_data + command_size > EC_MAX_FRAME_SIZE) {

   277

                more_commands_waiting = 1;

   278

                break;

   279

            }

   280

   281

            command->state = EC_CMD_SENT;

   282

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

   283

   284

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

   285

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

   286

   287

            // set "command following" flag in previous frame

   288

            if (follows_word)

   289

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

   290

   291

            // EtherCAT command header

   292

            EC_WRITE_U8 (cur_data,     command->type);

   293

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

   294

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

   295

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

   296

            EC_WRITE_U16(cur_data + 8, 0x0000);

   297

            follows_word = cur_data + 6;

   298

            cur_data += EC_COMMAND_HEADER_SIZE;

   299

   300

            // EtherCAT command data

   301

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

   302

            cur_data += command->data_size;

   303

   304

            // EtherCAT command footer

   305

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

   306

            cur_data += EC_COMMAND_FOOTER_SIZE;

   307

        }

   308

   309

        if (cur_data - frame_data == EC_FRAME_HEADER_SIZE) {

   310

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

   311

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

   312

            break;

   313

        }

   314

   315

        // EtherCAT frame header

   316

        EC_WRITE_U16(frame_data, ((cur_data - frame_data

   317

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

   318

   319

        // pad frame

   320

        while (cur_data - frame_data < EC_MIN_FRAME_SIZE)

   321

            EC_WRITE_U8(cur_data++, 0x00);

   322

   323

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

   324

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

   325

   326

        // send frame

   327

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

   328

        frame_count++;

   329

    }

   330

    while (more_commands_waiting);

   331

   332

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

   333

        end = get_cycles();

   334

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

   335

               frame_count, (u32) (end - start) * 1000 / cpu_khz);

   336

    }

   337

}

   338

   339

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

   340

   341

/**

   342

   Processes a received frame.

   343

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

   344

   \return 0 in case of success, else < 0

   345

*/

   346

   347

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

   348

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

   349

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

   350

                       )

   351

{

   352

    size_t frame_size, data_size;

   353

    uint8_t command_type, command_index;

   354

    unsigned int cmd_follows, matched;

   355

    const uint8_t *cur_data;

   356

    ec_command_t *command;

   357

   358

    if (unlikely(size < EC_FRAME_HEADER_SIZE)) {

   359

        master->stats.corrupted++;

   360

        ec_master_output_stats(master);

   361

        return;

   362

    }

   363

   364

    cur_data = frame_data;

   365

   366

    // check length of entire frame

   367

    frame_size = EC_READ_U16(cur_data) & 0x07FF;

   368

    cur_data += EC_FRAME_HEADER_SIZE;

   369

   370

    if (unlikely(frame_size > size)) {

   371

        master->stats.corrupted++;

   372

        ec_master_output_stats(master);

   373

        return;

   374

    }

   375

   376

    cmd_follows = 1;

   377

    while (cmd_follows) {

   378

        // process command header

   379

        command_type  = EC_READ_U8 (cur_data);

   380

        command_index = EC_READ_U8 (cur_data + 1);

   381

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

   382

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

   383

        cur_data += EC_COMMAND_HEADER_SIZE;

   384

   385

        if (unlikely(cur_data - frame_data

   386

                     + data_size + EC_COMMAND_FOOTER_SIZE > size)) {

   387

            master->stats.corrupted++;

   388

            ec_master_output_stats(master);

   389

            return;

   390

        }

   391

   392

        // search for matching command in the queue

   393

        matched = 0;

   394

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

   395

            if (command->state == EC_CMD_SENT

   396

                && command->type == command_type

   397

                && command->index == command_index

   398

                && command->data_size == data_size) {

   399

                matched = 1;

   400

                break;

   401

            }

   402

        }

   403

   404

        // no matching command was found

   405

        if (!matched) {

   406

            master->stats.unmatched++;

   407

            ec_master_output_stats(master);

   408

            cur_data += data_size + EC_COMMAND_FOOTER_SIZE;

   409

            continue;

   410

        }

   411

   412

        // copy received data in the command memory

   413

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

   414

        cur_data += data_size;

   415

   416

        // set the command's working counter

   417

        command->working_counter = EC_READ_U16(cur_data);

   418

        cur_data += EC_COMMAND_FOOTER_SIZE;

   419

   420

        // dequeue the received command

   421

        command->state = EC_CMD_RECEIVED;

   422

        list_del_init(&command->queue);

   423

    }

   424

}

   425

   426

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

   427

   428

/**

   429

   Sends a single command and waits for its reception.

   430

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

   431

   \return 0 in case of success, else < 0

   432

*/

   433

   434

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

   435

                        ec_command_t *command /**< command */

   436

                        )

   437

{

   438

    unsigned int response_tries_left;

   439

   440

    response_tries_left = 10;

   441

   442

    while (1)

   443

    {

   444

        ec_master_queue_command(master, command);

   445

        ecrt_master_sync_io(master);

   446

   447

        if (command->state == EC_CMD_RECEIVED) {

   448

            if (likely(command->working_counter))

   449

                return 0;

   450

        }

   451

        else if (command->state == EC_CMD_TIMEOUT) {

   452

            EC_ERR("Simple-IO TIMEOUT!\n");

   453

            return -1;

   454

        }

   455

        else if (command->state == EC_CMD_ERROR) {

   456

            EC_ERR("Simple-IO command error!\n");

   457

            return -1;

   458

        }

   459

   460

        // no direct response, wait a little bit...

   461

        udelay(100);

   462

   463

        if (unlikely(--response_tries_left)) {

   464

            EC_ERR("No response in simple-IO!\n");

   465

            return -1;

   466

        }

   467

    }

   468

}

   469

   470

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

   471

   472

/**

   473

   Scans the EtherCAT bus for slaves.

   474

   Creates a list of slave structures for further processing.

   475

   \return 0 in case of success, else < 0

   476

*/

   477

   478

int ec_master_bus_scan(ec_master_t *master /**< EtherCAT master */)

   479

{

   480

    ec_slave_t *slave, *next;

   481

    ec_slave_ident_t *ident;

   482

    unsigned int i;

   483

    ec_command_t *command;

   484

    ec_eoe_t *eoe;

   485

    uint16_t coupler_index, coupler_subindex;

   486

    uint16_t reverse_coupler_index, current_coupler_index;

   487