1

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

     2

 *

     3

 *  $Id$

     4

 *

     5

 *  Copyright (C) 2006-2012  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

#ifdef EC_RTDM

    59

#include "rtdm.h"

    60

#endif

    61

    62

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

    63

    64

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

    65

 *

    66

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

    67

 * where INDEX is the master index.

    68

 *

    69

 * \param master EtherCAT master

    70

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

    71

 * \param args arguments (optional)

    72

 */

    73

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

    74

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

    75

    76

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

    77

 *

    78

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

    79

 * where INDEX is the master index.

    80

 *

    81

 * \param master EtherCAT master

    82

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

    83

 * \param args arguments (optional)

    84

 */

    85

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

    86

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

    87

    88

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

    89

 *

    90

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

    91

 * where INDEX is the master index.

    92

 *

    93

 * \param master EtherCAT master

    94

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

    95

 * \param args arguments (optional)

    96

 */

    97

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

    98

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

    99

   100

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

   101

 *

   102

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

   103

 * where INDEX is the master index.

   104

 *

   105

 * \param master EtherCAT master

   106

 * \param level Debug level. Master's debug level must be >= \a level for

   107

 * output.

   108

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

   109

 * \param args arguments (optional)

   110

 */

   111

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

   112

    do { \

   113

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

   114

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

   115

                    master->index, ##args); \

   116

        } \

   117

    } while (0)

   118

   119

   120

/** Size of the external datagram ring.

   121

 *

   122

 * The external datagram ring is used for slave FSMs.

   123

 */

   124

#define EC_EXT_RING_SIZE 32

   125

   126

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

   127

   128

/** EtherCAT master phase.

   129

 */

   130

typedef enum {

   131

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

   132

                   attached. */

   133

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

   134

               is not in use, yet. */

   135

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

   136

                   application. */

   137

} ec_master_phase_t;

   138

   139

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

   140

   141

/** Cyclic statistics.

   142

 */

   143

typedef struct {

   144

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

   145

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

   146

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

   147

                               queued any longer) */

   148

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

   149

} ec_stats_t;

   150

   151

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

   152

   153

/** Device statistics.

   154

 */

   155

typedef struct {

   156

    u64 tx_count; /**< Number of frames sent. */

   157

    u64 last_tx_count; /**< Number of frames sent of last statistics cycle. */

   158

    u64 rx_count; /**< Number of frames received. */

   159

    u64 last_rx_count; /**< Number of frames received of last statistics

   160

                         cycle. */

   161

    u64 tx_bytes; /**< Number of bytes sent. */

   162

    u64 last_tx_bytes; /**< Number of bytes sent of last statistics cycle. */

   163

    u64 rx_bytes; /**< Number of bytes received. */

   164

    u64 last_rx_bytes; /**< Number of bytes received of last statistics cycle.

   165

                        */

   166

    u64 last_loss; /**< Tx/Rx difference of last statistics cycle. */

   167

    s32 tx_frame_rates[EC_RATE_COUNT]; /**< Transmit rates in frames/s for

   168

                                         different statistics cycle periods.

   169

                                        */

   170

    s32 rx_frame_rates[EC_RATE_COUNT]; /**< Receive rates in frames/s for

   171

                                         different statistics cycle periods.

   172

                                        */

   173

    s32 tx_byte_rates[EC_RATE_COUNT]; /**< Transmit rates in byte/s for

   174

                                        different statistics cycle periods. */

   175

    s32 rx_byte_rates[EC_RATE_COUNT]; /**< Receive rates in byte/s for

   176

                                        different statistics cycle periods. */

   177

    s32 loss_rates[EC_RATE_COUNT]; /**< Frame loss rates for different

   178

                                     statistics cycle periods. */

   179

    unsigned long jiffies; /**< Jiffies of last statistic cycle. */

   180

} ec_device_stats_t;

   181

   182

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

   183

   184

#if EC_MAX_NUM_DEVICES < 1

   185

#error Invalid number of devices

   186

#endif

   187

   188

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

   189

   190

/** EtherCAT master.

   191

 *

   192

 * Manages slaves, domains and IO.

   193

 */

   194

struct ec_master {

   195

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

   196

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

   197

   198

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

   199

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

   200

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

   201

#else

   202

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

   203

#endif

   204

   205

#ifdef EC_RTDM

   206

    ec_rtdm_dev_t rtdm_dev; /**< RTDM device. */

   207

#endif

   208

   209

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

   210

   211

    ec_device_t devices[EC_MAX_NUM_DEVICES]; /**< EtherCAT devices. */

   212

    const uint8_t *macs[EC_MAX_NUM_DEVICES]; /**< Device MAC addresses. */

   213

#if EC_MAX_NUM_DEVICES > 1

   214

    unsigned int num_devices; /**< Number of devices. Access this always via

   215

                                ec_master_num_devices(), because it may be

   216

                                optimized! */

   217

#endif

   218

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

   219

    ec_device_stats_t device_stats; /**< Device statistics. */

   220

   221

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

   222

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

   223

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

   224

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

   225

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

   226

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

   227

                                      for the FSM side. */

   228

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

   229

                                     for the realtime side. */

   230

   231

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

   232

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

   233

   234

    /* Configuration applied by the application. */

   235

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

   236

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

   237

   238

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

   239

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

   240

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

   241

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

   242

                                       reference clock to the master clock. */

