1

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

     2

 *

     3

 *  m a s t e r . c

     4

 *

     5

 *  Methoden für einen EtherCAT-Master.

     6

 *

     7

 *  $Id$

     8

 *

     9

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

    10

    11

#include <linux/module.h>

    12

#include <linux/kernel.h>

    13

#include <linux/string.h>

    14

#include <linux/slab.h>

    15

#include <linux/delay.h>

    16

    17

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

    18

#include "globals.h"

    19

#include "master.h"

    20

#include "slave.h"

    21

#include "types.h"

    22

#include "device.h"

    23

#include "command.h"

    24

#include "ethernet.h"

    25

    26

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

    27

    32

static struct attribute attr_slave_count = {

    33

    .name = "slave_count",

    34

    .owner = THIS_MODULE,

    35

    .mode = S_IRUGO

    36

};

    37

    38

static struct attribute *ec_def_attrs[] = {

    39

    &attr_slave_count,

    40

    NULL,

    41

};

    42

    43

static struct sysfs_ops ec_sysfs_ops = {

    44

    .show = &ec_show_master_attribute,

    45

    .store = NULL

    46

};

    47

    48

static struct kobj_type ktype_ec_master = {

    49

    .release = ec_master_clear,

    50

    .sysfs_ops = &ec_sysfs_ops,

    51

    .default_attrs = ec_def_attrs

    52

};

    53

    54

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

    55

    56

/**

    57

   Konstruktor des EtherCAT-Masters.

    58

*/

    59

    60

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

    61

                   unsigned int index /**< Master-Index */

    62

                   )

    63

{

    64

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

    65

    66

    master->index = index;

    67

    master->slaves = NULL;

    68

    master->device = NULL;

    69

    master->reserved = 0;

    70

    71

    INIT_LIST_HEAD(&master->command_queue);

    72

    INIT_LIST_HEAD(&master->domains);

    73

    INIT_LIST_HEAD(&master->eoe_slaves);

    74

    75

    // Init kobject and add it to the hierarchy

    76

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

    77

    kobject_init(&master->kobj);

    78

    master->kobj.ktype = &ktype_ec_master;

    79

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

    80

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

    81

        kobject_put(&master->kobj);

    82

        return -1;

    83

    }

    84

    85

    ec_command_init(&master->simple_command);

    86

    ec_command_init(&master->watch_command);

    87

    88

    ec_master_reset(master);

    89

    return 0;

    90

}

    91

    92

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

    93

    94

/**

    95

   Destruktor eines EtherCAT-Masters.

    96

    97

   Entfernt alle Kommandos aus der Liste, löscht den Zeiger

    98

   auf das Slave-Array und gibt die Prozessdaten frei.

    99

*/

   100

   101

void ec_master_clear(struct kobject *kobj /**< KObject des Masters */)

   102

{

   103

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

   104

   105

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

   106

   107

    ec_master_reset(master);

   108

   109

    if (master->device) {

   110

        ec_device_clear(master->device);

   111

        kfree(master->device);

   112

    }

   113

   114

    ec_command_clear(&master->simple_command);

   115

    ec_command_clear(&master->watch_command);

   116

   117

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

   118

}

   119

   120

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

   121

   122

/**

   123

   Setzt den Master zurück in den Ausgangszustand.

   124

   125

   Bei einem "release" sollte immer diese Funktion aufgerufen werden,

   126

   da sonst Slave-Liste, Domains, etc. weiter existieren.

   127

*/

   128

   129

void ec_master_reset(ec_master_t *master

   130

                     /**< Zeiger auf den zurückzusetzenden Master */

   131

                     )

   132

{

   133

    unsigned int i;

   134

    ec_command_t *command, *next_c;

   135

    ec_domain_t *domain, *next_d;

   136

    ec_eoe_t *eoe, *next_eoe;

   137

   138

    // Alle Slaves entfernen

   139

    if (master->slaves) {

   140

        for (i = 0; i < master->slave_count; i++)

   141

            ec_slave_clear(master->slaves + i);

   142

        kfree(master->slaves);

   143

        master->slaves = NULL;

   144

    }

   145

    master->slave_count = 0;

   146

   147

    // Kommando-Warteschlange leeren

   148

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

   149

        command->state = EC_CMD_ERROR;

   150

        list_del_init(&command->queue);

   151

    }

   152

   153

    // Domain-Liste leeren

   154

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

   155

        list_del(&domain->list);

   156

        kobject_del(&domain->kobj);

   157

        kobject_put(&domain->kobj);

   158

    }

   159

   160

    // EOE-Liste leeren

   161

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

   162

        list_del(&eoe->list);

   163

        ec_eoe_clear(eoe);

   164

        kfree(eoe);

   165

    }

   166

   167

    master->command_index = 0;

   168

    master->debug_level = 0;

   169

    master->timeout = 500; // 500us

   170

   171

    master->slaves_responding = 0;

   172

    master->slave_states = EC_SLAVE_STATE_UNKNOWN;

   173

   174

    master->stats.timeouts = 0;

   175

    master->stats.delayed = 0;

   176

    master->stats.corrupted = 0;

   177

    master->stats.unmatched = 0;

   178

    master->stats.eoe_errors = 0;

   179

    master->stats.t_last = 0;

   180

}

   181

   182

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

   183

   184

