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

        case EC_IOCTL_SLAVE:

   169

            {

   170

                ec_ioctl_slave_t data;

   171

                const ec_slave_t *slave;

   172

   173

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

   174

                    retval = -EFAULT;

   175

                    break;

   176

                }

   177

   178

                if (!(slave = ec_master_find_slave(

   179

                                master, 0, data.position))) {

   180

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

   181

                    retval = -EINVAL;

   182

                    break;

   183

                }

   184

   185

                data.vendor_id = slave->sii.vendor_id;

   186

                data.product_code = slave->sii.product_code;

   187

                data.revision_number = slave->sii.revision_number;

   188

                data.serial_number = slave->sii.serial_number;

   189

                data.alias = slave->sii.alias;

   190

                data.rx_mailbox_offset = slave->sii.rx_mailbox_offset;

   191

                data.rx_mailbox_size = slave->sii.rx_mailbox_size;

   192

                data.tx_mailbox_offset = slave->sii.tx_mailbox_offset;

   193

                data.tx_mailbox_size = slave->sii.tx_mailbox_size;

   194

                data.mailbox_protocols = slave->sii.mailbox_protocols;

   195

                data.has_general_category = slave->sii.has_general;

   196

                data.coe_details = slave->sii.coe_details;

   197

                data.general_flags = slave->sii.general_flags;

   198

                data.current_on_ebus = slave->sii.current_on_ebus;

   199

                data.state = slave->current_state;

   200

                data.error_flag = slave->error_flag;

   201

   202

                data.sync_count = slave->sii.sync_count;

   203

                data.sdo_count = ec_slave_sdo_count(slave);

   204

                data.sii_nwords = slave->sii_nwords;

   205

   206

                if (slave->sii.name) {

   207

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

   208

                            EC_IOCTL_STRING_SIZE);

   209

                    data.name[EC_IOCTL_STRING_SIZE - 1] = 0;

   210

                } else {

   211

                    data.name[0] = 0;

   212

                }

   213

   214

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

   215

                    retval = -EFAULT;

   216

                break;

   217

            }

   218

   219

        case EC_IOCTL_SYNC:

   220

            {

   221

                ec_ioctl_sync_t data;

   222

                const ec_slave_t *slave;

   223

                const ec_sync_t *sync;

   224

   225

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

   226

                    retval = -EFAULT;

   227

                    break;

   228

                }

   229

   230

                if (!(slave = ec_master_find_slave(

   231

                                master, 0, data.slave_position))) {

   232

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

   233

                    retval = -EINVAL;

   234

                    break;

   235

                }

   236

   237

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

   238

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

   239

                            data.sync_index, data.slave_position);

   240

                    retval = -EINVAL;

   241

                    break;

   242

                }

   243

   244

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

   245

   246

                data.physical_start_address = sync->physical_start_address;

   247

                data.default_size = sync->length;

   248

                data.control_register = sync->control_register;

   249

                data.enable = sync->enable;

   250

                data.assign_source = sync->assign_source;

   251

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

   252

   253

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

   254

                    retval = -EFAULT;

   255

                break;

   256

            }

   257

   258

        case EC_IOCTL_PDO:

   259

            {

   260

                ec_ioctl_pdo_t data;

   261

                const ec_slave_t *slave;

   262

                const ec_sync_t *sync;

   263

                const ec_pdo_t *pdo;

   264

   265

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

   266

                    retval = -EFAULT;

   267

                    break;

   268

                }

   269

   270

                if (!(slave = ec_master_find_slave(

   271

                                master, 0, data.slave_position))) {

   272

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

   273

                    retval = -EINVAL;

   274

                    break;

   275

                }

   276

   277

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

   278

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

   279

                            data.sync_index, data.slave_position);

   280

                    retval = -EINVAL;

   281

                    break;

   282

                }

   283

   284

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

   285

                if (!(pdo = ec_pdo_list_find_pdo_by_pos_const(

   286

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

   287

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

   288

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

   289

                            data.pdo_pos, data.slave_position);

   290

                    retval = -EINVAL;

   291

                    break;

   292

                }

   293

   294

                data.dir = pdo->dir;

   295

                data.index = pdo->index;

   296

                data.entry_count = ec_pdo_entry_count(pdo);

   297

   298

                if (pdo->name) {

   299

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

   300

                    data.name[EC_IOCTL_STRING_SIZE - 1] = 0;

   301

                } else {

   302

                    data.name[0] = 0;

   303

                }

   304

   305

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

   306

                    retval = -EFAULT;

   307

                break;

   308

            }

   309

   310

        case EC_IOCTL_PDO_ENTRY:

   311

            {

   312

                ec_ioctl_pdo_entry_t data;

   313

                const ec_slave_t *slave;

   314

                const ec_sync_t *sync;

   315

                const ec_pdo_t *pdo;

   316

                const ec_pdo_entry_t *entry;

   317

   318

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

   319

                    retval = -EFAULT;

   320

                    break;

   321

                }

   322

   323

                if (!(slave = ec_master_find_slave(

   324

                                master, 0, data.slave_position))) {

   325

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

   326

                    retval = -EINVAL;

   327

                    break;

   328

                }

   329

   330

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

   331

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

   332

                            data.sync_index, data.slave_position);

   333

                    retval = -EINVAL;

   334

                    break;

   335

                }

   336

   337

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

   338

                if (!(pdo = ec_pdo_list_find_pdo_by_pos_const(

   339

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

   340

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

   341

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

   342

                            data.pdo_pos, data.slave_position);

   343

                    retval = -EINVAL;

   344

                    break;

   345

                }

   346

   347

                if (!(entry = ec_pdo_find_entry_by_pos_const(

   348

                                pdo, data.entry_pos))) {

   349

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

   350

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

   351

                            data.entry_pos, data.slave_position);

   352

                    retval = -EINVAL;

   353

                    break;

   354

                }

   355

   356

                data.index = entry->index;

   357

                data.subindex = entry->subindex;

   358

                data.bit_length = entry->bit_length;

   359

                if (entry->name) {

   360

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

   361

                    data.name[EC_IOCTL_STRING_SIZE - 1] = 0;

   362

                } else {

   363

                    data.name[0] = 0;

   364

                }

   365

   366

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

   367

                    retval = -EFAULT;

   368

                break;

   369

            }

   370

   371

        case EC_IOCTL_DOMAIN_COUNT:

   372

            retval = ec_master_domain_count(master);

   373

            break;

   374

   375

        case EC_IOCTL_DOMAIN:

   376

            {

   377

                ec_ioctl_domain_t data;

   378

                const ec_domain_t *domain;

   379

   380

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

   381

                    retval = -EFAULT;

   382

                    break;

   383

                }

   384

   385

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

   386

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

   387

                    retval = -EINVAL;

   388

                    break;

   389

                }

   390

   391

                data.data_size = domain->data_size;

   392

                data.logical_base_address = domain->logical_base_address;

   393

                data.working_counter = domain->working_counter;

   394

                data.expected_working_counter = domain->expected_working_counter;

   395

                data.fmmu_count = ec_domain_fmmu_count(domain);

   396

   397

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

   398

                    retval = -EFAULT;

   399

                break;

   400

            }

   401

   402

        case EC_IOCTL_DOMAIN_FMMU:

   403

            {

   404

                ec_ioctl_domain_fmmu_t data;

   405

                const ec_domain_t *domain;

   406

                const ec_fmmu_config_t *fmmu;

   407

   408

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

   409

                    retval = -EFAULT;

   410

                    break;

   411

                }

   412

   413

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

   414

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

   415

                    retval = -EINVAL;

   416

                    break;

   417

                }

   418

   419

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

   420

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

   421

                            data.domain_index, data.fmmu_index + 1);

   422

                    retval = -EINVAL;

   423

                    break;

   424

                }

   425

   426

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

   427

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

   428

                data.fmmu_dir = fmmu->dir;

   429

                data.logical_address = fmmu->logical_start_address;

   430

                data.data_size = fmmu->data_size;

   431

   432

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

   433

                    retval = -EFAULT;

   434

                break;

   435

            }

   436

   437

        case EC_IOCTL_DATA:

   438

            {

   439

                ec_ioctl_data_t data;

   440

                const ec_domain_t *domain;

   441

   442

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

   443

                    retval = -EFAULT;

   444

                    break;

   445

                }

   446

   447

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

   448

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

   449

                    retval = -EINVAL;

   450

                    break;

   451

                }

   452

   453

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

   454

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

   455

                            data.data_size, domain->data_size);

   456

                    retval = -EFAULT;

   457

                    break;

   458

                }

   459

   460

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

   461

                            domain->data_size))

   462

                    retval = -EFAULT;

   463

                break;

   464

            }

   465

   466

        case EC_IOCTL_SET_DEBUG:

   467

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

   468

                return -EPERM;

   469

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

   470

                retval = -EINVAL;

   471

            break;

   472

   473

        case EC_IOCTL_SLAVE_STATE:

   474

            {

   475

                ec_ioctl_slave_state_t data;

   476

                ec_slave_t *slave;

   477

   478

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

   479

                    return -EPERM;

   480

   481

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

   482

                    retval = -EFAULT;

   483

                    break;

   484

                }

   485

   486

                if (!(slave = ec_master_find_slave(

   487

                                master, 0, data.slave_position))) {

   488

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

   489

                    retval = -EINVAL;

   490

                    break;

   491

                }

   492

   493

                ec_slave_request_state(slave, data.requested_state);

   494

                break;

   495

            }

   496

   497

        case EC_IOCTL_SDO:

   498

            {

   499

                ec_ioctl_sdo_t data;

   500

                const ec_slave_t *slave;