1

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

     2

 *

     3

 *  d o m a i n . c

     4

 *

     5

 *  Methoden für Gruppen von EtherCAT-Slaves.

     6

 *

     7

 *  $Id$

     8

 *

     9

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

    10

    11

#include "globals.h"

    12

#include "domain.h"

    13

#include "master.h"

    14

    15

void ec_domain_clear_field_regs(ec_domain_t *);

    16

    17

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

    18

    19

/**

    20

   Konstruktor einer EtherCAT-Domäne.

    21

*/

    22

    23

void ec_domain_init(ec_domain_t *domain, /**< Domäne */

    24

                    ec_master_t *master, /**< Zugehöriger Master */

    25

                    ec_domain_mode_t mode, /**< Synchron/Asynchron */

    26

                    unsigned int timeout_us /**< Timeout in Mikrosekunden */

    27

                    )

    28

{

    29

    domain->master = master;

    30

    domain->mode = mode;

    31

    domain->timeout_us = timeout_us;

    32

    33

    domain->data = NULL;

    34

    domain->data_size = 0;

    35

    domain->commands = NULL;

    36

    domain->command_count = 0;

    37

    domain->base_address = 0;

    38

    domain->response_count = 0xFFFFFFFF;

    39

    40

    INIT_LIST_HEAD(&domain->field_regs);

    41

}

    42

    43

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

    44

    45

/**

    46

   Destruktor einer EtherCAT-Domäne.

    47

*/

    48

    49

void ec_domain_clear(ec_domain_t *domain /**< Domäne */)

    50

{

    51

    if (domain->data) kfree(domain->data);

    52

    if (domain->commands) kfree(domain->commands);

    53

    54

    ec_domain_clear_field_regs(domain);

    55

}

    56

    57

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

    58

    59

/**

    60

   Registriert ein Feld in einer Domäne.

    61

    62

   \return 0 bei Erfolg, < 0 bei Fehler

    63

*/

    64

    65

int ec_domain_reg_field(ec_domain_t *domain, /**< Domäne */

    66

                        ec_slave_t *slave, /**< Slave */

    67

                        const ec_sync_t *sync, /**< Sync-Manager */

    68

                        uint32_t field_offset, /**< Datenfeld-Offset */

    69

                        void **data_ptr /**< Adresse des Prozessdatenzeigers */

    70

                        )

    71

{

    72

    ec_field_reg_t *field_reg;

    73

    74

    if (!(field_reg = (ec_field_reg_t *) kmalloc(sizeof(ec_field_reg_t),

    75

                                                 GFP_KERNEL))) {

    76

        EC_ERR("Failed to allocate field registration.\n");

    77

        return -1;

    78

    }

    79

    80

    if (ec_slave_set_fmmu(slave, domain, sync)) {

    81

        EC_ERR("FMMU configuration failed.\n");

    82

        kfree(field_reg);

    83

        return -1;

    84

    }

    85

    86

    field_reg->slave = slave;

    87

    field_reg->sync = sync;

    88

    field_reg->field_offset = field_offset;

    89

    field_reg->data_ptr = data_ptr;

    90

    91

    list_add_tail(&field_reg->list, &domain->field_regs);

    92

    93

    return 0;

    94

}

    95

    96

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

    97

    98

/**

    99

   Gibt die Liste der registrierten Datenfelder frei.

   100

*/

   101

   102

void ec_domain_clear_field_regs(ec_domain_t *domain)

   103

{

   104

    ec_field_reg_t *field_reg, *next;

   105

   106

    list_for_each_entry_safe(field_reg, next, &domain->field_regs, list) {

   107

        list_del(&field_reg->list);

   108

        kfree(field_reg);

   109

    }

   110

}

   111

   112

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

   113

   114

/**

   115

   Erzeugt eine Domäne.

   116

   117

   Reserviert den Speicher einer Domäne, berechnet die logischen Adressen der

   118

   FMMUs und setzt die Prozessdatenzeiger der registrierten Felder.

   119

   120

   \return 0 bei Erfolg, < 0 bei Fehler

   121

*/

   122

   123

int ec_domain_alloc(ec_domain_t *domain, /**< Domäne */

   124

                    uint32_t base_address /**< Logische Basisadresse */

   125

                    )

   126