/**

   185

   Stellt ein Kommando in die Warteschlange.

   186

*/

   187

   188

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

   189

                             ec_command_t *command /**< Kommando */

   190

                             )

   191

{

   192

    ec_command_t *queued_command;

   193

   194

    // Ist das Kommando schon in der Warteschlange?

   195

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

   196

        if (queued_command == command) {

   197

            command->state = EC_CMD_QUEUED;

   198

            if (unlikely(master->debug_level))

   199

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

   200

            return;

   201

        }

   202

    }

   203

   204

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

   205

    command->state = EC_CMD_QUEUED;

   206

}

   207

   208

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

   209

   210

/**

   211

   Sendet die Kommandos in der Warteschlange.

   212

   213

   \return 0 bei Erfolg, sonst < 0

   214

*/

   215

   216

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

   217

{

   218

    ec_command_t *command;

   219

    size_t command_size;

   220

    uint8_t *frame_data, *cur_data;

   221

    void *follows_word;

   222

    cycles_t start = 0, end;

   223

    unsigned int frame_count, more_commands_waiting;

   224

   225

    frame_count = 0;

   226

   227

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

   228

        EC_DBG("ec_master_send_commands\n");

   229

        start = get_cycles();

   230

    }

   231

   232

    do {

   233

        // Zeiger auf Socket-Buffer holen

   234

        frame_data = ec_device_tx_data(master->device);

   235

        cur_data = frame_data + EC_FRAME_HEADER_SIZE;

   236

        follows_word = NULL;

   237

        more_commands_waiting = 0;

   238

   239

        // Aktuellen Frame mit Kommandos füllen

   240

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

   241

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

   242

   243

            // Passt das aktuelle Kommando noch in den aktuellen Rahmen?

   244

            command_size = EC_COMMAND_HEADER_SIZE + command->data_size

   245

                + EC_COMMAND_FOOTER_SIZE;

   246

            if (cur_data - frame_data + command_size > EC_MAX_FRAME_SIZE) {

   247

                more_commands_waiting = 1;

   248

                break;

   249

            }

   250

   251

            command->state = EC_CMD_SENT;

   252

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

   253

   254

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

   255

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

   256

   257

            // Command-Following-Flag im letzten Kommando setzen

   258

            if (follows_word)

   259

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

   260

   261

            // EtherCAT command header

   262

            EC_WRITE_U8 (cur_data,     command->type);

   263

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

   264

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

   265

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

   266

            EC_WRITE_U16(cur_data + 8, 0x0000);

   267

            follows_word = cur_data + 6;

   268

            cur_data += EC_COMMAND_HEADER_SIZE;

   269

   270

            // EtherCAT command data

   271

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

   272

            cur_data += command->data_size;

   273

   274

            // EtherCAT command footer

   275

            EC_WRITE_U16(cur_data, 0x0000); // Working counter

   276

            cur_data += EC_COMMAND_FOOTER_SIZE;

   277

        }

   278

   279

        if (cur_data - frame_data == EC_FRAME_HEADER_SIZE) {

   280

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

   281

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

   282

            break;

   283

        }

   284

   285

        // EtherCAT frame header

   286

        EC_WRITE_U16(frame_data, ((cur_data - frame_data

   287

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

   288

   289

        // Rahmen auffüllen

   290

        while (cur_data - frame_data < EC_MIN_FRAME_SIZE)

   291

            EC_WRITE_U8(cur_data++, 0x00);

   292

   293

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

   294

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

   295

   296

        // Send frame

   297

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

   298

        frame_count++;

   299

    }

   300

    while (more_commands_waiting);

   301

   302

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

   303

        end = get_cycles();

   304

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

   305

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

   306

    }

   307

}

   308

   309

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

   310

   311

/**

   312

   Processes a received frame.

   313

   314

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

   315

   316

   \return 0 bei Erfolg, sonst < 0

   317

*/

   318

   319

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

   320

                      const uint8_t *frame_data, /**< Empfangene Daten */

   321

                      size_t size /**< Anzahl empfangene Datenbytes */

   322

                      )

   323

