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 = NULL;

    29

    domain->data_size = 0;

    30

    domain->commands = NULL;

    31

    domain->command_count = 0;

    32

    domain->base_address = 0;

    33

    domain->response_count = 0xFFFFFFFF;

    34

    35

    INIT_LIST_HEAD(&domain->field_regs);

    36

}

    37

    38

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

    39

    40

/**

    41

   Destruktor einer EtherCAT-Domäne.

    42

*/

    43

    44

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

    45

{

    46

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

    47

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

    48

    49

    ec_domain_clear_field_regs(domain);

    50

}

    51

    52

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

    53

    54

/**

    55

   Registriert ein Feld in einer Domäne.

    56

    57

   \return 0 bei Erfolg, < 0 bei Fehler

    58

*/

    59

    60

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

    61

                        ec_slave_t *slave, /**< Slave */

    62

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

    63

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

    64

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

    65

                        )

    66

{

    67

    ec_field_reg_t *field_reg;

    68

    69

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

    70

                                                 GFP_KERNEL))) {

    71

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

    72

        return -1;

    73

    }

    74

    75

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

    76

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

    77

        kfree(field_reg);

    78

        return -1;

    79

    }

    80

    81

    field_reg->slave = slave;

    82

    field_reg->sync = sync;

    83

    field_reg->field_offset = field_offset;

    84

    field_reg->data_ptr = data_ptr;

    85

    86

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

    87

    88

    return 0;

    89

}

    90

    91

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

    92

    93

/**

    94

   Gibt die Liste der registrierten Datenfelder frei.

    95

*/

    96

    97

void ec_domain_clear_field_regs(ec_domain_t *domain)

    98

{

    99

    ec_field_reg_t *field_reg, *next;

   100

   101

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

   102

        list_del(&field_reg->list);

   103

        kfree(field_reg);

   104

    }

   105

}

   106

   107

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

   108

   109

/**

   110

   Erzeugt eine Domäne.

   111

   112

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

   113

   FMMUs und setzt die Prozessdatenzeiger der registrierten Felder.

   114

   115

   \return 0 bei Erfolg, < 0 bei Fehler

   116

*/

   117

   118

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

   119

                    uint32_t base_address /**< Logische Basisadresse */

   120

                    )

   121

{

   122

    ec_field_reg_t *field_reg;

   123

    ec_slave_t *slave;

   124

    ec_fmmu_t *fmmu;

   125

    unsigned int i, j;

   126

    uint32_t data_offset;

   127

   128

    if (domain->data) {

   129

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

   130

        return -1;

   131

    }

   132

   133

    domain->base_address = base_address;

   134

   135

    // Größe der Prozessdaten berechnen

   136

    // und logische Adressen der FMMUs setzen

   137

    domain->data_size = 0;

   138

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

   139

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

   140

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

   141

            fmmu = &slave->fmmus[j];

   142

            if (fmmu->domain == domain) {

   143

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

   144

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

   145

            }

   146

        }

   147

    }

   148

   149

    if (!domain->data_size) {

   150

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

   151

        ec_domain_clear_field_regs(domain);

   152

        return 0;

   153

    }

   154

   155

    // Prozessdaten allozieren

   156

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

   157

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

   158

        return -1;

   159

    }

   160

   161

    // Prozessdaten mit Nullen vorbelegen

   162

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

   163

   164

    // Alle Prozessdatenzeiger setzen

   165

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

   166

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

   167

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

   168

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

   169

                data_offset = fmmu->logical_start_address - base_address

   170

                    + field_reg->field_offset;

   171

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

   172

                break;

   173

            }

   174

        }

   175

    }

   176

   177

    // Kommando-Array erzeugen

   178

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

   179

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

   180

                                                      * domain->command_count,

   181

                                                      GFP_KERNEL))) {

   182

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

   183

        return -1;

   184

    }

   185

   186

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

   187

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

   188

   189

    ec_domain_clear_field_regs(domain);

   190

   191

    return 0;

   192

}

   193

   194

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

   195

   196

/**

   197

   Gibt die Anzahl der antwortenden Slaves aus.

   198

*/

   199

   200

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

   201

                              unsigned int count /**< Neue Anzahl */

   202

                              )

   203

{

   204

    if (count != domain->response_count) {

   205

        domain->response_count = count;

   206

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

   207

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

   208

    }

   209

}

   210

   211

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

   212

 *

   213

 * Echtzeitschnittstelle

   214

 *

   215

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

   216

   217

/**

   218

   Registriert ein Datenfeld innerhalb einer Domäne.

   219

   220

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

   221

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

   222

     soll.

   223

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

   224

     auf ein entsprechend großes Array zeigt.

   225

   226

   \return Zeiger auf den Slave bei Erfolg, sonst NULL

   227

*/

   228

   229

