1

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

     2

 *

     3

 *  $Id$

     4

 *

     5

 *  Copyright (C) 2006-2008  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 and/or

    10

 *  modify it under the terms of the GNU General Public License version 2, as

    11

 *  published by the Free Software Foundation.

    12

 *

    13

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

    14

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

    15

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General

    16

 *  Public License for more details.

    17

 *

    18

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

    19

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

    20

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

    21

 *

    22

 *  ---

    23

 *

    24

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

    25

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

    26

 *  industrial property and similar rights of Beckhoff Automation GmbH.

    27

 *

    28

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

    29

    30

/**

    31

   \file

    32

   EtherCAT slave methods.

    33

*/

    34

    35

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

    36

    37

#include <linux/module.h>

    38

#include <linux/delay.h>

    39

    40

#include "globals.h"

    41

#include "datagram.h"

    42

#include "master.h"

    43

#include "slave_config.h"

    44

    45

#include "slave.h"

    46

    47

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

    48

    49

extern const ec_code_msg_t al_status_messages[];

    50

    51

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

    52

    53

char *ec_slave_sii_string(ec_slave_t *, unsigned int);

    54

    55

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

    56

    57

/**

    58

   Slave constructor.

    59

   \return 0 in case of success, else < 0

    60

*/

    61

    62

void ec_slave_init(

    63

        ec_slave_t *slave, /**< EtherCAT slave */

    64

        ec_master_t *master, /**< EtherCAT master */

    65

        uint16_t ring_position, /**< ring position */

    66

        uint16_t station_address /**< station address to configure */

    67

        )

    68

{

    69

    unsigned int i;

    70

    int ret;

    71

    72

    slave->master = master;

    73

    slave->ring_position = ring_position;

    74

    slave->station_address = station_address;

    75

    slave->effective_alias = 0x0000;

    76

    77

    slave->config = NULL;

    78

    slave->requested_state = EC_SLAVE_STATE_PREOP;

    79

    slave->current_state = EC_SLAVE_STATE_UNKNOWN;

    80

    slave->error_flag = 0;

    81

    slave->force_config = 0;

    82

    slave->configured_rx_mailbox_offset = 0x0000;

    83

    slave->configured_rx_mailbox_size = 0x0000;

    84

    slave->configured_tx_mailbox_offset = 0x0000;

    85

    slave->configured_tx_mailbox_size = 0x0000;

    86

    87

    slave->base_type = 0;

    88

    slave->base_revision = 0;

    89

    slave->base_build = 0;

    90

    slave->base_fmmu_count = 0;

    91

    slave->base_sync_count = 0;

    92

    93

    for (i = 0; i < EC_MAX_PORTS; i++) {

    94

        slave->ports[i].desc = EC_PORT_NOT_IMPLEMENTED;

    95

    96

        slave->ports[i].link.link_up = 0;

    97

        slave->ports[i].link.loop_closed = 0;

    98

        slave->ports[i].link.signal_detected = 0;

    99

        slave->sii.physical_layer[i] = 0xFF;

   100

   101

        slave->ports[i].receive_time = 0U;

   102

   103

        slave->ports[i].next_slave = NULL;

   104

        slave->ports[i].delay_to_next_dc = 0U;

   105

    }

   106

   107

    slave->base_fmmu_bit_operation = 0;

   108

    slave->base_dc_supported = 0;

   109

    slave->base_dc_range = EC_DC_32;

   110

    slave->has_dc_system_time = 0;

   111

    slave->transmission_delay = 0U;

   112

   113

    slave->sii_words = NULL;

   114

    slave->sii_nwords = 0;

   115

   116

    slave->sii.alias = 0x0000;

   117

    slave->sii.vendor_id = 0x00000000;

   118

    slave->sii.product_code = 0x00000000;

   119

    slave->sii.revision_number = 0x00000000;

   120

    slave->sii.serial_number = 0x00000000;

   121

    slave->sii.boot_rx_mailbox_offset = 0x0000;

   122

    slave->sii.boot_rx_mailbox_size = 0x0000;

   123

    slave->sii.boot_tx_mailbox_offset = 0x0000;

   124

    slave->sii.boot_tx_mailbox_size = 0x0000;

   125

    slave->sii.std_rx_mailbox_offset = 0x0000;

   126

    slave->sii.std_rx_mailbox_size = 0x0000;

   127

    slave->sii.std_tx_mailbox_offset = 0x0000;

   128

    slave->sii.std_tx_mailbox_size = 0x0000;

   129

    slave->sii.mailbox_protocols = 0;

   130

   131

    slave->sii.strings = NULL;

   132

    slave->sii.string_count = 0;

   133

   134

    slave->sii.has_general = 0;

   135

    slave->sii.group = NULL;

   136

    slave->sii.image = NULL;

   137

    slave->sii.order = NULL;

   138

    slave->sii.name = NULL;

   139

    memset(&slave->sii.coe_details, 0x00, sizeof(ec_sii_coe_details_t));

   140

    memset(&slave->sii.general_flags, 0x00, sizeof(ec_sii_general_flags_t));

   141

    slave->sii.current_on_ebus = 0;

   142

   143

    slave->sii.syncs = NULL;

   144

    slave->sii.sync_count = 0;

   145

   146

    INIT_LIST_HEAD(&slave->sii.pdos);

   147

   148

    INIT_LIST_HEAD(&slave->sdo_dictionary);

   149

   150

    slave->sdo_dictionary_fetched = 0;

   151

    slave->jiffies_preop = 0;

   152

   153

    INIT_LIST_HEAD(&slave->slave_sdo_requests);

   154

    init_waitqueue_head(&slave->sdo_queue);

   155

   156

    INIT_LIST_HEAD(&slave->foe_requests);

   157

    init_waitqueue_head(&slave->foe_queue);

   158

   159

    INIT_LIST_HEAD(&slave->soe_requests);

   160

    init_waitqueue_head(&slave->soe_queue);

   161

   162

    // init datagram

   163

    ec_datagram_init(&slave->datagram);

   164

    snprintf(slave->datagram.name, EC_DATAGRAM_NAME_SIZE,

   165

            "slave%u-fsm", slave->ring_position);

   166

    ret = ec_datagram_prealloc(&slave->datagram, EC_MAX_DATA_SIZE);

   167

    if (ret < 0) {

   168

        ec_datagram_clear(&slave->datagram);

   169

        EC_SLAVE_ERR(slave, "Failed to allocate FSM datagram.\n");

   170

        return;

   171

    }

   172

    ec_mbox_init(&slave->mbox,&slave->datagram);

   173

   174

    // create state machine object

   175

    ec_fsm_slave_init(&slave->fsm, slave, &slave->mbox);

   176

}

   177

   178

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

   179

   180

