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

   EtherCAT domain methods.

    33

*/

    34

    35

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

    36

    37

#include <linux/module.h>

    38

    39

#include "globals.h"

    40

#include "master.h"

    41

#include "slave_config.h"

    42

    43

#include "domain.h"

    44

#include "datagram_pair.h"

    45

    48

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

    49

    50

void ec_domain_clear_data(ec_domain_t *);

    51

    52

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

    53

    54

/** Domain constructor.

    55

 */

    56

void ec_domain_init(

    57

        ec_domain_t *domain, /**< EtherCAT domain. */

    58

        ec_master_t *master, /**< Parent master. */

    59

        unsigned int index /**< Index. */

    60

        )

    61

{

    62

    domain->master = master;

    63

    domain->index = index;

    64

    INIT_LIST_HEAD(&domain->fmmu_configs);

    65

    domain->data_size = 0;

    66

    domain->data = NULL;

    67

    domain->data_origin = EC_ORIG_INTERNAL;

    68

    domain->logical_base_address = 0x00000000;

    69

    INIT_LIST_HEAD(&domain->datagram_pairs);

    70

    domain->working_counter = 0x0000;

    71

    domain->expected_working_counter = 0x0000;

    72

    domain->working_counter_changes = 0;

    73

    domain->notify_jiffies = 0;

    74

}

    75

    76

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

    77

    78

/** Domain destructor.

    79

 */

    80

void ec_domain_clear(ec_domain_t *domain /**< EtherCAT domain */)

    81

{

    82

    ec_datagram_pair_t *datagram_pair, *next_pair;

    83

    84

    // dequeue and free datagrams

    85

    list_for_each_entry_safe(datagram_pair, next_pair,

    86

            &domain->datagram_pairs, list) {

    87

        ec_datagram_pair_clear(datagram_pair);

    88

        kfree(datagram_pair);

    89

    }

    90

    91

    ec_domain_clear_data(domain);

    92

}

    93

    94

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

    95

    96

/** Frees internally allocated memory.

    97

 */

    98

void ec_domain_clear_data(

    99

        ec_domain_t *domain /**< EtherCAT domain. */

   100

        )

   101

{

   102

    if (domain->data_origin == EC_ORIG_INTERNAL && domain->data) {

   103

        kfree(domain->data);

   104

    }

   105

   106

    domain->data = NULL;

   107

    domain->data_origin = EC_ORIG_INTERNAL;

   108

}

   109

   110

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

   111

   112

/** Adds an FMMU configuration to the domain.

   113

 */

   114

void ec_domain_add_fmmu_config(

   115

        ec_domain_t *domain, /**< EtherCAT domain. */

   116

        ec_fmmu_config_t *fmmu /**< FMMU configuration. */

   117

        )

   118

{

   119

    fmmu->domain = domain;

   120

   121

    domain->data_size += fmmu->data_size;

   122

    list_add_tail(&fmmu->list, &domain->fmmu_configs);

   123

   124

    EC_MASTER_DBG(domain->master, 1, "Domain %u:"

   125

            " Added %u bytes, total %zu.\n",

   126

            domain->index, fmmu->data_size, domain->data_size);

   127

}

   128

   129

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

   130

   131

/** Allocates a domain datagram pair and appends it to the list.

   132

 *

   133

 * The datagrams' types and expected working counters are determined by the

   134

 * number of input and output fmmus that share the datagrams.

   135

 *

   136

 * \retval  0 Success.

   137

 * \retval <0 Error code.

   138

 */

   139

int ec_domain_add_datagram_pair(

   140

        ec_domain_t *domain, /**< EtherCAT domain. */

   141

        uint32_t logical_offset, /**< Logical offset. */

   142

        size_t data_size, /**< Size of the data. */

   143

        uint8_t *data, /**< Process data. */

   144

        const unsigned int used[] /**< Slave config counter for in/out. */

   145

        )

   146

{

   147

    ec_datagram_pair_t *datagram_pair;

   148

    int ret;

   149

   150

    if (!(datagram_pair = kmalloc(sizeof(ec_datagram_pair_t), GFP_KERNEL))) {

   151

        EC_MASTER_ERR(domain->master,

   152

                "Failed to allocate domain datagram pair!\n");

   153

        return -ENOMEM;

   154

    }

   155

   158

    if (ret) {

   159

        kfree(datagram_pair);

   160

        return ret;

   161

    }

   162

   170

   171

    list_add_tail(&datagram_pair->list, &domain->datagram_pairs);

   172

    return 0;

   173

}

   174

   175

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

   176

   177

