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

};

    59

    60

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

    61

    62

typedef struct {

    63

    unsigned int slave_count;

    64

    uint8_t mode;

    65

    struct {

    66

        uint8_t address[6];

    67

        uint8_t attached;

    68

        unsigned int tx_count;

    69

        unsigned int rx_count;

    70

    } devices[2];

    71

} ec_ioctl_master_t;

    72

    73

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

    74

    75

#define EC_IOCTL_SLAVE_NAME_SIZE 114

    76

    77

typedef struct {

    78

    // input

    79

    uint16_t position;

    80

    81

    // outputs

    82

    uint32_t vendor_id;

    83

    uint32_t product_code;

    84

    uint32_t revision_number;

    85

    uint32_t serial_number;

    86

    uint16_t alias;

    87

    uint8_t state;

    88

    uint8_t sync_count;

    89

    char name[EC_IOCTL_SLAVE_NAME_SIZE];

    90

} ec_ioctl_slave_t;

    91

    92

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

    93

    94

typedef struct {

    95

    // inputs

    96

    uint16_t slave_position;

    97

    unsigned int sync_index;

    98

    99

    // outputs

   100

    uint16_t physical_start_address;

   101

    uint16_t default_size;

   102

    uint8_t control_register;

   103

    uint8_t enable;

   104

    uint8_t assign_source;

   105

    uint8_t pdo_count;

   106

} ec_ioctl_sync_t;

   107

   108

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

   109

   110

#define EC_IOCTL_PDO_NAME_SIZE 114

   111

   112

typedef struct {

   113

    // inputs

   114

    uint16_t slave_position;

   115

    unsigned int sync_index;

   116

    unsigned int pdo_pos;

   117

   118

    // outputs

   119

    uint8_t dir;

   120

    uint16_t index;

   121

    uint8_t entry_count;

   122

    char name[EC_IOCTL_PDO_NAME_SIZE];

   123

} ec_ioctl_pdo_t;

   124

   125

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

   126

   127

#define EC_IOCTL_PDO_ENTRY_NAME_SIZE 110

   128

   129

typedef struct {

   130

    // inputs

   131

    uint16_t slave_position;

   132

    unsigned int sync_index;

   133

    unsigned int pdo_pos;

   134

    unsigned int entry_pos;

   135

   136

    // outputs

   137

    uint16_t index;

   138

    uint8_t subindex;

   139

    uint8_t bit_length;

   140

    char name[EC_IOCTL_PDO_NAME_SIZE];

   141

} ec_ioctl_pdo_entry_t;

   142

   143

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

   144

   145

typedef struct {

   146

    // inputs

   147

	unsigned int index;

   148

   149

    // outputs

   150

	unsigned int data_size;

   151

	uint32_t logical_base_address;

   152

	uint16_t working_counter;

   153

	uint16_t expected_working_counter;

   154

    unsigned int fmmu_count;

   155

} ec_ioctl_domain_t;

   156

   157

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

   158

   159

typedef struct {

   160

    // inputs

   161

	unsigned int domain_index;

   162

	unsigned int fmmu_index;

   163

   164

    // outputs

   165

    uint16_t slave_config_alias;

   166

    uint16_t slave_config_position;

   167

    uint8_t fmmu_dir;

   168

	uint32_t logical_address;

   169

    unsigned int data_size;

   170

} ec_ioctl_domain_fmmu_t;

   171

   172

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

   173

   174

typedef struct {

   175

    // inputs

   176

	unsigned int domain_index;

   177

    unsigned int data_size;

   178

    unsigned char *target;

   179

} ec_ioctl_data_t;

   180

   181

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

   182

   183

typedef struct {

   184

    // inputs

   185

	uint16_t slave_position;

   186

    uint8_t requested_state;

   187

} ec_ioctl_slave_state_t;

   188

   189

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

   190

   191

#endif