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

    49

#include <asm/semaphore.h>

    50

    51

#include "device.h"

    52

#include "device_id.h"

    53

#include "domain.h"

    54

#include "fsm_master.h"

    55

    56

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

    57

    58

/**

    59

   EtherCAT master mode.

    60

*/

    61

    62

typedef enum

    63

{

    64

    EC_MASTER_MODE_ORPHANED,

    65

    EC_MASTER_MODE_IDLE,

    66

    EC_MASTER_MODE_OPERATION

    67

}

    68

ec_master_mode_t;

    69

    70

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

    71

    72

/**

    73

   Cyclic statistics.

    74

*/

    75

    76

typedef struct

    77

{

    78

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

    79

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

    80

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

    81

                             requeued when not yet received) */

    82

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

    83

                               queued any longer) */

    84

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

    85

}

    86

ec_stats_t;

    87

    88

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

    89

    90

/**

    91

   EtherCAT master.

    92

   Manages slaves, domains and IO.

    93

*/

    94

    95

struct ec_master

    96

{

    97

    struct list_head list; /**< list item for module's master list */

    98

    atomic_t available; /**< zero, if the master is reserved for RT */

    99

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

   100

   101

    struct kobject kobj; /**< kobject */

   102

   103

    ec_device_t main_device; /**< EtherCAT device */

   104

    const ec_device_id_t *main_device_id; /**< ID of main device */

   105

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

   106

    const ec_device_id_t *backup_device_id; /**< ID of backup device */

   107

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

   108

   109

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

   110

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

   111

    ec_master_mode_t mode; /**< master mode */

   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

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

   117

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

   118

   119

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

   120

   121

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

   122

    ec_stats_t stats; /**< cyclic statistics */

   123

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

   124

                                       were registered and that are offline

   125

                                       (used for bus status) */

   126

   127

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

   128

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

   129

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

   130

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

   131

   132

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

   133

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

   134

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

   135

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

   136

    unsigned int eoe_checked; /**< non-zero, if EoE processing is not

   137

                                 necessary. */

   138

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

   139

   140

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

   141

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

   142

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

   143

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

   144

   145

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

   146

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

   147

                                   EEPROM write requests */

   148

    wait_queue_head_t eeprom_queue; /**< wait queue for EEPROM

   149

                                      write requests from user space */

   150

   151

    ec_sdo_request_t *sdo_request; /**< pointer to the current SDO request */

   152

    unsigned int sdo_seq_user; /**< sequence number for user space */

   153

    unsigned int sdo_seq_master; /**< sequence number for master */

   154

    struct semaphore sdo_sem; /**< SDO semaphore */

   155

    struct timer_list sdo_timer; /**< timer for polling sdo processing */

   156

    struct completion sdo_complete; /**< SDO request completion object */

   157

};

   158

   159

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

   160

   161

// master creation/deletion

   162

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

   163

        const ec_device_id_t *, const ec_device_id_t *, unsigned int);

   164

void ec_master_destroy(ec_master_t *);

   165

   166

// mode transitions

   167

int ec_master_enter_idle_mode(ec_master_t *);

   168

void ec_master_leave_idle_mode(ec_master_t *);

   169

int ec_master_enter_operation_mode(ec_master_t *);

   170

void ec_master_leave_operation_mode(ec_master_t *);

   171

   172

// EoE

   173

void ec_master_eoe_start(ec_master_t *);

   174

void ec_master_eoe_stop(ec_master_t *);

   175

   176

// datagram IO

   177

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

   178

void ec_master_queue_datagram(ec_master_t *, ec_datagram_t *);

   179

   180

// misc.

   181

void ec_master_output_stats(ec_master_t *);

   182

void ec_master_destroy_slaves(ec_master_t *);

   183

void ec_master_calc_addressing(ec_master_t *);

   184

   185

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

   186

   187

#endif