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

    65

        << "These are the valid data types:" << endl

    66

        << "  int8, int16, int32, int64, uint8, uint16, uint32," << endl

    67

        << "  uint64, string, raw." << endl

    68

        << endl

    69

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

    70

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

    71

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

    72

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

    73

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

    74

        << endl

    75

        << numericInfo();

    76

    77

    return str.str();

    78

}

    79

    80

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

    81

    82

void CommandRegRead::execute(const StringVector &args)

    83

{

    84

    SlaveList slaves;

    85

    ec_ioctl_slave_reg_t data;

    86

    stringstream strOffset, err;

    87

    const DataType *dataType = NULL;

    88

    89

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

    90

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

    91

        throwInvalidUsageException(err);

    92

    }

    93

    94

    strOffset << args[0];

    95

    strOffset

    96

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

    97

        >> data.offset;

    98

    if (strOffset.fail()) {

    99

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

   100

        throwInvalidUsageException(err);

   101

    }

   102

   103

    if (args.size() > 1) {

   104

        stringstream strLength;

   105

        strLength << args[1];

   106

        strLength

   107

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

   108

            >> data.length;

   109

        if (strLength.fail()) {

   110

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

   111

            throwInvalidUsageException(err);

   112

        }

   113

   114

        if (!data.length) {

   115

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

   116

            throwInvalidUsageException(err);

   117

        }

   118

    } else { // no length argument given

   119

        data.length = 0;

   120

    }

   121

   122

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

   123

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

   124

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

   125

            throwInvalidUsageException(err);

   126

        }

   127

   128

        if (dataType->byteSize) {

   129

            // override length argument

   130

            data.length = dataType->byteSize;

   131

        }

   132

    }

   133

   134

    if (!data.length) {

   135

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

   136

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

   137

        throwInvalidUsageException(err);

   138

    }

   139

   140

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

   141

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

   142

        throwInvalidUsageException(err);

   143

    }

   144

   145

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

   146

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

   147

        throwInvalidUsageException(err);

   148

    }

   149

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

   150

    m.open(MasterDevice::Read);

   151

    slaves = selectedSlaves(m);

   152

   153

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

   154

        throwSingleSlaveRequired(slaves.size());

   155

    }

   156

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

   157

   158

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

   159

   160

    try {

   161

        m.readReg(&data);

   162

    } catch (MasterDeviceException &e) {

   163

        delete [] data.data;

   164

        throw e;

   165

    }

   166

   167

    try {

   168

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

   169

    } catch (SizeException &e) {

   170

        delete [] data.data;

   171

        throwCommandException(e.what());

   172

    }

   173

   174

    delete [] data.data;

   175

}

   176

   177

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