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.

     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

#include <iostream>

    31

#include <iomanip>

    32

#include <list>

    33

#include <string.h>

    34

using namespace std;

    35

    36

#include "CommandSlaves.h"

    37

    38

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

    39

    40

CommandSlaves::CommandSlaves():

    41

    Command("slaves", "Display slaves on the bus.")

    42

{

    43

}

    44

    45

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

    46

    47

string CommandSlaves::helpString() const

    48

{

    49

    stringstream str;

    50

    51

    str << getName() << " [OPTIONS]" << endl

    52

        << endl

    53

        << getBriefDescription() << endl

    54

        << endl

    55

        << "If the --verbose option is not given, the slaves are" << endl

    56

        << "displayed one-per-line. Example:" << endl

    57

        << endl

    58

        << "1  5555:0  PREOP  +  EL3162 2C. Ana. Input 0-10V" << endl

    59

        << "|  |    |  |      |  |" << endl

    60

        << "|  |    |  |      |  \\- Name from the SII if avaliable," << endl

    61

        << "|  |    |  |      |     otherwise vendor ID and product" << endl

    62

        << "|  |    |  |      |     code (both hexadecimal)." << endl

    63

        << "|  |    |  |      \\- Error flag. '+' means no error," << endl

    64

        << "|  |    |  |         'E' means that scan or" << endl

    65

        << "|  |    |  |         configuration failed." << endl

    66

        << "|  |    |  \\- Current application-layer state." << endl

    67

        << "|  |    \\- Decimal relative position to the last" << endl

    68

        << "|  |       slave with an alias address set." << endl

    69

        << "|  \\- Decimal alias address of this slave (if set)," << endl

    70

        << "|     otherwise of the last slave with an alias set," << endl

    71

        << "|     or zero, if no alias was encountered up to this" << endl

    72

        << "|     position." << endl

    73

        << "\\- Absolute ring position in the bus." << endl

    74

        << endl

    75

        << "If the --verbose option is given, a detailed (multi-line)" << endl

    76

        << "description is output for each slave." << endl

    77

        << endl

    78

        << "Slave selection:" << endl

    79

        << "  Slaves for this and other commands can be selected with" << endl

    80

        << "  the --alias and --position parameters as follows:" << endl

    81

        << endl

    82

        << "  1) If neither the --alias nor the --position option" << endl

    83

        << "     is given, all slaves are selected." << endl

    84

        << "  2) If only the --position option is given, it is" << endl

    85

        << "     interpreted as an absolute ring position and" << endl

    86

        << "     a slave with this position is matched." << endl

    87

        << "  3) If only the --alias option is given, all slaves" << endl

    88

        << "     with the given alias address and subsequent" << endl

    89

        << "     slaves before a slave with a different alias" << endl

    90

        << "     address match (use -p0 if only the slaves" << endl

    91

        << "     with the given alias are desired, see 4))." << endl

    92

        << "  4) If both the --alias and the --position option are" << endl

    93

        << "     given, the latter is interpreted as relative" << endl

    94

        << "     position behind any slave with the given alias." << endl

    95

        << endl

    96

        << "Command-specific options:" << endl

    97

        << "  --alias    -a <alias>  Slave alias (see above)." << endl

    98

        << "  --position -p <pos>    Slave position (see above)." << endl

    99

        << "  --verbose  -v          Show detailed slave information." << endl

   100

        << endl

   101

        << numericInfo();

   102

   103

    return str.str();

   104

}

   105

   106

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

   107

   108

void CommandSlaves::execute(MasterDevice &m, const StringVector &args)

   109

{

   110

    SlaveList slaves;

   111

   112

    m.open(MasterDevice::Read);

   113

    slaves = selectedSlaves(m);

   114

   115

    if (getVerbosity() == Verbose) {

   116

        showSlaves(m, slaves);

   117

    } else {

   118

        listSlaves(m, slaves);

   119

    }

   120

}

   121

   122

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

   123

   124

void CommandSlaves::listSlaves(

   125

        MasterDevice &m,

   126

        const SlaveList &slaves

   127

        )

   128

