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 <list>

    31

#include <iostream>

    32

#include <iomanip>

    33

#include <sstream>

    34

using namespace std;

    35

    36

#include "CommandConfig.h"

    37

    38

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

    39

    40

CommandConfig::CommandConfig():

    41

    Command("config", "Show slave configurations.")

    42

{

    43

}

    44

    45

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

    46

    47

string CommandConfig::helpString() const

    48

{

    49

    stringstream str;

    50

    51

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

    52

        << endl

    53

        << getBriefDescription() << endl

    54

        << endl

    55

        << "Without the --verbose option, slave configurations are" << endl

    56

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

    57

        << endl

    58

        << "1001:0  0x0000003b/0x02010000  3  OP" << endl

    59

        << "|       |                      |  |" << endl

    60

        << "|       |                      |  \\- Application-layer" << endl

    61

        << "|       |                      |     state of the attached" << endl

    62

        << "|       |                      |     slave, or '-', if no" << endl

    63

        << "|       |                      |     slave is attached." << endl

    64

        << "|       |                      \\- Absolute decimal ring" << endl

    65

        << "|       |                         position of the attached" << endl

    66

        << "|       |                         slave, or '-' if none" << endl

    67

        << "|       |                         attached." << endl

    68

        << "|       \\- Expected vendor ID and product code (both" << endl

    69

        << "|          hexadecimal)." << endl

    70

        << "\\- Alias address and relative position (both decimal)." << endl

    71

        << endl

    72

        << "With the --verbose option given, the configured PDOs and" << endl

    73

        << "SDOs are output in addition." << endl

    74

        << endl

    75

        << "Configuration selection:" << endl

    76

        << "  Slave configurations can be selected with" << endl

    77

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

    78

        << endl

    79

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

    80

        << "     is given, all slave configurations are displayed." << endl

    81

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

    82

        << "     of zero is assumed (see 4))." << endl

    83

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

    84

        << "     configurations with the given alias address" << endl

    85

        << "     are displayed." << endl

    86

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

    87

        << "     given, the selection can match a single" << endl

    88

        << "     configuration, that is displayed, if it exists." << endl

    89

        << endl

    90

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

    91

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

    92

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

    93

        << "  --verbose  -v          Show detailed configurations." << endl

    94

        << endl

    95

        << numericInfo();

    96

    97

    return str.str();

    98

}

    99

   100

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

   101

   102

/** Lists the bus configuration.

   103

 */

   104

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

   105

{

   106

    ConfigList configs;

   107

   108

    if (args.size()) {

   109

        stringstream err;

   110

        err << "'" << getName() << "' takes no arguments!";

   111

        throwInvalidUsageException(err);

   112

    }

   113

   114

    m.open(MasterDevice::Read);

   115

    configs = selectedConfigs(m);

   116

   117

    if (getVerbosity() == Verbose) {

   118

        showDetailedConfigs(m, configs);

   119

    } else {

   120

        listConfigs(m, configs);

   121

    }

   122

}

   123

   124

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

   125

   126

/** Lists the complete bus configuration.

   127

 */

   128

void CommandConfig::showDetailedConfigs(

   129

        MasterDevice &m,

   130

        const ConfigList &configList

   131

        )

   132

