1

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

     2

 *  

     3

 *  $Id$

     4

 *  

     5

 *  Copyright (C) 2006-2009  Florian Pose, Ingenieurgemeinschaft IgH

     6

 *  

     7

 *  This file is part of the IgH EtherCAT master userspace library.

     8

 *  

     9

 *  The IgH EtherCAT master userspace library is free software; you can

    10

 *  redistribute it and/or modify it under the terms of the GNU Lesser General

    11

 *  Public License as published by the Free Software Foundation; version 2.1

    12

 *  of the License.

    13

 *

    14

 *  The IgH EtherCAT master userspace library is distributed in the hope that

    15

 *  it will be useful, but WITHOUT ANY WARRANTY; without even the implied

    16

 *  warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    17

 *  GNU Lesser General Public License for more details.

    18

 *

    19

 *  You should have received a copy of the GNU Lesser General Public License

    20

 *  along with the IgH EtherCAT master userspace library. If not, see

    21

 *  <http://www.gnu.org/licenses/>.

    22

 *  

    23

 *  ---

    24

 *  

    25

 *  The license mentioned above concerns the source code only. Using the

    26

 *  EtherCAT technology and brand is only permitted in compliance with the

    27

 *  industrial property and similar rights of Beckhoff Automation GmbH.

    28

 *

    29

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

    30

    31

#include <stdlib.h>

    32

#include <sys/ioctl.h>

    33

#include <stdio.h>

    34

#include <errno.h>

    35

#include <string.h>

    36

#include <sys/mman.h>

    37

    38

#include "master.h"

    39

#include "domain.h"

    40

#include "slave_config.h"

    41

#include "master/ioctl.h"

    42

    43

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

    44

    45

int ecrt_master_reserve(ec_master_t *master)

    46

{

    47

    if (ioctl(master->fd, EC_IOCTL_REQUEST, NULL) == -1) {

    48

        fprintf(stderr, "Failed to reserve master: %s\n",

    49

                strerror(errno));

    50

        return -1;

    51

    }

    52

    return 0;

    53

}

    54

    55

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

    56

    57

void ec_master_clear_config(ec_master_t *master)

    58

{

    59

    ec_domain_t *d, *next_d;

    60

    ec_slave_config_t *c, *next_c;

    61

    62

    d = master->first_domain;

    63

    while (d) {

    64

        next_d = d->next;

    65

        ec_domain_clear(d);

    66

        d = next_d;

    67

    }

    68

    master->first_domain = NULL;

    69

    70

    c = master->first_config;

    71

    while (c) {

    72

        next_c = c->next;

    73

        ec_slave_config_clear(c);

    74

        c = next_c;

    75

    }

    76

    master->first_config = NULL;

    77

}

    78

    79

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

    80

    81

void ec_master_clear(ec_master_t *master)

    82

{

    83

    if (master->process_data)  {

    84

        munmap(master->process_data, master->process_data_size);

    85

    }

    86

    87

    ec_master_clear_config(master);

    88

    89

    if (master->fd != -1) {

    90

        close(master->fd);

    91

    }

    92

}

    93

    94

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

    95

    96

void ec_master_add_domain(ec_master_t *master, ec_domain_t *domain)

    97

{

    98

    if (master->first_domain) {

    99

        ec_domain_t *d = master->first_domain;

   100

        while (d->next) {

   101

            d = d->next;

   102

        }

   103

        d->next = domain;

   104

    } else {

   105

        master->first_domain = domain;

   106

    }

   107

}

   108

   109

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

   110

   111

ec_domain_t *ecrt_master_create_domain(ec_master_t *master)

   112

{

   113

    ec_domain_t *domain;

   114

    int index;

   115

   116

    domain = malloc(sizeof(ec_domain_t));

   117

    if (!domain) {

   118

        fprintf(stderr, "Failed to allocate memory.\n");

   119

        return 0;

   120

    }

   121

   122

    index = ioctl(master->fd, EC_IOCTL_CREATE_DOMAIN, NULL);

   123

    if (index == -1) {

   124

        fprintf(stderr, "Failed to create domain: %s\n", strerror(errno));

   125

        free(domain);

   126

        return 0; 

   127

    }

   128

   129

    domain->next = NULL;

   130

    domain->index = (unsigned int) index;

   131

    domain->master = master;

   132

    domain->process_data = NULL;

   133

   134

    ec_master_add_domain(master, domain);

   135

   136

    return domain;

   137

}

   138

   139

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

   140

   141

