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

                    )

    26

{

    27

    domain->master = master;

    28

    domain->data_size = 0;

    29

    domain->base_address = 0;

    30

    domain->response_count = 0xFFFFFFFF;

    31

    32

    INIT_LIST_HEAD(&domain->field_regs);

    33

    INIT_LIST_HEAD(&domain->commands);

    34

}

    35

    36

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

    37

    38

/**

    39

   Destruktor einer EtherCAT-Domäne.

    40

*/

    41

    42

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

    43

{

    44

    ec_command_t *command, *next;

    45

    46

    list_for_each_entry_safe(command, next, &domain->commands, list) {

    47

        ec_command_clear(command);

    48

        kfree(command);

    49

    }

    50

    51

    ec_domain_clear_field_regs(domain);

    52

}

    53

    54

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

    55

    56

/**

    57

   Registriert ein Feld in einer Domäne.

    58

    59

   \return 0 bei Erfolg, < 0 bei Fehler

    60

*/

    61

    62

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

    63

                        ec_slave_t *slave, /**< Slave */

    64

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

    65

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

    66

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

    67

                        )

    68

{

    69

    ec_field_reg_t *field_reg;

    70

    71

    if (!(field_reg =

    72

          (ec_field_reg_t *) kmalloc(sizeof(ec_field_reg_t), GFP_KERNEL))) {

    73

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

    74

        return -1;

    75

    }

    76

    77

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

    78

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

    79

        kfree(field_reg);

    80

        return -1;

    81

    }

    82

    83

    field_reg->slave = slave;

    84

    field_reg->sync = sync;

    85

    field_reg->field_offset = field_offset;

    86

    field_reg->data_ptr = data_ptr;

    87

    88

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

    89

    return 0;

    90

}

    91

    92

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

    93

    94

/**

    95

   Gibt die Liste der registrierten Datenfelder frei.

    96

*/

    97

    98

void ec_domain_clear_field_regs(ec_domain_t *domain)

    99

{

   100

    ec_field_reg_t *field_reg, *next;

   101

   102

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

   103

        list_del(&field_reg->list);

   104

        kfree(field_reg);

   105

    }

   106

}

   107

   108

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

   109

   110

/**

   111

   Alloziert ein Prozessdatenkommando und fügt es in die Liste ein.

   112

*/

   113

   114

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

   115

                          uint32_t offset, /**< Logisches Offset */

   116

                          size_t data_size /**< Größe der Kommando-Daten */

   117

                          )

   118

{

   119

    ec_command_t *command;

   120

   121

    if (!(command = kmalloc(sizeof(ec_command_t), GFP_KERNEL))) {

   122

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

   123

        return -1;

   124

    }

   125

   126

    ec_command_init(command);

   127

   128

    if (ec_command_lrw(command, offset, data_size)) {

   129

        kfree(command);

   130

        return -1;

   131

    }

   132

   133

    list_add_tail(&command->list, &domain->commands);

   134

    return 0;

   135

}

   136

   137

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

   138

   139

/**

   140

   Erzeugt eine Domäne.

   141

   142

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

   143

   FMMUs und setzt die Prozessdatenzeiger der registrierten Felder.

   144

   145

   \return 0 bei Erfolg, < 0 bei Fehler

   146

*/

   147

   148

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

   149

                    uint32_t base_address /**< Logische Basisadresse */

   150

                    )

   151

