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

   Canopen-over-EtherCAT functions.

    37

*/

    38

    39

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

    40

    41

#include <linux/module.h>

    42

    43

#include "canopen.h"

    44

#include "master.h"

    45

    46

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

    47

    48

ssize_t ec_show_sdo_attribute(struct kobject *, struct attribute *, char *);

    49

ssize_t ec_show_sdo_entry_attribute(struct kobject *, struct attribute *,

    50

                                    char *);

    51

void ec_sdo_clear(struct kobject *);

    52

void ec_sdo_entry_clear(struct kobject *);

    53

    54

void ec_sdo_request_init_read(ec_sdo_request_t *, ec_sdo_t *,

    55

                              ec_sdo_entry_t *);

    56

void ec_sdo_request_clear(ec_sdo_request_t *);

    57

    58

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

    59

    60

/** \cond */

    61

    62

EC_SYSFS_READ_ATTR(info);

    63

EC_SYSFS_READ_ATTR(value);

    64

    65

static struct attribute *sdo_def_attrs[] = {

    66

    &attr_info,

    67

    NULL,

    68

};

    69

    70

static struct sysfs_ops sdo_sysfs_ops = {

    71

    .show = &ec_show_sdo_attribute,

    72

    .store = NULL

    73

};

    74

    75

static struct kobj_type ktype_ec_sdo = {

    76

    .release = ec_sdo_clear,

    77

    .sysfs_ops = &sdo_sysfs_ops,

    78

    .default_attrs = sdo_def_attrs

    79

};

    80

    81

static struct attribute *sdo_entry_def_attrs[] = {

    82

    &attr_info,

    83

    &attr_value,

    84

    NULL,

    85

};

    86

    87

static struct sysfs_ops sdo_entry_sysfs_ops = {

    88

    .show = &ec_show_sdo_entry_attribute,

    89

    .store = NULL

    90

};

    91

    92

static struct kobj_type ktype_ec_sdo_entry = {

    93

    .release = ec_sdo_entry_clear,

    94

    .sysfs_ops = &sdo_entry_sysfs_ops,

    95

    .default_attrs = sdo_entry_def_attrs

    96

};

    97

    98

/** \endcond */

    99

   100

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

   101

   102

/**

   103

   SDO constructor.

   104

*/

   105

   106

int ec_sdo_init(ec_sdo_t *sdo, /**< SDO */

   107

                uint16_t index, /**< SDO index */

   108

                ec_slave_t *slave /**< parent slave */

   109

                )

   110

{

   111

    sdo->slave = slave;

   112

    sdo->index = index;

   113

    sdo->object_code = 0x00;

   114

    sdo->name = NULL;

   115

    sdo->subindices = 0;

   116

    INIT_LIST_HEAD(&sdo->entries);

   117

   118

    // init kobject and add it to the hierarchy

   119

    memset(&sdo->kobj, 0x00, sizeof(struct kobject));

   120

    kobject_init(&sdo->kobj);

   121

    sdo->kobj.ktype = &ktype_ec_sdo;

   122

    sdo->kobj.parent = &slave->sdo_kobj;

   123

    if (kobject_set_name(&sdo->kobj, "%4X", sdo->index)) {

   124

        EC_ERR("Failed to set kobj name.\n");

   125

        return -1;

   126

    }

   127

   128

    return 0;

   129

}

   130

   131

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

   132

   133

/**

   134

   SDO destructor.

   135

   Clears and frees an SDO object.

   136

*/

   137

   138

void ec_sdo_destroy(ec_sdo_t *sdo /**< SDO */)

   139

{

   140

    ec_sdo_entry_t *entry, *next;

   141

   142

    // free all entries

   143

    list_for_each_entry_safe(entry, next, &sdo->entries, list) {

   144

        list_del(&entry->list);

   145

        ec_sdo_entry_destroy(entry);

   146

    }

   147

   148

    // destroy self

   149

    kobject_del(&sdo->kobj);

   150

    kobject_put(&sdo->kobj);

   151

}

   152

   153

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

   154

   155

/**

   156

   Clear and free SDO.

   157

   This method is called by the kobject,

   158

   once there are no more references to it.

   159

*/

   160

   161

void ec_sdo_clear(struct kobject *kobj /**< SDO's kobject */)

   162

{

   163

    ec_sdo_t *sdo = container_of(kobj, ec_sdo_t, kobj);

   164

   165

    if (sdo->name) kfree(sdo->name);

   166

   167

    kfree(sdo);

   168

}

   169

   170

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

   171

   172

