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

#ifndef __MASTER_DEVICE_H__

    31

#define __MASTER_DEVICE_H__

    32

    33

#include <stdexcept>

    34

#include <sstream>

    35

using namespace std;

    36

    37

#include "ecrt.h"

    38

#include "ioctl.h"

    39

    40

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

    41

    42

class MasterDeviceException:

    43

    public runtime_error

    44

{

    45

    friend class MasterDevice;

    46

    47

    protected:

    48

        /** Constructor with string parameter. */

    49

        MasterDeviceException(

    50

                const string &s /**< Message. */

    51

                ): runtime_error(s) {}

    52

    53

        /** Constructor with stringstream parameter. */

    54

        MasterDeviceException(

    55

                const stringstream &s /**< Message. */

    56

                ): runtime_error(s.str()) {}

    57

};

    58

    59

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

    60

    61

class MasterDeviceSdoAbortException:

    62

    public MasterDeviceException

    63

{

    64

    friend class MasterDevice;

    65

    66

    public:

    67

        uint32_t abortCode;

    68

    69

    protected:

    70

        /** Constructor with abort code parameter. */

    71

        MasterDeviceSdoAbortException(uint32_t code):

    72

            MasterDeviceException("SDO transfer aborted.") {

    73

                abortCode = code;

    74

            };

    75

};

    76

    77

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

    78

    79

class MasterDeviceSoeException:

    80

    public MasterDeviceException

    81

{

    82

    friend class MasterDevice;

    83

    84

    public:

    85

        uint16_t errorCode;

    86

    87

    protected:

    88

        /** Constructor with error code parameter. */

    89

        MasterDeviceSoeException(uint16_t code):

    90

            MasterDeviceException("SoE transfer aborted.") {

    91

                errorCode = code;

    92

            };

    93

};

    94

    95

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

    96

    97

class MasterDeviceEoeException:

    98

    public MasterDeviceException

    99

{

   100

    friend class MasterDevice;

   101

   102

    public:

   103

        uint16_t result;

   104

   105

    protected:

   106

        /** Constructor with error code parameter. */

   107

        MasterDeviceEoeException(uint16_t result):

   108

            MasterDeviceException("EoE set IP parameter failed."),

   109

            result(result) {};

   110

};

   111

   112

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

   113

   114

class MasterDevice

   115

{

   116

    public:

   117

        MasterDevice(unsigned int = 0U);

   118

        ~MasterDevice();

   119

   120

        void setIndex(unsigned int);

   121

        unsigned int getIndex() const;

   122

   123

        enum Permissions {Read, ReadWrite};

   124

        void open(Permissions);

   125

        void close();

   126

   127

        void getModule(ec_ioctl_module_t *);

   128

   129

        void getMaster(ec_ioctl_master_t *);

   130

        void getConfig(ec_ioctl_config_t *, unsigned int);

   131

        void getConfigPdo(ec_ioctl_config_pdo_t *, unsigned int, uint8_t,

   132

                uint16_t);

   133

        void getConfigPdoEntry(ec_ioctl_config_pdo_entry_t *, unsigned int,

   134

                uint8_t, uint16_t, uint8_t);

   135

        void getConfigSdo(ec_ioctl_config_sdo_t *, unsigned int, unsigned int);

   136

        void getConfigIdn(ec_ioctl_config_idn_t *, unsigned int, unsigned int);

   137

        void getDomain(ec_ioctl_domain_t *, unsigned int);

   138

        void getFmmu(ec_ioctl_domain_fmmu_t *, unsigned int, unsigned int);

   139

        void getData(ec_ioctl_domain_data_t *, unsigned int, unsigned int,

   140

                unsigned char *);

   141

        void getSlave(ec_ioctl_slave_t *, uint16_t);

   142

        void getSync(ec_ioctl_slave_sync_t *, uint16_t, uint8_t);

   143

        void getPdo(ec_ioctl_slave_sync_pdo_t *, uint16_t, uint8_t, uint8_t);

   144

        void getPdoEntry(ec_ioctl_slave_sync_pdo_entry_t *, uint16_t, uint8_t,

   145

                uint8_t, uint8_t);

   146

        void getSdo(ec_ioctl_slave_sdo_t *, uint16_t, uint16_t);

   147

        void getSdoEntry(ec_ioctl_slave_sdo_entry_t *, uint16_t, int, uint8_t);

   148

        void readSii(ec_ioctl_slave_sii_t *);

   149

        void writeSii(ec_ioctl_slave_sii_t *);

   150

        void readReg(ec_ioctl_slave_reg_t *);

   151

        void writeReg(ec_ioctl_slave_reg_t *);

   152

        void setDebug(unsigned int);

   153

        void rescan();

   154

        void sdoDownload(ec_ioctl_slave_sdo_download_t *);

   155

        void sdoUpload(ec_ioctl_slave_sdo_upload_t *);

   156

        void requestState(uint16_t, uint8_t);

   157

        void readFoe(ec_ioctl_slave_foe_t *);

   158

        void writeFoe(ec_ioctl_slave_foe_t *);

   159

#ifdef EC_EOE

   160

        void getEoeHandler(ec_ioctl_eoe_handler_t *, uint16_t);

   161

#endif

   162

        void readSoe(ec_ioctl_slave_soe_read_t *);

   163

        void writeSoe(ec_ioctl_slave_soe_write_t *);

   164

        void setIpParam(ec_ioctl_slave_eoe_ip_t *);

   165

   166

        unsigned int getMasterCount() const {return masterCount;}

   167

   168

    private:

   169

        unsigned int index;

   170

        unsigned int masterCount;

   171

        int fd;

   172

};

   173

   174

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

   175

   176

inline unsigned int MasterDevice::getIndex() const

   177

{

   178

    return index;

   179

}

   180

   181

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

   182

   183

#endif