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

#include <asm/byteorder.h>

    13

    20

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

    21

    22

struct ec_master;

    23

typedef struct ec_master ec_master_t;

    24

    25

struct ec_domain;

    26

typedef struct ec_domain ec_domain_t;

    27

    28

struct ec_slave;

    29

typedef struct ec_slave ec_slave_t;

    30

    31

typedef struct

    32

{

    33

    void **data_ptr;

    34

    const char *slave_address;

    35

    const char *vendor_name;

    36

    const char *product_name;

    37

    const char *field_name;

    38

    unsigned int field_index;

    39

    unsigned int field_count;

    40

}

    41

ec_field_init_t;

    42

    43

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

    44

// Master request functions

    45

    46

ec_master_t *ecrt_request_master(unsigned int master_index);

    47

void ecrt_release_master(ec_master_t *master);

    48

    49

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

    50

// Master methods

    51

    52

ec_domain_t *ecrt_master_create_domain(ec_master_t *master);

    53

int ecrt_master_activate(ec_master_t *master);

    54

void ecrt_master_deactivate(ec_master_t *master);

    55

void ecrt_master_sync_io(ec_master_t *master);

    56

void ecrt_master_async_send(ec_master_t *master);

    57

void ecrt_master_async_receive(ec_master_t *master);

    58

void ecrt_master_prepare_async_io(ec_master_t *master);

    59

void ecrt_master_debug(ec_master_t *master, int level);

    60

void ecrt_master_print(const ec_master_t *master);

    61

int ecrt_master_sdo_write(ec_master_t *master,

    62

                          const char *slave_addr,

    63

                          uint16_t sdo_index,

    64

                          uint8_t sdo_subindex,

    65

                          uint32_t value,

    66

                          size_t size);

    67

int ecrt_master_sdo_read(ec_master_t *master,

    68

                         const char *slave_addr,

    69

                         uint16_t sdo_index,

    70

                         uint8_t sdo_subindex,

    71

                         uint32_t *value);

    72

    73

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

    74

// Domain Methods

    75

    76

ec_slave_t *ecrt_domain_register_field(ec_domain_t *domain,

    77

                                       const char *address,

    78

                                       const char *vendor_name,

    79

                                       const char *product_name,

    80

                                       void **data_ptr,

    81

                                       const char *field_name,

    82

                                       unsigned int field_index,

    83

                                       unsigned int field_count);

    84

int ecrt_domain_register_field_list(ec_domain_t *domain,

    85

                                    ec_field_init_t *fields);

    86

void ecrt_domain_queue(ec_domain_t *domain);

    87

void ecrt_domain_process(ec_domain_t *domain);

    88

int ecrt_domain_state(ec_domain_t *domain);

    89

    90

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

    91

// Slave Methods

    92

    93

int ecrt_slave_sdo_write(ec_slave_t *slave,

    94

                         uint16_t sdo_index,

    95

                         uint8_t sdo_subindex,

    96

                         uint32_t value,

    97

                         size_t size);

    98

int ecrt_slave_sdo_read(ec_slave_t *slave,

    99

                        uint16_t sdo_index,

   100

                        uint8_t sdo_subindex,

   101

                        uint32_t *value);

   102

   103

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

   104

// Bitwise read/write macros

   105

   106

#define EC_READ_BIT(PD, CH) (*((uint8_t *) (PD)) >> (CH)) & 0x01)

   107

   108

#define EC_WRITE_BIT(PD, CH, VAL) \

   109

    do { \

   110

        if (VAL) *((uint8_t *) (PD)) |=  (1 << (CH)); \

   111

        else     *((uint8_t *) (PD)) &= ~(1 << (CH)); \

   112

    } while (0)

   113

   114

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

   115

// Read macros

   116

   117

#define EC_READ_U8(PD) ((uint8_t) *((uint8_t *) (PD)))

   118

#define EC_READ_S8(PD) ((int8_t)  *((uint8_t *) (PD)))

   119

   120

#define EC_READ_U16(PD) ((uint16_t) le16_to_cpup((void *) (PD)))

   121

#define EC_READ_S16(PD) ((int16_t)  le16_to_cpup((void *) (PD)))

   122

   123

#define EC_READ_U32(PD) ((uint32_t) le32_to_cpup((void *) (PD)))

   124

#define EC_READ_S32(PD) ((int32_t)  le32_to_cpup((void *) (PD)))

   125

   126

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

   127

// Write macros

   128

   129

#define EC_WRITE_U8(PD, VAL) \

   130

    do { \

   131

        *((uint8_t *)(PD)) = ((uint8_t) (VAL)); \

   132

    } while (0)

   133

   134

#define EC_WRITE_S8(PD, VAL) EC_WRITE_U8(PD, VAL)

   135

   136

#define EC_WRITE_U16(PD, VAL) \

   137

    do { \

   138

        *((uint16_t *) (PD)) = (uint16_t) (VAL); \

   139

        cpu_to_le16s(PD); \

   140

    } while (0)

   141

   142

#define EC_WRITE_S16(PD, VAL) EC_WRITE_U16(PD, VAL)

   143

   144

#define EC_WRITE_U32(PD, VAL) \

   145

    do { \

   146

        *((uint32_t *) (PD)) = (uint32_t) (VAL); \

   147

        cpu_to_le16s(PD); \

   148

    } while (0)

   149

   150

#define EC_WRITE_S32(PD, VAL) EC_WRITE_U32(PD, VAL)

   151

   152

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

   153

   154

#endif