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

   Ethernet-over-EtherCAT (EoE).

    37

*/

    38

    39

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

    40

    41

#include <linux/netdevice.h>

    42

#include <linux/etherdevice.h>

    43

    44

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

    45

#include "globals.h"

    46

#include "master.h"

    47

#include "slave.h"

    48

#include "mailbox.h"

    49

#include "ethernet.h"

    50

    51

/**

    52

   Defines the debug level of EoE processing

    53

    54

   0 = No debug messages.

    55

   1 = Output actions.

    56

   2 = Output actions and frame data.

    57

*/

    58

    59

#define EOE_DEBUG_LEVEL 0

    60

    61

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

    62

    63

void ec_eoe_flush(ec_eoe_t *);

    64

    65

// state functions

    66

void ec_eoe_state_rx_start(ec_eoe_t *);

    67

void ec_eoe_state_rx_check(ec_eoe_t *);

    68

void ec_eoe_state_rx_fetch(ec_eoe_t *);

    69

void ec_eoe_state_tx_start(ec_eoe_t *);

    70

void ec_eoe_state_tx_sent(ec_eoe_t *);

    71

    72

// net_device functions

    73

int ec_eoedev_open(struct net_device *);

    74

int ec_eoedev_stop(struct net_device *);

    75

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

    76

struct net_device_stats *ec_eoedev_stats(struct net_device *);

    77

    78

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

    79

    80

/**

    81

   EoE constructor.

    82

   Initializes the EoE handler, creates a net_device and registeres it.

    83

*/

    84

    85

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

    86

{

    87

    ec_eoe_t **priv;

    88

    int result, i;

    89

    90

    eoe->slave = NULL;

    91

    ec_datagram_init(&eoe->datagram);

    92

    eoe->state = ec_eoe_state_rx_start;

    93

    eoe->opened = 0;

    94

    eoe->rx_skb = NULL;

    95

    eoe->rx_expected_fragment = 0;

    96

    INIT_LIST_HEAD(&eoe->tx_queue);

    97

    eoe->tx_frame = NULL;

    98

    eoe->tx_queue_active = 0;

    99

    eoe->tx_queued_frames = 0;

   100

    eoe->tx_queue_lock = SPIN_LOCK_UNLOCKED;

   101

    eoe->tx_frame_number = 0xFF;

   102

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

   103

   104

    eoe->rx_counter = 0;

   105

    eoe->tx_counter = 0;

   106

    eoe->rx_rate = 0;

   107

    eoe->tx_rate = 0;

   108

    eoe->rate_jiffies = 0;

   109

   110

    if (!(eoe->dev =

   111

          alloc_netdev(sizeof(ec_eoe_t *), "eoe%d", ether_setup))) {

   112

        EC_ERR("Unable to allocate net_device for EoE handler!\n");

   113

        goto out_return;

   114

    }

   115

   116

    // initialize net_device

   117

    eoe->dev->open = ec_eoedev_open;

   118

    eoe->dev->stop = ec_eoedev_stop;

   119

    eoe->dev->hard_start_xmit = ec_eoedev_tx;

   120

    eoe->dev->get_stats = ec_eoedev_stats;

   121

   122

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

   123

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

   124

   125

    // initialize private data

   126

    priv = netdev_priv(eoe->dev);

   127

    *priv = eoe;

   128

   129

    // Usually setting the MTU appropriately makes the upper layers

   130

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

   131

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

   132

    // is done "manually".

   133

#if 0

   134

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

   135

#endif

   136

   137

    // connect the net_device to the kernel

   138

    if ((result = register_netdev(eoe->dev))) {

   139

        EC_ERR("Unable to register net_device: error %i\n", result);

   140

        goto out_free;

   141

    }

   142

   143

    // make the last address octet unique

   144

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

   145

   146

    return 0;

   147

   148

 out_free:

   149

    free_netdev(eoe->dev);

   150

    eoe->dev = NULL;

   151

 out_return:

   152

    return -1;

   153

}

   154

   155

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

   156

   157

/**

   158

   EoE destructor.

   159

   Unregisteres the net_device and frees allocated memory.

   160

*/

   161

   162

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

   163

{

   164

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

   165

    free_netdev(eoe->dev);

   166

   167

    // empty transmit queue

   168

    ec_eoe_flush(eoe);

   169

   170

    if (eoe->tx_frame) {

   171

        dev_kfree_skb(eoe->tx_frame->skb);

   172

        kfree(eoe->tx_frame);

   173

    }

   174

   175

    if (eoe->rx_skb) dev_kfree_skb(eoe->rx_skb);

   176

   177

    ec_datagram_clear(&eoe->datagram);

   178

}

   179

   180

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

   181

   182

/**

   183

   Empties the transmit queue.

   184

*/

   185

   186

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

   187

