1

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

     2

 *

     3

 *  m a s t e r . h

     4

 *

     5

 *  EtherCAT master structure.

     6

 *

     7

 *  $Id$

     8

 *

    26

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

    27

    28

#ifndef _EC_MASTER_H_

    29

#define _EC_MASTER_H_

    30

    31

#include <linux/list.h>

    32

#include <linux/sysfs.h>

    33

#include <linux/timer.h>

    34

    35

#include "device.h"

    36

#include "domain.h"

    37

    38

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

    39

    40

/**

    49

   EtherCAT master mode.

    50

*/

    51

    52

typedef enum

    53

{

    54

    EC_MASTER_MODE_IDLE,

    55

    EC_MASTER_MODE_FREERUN,

    56

    EC_MASTER_MODE_RUNNING

    57

}

    58

ec_master_mode_t;

    59

    60

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

    61

    62

/**

    63

   Cyclic EtherCAT statistics.

    64

*/

    65

    66

typedef struct

    67

{

    68

    unsigned int timeouts; /**< command timeouts */

    69

    unsigned int delayed; /**< delayed commands */

    70

    unsigned int corrupted; /**< corrupted frames */

    71

    unsigned int unmatched; /**< unmatched commands */

    72

    unsigned int eoe_errors; /**< Ethernet-over-EtherCAT errors */

    73

    cycles_t t_last; /**< time of last output */

    74

}

    75

ec_stats_t;

    76

    77

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

    78

    79

/**

    80

   EtherCAT-Master.

    81

   Manages slaves, domains and IO.

    82

*/

    83

    84

struct ec_master

    85

{

    86

    struct list_head list; /**< list item */

    87

    struct kobject kobj; /**< kobject */

    88

    unsigned int index; /**< master index */

    89

    struct list_head slaves; /**< list of slaves on the bus */

    90

    unsigned int slave_count; /**< number of slaves on the bus */

    91

    ec_device_t *device; /**< EtherCAT device */

    92

    struct list_head command_queue; /**< command queue */

    93

    uint8_t command_index; /**< current command index */

    94

    struct list_head domains; /**< list of domains */

    95

    ec_command_t simple_command; /**< command structure for initialization */

    96

    ec_command_t watch_command; /**< command for watching the slaves */

    97

    unsigned int slaves_responding; /**< number of responding slaves */

    98

    ec_slave_state_t slave_states; /**< states of the responding slaves */

    99

    int debug_level; /**< master debug level */

   100

    ec_stats_t stats; /**< cyclic statistics */

   101

    unsigned int timeout; /**< timeout in synchronous IO */

   102

    struct list_head eoe_slaves; /**< Ethernet-over-EtherCAT slaves */

   103

    unsigned int reserved; /**< true, if the master is reserved for RT */

   104

    struct timer_list freerun_timer; /**< timer object for free run mode */

   105

    ec_master_mode_t mode; /**< master mode */

   106

};

   107

   110

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

   111

   112

// master creation and deletion

   113

int ec_master_init(ec_master_t *, unsigned int);

   114

void ec_master_clear(struct kobject *);

   115

void ec_master_reset(ec_master_t *);

   116

   117

// free run

   118

void ec_master_freerun_start(ec_master_t *);

   119

void ec_master_freerun_stop(ec_master_t *);

   120

   121

// IO

   122

void ec_master_receive(ec_master_t *, const uint8_t *, size_t);

   123

void ec_master_queue_command(ec_master_t *, ec_command_t *);

   124

int ec_master_simple_io(ec_master_t *, ec_command_t *);

   125

   126

// slave management

   127

int ec_master_bus_scan(ec_master_t *);

   128

   129

// misc.

   130

void ec_master_debug(const ec_master_t *);

   131

void ec_master_output_stats(ec_master_t *);

   132

void ec_master_run_eoe(ec_master_t *);

   133

   134

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

   135

   136

#endif