ssize_t ec_sdo_info(ec_sdo_t *sdo, /**< SDO */

   173

                    char *buffer /**< target buffer */

   174

                    )

   175

{

   176

    off_t off = 0;

   177

   178

    off += sprintf(buffer + off, "Index: 0x%04X\n", sdo->index);

   179

    off += sprintf(buffer + off, "Name: %s\n", sdo->name ? sdo->name : "");

   180

    off += sprintf(buffer + off, "Subindices: %i\n", sdo->subindices);

   181

   182

    return off;

   183

}

   184

   185

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

   186

   187

ssize_t ec_show_sdo_attribute(struct kobject *kobj, /**< kobject */

   188

                              struct attribute *attr,

   189

                              char *buffer

   190

                              )

   191

{

   192

    ec_sdo_t *sdo = container_of(kobj, ec_sdo_t, kobj);

   193

   194

    if (attr == &attr_info) {

   195

        return ec_sdo_info(sdo, buffer);

   196

    }

   197

   198

    return 0;

   199

}

   200

   201

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

   202

   203

/**

   204

   SDO entry constructor.

   205

*/

   206

   207

int ec_sdo_entry_init(ec_sdo_entry_t *entry, /**< SDO entry */

   208

                      uint8_t subindex, /**< SDO entry subindex */

   209

                      ec_sdo_t *sdo /**< parent SDO */

   210

                      )

   211

{

   212

    entry->sdo = sdo;

   213

    entry->subindex = subindex;

   214

    entry->data_type = 0x0000;

   215

    entry->bit_length = 0;

   216

    entry->description = NULL;

   217

   218

    // init kobject and add it to the hierarchy

   219

    memset(&entry->kobj, 0x00, sizeof(struct kobject));

   220

    kobject_init(&entry->kobj);

   221

    entry->kobj.ktype = &ktype_ec_sdo_entry;

   222

    entry->kobj.parent = &sdo->kobj;

   223

    if (kobject_set_name(&entry->kobj, "%i", entry->subindex)) {

   224

        EC_ERR("Failed to set kobj name.\n");

   225

        return -1;

   226

    }

   227

   228

    return 0;

   229

}

   230

   231

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

   232

   233

/**

   234

   SDO entry destructor.

   235

   Clears and frees an SDO entry object.

   236

*/

   237

   238

void ec_sdo_entry_destroy(ec_sdo_entry_t *entry /**< SDO entry */)

   239

{

   240

    // destroy self

   241

    kobject_del(&entry->kobj);

   242

    kobject_put(&entry->kobj);

   243

}

   244

   245

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

   246

   247

/**

   248

   Clear and free SDO entry.

   249

   This method is called by the kobject,

   250

   once there are no more references to it.

   251

*/

   252

   253

void ec_sdo_entry_clear(struct kobject *kobj /**< SDO entry's kobject */)

   254

{

   255

    ec_sdo_entry_t *entry = container_of(kobj, ec_sdo_entry_t, kobj);

   256

   257

    if (entry->description) kfree(entry->description);

   258

   259

    kfree(entry);

   260

}

   261

   262

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

   263

   264

ssize_t ec_sdo_entry_info(ec_sdo_entry_t *entry, /**< SDO entry */

   265

                          char *buffer /**< target buffer */

   266

                          )

   267

{

   268

    off_t off = 0;

   269

   270

    off += sprintf(buffer + off, "Subindex: 0x%02X\n", entry->subindex);

   271

    off += sprintf(buffer + off, "Description: %s\n",

   272

                   entry->description ? entry->description : "");

   273

    off += sprintf(buffer + off, "Data type: 0x%04X\n", entry->data_type);

   274

    off += sprintf(buffer + off, "Bit length: %i\n", entry->bit_length);

   275

   276

    return off;

   277

}

   278

   279

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

   280

   281

ssize_t ec_sdo_entry_format_data(ec_sdo_entry_t *entry, /**< SDO entry */

   282

                                 ec_sdo_request_t *request, /**< SDO request */

   283

                                 char *buffer /**< target buffer */

   284

                                 )

   285

