1

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

     2

 *

     3

 *  $Id$

     4

 *

     5

 *  Copyright (C) 2006-2008  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 and/or

    10

 *  modify it under the terms of the GNU General Public License version 2, as

    11

 *  published by the Free Software Foundation.

    12

 *

    13

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

    14

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

    15

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General

    16

 *  Public License for more details.

    17

 *

    18

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

    19

 *  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

 *  The license mentioned above concerns the source code only. Using the

    25

 *  EtherCAT technology and brand is only permitted in compliance with the

    26

 *  industrial property and similar rights of Beckhoff Automation GmbH.

    27

 *

    28

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

    29

    30

/**

    31

   \file

    32

   EtherCAT master structure.

    33

*/

    34

    35

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

    36

    37

#ifndef __EC_MASTER_H__

    38

#define __EC_MASTER_H__

    39

    40

#include <linux/version.h>

    41

#include <linux/list.h>

    42

#include <linux/timer.h>

    43

#include <linux/wait.h>

    44

#include <linux/kthread.h>

    45

    46

#if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 27)

    47

#include <linux/semaphore.h>

    48

#else

    49

#include <asm/semaphore.h>

    50

#endif

    51

    52

#include "device.h"

    53

#include "domain.h"

    54

#include "fsm_master.h"

    55

#include "cdev.h"

    56

    57

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

    58

    59

/** EtherCAT master phase.

    60

 */

    61

typedef enum {

    62

    EC_ORPHANED, /**< Orphaned phase. The master has no Ethernet device

    63

                   attached. */

    64

    EC_IDLE, /**< Idle phase. An Ethernet device is attached, but the master

    65

               is not in use, yet. */

    66

    EC_OPERATION /**< Operation phase. The master was requested by a realtime

    67

                   application. */

    68

} ec_master_phase_t;

    69

    70

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

    71

    72

/** Cyclic statistics.

    73

 */

    74

typedef struct {

    75

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

    76

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

    77

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

    78

                               queued any longer) */

    79

    unsigned long output_jiffies; /**< time of last output */

    80

} ec_stats_t;

    81

    82

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

    83

    84

/** EtherCAT master.

    85

 *

    86

 * Manages slaves, domains and IO.

    87

 */

    88

struct ec_master {

    89

    unsigned int index; /**< Index. */

    90

    unsigned int reserved; /**< \a True, if the master is in use. */

    91

    92

    ec_cdev_t cdev; /**< Master character device. */

    93

#if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 26)

    94

    struct device *class_device; /**< Master class device. */

    95

#else

    96

    struct class_device *class_device; /**< Master class device. */

    97

#endif

    98

    99

    struct semaphore master_sem; /**< Master semaphore. */

   100

   101

    ec_device_t main_device; /**< EtherCAT main device. */

   102

    const uint8_t *main_mac; /**< MAC address of main device. */

   103

    ec_device_t backup_device; /**< EtherCAT backup device. */

   104

    const uint8_t *backup_mac; /**< MAC address of backup device. */

   105

    struct semaphore device_sem; /**< Device semaphore. */

   106

   107

    ec_fsm_master_t fsm; /**< Master state machine. */

   108

    ec_datagram_t fsm_datagram; /**< Datagram used for state machines. */

   109

    ec_master_phase_t phase; /**< Master phase. */

   110

    unsigned int injection_seq_fsm; /**< Datagram injection sequence number

   111

                                      for the FSM side. */

   112

    unsigned int injection_seq_rt; /**< Datagram injection sequence number

   113

                                     for the realtime side. */

   114

   115

    ec_slave_t *slaves; /**< Array of slaves on the bus. */

   116

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

   117

   118

    struct list_head configs; /**< List of slave configurations. */

   119

   120

    u64 app_time; /**< Time of the last ecrt_master_sync() call. */

   121

    u64 app_start_time; /**< Application start time. */

   122

    u8 has_start_time; /**< Start time already taken. */

   123

    ec_datagram_t ref_sync_datagram; /**< Datagram used for synchronizing the

   124

                                       reference clock to the master clock. */

   125

    ec_datagram_t sync_datagram; /**< Datagram used for DC drift

   126

                                   compensation. */

   127

    ec_slave_t *dc_ref_clock; /**< DC reference clock slave. */

   128

   129

    unsigned int scan_busy; /**< Current scan state. */

   130

    unsigned int allow_scan; /**< \a True, if slave scanning is allowed. */

   131

    struct semaphore scan_sem; /**< Semaphore protecting the \a scan_busy

   132

                                 variable and the \a allow_scan flag. */

   133

    wait_queue_head_t scan_queue; /**< Queue for processes that wait for

   134

                                    slave scanning. */

   135

   136

    unsigned int config_busy; /**< State of slave configuration. */

   137

    unsigned int allow_config; /**< \a True, if slave configuration is

   138

                                 allowed. */

