1

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

     2

 *

     3

 *  m a s t e r . h

     4

 *

     5

 *  EtherCAT master structure.

     6

 *

     7

 *  $Id$

     8

 *

     9

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

    10

    11

#ifndef _EC_MASTER_H_

    12

#define _EC_MASTER_H_

    13

    14

#include <linux/list.h>

    15

#include <linux/sysfs.h>

    16

#include <linux/timer.h>

    17

    18

#include "device.h"

    19

#include "domain.h"

    20

    21

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

    22

    23

/**

    24

   EtherCAT master mode.

    25

*/

    26

    27

typedef enum

    28

{

    29

    EC_MASTER_MODE_IDLE,

    30

    EC_MASTER_MODE_FREERUN,

    31

    EC_MASTER_MODE_RUNNING

    32

}

    33

ec_master_mode_t;

    34

    35

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

    36

    37

/**

    38

   Cyclic EtherCAT statistics.

    39

*/

    40

    41

typedef struct

    42

{

    43

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

    44

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

    45

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

    46

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

    47

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

    48

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

    49

}

    50

ec_stats_t;

    51

    52

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

    53

    54

/**

    55

   EtherCAT-Master.

    56

   Manages slaves, domains and IO.

    57

*/

    58

    59

struct ec_master

    60

{

    61

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

    62

    struct kobject kobj; /**< kobject */

    63

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

    64

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

    65

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

    66

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

    67

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

    68

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

    69

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

    70

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

    71

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

    72

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

    73

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

    74

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

    75

    ec_stats_t stats; /**< cyclic statistics */

    76

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

    77

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

    78

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

    79

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

    80

    ec_master_mode_t mode; /**< master mode */

    81

};

    82

    83

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

    84

    85

// master creation and deletion

    86

int ec_master_init(ec_master_t *, unsigned int);

    87

void ec_master_clear(struct kobject *);

    88

void ec_master_reset(ec_master_t *);

    89

    90

// free run

    91

void ec_master_freerun_start(ec_master_t *);

    92

void ec_master_freerun_stop(ec_master_t *);

    93

    94

// IO

    95

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

    96

void ec_master_queue_command(ec_master_t *, ec_command_t *);

    97

int ec_master_simple_io(ec_master_t *, ec_command_t *);

    98

    99

// slave management

   100

int ec_master_bus_scan(ec_master_t *);

   101

   102

// misc.

   103

void ec_master_debug(const ec_master_t *);

   104

void ec_master_output_stats(ec_master_t *);

   105

void ec_master_run_eoe(ec_master_t *);

   106

   107

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

   108

   109

#endif