void ec_master_add_slave_config(ec_master_t *master, ec_slave_config_t *sc)

   142

{

   143

    if (master->first_config) {

   144

        ec_slave_config_t *c = master->first_config;

   145

        while (c->next) {

   146

            c = c->next;

   147

        }

   148

        c->next = sc;

   149

    } else {

   150

        master->first_config = sc;

   151

    }

   152

}

   153

   154

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

   155

   156

ec_slave_config_t *ecrt_master_slave_config(ec_master_t *master,

   157

        uint16_t alias, uint16_t position, uint32_t vendor_id,

   158

        uint32_t product_code)

   159

{

   160

    ec_ioctl_config_t data;

   161

    ec_slave_config_t *sc;

   162

    int index;

   163

   164

    sc = malloc(sizeof(ec_slave_config_t));

   165

    if (!sc) {

   166

        fprintf(stderr, "Failed to allocate memory.\n");

   167

        return 0;

   168

    }

   169

   170

    data.alias = alias;

   171

    data.position = position;

   172

    data.vendor_id = vendor_id;

   173

    data.product_code = product_code;

   174

   175

    if (ioctl(master->fd, EC_IOCTL_CREATE_SLAVE_CONFIG, &data) == -1) {

   176

        fprintf(stderr, "Failed to create slave config: %s\n",

   177

                strerror(errno));

   178

        free(sc);

   179

        return 0; 

   180

    }

   181

   182

    sc->next = NULL;

   183

    sc->master = master;

   184

    sc->index = data.config_index;

   185

    sc->alias = alias;

   186

    sc->position = position;

   187

    sc->first_sdo_request = NULL;

   188

    sc->first_voe_handler = NULL;

   189

   190

    ec_master_add_slave_config(master, sc);

   191

   192

    return sc;

   193

}

   194

   195

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

   196

   197

int ecrt_master(ec_master_t* master, ec_master_info_t *master_info)

   198

{

   199

    ec_ioctl_master_t data;

   200

   201

    if (ioctl(master->fd, EC_IOCTL_MASTER, &data) < 0) {

   202

        fprintf(stderr, "Failed to get master info: %s\n", strerror(errno));

   203

        return -1;

   204

    }

   205

   206

    master_info->slave_count = data.slave_count;

   207

    master_info->link_up = data.devices[0].link_state;

   208

    master_info->scan_busy = data.scan_busy;

   209

    master_info->app_time = data.app_time;

   210

    return 0;

   211

}

   212

   213

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

   214

   215

int ecrt_master_get_slave(ec_master_t *master, uint16_t slave_position,

   216

        ec_slave_info_t *slave_info)

   217

{

   218

    ec_ioctl_slave_t data;

   219

    int index;

   220

   221

    data.position = slave_position;

   222

   223

    if (ioctl(master->fd, EC_IOCTL_SLAVE, &data) == -1) {

   224

        fprintf(stderr, "Failed to get slave info: %s\n", strerror(errno));

   225

        return -1;

   226

    }

   227

   228

    slave_info->position = data.position;

   229

    slave_info->vendor_id = data.vendor_id;

   230

    slave_info->product_code = data.product_code;

   231

    slave_info->revision_number = data.revision_number;

   232

    slave_info->serial_number = data.serial_number;

   233

    slave_info->alias = data.alias;

   234

    slave_info->current_on_ebus = data.current_on_ebus;

   235

    slave_info->al_state = data.al_state;

   236

    slave_info->error_flag = data.error_flag;

   237

    slave_info->sync_count = data.sync_count;

   238

    slave_info->sdo_count = data.sdo_count;

   239

    strncpy(slave_info->name, data.name, EC_MAX_STRING_LENGTH);

   240

    return 0;

   241

}

   242

   243

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

   244

   245

int ecrt_master_get_sync_manager(ec_master_t *master, uint16_t slave_position,

   246

        uint8_t sync_index, ec_sync_info_t *sync)

   247

{

   248

    ec_ioctl_slave_sync_t data;

   249

   250

    if (sync_index >= EC_MAX_SYNC_MANAGERS)

   251

        return -ENOENT;

   252

   253

    memset(&data, 0x00, sizeof(ec_ioctl_slave_sync_t));

   254

    data.slave_position = slave_position;

   255

    data.sync_index = sync_index;

   256

   257

    if (ioctl(master->fd, EC_IOCTL_SLAVE_SYNC, &data) == -1) {

   258

        fprintf(stderr, "Failed to get sync manager information: %s\n",

   259

                strerror(errno));

   260

        return -1; // FIXME

   261

    }

   262

   263

    sync->index = sync_index;

   264

    sync->dir = EC_READ_BIT(&data.control_register, 2) ?

   265

        EC_DIR_OUTPUT : EC_DIR_INPUT;

   266

    sync->n_pdos = data.pdo_count;

   267

    sync->pdos = NULL;

   268

    sync->watchdog_mode = EC_READ_BIT(&data.control_register, 6) ?

   269

        EC_WD_ENABLE : EC_WD_DISABLE;

   270

   271

    return 0;

   272

}

   273

   274

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

   275

   276

