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

/**

    31

   \file

    32

   Ethernet over EtherCAT (EoE).

    33

*/

    34

    35

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

    36

    37

#include <linux/version.h>

    38

#include <linux/netdevice.h>

    39

#include <linux/etherdevice.h>

    40

    41

#include "globals.h"

    42

#include "master.h"

    43

#include "slave.h"

    44

#include "mailbox.h"

    45

#include "ethernet.h"

    46

    47

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

    48

    49

/** Defines the debug level of EoE processing.

    50

 *

    51

 * 0 = No debug messages.

    52

 * 1 = Output warnings.

    53

 * 2 = Output actions.

    54

 * 3 = Output actions and frame data.

    55

 */

    56

#define EOE_DEBUG_LEVEL 1

    57

    58

/** Size of the EoE tx queue.

    59

 */

    60

#define EC_EOE_TX_QUEUE_SIZE 100

    61

    62

/** Number of tries.

    63

 */

    64

#define EC_EOE_TRIES 100

    65

    66

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

    67

    68

void ec_eoe_flush(ec_eoe_t *);

    69

    70

// state functions

    71

void ec_eoe_state_rx_start(ec_eoe_t *);

    72

void ec_eoe_state_rx_check(ec_eoe_t *);

    73

void ec_eoe_state_rx_fetch(ec_eoe_t *);

    74

void ec_eoe_state_tx_start(ec_eoe_t *);

    75

void ec_eoe_state_tx_sent(ec_eoe_t *);

    76

    77

// net_device functions

    78

int ec_eoedev_open(struct net_device *);

    79

int ec_eoedev_stop(struct net_device *);

    80

int ec_eoedev_tx(struct sk_buff *, struct net_device *);

    81

struct net_device_stats *ec_eoedev_stats(struct net_device *);

    82

    83

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

    84

    85

#if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 29)

    86

/** Device operations for EoE interfaces.

    87

 */

    88

static const struct net_device_ops ec_eoedev_ops = {

    89

    .ndo_open = ec_eoedev_open,

    90

    .ndo_stop = ec_eoedev_stop,

    91

    .ndo_start_xmit = ec_eoedev_tx,

    92

    .ndo_get_stats = ec_eoedev_stats,

    93

};

    94

#endif

    95

    96

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

    97

    98

/** EoE constructor.

    99

 *

   100

 * Initializes the EoE handler, creates a net_device and registers it.

   101

 */

   102

int ec_eoe_init(

   103

        ec_eoe_t *eoe, /**< EoE handler */

   104

        ec_slave_t *slave /**< EtherCAT slave */

   105

        )

   106