{

   188

    ec_eoe_frame_t *frame, *next;

   189

   190

    spin_lock_bh(&eoe->tx_queue_lock);

   191

   192

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

   193

        list_del(&frame->queue);

   194

        dev_kfree_skb(frame->skb);

   195

        kfree(frame);

   196

    }

   197

    eoe->tx_queued_frames = 0;

   198

   199

    spin_unlock_bh(&eoe->tx_queue_lock);

   200

}

   201

   202

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

   203

   204

/**

   205

   Sends a frame or the next fragment.

   206

*/

   207

   208

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

   209

{

   210

    size_t remaining_size, current_size, complete_offset;

   211

    unsigned int last_fragment;

   212

    uint8_t *data;

   213

#if EOE_DEBUG_LEVEL > 1

   214

    unsigned int i;

   215

#endif

   216

   217

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

   218

   219

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

   220

        current_size = remaining_size;

   221

        last_fragment = 1;

   222

    }

   223

    else {

   224

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

   225

        last_fragment = 0;

   226

    }

   227

   228

    if (eoe->tx_fragment_number) {

   229

        complete_offset = eoe->tx_offset / 32;

   230

    }

   231

    else {

   232

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

   233

        complete_offset = remaining_size / 32 + 1;

   234

    }

   235

   236

#if EOE_DEBUG_LEVEL > 0

   237

    EC_DBG("EoE TX sending %sfragment %i with %i octets (%i)."

   238

           " %i frames queued.\n", last_fragment ? "last " : "",

   239

           eoe->tx_fragment_number, current_size, complete_offset,

   240

           eoe->tx_queued_frames);

   241

#endif

   242

   243

#if EOE_DEBUG_LEVEL > 1

   244

    EC_DBG("");

   245

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

   246

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

   247

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

   248

            printk("\n");

   249

            EC_DBG("");

   250

        }

   251

    }

   252

    printk("\n");

   253

#endif

   254

   255

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

   256

                                            0x02, current_size + 4)))

   257

        return -1;

   258

   259

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

   260

    EC_WRITE_U8 (data + 1, last_fragment);

   261

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

   262

                            (complete_offset & 0x3F) << 6 |

   263

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

   264

   265

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

   266

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

   267

   268

    eoe->tx_offset += current_size;

   269

    eoe->tx_fragment_number++;

   270

    return 0;

   271

}

   272

   273

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

   274

   275

/**

   276

   Runs the EoE state machine.

   277

*/

   278

   279

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

   280

{

   281

    if (!eoe->opened) return;

   282

   283

    // call state function

   284

    eoe->state(eoe);

   285

   286

    // update statistics

   287

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

   288

        eoe->rx_rate = eoe->rx_counter * 8;

   289

        eoe->tx_rate = eoe->tx_counter * 8;

   290

        eoe->rx_counter = 0;

   291

        eoe->tx_counter = 0;

   292

        eoe->rate_jiffies = jiffies;

   293

    }

   294

}

   295

   296

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

   297

   298

/**

   299

   Returns the state of the device.

   300

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

   301

*/

   302

   303

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

   304

{

   305

    return eoe->slave && eoe->opened;

   306

}

   307

   308

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

   309

 *  STATE PROCESSING FUNCTIONS

   310

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

   311

   312

/**

   313

   State: RX_START.

   314

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

   315

   slave's mailbox for a new EoE datagram.

   316

*/

   317

   318

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

   319

{

   320

    if (!eoe->slave->online || !eoe->slave->master->main_device.link_state)

   321

        return;

   322

   323

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

   324

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

   325

    eoe->state = ec_eoe_state_rx_check;

   326

}

   327

   328

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

   329

   330

/**

   331

   State: RX_CHECK.

   332

   Processes the checking datagram sent in RX_START and issues a receive

   333

   datagram, if new data is available.

   334

*/

   335

   336

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

   337

{

   338

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

   339

        eoe->stats.rx_errors++;

   340

        eoe->state = ec_eoe_state_tx_start;

   341

        return;

   342

    }

   343

   344

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

   345

        eoe->state = ec_eoe_state_tx_start;

   346

        return;

   347

    }

   348

   349

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

   350

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

   351

    eoe->state = ec_eoe_state_rx_fetch;

   352

}

   353

   354

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

   355

   356

/**

   357

   State: RX_FETCH.

   358

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

   359

   EoE datagram.

   360

*/

   361

   362

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

   363