int ecrt_master_get_pdo(ec_master_t *master, uint16_t slave_position,

   277

        uint8_t sync_index, uint16_t pos, ec_pdo_info_t *pdo)

   278

{

   279

    ec_ioctl_slave_sync_pdo_t data;

   280

   281

    if (sync_index >= EC_MAX_SYNC_MANAGERS)

   282

        return -ENOENT;

   283

   284

    memset(&data, 0x00, sizeof(ec_ioctl_slave_sync_pdo_t));

   285

    data.slave_position = slave_position;

   286

    data.sync_index = sync_index;

   287

    data.pdo_pos = pos;

   288

   289

    if (ioctl(master->fd, EC_IOCTL_SLAVE_SYNC_PDO, &data) == -1) {

   290

        fprintf(stderr, "Failed to get pdo information: %s\n",

   291

                strerror(errno));

   292

        return -1; // FIXME

   293

    }

   294

   295

    pdo->index = data.index;

   296

    pdo->n_entries = data.entry_count;

   297

    pdo->entries = NULL;

   298

   299

    return 0;

   300

}

   301

   302

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

   303

   304

int ecrt_master_get_pdo_entry(ec_master_t *master, uint16_t slave_position,

   305

        uint8_t sync_index, uint16_t pdo_pos, uint16_t entry_pos,

   306

        ec_pdo_entry_info_t *entry)

   307

{

   308

    ec_ioctl_slave_sync_pdo_entry_t data;

   309

   310

    if (sync_index >= EC_MAX_SYNC_MANAGERS)

   311

        return -ENOENT;

   312

   313

    memset(&data, 0x00, sizeof(ec_ioctl_slave_sync_pdo_entry_t));

   314

    data.slave_position = slave_position;

   315

    data.sync_index = sync_index;

   316

    data.pdo_pos = pdo_pos;

   317

    data.entry_pos = entry_pos;

   318

   319

    if (ioctl(master->fd, EC_IOCTL_SLAVE_SYNC_PDO_ENTRY, &data) == -1) {

   320

        fprintf(stderr, "Failed to get pdo entry information: %s\n",

   321

                strerror(errno));

   322

        return -1; // FIXME

   323

    }

   324

   325

    entry->index = data.index;

   326

    entry->subindex = data.subindex;

   327

    entry->bit_length = data.bit_length;

   328

   329

    return 0;

   330

}

   331

   332

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

   333

   334

int ecrt_master_sdo_download(ec_master_t *master, uint16_t slave_position,

   335

        uint16_t index, uint8_t subindex, uint8_t *data,

   336

        size_t data_size, uint32_t *abort_code)

   337

{

   338

    ec_ioctl_slave_sdo_download_t download;

   339

   340

    download.slave_position = slave_position;

   341

    download.sdo_index = index;

   342

    download.sdo_entry_subindex = subindex;

   343

    download.complete_access = 0;

   344

    download.data_size = data_size;

   345

    download.data = data;

   346

   347

    if (ioctl(master->fd, EC_IOCTL_SLAVE_SDO_DOWNLOAD, &download) == -1) {

   348

        if (errno == EIO && abort_code) {

   349

            *abort_code = download.abort_code;

   350

        }

   351

        fprintf(stderr, "Failed to execute SDO download: %s\n",

   352

            strerror(errno));

   353

        return -1;

   354

    }

   355

   356

    return 0;

   357

}

   358

   359

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

   360

   361

int ecrt_master_sdo_download_complete(ec_master_t *master,

   362

        uint16_t slave_position, uint16_t index, uint8_t *data,

   363

        size_t data_size, uint32_t *abort_code)

   364