{

   127

    ec_field_reg_t *field_reg;

   128

    ec_slave_t *slave;

   129

    ec_fmmu_t *fmmu;

   130

    unsigned int i, j, found, data_offset;

   131

   132

    if (domain->data) {

   133

        EC_ERR("Domain already allocated!\n");

   134

        return -1;

   135

    }

   136

   137

    domain->base_address = base_address;

   138

   139

    // Größe der Prozessdaten berechnen

   140

    // und logische Adressen der FMMUs setzen

   141

    domain->data_size = 0;

   142

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

   143

        slave = &domain->master->slaves[i];

   144

        for (j = 0; j < slave->fmmu_count; j++) {

   145

            fmmu = &slave->fmmus[j];

   146

            if (fmmu->domain == domain) {

   147

                fmmu->logical_start_address = base_address + domain->data_size;

   148

                domain->data_size += fmmu->sync->size;

   149

            }

   150

        }

   151

    }

   152

   153

    if (!domain->data_size) {

   154

        EC_WARN("Domain 0x%08X contains no data!\n", (u32) domain);

   155

        ec_domain_clear_field_regs(domain);

   156

        return 0;

   157

    }

   158

   159

    // Prozessdaten allozieren

   160

    if (!(domain->data = kmalloc(domain->data_size, GFP_KERNEL))) {

   161

        EC_ERR("Failed to allocate domain data!\n");

   162

        return -1;

   163

    }

   164

   165

    // Prozessdaten mit Nullen vorbelegen

   166

    memset(domain->data, 0x00, domain->data_size);

   167

   168

    // Alle Prozessdatenzeiger setzen

   169

    list_for_each_entry(field_reg, &domain->field_regs, list) {

   170

        found = 0;

   171

        for (i = 0; i < field_reg->slave->fmmu_count; i++) {

   172

            fmmu = &field_reg->slave->fmmus[i];

   173

            if (fmmu->domain == domain && fmmu->sync == field_reg->sync) {

   174

                data_offset = fmmu->logical_start_address - base_address

   175

                    + field_reg->field_offset;

   176

                *field_reg->data_ptr = domain->data + data_offset;

   177

                found = 1;

   178

                break;

   179

            }

   180

        }

   181

   182

        if (!found) { // Sollte nie passieren

   183

            EC_ERR("FMMU not found. Please report!\n");

   184

            return -1;

   185

        }

   186

    }

   187

   188

    // Kommando-Array erzeugen

   189

    domain->command_count = domain->data_size / EC_MAX_DATA_SIZE + 1;

   190

    if (!(domain->commands = (ec_command_t *) kmalloc(sizeof(ec_command_t)

   191

                                                      * domain->command_count,

   192

                                                      GFP_KERNEL))) {

   193

        EC_ERR("Failed to allocate domain command array!\n");

   194

        return -1;

   195

    }

   196

   197

    EC_INFO("Domain %X - Allocated %i bytes in %i command(s)\n",

   198

            (u32) domain, domain->data_size, domain->command_count);

   199

   200

    ec_domain_clear_field_regs(domain);

   201

   202

    return 0;

   203

}

   204

   205

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

   206

   207

/**

   208

   Gibt die Anzahl der antwortenden Slaves aus.

   209

*/

   210

   211

void ec_domain_response_count(ec_domain_t *domain, /**< Domäne */

   212

                              unsigned int count /**< Neue Anzahl */

   213

                              )

   214

{

   215

    if (count != domain->response_count) {

   216

        domain->response_count = count;

   217

        EC_INFO("Domain %08X state change - %i slave%s responding.\n",

   218

                (u32) domain, count, count == 1 ? "" : "s");

   219

    }

   220

}

   221

   222

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

   223

 *

   224

 * Echtzeitschnittstelle

   225

 *

   226

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

   227

   228

/**

   229

   Registriert ein Datenfeld innerhalb einer Domäne.

   230

   231

   \return Zeiger auf den Slave bei Erfolg, sonst NULL

   232

*/

   233

   234

ec_slave_t *EtherCAT_rt_register_slave_field(ec_domain_t *domain,

   235

                                             /**< Domäne */

   236

                                             const char *address,

   237

                                             /**< ASCII-Addresse des Slaves,

   238

                                                siehe ec_master_slave_address()

   239

                                             */

   240

                                             const char *vendor_name,

   241

                                             /**< Herstellername */

   242

                                             const char *product_name,

   243

                                             /**< Produktname */

   244

                                             void **data_ptr,

   245

                                             /**< Adresse des Zeigers auf die

   246

                                                Prozessdaten */

   247

                                             ec_field_type_t field_type,

   248

                                             /**< Typ des Datenfeldes */

   249

                                             unsigned int field_index,

   250

                                             /**< Gibt an, ab welchem Feld mit

   251

                                                Typ \a field_type gezählt

   252

                                                werden soll. */

   253

                                             unsigned int field_count

   254

                                             /**< Anzahl Felder selben Typs */

   255

                                             )

   256

