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 "ethernet.h"

    55

#include "fsm_master.h"

    56

#include "cdev.h"

    57

    58

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

    59

    60

/** EtherCAT master phase.

    61

 */

    62

typedef enum {

    63

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

    64

                   attached. */

    65

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

    66

               is not in use, yet. */

    67

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

    68

                   application. */

    69

} ec_master_phase_t;

    70

    71

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

    72

    73

/** Cyclic statistics.

    74

 */

    75

typedef struct {

    76

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

    77

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

    78

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

    79

                               queued any longer) */

    80

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

    81

} ec_stats_t;

    82

    83

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

    84

    85

/** EtherCAT master.

    86

 *

    87

 * Manages slaves, domains and IO.

    88

 */

    89

struct ec_master {

    90

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

    91

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

    92

    93

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

    94

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

    95

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

    96

#else

    97

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

    98

#endif

    99

   100

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

   101

   102

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

   103

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

   104

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

   105

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

   106

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

   107

   108

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

   109

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

   110

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

   111

    unsigned int active; /**< Master has been activated. */

   112

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

   113

                                      for the FSM side. */

   114

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

   115

                                     for the realtime side. */

   116

   117

   118

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

   119

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

   120

   121

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

   122

   123

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

   124

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

   125

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

   126

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

   127

                                       reference clock to the master clock. */

   128

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

   129

                                   compensation. */

   130

    ec_datagram_t sync_mon_datagram; /**< Datagram used for DC synchronisation

   131

                                       monitoring. */

   132

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

   133

   134

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

   135

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

   136

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

   137

                                 variable and the \a allow_scan flag. */

   138

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

   139

                                    slave scanning. */

   140

   141

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

   142

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

   143

                                 allowed. */

   144

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

   145

                                   variable and the allow_config flag. */

   146

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

   147

                                      slave configuration. */

   148

   149

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

   150

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

   151

   152

    struct list_head ext_datagram_queue; /**< Queue for non-application

   153

                                           datagrams. */

   154

    struct semaphore ext_queue_sem; /**< Semaphore protecting the \a

   155

                                      ext_datagram_queue. */

   156

   157

    struct list_head external_datagram_queue; /**< External Datagram queue. */

   158

    size_t send_interval; /* interval between calls to ecrt_master_send */

   159

    size_t max_queue_size; /** max. size of datagram queue */

   160

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

   161

   162

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

   163

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

   164

   165

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

   166

   167

#ifdef EC_EOE

   168

    struct task_struct *eoe_thread; /**< EoE thread. */

   169

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

   170

#endif

   171

   172

    struct semaphore io_sem; /**< Semaphore used in \a IDLE phase. */

   173

   174

    void (*send_cb)(void *); /**< Current send datagrams callback. */

   175

    void (*receive_cb)(void *); /**< Current receive datagrams callback. */

   176

    void *cb_data; /**< Current callback data. */

   177

    void (*app_send_cb)(void *); /**< Application's send datagrams

   178

                                          callback. */

   179

    void (*app_receive_cb)(void *); /**< Application's receive datagrams

   180

                                      callback. */

   181

    void *app_cb_data; /**< Application callback data. */

   182

   183

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

   184

    wait_queue_head_t sii_queue; /**< Wait queue for SII

   185

                                      write requests from user space. */

   186

   187

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

   188

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

   189

   190

};

   191

   192

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

   193

   194

// static funtions

   195

void ec_master_init_static(void);

   196

   197

// master creation/deletion

   198

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

   199

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

   200

void ec_master_clear(ec_master_t *);

   201

   202

// phase transitions

   203

int ec_master_enter_idle_phase(ec_master_t *);

   204

void ec_master_leave_idle_phase(ec_master_t *);

   205

int ec_master_enter_operation_phase(ec_master_t *);

   206

void ec_master_leave_operation_phase(ec_master_t *);

   207

   208

#ifdef EC_EOE

   209

// EoE

   210

void ec_master_eoe_start(ec_master_t *);

   211

void ec_master_eoe_stop(ec_master_t *);

   212

#endif

   213

   214

// datagram IO

   215

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

   216

void ec_master_queue_datagram(ec_master_t *, ec_datagram_t *);

   217

void ec_master_queue_datagram_ext(ec_master_t *, ec_datagram_t *);

   218

void ec_master_queue_external_datagram(ec_master_t *, ec_datagram_t *);

   219

void ec_master_inject_external_datagrams(ec_master_t *);

   220

   221

// misc.

   222

void ec_master_set_send_interval(ec_master_t *,size_t);

   223

void ec_master_attach_slave_configs(ec_master_t *);

   224

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

   225

const ec_slave_t *ec_master_find_slave_const(const ec_master_t *, uint16_t,

   226

        uint16_t);

   227

void ec_master_output_stats(ec_master_t *);

   228

#ifdef EC_EOE

   229

void ec_master_clear_eoe_handlers(ec_master_t *);

   230

#endif

   231

void ec_master_clear_slaves(ec_master_t *);

   232

   233

unsigned int ec_master_config_count(const ec_master_t *);

   234

ec_slave_config_t *ec_master_get_config(

   235

        const ec_master_t *, unsigned int);

   236

const ec_slave_config_t *ec_master_get_config_const(

   237

        const ec_master_t *, unsigned int);

   238

unsigned int ec_master_domain_count(const ec_master_t *);

   239

ec_domain_t *ec_master_find_domain(ec_master_t *, unsigned int);

   240

const ec_domain_t *ec_master_find_domain_const(const ec_master_t *,

   241

        unsigned int);

   242

#ifdef EC_EOE

   243

uint16_t ec_master_eoe_handler_count(const ec_master_t *);

   244

const ec_eoe_t *ec_master_get_eoe_handler_const(const ec_master_t *, uint16_t);

   245

#endif

   246

   247

int ec_master_debug_level(ec_master_t *, unsigned int);

   248

   249

ec_domain_t *ecrt_master_create_domain_err(ec_master_t *);

   250

ec_slave_config_t *ecrt_master_slave_config_err(ec_master_t *, uint16_t,

   251

        uint16_t, uint32_t, uint32_t);

   252

   253

void ec_master_calc_dc(ec_master_t *);

   254

   255

void ec_master_internal_send_cb(void *);

   256

void ec_master_internal_receive_cb(void *);

   257

   258

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

   259

   260

#endif