{

   129

    ec_ioctl_master_t master;

   130

    unsigned int i;

   131

    ec_ioctl_slave_t slave;

   132

    uint16_t lastAlias, aliasIndex;

   133

    Info info;

   134

    typedef list<Info> InfoList;

   135

    InfoList infoList;

   136

    InfoList::const_iterator iter;

   137

    stringstream str;

   138

    unsigned int maxPosWidth = 0, maxAliasWidth = 0,

   139

                 maxRelPosWidth = 0, maxStateWidth = 0;

   140

   141

    m.getMaster(&master);

   142

   143

    lastAlias = 0;

   144

    aliasIndex = 0;

   145

    for (i = 0; i < master.slave_count; i++) {

   146

        m.getSlave(&slave, i);

   147

   148

        if (slave.alias) {

   149

            lastAlias = slave.alias;

   150

            aliasIndex = 0;

   151

        }

   152

   153

        if (slaveInList(slave, slaves)) {

   154

            str << dec << i;

   155

            info.pos = str.str();

   156

            str.clear();

   157

            str.str("");

   158

   159

            str << lastAlias;

   160

            info.alias = str.str();

   161

            str.str("");

   162

   163

            str << aliasIndex;

   164

            info.relPos = str.str();

   165

            str.str("");

   166

   167

            info.state = alStateString(slave.al_state);

   168

            info.flag = (slave.error_flag ? 'E' : '+');

   169

   170

            if (strlen(slave.name)) {

   171

                info.name = slave.name;

   172

            } else {

   173

                str << "0x" << hex << setfill('0')

   174

                    << setw(8) << slave.vendor_id << ":0x"

   175

                    << setw(8) << slave.product_code;

   176

                info.name = str.str();

   177

                str.str("");

   178

            }

   179

   180

   181

            infoList.push_back(info);

   182

   183

            if (info.pos.length() > maxPosWidth)

   184

                maxPosWidth = info.pos.length();

   185

            if (info.alias.length() > maxAliasWidth)

   186

                maxAliasWidth = info.alias.length();

   187

            if (info.relPos.length() > maxRelPosWidth)

   188

                maxRelPosWidth = info.relPos.length();

   189

            if (info.state.length() > maxStateWidth)

   190

                maxStateWidth = info.state.length();

   191

        }

   192

   193

        aliasIndex++;

   194

    }

   195

   196

    for (iter = infoList.begin(); iter != infoList.end(); iter++) {

   197

        cout << setfill(' ') << right

   198

            << setw(maxPosWidth) << iter->pos << "  "

   199

            << setw(maxAliasWidth) << iter->alias

   200

            << ":" << left

   201

            << setw(maxRelPosWidth) << iter->relPos << "  "

   202

            << setw(maxStateWidth) << iter->state << "  "

   203

            << iter->flag << "  "

   204

            << iter->name << endl;

   205

    }

   206

}

   207

   208

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

   209

   210

void CommandSlaves::showSlaves(

   211

        MasterDevice &m,

   212

        const SlaveList &slaves

   213

        )

   214