/** Domain finish helper function.

   178

 *

   179

 * Detects, if a slave configuration has already been taken into account for

   180

 * a datagram's expected working counter calculation.

   181

 *

   182

 * Walks through the list of all FMMU configurations for the current datagram

   183

 * and ends before the current datagram.

   184

 */

   185

int shall_count(

   186

        const ec_fmmu_config_t *cur_fmmu, /**< Current FMMU with direction to

   187

                                            search for. */

   188

        const ec_fmmu_config_t *first_fmmu /**< Datagram's first FMMU. */

   189

        )

   190

{

   191

    for (; first_fmmu != cur_fmmu;

   192

            first_fmmu = list_entry(first_fmmu->list.next,

   193

                ec_fmmu_config_t, list)) {

   194

   195

        if (first_fmmu->sc == cur_fmmu->sc

   196

                && first_fmmu->dir == cur_fmmu->dir) {

   197

            return 0; // was already counted

   198

        }

   199

    }

   200

   201

    return 1;

   202

}

   203

   204

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

   205

   206

/** Finishes a domain.

   207

 *

   208

 * This allocates the necessary datagrams and writes the correct logical

   209

 * addresses to every configured FMMU.

   210

 *

   211

 * \todo Check for FMMUs that do not fit into any datagram.

   212

 *

   213

 * \retval  0 Success

   214

 * \retval <0 Error code.

   215

 */

   216

int ec_domain_finish(

   217

        ec_domain_t *domain, /**< EtherCAT domain. */

   218

        uint32_t base_address /**< Logical base address. */

   219

        )

   220

{

   221

    uint32_t datagram_offset;

   222

    size_t datagram_size;

   223

    unsigned int datagram_count;

   224

    unsigned int datagram_used[EC_DIR_COUNT];

   225

    ec_fmmu_config_t *fmmu;

   226

    const ec_fmmu_config_t *datagram_first_fmmu = NULL;

   227

    const ec_datagram_pair_t *datagram_pair;

   228

    int ret;

   229

   230

    domain->logical_base_address = base_address;

   231

   232

    if (domain->data_size && domain->data_origin == EC_ORIG_INTERNAL) {

   233

        if (!(domain->data =

   234

                    (uint8_t *) kmalloc(domain->data_size, GFP_KERNEL))) {

   235

            EC_MASTER_ERR(domain->master, "Failed to allocate %zu bytes"

   236

                    " internal memory for domain %u!\n",

   237

                    domain->data_size, domain->index);

   238

            return -ENOMEM;

   239

        }

   240

    }

   241

   242

    // Cycle through all domain FMMUs and

   243

    // - correct the logical base addresses

   244

    // - set up the datagrams to carry the process data

   245

    // - calculate the datagrams' expected working counters

   246

    datagram_offset = 0;

   247

    datagram_size = 0;

   248

    datagram_count = 0;

   249

    datagram_used[EC_DIR_OUTPUT] = 0;

   250

    datagram_used[EC_DIR_INPUT] = 0;

   251

   252

    if (!list_empty(&domain->fmmu_configs)) {

   253

        datagram_first_fmmu =

   254

            list_entry(domain->fmmu_configs.next, ec_fmmu_config_t, list);

   255

    }

   256

   257

    list_for_each_entry(fmmu, &domain->fmmu_configs, list) {

   258

   259

        // Correct logical FMMU address

   260

        fmmu->logical_start_address += base_address;

   261

   262

        // Increment Input/Output counter to determine datagram types

   263

        // and calculate expected working counters

   264

        if (shall_count(fmmu, datagram_first_fmmu)) {

   265

            datagram_used[fmmu->dir]++;

   266

        }

   267

   268

        // If the current FMMU's data do not fit in the current datagram,

   269

        // allocate a new one.

   270

        if (datagram_size + fmmu->data_size > EC_MAX_DATA_SIZE) {

   271

            ret = ec_domain_add_datagram_pair(domain,

   272

                    domain->logical_base_address + datagram_offset,

   273

                    datagram_size, domain->data + datagram_offset,

   274

                    datagram_used);

   275

            if (ret < 0)

   276

                return ret;

   277

   278

            datagram_offset += datagram_size;

   279

            datagram_size = 0;

   280

            datagram_count++;

   281

            datagram_used[EC_DIR_OUTPUT] = 0;

   282

            datagram_used[EC_DIR_INPUT] = 0;

   283

            datagram_first_fmmu = fmmu;

   284

        }

   285

   286

        datagram_size += fmmu->data_size;

   287

    }

   288

   289

    /* Allocate last datagram pair, if data are left (this is also the case if

   290

     * the process data fit into a single datagram) */

   291

    if (datagram_size) {

   292

        ret = ec_domain_add_datagram_pair(domain,

   293

                domain->logical_base_address + datagram_offset,

   294

                datagram_size, domain->data + datagram_offset,

   295

                datagram_used);

   296

        if (ret < 0)

   297

            return ret;

   298

        datagram_count++;

   299

    }

   300

   301

    EC_MASTER_INFO(domain->master, "Domain%u: Logical address 0x%08x,"

   302

            " %zu byte, expected working counter %u.\n", domain->index,

   303

            domain->logical_base_address, domain->data_size,

   304

            domain->expected_working_counter);

   305

   306

    list_for_each_entry(datagram_pair, &domain->datagram_pairs, list) {

   307

        const ec_datagram_t *datagram =

   308

            &datagram_pair->datagrams[EC_DEVICE_MAIN];

   309

        EC_MASTER_INFO(domain->master, "  Datagram %s: Logical offset 0x%08x,"

   310

                " %zu byte, type %s.\n", datagram->name,

   311

                EC_READ_U32(datagram->address), datagram->data_size,

   312

                ec_datagram_type_string(datagram));

   313

    }

   314

   315

    return 0;

   316

}

   317

   318

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

   319

   320

