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 <libgen.h> // basename()

    31

#include <string.h>

    32

    33

#include <iostream>

    34

#include <iomanip>

    35

#include <fstream>

    36

using namespace std;

    37

    38

#include "CommandFoeWrite.h"

    39

#include "foe.h"

    40

#include "MasterDevice.h"

    41

    42

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

    43

    44

CommandFoeWrite::CommandFoeWrite():

    45

    FoeCommand("foe_write", "Store a file on a slave via FoE.")

    46

{

    47

}

    48

    49

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

    50

    51

string CommandFoeWrite::helpString() const

    52

{

    53

    stringstream str;

    54

    55

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

    56

        << endl

    57

        << getBriefDescription() << endl

    58

        << endl

    59

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

    60

        << endl

    61

        << "Arguments:" << endl

    62

        << "  FILENAME can either be a path to a file, or '-'. In" << endl

    63

        << "           the latter case, data are read from stdin and" << endl

    64

        << "           the --output-file option has to be specified." << endl

    65

        << endl

    66

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

    67

        << "  --output-file -o <file>   Target filename on the slave." << endl

    68

        << "                            If the FILENAME argument is" << endl

    69

        << "                            '-', this is mandatory." << endl

    70

        << "                            Otherwise, the basename() of" << endl

    71

        << "                            FILENAME is used by default." << endl

    72

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

    73

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

    74

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

    75

        << endl

    76

        << numericInfo();

    77

    78

    return str.str();

    79

}

    80

    81

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

    82

    83

void CommandFoeWrite::execute(const StringVector &args)

    84

{

    85

    stringstream err;

    86

    ec_ioctl_slave_foe_t data;

    87

    ifstream file;

    88

    SlaveList slaves;

    89

    string storeFileName;

    90

    91

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

    92

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

    93

        throwInvalidUsageException(err);

    94

    }

    95

    96

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

    97

        loadFoeData(&data, cin);

    98

        if (getOutputFile().empty()) {

    99

            err << "Please specify a filename for the slave side"

   100

                << " with --output-file!";

   101

            throwCommandException(err);

   102

        } else {

   103

            storeFileName = getOutputFile();

   104

        }

   105

    } else {

   106

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

   107

        if (file.fail()) {

   108

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

   109

            throwCommandException(err);

   110

        }

   111

        loadFoeData(&data, file);

   112

        file.close();

   113

        if (getOutputFile().empty()) {

   114

            char *cpy = strdup(args[0].c_str()); // basename can modify

   115

                                                 // the string contents

   116

            storeFileName = basename(cpy);

   117

            free(cpy);

   118

        } else {

   119

            storeFileName = getOutputFile();

   120

        }

   121

    }

   122

   123

    MasterDevice m(getSingleMasterIndex());

   124

    try {

   125

        m.open(MasterDevice::ReadWrite);

   126

    } catch (MasterDeviceException &e) {

   127

        if (data.buffer_size)

   128

            delete [] data.buffer;

   129

        throw e;

   130

    }

   131

   132

    slaves = selectedSlaves(m);

   133

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

   134

        if (data.buffer_size)

   135

            delete [] data.buffer;

   136

        throwSingleSlaveRequired(slaves.size());

   137

    }

   138

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

   139

   140

    // write data via foe to the slave

   141

    data.offset = 0;

   142

    strncpy(data.file_name, storeFileName.c_str(), sizeof(data.file_name));

   143

   144

    try {

   145

        m.writeFoe(&data);

   146

    } catch (MasterDeviceException &e) {

   147

        if (data.buffer_size)

   148

            delete [] data.buffer;

   149

        if (data.result) {

   150

            if (data.result == FOE_OPCODE_ERROR) {

   151

                err << "FoE write aborted with error code 0x"

   152

                    << setw(8) << setfill('0') << hex << data.error_code

   153

                    << ": " << errorText(data.error_code);

   154

            } else {

   155

                err << "Failed to write via FoE: "

   156

                    << resultText(data.result);

   157

            }

   158

            throwCommandException(err);

   159

        } else {

   160

            throw e;

   161

        }

   162

    }

   163

   164

    if (getVerbosity() == Verbose) {

   165

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

   166

    }

   167

   168

    if (data.buffer_size)

   169

        delete [] data.buffer;

   170

}

   171

   172

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

   173

   174

void CommandFoeWrite::loadFoeData(

   175

        ec_ioctl_slave_foe_t *data,

   176

        const istream &in

   177

        )

   178

{

   179

    stringstream err;

   180

    ostringstream tmp;

   181

   182

    tmp << in.rdbuf();

   183

    string const &contents = tmp.str();

   184

   185

    if (getVerbosity() == Verbose) {

   186

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

   187

    }

   188

   189

    data->buffer_size = contents.size();

   190

   191

    if (data->buffer_size) {

   192

        // allocate buffer and read file into buffer

   193

        data->buffer = new uint8_t[data->buffer_size];

   194

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

   195

    }

   196

}

   197

   198

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