{

   215

    SlaveList::const_iterator si;

   216

   217

    for (si = slaves.begin(); si != slaves.end(); si++) {

   218

        cout << "=== Slave " << dec << si->position << " ===" << endl;

   219

   220

        if (si->alias)

   221

            cout << "Alias: " << si->alias << endl;

   222

   223

        cout

   224

            << "State: " << alStateString(si->al_state) << endl

   225

            << "Flag: " << (si->error_flag ? 'E' : '+') << endl

   226

            << "Identity:" << endl

   227

            << "  Vendor Id:       0x"

   228

            << hex << setfill('0')

   229

            << setw(8) << si->vendor_id << endl

   230

            << "  Product code:    0x"

   231

            << setw(8) << si->product_code << endl

   232

            << "  Revision number: 0x"

   233

            << setw(8) << si->revision_number << endl

   234

            << "  Serial number:   0x"

   235

            << setw(8) << si->serial_number << endl;

   236

   237

        if (si->mailbox_protocols) {

   238

            list<string> protoList;

   239

            list<string>::const_iterator protoIter;

   240

   241

            cout << "Mailboxes:" << endl

   242

               << "  Bootstrap RX: 0x"

   243

                << hex << setw(4) << si->boot_rx_mailbox_offset << "/"

   244

                << dec << si->boot_rx_mailbox_size

   245

                << ", TX: 0x"

   246

                << hex << setw(4) << si->boot_tx_mailbox_offset << "/"

   247

                << dec << si->boot_tx_mailbox_size << endl

   248

                << "  Standard  RX: 0x"

   249

                << hex << setw(4) << si->std_rx_mailbox_offset << "/"

   250

                << dec << si->std_rx_mailbox_size

   251

                << ", TX: 0x"

   252

                << hex << setw(4) << si->std_tx_mailbox_offset << "/"

   253

                << dec << si->std_tx_mailbox_size << endl

   254

                << "  Supported protocols: ";

   255

   256

            if (si->mailbox_protocols & EC_MBOX_AOE) {

   257

                protoList.push_back("AoE");

   258

            }

   259

            if (si->mailbox_protocols & EC_MBOX_EOE) {

   260

                protoList.push_back("EoE");

   261

            }

   262

            if (si->mailbox_protocols & EC_MBOX_COE) {

   263

                protoList.push_back("CoE");

   264

            }

   265

            if (si->mailbox_protocols & EC_MBOX_FOE) {

   266

                protoList.push_back("FoE");

   267

            }

   268

            if (si->mailbox_protocols & EC_MBOX_SOE) {

   269

                protoList.push_back("SoE");

   270

            }

   271

            if (si->mailbox_protocols & EC_MBOX_VOE) {

   272

                protoList.push_back("VoE");

   273

            }

   274

   275

            for (protoIter = protoList.begin(); protoIter != protoList.end();

   276

                    protoIter++) {

   277

                if (protoIter != protoList.begin())

   278

                    cout << ", ";

   279

                cout << *protoIter;

   280

            }

   281

            cout << endl;

   282

        }

   283

   284

        if (si->has_general_category) {

   285

            cout << "General:" << endl

   286

                << "  Group: " << si->group << endl

   287

                << "  Image name: " << si->image << endl

   288

                << "  Order number: " << si->order << endl

   289

                << "  Device name: " << si->name << endl;

   290

   291

            if (si->mailbox_protocols & EC_MBOX_COE) {

   292

                cout << "  CoE details:" << endl

   293

                    << "    Enable SDO: "

   294

                    << (si->coe_details.enable_sdo ? "yes" : "no") << endl

   295

                    << "    Enable SDO Info: "

   296

                    << (si->coe_details.enable_sdo_info ? "yes" : "no") << endl

   297

                    << "    Enable PDO Assign: "

   298

                    << (si->coe_details.enable_pdo_assign

   299

                            ? "yes" : "no") << endl

   300

                    << "    Enable PDO Configuration: "

   301

                    << (si->coe_details.enable_pdo_configuration

   302

                            ? "yes" : "no") << endl

   303

                    << "    Enable Upload at startup: "

   304

                    << (si->coe_details.enable_upload_at_startup

   305

                            ? "yes" : "no") << endl

   306

                    << "    Enable SDO complete access: "

   307

                    << (si->coe_details.enable_sdo_complete_access

   308

                            ? "yes" : "no") << endl;

   309

            }

   310

   311

            cout << "  Flags:" << endl

   312

                << "    Enable SafeOp: "

   313

                << (si->general_flags.enable_safeop ? "yes" : "no") << endl

   314

                << "    Enable notLRW: "

   315

                << (si->general_flags.enable_not_lrw ? "yes" : "no") << endl

   316

                << "  Current consumption: "

   317

                << dec << si->current_on_ebus << " mA" << endl;

   318

        }

   319

    }

   320

}

   321

   322

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

   323

   324

bool CommandSlaves::slaveInList(

   325

        const ec_ioctl_slave_t &slave,

   326

        const SlaveList &slaves

   327

        )

   328

{

   329

    SlaveList::const_iterator si;

   330

   331

    for (si = slaves.begin(); si != slaves.end(); si++) {

   332

        if (si->position == slave.position) {

   333

            return true;

   334

        }

   335

    }

   336

   337

    return false;

   338

}

   339

   340

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