1

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

     2

 *

     3

 *  $Id$

     4

 *

     5

 *  Copyright (C) 2006  Florian Pose, Ingenieurgemeinschaft IgH

     6

 *

     7

 *  This file is part of the IgH EtherCAT Master.

     8

 *

     9

 *  The IgH EtherCAT Master is free software; you can redistribute it

    10

 *  and/or modify it under the terms of the GNU General Public License

    11

 *  as published by the Free Software Foundation; version 2 of the License.

    12

 *

    13

 *  The IgH EtherCAT Master is distributed in the hope that it will be

    14

 *  useful, but WITHOUT ANY WARRANTY; without even the implied warranty of

    15

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    16

 *  GNU General Public License for more details.

    17

 *

    18

 *  You should have received a copy of the GNU General Public License

    19

 *  along with the IgH EtherCAT Master; if not, write to the Free Software

    20

 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

    21

 *

    22

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

    23

    24

/**

    25

   \file

    26

   EtherCAT master structure.

    27

*/

    28

    29

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

    30

    31

#ifndef _EC_MASTER_H_

    32

#define _EC_MASTER_H_

    33

    34

#include <linux/list.h>

    35

#include <linux/sysfs.h>

    36

#include <linux/timer.h>

    37

    38

#include "device.h"

    39

#include "domain.h"

    40

    41

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

    42

    43

// Uncomment this to do EoE within a kernel timer. Otherwise, it will be

    44

// done in a working queue.

    45

    47

    48

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

    49

    50

/**

    51

   EtherCAT master mode.

    52

*/

    53

    54

typedef enum

    55

{

    56

    EC_MASTER_MODE_IDLE,

    57

    EC_MASTER_MODE_FREERUN,

    58

    EC_MASTER_MODE_RUNNING

    59

}

    60

ec_master_mode_t;

    61

    62

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

    63

    64

/**

    65

   Cyclic statistics.

    66

*/

    67

    68

typedef struct

    69

{

    70

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

    71

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

    72

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

    73

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

    74

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

    75

}

    76

ec_stats_t;

    77

    78

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

    79

    80

/**

    81

   EtherCAT master.

    82

   Manages slaves, domains and IO.

    83

*/

    84

    85

struct ec_master

    86

{

    87

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

    88

    struct kobject kobj; /**< kobject */

    89

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

    90

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

    91

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

    92

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

    93

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

    94

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

    95

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

    96

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

    97

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

    98

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

    99

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

   100

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

   101

    ec_stats_t stats; /**< cyclic statistics */

   102

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

   103

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

   104

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

   105

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

   106

    ec_master_mode_t mode; /**< master mode */

   107

    int (*request_cb)(void *); /**< lock request callback */

   108

    void (*release_cb)(void *); /**< lock release callback */

   109

    void *cb_data; /**< data parameter of locking callbacks */

   110

#ifdef EOE_TIMER

   111

    struct timer_list eoe_timer; /** EoE timer object */

   112

#else

   113

    struct workqueue_struct *eoe_workqueue; /**< EoE workqueue */

   114

    struct work_struct eoe_work; /**< work structure for EoE workqueue */

   115

#endif

   116

};

   117

   118

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

   119

   120

// master creation and deletion

   121

int ec_master_init(ec_master_t *, unsigned int);

   122

void ec_master_clear(struct kobject *);

   123

void ec_master_reset(ec_master_t *);

   124

   125

// free run

   126

void ec_master_freerun_start(ec_master_t *);

   127

void ec_master_freerun_stop(ec_master_t *);

   128

   129

// IO

   130

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

   131

void ec_master_queue_command(ec_master_t *, ec_command_t *);

   132

int ec_master_simple_io(ec_master_t *, ec_command_t *);

   133

   134

// slave management

   135

int ec_master_bus_scan(ec_master_t *);

   136

   137

// misc.

   138

void ec_master_output_stats(ec_master_t *);

   139

   140

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

   141

   142

#endif