{

   286

    off_t off = 0;

   287

    unsigned int i;

   288

   289

    if (entry->data_type == 0x0002 && entry->bit_length == 8) { // int8

   290

        off += sprintf(buffer + off, "%i\n", *((int8_t *) request->data));

   291

    }

   292

    else if (entry->data_type == 0x0003 && entry->bit_length == 16) { // int16

   293

        off += sprintf(buffer + off, "%i\n", *((int16_t *) request->data));

   294

    }

   295

    else if (entry->data_type == 0x0004 && entry->bit_length == 32) { // int32

   296

        off += sprintf(buffer + off, "%i\n", *((int32_t *) request->data));

   297

    }

   298

    else if (entry->data_type == 0x0005 && entry->bit_length == 8) { // uint8

   299

        off += sprintf(buffer + off, "%i\n", *((uint8_t *) request->data));

   300

    }

   301

    else if (entry->data_type == 0x0006 && entry->bit_length == 16) { // uint16

   302

        off += sprintf(buffer + off, "%i\n", *((uint16_t *) request->data));

   303

    }

   304

    else if (entry->data_type == 0x0007 && entry->bit_length == 32) { // uint32

   305

        off += sprintf(buffer + off, "%i\n", *((uint32_t *) request->data));

   306

    }

   307

    else if (entry->data_type == 0x0009) { // string

   308

        off += sprintf(buffer + off, "%s\n", request->data);

   309

    }

   310

    else {

   311

        for (i = 0; i < request->size; i++)

   312

            off += sprintf(buffer + off, "%02X (%c)\n",

   313

                           request->data[i], request->data[i]);

   314

    }

   315

   316

    return off;

   317

}

   318

   319

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

   320

   321

ssize_t ec_sdo_entry_read_value(ec_sdo_entry_t *entry, /**< SDO entry */

   322

                                char *buffer /**< target buffer */

   323

                                )

   324

{

   325

    ec_sdo_t *sdo = entry->sdo;

   326

    ec_master_t *master = sdo->slave->master;

   327

    off_t off = 0;

   328

    ec_sdo_request_t request;

   329

   330

    if (down_interruptible(&master->sdo_sem)) {

   331

        // interrupted by signal

   332

        return -ERESTARTSYS;

   333

    }

   334

   335

    ec_sdo_request_init_read(&request, sdo, entry);

   336

   337

    // this is necessary, because the completion object

   338

    // is completed by the ec_master_flush_sdo_requests() function.

   339

    INIT_COMPLETION(master->sdo_complete);

   340

   341

    master->sdo_request = &request;

   342

    master->sdo_seq_user++;

   343

    master->sdo_timer.expires = jiffies + 10;

   344

    add_timer(&master->sdo_timer);

   345

   346

    wait_for_completion(&master->sdo_complete);

   347

   348

    master->sdo_request = NULL;

   349

    up(&master->sdo_sem);

   350

   351

    if (request.return_code == 1 && request.data) {

   352

        off += ec_sdo_entry_format_data(entry, &request, buffer);

   353

    }

   354

    else {

   355

        off = -EINVAL;

   356

    }

   357

   358

    ec_sdo_request_clear(&request);

   359

    return off;

   360

}

   361

   362

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

   363

   364

ssize_t ec_show_sdo_entry_attribute(struct kobject *kobj, /**< kobject */

   365

                                    struct attribute *attr,

   366

                                    char *buffer

   367

                                    )

   368

{

   369

    ec_sdo_entry_t *entry = container_of(kobj, ec_sdo_entry_t, kobj);

   370

   371

    if (attr == &attr_info) {

   372

        return ec_sdo_entry_info(entry, buffer);

   373

    }

   374

    else if (attr == &attr_value) {

   375

        return ec_sdo_entry_read_value(entry, buffer);

   376

    }

   377

   378

    return 0;

   379

}

   380

   381

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

   382

   383

/**

   384

   SDO request constructor.

   385

*/

   386

   387

void ec_sdo_request_init_read(ec_sdo_request_t *req, /**< SDO request */

   388

                              ec_sdo_t *sdo, /**< SDO */

   389

                              ec_sdo_entry_t *entry /**< SDO entry */

   390

                              )

   391

{

   392

    req->sdo = sdo;

   393

    req->entry = entry;

   394

    req->data = NULL;

   395

    req->size = 0;

   396

    req->return_code = 0;

   397

}

   398

   399

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

   400

   401

/**

   402

   SDO request destructor.

   403

*/

   404

   405

void ec_sdo_request_clear(ec_sdo_request_t *req /**< SDO request */)

   406

{

   407

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

   408

}

   409

   410

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