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 mode.

    57

 */

    58

typedef enum {

    59

    EC_MASTER_MODE_ORPHANED,

    60

    EC_MASTER_MODE_IDLE,

    61

    EC_MASTER_MODE_OPERATION

    62

} ec_master_mode_t;

    63

    64

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

    65

    66

/** Cyclic statistics.

    67

 */

    68

typedef struct {

    69

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

    70

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

    71

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

    72

                               queued any longer) */

    73

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

    74

} ec_stats_t;

    75

    76

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

    77

    78

/** EtherCAT master.

    79

 *

    80

 * Manages slaves, domains and IO.

    81

 */

    82

struct ec_master {

    83

    unsigned int index; /**< master index */

    84

    unsigned int reserved; /**< non-zero, if the master is reserved for RT */

    85

    86

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

    87

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

    88

    89

    ec_device_t main_device; /**< EtherCAT device */

    90

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

    91

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

    92

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

    93

    struct semaphore device_sem; /**< device semaphore */

    94

    95

    ec_fsm_master_t fsm; /**< master state machine */

    96

    ec_datagram_t fsm_datagram; /**< datagram used for state machines */

    97

    ec_master_mode_t mode; /**< master mode */

    98

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

    99

                                      for the FSM side */

   100

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

   101

                                     for the realtime side */

   102

   103

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

   104

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

   105

   106

    struct list_head configs; /**< Bus configuration list. */

   107

    unsigned int configs_attached; /**< Slave configurations were attached. */

   108

   109

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

   110

    unsigned int allow_scan; /**< non-zero, if slave scanning is allowed */

   111

    struct semaphore scan_sem; /**< semaphore protecting the scan_state

   112

                                 variable and the allow_scan flag */

   113

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

   114

                                    slave scanning */

   115

   116

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

   117

    unsigned int allow_config; /**< non-zero, if slave scanning is allowed */

   118

    struct semaphore config_sem; /**< semaphore protecting the config_state

   119

                                   variable and the allow_config flag */

   120

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

   121

                                      slave configuration */

   122

   123

    struct list_head datagram_queue; /**< datagram queue */

   124

    uint8_t datagram_index; /**< current datagram index */

   125

   126

    struct list_head domains; /**< list of domains */

   127

   128

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

   129

    ec_stats_t stats; /**< cyclic statistics */

   130

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

   131

                                     call to ecrt_master_receive() */

   132

   133

    int thread_id; /**< master thread PID */

   134

    struct completion thread_exit; /**< thread completion object */

   135

    uint32_t idle_cycle_times[HZ]; /**< Idle cycle times ring */

   136

    unsigned int idle_cycle_time_pos; /**< time ring buffer position */

   137

   138

#ifdef EC_EOE

   139

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

   140

    unsigned int eoe_running; /**< non-zero, if EoE processing is active. */

   141

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

   142

    uint32_t eoe_cycle_times[HZ]; /**< EoE cycle times ring */

   143

    unsigned int eoe_cycle_time_pos; /**< time ring buffer position */

   144

#endif

   145

   146

    spinlock_t internal_lock; /**< spinlock used in idle mode */

   147

    int (*request_cb)(void *); /**< lock request callback */

   148

    void (*release_cb)(void *); /**< lock release callback */

   149

    void *cb_data; /**< data parameter of locking callbacks */

   150

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

   151

    void (*ext_release_cb)(void *); /**< externam lock release callback */

   152

    void *ext_cb_data; /**< data parameter of external locking callbacks */

   153

   154

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

   155

    struct semaphore sii_sem; /**< semaphore protecting the list of

   156

                                   SII write requests */

   157

    wait_queue_head_t sii_queue; /**< wait queue for SII

   158

                                      write requests from user space */

   159

   160

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

   161

    struct semaphore sdo_sem; /**< semaphore protecting the list of

   162

                                   Sdo access requests */

   163

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

   164

                                   from user space */

   165

};

   166

   167

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

   168

   169

// master creation/deletion

   170

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

   171

        const uint8_t *, dev_t, struct class *);

   172

void ec_master_clear(ec_master_t *);

   173

   174

// mode transitions

   175

int ec_master_enter_idle_mode(ec_master_t *);

   176

void ec_master_leave_idle_mode(ec_master_t *);

   177

int ec_master_enter_operation_mode(ec_master_t *);

   178

void ec_master_leave_operation_mode(ec_master_t *);

   179

   180

#ifdef EC_EOE

   181

// EoE

   182

void ec_master_eoe_start(ec_master_t *);

   183

void ec_master_eoe_stop(ec_master_t *);

   184

#endif

   185

   186

// datagram IO

   187

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

   188

void ec_master_queue_datagram(ec_master_t *, ec_datagram_t *);

   189

   190

// misc.

   191

int ec_master_attach_slave_configs(ec_master_t *);

   192

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

   193

void ec_master_output_stats(ec_master_t *);

   194

#ifdef EC_EOE

   195

void ec_master_clear_eoe_handlers(ec_master_t *);

   196

#endif

   197

void ec_master_clear_slaves(ec_master_t *);

   198

   199

unsigned int ec_master_config_count(const ec_master_t *);

   200

const ec_slave_config_t *ec_master_get_config_const(

   201

        const ec_master_t *, unsigned int);

   202

unsigned int ec_master_domain_count(const ec_master_t *);

   203

ec_domain_t *ec_master_find_domain(ec_master_t *, unsigned int);

   204

   205

int ec_master_debug_level(ec_master_t *, int);

   206

   207

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

   208

   209

#endif