/** Get the number of FMMU configurations of the domain.

   321

 */

   322

unsigned int ec_domain_fmmu_count(const ec_domain_t *domain)

   323

{

   324

    const ec_fmmu_config_t *fmmu;

   325

    unsigned int num = 0;

   326

   327

    list_for_each_entry(fmmu, &domain->fmmu_configs, list) {

   328

        num++;

   329

    }

   330

   331

    return num;

   332

}

   333

   334

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

   335

   336

/** Get a certain FMMU configuration via its position in the list.

   337

 */

   338

const ec_fmmu_config_t *ec_domain_find_fmmu(

   339

        const ec_domain_t *domain, /**< EtherCAT domain. */

   340

        unsigned int pos /**< List position. */

   341

        )

   342

{

   343

    const ec_fmmu_config_t *fmmu;

   344

   345

    list_for_each_entry(fmmu, &domain->fmmu_configs, list) {

   346

        if (pos--)

   347

            continue;

   348

        return fmmu;

   349

    }

   350

   351

    return NULL;

   352

}

   353

   354

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

   355

 *  Application interface

   356

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

   357

   358

int ecrt_domain_reg_pdo_entry_list(ec_domain_t *domain,

   359

        const ec_pdo_entry_reg_t *regs)

   360

{

   361

    const ec_pdo_entry_reg_t *reg;

   362

    ec_slave_config_t *sc;

   363

    int ret;

   364

   365

    EC_MASTER_DBG(domain->master, 1, "ecrt_domain_reg_pdo_entry_list("

   366

            "domain = 0x%p, regs = 0x%p)\n", domain, regs);

   367

   368

    for (reg = regs; reg->index; reg++) {

   369

        sc = ecrt_master_slave_config_err(domain->master, reg->alias,

   370

                reg->position, reg->vendor_id, reg->product_code);

   371

        if (IS_ERR(sc))

   372

            return PTR_ERR(sc);

   373

   374

        ret = ecrt_slave_config_reg_pdo_entry(sc, reg->index,

   375

                        reg->subindex, domain, reg->bit_position);

   376

        if (ret < 0)

   377

            return ret;

   378

   379

        *reg->offset = ret;

   380

    }

   381

   382

    return 0;

   383

}

   384

   385

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

   386

   387

size_t ecrt_domain_size(const ec_domain_t *domain)

   388

{

   389

    return domain->data_size;

   390

}

   391

   392

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

   393

   394

void ecrt_domain_external_memory(ec_domain_t *domain, uint8_t *mem)

   395

{

   396

    EC_MASTER_DBG(domain->master, 1, "ecrt_domain_external_memory("

   397

            "domain = 0x%p, mem = 0x%p)\n", domain, mem);

   398

   399

    down(&domain->master->master_sem);

   400

   401

    ec_domain_clear_data(domain);

   402

   403

    domain->data = mem;

   404

    domain->data_origin = EC_ORIG_EXTERNAL;

   405

   406

    up(&domain->master->master_sem);

   407

}

   408

   409

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

   410

   411

uint8_t *ecrt_domain_data(ec_domain_t *domain)

   412

{

   413

    return domain->data;

   414

}

   415

   416

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

   417

   418

void ecrt_domain_process(ec_domain_t *domain)

   419

{

   420

    uint16_t working_counter_sum;

   431

   432

    working_counter_sum = 0;