{

   107

    ec_eoe_t **priv;

   108

    int i, ret = 0;

   109

    char name[EC_DATAGRAM_NAME_SIZE];

   110

   111

    eoe->slave = slave;

   112

   113

    ec_datagram_init(&eoe->datagram);

   114

    eoe->queue_datagram = 0;

   115

    eoe->state = ec_eoe_state_rx_start;

   116

    eoe->opened = 0;

   117

    eoe->rx_skb = NULL;

   118

    eoe->rx_expected_fragment = 0;

   119

    INIT_LIST_HEAD(&eoe->tx_queue);

   120

    eoe->tx_frame = NULL;

   121

    eoe->tx_queue_active = 0;

   122

    eoe->tx_queue_size = EC_EOE_TX_QUEUE_SIZE;

   123

    eoe->tx_queued_frames = 0;

   124

   125

    sema_init(&eoe->tx_queue_sem, 1);

   126

    eoe->tx_frame_number = 0xFF;

   127

    memset(&eoe->stats, 0, sizeof(struct net_device_stats));

   128

   129

    eoe->rx_counter = 0;

   130

    eoe->tx_counter = 0;

   131

    eoe->rx_rate = 0;

   132

    eoe->tx_rate = 0;

   133

    eoe->rate_jiffies = 0;

   134

    eoe->rx_idle = 1;

   135

    eoe->tx_idle = 1;

   136

   137

    /* device name eoe<MASTER>[as]<SLAVE>, because networking scripts don't

   138

     * like hyphens etc. in interface names. */

   139

    if (slave->effective_alias) {

   140

        snprintf(name, EC_DATAGRAM_NAME_SIZE,

   141

                "eoe%ua%u", slave->master->index, slave->effective_alias);

   142

    } else {

   143

        snprintf(name, EC_DATAGRAM_NAME_SIZE,

   144

                "eoe%us%u", slave->master->index, slave->ring_position);

   145

    }

   146

   147

    snprintf(eoe->datagram.name, EC_DATAGRAM_NAME_SIZE, name);

   148

   149

    if (!(eoe->dev = alloc_netdev(sizeof(ec_eoe_t *), name, ether_setup))) {

   150

        EC_SLAVE_ERR(slave, "Unable to allocate net_device %s"

   151

                " for EoE handler!\n", name);

   152

        ret = -ENODEV;

   153

        goto out_return;

   154

    }

   155

   156

    // initialize net_device

   157

#if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 29)

   158

    eoe->dev->netdev_ops = &ec_eoedev_ops;

   159

#else

   160

    eoe->dev->open = ec_eoedev_open;

   161

    eoe->dev->stop = ec_eoedev_stop;

   162

    eoe->dev->hard_start_xmit = ec_eoedev_tx;

   163

    eoe->dev->get_stats = ec_eoedev_stats;

   164

#endif

   165

   166

    for (i = 0; i < ETH_ALEN; i++)

   167

        eoe->dev->dev_addr[i] = i | (i << 4);

   168

   169

    // initialize private data

   170

    priv = netdev_priv(eoe->dev);

   171

    *priv = eoe;

   172

   173

    // Usually setting the MTU appropriately makes the upper layers

   174

    // do the frame fragmenting. In some cases this doesn't work

   175

    // so the MTU is left on the Ethernet standard value and fragmenting

   176

    // is done "manually".

   177

#if 0

   178

    eoe->dev->mtu = slave->configured_rx_mailbox_size - ETH_HLEN - 10;

   179

#endif

   180

   181

    // connect the net_device to the kernel

   182

    ret = register_netdev(eoe->dev);

   183

    if (ret) {

   184

        EC_SLAVE_ERR(slave, "Unable to register net_device:"

   185

                " error %i\n", ret);

   186

        goto out_free;

   187

    }

   188

   189

    // make the last address octet unique

   190

    eoe->dev->dev_addr[ETH_ALEN - 1] = (uint8_t) eoe->dev->ifindex;

   191

    return 0;

   192

   193

 out_free:

   194

    free_netdev(eoe->dev);

   195

    eoe->dev = NULL;

   196

 out_return:

   197

    return ret;

   198

}

   199

   200

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

   201

   202

/** EoE destructor.

   203

 *

   204

 * Unregisteres the net_device and frees allocated memory.

   205

 */

   206

void ec_eoe_clear(ec_eoe_t *eoe /**< EoE handler */)

   207

{

   208

    unregister_netdev(eoe->dev); // possibly calls close callback

   209

   210

    // empty transmit queue

   211

    ec_eoe_flush(eoe);

   212

   213

    if (eoe->tx_frame) {

   214

        dev_kfree_skb(eoe->tx_frame->skb);

   215

        kfree(eoe->tx_frame);

   216

    }

   217

   218

    if (eoe->rx_skb)

   219

        dev_kfree_skb(eoe->rx_skb);

   220

   221

    free_netdev(eoe->dev);

   222

   223

    ec_datagram_clear(&eoe->datagram);

   224

}

   225

   226

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

   227

   228

/** Empties the transmit queue.

   229

 */

   230

void ec_eoe_flush(ec_eoe_t *eoe /**< EoE handler */)

   231

{

   232

    ec_eoe_frame_t *frame, *next;

   233

   234

    down(&eoe->tx_queue_sem);

   235

   236

    list_for_each_entry_safe(frame, next, &eoe->tx_queue, queue) {

   237

        list_del(&frame->queue);

   238

        dev_kfree_skb(frame->skb);

   239

        kfree(frame);

   240

    }

   241

    eoe->tx_queued_frames = 0;

   242

   243

    up(&eoe->tx_queue_sem);

   244

}

   245

   246

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

   247

   248

/** Sends a frame or the next fragment.

   249

 */

   250

int ec_eoe_send(ec_eoe_t *eoe /**< EoE handler */)

   251