{

   257

    ec_slave_t *slave;

   258

    const ec_slave_type_t *type;

   259

    ec_master_t *master;

   260

    const ec_sync_t *sync;

   261

    const ec_field_t *field;

   262

    unsigned int field_idx, i, j;

   263

    uint32_t field_offset;

   264

   265

    if (!field_count) {

   266

        EC_ERR("field_count may not be 0!\n");

   267

        return NULL;

   268

    }

   269

   270

    master = domain->master;

   271

   272

    // Adresse übersetzen

   273

    if (!(slave = ec_master_slave_address(master, address))) return NULL;

   274

   275

    if (!(type = slave->type)) {

   276

        EC_ERR("Slave \"%s\" (position %i) has unknown type!\n", address,

   277

               slave->ring_position);

   278

        return NULL;

   279

    }

   280

   281

    if (strcmp(vendor_name, type->vendor_name) ||

   282

        strcmp(product_name, type->product_name)) {

   283

        EC_ERR("Invalid slave type at position %i - Requested: \"%s %s\","

   284

               " found: \"%s %s\".\n", slave->ring_position, vendor_name,

   285

               product_name, type->vendor_name, type->product_name);

   286

        return NULL;

   287

    }

   288

   289

    field_idx = 0;

   290

    for (i = 0; type->sync_managers[i]; i++) {

   291

        sync = type->sync_managers[i];

   292

        field_offset = 0;

   293

        for (j = 0; sync->fields[j]; j++) {

   294

            field = sync->fields[j];

   295

            if (field->type == field_type) {

   296

                if (field_idx == field_index) {

   297

                    ec_domain_reg_field(domain, slave, sync, field_offset,

   298

                                        data_ptr++);

   299

                    if (!(--field_count)) return slave;

   300

                }

   301

                field_idx++;

   302

            }

   303

            field_offset += field->size;

   304

        }

   305

    }

   306

   307

    EC_ERR("Slave %i (\"%s %s\") registration mismatch: Type %i, index %i,"

   308

           " count %i.\n", slave->ring_position, vendor_name, product_name,

   309

           field_type, field_index, field_count);

   310

    return NULL;

   311

}

   312

   313

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

   314

   315

/**

   316

   Registriert eine ganze Liste von Datenfeldern innerhalb einer Domäne.

   317

   318

   Achtung: Die Liste muss mit einer NULL-Struktur ({}) abgeschlossen sein!

   319

   320

   \return 0 bei Erfolg, sonst < 0

   321

*/

   322

   323

int EtherCAT_rt_register_domain_fields(ec_domain_t *domain,

   324

                                       /**< Domäne */

   325

                                       ec_field_init_t *fields

   326

                                       /**< Array mit Datenfeldern */

   327

                                       )

   328

{

   329

    ec_field_init_t *field;

   330

   331

    for (field = fields; field->data; field++) {

   332

        if (!EtherCAT_rt_register_slave_field(domain, field->address,

   333

                                              field->vendor, field->product,

   334

                                              field->data, field->field_type,

   335

                                              field->field_index,

   336

                                              field->field_count)) {

   337

            return -1;

   338

        }

   339

    }

   340

   341

    return 0;

   342

}

   343

   344

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

   345

   346

/**

   347

   Setzt Prozessdaten-Kommandos in die Warteschlange des Masters.

   348

*/

   349

   350

void EtherCAT_rt_domain_queue(ec_domain_t *domain /**< Domäne */)

   351

{

   352

    unsigned int offset, i;

   353

    size_t size;

   354

   355

    offset = 0;

   356

    for (i = 0; i < domain->command_count; i++) {

   357

        size = domain->data_size - offset;

   358

        if (size > EC_MAX_DATA_SIZE) size = EC_MAX_DATA_SIZE;

   359

        ec_command_init_lrw(domain->commands + i,

   360

                            domain->base_address + offset, size,

   361

                            domain->data + offset);

   362

        ec_master_queue_command(domain->master, domain->commands + i);

   363

        offset += size;

   364

    }

   365

}

   366

   367

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

   368

   369

/**

   370

   Verarbeitet empfangene Prozessdaten.

   371

*/

   372

   373

void EtherCAT_rt_domain_process(ec_domain_t *domain /**< Domäne */)

   374

{

   375

    unsigned int offset, working_counter_sum, i;

   376

    ec_command_t *command;

   377

    size_t size;

   378

   379

    working_counter_sum = 0;

   380

   381

    offset = 0;

   382

    for (i = 0; i < domain->command_count; i++) {

   383

        command = domain->commands + i;

   384

        size = domain->data_size - offset;

   385

        if (size > EC_MAX_DATA_SIZE) size = EC_MAX_DATA_SIZE;

   386

        if (command->state == EC_CMD_RECEIVED) {

   387

            // Daten vom Kommando- in den Prozessdatenspeicher kopieren

   388

            memcpy(domain->data + offset, command->data, size);

   389

            working_counter_sum += command->working_counter;

   390

        }

   391

        else if (unlikely(domain->master->debug_level)) {

   392

            EC_DBG("process data command not received!\n");

   393

        }

   394

        offset += size;

   395

    }

   396

   397

    ec_domain_response_count(domain, working_counter_sum);

   398

}

   399

   400

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

   401

   402

EXPORT_SYMBOL(EtherCAT_rt_register_slave_field);

   403

EXPORT_SYMBOL(EtherCAT_rt_register_domain_fields);

   404

EXPORT_SYMBOL(EtherCAT_rt_domain_queue);

   405

EXPORT_SYMBOL(EtherCAT_rt_domain_process);

   406

   407

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

   408

   409

/* Emacs-Konfiguration

   410

;;; Local Variables: ***

   411

;;; c-basic-offset:4 ***

   412

;;; End: ***

   413

*/