{

   365

    ec_ioctl_slave_sdo_download_t download;

   366

   367

    download.slave_position = slave_position;

   368

    download.sdo_index = index;

   369

    download.sdo_entry_subindex = 0;

   370

    download.complete_access = 1;

   371

    download.data_size = data_size;

   372

    download.data = data;

   373

   374

    if (ioctl(master->fd, EC_IOCTL_SLAVE_SDO_DOWNLOAD, &download) == -1) {

   375

        if (errno == EIO && abort_code) {

   376

            *abort_code = download.abort_code;

   377

        }

   378

        fprintf(stderr, "Failed to execute SDO download: %s\n",

   379

            strerror(errno));

   380

        return -1;

   381

    }

   382

   383

    return 0;

   384

}

   385

   386

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

   387

   388

int ecrt_master_sdo_upload(ec_master_t *master, uint16_t slave_position,

   389

        uint16_t index, uint8_t subindex, uint8_t *target,

   390

        size_t target_size, size_t *result_size, uint32_t *abort_code)

   391

{

   392

    ec_ioctl_slave_sdo_upload_t upload;

   393

   394

    upload.slave_position = slave_position;

   395

    upload.sdo_index = index;

   396

    upload.sdo_entry_subindex = subindex;

   397

    upload.target_size = target_size;

   398

    upload.target = target;

   399

   400

    if (ioctl(master->fd, EC_IOCTL_SLAVE_SDO_UPLOAD, &upload) == -1) {

   401

        if (errno == EIO && abort_code) {

   402

            *abort_code = upload.abort_code;

   403

        }

   404

        fprintf(stderr, "Failed to execute SDO upload: %s\n",

   405

                strerror(errno));

   406

        return -1;

   407

    }

   408

   409

    *result_size = upload.data_size;

   410

    return 0;

   411

}

   412

   413

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

   414

   415

int ecrt_master_write_idn(ec_master_t *master, uint16_t slave_position,

   416

        uint8_t drive_no, uint16_t idn, uint8_t *data, size_t data_size,

   417

        uint16_t *error_code)

   418

{

   419

    ec_ioctl_slave_soe_write_t io;

   420

   421

    io.slave_position = slave_position;

   422

    io.drive_no = drive_no;

   423

    io.idn = idn;

   424

    io.data_size = data_size;

   425

    io.data = data;

   426

   427

    if (ioctl(master->fd, EC_IOCTL_SLAVE_SOE_WRITE, &io) == -1) {

   428

        if (errno == EIO && error_code) {

   429

            *error_code = io.error_code;

   430

        }

   431

        fprintf(stderr, "Failed to write IDN: %s\n", strerror(errno));

   432

        return -1;

   433

    }

   434

   435

    return 0;

   436

}

   437

   438

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

   439

   440

int ecrt_master_read_idn(ec_master_t *master, uint16_t slave_position,

   441

        uint8_t drive_no, uint16_t idn, uint8_t *target, size_t target_size,

   442

        size_t *result_size, uint16_t *error_code)

   443

{

   444

    ec_ioctl_slave_soe_read_t io;

   445

   446

    io.slave_position = slave_position;

   447

    io.drive_no = drive_no;

   448

    io.idn = idn;

   449

    io.mem_size = target_size;

   450

    io.data = target;

   451

   452

    if (ioctl(master->fd, EC_IOCTL_SLAVE_SOE_READ, &io) == -1) {

   453

        if (errno == EIO && error_code) {

   454

            *error_code = io.error_code;

   455

        }

   456

        fprintf(stderr, "Failed to read IDN: %s\n", strerror(errno));

   457

        return -1;

   458

    }

   459

   460

    *result_size = io.data_size;

   461

    return 0;

   462

}

   463

   464

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

   465

   466

int ecrt_master_activate(ec_master_t *master)

   467

{

   468

    if (ioctl(master->fd, EC_IOCTL_ACTIVATE,

   469

                &master->process_data_size) == -1) {

   470

        fprintf(stderr, "Failed to activate master: %s\n",

   471

                strerror(errno));

   472

        return -1; // FIXME

   473

    }

   474

   475

    if (master->process_data_size) {

   476

        master->process_data = mmap(0, master->process_data_size,

   477

                PROT_READ | PROT_WRITE, MAP_SHARED, master->fd, 0);

   478

        if (master->process_data == MAP_FAILED) {

   479

            fprintf(stderr, "Failed to map process data: %s", strerror(errno));

   480

            master->process_data = NULL;

   481

            master->process_data_size = 0;

   482

            return -1; // FIXME

   483

        }

   484

   485

        // Access the mapped region to cause the initial page fault

   486

        master->process_data[0] = 0x00;

   487

    }

   488

   489

    return 0;

   490

}

   491

   492

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

   493

   494

void ecrt_master_deactivate(ec_master_t *master)