{

   252

    size_t remaining_size, current_size, complete_offset;

   253

    unsigned int last_fragment;

   254

    uint8_t *data;

   255

#if EOE_DEBUG_LEVEL >= 3

   256

    unsigned int i;

   257

#endif

   258

   259

    remaining_size = eoe->tx_frame->skb->len - eoe->tx_offset;

   260

   261

    if (remaining_size <= eoe->slave->configured_tx_mailbox_size - 10) {

   262

        current_size = remaining_size;

   263

        last_fragment = 1;

   264

    } else {

   265

        current_size = ((eoe->slave->configured_tx_mailbox_size - 10) / 32) * 32;

   266

        last_fragment = 0;

   267

    }

   268

   269

    if (eoe->tx_fragment_number) {

   270

        complete_offset = eoe->tx_offset / 32;

   271

    }

   272

    else {

   273

        // complete size in 32 bit blocks, rounded up.

   274

        complete_offset = remaining_size / 32 + 1;

   275

    }

   276

   277

#if EOE_DEBUG_LEVEL >= 2

   278

    EC_SLAVE_DBG(slave, 0, "EoE %s TX sending fragment %u%s"

   279

            " with %u octets (%u). %u frames queued.\n",

   280

            eoe->dev->name, eoe->tx_fragment_number,

   281

            last_fragment ? "" : "+", current_size, complete_offset,

   282

            eoe->tx_queued_frames);

   283

#endif

   284

   285

#if EOE_DEBUG_LEVEL >= 3

   286

    EC_SLAVE_DBG(master, 0, "");

   287

    for (i = 0; i < current_size; i++) {

   288

        printk("%02X ", eoe->tx_frame->skb->data[eoe->tx_offset + i]);

   289

        if ((i + 1) % 16 == 0) {

   290

            printk("\n");

   291

            EC_SLAVE_DBG(master, 0, "");

   292

        }

   293

    }

   294

    printk("\n");

   295

#endif

   296

   297

    data = ec_slave_mbox_prepare_send(eoe->slave, &eoe->datagram,

   298

            0x02, current_size + 4);

   299

    if (IS_ERR(data))

   300

        return PTR_ERR(data);

   301

   302

    EC_WRITE_U8 (data,     0x00); // eoe fragment req.

   303

    EC_WRITE_U8 (data + 1, last_fragment);

   304

    EC_WRITE_U16(data + 2, ((eoe->tx_fragment_number & 0x3F) |

   305

                            (complete_offset & 0x3F) << 6 |

   306

                            (eoe->tx_frame_number & 0x0F) << 12));

   307

   308

    memcpy(data + 4, eoe->tx_frame->skb->data + eoe->tx_offset, current_size);

   309

    eoe->queue_datagram = 1;

   310

   311

    eoe->tx_offset += current_size;

   312

    eoe->tx_fragment_number++;

   313

    return 0;

   314

}

   315

   316

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

   317

   318

/** Runs the EoE state machine.

   319

 */

   320

void ec_eoe_run(ec_eoe_t *eoe /**< EoE handler */)

   321

{

   322

    if (!eoe->opened)

   323

        return;

   324

   325

    // if the datagram was not sent, or is not yet received, skip this cycle

   326

    if (eoe->queue_datagram || eoe->datagram.state == EC_DATAGRAM_SENT)

   327

        return;

   328

   329

    // call state function

   330

    eoe->state(eoe);

   331

   332

    // update statistics

   333

    if (jiffies - eoe->rate_jiffies > HZ) {

   334

        eoe->rx_rate = eoe->rx_counter;

   335

        eoe->tx_rate = eoe->tx_counter;

   336

        eoe->rx_counter = 0;

   337

        eoe->tx_counter = 0;

   338

        eoe->rate_jiffies = jiffies;

   339

    }

   340

   341

    ec_datagram_output_stats(&eoe->datagram);

   342

}

   343

   344

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

   345

   346

/** Queues the datagram, if necessary.

   347

 */

   348

void ec_eoe_queue(ec_eoe_t *eoe /**< EoE handler */)

   349

{

   350

   if (eoe->queue_datagram) {

   351

       ec_master_queue_datagram_ext(eoe->slave->master, &eoe->datagram);

   352

       eoe->queue_datagram = 0;

   353

   }

   354

}

   355

   356

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

   357

   358

/** Returns the state of the device.

   359

 *

   360

 * \return 1 if the device is "up", 0 if it is "down"

   361

 */

   362

int ec_eoe_is_open(const ec_eoe_t *eoe /**< EoE handler */)

   363

{

   364

    return eoe->opened;

   365

}

   366

   367

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

   368

   369

/** Returns the idle state.

   370

 *

   371

 * \retval 1 The device is idle.

   372

 * \retval 0 The device is busy.

   373

 */

   374

int ec_eoe_is_idle(const ec_eoe_t *eoe /**< EoE handler */)

   375

{

   376

    return eoe->rx_idle && eoe->tx_idle;

   377

}

   378

   379

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

   380

 *  STATE PROCESSING FUNCTIONS

   381

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

   382

   383

