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

    36

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

    37

    38

CommandSdos::CommandSdos():

    39

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

    40

{

    41

}

    42

    43

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

    44

    45

string CommandSdos::helpString() const

    46

{

    47

    stringstream str;

    48

    49

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

    50

    	<< endl

    51

    	<< getBriefDescription() << endl

    52

    	<< endl

    53

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

    54

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

    55

    	<< endl

    56

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

    57

    	<< endl

    58

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

    59

    	<< endl

    60

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

    61

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

    62

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

    63

        << "   description. Example:" << endl

    64

    	<< endl

    65

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

    66

    	<< endl

    67

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

    68

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

    69

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

    70

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

    71

        << "shown." << endl

    72

        << endl

    73

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

    74

		<< endl << endl

    75

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

    76

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

    77

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

    78

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

    79

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

    80

		<< "                         SDO entries)." << endl

    81

    	<< endl

    82

		<< numericInfo();

    83

    84

	return str.str();

    85

}

    86

    87

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

    88

    89

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

    90

{

    91

    SlaveList slaves;

    92

    SlaveList::const_iterator si;

    93

    bool showHeader;

    94

    95

    if (args.size()) {

    96

        stringstream err;

    97

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

    98

        throwInvalidUsageException(err);

    99

    }

   100

   101

    m.open(MasterDevice::Read);

   102

    slaves = selectedSlaves(m);

   103

    showHeader = slaves.size() > 1;

   104

   105

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

   106

        listSlaveSdos(m, *si, showHeader);

   107

    }

   108

}

   109

   110

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

   111

   112

void CommandSdos::listSlaveSdos(

   113

		MasterDevice &m,

   114

        const ec_ioctl_slave_t &slave,

   115

		bool showHeader

   116

		)

   117

{

   118

    ec_ioctl_slave_sdo_t sdo;

   119

    ec_ioctl_slave_sdo_entry_t entry;

   120

    unsigned int i, j;

   121

    const DataType *d;

   122

   123

    if (showHeader)

   124

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

   125

   126

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

   127

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

   128

   129

        cout << "SDO 0x"

   130

            << hex << setfill('0')

   131

            << setw(4) << sdo.sdo_index

   132

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

   133

   134

        if (getVerbosity() == Quiet)

   135

            continue;

   136

   137

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

   138

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

   139

   140

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

   141

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

   142

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

   143

                << ", "

   144

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

   145

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

   146

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

   147

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

   148

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

   149

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

   150

                << ", ";

   151

   152

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

   153

                cout << d->name;

   154

            } else {

   155

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

   156

            }

   157

   158

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

   159

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

   160

        }

   161

    }

   162

}

   163

   164

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