1

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

     2

 *

     3

 *  $Id$

     4

 *

     5

 *  Copyright (C) 2006  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

    10

 *  and/or modify it under the terms of the GNU General Public License

    11

 *  as published by the Free Software Foundation; either version 2 of the

    12

 *  License, or (at your option) any later version.

    13

 *

    14

 *  The IgH EtherCAT Master is distributed in the hope that it will be

    15

 *  useful, but WITHOUT ANY WARRANTY; without even the implied warranty of

    16

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    17

 *  GNU General Public License for more details.

    18

 *

    19

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

    20

 *  along with the IgH EtherCAT Master; if not, write to the Free Software

    21

 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

    22

 *

    23

 *  The right to use EtherCAT Technology is granted and comes free of

    24

 *  charge under condition of compatibility of product made by

    25

 *  Licensee. People intending to distribute/sell products based on the

    26

 *  code, have to sign an agreement to guarantee that products using

    27

 *  software based on IgH EtherCAT master stay compatible with the actual

    28

 *  EtherCAT specification (which are released themselves as an open

    29

 *  standard) as the (only) precondition to have the right to use EtherCAT

    30

 *  Technology, IP and trade marks.

    31

 *

    32

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

    33

    34

/**

    35

   \file

    36

   EtherCAT master character device.

    37

*/

    38

    39

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

    40

    41

#include <linux/module.h>

    42

    43

#include "cdev.h"

    44

#include "master.h"

    45

#include "slave_config.h"

    46

#include "ioctl.h"

    47

    48

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

    49

    50

/** \cond */

    51

    52

int eccdev_open(struct inode *, struct file *);

    53

int eccdev_release(struct inode *, struct file *);

    54

ssize_t eccdev_read(struct file *, char __user *, size_t, loff_t *);

    55

ssize_t eccdev_write(struct file *, const char __user *, size_t, loff_t *);

    56

long eccdev_ioctl(struct file *, unsigned int, unsigned long);

    57

    58

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

    59

    60

static struct file_operations eccdev_fops = {

    61

    .owner          = THIS_MODULE,

    62

    .open           = eccdev_open,

    63

    .release        = eccdev_release,

    64

    .unlocked_ioctl = eccdev_ioctl

    65

};

    66

    67

/** \endcond */

    68

    69

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

    70

    71

/** Constructor.

    72

 * 

    73

 * \return 0 in case of success, else < 0

    74

 */

    75

int ec_cdev_init(

    76

		ec_cdev_t *cdev, /**< EtherCAT master character device. */

    77

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

    78

		dev_t dev_num /**< Device number. */

    79

		)

    80

{

    81

    cdev->master = master;

    82

    83

    cdev_init(&cdev->cdev, &eccdev_fops);

    84

    cdev->cdev.owner = THIS_MODULE;

    85

    86

    if (cdev_add(&cdev->cdev,

    87

		 MKDEV(MAJOR(dev_num), master->index), 1)) {

    88

		EC_ERR("Failed to add character device!\n");

    89

		return -1;

    90

    }

    91

    92

    return 0;

    93

}

    94

    95

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

    96

    97

/** Destructor.

    98

 */

    99

void ec_cdev_clear(ec_cdev_t *cdev /**< EtherCAT XML device */)

   100

{

   101

    cdev_del(&cdev->cdev);

   102

}

   103

   104

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

   105

 * File operations

   106

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

   107

   108

int eccdev_open(struct inode *inode, struct file *filp)

   109

{

   110

    ec_cdev_t *cdev = container_of(inode->i_cdev, ec_cdev_t, cdev);

   111

    ec_master_t *master = cdev->master;

   112

   113

    filp->private_data = cdev;

   114

    if (master->debug_level)

   115

        EC_DBG("File opened.\n");

   116

    return 0;

   117

}

   118

   119

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

   120

   121

int eccdev_release(struct inode *inode, struct file *filp)

   122

{

   123

    ec_cdev_t *cdev = (ec_cdev_t *) filp->private_data;

   124

    ec_master_t *master = cdev->master;

   125

   126

    if (master->debug_level)

   127

        EC_DBG("File closed.\n");

   128

    return 0;

   129

}

   130

   131

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

   132

   133

long eccdev_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)

   134

