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 stave structure.

    37

*/

    38

    39

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

    40

    41

#ifndef _EC_SLAVE_H_

    42

#define _EC_SLAVE_H_

    43

    44

#include <linux/list.h>

    45

#include <linux/kobject.h>

    46

    47

#include "../include/ecrt.h"

    48

    49

#include "globals.h"

    50

#include "datagram.h"

    51

    52

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

    53

    54

/**

    55

   State of an EtherCAT slave.

    56

*/

    57

    58

typedef enum

    59

{

    60

    EC_SLAVE_STATE_UNKNOWN = 0x00,

    61

    /**< unknown state */

    62

    EC_SLAVE_STATE_INIT = 0x01,

    63

    /**< INIT state (no mailbox communication, no IO) */

    64

    EC_SLAVE_STATE_PREOP = 0x02,

    65

    /**< PREOP state (mailbox communication, no IO) */

    66

    EC_SLAVE_STATE_SAVEOP = 0x04,

    67

    /**< SAVEOP (mailbox communication and input update) */

    68

    EC_SLAVE_STATE_OP = 0x08,

    69

    /**< OP (mailbox communication and input/output update) */

    70

    EC_SLAVE_STATE_ACK_ERR = 0x10

    71

    /**< Acknowledge/Error bit (no actual state) */

    72

}

    73

ec_slave_state_t;

    74

    75

typedef enum {

    76

    EC_SLAVE_OFFLINE,

    77

    EC_SLAVE_ONLINE

    78

}

    79

ec_slave_online_state_t;

    80

    81

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

    82

    83

/**

    84

   Supported mailbox protocols.

    85

*/

    86

    87

enum

    88

{

    89

    EC_MBOX_AOE = 0x01, /**< ADS-over-EtherCAT */

    90

    EC_MBOX_EOE = 0x02, /**< Ethernet-over-EtherCAT */

    91

    EC_MBOX_COE = 0x04, /**< CANopen-over-EtherCAT */

    92

    EC_MBOX_FOE = 0x08, /**< File-Access-over-EtherCAT */

    93

    EC_MBOX_SOE = 0x10, /**< Servo-Profile-over-EtherCAT */

    94

    EC_MBOX_VOE = 0x20  /**< Vendor specific */

    95

};

    96

    97

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

    98

    99

/**

   100

   String object (EEPROM).

   101

*/

   102

   103

typedef struct

   104

{

   105

    struct list_head list; /**< list item */

   106

    size_t size; /**< size in bytes */

   107

    char *data; /**< string data */

   108

}

   109

ec_sii_string_t;

   110

   111

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

   112

   113

/**

   114

   Sync manager configuration (EEPROM).

   115

*/

   116

   117

typedef struct

   118

{

   119

    unsigned int index; /**< sync manager index */

   120

    uint16_t physical_start_address; /**< physical start address */

   121

    uint16_t length; /**< data length in bytes */

   122

    uint8_t control_register; /**< control register value */

   123

    uint8_t enable; /**< enable bit */

   124

    uint16_t est_length; /**< Estimated length. This is no field of the SII,

   125

                            but it is used to calculate the length via

   126

                            PDO ranges */

   127

}

   128

ec_sii_sync_t;

   129

   130

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

   131

   132

/**

   133

   PDO type.

   134

*/

   135

   136

typedef enum

   137

{

   138

    EC_RX_PDO, /**< Reveive PDO */

   139

    EC_TX_PDO /**< Transmit PDO */

   140

}

   141

ec_sii_pdo_type_t;

   142

   143

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

   144

   145

/**

   146

   PDO description (EEPROM).

   147

*/

   148

   149

typedef struct

   150

{

   151

    struct list_head list; /**< list item */

   152

    ec_sii_pdo_type_t type; /**< PDO type */

   153

    uint16_t index; /**< PDO index */

   154

    uint8_t sync_index; /**< assigned sync manager */

   155

    char *name; /**< PDO name */

   156

    struct list_head entries; /**< entry list */

   157

}

   158

ec_sii_pdo_t;

   159

   160

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

   161

   162

/**

   163

   PDO entry description (EEPROM).

   164

*/

   165

   166

typedef struct

   167

{

   168

    struct list_head list; /**< list item */

   169

    uint16_t index; /**< PDO index */

   170

    uint8_t subindex; /**< entry subindex */

   171

    char *name; /**< entry name */

   172

    uint8_t bit_length; /**< entry length in bit */

   173

}

   174

ec_sii_pdo_entry_t;

   175

   176

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

   177

   178

/**

   179

   FMMU configuration.

   180

*/

   181

   182

typedef struct

   183

{

   184

    unsigned int index; /**< FMMU index */

   185

    const ec_domain_t *domain; /**< domain */

   186

    const ec_sii_sync_t *sync; /**< sync manager */

   187

    uint32_t logical_start_address; /**< logical start address */

   188

}

   189

ec_fmmu_t;

   190

   191

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

   192

   193

/**

   194

   EtherCAT slave.

   195

*/

   196

   197

struct ec_slave

   198

