1

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

     2

 *

     3

 *  $Id$

     4

 *

     5

 *  Copyright (C) 2006  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

    10

 *  and/or modify it under the terms of the GNU General Public License

    11

 *  as published by the Free Software Foundation; either version 2 of the

    12

 *  License, or (at your option) any later version.

    13

 *

    14

 *  The IgH EtherCAT Master is distributed in the hope that it will be

    15

 *  useful, but WITHOUT ANY WARRANTY; without even the implied warranty of

    16

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    17

 *  GNU General Public License for more details.

    18

 *

    19

 *  You should have received a copy of the GNU General Public License

    20

 *  along with the IgH EtherCAT Master; if not, write to the Free Software

    21

 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

    22

 *

    23

 *  The right to use EtherCAT Technology is granted and comes free of

    24

 *  charge under condition of compatibility of product made by

    25

 *  Licensee. People intending to distribute/sell products based on the

    26

 *  code, have to sign an agreement to guarantee that products using

    27

 *  software based on IgH EtherCAT master stay compatible with the actual

    28

 *  EtherCAT specification (which are released themselves as an open

    29

 *  standard) as the (only) precondition to have the right to use EtherCAT

    30

 *  Technology, IP and trade marks.

    31

 *

    32

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

    33

    34

/**

    35

   \file

    36

   EtherCAT master character device IOCTL commands.

    37

*/

    38

    39

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

    40

    41

#ifndef __EC_IOCTL_H__

    42

#define __EC_IOCTL_H__

    43

    44

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

    45

    46

enum {

    47

    EC_IOCTL_MASTER,

    48

    EC_IOCTL_SLAVE,

    49

    EC_IOCTL_SYNC,

    50

    EC_IOCTL_PDO,

    51

    EC_IOCTL_PDO_ENTRY,

    52

	EC_IOCTL_DOMAIN_COUNT,

    53

	EC_IOCTL_DOMAIN,

    54

	EC_IOCTL_DOMAIN_FMMU,

    55

	EC_IOCTL_DATA,

    56

    EC_IOCTL_SET_DEBUG,

    57

    EC_IOCTL_SLAVE_STATE,

    58

    EC_IOCTL_SDO,

    59

    EC_IOCTL_SDO_ENTRY,

    60

};

    61

    62

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

    63

    64

typedef struct {

    65

    unsigned int slave_count;

    66

    uint8_t mode;

    67

    struct {

    68

        uint8_t address[6];

    69

        uint8_t attached;

    70

        unsigned int tx_count;

    71

        unsigned int rx_count;

    72

    } devices[2];

    73

} ec_ioctl_master_t;

    74

    75

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

    76

    77

#define EC_IOCTL_SLAVE_NAME_SIZE 104

    78

    79

typedef struct {

    80

    // input

    81

    uint16_t position;

    82

    83

    // outputs

    84

    uint32_t vendor_id;

    85

    uint32_t product_code;

    86

    uint32_t revision_number;

    87

    uint32_t serial_number;

    88

    uint16_t alias;

    89

    uint8_t state;

    90

    uint8_t sync_count;

    91

    uint16_t sdo_count;

    92

    char name[EC_IOCTL_SLAVE_NAME_SIZE];

    93

} ec_ioctl_slave_t;

    94

    95

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

    96

    97

typedef struct {

    98

    // inputs

    99

    uint16_t slave_position;

   100

    unsigned int sync_index;

   101

   102

    // outputs

   103

    uint16_t physical_start_address;

   104

    uint16_t default_size;

   105

    uint8_t control_register;

   106

    uint8_t enable;

   107

    uint8_t assign_source;

   108

    uint8_t pdo_count;

   109

} ec_ioctl_sync_t;

   110

   111

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

   112

   113

#define EC_IOCTL_PDO_NAME_SIZE 114

   114

   115

typedef struct {

   116

    // inputs

   117

    uint16_t slave_position;

   118

    unsigned int sync_index;

   119

    unsigned int pdo_pos;

   120

   121

    // outputs

   122

    uint8_t dir;

   123

    uint16_t index;

   124

    uint8_t entry_count;

   125

    char name[EC_IOCTL_PDO_NAME_SIZE];

   126

} ec_ioctl_pdo_t;

   127

   128

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

   129

   130

#define EC_IOCTL_PDO_ENTRY_NAME_SIZE 110

   131

   132

typedef struct {

   133

    // inputs

   134

    uint16_t slave_position;

   135

    unsigned int sync_index;

   136

    unsigned int pdo_pos;

   137

    unsigned int entry_pos;

   138

   139

    // outputs

   140

    uint16_t index;

   141

    uint8_t subindex;

   142

    uint8_t bit_length;

   143

    char name[EC_IOCTL_PDO_NAME_SIZE];

   144

} ec_ioctl_pdo_entry_t;

   145

   146

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

   147

   148

typedef struct {

   149

    // inputs

   150

	unsigned int index;

   151

   152

    // outputs

   153

	unsigned int data_size;

   154

	uint32_t logical_base_address;

   155

	uint16_t working_counter;

   156

	uint16_t expected_working_counter;

   157

    unsigned int fmmu_count;

   158

} ec_ioctl_domain_t;

   159

   160

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

   161

   162

typedef struct {

   163

    // inputs

   164

	unsigned int domain_index;

   165

	unsigned int fmmu_index;

   166

   167

    // outputs

   168

    uint16_t slave_config_alias;

   169

    uint16_t slave_config_position;

   170

    uint8_t fmmu_dir;

   171

	uint32_t logical_address;

   172

    unsigned int data_size;

   173

} ec_ioctl_domain_fmmu_t;

   174

   175

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

   176

   177

typedef struct {

   178

    // inputs

   179

	unsigned int domain_index;

   180

    unsigned int data_size;

   181

    unsigned char *target;

   182

} ec_ioctl_data_t;

   183

   184

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

   185

   186

typedef struct {

   187

    // inputs

   188

	uint16_t slave_position;

   189

    uint8_t requested_state;

   190

} ec_ioctl_slave_state_t;

   191

   192

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

   193

   194

#define EC_IOCTL_SDO_NAME_SIZE 121

   195

   196

typedef struct {

   197

    // inputs

   198

    uint16_t slave_position;

   199

    uint16_t sdo_position;

   200

   201

    // outputs

   202

    uint16_t sdo_index;

   203

    uint8_t max_subindex;

   204

    char name[EC_IOCTL_SDO_NAME_SIZE];

   205

} ec_ioctl_sdo_t;

   206

   207

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

   208

   209

#define EC_IOCTL_SDO_ENTRY_DESCRIPTION_SIZE 120

   210

   211

typedef struct {

   212

    // inputs

   213

    uint16_t slave_position;

   214

    uint16_t sdo_position;

   215

    uint8_t sdo_entry_subindex;

   216

   217

    // outputs

   218

    uint16_t data_type;

   219

    uint16_t bit_length;

   220

    char description[EC_IOCTL_SDO_ENTRY_DESCRIPTION_SIZE];

   221

} ec_ioctl_sdo_entry_t;

   222

   223

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

   224

   225

#endif