/** State: RX_START.

   384

 *

   385

 * Starts a new receiving sequence by queueing a datagram that checks the

   386

 * slave's mailbox for a new EoE datagram.

   387

 *

   388

 * \fixme Use both devices.

   389

 */

   390

void ec_eoe_state_rx_start(ec_eoe_t *eoe /**< EoE handler */)

   391

{

   392

    if (eoe->slave->error_flag ||

   393

            !eoe->slave->master->devices[EC_DEVICE_MAIN].link_state) {

   394

        eoe->rx_idle = 1;

   395

        eoe->tx_idle = 1;

   396

        return;

   397

    }

   398

   399

    ec_slave_mbox_prepare_check(eoe->slave, &eoe->datagram);

   400

    eoe->queue_datagram = 1;

   401

    eoe->state = ec_eoe_state_rx_check;

   402

}

   403

   404

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

   405

   406

/** State: RX_CHECK.

   407

 *

   408

 * Processes the checking datagram sent in RX_START and issues a receive

   409

 * datagram, if new data is available.

   410

 */

   411

void ec_eoe_state_rx_check(ec_eoe_t *eoe /**< EoE handler */)

   412

{

   413

    if (eoe->datagram.state != EC_DATAGRAM_RECEIVED) {

   414

        eoe->stats.rx_errors++;

   415

#if EOE_DEBUG_LEVEL >= 1

   416

        EC_SLAVE_WARN(eoe->slave, "Failed to receive mbox"

   417

                " check datagram for %s.\n", eoe->dev->name);

   418

#endif

   419

        eoe->state = ec_eoe_state_tx_start;

   420

        return;

   421

    }

   422

   423

    if (!ec_slave_mbox_check(&eoe->datagram)) {

   424

        eoe->rx_idle = 1;

   425

        eoe->state = ec_eoe_state_tx_start;

   426

        return;

   427

    }

   428

   429

    eoe->rx_idle = 0;

   430

    ec_slave_mbox_prepare_fetch(eoe->slave, &eoe->datagram);

   431

    eoe->queue_datagram = 1;

   432

    eoe->state = ec_eoe_state_rx_fetch;

   433

}

   434

   435

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

   436

   437

/** State: RX_FETCH.

   438

 *

   439

 * Checks if the requested data of RX_CHECK was received and processes the EoE

   440

 * datagram.

   441

 */

   442

void ec_eoe_state_rx_fetch(ec_eoe_t *eoe /**< EoE handler */)

   443

{

   444

    size_t rec_size, data_size;

   445

    uint8_t *data, frame_type, last_fragment, time_appended, mbox_prot;

   446

    uint8_t fragment_offset, fragment_number;

   447

#if EOE_DEBUG_LEVEL >= 2

   448

    uint8_t frame_number;

   449

#endif

   450

    off_t offset;

   451

#if EOE_DEBUG_LEVEL >= 3

   452

    unsigned int i;

   453

#endif

   454

   455

    if (eoe->datagram.state != EC_DATAGRAM_RECEIVED) {

   456

        eoe->stats.rx_errors++;

   457

#if EOE_DEBUG_LEVEL >= 1

   458

        EC_SLAVE_WARN(eoe->slave, "Failed to receive mbox"

   459

                " fetch datagram for %s.\n", eoe->dev->name);

   460

#endif

   461

        eoe->state = ec_eoe_state_tx_start;

   462

        return;

   463

    }

   464

   465

    data = ec_slave_mbox_fetch(eoe->slave, &eoe->datagram,

   466

            &mbox_prot, &rec_size);

   467

    if (IS_ERR(data)) {

   468

        eoe->stats.rx_errors++;

   469

#if EOE_DEBUG_LEVEL >= 1

   470

        EC_SLAVE_WARN(eoe->slave, "Invalid mailbox response for %s.\n",

   471

                eoe->dev->name);

   472

#endif

   473

        eoe->state = ec_eoe_state_tx_start;

   474

        return;

   475

    }

   476

   477

    if (mbox_prot != 0x02) { // EoE FIXME mailbox handler necessary

   478

        eoe->stats.rx_errors++;

   479

#if EOE_DEBUG_LEVEL >= 1

   480

        EC_SLAVE_WARN(eoe->slave, "Other mailbox protocol response for %s.\n",

   481

                eoe->dev->name);

   482

#endif

   483

        eoe->state = ec_eoe_state_tx_start;

   484

        return;