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

   FMMU-Konfiguration.

    43

*/

    44

    45

typedef struct

    46

{

    47

    const ec_domain_t *domain;

    48

    const ec_sync_t *sync;

    49

    uint32_t logical_start_address;

    50

}

    51

ec_fmmu_t;

    52

    53

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

    54

    55

/**

    56

   String im EEPROM eines EtherCAT-Slaves.

    57

*/

    58

    59

typedef struct

    60

{

    61

    struct list_head list;

    62

    size_t size;

    63

    char *data;

    64

}

    65

ec_eeprom_string_t;

    66

    67

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

    68

    69

/**

    70

   Sync-Manager-Konfiguration laut EEPROM.

    71

*/

    72

    73

typedef struct

    74

{

    75

    struct list_head list;

    76

    unsigned int index;

    77

    uint16_t physical_start_address;

    78

    uint16_t length;

    79

    uint8_t control_register;

    80

    uint8_t enable;

    81

}

    82

ec_eeprom_sync_t;

    83

    84

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

    85

    86

/**

    87

   PDO-Typ.

    88

*/

    89

    90

typedef enum

    91

{

    92

    EC_RX_PDO,

    93

    EC_TX_PDO

    94

}

    95

ec_pdo_type_t;

    96

    97

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

    98

    99

/**

   100

   PDO-Beschreibung im EEPROM.

   101

*/

   102

   103

typedef struct

   104

{

   105

    struct list_head list;

   106

    ec_pdo_type_t type;

   107

    uint16_t index;

   108

    uint8_t sync_manager;

   109

    char *name;

   110

    struct list_head entries;

   111

}

   112

ec_eeprom_pdo_t;

   113

   114

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

   115

   116

/**

   117

   PDO-Entry-Beschreibung im EEPROM.

   118

*/

   119

   120

typedef struct

   121

{

   122

    struct list_head list;

   123

    uint16_t index;

   124

    uint8_t subindex;

   125

    char *name;

   126

    uint8_t bit_length;

   127

}

   128

ec_eeprom_pdo_entry_t;

   129

   130

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

   131

   132

/**

   133

   EtherCAT-Slave

   134

*/

   135

   136

struct ec_slave

   137

{

   138

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

   139

   140

    // Addresses

   141

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

   142

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

   143

   144

    // Base data

   145

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

   146

    uint8_t base_revision; /**< Revision */

   147

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

   148

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

   149

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

   150

   151

    // Slave information interface

   152

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

   153

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

   154

    uint32_t sii_product_code; /**< Herstellerspezifischer Produktcode */

   155

    uint32_t sii_revision_number; /**< Revisionsnummer */

   156

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

   157

   158

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

   159

                                    des Slave-Typs */

   160

   161

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

   162

   163

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

   164

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

   165

   166

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

   167

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

   168

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

   169

   170

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

   171

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

   172

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

   173

};

   174

   175

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

   176

   177

// Slave construction/destruction

   178

void ec_slave_init(ec_slave_t *, ec_master_t *);

   179

void ec_slave_clear(ec_slave_t *);

   180

   181

// Slave control

   182

int ec_slave_fetch(ec_slave_t *);

   183

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

   184

int ec_slave_sii_write(ec_slave_t *, uint16_t, uint16_t);

   185

int ec_slave_state_change(ec_slave_t *, uint8_t);

   186

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

   187

   188

// Misc

   189

void ec_slave_print(const ec_slave_t *);

   190

int ec_slave_check_crc(ec_slave_t *);

   191

   192

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

   193

   194

#endif

   195

   196

/* Emacs-Konfiguration

   197

;;; Local Variables: ***

   198

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

   199

;;; End: ***

   200

*/