/**

   181

   Slave destructor.

   182

   Clears and frees a slave object.

   183

*/

   184

   185

void ec_slave_clear(ec_slave_t *slave /**< EtherCAT slave */)

   186

{

   187

    ec_sdo_t *sdo, *next_sdo;

   188

    unsigned int i;

   189

    ec_pdo_t *pdo, *next_pdo;

   190

   191

    // abort all pending requests

   192

   193

    while (!list_empty(&slave->slave_sdo_requests)) {

   194

        ec_master_sdo_request_t *request =

   195

            list_entry(slave->slave_sdo_requests.next,

   196

                ec_master_sdo_request_t, list);

   197

        list_del_init(&request->list); // dequeue

   198

        EC_SLAVE_WARN(slave, "Discarding SDO request %p,"

   199

                " slave about to be deleted.\n",request);

   200

        request->req.state = EC_INT_REQUEST_FAILURE;

   201

        kref_put(&request->refcount,ec_master_sdo_request_release);

   202

        wake_up(&slave->sdo_queue);

   203

    }

   204

   205

    while (!list_empty(&slave->foe_requests)) {

   206

        ec_master_foe_request_t *request =

   207

            list_entry(slave->foe_requests.next,

   208

                ec_master_foe_request_t, list);

   209

        list_del_init(&request->list); // dequeue

   210

        EC_SLAVE_WARN(slave, "Discarding FoE request,"

   211

                " slave about to be deleted.\n");

   212

        request->req.state = EC_INT_REQUEST_FAILURE;

   213

        kref_put(&request->refcount,ec_master_foe_request_release);

   214

        wake_up(&slave->foe_queue);

   215

    }

   216

   217

    while (!list_empty(&slave->soe_requests)) {

   218

        ec_master_soe_request_t *request =

   219

            list_entry(slave->soe_requests.next,

   220

                ec_master_soe_request_t, list);

   221

        list_del_init(&request->list); // dequeue

   222

        EC_SLAVE_WARN(slave, "Discarding SoE request,"

   223

                " slave about to be deleted.\n");

   224

        request->req.state = EC_INT_REQUEST_FAILURE;

   225

        kref_put(&request->refcount,ec_master_soe_request_release);

   226

        wake_up(&slave->soe_queue);

   227

    }

   228

   229

    if (slave->config)

   230

        ec_slave_config_detach(slave->config);

   231

   232

    // free all SDOs

   233

    list_for_each_entry_safe(sdo, next_sdo, &slave->sdo_dictionary, list) {

   234

        list_del(&sdo->list);

   235

        ec_sdo_clear(sdo);

   236

        kfree(sdo);

   237

    }

   238

   239

    // free all strings

   240

    if (slave->sii.strings) {

   241

        for (i = 0; i < slave->sii.string_count; i++)

   242

            kfree(slave->sii.strings[i]);

   243

        kfree(slave->sii.strings);

   244

    }

   245

   246

    // free all sync managers

   247

    ec_slave_clear_sync_managers(slave);

   248

   249

    // free all SII PDOs

   250

    list_for_each_entry_safe(pdo, next_pdo, &slave->sii.pdos, list) {

   251

        list_del(&pdo->list);

   252

        ec_pdo_clear(pdo);

   253

        kfree(pdo);

   254

    }

   255

   256

    if (slave->sii_words)

   257

        kfree(slave->sii_words);

   258

    ec_fsm_slave_clear(&slave->fsm);

   259

    ec_mbox_clear(&slave->mbox);

   260

}

   261

   262

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

   263

   264