{

   324

    size_t frame_size, data_size;

   325

    uint8_t command_type, command_index;

   326

    unsigned int cmd_follows, matched;

   327

    const uint8_t *cur_data;

   328

    ec_command_t *command;

   329

   330

    if (unlikely(size < EC_FRAME_HEADER_SIZE)) {

   331

        master->stats.corrupted++;

   332

        ec_master_output_stats(master);

   333

        return;

   334

    }

   335

   336

    cur_data = frame_data;

   337

   338

    // Länge des gesamten Frames prüfen

   339

    frame_size = EC_READ_U16(cur_data) & 0x07FF;

   340

    cur_data += EC_FRAME_HEADER_SIZE;

   341

   342

    if (unlikely(frame_size > size)) {

   343

        master->stats.corrupted++;

   344

        ec_master_output_stats(master);

   345

        return;

   346

    }

   347

   348

    cmd_follows = 1;

   349

    while (cmd_follows) {

   350

        // Kommando-Header auswerten

   351

        command_type  = EC_READ_U8 (cur_data);

   352

        command_index = EC_READ_U8 (cur_data + 1);

   353

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

   354

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

   355

        cur_data += EC_COMMAND_HEADER_SIZE;

   356

   357

        if (unlikely(cur_data - frame_data

   358

                     + data_size + EC_COMMAND_FOOTER_SIZE > size)) {

   359

            master->stats.corrupted++;

   360

            ec_master_output_stats(master);

   361

            return;

   362

        }

   363

   364

        // Suche passendes Kommando in der Liste

   365

        matched = 0;

   366

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

   367

            if (command->state == EC_CMD_SENT

   368

                && command->type == command_type

   369

                && command->index == command_index

   370

                && command->data_size == data_size) {

   371

                matched = 1;

   372

                break;

   373

            }

   374

        }

   375

   376

        // Kein passendes Kommando in der Liste gefunden

   377

        if (!matched) {

   378

            master->stats.unmatched++;

   379

            ec_master_output_stats(master);

   380

            cur_data += data_size + EC_COMMAND_FOOTER_SIZE;

   381

            continue;

   382

        }

   383

   384

        // Empfangene Daten in Kommando-Datenspeicher kopieren

   385

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

   386

        cur_data += data_size;

   387

   388

        // Working-Counter setzen

   389

        command->working_counter = EC_READ_U16(cur_data);

   390

        cur_data += EC_COMMAND_FOOTER_SIZE;

   391

   392

        // Kommando aus der Warteschlange entfernen

   393

        command->state = EC_CMD_RECEIVED;

   394

        list_del_init(&command->queue);

   395

    }

   396

}

   397

   398

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

   399

   400

/**

   401

   Sendet ein einzelnes Kommando und wartet auf den Empfang.

   402

   403

   Wenn der Slave nicht antwortet, wird das Kommando

   404

   nochmals gesendet.

   405

   406

   \return 0 bei Erfolg, sonst < 0

   407

*/

   408

   409

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

   410

                        ec_command_t *command /**< Kommando */

   411

                        )

   412

{

   413

    unsigned int response_tries_left;

   414

   415

    response_tries_left = 10;

   416

   417

    while (1)

   418

    {

   419

        ec_master_queue_command(master, command);

   420

        ecrt_master_sync_io(master);

   421

   422

        if (command->state == EC_CMD_RECEIVED) {

   423

            if (likely(command->working_counter))

   424

                return 0;

   425

        }

   426

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

   427

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

   428

            return -1;

   429

        }

   430

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

   431

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

   432

            return -1;

   433

        }

   434

   435

        // Keine direkte Antwort. Dem Slave Zeit lassen...

   436

        udelay(100);

   437

   438

        if (unlikely(--response_tries_left)) {

   439

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

   440

            return -1;

   441

        }

   442

    }

   443

}

   444

   445

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

   446

   447

/**

   448

   Durchsucht den EtherCAT-Bus nach Slaves.

   449

   450

   Erstellt ein Array mit allen Slave-Informationen die für den

   451

   weiteren Betrieb notwendig sind.

   452

   453

   \return 0 bei Erfolg, sonst < 0

   454

*/

   455

   456

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

   457

{

   458

    ec_slave_t *slave;

   459

    ec_slave_ident_t *ident;

   460

    unsigned int i;

   461

    ec_command_t *command;

   462

    ec_eoe_t *eoe;

   463

   464

    if (master->slaves || master->slave_count) {

   465

        EC_ERR("Slave scan already done!\n");

   466

        return -1;

   467

    }

   468

   469

    command = &master->simple_command;

   470

   471

    // Determine number of slaves on bus

   472

    if (ec_command_brd(command, 0x0000, 4)) return -1;

   473

    if (unlikely(ec_master_simple_io(master, command))) return -1;

   474

    master->slave_count = command->working_counter;

   475

    EC_INFO("Found %i slaves on bus.\n", master->slave_count);

   476

   477

    if (!master->slave_count) return 0;

   478

   479

    if (!(master->slaves = (ec_slave_t *)

   480

          kmalloc(master->slave_count * sizeof(ec_slave_t), GFP_KERNEL))) {

   481

        EC_ERR("Failed to allocate slaves!\n");

   482

        return -1;

   483

    }

   484

   485

    // Init slaves

   486

    for (i = 0; i < master->slave_count; i++) {

   487

        slave = master->slaves + i;

   488

        ec_slave_init(slave, master);

   489

        slave->ring_position = i;

   490

        slave->station_address = i + 1;