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

    46

#include <linux/timer.h>

    47

#include <linux/wait.h>

    48

#include <asm/semaphore.h>

    49

    50

#include "device.h"

    51

#include "domain.h"

    52

#include "fsm_master.h"

    53

    54

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

    55

    56

/**

    57

   EtherCAT master mode.

    58

*/

    59

    60

typedef enum

    61

{

    62

    EC_MASTER_MODE_ORPHANED,

    63

    EC_MASTER_MODE_IDLE,

    64

    EC_MASTER_MODE_OPERATION

    65

}

    66

ec_master_mode_t;

    67

    68

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

    69

    70

/**

    71

   Cyclic statistics.

    72

*/

    73

    74

typedef struct

    75

{

    76

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

    77

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

    78

    unsigned int skipped; /**< skipped datagrams (the ones that were

    79

                             requeued when not yet received) */

    80

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

    81

                               queued any longer) */

    82

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

    83

}

    84

ec_stats_t;

    85

    86

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

    87

    88

/**

    89

   EtherCAT master.

    90

   Manages slaves, domains and IO.

    91

*/

    92

    93

struct ec_master

    94

{

    95

    struct kobject kobj; /**< kobject */

    96

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

    97

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

    98

    99

    ec_device_t main_device; /**< EtherCAT device */

   100

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

   101

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

   102

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

   103

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

   104

   105

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

   106

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

   107

    ec_master_mode_t mode; /**< master mode */

   108

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

   109

                                      for the FSM side */

   110

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

   111

                                     for the realtime side */

   112

   113

    struct list_head slaves; /**< list of slaves on the bus */

   114

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

   115

   116

    ec_request_state_t scan_state; /**< current scanning state */

   117

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

   118

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

   119

                                 variable and the allow_scan flag */

   120

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

   121

                                    slave scanning */

   122

   123

    ec_request_state_t config_state; /**< state of slave configuration */

   124

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

   125

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

   126

                                   variable and the allow_config flag */

   127

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

   128

                                      slave configuration */

   129

   130

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

   131

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

   132

   133

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

   134

   135

    int debug_level; /**< master debug level */

   136

    ec_stats_t stats; /**< cyclic statistics */

   137

    unsigned int pdo_slaves_offline; /** number of slaves, for which PDOs

   138

                                       were registered and that are offline

   139

                                       (used for bus status) */

   140

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

   141

                                     call to ecrt_master_receive() */

   142

   143

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

   144

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

   145

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

   146

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

   147

   148

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

   149

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

   150

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

   151

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

   152

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

   153

   154

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

   155

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

   156

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

   157

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

   158

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

   159

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

   160

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

   161

   162

    struct list_head eeprom_requests; /**< EEPROM write requests */

   163

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

   164

                                   EEPROM write requests */

   165

    wait_queue_head_t eeprom_queue; /**< wait queue for EEPROM

   166

                                      write requests from user space */

   167

   168

    struct list_head sdo_requests; /**< SDO access requests */

   169

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

   170

                                   SDO access requests */

   171

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

   172

                                   from user space */

   173

};

   174

   175

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

   176

   177

// master creation/deletion

   178

int ec_master_init(ec_master_t *, struct kobject *, unsigned int,

   179

        const uint8_t *, const uint8_t *);

   180

void ec_master_clear(ec_master_t *);

   181

   182

// mode transitions

   183

int ec_master_enter_idle_mode(ec_master_t *);

   184

void ec_master_leave_idle_mode(ec_master_t *);

   185

int ec_master_enter_operation_mode(ec_master_t *);

   186

void ec_master_leave_operation_mode(ec_master_t *);

   187

   188

// EoE

   189

void ec_master_eoe_start(ec_master_t *);

   190

void ec_master_eoe_stop(ec_master_t *);

   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_output_stats(ec_master_t *);

   198

void ec_master_clear_eoe_handlers(ec_master_t *);

   199

void ec_master_destroy_slaves(ec_master_t *);

   200

   201

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

   202

   203

#endif