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

using namespace std;

    33

    34

#include "CommandSdos.h"

    35

#include "MasterDevice.h"

    36

    37

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

    38

    39

CommandSdos::CommandSdos():

    40

    SdoCommand("sdos", "List SDO dictionaries.")

    41

{

    42

}

    43

    44

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

    45

    46

string CommandSdos::helpString(const string &binaryBaseName) const

    47

{

    48

    stringstream str;

    49

    50

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

    51

        << endl

    52

        << getBriefDescription() << endl

    53

        << endl

    54

        << "SDO dictionary information is displayed in two layers," << endl

    55

        << "which are indented accordingly:" << endl

    56

        << endl

    57

        << "1) SDOs - Hexadecimal SDO index and the name. Example:" << endl

    58

        << endl

    59

        << "   SDO 0x1018, \"Identity object\"" << endl

    60

        << endl

    61

        << "2) SDO entries - SDO index and SDO entry subindex (both" << endl

    62

        << "   hexadecimal) followed by the access rights (see" << endl

    63

        << "   below), the data type, the length in bit, and the" << endl

    64

        << "   description. Example:" << endl

    65

        << endl

    66

        << "   0x1018:01, rwrwrw, uint32, 32 bit, \"Vendor id\"" << endl

    67

        << endl

    68

        << "The access rights are specified for the AL states PREOP," << endl

    69

        << "SAFEOP and OP. An 'r' means, that the entry is readable" << endl

    70

        << "in the corresponding state, an 'w' means writable," << endl

    71

        << "respectively. If a right is not granted, a dash '-' is" << endl

    72

        << "shown." << endl

    73

        << endl

    74

        << "If the --quiet option is given, only the SDOs are output."

    75

        << endl << endl

    76

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

    77

        << "  --alias    -a <alias>" << endl

    78

        << "  --position -p <pos>    Slave selection. See the help of" << endl

    79

        << "                         the 'slaves' command." << endl

    80

        << "  --quiet    -q          Only output SDOs (without the" << endl

    81

        << "                         SDO entries)." << endl

    82

        << endl

    83

        << numericInfo();

    84

    85

    return str.str();

    86

}

    87

    88

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

    89

    90

void CommandSdos::execute(const StringVector &args)

    91

{

    92

	MasterIndexList masterIndices;

    93

    SlaveList slaves;

    94

    SlaveList::const_iterator si;

    95

    bool showHeader, multiMaster;

    96

    97

    if (args.size()) {

    98

        stringstream err;

    99

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

   100

        throwInvalidUsageException(err);

   101

    }

   102

   103

	masterIndices = getMasterIndices();

   104

    multiMaster = masterIndices.size() > 1;

   105

    MasterIndexList::const_iterator mi;

   106

    for (mi = masterIndices.begin();

   107

            mi != masterIndices.end(); mi++) {

   108

        MasterDevice m(*mi);

   109

        m.open(MasterDevice::Read);

   110

        slaves = selectedSlaves(m);

   111

        showHeader = multiMaster || slaves.size() > 1;

   112

   113

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

   114

            listSlaveSdos(m, *si, showHeader);

   115

        }

   116

    }

   117

}

   118

   119

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

   120

   121

void CommandSdos::listSlaveSdos(

   122

        MasterDevice &m,

   123

        const ec_ioctl_slave_t &slave,

   124

        bool showHeader

   125

        )

   126

{

   127

    ec_ioctl_slave_sdo_t sdo;

   128

    ec_ioctl_slave_sdo_entry_t entry;

   129

    unsigned int i, j;

   130

    const DataType *d;

   131

   132

    if (showHeader && slave.sdo_count)

   133

        cout << "=== Master " << m.getIndex()

   134

            << ", Slave " << slave.position << " ===" << endl;

   135

   136

    for (i = 0; i < slave.sdo_count; i++) {

   137

        m.getSdo(&sdo, slave.position, i);

   138

   139

        cout << "SDO 0x"

   140

            << hex << setfill('0')

   141

            << setw(4) << sdo.sdo_index

   142

            << ", \"" << sdo.name << "\"" << endl;

   143

   144

        if (getVerbosity() == Quiet)

   145

            continue;

   146

   147

        for (j = 0; j <= sdo.max_subindex; j++) {

   148

            m.getSdoEntry(&entry, slave.position, -i, j);

   149

   150

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

   151

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

   152

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

   153

                << ", "

   154

                << (entry.read_access[EC_SDO_ENTRY_ACCESS_PREOP] ? "r" : "-")

   155

                << (entry.write_access[EC_SDO_ENTRY_ACCESS_PREOP] ? "w" : "-")

   156

                << (entry.read_access[EC_SDO_ENTRY_ACCESS_SAFEOP] ? "r" : "-")

   157

                << (entry.write_access[EC_SDO_ENTRY_ACCESS_SAFEOP] ? "w" : "-")

   158

                << (entry.read_access[EC_SDO_ENTRY_ACCESS_OP] ? "r" : "-")

   159

                << (entry.write_access[EC_SDO_ENTRY_ACCESS_OP] ? "w" : "-")

   160

                << ", ";

   161

   162

            if ((d = findDataType(entry.data_type))) {

   163

                cout << d->name;

   164

            } else {

   165

                cout << "type " << setw(4) << entry.data_type;

   166

            }

   167

   168

            cout << ", " << dec << entry.bit_length << " bit, \""

   169

                << entry.description << "\"" << endl;

   170

        }

   171

    }

   172

}

   173

   174

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