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

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

    76

    77

/**

    78

   Supported mailbox protocols.

    79

*/

    80

    81

enum

    82

{

    83

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

    84

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

    85

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

    86

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

    87

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

    88

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

    89

};

    90

    91

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

    92

    93

/**

    94

   String object (EEPROM).

    95

*/

    96

    97

typedef struct

    98

{

    99

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

   100

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

   101

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

   102

}

   103

ec_sii_string_t;

   104

   105

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

   106

   107

/**

   108

   Sync manager configuration (EEPROM).

   109

*/

   110

   111

typedef struct

   112

{

   113

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

   114

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

   115

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

   116

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

   117

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

   118

    uint8_t enable; /**< enable bit */

   119

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

   120

                            but it is used to calculate the length via

   121

                            PDO ranges */

   122

}

   123

ec_sii_sync_t;

   124

   125

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

   126

   127

/**

   128

   PDO type.

   129

*/

   130

   131

typedef enum

   132

{

   133

    EC_RX_PDO, /**< Reveive PDO */

   134

    EC_TX_PDO /**< Transmit PDO */

   135

}

   136

ec_sii_pdo_type_t;

   137

   138

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

   139

   140

/**

   141

   PDO description (EEPROM).

   142

*/

   143

   144

typedef struct

   145

{

   146

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

   147

    ec_sii_pdo_type_t type; /**< PDO type */

   148

    uint16_t index; /**< PDO index */

   149

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

   150

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

   151

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

   152

}

   153

ec_sii_pdo_t;

   154

   155

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

   156

   157

/**

   158

   PDO entry description (EEPROM).

   159

*/

   160

   161

typedef struct

   162

{

   163

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

   164

    uint16_t index; /**< PDO index */

   165

    uint8_t subindex; /**< entry subindex */

   166

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

   167

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

   168

}

   169

ec_sii_pdo_entry_t;

   170

   171

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

   172

   173

/**

   174

   FMMU configuration.

   175

*/

   176

   177

typedef struct

   178

{

   179

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

   180

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

   181

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

   182

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

   183

}

   184

ec_fmmu_t;

   185

   186

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

   187

   188

/**

   189

   EtherCAT slave.

   190

*/

   191

   192

struct ec_slave

   193

{

   194

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

   195

    struct kobject kobj; /**< kobject */

   196

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

   197

   198

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

   199

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

   200

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

   201

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

   202

    unsigned int online; /**< non-zero, if the slave responds. */

   203

   204

    // addresses

   205

    uint16_t ring_position; /**< ring position */

   206

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

   207

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

   208

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

   209

   210

    // base data

   211

    uint8_t base_type; /**< slave type */

   212

    uint8_t base_revision; /**< revision */

   213

    uint16_t base_build; /**< build number */

   214

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

   215

    uint16_t base_sync_count; /**< number of supported sync managers */

   216

   217

    // data link status

   218

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

   219

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

   220

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

   221

   222

    // EEPROM

   223

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

   224

    uint16_t eeprom_size; /**< size of the EEPROM contents in byte */

   225

    uint16_t *new_eeprom_data; /**< new EEPROM data to write */

   226

    uint16_t new_eeprom_size; /**< size of new EEPROM data in words */

   227

   228

    // slave information interface

   229

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

   230

    uint32_t sii_vendor_id; /**< vendor id */

   231

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

   232

    uint32_t sii_revision_number; /**< revision number */

   233

    uint32_t sii_serial_number; /**< serial number */

   234

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

   235

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

   236

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

   237

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

   238

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

   239

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

   240

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

   241

    struct list_head sii_syncs; /**< EEPROM SYNC MANAGER categories */

   242

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

   243

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

   244

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

   245

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

   246

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

   247

    int16_t sii_current_on_ebus; /**< power consumption */

   248

   249

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

   250

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

   251

   252

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

   253

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

   254

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

   255

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

   256

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

   257

};

   258

   259

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

   260

   261

// slave construction/destruction

   262

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

   263

void ec_slave_destroy(ec_slave_t *);

   264

   265

void ec_slave_reset(ec_slave_t *);

   266

   267

int ec_slave_prepare_fmmu(ec_slave_t *, const ec_domain_t *,

   268

                          const ec_sii_sync_t *);

   269

   270

void ec_slave_request_state(ec_slave_t *, ec_slave_state_t);

   271

   272

// SII categories

   273

int ec_slave_fetch_strings(ec_slave_t *, const uint8_t *);

   274

void ec_slave_fetch_general(ec_slave_t *, const uint8_t *);

   275

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

   276

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

   277

                       ec_sii_pdo_type_t);

   278

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

   279

   280

// misc.

   281

uint16_t ec_slave_calc_sync_size(const ec_slave_t *,

   282

                                 const ec_sii_sync_t *);

   283

   284

int ec_slave_is_coupler(const ec_slave_t *);

   285

int ec_slave_has_subbus(const ec_slave_t *);

   286

   287

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

   288

   289

void ec_slave_sdo_dict_info(const ec_slave_t *,

   290

                            unsigned int *, unsigned int *);

   291

   292

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

   293

   294

#endif