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

#include "fsm.h"

    41

    42

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

    43

    44

/**

    45

   EtherCAT master mode.

    46

*/

    47

    48

typedef enum

    49

{

    50

    EC_MASTER_MODE_IDLE,

    51

    EC_MASTER_MODE_FREERUN,

    52

    EC_MASTER_MODE_RUNNING

    53

}

    54

ec_master_mode_t;

    55

    56

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

    57

    58

/**

    59

   Cyclic statistics.

    60

*/

    61

    62

typedef struct

    63

{

    64

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

    65

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

    66

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

    67

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

    68

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

    69

}

    70

ec_stats_t;

    71

    72

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

    73

    74

/**

    75

   EtherCAT master.

    76

   Manages slaves, domains and IO.

    77

*/

    78

    79

struct ec_master

    80

{

    81

    struct list_head list; /**< list item for module's master list */

    82

    unsigned int reserved; /**< non-zero, if the master is reserved for RT */

    83

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

    84

    85

    struct kobject kobj; /**< kobject */

    86

    87

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

    88

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

    89

    90

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

    91

    92

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

    93

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

    94

    95

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

    96

    97

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

    98

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

    99

   100

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

   101

    ec_stats_t stats; /**< cyclic statistics */

   102

   103

    struct workqueue_struct *workqueue; /**< master workqueue */

   104

    struct work_struct freerun_work; /**< free run work object */

   105

    ec_fsm_t fsm; /**< master state machine */

   106

    ec_master_mode_t mode; /**< master mode */

   107

   108

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

   109

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

   110

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

   111

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

   112

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

   113

};

   114

   115

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

   116

   117

// master creation and deletion

   118

int ec_master_init(ec_master_t *, unsigned int);

   119

void ec_master_clear(struct kobject *);

   120

void ec_master_reset(ec_master_t *);

   121

   122

// free run

   123

void ec_master_freerun_start(ec_master_t *);

   124

void ec_master_freerun_stop(ec_master_t *);

   125

   126

// IO

   127

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

   128

void ec_master_queue_command(ec_master_t *, ec_command_t *);

   129

int ec_master_simple_io(ec_master_t *, ec_command_t *);

   130

   131

// slave management

   132

int ec_master_bus_scan(ec_master_t *);

   133

   134

// misc.

   135

void ec_master_clear_slaves(ec_master_t *);

   136

void ec_master_output_stats(ec_master_t *);

   137

   138

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

   139

   140

#endif