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 "CommandRegRead.h"

    35

#include "MasterDevice.h"

    36

    37

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

    38

    39

CommandRegRead::CommandRegRead():

    40

    Command("reg_read", "Output a slave's register contents.")

    41

{

    42

}

    43

    44

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

    45

    46

string CommandRegRead::helpString() const

    47

{

    48

    stringstream str;

    49

    50

    str << getName() << " [OPTIONS] <OFFSET> [LENGTH]" << endl

    51

        << endl

    52

        << getBriefDescription() << endl

    53

        << endl

    54

        << "This command requires a single slave to be selected." << endl

    55

        << endl

    56

        << "Arguments:" << endl

    57

        << "  OFFSET is the register address. Must" << endl

    58

        << "         be an unsigned 16 bit number." << endl

    59

        << "  LENGTH is the number of bytes to read and must also be" << endl

    60

        << "         an unsigned 16 bit number. OFFSET plus LENGTH" << endl

    61

        << "         may not exceed 64k. The length is ignored (and" << endl

    62

        << "         can be omitted), if a selected data type" << endl

    63

        << "         implies a length." << endl

    64

        << endl

    66

        << endl

    67

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

    68

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

    69

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

    70

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

    71

        << "  --type     -t <type>   Data type (see above)." << endl

    72

        << endl

    73

        << numericInfo();

    74

    75

    return str.str();

    76

}

    77

    78

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

    79

    80

void CommandRegRead::execute(const StringVector &args)

    81

{

    82

    SlaveList slaves;

    83

    ec_ioctl_slave_reg_t data;

    84

    stringstream strOffset, err;

    85

    const DataType *dataType = NULL;

    86

    87

    if (args.size() < 1 || args.size() > 2) {

    88

        err << "'" << getName() << "' takes one or two arguments!";

    89

        throwInvalidUsageException(err);

    90

    }

    91

    92

    strOffset << args[0];

    93

    strOffset

    94

        >> resetiosflags(ios::basefield) // guess base from prefix

    95

        >> data.offset;

    96

    if (strOffset.fail()) {

    97

        err << "Invalid offset '" << args[0] << "'!";

    98

        throwInvalidUsageException(err);

    99

    }

   100

   101

    if (args.size() > 1) {

   102

        stringstream strLength;

   103

        strLength << args[1];

   104

        strLength

   105

            >> resetiosflags(ios::basefield) // guess base from prefix

   106

            >> data.length;

   107

        if (strLength.fail()) {

   108

            err << "Invalid length '" << args[1] << "'!";

   109

            throwInvalidUsageException(err);

   110

        }

   111

   112

        if (!data.length) {

   113

            err << "Length may not be zero!";

   114

            throwInvalidUsageException(err);

   115

        }

   116

    } else { // no length argument given

   117

        data.length = 0;

   118

    }

   119

   120

    if (!getDataType().empty()) {

   121

        if (!(dataType = findDataType(getDataType()))) {

   122

            err << "Invalid data type '" << getDataType() << "'!";

   123

            throwInvalidUsageException(err);

   124

        }

   125

   126

        if (dataType->byteSize) {

   127

            // override length argument

   128

            data.length = dataType->byteSize;

   129

        }

   130

    }

   131

   132

    if (!data.length) {

   133

        err << "The length argument is mandatory, if no datatype is " << endl

   134

            << "specified, or the datatype does not imply a length!";

   135

        throwInvalidUsageException(err);

   136

    }

   137

   138

    if ((uint32_t) data.offset + data.length > 0xffff) {

   139

        err << "Offset and length exceeding 64k!";

   140

        throwInvalidUsageException(err);

   141

    }

   142

   143

    if (getMasterIndices().size() != 1) {

   144

        err << getName() << " requires to select a single master!";

   145

        throwInvalidUsageException(err);

   146

    }

   147

    MasterDevice m(getMasterIndices().front());

   148

    m.open(MasterDevice::Read);

   149

    slaves = selectedSlaves(m);

   150

   151

    if (slaves.size() != 1) {

   152

        throwSingleSlaveRequired(slaves.size());

   153

    }

   154

    data.slave_position = slaves.front().position;

   155

   156

    data.data = new uint8_t[data.length];

   157

   158

    try {

   159

        m.readReg(&data);

   160

    } catch (MasterDeviceException &e) {

   161

        delete [] data.data;

   162

        throw e;

   163

    }

   164

   165

    try {

   166

        outputData(cout, dataType, data.data, data.length);

   167

    } catch (SizeException &e) {

   168

        delete [] data.data;

   169

        throwCommandException(e.what());

   170

    }

   171

   172

    delete [] data.data;

   173

}

   174

   175

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