1

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

     2

 *

     3

 * Oeffentliche EtherCAT-Schnittstellen fuer Echtzeitprozesse.

     4

 *

     5

 * $Id$

     6

 *

     7

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

     8

     9

#ifndef _ETHERCAT_RT_H_

    10

#define _ETHERCAT_RT_H_

    11

    12

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

    13

    14

struct ec_master;

    15

typedef struct ec_master ec_master_t;

    16

    17

struct ec_slave_type;

    18

typedef struct ec_slave_type ec_slave_type_t;

    19

    20

struct ec_slave;

    21

typedef struct ec_slave ec_slave_t;

    22

    23

struct ec_slave_init;

    24

typedef struct ec_slave_init ec_slave_init_t;

    25

    26

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

    27

    28

ec_master_t *EtherCAT_rt_request_master(unsigned int master_index);

    29

    30

void EtherCAT_rt_release_master(ec_master_t *master);

    31

    32

ec_slave_t *EtherCAT_rt_register_slave(ec_master_t *master,

    33

                                       unsigned int slave_index,

    34

                                       const char *vendor_name,

    35

                                       const char *product_name,

    36

                                       int domain);

    37

    38

int EtherCAT_rt_register_slave_list(ec_master_t *master,

    39

                                    const ec_slave_init_t *slaves,

    40

                                    unsigned int count);

    41

    42

int EtherCAT_rt_activate_slaves(ec_master_t *master);

    43

    44

int EtherCAT_rt_deactivate_slaves(ec_master_t *master);

    45

    46

int EtherCAT_rt_domain_xio(ec_master_t *master, unsigned int domain,

    47

                           unsigned int timeout_us);

    48

    49

void EtherCAT_rt_debug_level(ec_master_t *master, int level);

    50

    56

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

    57

    58

/**

    59

   EtherCAT-Slave

    60

*/

    61

    62

struct ec_slave

    63

{

    64

    // Base data

    65

    unsigned char base_type; /**< Slave-Typ */

    66

    unsigned char base_revision; /**< Revision */

    67

    unsigned short base_build; /**< Build-Nummer */

    68

    69

    // Addresses

    70

    short ring_position; /**< (Negative) Position des Slaves im Bus */

    71

    unsigned short station_address; /**< Konfigurierte Slave-Adresse */

    72

    73

    // Slave information interface

    74

    unsigned int sii_vendor_id; /**< Identifikationsnummer des Herstellers */

    75

    unsigned int sii_product_code; /**< Herstellerspezifischer Produktcode */

    76

    unsigned int sii_revision_number; /**< Revisionsnummer */

    77

    unsigned int sii_serial_number; /**< Seriennummer der Klemme */

    78

    79

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

    80

                                    des Slave-Typs */

    81

    82

    unsigned int logical_address; /**< Konfigurierte, logische Adresse */

    83

    84

    void *process_data; /**< Zeiger auf den Speicherbereich

    85

                           innerhalb eines Prozessdatenobjekts */

    86

    void *private_data; /**< Zeiger auf privaten Datenbereich */

    87

    int (*configure)(ec_slave_t *); /**< Zeiger auf die Funktion zur

    88

                                     Konfiguration */

    89

    90

    unsigned char registered; /**< Der Slave wurde registriert */

    91

    92

    unsigned int domain; /**< Prozessdatendomäne */

    93

    94

    int error_reported; /**< Ein Zugriffsfehler wurde bereits gemeldet */

    95

};

    96

    97

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

    98

    99

/**

   100

   Beschreibung eines EtherCAT-Slave-Typs.

   101

   102

   Diese Beschreibung dient zur Konfiguration einer bestimmten

   103

   Slave-Art. Sie enthält die Konfigurationsdaten für die

   104

   Slave-internen Sync-Manager und FMMU's.

   105

*/

   106

   107

struct ec_slave_init

   108

{

   109

    ec_slave_t **slave_ptr; /**< Zeiger auf den Slave-Zeiger, der mit der

   110

                               Adresse des Slaves belegt werden soll. */

   111

    unsigned int bus_index; /**< Bus-Index des zu registrierenden Slaves */

   112

    const char *vendor_name; /**< Name des Herstellers */

   113

    const char *product_name; /**< Name des Slaves-Typs */

   114

    unsigned int domain; /**< Domäne, in der registriert werden soll. */

   115

};

   116

   117

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

   118

   119

#endif