/** Clear the sync manager array. 

   265

 */

   266

void ec_slave_clear_sync_managers(ec_slave_t *slave /**< EtherCAT slave. */)

   267

{

   268

    unsigned int i;

   269

   270

    if (slave->sii.syncs) {

   271

        for (i = 0; i < slave->sii.sync_count; i++) {

   272

            ec_sync_clear(&slave->sii.syncs[i]);

   273

        }

   274

        kfree(slave->sii.syncs);

   275

        slave->sii.syncs = NULL;

   276

    }

   277

}

   278

   279

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

   280

   281

/**

   282

 * Sets the application state of a slave.

   283

 */

   284

   285

void ec_slave_set_state(ec_slave_t *slave, /**< EtherCAT slave */

   286

        ec_slave_state_t new_state /**< new application state */

   287

        )

   288

{

   289

    if (new_state != slave->current_state) {

   290

        if (slave->master->debug_level) {

   291

            char old_state[EC_STATE_STRING_SIZE],

   292

                cur_state[EC_STATE_STRING_SIZE];

   293

            ec_state_string(slave->current_state, old_state, 0);

   294

            ec_state_string(new_state, cur_state, 0);

   295

            EC_SLAVE_DBG(slave, 0, "%s -> %s.\n", old_state, cur_state);

   296

        }

   297

        slave->current_state = new_state;

   298

    }

   299

}

   300

   301

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

   302

   303

/**

   304

 * Request a slave state and resets the error flag.

   305

 */

   306

   307

void ec_slave_request_state(ec_slave_t *slave, /**< EtherCAT slave */

   308

                            ec_slave_state_t state /**< new state */

   309

                            )

   310

{

   311

    slave->requested_state = state;

   312

    slave->error_flag = 0;

   313

}

   314

   315

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

   316

   317

/**

   318

   Fetches data from a STRING category.

   319

   \todo range checking

   320

   \return 0 in case of success, else < 0

   321

*/

   322

   323

int ec_slave_fetch_sii_strings(

   324

        ec_slave_t *slave, /**< EtherCAT slave */

   325

        const uint8_t *data, /**< category data */

   326

        size_t data_size /**< number of bytes */

   327

        )

   328

{

   329

    int i, err;

   330

    size_t size;

   331

    off_t offset;

   332

   333

    slave->sii.string_count = data[0];

   334

   335

    if (slave->sii.string_count) {

   336

        if (!(slave->sii.strings =

   337

                    kmalloc(sizeof(char *) * slave->sii.string_count,

   338

                        GFP_KERNEL))) {

   339

            EC_SLAVE_ERR(slave, "Failed to allocate string array memory.\n");

   340

            err = -ENOMEM;

   341

            goto out_zero;

   342

        }

   343

   344

        offset = 1;

   345

        for (i = 0; i < slave->sii.string_count; i++) {

   346

            size = data[offset];

   347

            // allocate memory for string structure and data at a single blow

   348

            if (!(slave->sii.strings[i] =

   349

                        kmalloc(sizeof(char) * size + 1, GFP_KERNEL))) {

   350

                EC_SLAVE_ERR(slave, "Failed to allocate string memory.\n");

   351

                err = -ENOMEM;

   352

                goto out_free;

   353

            }

   354

            memcpy(slave->sii.strings[i], data + offset + 1, size);

   355

            slave->sii.strings[i][size] = 0x00; // append binary zero

   356

            offset += 1 + size;

   357

        }

   358

    }

   359

   360

    return 0;

   361

   362

out_free:

   363

    for (i--; i >= 0; i--)

   364

        kfree(slave->sii.strings[i]);

   365

    kfree(slave->sii.strings);

   366

    slave->sii.strings = NULL;

   367

out_zero:

   368

    slave->sii.string_count = 0;

   369

    return err;

   370

}

   371

   372

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

   373

   374

/**

   375

   Fetches data from a GENERAL category.

   376

   \return 0 in case of success, else < 0

   377

*/

   378

   379

