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

/** Convenience macro for printing master-specific information to syslog.

    61

 *

    62

 * This will print the message in \a fmt with a prefixed "EtherCAT <INDEX>: ",

    63

 * where INDEX is the master index.

    64

 *

    65

 * \param master EtherCAT master

    66

 * \param fmt format string (like in printf())

    67

 * \param args arguments (optional)

    68

 */

    69

#define EC_MASTER_INFO(master, fmt, args...) \

    70

    printk(KERN_INFO "EtherCAT %u: " fmt, master->index, ##args)

    71

    72

/** Convenience macro for printing master-specific errors to syslog.

    73

 *

    74

 * This will print the message in \a fmt with a prefixed "EtherCAT <INDEX>: ",

    75

 * where INDEX is the master index.

    76

 *

    77

 * \param master EtherCAT master

    78

 * \param fmt format string (like in printf())

    79

 * \param args arguments (optional)

    80

 */

    81

#define EC_MASTER_ERR(master, fmt, args...) \

    82

    printk(KERN_ERR "EtherCAT ERROR %u: " fmt, master->index, ##args)

    83

    84

/** Convenience macro for printing master-specific warnings to syslog.

    85

 *

    86

 * This will print the message in \a fmt with a prefixed "EtherCAT <INDEX>: ",

    87

 * where INDEX is the master index.

    88

 *

    89

 * \param master EtherCAT master

    90

 * \param fmt format string (like in printf())

    91

 * \param args arguments (optional)

    92

 */

    93

#define EC_MASTER_WARN(master, fmt, args...) \

    94

    printk(KERN_WARNING "EtherCAT WARNING %u: " fmt, master->index, ##args)

    95

    96

/** Convenience macro for printing master-specific debug messages to syslog.

    97

 *

    98

 * This will print the message in \a fmt with a prefixed "EtherCAT <INDEX>: ",

    99

 * where INDEX is the master index.

   100

 *

   101

 * \param master EtherCAT master

   102

 * \param fmt format string (like in printf())

   103

 * \param args arguments (optional)

   104

 */

   105

#define EC_MASTER_DBG(master, level, fmt, args...) \

   106

    do { \

   107

        if (master->debug_level >= level) { \

   108

            printk(KERN_DEBUG "EtherCAT DEBUG %u: " fmt, \

   109

                    master->index, ##args); \

   110

        } \

   111

    } while (0)

   112

   113

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

   114

   115

/** EtherCAT master phase.

   116

 */

   117

typedef enum {

   118

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

   119

                   attached. */

   120

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

   121

               is not in use, yet. */

   122

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

   123

                   application. */

   124

} ec_master_phase_t;

   125

   126

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

   127

   128

/** Cyclic statistics.

   129

 */

   130

typedef struct {

   131

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

   132

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

   133

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

   134

                               queued any longer) */

   135

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

   136

} ec_stats_t;

   137

   138

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

   139

   140

/** EtherCAT master.

   141

 *

   142

 * Manages slaves, domains and IO.

   143

 */

   144

struct ec_master {

   145

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

   146

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

   147

   148

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

   149

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

   150

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

   151

#else

   152

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

   153

#endif

   154

   155

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

   156

   157

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

   158

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

   159

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

   160

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

   161

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

   162

   163

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

   164

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

   165

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

   166

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

   167

    unsigned int config_changed; /**< The configuration changed. */

   168

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

   169

                                      for the FSM side. */

   170

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

   171

                                     for the realtime side. */

   172

   173

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

   174

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

   175

   176

    /* Configuration applied by the application. */

   177

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

   178

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

   179

   180

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

   181

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

   182

    u8 has_app_time; /**< Application time is valid. */

   183

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

   184

                                       reference clock to the master clock. */

   185

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

   186

                                   compensation. */

   187

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

   188

                                       monitoring. */

   189

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

   190

   191

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

   192

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

   193

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

   194

                                 variable and the \a allow_scan flag. */

   195

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

   196

                                    slave scanning. */

   197

   198

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

   199

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

   200

                                   variable and the allow_config flag. */

   201

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

   202

                                      slave configuration. */

   203

   204

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

   205

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

   206

   207

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

   208

                                           datagrams. */

   209

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

   210

                                      ext_datagram_queue. */

   211

   212

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

   213

    unsigned int send_interval; /**< Interval between calls to ecrt_master_send */

   214

    size_t max_queue_size; /**< Maximum size of datagram queue */

   215

   216

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

   217

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

   218

   219

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

   220

   221

#ifdef EC_EOE

   222

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

   223

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

   224

#endif

   225

   226

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

   227

   228

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

   229

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

   230

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

   231

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

   232

                                          callback. */

   233

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

   234

                                      callback. */

   235

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

   236

   237

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

   238

    wait_queue_head_t sii_queue; /**< Wait queue for SII

   239

                                      write requests from user space. */

   240

   241

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

   242

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

   243

};

   244

   245

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

   246

   247

// static funtions

   248

void ec_master_init_static(void);

   249

   250

// master creation/deletion

   251

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

   252

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

   253

void ec_master_clear(ec_master_t *);

   254

   255

// phase transitions

   256

int ec_master_enter_idle_phase(ec_master_t *);

   257

void ec_master_leave_idle_phase(ec_master_t *);

   258

int ec_master_enter_operation_phase(ec_master_t *);

   259

void ec_master_leave_operation_phase(ec_master_t *);

   260

   261

#ifdef EC_EOE

   262

// EoE

   263

void ec_master_eoe_start(ec_master_t *);

   264

void ec_master_eoe_stop(ec_master_t *);

   265

#endif

   266

   267

// datagram IO

   268

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

   269

void ec_master_queue_datagram(ec_master_t *, ec_datagram_t *);

   270

void ec_master_queue_datagram_ext(ec_master_t *, ec_datagram_t *);

   271

void ec_master_queue_external_datagram(ec_master_t *, ec_datagram_t *);

   272

void ec_master_inject_external_datagrams(ec_master_t *);

   273

   274

// misc.

   275

void ec_master_set_send_interval(ec_master_t *, unsigned int);

   276

void ec_master_attach_slave_configs(ec_master_t *);

   277

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

   278

const ec_slave_t *ec_master_find_slave_const(const ec_master_t *, uint16_t,

   279

        uint16_t);

   280

void ec_master_output_stats(ec_master_t *);

   281

#ifdef EC_EOE

   282

void ec_master_clear_eoe_handlers(ec_master_t *);

   283

#endif

   284

void ec_master_clear_slaves(ec_master_t *);

   285

   286

unsigned int ec_master_config_count(const ec_master_t *);

   287

ec_slave_config_t *ec_master_get_config(

   288

        const ec_master_t *, unsigned int);

   289

const ec_slave_config_t *ec_master_get_config_const(

   290

        const ec_master_t *, unsigned int);

   291

unsigned int ec_master_domain_count(const ec_master_t *);

   292

ec_domain_t *ec_master_find_domain(ec_master_t *, unsigned int);

   293

const ec_domain_t *ec_master_find_domain_const(const ec_master_t *,

   294

        unsigned int);

   295

#ifdef EC_EOE

   296

uint16_t ec_master_eoe_handler_count(const ec_master_t *);

   297

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

   298

#endif

   299

   300

int ec_master_debug_level(ec_master_t *, unsigned int);

   301

   302

ec_domain_t *ecrt_master_create_domain_err(ec_master_t *);

   303

ec_slave_config_t *ecrt_master_slave_config_err(ec_master_t *, uint16_t,

   304

        uint16_t, uint32_t, uint32_t);

   305

   306

void ec_master_calc_dc(ec_master_t *);

   307

void ec_master_request_op(ec_master_t *);

   308

   309

void ec_master_internal_send_cb(void *);

   310

void ec_master_internal_receive_cb(void *);

   311

   312

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

   313

   314

#endif