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/timer.h>

    46

#include <linux/wait.h>

    47

#include <asm/semaphore.h>

    48

    49

#include "device.h"

    50

#include "domain.h"

    51

#include "fsm_master.h"

    52

#include "cdev.h"

    53

    54

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

    55

    56

/** EtherCAT master phase.

    57

 */

    58

typedef enum {

    59

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

    60

                   attached. */

    61

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

    62

               is not in use, yet. */

    63

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

    64

                   application. */

    65

} ec_master_phase_t;

    66

    67

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

    68

    69

/** Cyclic statistics.

    70

 */

    71

typedef struct {

    72

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

    73

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

    74

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

    75

                               queued any longer) */

    76

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

    77

} ec_stats_t;

    78

    79

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

    80

    81

/** EtherCAT master.

    82

 *

    83

 * Manages slaves, domains and IO.

    84

 */

    85

struct ec_master {

    86

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

    87

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

    88

    89

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

    90

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

    91

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

    92

    93

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

    94

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

    95

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

    96

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

    97

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

    98

    99

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

   100

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

   101

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

   102

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

   103

                                      for the FSM side. */

   104

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

   105

                                     for the realtime side. */

   106

   107

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

   108

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

   109

   110

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

   111

   112

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

   113

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

   114

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

   115

                                 variable and the \a allow_scan flag. */

   116

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

   117

                                    slave scanning. */

   118

   119

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

   120

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

   121

                                 allowed. */

   122

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

   123

                                   variable and the allow_config flag. */

   124

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

   125

                                      slave configuration. */

   126

   127

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

   128

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

   129

   130

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

   131

   132

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

   133

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

   134

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

   135

                                     call to ecrt_master_receive(). */

   136

   137

    int thread_id; /**< Master thread PID. */

   138

    struct completion thread_can_terminate; /**< Thread termination completion

   139

                                              object. When stopping the

   140

                                              thread, it must be assured, that

   141

                                              it 'hears' a SIGTERM, therefore

   142

                                              the allow_singal() function must

   143

                                              have been called.

   144

                                             */

   145

    struct completion thread_exit; /**< Thread completion object. */

   146

   147

#ifdef EC_EOE

   148

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

   149

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

   150

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

   151

#endif

   152

   153

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

   154

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

   155

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

   156

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

   157

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

   158

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

   159

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

   160

   161

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

   162

    wait_queue_head_t sii_queue; /**< Wait queue for SII

   163

                                      write requests from user space. */

   164

   165

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

   166

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

   167

                                   from user space. */

   168

   169

    struct list_head phy_requests; /**< Physical memory requests. */

   170

    wait_queue_head_t phy_queue; /**< Wait queue for phy requests. */

   171

};

   172

   173

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

   174

   175

// master creation/deletion

   176

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

   177

        const uint8_t *, dev_t, struct class *);

   178

void ec_master_clear(ec_master_t *);

   179

   180

// phase transitions

   181

int ec_master_enter_idle_phase(ec_master_t *);

   182

void ec_master_leave_idle_phase(ec_master_t *);

   183

int ec_master_enter_operation_phase(ec_master_t *);

   184

void ec_master_leave_operation_phase(ec_master_t *);

   185

   186

#ifdef EC_EOE

   187

// EoE

   188

void ec_master_eoe_start(ec_master_t *);

   189

void ec_master_eoe_stop(ec_master_t *);

   190

#endif

   191

   192

// datagram IO

   193

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

   194

void ec_master_queue_datagram(ec_master_t *, ec_datagram_t *);

   195

   196

// misc.

   197

void ec_master_attach_slave_configs(ec_master_t *);

   198

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

   199

const ec_slave_t *ec_master_find_slave_const(const ec_master_t *, uint16_t,

   200

        uint16_t);

   201

void ec_master_output_stats(ec_master_t *);

   202

#ifdef EC_EOE

   203

void ec_master_clear_eoe_handlers(ec_master_t *);

   204

#endif

   205

void ec_master_clear_slaves(ec_master_t *);

   206

   207

unsigned int ec_master_config_count(const ec_master_t *);

   208

const ec_slave_config_t *ec_master_get_config_const(

   209

        const ec_master_t *, unsigned int);

   210

unsigned int ec_master_domain_count(const ec_master_t *);

   211

ec_domain_t *ec_master_find_domain(ec_master_t *, unsigned int);

   212

const ec_domain_t *ec_master_find_domain_const(const ec_master_t *,

   213

        unsigned int);

   214

   215

int ec_master_debug_level(ec_master_t *, int);

   216

   217

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

   218

   219

#endif