ec_slave_t *ecrt_domain_register_field(ec_domain_t *domain,

   230

                                       /**< Domäne */

   231

                                       const char *address,

   232

                                       /**< ASCII-Addresse des Slaves,

   233

                                          siehe ec_master_slave_address() */

   234

                                       const char *vendor_name,

   235

                                       /**< Herstellername */

   236

                                       const char *product_name,

   237

                                       /**< Produktname */

   238

                                       void **data_ptr,

   239

                                       /**< Adresse des Zeigers auf die

   240

                                          Prozessdaten */

   241

                                       const char *field_name,

   242

                                       /**< Name des Datenfeldes */

   243

                                       unsigned int field_index,

   244

                                       /**< Gibt an, ab welchem Feld mit

   245

                                          Typ \a field_type gezählt

   246

                                          werden soll. */

   247

                                       unsigned int field_count

   248

                                       /**< Anzahl Felder selben Typs */

   249

                                       )

   250

{

   251

    ec_slave_t *slave;

   252

    const ec_slave_type_t *type;

   253

    ec_master_t *master;

   254

    const ec_sync_t *sync;

   255

    const ec_field_t *field;

   256

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

   257

    uint32_t field_offset;

   258

   259

    master = domain->master;

   260

   261

    // Adresse übersetzen

   262

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

   263

   264

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

   265

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

   266

               slave->ring_position);

   267

        return NULL;

   268

    }

   269

   270

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

   271

        strcmp(product_name, type->product_name)) {

   272

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

   273

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

   274

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

   275

        return NULL;

   276

    }

   277

   278

    if (!data_ptr) {

   279

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

   280

        slave->registered = 1;

   281

    }

   282

   283

    if (!field_count) field_count = 1;

   284

    orig_field_index = field_index;

   285

    orig_field_count = field_count;

   286

   287

    field_counter = 0;

   288

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

   289

        sync = type->sync_managers[i];

   290

        field_offset = 0;

   291

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

   292

            field = sync->fields[j];

   293

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

   294

                if (field_counter++ == field_index) {

   295

                    if (data_ptr)

   296

                        ec_domain_reg_field(domain, slave, sync, field_offset,

   297

                                            data_ptr++);

   298

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

   299

                    field_index++;

   300

                }

   301

            }

   302

            field_offset += field->size;

   303

        }

   304

    }

   305

   306

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

   307

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

   308

           product_name, field_name, orig_field_index, orig_field_count);

   309

    return NULL;

   310

}

   311

   312

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

   313

   314

/**

   315

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

   316

   317

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

   318

   319

   \return 0 bei Erfolg, sonst < 0

   320

*/

   321

   322

int ecrt_domain_register_field_list(ec_domain_t *domain,

   323

                                    /**< Domäne */

   324

                                    ec_field_init_t *fields

   325

                                    /**< Array mit Datenfeldern */

   326

                                    )

   327

{

   328

    ec_field_init_t *field;

   329

   330

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

   331

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

   332

                                        field->vendor_name,

   333

                                        field->product_name, field->data_ptr,

   334

                                        field->field_name, field->field_index,

   335

                                        field->field_count))

   336

            return -1;

   337

   338

    return 0;

   339

}

   340

   341

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

   342

   343

/**

   344

   Setzt Prozessdaten-Kommandos in die Warteschlange des Masters.

   345

*/

   346

   347

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

   348

{

   349

    unsigned int i;

   350

    size_t size;

   351

    off_t offset;

   352

   353

    offset = 0;

   354

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

   355

        size = domain->data_size - offset;

   356

        if (size > EC_MAX_DATA_SIZE) size = EC_MAX_DATA_SIZE;

   357

        ec_command_init_lrw(domain->commands + i,

   358

                            domain->base_address + offset, size,

   359

                            domain->data + offset);

   360

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

   361

        offset += size;

   362

    }

   363

}

   364

   365

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

   366

   367

/**

   368

   Verarbeitet empfangene Prozessdaten.

   369

*/

   370

   371

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

   372

{

   373

    unsigned int working_counter_sum, i;

   374

    ec_command_t *command;

   375

    size_t size;

   376

    off_t offset;

   377

   378

    working_counter_sum = 0;

   379

   380

    offset = 0;

   381

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

   382

        command = domain->commands + i;

   383

        size = domain->data_size - offset;

   384

        if (size > EC_MAX_DATA_SIZE) size = EC_MAX_DATA_SIZE;

   385

        if (command->state == EC_CMD_RECEIVED) {

   386

            // Daten vom Kommando- in den Prozessdatenspeicher kopieren

   387

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

   388

            working_counter_sum += command->working_counter;

   389

        }

   390

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

   391

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

   392

        }

   393

        offset += size;

   394

    }

   395

   396

    ec_domain_response_count(domain, working_counter_sum);

   397

}

   398

   399

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

   400

   401

/**

   402

   Gibt den Status einer Domäne zurück.

   403

   404

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

   405

*/

   406

   407

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

   408

{

   409

    unsigned int i;

   410

    ec_command_t *command;

   411

   412

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

   413

        command = domain->commands + i;

   414

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

   415

    }

   416

   417

    return 0;

   418

}

   419

   420

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

   421

   422

EXPORT_SYMBOL(ecrt_domain_register_field);

   423

EXPORT_SYMBOL(ecrt_domain_register_field_list);

   424

EXPORT_SYMBOL(ecrt_domain_queue);

   425

EXPORT_SYMBOL(ecrt_domain_process);

   426

EXPORT_SYMBOL(ecrt_domain_state);

   427

   428

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

   429

   430

/* Emacs-Konfiguration

   431

;;; Local Variables: ***

   432

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

   433

;;; End: ***

   434

*/