1

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

     2

 *

     3

 *  s l a v e . h

     4

 *

     5

 *  EtherCAT stave structure.

     6

 *

     7

 *  $Id$

     8

 *

     9

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

    10

    11

#ifndef _EC_SLAVE_H_

    12

#define _EC_SLAVE_H_

    13

    14

#include <linux/list.h>

    15

#include <linux/kobject.h>

    16

    17

#include "globals.h"

    18

#include "command.h"

    19

#include "types.h"

    20

    21

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

    22

    23

/**

    24

   State of an EtherCAT slave.

    25

*/

    26

    27

typedef enum

    28

{

    29

    EC_SLAVE_STATE_UNKNOWN = 0x00,

    30

    /**< unknown state */

    31

    EC_SLAVE_STATE_INIT = 0x01,

    32

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

    33

    EC_SLAVE_STATE_PREOP = 0x02,

    34

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

    35

    EC_SLAVE_STATE_SAVEOP = 0x04,

    36

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

    37

    EC_SLAVE_STATE_OP = 0x08,

    38

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

    39

    EC_ACK = 0x10

    40

    /**< Acknoledge bit (no state) */

    41

}

    42

ec_slave_state_t;

    43

    44

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

    45

    46

/**

    47

   Supported mailbox protocols.

    48

*/

    49

    50

enum

    51

{

    52

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

    53

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

    54

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

    55

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

    56

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

    57

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

    58

};

    59

    60

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

    61

    62

/**

    63

   FMMU configuration.

    64

*/

    65

    66

typedef struct

    67

{

    68

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

    69

    const ec_sync_t *sync; /**< sync manager */

    70

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

    71

}

    72

ec_fmmu_t;

    73

    74

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

    75

    76

/**

    77

   String object (EEPROM).

    78

*/

    79

    80

typedef struct

    81

{

    82

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

    83

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

    84

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

    85

}

    86

ec_eeprom_string_t;

    87

    88

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

    89

    90

/**

    91

   Sync manager configuration (EEPROM).

    92

*/

    93

    94

typedef struct

    95

{

    96

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

    97

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

    98

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

    99

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

   100

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

   101

    uint8_t enable; /**< enable bit */

   102

}

   103

ec_eeprom_sync_t;

   104

   105

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

   106

   107

/**

   108

   PDO type.

   109

*/

   110

   111

typedef enum

   112

{

   113

    EC_RX_PDO, /**< Reveive PDO */

   114

    EC_TX_PDO /**< Transmit PDO */

   115

}

   116

ec_pdo_type_t;

   117

   118

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

   119

   120

/**

   121

   PDO description (EEPROM).

   122

*/

   123

   124

typedef struct

   125

{

   126

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

   127

    ec_pdo_type_t type; /**< PDO type */

   128

    uint16_t index; /**< PDO index */

   129

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

   130

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

   131

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

   132

}

   133

ec_eeprom_pdo_t;

   134

   135

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

   136

   137

/**

   138

   PDO entry description (EEPROM).

   139

*/

   140

   141

typedef struct

   142

{

   143

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

   144

    uint16_t index; /**< PDO index */

   145

    uint8_t subindex; /**< entry subindex */

   146

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

   147

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

   148

}

   149

ec_eeprom_pdo_entry_t;

   150

   151

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

   152

   153

/**

   154

   CANopen SDO.

   155

*/

   156

   157

typedef struct

   158

{

   159

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

   160

    uint16_t index; /**< SDO index */

   161

    //uint16_t type;

   162

    uint8_t object_code; /**< object code */

   163

    char *name; /**< SDO name */

   164

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

   165

}

   166

ec_sdo_t;

   167

   168

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

   169

   170

/**

   171

   CANopen SDO entry.

   172

*/

   173

   174

typedef struct

   175

{

   176

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

   177

    uint8_t subindex; /**< entry subindex */

   178

    uint16_t data_type; /**< entry data type */

   179

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

   180

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

   181

}

   182

ec_sdo_entry_t;

   183

   184

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

   185

   186

/**

   187

   EtherCAT-Slave

   188

*/

   189

   190

struct ec_slave

   191

{

   192

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

   193

    struct kobject kobj; /**< kobject */

   194

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

   195

   196

    // addresses

   197

    uint16_t ring_position; /**< ring position */

   198

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

   199

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

   200

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

   201

   202

    // base data

   203

    uint8_t base_type; /**< slave type */

   204

    uint8_t base_revision; /**< revision */

   205

    uint16_t base_build; /**< build number */

   206

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

   207

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

   208

   209

    // data link status

   210

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

   211

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

   212

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

   213

   214

    // slave information interface

   215

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

   216

    uint32_t sii_vendor_id; /**< vendor id */

   217

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

   218

    uint32_t sii_revision_number; /**< revision number */

   219

    uint32_t sii_serial_number; /**< serial number */

   220

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

   221

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

   222

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

   223

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

   224

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

   225

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

   226

   227

    const ec_slave_type_t *type; /**< pointer to slave type object */

   228

   229

    uint8_t registered; /**< true, if slave has been registered */

   230

   231

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

   232

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

   233

   234

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

   235

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

   236

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

   237

   238

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

   239

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

   240

    char *eeprom_desc; /**< slave description acc. to EEPROM */

   241

   242

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

   243

   244

    ec_command_t mbox_command; /**< mailbox command */

   245

};

   246

   247

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

   248

   249

// slave construction/destruction

   250

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

   251

void ec_slave_clear(struct kobject *);

   252

   253

// slave control

   254

int ec_slave_fetch(ec_slave_t *);

   255

int ec_slave_sii_read16(ec_slave_t *, uint16_t, uint16_t *);

   256

int ec_slave_sii_read32(ec_slave_t *, uint16_t, uint32_t *);

   257

int ec_slave_sii_write16(ec_slave_t *, uint16_t, uint16_t);

   258

int ec_slave_state_change(ec_slave_t *, uint8_t);

   259

int ec_slave_prepare_fmmu(ec_slave_t *, const ec_domain_t *,

   260

                          const ec_sync_t *);

   261

   262

// CoE

   263

int ec_slave_fetch_sdo_list(ec_slave_t *);

   264

   265

// misc.

   266

void ec_slave_print(const ec_slave_t *, unsigned int);

   267

int ec_slave_check_crc(ec_slave_t *);

   268

   269

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

   270

   271

#endif