{

   135

    ec_cdev_t *cdev = (ec_cdev_t *) filp->private_data;

   136

    ec_master_t *master = cdev->master;

   137

    long retval = 0;

   138

   139

    if (master->debug_level)

   140

        EC_DBG("ioctl(filp = %x, cmd = %u (%u), arg = %x)\n",

   141

                (u32) filp, (u32) cmd, (u32) _IOC_NR(cmd), (u32) arg);

   142

   143

    // FIXME lock

   144

   145

    switch (cmd) {

   146

        case EC_IOCTL_MASTER:

   147

            {

   148

                ec_ioctl_master_t data;

   149

   150

                data.slave_count = master->slave_count;

   151

                data.config_count = ec_master_config_count(master);

   152

                data.mode = (uint8_t) master->mode;

   153

   154

                memcpy(data.devices[0].address, master->main_mac, ETH_ALEN); 

   155

                data.devices[0].attached = master->main_device.dev ? 1 : 0;

   156

                data.devices[0].tx_count = master->main_device.tx_count;

   157

                data.devices[0].rx_count = master->main_device.rx_count;

   158

                memcpy(data.devices[1].address, master->backup_mac, ETH_ALEN); 

   159

                data.devices[1].attached = master->backup_device.dev ? 1 : 0;

   160

                data.devices[1].tx_count = master->backup_device.tx_count;

   161

                data.devices[1].rx_count = master->backup_device.rx_count;

   162

   163

                if (copy_to_user((void __user *) arg, &data, sizeof(data))) {

   164

                    retval = -EFAULT;

   165

                    break;

   166

                }

   167

   168

                break;

   169

            }

   170

   171

            retval = master->slave_count;

   172

            break;

   173

   174

        case EC_IOCTL_SLAVE:

   175

            {

   176

                ec_ioctl_slave_t data;

   177

                const ec_slave_t *slave;

   178

   179

                if (copy_from_user(&data, (void __user *) arg, sizeof(data))) {

   180

                    retval = -EFAULT;

   181

                    break;

   182

                }

   183

   184

                if (!(slave = ec_master_find_slave(

   185

                                master, 0, data.position))) {

   186

                    EC_ERR("Slave %u does not exist!\n", data.position);

   187

                    retval = -EINVAL;

   188

                    break;

   189

                }

   190

   191

                data.vendor_id = slave->sii.vendor_id;

   192

                data.product_code = slave->sii.product_code;

   193

                data.revision_number = slave->sii.revision_number;

   194

                data.serial_number = slave->sii.serial_number;

   195

                data.alias = slave->sii.alias;

   196

                data.rx_mailbox_offset = slave->sii.rx_mailbox_offset;

   197

                data.rx_mailbox_size = slave->sii.rx_mailbox_size;

   198

                data.tx_mailbox_offset = slave->sii.tx_mailbox_offset;

   199

                data.tx_mailbox_size = slave->sii.tx_mailbox_size;

   200

                data.mailbox_protocols = slave->sii.mailbox_protocols;

   201

                data.has_general_category = slave->sii.has_general;

   202

                data.coe_details = slave->sii.coe_details;

   203

                data.general_flags = slave->sii.general_flags;

   204

                data.current_on_ebus = slave->sii.current_on_ebus;

   205

                data.state = slave->current_state;

   206

                data.error_flag = slave->error_flag;

   207

   208

                data.sync_count = slave->sii.sync_count;

   209

                data.sdo_count = ec_slave_sdo_count(slave);

   210

                data.sii_nwords = slave->sii_nwords;

   211

   212

                if (slave->sii.name) {

   213

                    strncpy(data.name, slave->sii.name,

   214

                            EC_IOCTL_STRING_SIZE);

   215

                    data.name[EC_IOCTL_STRING_SIZE - 1] = 0;

   216

                } else {

   217

                    data.name[0] = 0;

   218

                }

   219

   220

                if (copy_to_user((void __user *) arg, &data, sizeof(data))) {

   221

                    retval = -EFAULT;

   222

                    break;

   223

                }

   224

   225

                break;

   226

            }

   227

   228

        case EC_IOCTL_SYNC:

   229

            {

   230

                ec_ioctl_sync_t data;

   231

                const ec_slave_t *slave;

   232

                const ec_sync_t *sync;

   233

   234

                if (copy_from_user(&data, (void __user *) arg, sizeof(data))) {

   235

                    retval = -EFAULT;

   236

                    break;

   237

                }

   238

   239

                if (!(slave = ec_master_find_slave(

   240

                                master, 0, data.slave_position))) {

   241

                    EC_ERR("Slave %u does not exist!\n", data.slave_position);

   242

                    retval = -EINVAL;

   243

                    break;

   244

                }

   245

   246

                if (data.sync_index >= slave->sii.sync_count) {

   247

                    EC_ERR("Sync manager %u does not exist in slave %u!\n",

   248

                            data.sync_index, data.slave_position);

   249

                    retval = -EINVAL;

   250

                    break;

   251

                }

   252

   253

                sync = &slave->sii.syncs[data.sync_index];

   254

   255

                data.physical_start_address = sync->physical_start_address;

   256

                data.default_size = sync->length;

   257

                data.control_register = sync->control_register;

   258

                data.enable = sync->enable;

   259

                data.assign_source = sync->assign_source;

   260

                data.pdo_count = ec_pdo_list_count(&sync->pdos);

   261

   262

                if (copy_to_user((void __user *) arg, &data, sizeof(data))) {

   263

                    retval = -EFAULT;

   264

                    break;

   265

                }

   266

                break;

   267

            }

   268

   269

        case EC_IOCTL_PDO:

   270

            {

   271

                ec_ioctl_pdo_t data;

   272

                const ec_slave_t *slave;

   273

                const ec_sync_t *sync;

   274

                const ec_pdo_t *pdo;

   275

   276

                if (copy_from_user(&data, (void __user *) arg, sizeof(data))) {

   277

                    retval = -EFAULT;

   278

                    break;

   279

                }

   280

   281

                if (!(slave = ec_master_find_slave(

   282

                                master, 0, data.slave_position))) {

   283

                    EC_ERR("Slave %u does not exist!\n", data.slave_position);

   284

                    retval = -EINVAL;

   285

                    break;

   286

                }

   287

   288

                if (data.sync_index >= slave->sii.sync_count) {

   289

                    EC_ERR("Sync manager %u does not exist in slave %u!\n",

   290

                            data.sync_index, data.slave_position);

   291

                    retval = -EINVAL;

   292

                    break;

   293

                }

   294

   295

                sync = &slave->sii.syncs[data.sync_index];

   296

                if (!(pdo = ec_pdo_list_find_pdo_by_pos_const(

   297

                                &sync->pdos, data.pdo_pos))) {

   298

                    EC_ERR("Sync manager %u does not contain a Pdo with "

   299

                            "position %u in slave %u!\n", data.sync_index,

   300

                            data.pdo_pos, data.slave_position);

   301

                    retval = -EINVAL;

   302

                    break;

   303

                }

   304

   305

                data.dir = pdo->dir;

   306

                data.index = pdo->index;

   307

                data.entry_count = ec_pdo_entry_count(pdo);

   308

   309

                if (pdo->name) {

   310

                    strncpy(data.name, pdo->name, EC_IOCTL_STRING_SIZE);

   311

                    data.name[EC_IOCTL_STRING_SIZE - 1] = 0;

   312

                } else {

   313

                    data.name[0] = 0;

   314

                }

   315

   316

                if (copy_to_user((void __user *) arg, &data, sizeof(data))) {

   317

                    retval = -EFAULT;

   318

                    break;

   319

                }

   320

                break;

   321

            }

   322

   323

        case EC_IOCTL_PDO_ENTRY:

   324

            {

   325

                ec_ioctl_pdo_entry_t data;

   326

                const ec_slave_t *slave;

   327

                const ec_sync_t *sync;

   328

                const ec_pdo_t *pdo;

   329

                const ec_pdo_entry_t *entry;

   330

   331

                if (copy_from_user(&data, (void __user *) arg, sizeof(data))) {

   332

                    retval = -EFAULT;

   333

                    break;

   334

                }

   335

   336

                if (!(slave = ec_master_find_slave(

   337

                                master, 0, data.slave_position))) {

   338

                    EC_ERR("Slave %u does not exist!\n", data.slave_position);

   339

                    retval = -EINVAL;

   340

                    break;

   341

                }

   342

   343

                if (data.sync_index >= slave->sii.sync_count) {

   344

                    EC_ERR("Sync manager %u does not exist in slave %u!\n",

   345

                            data.sync_index, data.slave_position);

   346

                    retval = -EINVAL;

   347

                    break;

   348

                }

   349

   350

                sync = &slave->sii.syncs[data.sync_index];

   351

                if (!(pdo = ec_pdo_list_find_pdo_by_pos_const(

   352

                                &sync->pdos, data.pdo_pos))) {

   353

                    EC_ERR("Sync manager %u does not contain a Pdo with "

   354

                            "position %u in slave %u!\n", data.sync_index,

   355

                            data.pdo_pos, data.slave_position);

   356

                    retval = -EINVAL;

   357

                    break;

   358

                }

   359

   360

                if (!(entry = ec_pdo_find_entry_by_pos_const(

   361

                                pdo, data.entry_pos))) {

   362

                    EC_ERR("Pdo 0x%04X does not contain an entry with "

   363

                            "position %u in slave %u!\n", data.pdo_pos,

   364

                            data.entry_pos, data.slave_position);

   365

                    retval = -EINVAL;

   366

                    break;

   367

                }

   368

   369

                data.index = entry->index;

   370

                data.subindex = entry->subindex;

   371

                data.bit_length = entry->bit_length;

   372

                if (entry->name) {

   373

                    strncpy(data.name, entry->name, EC_IOCTL_STRING_SIZE);

   374

                    data.name[EC_IOCTL_STRING_SIZE - 1] = 0;

   375

                } else {

   376

                    data.name[0] = 0;

   377

                }

   378

   379

                if (copy_to_user((void __user *) arg, &data, sizeof(data))) {

   380

                    retval = -EFAULT;

   381

                    break;

   382

                }

   383

                break;

   384

            }

   385

   386

        case EC_IOCTL_DOMAIN_COUNT:

   387

            retval = ec_master_domain_count(master);

   388

            break;

   389

   390

        case EC_IOCTL_DOMAIN:

   391

            {

   392

                ec_ioctl_domain_t data;

   393

                const ec_domain_t *domain;

   394

   395

                if (copy_from_user(&data, (void __user *) arg, sizeof(data))) {

   396

                    retval = -EFAULT;

   397

                    break;

   398

                }

   399

   400

                if (!(domain = ec_master_find_domain(master, data.index))) {

   401

                    EC_ERR("Domain %u does not exist!\n", data.index);

   402

                    retval = -EINVAL;

   403

                    break;

   404

                }

   405

   406

                data.data_size = domain->data_size;

   407

                data.logical_base_address = domain->logical_base_address;

   408

                data.working_counter = domain->working_counter;

   409

                data.expected_working_counter = domain->expected_working_counter;

   410

                data.fmmu_count = ec_domain_fmmu_count(domain);

   411

   412

                if (copy_to_user((void __user *) arg, &data, sizeof(data))) {

   413

                    retval = -EFAULT;

   414

                    break;

   415

                }

   416

                break;

   417

            }

   418

   419

        case EC_IOCTL_DOMAIN_FMMU:

   420

            {

   421

                ec_ioctl_domain_fmmu_t data;

   422

                const ec_domain_t *domain;

   423

                const ec_fmmu_config_t *fmmu;

   424

   425

                if (copy_from_user(&data, (void __user *) arg, sizeof(data))) {

   426

                    retval = -EFAULT;

   427

                    break;

   428

                }

   429

   430

                if (!(domain = ec_master_find_domain(master, data.domain_index))) {

   431

                    EC_ERR("Domain %u does not exist!\n", data.domain_index);

   432

                    retval = -EINVAL;

   433

                    break;

   434

                }

   435

   436

                if (!(fmmu = ec_domain_find_fmmu(domain, data.fmmu_index))) {

   437

                    EC_ERR("Domain %u has less than %u fmmu configurations.\n",

   438

                            data.domain_index, data.fmmu_index + 1);

   439

                    retval = -EINVAL;

   440

                    break;

   441

                }

   442

   443

                data.slave_config_alias = fmmu->sc->alias;

   444

                data.slave_config_position = fmmu->sc->position;

   445

                data.fmmu_dir = fmmu->dir;

   446

                data.logical_address = fmmu->logical_start_address;

   447

                data.data_size = fmmu->data_size;

   448

   449

                if (copy_to_user((void __user *) arg, &data, sizeof(data))) {

   450

                    retval = -EFAULT;

   451

                    break;

   452

                }

   453

                break;

   454

            }

   455

   456

        case EC_IOCTL_DATA:

   457

            {

   458

                ec_ioctl_data_t data;

   459

                const ec_domain_t *domain;

   460

   461

                if (copy_from_user(&data, (void __user *) arg, sizeof(data))) {

   462

                    retval = -EFAULT;

   463

                    break;

   464

                }

   465

   466

                if (!(domain = ec_master_find_domain(master, data.domain_index))) {

   467

                    EC_ERR("Domain %u does not exist!\n", data.domain_index);

   468

                    retval = -EINVAL;

   469

                    break;

   470

                }

   471

   472

                if (domain->data_size != data.data_size) {

   473

                    EC_ERR("Data size mismatch %u/%u!\n",

   474

                            data.data_size, domain->data_size);

   475

                    retval = -EFAULT;

   476

                    break;

   477

                }

   478

   479

                if (copy_to_user((void __user *) data.target, domain->data,

   480

                            domain->data_size)) {

   481

                    retval = -EFAULT;

   482

                    break;

   483

                }

   484

                break;

   485

            }

   486

   487

        case EC_IOCTL_SET_DEBUG:

   488

            if (!(filp->f_mode & FMODE_WRITE))

   489

                return -EPERM;

   490

            if (ec_master_debug_level(master, (unsigned int) arg)) {

   491

                retval = -EINVAL;

   492

            }

   493

            break;

   494

   495

        case EC_IOCTL_SLAVE_STATE:

   496

            {

   497

                ec_ioctl_slave_state_t data;

   498

                ec_slave_t *slave;

   499

   500

                if (!(filp->f_mode & FMODE_WRITE))

   501

                    return -EPERM;