{

   364

    size_t rec_size, data_size;

   365

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

   366

    uint8_t frame_number, fragment_offset, fragment_number;

   367

    off_t offset;

   368

#if EOE_DEBUG_LEVEL > 1

   369

    unsigned int i;

   370

#endif

   371

   372

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

   373

        eoe->stats.rx_errors++;

   374

        eoe->state = ec_eoe_state_tx_start;

   375

        return;

   376

    }

   377

   378

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

   379

                                     &mbox_prot, &rec_size))) {

   380

        eoe->stats.rx_errors++;

   381

        eoe->state = ec_eoe_state_tx_start;

   382

        return;

   383

    }

   384

   385

    if (mbox_prot != 0x02) { // EoE

   386

        eoe->stats.rx_errors++;

   387

        eoe->state = ec_eoe_state_tx_start;

   388

        return;

   389

    }

   390

   391

    frame_type = EC_READ_U16(data) & 0x000F;

   392

   393

    if (frame_type != 0x00) {

   394

#if EOE_DEBUG_LEVEL > 0

   395

        EC_DBG("other frame received.\n");

   396

#endif

   397

        eoe->stats.rx_dropped++;

   398

        eoe->state = ec_eoe_state_tx_start;

   399

        return;

   400

    }

   401

   402

    // EoE Fragment Request received

   403

   404

    last_fragment = (EC_READ_U16(data) >> 8) & 0x0001;

   405

    time_appended = (EC_READ_U16(data) >> 9) & 0x0001;

   406

    fragment_number = EC_READ_U16(data + 2) & 0x003F;

   407

    fragment_offset = (EC_READ_U16(data + 2) >> 6) & 0x003F;

   408

    frame_number = (EC_READ_U16(data + 2) >> 12) & 0x000F;

   409

   410

#if EOE_DEBUG_LEVEL > 0

   411

    EC_DBG("EoE RX fragment %i, offset %i, frame %i%s%s,"

   412

           " %i octets\n", fragment_number, fragment_offset,

   413

           frame_number,

   414

           last_fragment ? ", last fragment" : "",

   415

           time_appended ? ", + timestamp" : "",

   416

           time_appended ? rec_size - 8 : rec_size - 4);

   417

#endif

   418

   419

#if EOE_DEBUG_LEVEL > 1

   420

    EC_DBG("");

   421

    for (i = 0; i < rec_size - 4; i++) {

   422

        printk("%02X ", data[i + 4]);

   423

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

   424

            printk("\n");

   425

            EC_DBG("");

   426

        }

   427

    }

   428

    printk("\n");

   429

#endif

   430

   431

    data_size = time_appended ? rec_size - 8 : rec_size - 4;

   432

   433

    if (!fragment_number) {

   434

        if (eoe->rx_skb) {

   435

            EC_WARN("EoE RX freeing old socket buffer...\n");

   436

            dev_kfree_skb(eoe->rx_skb);

   437

        }

   438

   439

        // new socket buffer

   440

        if (!(eoe->rx_skb = dev_alloc_skb(fragment_offset * 32))) {

   441

            if (printk_ratelimit())

   442

                EC_WARN("EoE RX low on mem. frame dropped.\n");

   443

            eoe->stats.rx_dropped++;

   444

            eoe->state = ec_eoe_state_tx_start;

   445

            return;

   446

        }

   447

   448

        eoe->rx_skb_offset = 0;

   449

        eoe->rx_skb_size = fragment_offset * 32;

   450

        eoe->rx_expected_fragment = 0;

   451

    }

   452

    else {

   453

        if (!eoe->rx_skb) {

   454

            eoe->stats.rx_dropped++;

   455

            eoe->state = ec_eoe_state_tx_start;

   456

            return;

   457

        }

   458

   459

        offset = fragment_offset * 32;

   460

        if (offset != eoe->rx_skb_offset ||

   461

            offset + data_size > eoe->rx_skb_size ||

   462

            fragment_number != eoe->rx_expected_fragment) {

   463

            dev_kfree_skb(eoe->rx_skb);

   464

            eoe->rx_skb = NULL;

   465

            eoe->stats.rx_errors++;

   466

            eoe->state = ec_eoe_state_tx_start;

   467

            return;

   468

        }

   469

    }

   470

   471

    // copy fragment into socket buffer

   472

    memcpy(skb_put(eoe->rx_skb, data_size), data + 4, data_size);

   473

    eoe->rx_skb_offset += data_size;

   474

   475

    if (last_fragment) {

   476

        // update statistics

   477

        eoe->stats.rx_packets++;

   478

        eoe->stats.rx_bytes += eoe->rx_skb->len;

   479

        eoe->rx_counter += eoe->rx_skb->len;

   480

   481

#if EOE_DEBUG_LEVEL > 0

   482

        EC_DBG("EoE RX frame completed with %u octets.\n",

   483

               eoe->rx_skb->len);

   484

#endif

   485

   486

        // pass socket buffer to network stack

   487

        eoe->rx_skb->dev = eoe->dev;

   488

        eoe->rx_skb->protocol = eth_type_trans(eoe->rx_skb, eoe->dev);

   489

        eoe->rx_skb->ip_summed = CHECKSUM_UNNECESSARY;