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)

    69

#define EC_IOCTL_SDO_DOWNLOAD  EC_IOW(0x0e, ec_ioctl_sdo_download_t)

    70

#define EC_IOCTL_SII_READ     EC_IOWR(0x0f, ec_ioctl_sii_t)

    71

#define EC_IOCTL_SII_WRITE     EC_IOW(0x10, ec_ioctl_sii_t)

    72

    73

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

    74

    75

typedef struct {

    76

    uint32_t slave_count;

    77

    uint8_t mode;

    78

    struct {

    79

        uint8_t address[6];

    80

        uint8_t attached;

    81

        uint32_t tx_count;

    82

        uint32_t rx_count;

    83

    } devices[2];

    84

} ec_ioctl_master_t;

    85

    86

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

    87

    88

#define EC_IOCTL_SLAVE_NAME_SIZE 100

    89

    90

typedef struct {

    91

    // input

    92

    uint16_t position;

    93

    94

    // outputs

    95

    uint32_t vendor_id;

    96

    uint32_t product_code;

    97

    uint32_t revision_number;

    98

    uint32_t serial_number;

    99

    uint16_t alias;

   100

    uint8_t state;

   101

    uint8_t sync_count;

   102

    uint16_t sdo_count;

   103

    uint32_t sii_nwords;

   104

    char name[EC_IOCTL_SLAVE_NAME_SIZE];

   105

} ec_ioctl_slave_t;

   106

   107

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

   108

   109

typedef struct {

   110

    // inputs

   111

    uint16_t slave_position;

   112

    uint32_t sync_index;

   113

   114

    // outputs

   115

    uint16_t physical_start_address;

   116

    uint16_t default_size;

   117

    uint8_t control_register;

   118

    uint8_t enable;

   119

    uint8_t assign_source;

   120

    uint8_t pdo_count;

   121

} ec_ioctl_sync_t;

   122

   123

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

   124

   125

#define EC_IOCTL_PDO_NAME_SIZE 114

   126

   127

typedef struct {

   128

    // inputs

   129

    uint16_t slave_position;

   130

    uint32_t sync_index;

   131

    uint32_t pdo_pos;

   132

   133

    // outputs

   134

    uint8_t dir;

   135

    uint16_t index;

   136

    uint8_t entry_count;

   137

    char name[EC_IOCTL_PDO_NAME_SIZE];

   138

} ec_ioctl_pdo_t;

   139

   140

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

   141

   142

#define EC_IOCTL_PDO_ENTRY_NAME_SIZE 110

   143

   144

typedef struct {

   145

    // inputs

   146

    uint16_t slave_position;

   147

    uint32_t sync_index;

   148

    uint32_t pdo_pos;

   149

    uint32_t entry_pos;

   150

   151

    // outputs

   152

    uint16_t index;

   153

    uint8_t subindex;

   154

    uint8_t bit_length;

   155

    char name[EC_IOCTL_PDO_NAME_SIZE];

   156

} ec_ioctl_pdo_entry_t;

   157

   158

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

   159

   160

typedef struct {

   161

    // inputs

   162

	uint32_t index;

   163

   164

    // outputs

   165

	uint32_t data_size;

   166

	uint32_t logical_base_address;

   167

	uint16_t working_counter;

   168

	uint16_t expected_working_counter;

   169

    uint32_t fmmu_count;

   170

} ec_ioctl_domain_t;

   171

   172

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

   173

   174

typedef struct {

   175

    // inputs

   176

	uint32_t domain_index;

   177

	uint32_t fmmu_index;

   178

   179

    // outputs

   180

    uint16_t slave_config_alias;

   181

    uint16_t slave_config_position;

   182

    uint8_t fmmu_dir;

   183

	uint32_t logical_address;

   184

    uint32_t data_size;

   185

} ec_ioctl_domain_fmmu_t;

   186

   187

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

   188

   189

typedef struct {

   190

    // inputs

   191

	uint32_t domain_index;

   192

    uint32_t data_size;

   193

    unsigned char *target;

   194

} ec_ioctl_data_t;

   195

   196

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

   197

   198

typedef struct {

   199

    // inputs

   200

	uint16_t slave_position;

   201

    uint8_t requested_state;

   202

} ec_ioctl_slave_state_t;

   203

   204

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

   205

   206

#define EC_IOCTL_SDO_NAME_SIZE 121

   207

   208

typedef struct {

   209

    // inputs

   210

    uint16_t slave_position;

   211

    uint16_t sdo_position;

   212

   213

    // outputs

   214

    uint16_t sdo_index;

   215

    uint8_t max_subindex;

   216

    char name[EC_IOCTL_SDO_NAME_SIZE];

   217

} ec_ioctl_sdo_t;

   218

   219

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

   220

   221

#define EC_IOCTL_SDO_ENTRY_DESCRIPTION_SIZE 120

   222

   223

typedef struct {

   224

    // inputs

   225

    uint16_t slave_position;

   226

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

   227

    uint8_t sdo_entry_subindex;

   228

   229

    // outputs

   230

    uint16_t data_type;

   231

    uint16_t bit_length;

   232

    char description[EC_IOCTL_SDO_ENTRY_DESCRIPTION_SIZE];

   233

} ec_ioctl_sdo_entry_t;

   234

   235

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

   236

   237

typedef struct {

   238

    // inputs

   239

    uint16_t slave_position;

   240

    uint16_t sdo_index;

   241

    uint8_t sdo_entry_subindex;

   242

    uint32_t target_size;

   243

    uint8_t *target;

   244

   245

    // outputs

   246

    uint32_t data_size;

   247

} ec_ioctl_sdo_upload_t;

   248

   249

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

   250

   251

typedef struct {

   252

    // inputs

   253

    uint16_t slave_position;

   254

    uint16_t sdo_index;

   255

    uint8_t sdo_entry_subindex;

   256

    uint32_t data_size;

   257

    uint8_t *data;

   258

} ec_ioctl_sdo_download_t;

   259

   260

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

   261

   262

typedef struct {

   263

    // inputs

   264

    uint16_t slave_position;

   265

    uint16_t offset;

   266

    uint32_t nwords;

   267

    uint16_t *words;

   268

} ec_ioctl_sii_t;

   269

   270

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

   271

   272

#endif