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

#include <linux/ioctl.h>

    45

    46

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

    47

    48

#define EC_IOCTL_TYPE    0xa4

    49

    50

#define EC_IO(nr)          _IO(EC_IOCTL_TYPE,nr)

    51

#define EC_IOR(nr,type)   _IOR(EC_IOCTL_TYPE,nr,type)

    52

#define EC_IOW(nr,type)   _IOW(EC_IOCTL_TYPE,nr,type)

    53

#define EC_IOWR(nr,type) _IOWR(EC_IOCTL_TYPE,nr,type)

    54

    55

#define EC_IOCTL_MASTER        EC_IOR(0x00, ec_ioctl_master_t)

    56

#define EC_IOCTL_SLAVE        EC_IOWR(0x01, ec_ioctl_slave_t)

    57

#define EC_IOCTL_SYNC         EC_IOWR(0x02, ec_ioctl_sync_t)

    58

#define EC_IOCTL_PDO          EC_IOWR(0x03, ec_ioctl_pdo_t)

    59

#define EC_IOCTL_PDO_ENTRY    EC_IOWR(0x04, ec_ioctl_pdo_entry_t)

    60

#define EC_IOCTL_DOMAIN_COUNT   EC_IO(0x05)

    61

#define EC_IOCTL_DOMAIN       EC_IOWR(0x06, ec_ioctl_domain_t)

    62

#define EC_IOCTL_DOMAIN_FMMU  EC_IOWR(0x07, ec_ioctl_domain_fmmu_t)

    63

#define EC_IOCTL_DATA         EC_IOWR(0x08, ec_ioctl_data_t)

    64

#define EC_IOCTL_SET_DEBUG      EC_IO(0x09)

    65

#define EC_IOCTL_SLAVE_STATE   EC_IOW(0x0a, ec_ioctl_slave_state_t)

    66

#define EC_IOCTL_SDO          EC_IOWR(0x0b, ec_ioctl_sdo_t)

    67

#define EC_IOCTL_SDO_ENTRY    EC_IOWR(0x0c, ec_ioctl_sdo_entry_t)

    68

#define EC_IOCTL_SDO_UPLOAD   EC_IOWR(0x0d, ec_ioctl_sdo_upload_t)

    70

    71

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

    72

    73

typedef struct {

    74

    unsigned int slave_count;

    75

    uint8_t mode;

    76

    struct {

    77

        uint8_t address[6];

    78

        uint8_t attached;

    79

        unsigned int tx_count;

    80

        unsigned int rx_count;

    81

    } devices[2];

    82

} ec_ioctl_master_t;

    83

    84

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

    85

    86

#define EC_IOCTL_SLAVE_NAME_SIZE 104

    87

    88

typedef struct {

    89

    // input

    90

    uint16_t position;

    91

    92

    // outputs

    93

    uint32_t vendor_id;

    94

    uint32_t product_code;

    95

    uint32_t revision_number;

    96

    uint32_t serial_number;

    97

    uint16_t alias;

    98

    uint8_t state;

    99

    uint8_t sync_count;

   100

    uint16_t sdo_count;

   101

    char name[EC_IOCTL_SLAVE_NAME_SIZE];

   102

} ec_ioctl_slave_t;

   103

   104

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

   105

   106

typedef struct {

   107

    // inputs

   108

    uint16_t slave_position;

   109

    unsigned int sync_index;

   110

   111

    // outputs

   112

    uint16_t physical_start_address;

   113

    uint16_t default_size;

   114

    uint8_t control_register;

   115

    uint8_t enable;

   116

    uint8_t assign_source;

   117

    uint8_t pdo_count;

   118

} ec_ioctl_sync_t;

   119

   120

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

   121

   122

#define EC_IOCTL_PDO_NAME_SIZE 114

   123

   124

typedef struct {

   125

    // inputs

   126

    uint16_t slave_position;

   127

    unsigned int sync_index;

   128

    unsigned int pdo_pos;

   129

   130

    // outputs

   131

    uint8_t dir;

   132

    uint16_t index;

   133

    uint8_t entry_count;

   134

    char name[EC_IOCTL_PDO_NAME_SIZE];

   135

} ec_ioctl_pdo_t;

   136

   137

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

   138

   139

#define EC_IOCTL_PDO_ENTRY_NAME_SIZE 110

   140

   141

typedef struct {

   142

    // inputs

   143

    uint16_t slave_position;

   144

    unsigned int sync_index;

   145

    unsigned int pdo_pos;

   146

    unsigned int entry_pos;

   147

   148

    // outputs

   149

    uint16_t index;

   150

    uint8_t subindex;

   151

    uint8_t bit_length;

   152

    char name[EC_IOCTL_PDO_NAME_SIZE];

   153

} ec_ioctl_pdo_entry_t;

   154

   155

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

   156

   157

typedef struct {

   158

    // inputs

   159

	unsigned int index;

   160

   161

    // outputs

   162

	unsigned int data_size;

   163

	uint32_t logical_base_address;

   164

	uint16_t working_counter;

   165

	uint16_t expected_working_counter;

   166

    unsigned int fmmu_count;

   167

} ec_ioctl_domain_t;

   168

   169

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

   170

   171

typedef struct {

   172

    // inputs

   173

	unsigned int domain_index;

   174

	unsigned int fmmu_index;

   175

   176

    // outputs

   177

    uint16_t slave_config_alias;

   178

    uint16_t slave_config_position;

   179

    uint8_t fmmu_dir;

   180

	uint32_t logical_address;

   181

    unsigned int data_size;

   182

} ec_ioctl_domain_fmmu_t;

   183

   184

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

   185

   186

typedef struct {

   187

    // inputs

   188

	unsigned int domain_index;

   189

    unsigned int data_size;

   190

    unsigned char *target;

   191

} ec_ioctl_data_t;

   192

   193

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

   194

   195

typedef struct {

   196

    // inputs

   197

	uint16_t slave_position;

   198

    uint8_t requested_state;

   199

} ec_ioctl_slave_state_t;

   200

   201

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

   202

   203

#define EC_IOCTL_SDO_NAME_SIZE 121

   204

   205

typedef struct {

   206

    // inputs

   207

    uint16_t slave_position;

   208

    uint16_t sdo_position;

   209

   210

    // outputs

   211

    uint16_t sdo_index;

   212

    uint8_t max_subindex;

   213

    char name[EC_IOCTL_SDO_NAME_SIZE];

   214

} ec_ioctl_sdo_t;

   215

   216

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

   217

   218

#define EC_IOCTL_SDO_ENTRY_DESCRIPTION_SIZE 120

   219

   220

typedef struct {

   221

    // inputs

   222

    uint16_t slave_position;

   223

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

   224

    uint8_t sdo_entry_subindex;

   225

   226

    // outputs

   227

    uint16_t data_type;

   228

    uint16_t bit_length;

   229

    char description[EC_IOCTL_SDO_ENTRY_DESCRIPTION_SIZE];

   230

} ec_ioctl_sdo_entry_t;

   231

   232

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

   233

   234

typedef struct {

   235

    // inputs

   236

    uint16_t slave_position;

   237

    uint16_t sdo_index;

   238

    uint8_t sdo_entry_subindex;

   239

    unsigned int target_size;

   240

    uint8_t *target;

   241

   242

    // outputs

   243

    unsigned int data_size;

   244

} ec_ioctl_sdo_upload_t;

   245

   246

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

   247

   259

#endif