1

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

     2

 *

     3

 *  s l a v e . h

     4

 *

     5

 *  Struktur für einen EtherCAT-Slave.

     6

 *

     7

 *  $Id$

     8

 *

     9

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

    10

    11

#ifndef _EC_SLAVE_H_

    12

#define _EC_SLAVE_H_

    13

    14

#include <linux/list.h>

    15

    16

#include "globals.h"

    17

#include "command.h"

    18

#include "types.h"

    19

    20

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

    21

    22

/**

    23

   Zustand eines EtherCAT-Slaves.

    24

*/

    25

    26

typedef enum

    27

{

    28

    EC_SLAVE_STATE_UNKNOWN = 0x00,

    29

    /**< Status unbekannt */

    30

    EC_SLAVE_STATE_INIT = 0x01,

    31

    /**< Init-Zustand (Keine Mailbox-Kommunikation, Kein I/O) */

    32

    EC_SLAVE_STATE_PREOP = 0x02,

    33

    /**< Pre-Operational (Mailbox-Kommunikation, Kein I/O) */

    34

    EC_SLAVE_STATE_SAVEOP = 0x04,

    35

    /**< Save-Operational (Mailbox-Kommunikation und Input Update) */

    36

    EC_SLAVE_STATE_OP = 0x08,

    37

    /**< Operational, (Mailbox-Kommunikation und Input/Output Update) */

    38

    EC_ACK = 0x10

    39

    /**< Acknoledge-Bit beim Zustandswechsel (kein eigener Zustand) */

    40

}

    41

ec_slave_state_t;

    42

    43

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

    44

    45

/**

    46

   Unterstützte Mailbox-Protokolle.

    47

*/

    48

    49

enum

    50

{

    51

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

    52

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

    53

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

    54

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

    55

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

    56

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

    57

};

    58

    59

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

    60

    61

/**

    62

   FMMU-Konfiguration.

    63

*/

    64

    65

typedef struct

    66

{

    67

    const ec_domain_t *domain;

    68

    const ec_sync_t *sync;

    69

    uint32_t logical_start_address;

    70

}

    71

ec_fmmu_t;

    72

    73

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

    74

    75

/**

    76

   String im EEPROM eines EtherCAT-Slaves.

    77

*/

    78

    79

typedef struct

    80

{

    81

    struct list_head list;

    82

    size_t size;

    83

    char *data;

    84

}

    85

ec_eeprom_string_t;

    86

    87

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

    88

    89

/**

    90

   Sync-Manager-Konfiguration laut EEPROM.

    91

*/

    92

    93

typedef struct

    94

{

    95

    struct list_head list;

    96

    unsigned int index;

    97

    uint16_t physical_start_address;

    98

    uint16_t length;

    99

    uint8_t control_register;

   100

    uint8_t enable;

   101

}

   102

ec_eeprom_sync_t;

   103

   104

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

   105

   106

/**

   107

   PDO-Typ.

   108

*/

   109

   110

typedef enum

   111

{

   112

    EC_RX_PDO,

   113

    EC_TX_PDO

   114

}

   115

ec_pdo_type_t;

   116

   117

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

   118

   119

/**

   120

   PDO-Beschreibung im EEPROM.

   121

*/

   122

   123

typedef struct

   124

{

   125

    struct list_head list;

   126

    ec_pdo_type_t type;

   127

    uint16_t index;

   128

    uint8_t sync_manager;

   129

    char *name;

   130

    struct list_head entries;

   131

}

   132

ec_eeprom_pdo_t;

   133

   134

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

   135

   136

/**

   137

   PDO-Entry-Beschreibung im EEPROM.

   138

*/

   139

   140

typedef struct

   141

{

   142

    struct list_head list;

   143

    uint16_t index;

   144

    uint8_t subindex;

   145

    char *name;

   146

    uint8_t bit_length;

   147

}

   148

ec_eeprom_pdo_entry_t;

   149

   150

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

   151

   152

/**

   153

   CANopen-SDO.

   154

*/

   155

   156

typedef struct

   157

{

   158

    struct list_head list;

   159

    uint16_t index;

   160

    uint16_t type;

   161

    uint8_t features;

   162

    char *name;

   163

    struct list_head entries;

   164

}

   165

ec_sdo_t;

   166

   167

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

   168

   169

/**

   170

   CANopen-SDO-Entry.

   171

*/

   172

   173

typedef struct

   174

{

   175

    struct list_head list;

   176

    uint8_t subindex;

   177

    uint16_t data_type;

   178

    uint16_t bit_length;

   179

    char *name;

   180

}

   181