{

   199

    struct list_head list; /**< list item */

   200

    struct kobject kobj; /**< kobject */

   201

    ec_master_t *master; /**< master owning the slave */

   202

   203

    ec_slave_state_t requested_state; /**< requested application state */

   204

    ec_slave_state_t current_state; /**< current application state */

   205

    ec_slave_online_state_t online_state; /**< online state */

   206

    unsigned int self_configured; /**< slave was configured by this master */

   207

    unsigned int error_flag; /**< stop processing after an error */

   208

    unsigned int pdos_registered; /**< non-zero, if PDOs were registered */

   209

   210

    // addresses

   211

    uint16_t ring_position; /**< ring position */

   212

    uint16_t station_address; /**< configured station address */

   213

    uint16_t coupler_index; /**< index of the last bus coupler */

   214

    uint16_t coupler_subindex; /**< index of this slave after last coupler */

   215

   216

    // base data

   217

    uint8_t base_type; /**< slave type */

   218

    uint8_t base_revision; /**< revision */

   219

    uint16_t base_build; /**< build number */

   220

    uint16_t base_fmmu_count; /**< number of supported FMMUs */

   221

   222

    // data link status

   223

    uint8_t dl_link[4]; /**< link detected */

   224

    uint8_t dl_loop[4]; /**< loop closed */

   225

    uint8_t dl_signal[4]; /**< detected signal on RX port */

   226

   227

    // EEPROM

   228

    uint8_t *eeprom_data; /**< Complete EEPROM image */

   229

    size_t eeprom_size; /**< size of the EEPROM contents in bytes */

   230

   231

    // slave information interface

   232

    uint16_t sii_alias; /**< configured station alias */

   233

    uint32_t sii_vendor_id; /**< vendor id */

   234

    uint32_t sii_product_code; /**< vendor's product code */

   235

    uint32_t sii_revision_number; /**< revision number */

   236

    uint32_t sii_serial_number; /**< serial number */

   237

    uint16_t sii_rx_mailbox_offset; /**< mailbox address (master to slave) */

   238

    uint16_t sii_rx_mailbox_size; /**< mailbox size (master to slave) */

   239

    uint16_t sii_tx_mailbox_offset; /**< mailbox address (slave to master) */

   240

    uint16_t sii_tx_mailbox_size; /**< mailbox size (slave to master) */

   241

    uint16_t sii_mailbox_protocols; /**< supported mailbox protocols */

   242

    uint8_t sii_physical_layer[4]; /**< port media */

   243

    struct list_head sii_strings; /**< EEPROM STRING categories */

   244

    ec_sii_sync_t *sii_syncs; /**< EEPROM SYNC MANAGER categories */

   245

    unsigned int sii_sync_count; /**< number of sync managers in EEPROM */

   246

    struct list_head sii_pdos; /**< EEPROM [RT]XPDO categories */

   247

    char *sii_group; /**< slave group acc. to EEPROM */

   248

    char *sii_image; /**< slave image name acc. to EEPROM */

   249

    char *sii_order; /**< slave order number acc. to EEPROM */

   250

    char *sii_name; /**< slave name acc. to EEPROM */

   251

    int16_t sii_current_on_ebus; /**< power consumption */

   252

   253

    ec_fmmu_t fmmus[EC_MAX_FMMUS]; /**< FMMU configurations */

   254

    uint8_t fmmu_count; /**< number of FMMUs used */

   255

   256

    struct kobject sdo_kobj; /**< kobject for SDOs */

   257

    struct list_head sdo_dictionary; /**< SDO dictionary list */

   258

    struct list_head sdo_confs; /**< list of SDO configurations */

   259

    uint8_t sdo_dictionary_fetched; /**< dictionary has been fetched */

   260

    unsigned long jiffies_preop; /**< time, the slave went to PREOP */

   261

};

   262

   263

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

   264

   265

// slave construction/destruction

   266

int ec_slave_init(ec_slave_t *, ec_master_t *, uint16_t, uint16_t);

   267

void ec_slave_destroy(ec_slave_t *);

   268

   269

void ec_slave_reset(ec_slave_t *);

   270

   271

int ec_slave_prepare_fmmu(ec_slave_t *, const ec_domain_t *,

   272

                          const ec_sii_sync_t *);

   273

   274

void ec_slave_request_state(ec_slave_t *, ec_slave_state_t);

   275

void ec_slave_set_state(ec_slave_t *, ec_slave_state_t);

   276

void ec_slave_set_online_state(ec_slave_t *, ec_slave_online_state_t);

   277

   278

// SII categories

   279

int ec_slave_fetch_strings(ec_slave_t *, const uint8_t *);

   280

void ec_slave_fetch_general(ec_slave_t *, const uint8_t *);

   281

int ec_slave_fetch_sync(ec_slave_t *, const uint8_t *, size_t);

   282

int ec_slave_fetch_pdo(ec_slave_t *, const uint8_t *, size_t,

   283

                       ec_sii_pdo_type_t);

   284

int ec_slave_locate_string(ec_slave_t *, unsigned int, char **);

   285

   286

// misc.

   288

void ec_slave_sync_config(const ec_slave_t *, const ec_sii_sync_t *,

   289

        uint8_t *);

   290

void ec_slave_fmmu_config(const ec_slave_t *, const ec_fmmu_t *, uint8_t *);

   291

uint16_t ec_slave_calc_sync_size(const ec_slave_t *, const ec_sii_sync_t *);

   292

   293

int ec_slave_is_coupler(const ec_slave_t *);

   294

   295

int ec_slave_validate(const ec_slave_t *, uint32_t, uint32_t);

   296

   297

void ec_slave_sdo_dict_info(const ec_slave_t *,

   298

                            unsigned int *, unsigned int *);

   299

   300

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

   301

   302

#endif