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 "types.h"

    15

    16

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

    17

    18

/**

    19

   Zustand eines EtherCAT-Slaves.

    20

*/

    21

    22

typedef enum

    23

{

    24

    EC_SLAVE_STATE_UNKNOWN = 0x00,

    25

    /**< Status unbekannt */

    26

    EC_SLAVE_STATE_INIT = 0x01,

    27

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

    28

    EC_SLAVE_STATE_PREOP = 0x02,

    29

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

    30

    EC_SLAVE_STATE_SAVEOP = 0x04,

    31

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

    32

    EC_SLAVE_STATE_OP = 0x08,

    33

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

    34

    EC_ACK = 0x10

    35

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

    36

}

    37

ec_slave_state_t;

    38

    39

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

    40

    41

/**

    42

   Unterstützte Mailbox-Protokolle.

    43

*/

    44

    45

enum

    46

{

    47

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

    48

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

    49

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

    50

    EC_MBOX_FOE = 0x08, /**< File Service over EtherCAT */

    51

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

    52

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

    53

};

    54

    55

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

    56

    57

/**

    58

   FMMU-Konfiguration.

    59

*/

    60

    61

typedef struct

    62

{

    63

    const ec_domain_t *domain;

    64

    const ec_sync_t *sync;

    65

    uint32_t logical_start_address;

    66

}

    67

ec_fmmu_t;

    68

    69

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

    70

    71

/**

    72

   String im EEPROM eines EtherCAT-Slaves.

    73

*/

    74

    75

typedef struct

    76

{

    77

    struct list_head list;

    78

    size_t size;

    79

    char *data;

    80

}

    81

ec_eeprom_string_t;

    82

    83

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

    84

    85

/**

    86

   Sync-Manager-Konfiguration laut EEPROM.

    87

*/

    88

    89

typedef struct

    90

{

    91

    struct list_head list;

    92

    unsigned int index;

    93

    uint16_t physical_start_address;

    94

    uint16_t length;

    95

    uint8_t control_register;

    96

    uint8_t enable;

    97

}

    98

ec_eeprom_sync_t;

    99

   100

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

   101

   102

/**

   103

   PDO-Typ.

   104

*/

   105

   106

typedef enum

   107

{

   108

    EC_RX_PDO,

   109

    EC_TX_PDO

   110

}

   111

ec_pdo_type_t;

   112

   113

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

   114

   115

/**

   116

   PDO-Beschreibung im EEPROM.

   117

*/

   118

   119

typedef struct

   120

{

   121

    struct list_head list;

   122

    ec_pdo_type_t type;

   123

    uint16_t index;

   124

    uint8_t sync_manager;

   125

    char *name;

   126

    struct list_head entries;

   127

}

   128

ec_eeprom_pdo_t;

   129

   130

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

   131

   132

/**

   133

   PDO-Entry-Beschreibung im EEPROM.

   134

*/

   135

   136

typedef struct

   137

{

   138

    struct list_head list;

   139

    uint16_t index;

   140

    uint8_t subindex;

   141

    char *name;

   142

    uint8_t bit_length;

   143

}

   144

ec_eeprom_pdo_entry_t;

   145

   146

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

   147

   148

/**

   149

   EtherCAT-Slave

   150

*/

   151

   152

struct ec_slave

   153

{

   154

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

   155

   156

    // Addresses

   157

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

   158

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

   159

   160

    // Base data

   161

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

   162

    uint8_t base_revision; /**< Revision */

   163

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

   164

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

   165

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

   166

   167

    // Slave information interface

   168

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

   169

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

   170

    uint32_t sii_product_code; /**< Herstellerspezifischer Produktcode */

   171

    uint32_t sii_revision_number; /**< Revisionsnummer */

   172

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

   173

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

   174

   175

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

   176

                                    des Slave-Typs */

   177

   178

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

   179

   180

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

   181

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

   182

   183

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

   184

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

   185

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

   186

   187

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

   188

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

   189

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

   190

};

   191

   192

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

   193

   194

// Slave construction/destruction

   195

void ec_slave_init(ec_slave_t *, ec_master_t *);

   196

void ec_slave_clear(ec_slave_t *);

   197

   198

// Slave control

   199

int ec_slave_fetch(ec_slave_t *);

   200

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

   201

int ec_slave_sii_write(ec_slave_t *, uint16_t, uint16_t);

   202

int ec_slave_state_change(ec_slave_t *, uint8_t);

   203

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

   204

   205

// Mailbox

   206

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

   207

int ec_slave_mailbox_receive(ec_slave_t *, uint8_t, uint8_t *, size_t *);

   208

   209

// CANopen over EtherCAT

   210

int ec_slave_fetch_sdo_list(ec_slave_t *);

   211

   212

// Misc

   213

void ec_slave_print(const ec_slave_t *);

   214

int ec_slave_check_crc(ec_slave_t *);

   215

   216

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

   217

   218

#endif

   219

   220

/* Emacs-Konfiguration

   221

;;; Local Variables: ***

   222

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

   223

;;; End: ***

   224

*/