ec_sdo_entry_t;

   182

   183

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

   184

   185

/**

   186

   EtherCAT-Slave

   187

*/

   188

   189

struct ec_slave

   190

{

   191

    ec_master_t *master; /**< EtherCAT-Master, zu dem der Slave gehört. */

   192

   193

    // Addresses

   194

    uint16_t ring_position; /**< Position des Slaves im Bus */

   195

    uint16_t station_address; /**< Konfigurierte Slave-Adresse */

   196

   197

    // Base data

   198

    uint8_t base_type; /**< Slave-Typ */

   199

    uint8_t base_revision; /**< Revision */

   200

    uint16_t base_build; /**< Build-Nummer */

   201

    uint16_t base_fmmu_count; /**< Anzahl unterstützter FMMUs */

   202

    uint16_t base_sync_count; /**< Anzahl unterstützter Sync-Manager */

   203

   204

    // Data link status

   205

    uint8_t dl_status_link[2]; /**< Verbindung erkannt */

   206

    uint8_t dl_status_loop[2]; /**< Loop geschlossen */

   207

    uint8_t dl_status_comm[2]; /**< Kommunikation */

   208

   209

    // Slave information interface

   210

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

   211

    uint32_t sii_vendor_id; /**< Identifikationsnummer des Herstellers */

   212

    uint32_t sii_product_code; /**< Herstellerspezifischer Produktcode */

   213

    uint32_t sii_revision_number; /**< Revisionsnummer */

   214

    uint32_t sii_serial_number; /**< Seriennummer der Klemme */

   215

    uint16_t sii_rx_mailbox_offset; /**< Adresse der Mailbox (Master->Slave) */

   216

    uint16_t sii_rx_mailbox_size; /**< Adresse der Mailbox (Master->Slave) */

   217

    uint16_t sii_tx_mailbox_offset; /**< Adresse der Mailbox (Slave->Master) */

   218

    uint16_t sii_tx_mailbox_size; /**< Adresse der Mailbox (Slave->Master) */

   219

    uint16_t sii_mailbox_protocols; /**< Unterstützte Mailbox-Protokolle */

   220

   221

    const ec_slave_type_t *type; /**< Zeiger auf die Beschreibung

   222

                                    des Slave-Typs */

   223

   224

    uint8_t registered; /**< Der Slave wurde registriert */

   225

   226

    ec_fmmu_t fmmus[EC_MAX_FMMUS]; /**< FMMU-Konfigurationen */

   227

    uint8_t fmmu_count; /**< Wieviele FMMUs schon benutzt sind. */

   228

   229

    struct list_head eeprom_strings; /**< Strings im EEPROM */

   230

    struct list_head eeprom_syncs; /**< Syncmanager-Konfigurationen (EEPROM) */

   231

    struct list_head eeprom_pdos; /**< PDO-Beschreibungen im EEPROM */

   232

   233

    char *eeprom_name; /**< Slave-Name laut Hersteller */

   234

    char *eeprom_group; /**< Slave-Beschreibung laut Hersteller */

   235

    char *eeprom_desc; /**< Slave-Beschreibung laut Hersteller */

   236

   237

    struct list_head sdo_dictionary; /**< SDO-Verzeichnis des Slaves */

   238

   239

    ec_command_t mbox_command; /**< Kommando für Mailbox-Kommunikation */

   240

};

   241

   242

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

   243

   244

// Slave construction/destruction

   245

void ec_slave_init(ec_slave_t *, ec_master_t *);

   246

void ec_slave_clear(ec_slave_t *);

   247

   248

// Slave control

   249

int ec_slave_fetch(ec_slave_t *);

   250

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

   251

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

   252

int ec_slave_sii_write16(ec_slave_t *, uint16_t, uint16_t);

   253

int ec_slave_state_change(ec_slave_t *, uint8_t);

   254

int ec_slave_set_fmmu(ec_slave_t *, const ec_domain_t *, const ec_sync_t *);

   255

   256

// CANopen over EtherCAT

   257

int ec_slave_fetch_sdo_list(ec_slave_t *);

   258

   259

// Misc

   260

void ec_slave_print(const ec_slave_t *, unsigned int);

   261

int ec_slave_check_crc(ec_slave_t *);

   262

   263

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

   264

   265

#endif

   266

   267

/* Emacs-Konfiguration

   268

;;; Local Variables: ***

   269

;;; c-basic-offset:4 ***

   270

;;; End: ***

   271

*/