{

   152

    ec_field_reg_t *field_reg;

   153

    ec_slave_t *slave;

   154

    ec_fmmu_t *fmmu;

   155

    unsigned int i, j, cmd_count;

   156

    uint32_t field_off, field_off_cmd;

   157

    uint32_t cmd_offset;

   158

    size_t cmd_data_size;

   159

    ec_command_t *command;

   160

   161

    domain->base_address = base_address;

   162

   163

    // Größe der Prozessdaten berechnen und Kommandos allozieren

   164

    domain->data_size = 0;

   165

    cmd_offset = base_address;

   166

    cmd_data_size = 0;

   167

    cmd_count = 0;

   168

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

   169

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

   170

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

   171

            fmmu = &slave->fmmus[j];

   172

            if (fmmu->domain == domain) {

   173

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

   174

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

   175

                if (cmd_data_size + fmmu->sync->size > EC_MAX_DATA_SIZE) {

   176

                    if (ec_domain_add_command(domain, cmd_offset,

   177

                                              cmd_data_size)) return -1;

   178

                    cmd_offset += cmd_data_size;

   179

                    cmd_data_size = 0;

   180

                    cmd_count++;

   181

                }

   182

                cmd_data_size += fmmu->sync->size;

   183

            }

   184

        }

   185

    }

   186

   187

    // Letztes Kommando allozieren

   188

    if (cmd_data_size) {

   189

        if (ec_domain_add_command(domain, cmd_offset, cmd_data_size))

   190

            return -1;

   191

        cmd_count++;

   192

    }

   193

   194

    if (!cmd_count) {

   195

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

   196

        ec_domain_clear_field_regs(domain);

   197

        return 0;

   198

    }

   199

   200

    // Alle Prozessdatenzeiger setzen

   201

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

   202

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

   203

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

   204

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

   205

                field_off = fmmu->logical_start_address +

   206

                    field_reg->field_offset;

   207

                // Kommando suchen

   208

                list_for_each_entry(command, &domain->commands, list) {

   209

                    field_off_cmd = field_off - command->address.logical;

   210

                    if (field_off >= command->address.logical &&

   211

                        field_off_cmd < command->mem_size) {

   212

                        *field_reg->data_ptr = command->data + field_off_cmd;

   213

                    }

   214

                }

   215

                if (!field_reg->data_ptr) {

   216

                    EC_ERR("Failed to assign data pointer!\n");

   217

                    return -1;

   218

                }

   219

                break;

   220

            }

   221

        }

   222

    }

   223

   224

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

   225

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

   226

   227

    ec_domain_clear_field_regs(domain);

   228

   229

    return 0;

   230

}

   231

   232

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

   233

   234

/**

   235

   Gibt die Anzahl der antwortenden Slaves aus.

   236

*/

   237

   238

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

   239

                              unsigned int count /**< Neue Anzahl */

   240

                              )

   241

{

   242

    if (count != domain->response_count) {

   243

        domain->response_count = count;

   246

    }

   247

}

   248

   249

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

   250

 *

   251

 * Echtzeitschnittstelle

   252

 *

   253

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

   254

   255

/**

   256

   Registriert ein Datenfeld innerhalb einer Domäne.

   257

   258

   - Ist \a data_ptr NULL, so wird der Slave nur auf den Typ überprüft.

   259

   - Wenn \a field_count 0 ist, wird angenommen, dass 1 Feld registriert werden

   260

     soll.

   261

   - Wenn \a field_count größer als 1 ist, wird angenommen, dass \a data_ptr

   262

     auf ein entsprechend großes Array zeigt.

   263

   264

   \return Zeiger auf den Slave bei Erfolg, sonst NULL

   265

*/

   266

   267

ec_slave_t *ecrt_domain_register_field(ec_domain_t *domain,

   268

                                       /**< Domäne */

   269

                                       const char *address,

   270

                                       /**< ASCII-Addresse des Slaves,

   271

                                          siehe ecrt_master_get_slave() */

   272

                                       const char *vendor_name,

   273

                                       /**< Herstellername */

   274

                                       const char *product_name,

   275

                                       /**< Produktname */

   276

                                       void **data_ptr,

   277

                                       /**< Adresse des Zeigers auf die

   278

                                          Prozessdaten */

   279

                                       const char *field_name,

   280

                                       /**< Name des Datenfeldes */

   281

                                       unsigned int field_index,

   282

                                       /**< Gibt an, ab welchem Feld mit

   283

                                          Typ \a field_type gezählt

   284

                                          werden soll. */

   285

                                       unsigned int field_count

   286

                                       /**< Anzahl Felder selben Typs */

   287

                                       )

   288