{

   133

    ConfigList::const_iterator configIter;

   134

    unsigned int i, j, k, l;

   135

    ec_ioctl_slave_t slave;

   136

    ec_ioctl_config_pdo_t pdo;

   137

    ec_ioctl_config_pdo_entry_t entry;

   138

    ec_ioctl_config_sdo_t sdo;

   139

   140

    for (configIter = configList.begin();

   141

            configIter != configList.end();

   142

            configIter++) {

   143

   144

        cout << "Alias: "

   145

            << dec << configIter->alias << endl

   146

            << "Position: " << configIter->position << endl

   147

            << "Vendor Id: 0x"

   148

            << hex << setfill('0')

   149

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

   150

            << "Product code: 0x"

   151

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

   152

            << "Attached slave: ";

   153

   154

        if (configIter->slave_position != -1) {

   155

            m.getSlave(&slave, configIter->slave_position);

   156

            cout << dec << configIter->slave_position

   157

                << " (" << alStateString(slave.al_state) << ")" << endl;

   158

        } else {

   159

            cout << "none" << endl;

   160

        }

   161

   162

        cout << "Watchdog divider: ";

   163

        if (configIter->watchdog_divider) {

   164

            cout << dec << configIter->watchdog_divider;

   165

        } else {

   166

            cout << "(Default)";

   167

        }

   168

        cout << endl

   169

            << "Watchdog intervals: ";

   170

        if (configIter->watchdog_intervals) {

   171

            cout << dec << configIter->watchdog_intervals;

   172

        } else {

   173

            cout << "(Default)";

   174

        }

   175

        cout << endl;

   176

   177

        for (j = 0; j < EC_MAX_SYNC_MANAGERS; j++) {

   178

            if (configIter->syncs[j].pdo_count) {

   179

                cout << "SM" << dec << j << ", Dir: "

   180

                    << (configIter->syncs[j].dir == EC_DIR_INPUT

   181

                            ? "Input" : "Output") << ", Watchdog: ";

   182

                switch (configIter->syncs[j].watchdog_mode) {

   183

                    case EC_WD_DEFAULT: cout << "Default"; break;

   184

                    case EC_WD_ENABLE: cout << "Enable"; break;

   185

                    case EC_WD_DISABLE: cout << "Disable"; break;

   186

                    default: cout << "???"; break;

   187

                }

   188

                cout << endl;

   189

   190

                for (k = 0; k < configIter->syncs[j].pdo_count; k++) {

   191

                    m.getConfigPdo(&pdo, configIter->config_index, j, k);

   192

   193

                    cout << "  PDO 0x" << hex << setfill('0')

   194

                        << setw(4) << pdo.index << endl;

   195

   196

                    for (l = 0; l < pdo.entry_count; l++) {

   197

                        m.getConfigPdoEntry(&entry,

   198

                                configIter->config_index, j, k, l);

   199

   200

                        cout << "    PDO entry 0x" << hex << setfill('0')

   201

                            << setw(4) << entry.index << ":"

   202

                            << setw(2) << (unsigned int) entry.subindex

   203

                            << ", " << dec << setfill(' ')

   204

                            << setw(2) << (unsigned int) entry.bit_length

   205

                            << " bit" << endl;

   206

                    }

   207

                }

   208

            }

   209

        }

   210

   211

        cout << "SDO configuration:" << endl;

   212

        if (configIter->sdo_count) {

   213

            for (j = 0; j < configIter->sdo_count; j++) {

   214

                m.getConfigSdo(&sdo, configIter->config_index, j);

   215

   216

                cout << "  0x"

   217

                    << hex << setfill('0')

   218

                    << setw(4) << sdo.index << ":"

   219

                    << setw(2) << (unsigned int) sdo.subindex

   220

                    << ", " << dec << sdo.size << " byte" << endl;

   221

   222

                cout << "    " << hex;

   223

                for (i = 0; i < min((uint32_t) sdo.size,

   224

                            (uint32_t) EC_MAX_SDO_DATA_SIZE); i++) {

   225

                    cout << setw(2) << (unsigned int) sdo.data[i];

   226

                    if ((i + 1) % 16 == 0 && i < sdo.size - 1) {

   227

                        cout << endl << "    ";

   228

                    } else {

   229

                        cout << " ";

   230

                    }

   231

                }

   232

   233

                cout << endl;

   234

                if (sdo.size > EC_MAX_SDO_DATA_SIZE) {

   235

                    cout << "    ..." << endl;

   236

                }

   237

            }

   238

        } else {

   239

            cout << "  None." << endl;

   240

        }

   241

   242

        if (configIter->dc_assign_activate) {

   243

            int i;

   244

   245

            cout << "DC configuration:" << endl

   246

                << "  AssignActivate: 0x" << hex << setfill('0')

   247

                << setw(4) << configIter->dc_assign_activate << endl;

   248

   249

            cout << "         Cycle [ns]   Shift [ns]" << endl;

   250

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

   251

                cout << "  SYNC" << dec << i << "  "

   252

                    << setfill(' ') << right

   253

                    << setw(11) << configIter->dc_sync[i].cycle_time

   254

                    << "  "

   255

                    << setw(11) << configIter->dc_sync[i].shift_time

   256

                    << endl;

   257

            }

   258

        }

   259

        cout << endl;

   260

    }

   261

}

   262

   263

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

   264

   265

/** Lists the bus configuration.

   266

 */

   267

void CommandConfig::listConfigs(

   268

        MasterDevice &m,

   269

        const ConfigList &configList

   270

        )

   271

{

   272

    ConfigList::const_iterator configIter;

   273

    stringstream str;

   274

    Info info;

   275

    typedef list<Info> InfoList;

   276

    InfoList list;

   277

    InfoList::const_iterator iter;

   278

    unsigned int maxAliasWidth = 0, maxPosWidth = 0,

   279

                 maxSlavePosWidth = 0, maxStateWidth = 0;

   280

    ec_ioctl_slave_t slave;

   281

   282

    for (configIter = configList.begin();

   283

            configIter != configList.end();

   284

            configIter++) {

   285

   286

        str << dec << configIter->alias;

   287

        info.alias = str.str();

   288

        str.clear();

   289

        str.str("");

   290

   291

        str << configIter->position;

   292

        info.pos = str.str();

   293

        str.clear();

   294

        str.str("");

   295

   296

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

   297

            << "0x" << setw(8) << configIter->vendor_id

   298

            << "/0x" << setw(8) << configIter->product_code;

   299

        info.ident = str.str();

   300

        str.clear();

   301

        str.str("");

   302

   303

        if (configIter->slave_position != -1) {

   304

            m.getSlave(&slave, configIter->slave_position);

   305

   306

            str << dec << configIter->slave_position;

   307

            info.slavePos = str.str();

   308

            str.clear();

   309

            str.str("");

   310

   311

            str << alStateString(slave.al_state);

   312

            info.state = str.str();

   313

            str.clear();

   314

            str.str("");

   315

        } else {

   316

            str << "-";

   317

            info.slavePos = str.str();

   318

            str.clear();

   319

            str.str("");

   320

   321

            str << "-";

   322

            info.state = str.str();

   323

            str.clear();

   324

            str.str("");

   325

        }

   326

   327

        list.push_back(info);

   328

   329

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

   330

            maxAliasWidth = info.alias.length();

   331

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

   332

            maxPosWidth = info.pos.length();

   333

        if (info.slavePos.length() > maxSlavePosWidth)

   334

            maxSlavePosWidth = info.slavePos.length();

   335

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

   336

            maxStateWidth = info.state.length();

   337

    }

   338

   339

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

   340

        cout << setfill(' ') << right

   341

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

   342

            << ":" << left

   343

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

   344

            << "  "

   345

            << iter->ident

   346

            << "  "

   347

            << setw(maxSlavePosWidth) << iter->slavePos << "  "

   348

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

   349

            << endl;

   350

    }

   351

}

   352

   353

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