   139

    struct semaphore config_sem; /**< Semaphore protecting the \a config_busy

   140

                                   variable and the allow_config flag. */

   141

    wait_queue_head_t config_queue; /**< Queue for processes that wait for

   142

                                      slave configuration. */

   143

   144

    struct list_head datagram_queue; /**< Datagram queue. */

   145

    uint8_t datagram_index; /**< Current datagram index. */

   146

   147

    struct list_head domains; /**< List of domains. */

   148

   149

    unsigned int debug_level; /**< Master debug level. */

   150

    ec_stats_t stats; /**< Cyclic statistics. */

   151

    unsigned int frames_timed_out; /**< There were frame timeouts in the last

   152

                                     call to ecrt_master_receive(). */

   153

   154

    struct task_struct *thread; /**< Master thread. */

   155

   156

#ifdef EC_EOE

   157

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

   158

    unsigned int eoe_running; /**< \a True, if EoE processing is active. */

   159

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

   160

#endif

   161

   162

    spinlock_t internal_lock; /**< Spinlock used in \a IDLE phase. */

   163

    int (*request_cb)(void *); /**< Lock request callback. */

   164

    void (*release_cb)(void *); /**< Lock release callback. */

   165

    void *cb_data; /**< Data parameter of locking callbacks. */

   166

    int (*ext_request_cb)(void *); /**< External lock request callback. */

   167

    void (*ext_release_cb)(void *); /**< External lock release callback. */

   168

    void *ext_cb_data; /**< Data parameter of external locking callbacks. */

   169

   170

    struct list_head sii_requests; /**< SII write requests. */

   171

    wait_queue_head_t sii_queue; /**< Wait queue for SII

   172

                                      write requests from user space. */

   173

   174

    struct list_head slave_sdo_requests; /**< SDO access requests. */

   175

    wait_queue_head_t sdo_queue; /**< Wait queue for SDO access requests

   176

                                   from user space. */

   177

   178

    struct list_head reg_requests; /**< Register requests. */

   179

    wait_queue_head_t reg_queue; /**< Wait queue for register requests. */

   180

   181

    struct list_head foe_requests; /**< FoE write requests. */

   182

    wait_queue_head_t foe_queue; /**< Wait queue for FoE

   183

                                      write requests from user space. */

   184

};

   185

   186

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

   187

   188

// static funtions

   189

void ec_master_init_static(void);

   190

   191

// master creation/deletion

   192

int ec_master_init(ec_master_t *, unsigned int, const uint8_t *,

   193

        const uint8_t *, dev_t, struct class *, unsigned int);

   194

void ec_master_clear(ec_master_t *);

   195

   196

// phase transitions

   197

int ec_master_enter_idle_phase(ec_master_t *);

   198

void ec_master_leave_idle_phase(ec_master_t *);

   199

int ec_master_enter_operation_phase(ec_master_t *);

   200

void ec_master_leave_operation_phase(ec_master_t *);

   201

   202

#ifdef EC_EOE

   203

// EoE

   204

void ec_master_eoe_start(ec_master_t *);

   205

void ec_master_eoe_stop(ec_master_t *);

   206

#endif

   207

   208

// datagram IO

   209

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

   210

void ec_master_queue_datagram(ec_master_t *, ec_datagram_t *);

   211

   212

// misc.

   213

void ec_master_attach_slave_configs(ec_master_t *);

   214

ec_slave_t *ec_master_find_slave(ec_master_t *, uint16_t, uint16_t);

   215

const ec_slave_t *ec_master_find_slave_const(const ec_master_t *, uint16_t,

   216

        uint16_t);

   217

void ec_master_output_stats(ec_master_t *);

   218

#ifdef EC_EOE

   219

void ec_master_clear_eoe_handlers(ec_master_t *);

   220

#endif

   221

void ec_master_clear_slaves(ec_master_t *);

   222

   223

unsigned int ec_master_config_count(const ec_master_t *);

   224

ec_slave_config_t *ec_master_get_config(

   225

        const ec_master_t *, unsigned int);

   226

const ec_slave_config_t *ec_master_get_config_const(

   227

        const ec_master_t *, unsigned int);

   228

unsigned int ec_master_domain_count(const ec_master_t *);

   229

ec_domain_t *ec_master_find_domain(ec_master_t *, unsigned int);

   230

const ec_domain_t *ec_master_find_domain_const(const ec_master_t *,

   231

        unsigned int);

   232

   233

int ec_master_debug_level(ec_master_t *, unsigned int);

   234

   235

ec_domain_t *ecrt_master_create_domain_err(ec_master_t *);

   236

ec_slave_config_t *ecrt_master_slave_config_err(ec_master_t *, uint16_t,

   237

        uint16_t, uint32_t, uint32_t);

   238

   239

void ec_master_calc_dc(ec_master_t *);

   240

   241

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

   242

   243

#endif