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

#include <fstream>

    33

using namespace std;

    34

    35

#include "CommandSiiWrite.h"

    36

#include "sii_crc.h"

    37

#include "MasterDevice.h"

    38

    39

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

    40

    41

CommandSiiWrite::CommandSiiWrite():

    42

    Command("sii_write", "Write SII contents to a slave.")

    43

{

    44

}

    45

    46

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

    47

    48

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

    49

{

    50

    stringstream str;

    51

    52

    str << binaryBaseName << " " << getName()

    53

        << " [OPTIONS] <FILENAME>" << endl

    54

        << endl 

    55

        << getBriefDescription() << endl

    56

        << endl

    57

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

    58

        << endl

    59

        << "The file contents are checked for validity and integrity." << endl

    60

        << "These checks can be overridden with the --force option." << endl

    61

        << endl

    62

        << "Arguments:" << endl

    63

        << "  FILENAME must be a path to a file that contains a" << endl

    64

        << "           positive number of words. If it is '-'," << endl

    65

        << "           data are read from stdin." << 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

        << "  --force    -f          Override validity checks." << endl

    72

        << endl

    73

        << numericInfo();

    74

    75

    return str.str();

    76

}

    77

    78

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

    79

    80

void CommandSiiWrite::execute(const StringVector &args)

    81

{

    82

    stringstream err;

    83

    ec_ioctl_slave_sii_t data;

    84

    ifstream file;

    85

    SlaveList slaves;

    86

    87

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

    88

        err << "'" << getName() << "' takes exactly one argument!";

    89

        throwInvalidUsageException(err);

    90

    }

    91

    92

    if (args[0] == "-") {

    93

        loadSiiData(&data, cin);

    94

    } else {

    95

        file.open(args[0].c_str(), ifstream::in | ifstream::binary);

    96

        if (file.fail()) {

    97

            err << "Failed to open '" << args[0] << "'!";

    98

            throwCommandException(err);

    99

        }

   100

        loadSiiData(&data, file);

   101

        file.close();

   102

    }

   103

   104

    if (!getForce()) {

   105

        try {

   106

            checkSiiData(&data);

   107

        } catch (CommandException &e) {

   108

            delete [] data.words;

   109

            throw e;

   110

        }

   111

    }

   112

   113

    MasterDevice m(getSingleMasterIndex());

   114

    try {

   115

        m.open(MasterDevice::ReadWrite);

   116

    } catch (MasterDeviceException &e) {

   117

        delete [] data.words;

   118

        throw e;

   119

    }

   120

   121

    slaves = selectedSlaves(m);

   122

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

   123

        delete [] data.words;

   124

        throwSingleSlaveRequired(slaves.size());

   125

    }

   126

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

   127

   128

    // send data to master

   129

    data.offset = 0;

   130

    try {

   131

        m.writeSii(&data);

   132

    } catch (MasterDeviceException &e) {

   133

        delete [] data.words;

   134

        throw e;

   135

    }

   136

   137

    if (getVerbosity() == Verbose) {

   138

        cerr << "SII writing finished." << endl;

   139

    }

   140

   141

    delete [] data.words;

   142

}

   143

   144

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

   145

   146

void CommandSiiWrite::loadSiiData(

   147

        ec_ioctl_slave_sii_t *data,

   148

        const istream &in

   149

        )

   150

{

   151

    stringstream err;

   152

    ostringstream tmp;

   153

   154

    tmp << in.rdbuf();

   155

    string const &contents = tmp.str();

   156

   157

    if (getVerbosity() == Verbose) {

   158

        cerr << "Read " << contents.size() << " bytes of SII data." << endl;

   159

    }

   160

   161

    if (!contents.size() || contents.size() % 2) {

   162

        err << "Invalid data size " << contents.size() << "! "

   163

            << "Must be non-zero and even.";

   164

        throwCommandException(err);

   165

    }

   166

    data->nwords = contents.size() / 2;

   167

   168

    // allocate buffer and read file into buffer

   169

    data->words = new uint16_t[data->nwords];

   170

    contents.copy((char *) data->words, contents.size());

   171

}

   172

   173

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

   174

   175

void CommandSiiWrite::checkSiiData(

   176

        const ec_ioctl_slave_sii_t *data

   177

        )

   178

{

   179

    stringstream err;

   180

    const uint16_t *categoryHeader;

   181

    uint16_t categoryType, categorySize;

   182

    uint8_t crc;

   183

   184

    if (data->nwords < 0x0041) {

   185

        err << "SII data too short (" << data->nwords << " words)! Mimimum is"

   186

            " 40 fixed words + 1 delimiter. Use --force to write anyway.";

   187

        throwCommandException(err);

   188

    }

   189

   190

    // calculate checksum over words 0 to 6

   191

    crc = calcSiiCrc((const uint8_t *) data->words, 14);

   192

    if (crc != ((const uint8_t *) data->words)[14]) {

   193

        err << "CRC incorrect. Must be 0x"

   194

            << hex << setfill('0') << setw(2) << (unsigned int) crc

   195

            << ". Use --force to write anyway.";

   196

        throwCommandException(err);

   197

    }

   198

   199

    // cycle through categories to detect corruption

   200

    categoryHeader = data->words + 0x0040U;

   201

    categoryType = le16_to_cpup(categoryHeader);

   202

    while (categoryType != 0xffff) {

   203

        if (categoryHeader + 1 > data->words + data->nwords) {

   204

            err << "SII data seem to be corrupted! "

   205

                << "Use --force to write anyway.";

   206

            throwCommandException(err);

   207

        }

   208

        categorySize = le16_to_cpup(categoryHeader + 1);

   209

        if (categoryHeader + 2 + categorySize + 1

   210

                > data->words + data->nwords) {

   211

            err << "SII data seem to be corrupted! "

   212

                "Use --force to write anyway.";

   213

            throwCommandException(err);

   214

        }

   215

        categoryHeader += 2 + categorySize;

   216

        categoryType = le16_to_cpup(categoryHeader);

   217

    }

   218

}

   219

   220

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