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; either version 2 of the

    12

 *  License, or (at your option) any later version.

    13

 *

    14

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

    15

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

    16

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    17

 *  GNU General Public License for more details.

    18

 *

    19

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

    20

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

    21

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

    22

 *

    23

 *  The right to use EtherCAT Technology is granted and comes free of

    24

 *  charge under condition of compatibility of product made by

    25

 *  Licensee. People intending to distribute/sell products based on the

    26

 *  code, have to sign an agreement to guarantee that products using

    27

 *  software based on IgH EtherCAT master stay compatible with the actual

    28

 *  EtherCAT specification (which are released themselves as an open

    29

 *  standard) as the (only) precondition to have the right to use EtherCAT

    30

 *  Technology, IP and trade marks.

    31

 *

    32

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

    33

    34

/**

    35

   \file

    36

   EtherCAT master structure.

    37

*/

    38

    39

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

    40

    41

#ifndef _EC_MASTER_H_

    42

#define _EC_MASTER_H_

    43

    44

#include <linux/list.h>

    45

#include <linux/sysfs.h>

    46

#include <linux/timer.h>

    47

    48

#include "device.h"

    49

#include "domain.h"

    50

#include "fsm.h"

    51

    52

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

    53

    54

/**

    55

   EtherCAT master mode.

    56

*/

    57

    58

typedef enum

    59

{

    60

    EC_MASTER_MODE_ORPHANED,

    61

    EC_MASTER_MODE_IDLE,

    62

    EC_MASTER_MODE_OPERATION

    63

}

    64

ec_master_mode_t;

    65

    66

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

    67

    68

/**

    69

   Cyclic statistics.

    70

*/

    71

    72

typedef struct

    73

{

    74

    unsigned int timeouts; /**< datagram timeouts */

    75

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

    76

    unsigned int skipped; /**< skipped datagrams (the ones that were

    77

                             requeued when not yet received) */

    78

    unsigned int unmatched; /**< unmatched datagrams (received, but not

    79

                               queued any longer) */

    81

}

    82

ec_stats_t;

    83

    84

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

    85

    86

/**

    87

   EtherCAT master.

    88

   Manages slaves, domains and IO.

    89

*/

    90

    91

struct ec_master

    92

{

    93

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

    94

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

    95

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

    96

    97

    struct kobject kobj; /**< kobject */

    98

    99

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

   100

   101

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

   102

    ec_master_mode_t mode; /**< master mode */

   103

   104

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

   105

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

   106

   107

    struct list_head datagram_queue; /**< datagram queue */

   108

    uint8_t datagram_index; /**< current datagram index */

   109

   110

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

   111

   112

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

   113

    ec_stats_t stats; /**< cyclic statistics */

   114

   115

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

   116

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

   117

    uint32_t idle_cycle_times[HZ]; /**< Idle cycle times ring */

   118

    unsigned int idle_cycle_time_pos; /**< time ring buffer position */

   119

   120

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

   121

    uint32_t eoe_cycle_times[HZ]; /**< EoE cycle times ring */

   122

    unsigned int eoe_cycle_time_pos; /**< time ring buffer position */

   123

    unsigned int eoe_running; /**< non-zero, if EoE processing is active. */

   124

    unsigned int eoe_checked; /**< non-zero, if EoE processing is not

   125

                                 necessary. */

   126

    struct list_head eoe_handlers; /**< Ethernet-over-EtherCAT handlers */

   127

   128

    spinlock_t internal_lock; /**< spinlock used in idle mode */

   129

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

   130

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

   131

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

   132

   133

    uint8_t eeprom_write_enable; /**< allow write operations to EEPROMs */

   134

};

   135

   136

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

   137

   138

// master creation and deletion

   139

int ec_master_init(ec_master_t *, unsigned int, unsigned int);

   140

void ec_master_clear(struct kobject *);

   141

void ec_master_reset(ec_master_t *);

   142

   143

// free run

   144

void ec_master_idle_start(ec_master_t *);

   145

void ec_master_idle_stop(ec_master_t *);

   146

   147

// EoE

   148

void ec_master_eoe_start(ec_master_t *);

   149

void ec_master_eoe_stop(ec_master_t *);

   150

   151

// IO

   152

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

   153

void ec_master_queue_datagram(ec_master_t *, ec_datagram_t *);

   154

   155

// slave management

   156

int ec_master_bus_scan(ec_master_t *);

   157

   158

// misc.

   159

void ec_master_output_stats(ec_master_t *);

   160

void ec_master_clear_slaves(ec_master_t *);

   161

void ec_master_measure_bus_time(ec_master_t *);

   162

   163

// other methods

   164

void ec_sync_config(const ec_sii_sync_t *, const ec_slave_t *, uint8_t *);

   165

void ec_fmmu_config(const ec_fmmu_t *, const ec_slave_t *, uint8_t *);

   166

void ec_master_calc_addressing(ec_master_t *);

   167

   168

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

   169

   170

#endif