int ec_slave_fetch_sii_general(

   380

        ec_slave_t *slave, /**< EtherCAT slave */

   381

        const uint8_t *data, /**< category data */

   382

        size_t data_size /**< size in bytes */

   383

        )

   384

{

   385

    unsigned int i;

   386

    uint8_t flags;

   387

   388

    if (data_size != 32) {

   389

        EC_SLAVE_ERR(slave, "Wrong size of general category (%zu/32).\n",

   390

                data_size);

   391

        return -EINVAL;

   392

    }

   393

   394

    slave->sii.group = ec_slave_sii_string(slave, data[0]);

   395

    slave->sii.image = ec_slave_sii_string(slave, data[1]);

   396

    slave->sii.order = ec_slave_sii_string(slave, data[2]);

   397

    slave->sii.name = ec_slave_sii_string(slave, data[3]);

   398

   399

    for (i = 0; i < 4; i++)

   400

        slave->sii.physical_layer[i] =

   401

            (data[4] & (0x03 << (i * 2))) >> (i * 2);

   402

   403

    // read CoE details

   404

    flags = EC_READ_U8(data + 5);

   405

    slave->sii.coe_details.enable_sdo =                 (flags >> 0) & 0x01;

   406

    slave->sii.coe_details.enable_sdo_info =            (flags >> 1) & 0x01;

   407

    slave->sii.coe_details.enable_pdo_assign =          (flags >> 2) & 0x01;

   408

    slave->sii.coe_details.enable_pdo_configuration =   (flags >> 3) & 0x01;

   409

    slave->sii.coe_details.enable_upload_at_startup =   (flags >> 4) & 0x01;

   410

    slave->sii.coe_details.enable_sdo_complete_access = (flags >> 5) & 0x01;

   411

   412

    // read general flags

   413

    flags = EC_READ_U8(data + 0x000B);

   414

    slave->sii.general_flags.enable_safeop =  (flags >> 0) & 0x01;

   415

    slave->sii.general_flags.enable_not_lrw = (flags >> 1) & 0x01;

   416

   417

    slave->sii.current_on_ebus = EC_READ_S16(data + 0x0C);

   418

    slave->sii.has_general = 1;

   419

    return 0;

   420

}

   421

   422

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

   423

   424

/** Fetches data from a SYNC MANAGER category.

   425

 *

   426

 * Appends the sync managers described in the category to the existing ones.

   427

 *

   428

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

   429

 */

   430

int ec_slave_fetch_sii_syncs(

   431

        ec_slave_t *slave, /**< EtherCAT slave. */

   432

        const uint8_t *data, /**< Category data. */

   433

        size_t data_size /**< Number of bytes. */

   434

        )

   435

{

   436

    unsigned int i, count, total_count;

   437

    ec_sync_t *sync;

   438

    size_t memsize;

   439

    ec_sync_t *syncs;

   440

    uint8_t index;

   441

   442

    // one sync manager struct is 4 words long

   443

    if (data_size % 8) {

   444

        EC_SLAVE_ERR(slave, "Invalid SII sync manager category size %zu.\n",

   445

                data_size);

   446

        return -EINVAL;

   447

    }

   448

   449

    count = data_size / 8;

   450

   451

    if (count) {

   452

        total_count = count + slave->sii.sync_count;

   453

        if (total_count > EC_MAX_SYNC_MANAGERS) {

   454

            EC_SLAVE_ERR(slave, "Exceeded maximum number of"

   455

                    " sync managers!\n");

   456

            return -EOVERFLOW;

   457

        }

   458

        memsize = sizeof(ec_sync_t) * total_count;

   459

        if (!(syncs = kmalloc(memsize, GFP_KERNEL))) {

   460

            EC_SLAVE_ERR(slave, "Failed to allocate %zu bytes"

   461

                    " for sync managers.\n", memsize);

   462

            return -ENOMEM;

   463

        }

   464

   465

        for (i = 0; i < slave->sii.sync_count; i++)

   466

            ec_sync_init_copy(syncs + i, slave->sii.syncs + i);

   467

   468

        // initialize new sync managers

   469

        for (i = 0; i < count; i++, data += 8) {

   470

            index = i + slave->sii.sync_count;

   471

            sync = &syncs[index];

   472

   473

            ec_sync_init(sync, slave);

   474

            sync->physical_start_address = EC_READ_U16(data);

   475

            sync->default_length = EC_READ_U16(data + 2);

   476

            sync->control_register = EC_READ_U8(data + 4);

   477

            sync->enable = EC_READ_U8(data + 6);

   478

        }

   479

   480

        if (slave->sii.syncs)

   481

            kfree(slave->sii.syncs);

   482

        slave->sii.syncs = syncs;

   483

        slave->sii.sync_count = total_count;

   484

    }