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

    EC_IOCTL_SDO_UPLOAD,

    61

};

    62

    63

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

    64

    65

typedef struct {

    66

    unsigned int slave_count;

    67

    uint8_t mode;

    68

    struct {

    69

        uint8_t address[6];

    70

        uint8_t attached;

    71

        unsigned int tx_count;

    72

        unsigned int rx_count;

    73

    } devices[2];

    74

} ec_ioctl_master_t;

    75

    76

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

    77

    78

#define EC_IOCTL_SLAVE_NAME_SIZE 104

    79

    80

typedef struct {

    81

    // input

    82

    uint16_t position;

    83

    84

    // outputs

    85

    uint32_t vendor_id;

    86

    uint32_t product_code;

    87

    uint32_t revision_number;

    88

    uint32_t serial_number;

    89

    uint16_t alias;

    90

    uint8_t state;

    91

    uint8_t sync_count;

    92

    uint16_t sdo_count;

    93

    char name[EC_IOCTL_SLAVE_NAME_SIZE];

    94

} ec_ioctl_slave_t;

    95

    96

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

    97

    98

typedef struct {

    99

    // inputs

   100

    uint16_t slave_position;

   101

    unsigned int sync_index;

   102

   103

    // outputs

   104

    uint16_t physical_start_address;

   105

    uint16_t default_size;

   106

    uint8_t control_register;

   107

    uint8_t enable;

   108

    uint8_t assign_source;

   109

    uint8_t pdo_count;

   110

} ec_ioctl_sync_t;

   111

   112

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

   113

   114

#define EC_IOCTL_PDO_NAME_SIZE 114

   115

   116

typedef struct {

   117

    // inputs

   118

    uint16_t slave_position;

   119

    unsigned int sync_index;

   120

    unsigned int pdo_pos;

   121

   122

    // outputs

   123

    uint8_t dir;

   124

    uint16_t index;

   125

    uint8_t entry_count;

   126

    char name[EC_IOCTL_PDO_NAME_SIZE];

   127

} ec_ioctl_pdo_t;

   128

   129

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

   130

   131

#define EC_IOCTL_PDO_ENTRY_NAME_SIZE 110

   132

   133

typedef struct {

   134

    // inputs

   135

    uint16_t slave_position;

   136

    unsigned int sync_index;

   137

    unsigned int pdo_pos;

   138

    unsigned int entry_pos;

   139

   140

    // outputs

   141

    uint16_t index;

   142

    uint8_t subindex;

   143

    uint8_t bit_length;

   144

    char name[EC_IOCTL_PDO_NAME_SIZE];

   145

} ec_ioctl_pdo_entry_t;

   146

   147

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

   148

   149

typedef struct {

   150

    // inputs

   151

	unsigned int index;

   152

   153

    // outputs

   154

	unsigned int data_size;

   155

	uint32_t logical_base_address;

   156

	uint16_t working_counter;

   157

	uint16_t expected_working_counter;

   158

    unsigned int fmmu_count;

   159

} ec_ioctl_domain_t;

   160

   161

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

   162

   163

typedef struct {

   164

    // inputs

   165

	unsigned int domain_index;

   166

	unsigned int fmmu_index;

   167

   168

    // outputs

   169

    uint16_t slave_config_alias;

   170

    uint16_t slave_config_position;

   171

    uint8_t fmmu_dir;

   172

	uint32_t logical_address;

   173

    unsigned int data_size;

   174

} ec_ioctl_domain_fmmu_t;

   175

   176

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

   177

   178

typedef struct {

   179

    // inputs

   180

	unsigned int domain_index;

   181

    unsigned int data_size;

   182

    unsigned char *target;

   183

} ec_ioctl_data_t;

   184

   185

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

   186

   187

typedef struct {

   188

    // inputs

   189

	uint16_t slave_position;

   190

    uint8_t requested_state;

   191

} ec_ioctl_slave_state_t;

   192

   193

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

   194

   195

#define EC_IOCTL_SDO_NAME_SIZE 121

   196

   197

typedef struct {

   198

    // inputs

   199

    uint16_t slave_position;

   200

    uint16_t sdo_position;

   201

   202

    // outputs

   203

    uint16_t sdo_index;

   204

    uint8_t max_subindex;

   205

    char name[EC_IOCTL_SDO_NAME_SIZE];

   206

} ec_ioctl_sdo_t;

   207

   208

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

   209

   210

#define EC_IOCTL_SDO_ENTRY_DESCRIPTION_SIZE 120

   211

   212

typedef struct {

   213

    // inputs

   214

    uint16_t slave_position;

   215

    int sdo_spec; // positive: index, negative: list position

   216

    uint8_t sdo_entry_subindex;

   217

   218

    // outputs

   219

    uint16_t data_type;

   220

    uint16_t bit_length;

   221

    char description[EC_IOCTL_SDO_ENTRY_DESCRIPTION_SIZE];

   222

} ec_ioctl_sdo_entry_t;

   223

   224

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

   225

   226

typedef struct {

   227

    // inputs

   228

    uint16_t slave_position;

   229

    uint16_t sdo_index;

   230

    uint8_t sdo_entry_subindex;

   231

    unsigned int target_size;

   232

    uint8_t *target;

   233

   234

    // outputs

   235

    unsigned int data_size;

   236

} ec_ioctl_sdo_upload_t;

   237

   238

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

   239

   240

#endif