{

   289

    ec_slave_t *slave;

   290

    const ec_slave_type_t *type;

   291

    ec_master_t *master;

   292

    const ec_sync_t *sync;

   293

    const ec_field_t *field;

   294

    unsigned int field_counter, i, j, orig_field_index, orig_field_count;

   295

    uint32_t field_offset;

   296

   297

    master = domain->master;

   298

   299

    // Adresse übersetzen

   300

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

   301

   302

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

   303

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

   304

               slave->ring_position);

   305

        return NULL;

   306

    }

   307

   308

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

   309

        strcmp(product_name, type->product_name)) {

   310

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

   311

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

   312

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

   313

        return NULL;

   314

    }

   315

   316

    if (!data_ptr) {

   317

        // Wenn data_ptr NULL, Slave als registriert ansehen (nicht warnen).

   318

        slave->registered = 1;

   319

    }

   320

   321

    if (!field_count) field_count = 1;

   322

    orig_field_index = field_index;

   323

    orig_field_count = field_count;

   324

   325

    field_counter = 0;

   326

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

   327

        sync = type->sync_managers[i];

   328

        field_offset = 0;

   329

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

   330

            field = sync->fields[j];

   331

            if (!strcmp(field->name, field_name)) {

   332

                if (field_counter++ == field_index) {

   333

                    if (data_ptr)

   334

                        ec_domain_reg_field(domain, slave, sync, field_offset,

   335

                                            data_ptr++);

   336

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

   337

                    field_index++;

   338

                }

   339

            }

   340

            field_offset += field->size;

   341

        }

   342

    }

   343

   344

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

   345

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

   346

           product_name, field_name, orig_field_index, orig_field_count);

   347

    return NULL;

   348

}

   349

   350

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

   351

   352

/**

   353

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

   354

   355

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

   356

   357

   \return 0 bei Erfolg, sonst < 0

   358

*/

   359

   360

int ecrt_domain_register_field_list(ec_domain_t *domain,

   361

                                    /**< Domäne */

   362

                                    const ec_field_init_t *fields

   363

                                    /**< Array mit Datenfeldern */

   364

                                    )

   365

{

   366

    const ec_field_init_t *field;

   367

   368

    for (field = fields; field->slave_address; field++)

   369

        if (!ecrt_domain_register_field(domain, field->slave_address,

   370

                                        field->vendor_name,

   371

                                        field->product_name, field->data_ptr,

   372

                                        field->field_name, field->field_index,

   373

                                        field->field_count))

   374

            return -1;

   375

   376

    return 0;

   377

}

   378

   379

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

   380

   381

/**

   382

   Setzt Prozessdaten-Kommandos in die Warteschlange des Masters.

   383

*/

   384

   385

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

   386

{

   387

    ec_command_t *command;

   388

   389

    list_for_each_entry(command, &domain->commands, list) {

   390

        ec_master_queue_command(domain->master, command);

   391

    }

   392

}

   393

   394

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

   395

   396

/**

   397

   Verarbeitet empfangene Prozessdaten.

   398

*/

   399

   400

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

   401

{

   402

    unsigned int working_counter_sum;

   403

    ec_command_t *command;

   404

   405

    working_counter_sum = 0;

   406

   407

    list_for_each_entry(command, &domain->commands, list) {

   408

        if (command->state == EC_CMD_RECEIVED) {

   409

            working_counter_sum += command->working_counter;

   410

        }

   411

    }

   412

   413

    ec_domain_response_count(domain, working_counter_sum);

   414

}

   415

   416

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

   417

   418

/**

   419

   Gibt den Status einer Domäne zurück.

   420

   421

   \return 0 wenn alle Kommandos empfangen wurden, sonst -1.

   422

*/

   423

   424

int ecrt_domain_state(ec_domain_t *domain /**< Domäne */)

   425

{

   426

    ec_command_t *command;

   427

   428

    list_for_each_entry(command, &domain->commands, list) {

   429

        if (command->state != EC_CMD_RECEIVED) return -1;

   430

    }

   431

   432

    return 0;

   433

}

   434

   435

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

   436

   437

EXPORT_SYMBOL(ecrt_domain_register_field);

   438

EXPORT_SYMBOL(ecrt_domain_register_field_list);

   439

EXPORT_SYMBOL(ecrt_domain_queue);

   440

EXPORT_SYMBOL(ecrt_domain_process);

   441

EXPORT_SYMBOL(ecrt_domain_state);

   442

   443

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

   444

   445

/* Emacs-Konfiguration

   446

;;; Local Variables: ***

   447

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

   448

;;; End: ***

   449

*/