   243

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

   244

                                   compensation. */

   245

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

   246

                                       monitoring. */

   247

    ec_slave_config_t *dc_ref_config; /**< Application-selected DC reference

   248

                                        clock slave config. */

   249

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

   250

   251

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

   252

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

   253

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

   254

                                 variable and the \a allow_scan flag. */

   255

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

   256

                                    slave scanning. */

   257

   258

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

   259

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

   260

                                   variable and the allow_config flag. */

   261

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

   262

                                      slave configuration. */

   263

   264

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

   265

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

   266

   267

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

   268

                                           datagrams. */

   269

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

   270

                                      ext_datagram_queue. */

   271

   272

    ec_datagram_t ext_datagram_ring[EC_EXT_RING_SIZE]; /**< External datagram

   273

                                                         ring. */

   274

    unsigned int ext_ring_idx_rt; /**< Index in external datagram ring for RT

   275

                                    side. */

   276

    unsigned int ext_ring_idx_fsm; /**< Index in external datagram ring for

   277

                                     FSM side. */

   278

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

   279

                                  ecrt_master_send(). */

   280

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

   281

   282

    ec_slave_t *fsm_slave; /**< Slave that is queried next for FSM exec. */

   283

    struct list_head fsm_exec_list; /**< Slave FSM execution list. */

   284

    unsigned int fsm_exec_count; /**< Number of entries in execution list. */

   285

   286

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

   287

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

   288

   289

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

   290

   291

#ifdef EC_EOE

   292

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

   293

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

   294

#endif

   295

   296

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

   297

   298

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

   299

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

   300

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

   301

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

   302

                                          callback. */

   303

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

   304

                                      callback. */

   305

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

   306

   307

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

   308

    struct list_head emerg_reg_requests; /**< Emergency register access

   309

                                           requests. */

   310

   311

    wait_queue_head_t request_queue; /**< Wait queue for external requests

   312

                                       from user space. */

   313

};

   314

   315

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

   316

   317

// static funtions

   318

void ec_master_init_static(void);

   319

   320

// master creation/deletion

   321

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

   322

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

   323

void ec_master_clear(ec_master_t *);

   324

   325

/** Number of Ethernet devices.

   326

 */

   327

#if EC_MAX_NUM_DEVICES > 1

   328

#define ec_master_num_devices(MASTER) ((MASTER)->num_devices)

   329

#else

   330

#define ec_master_num_devices(MASTER) 1

   331

#endif

   332

   333

// phase transitions

   334

int ec_master_enter_idle_phase(ec_master_t *);

   335

void ec_master_leave_idle_phase(ec_master_t *);

   336

int ec_master_enter_operation_phase(ec_master_t *);

   337

void ec_master_leave_operation_phase(ec_master_t *);

   338

   339

#ifdef EC_EOE

   340

// EoE

   341

void ec_master_eoe_start(ec_master_t *);

   342

void ec_master_eoe_stop(ec_master_t *);

   343

#endif

   344

   345

// datagram IO

   346

void ec_master_receive_datagrams(ec_master_t *, ec_device_t *,

   347

        const uint8_t *, size_t);

   348

void ec_master_queue_datagram(ec_master_t *, ec_datagram_t *);

   349

void ec_master_queue_datagram_ext(ec_master_t *, ec_datagram_t *);

   350

   351

// misc.

   352

void ec_master_set_send_interval(ec_master_t *, unsigned int);

   353

void ec_master_attach_slave_configs(ec_master_t *);

   354

void ec_master_expire_slave_config_requests(ec_master_t *);

   355

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

   356

const ec_slave_t *ec_master_find_slave_const(const ec_master_t *, uint16_t,

   357

        uint16_t);

   358

void ec_master_output_stats(ec_master_t *);

   359

#ifdef EC_EOE

   360

void ec_master_clear_eoe_handlers(ec_master_t *);

   361

#endif

   362

void ec_master_clear_slaves(ec_master_t *);

   363

   364

unsigned int ec_master_config_count(const ec_master_t *);

   365

ec_slave_config_t *ec_master_get_config(

   366

        const ec_master_t *, unsigned int);

   367

const ec_slave_config_t *ec_master_get_config_const(

   368

        const ec_master_t *, unsigned int);

   369

unsigned int ec_master_domain_count(const ec_master_t *);

   370

ec_domain_t *ec_master_find_domain(ec_master_t *, unsigned int);

   371

const ec_domain_t *ec_master_find_domain_const(const ec_master_t *,

   372

        unsigned int);

   373

#ifdef EC_EOE

   374

uint16_t ec_master_eoe_handler_count(const ec_master_t *);

   375

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

   376

#endif

   377

   378

int ec_master_debug_level(ec_master_t *, unsigned int);

   379

   380

ec_domain_t *ecrt_master_create_domain_err(ec_master_t *);

   381

ec_slave_config_t *ecrt_master_slave_config_err(ec_master_t *, uint16_t,

   382

        uint16_t, uint32_t, uint32_t);

   383

   384

void ec_master_calc_dc(ec_master_t *);

   385

void ec_master_request_op(ec_master_t *);

   386

   387

void ec_master_internal_send_cb(void *);

   388

void ec_master_internal_receive_cb(void *);

   389

   390

extern const unsigned int rate_intervals[EC_RATE_COUNT]; // see master.c

   391

   392

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

   393

   394

#endif