1

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

     2

 *

     3

 *  RTAI sample for the IgH EtherCAT master.

     4

 *

     5

 *  $Id$

     6

 *

     7

 *  Copyright (C) 2006  Florian Pose, Ingenieurgemeinschaft IgH

     8

 *

     9

 *  This file is part of the IgH EtherCAT Master.

    10

 *

    11

 *  The IgH EtherCAT Master is free software; you can redistribute it

    12

 *  and/or modify it under the terms of the GNU General Public License

    13

 *  as published by the Free Software Foundation; either version 2 of the

    14

 *  License, or (at your option) any later version.

    15

 *

    16

 *  The IgH EtherCAT Master is distributed in the hope that it will be

    17

 *  useful, but WITHOUT ANY WARRANTY; without even the implied warranty of

    18

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    19

 *  GNU General Public License for more details.

    20

 *

    21

 *  You should have received a copy of the GNU General Public License

    22

 *  along with the IgH EtherCAT Master; if not, write to the Free Software

    23

 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

    24

 *

    25

 *  The right to use EtherCAT Technology is granted and comes free of

    26

 *  charge under condition of compatibility of product made by

    27

 *  Licensee. People intending to distribute/sell products based on the

    28

 *  code, have to sign an agreement to guarantee that products using

    29

 *  software based on IgH EtherCAT master stay compatible with the actual

    30

 *  EtherCAT specification (which are released themselves as an open

    31

 *  standard) as the (only) precondition to have the right to use EtherCAT

    32

 *  Technology, IP and trade marks.

    33

 *

    34

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

    35

    36

// Linux

    37

#include <linux/module.h>

    38

    39

// RTAI

    40

#include "rtai_sched.h"

    41

#include "rtai_sem.h"

    42

    43

// EtherCAT

    44

#include "../../include/ecrt.h"

    45

#include "../../include/ecdb.h"

    46

    47

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

    48

    49

MODULE_LICENSE("GPL");

    50

MODULE_AUTHOR("Florian Pose <fp@igh-essen.com>");

    51

MODULE_DESCRIPTION("EtherCAT RTAI sample module");

    52

    53

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

    54

    55

// RTAI task frequency in Hz

    56

#define FREQUENCY 10000

    57

#define INHIBIT_TIME 20

    58

    59

#define TIMERTICKS (1000000000 / FREQUENCY)

    60

    61

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

    62

    63

// RTAI

    64

RT_TASK task;

    65

SEM master_sem;

    66

cycles_t t_last_cycle = 0, t_critical;

    67

    68

// EtherCAT

    69

ec_master_t *master = NULL;

    70

ec_domain_t *domain1 = NULL;

    71

    72

// data fields

    73

void *r_ana_out;

    74

    75

// channels

    76

uint32_t k_pos;

    77

    78

ec_pdo_reg_t domain1_pdos[] = {

    79

    {"2", Beckhoff_EL4132_Output1, &r_ana_out},

    80

    {}

    81

};

    82

    83

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

    84

    85

void run(long data)

    86

{

    87

    while (1)

    88

    {

    89

        t_last_cycle = get_cycles();

    90

        rt_sem_wait(&master_sem);

    91

    92

        ecrt_master_receive(master);

    93

        ecrt_domain_process(domain1);

    94

    95

        // process data

    96

        //k_pos = EC_READ_U32(r_ssi_input);

    97

    98

        ecrt_master_run(master);

    99

        ecrt_master_send(master);

   100

   101

        rt_sem_signal(&master_sem);

   102

        rt_task_wait_period();

   103

    }

   104

}

   105

   106

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

   107

   108

int request_lock(void *data)

   109

{

   110

    // too close to the next RT cycle: deny access...

   111

    if (get_cycles() - t_last_cycle > t_critical) return -1;

   112

   113

    // allow access

   114

    rt_sem_wait(&master_sem);

   115

    return 0;

   116

}

   117

   118

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

   119

   120

void release_lock(void *data)

   121

{

   122

    rt_sem_signal(&master_sem);

   123

}

   124

   125

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

   126

   127

int __init init_mod(void)

   128

{

   129

    RTIME tick_period, requested_ticks, now;

   130

   131

    printk(KERN_INFO "=== Starting EtherCAT RTAI sample module... ===\n");

   132

   133

    rt_sem_init(&master_sem, 1);

   134

   135

    t_critical = cpu_khz * 1000 / FREQUENCY - cpu_khz * INHIBIT_TIME / 1000;

   136

   137

    if (!(master = ecrt_request_master(0))) {

   138

        printk(KERN_ERR "Requesting master 0 failed!\n");

   139

        goto out_return;

   140

    }

   141

   142

   143

    ecrt_master_callbacks(master, request_lock, release_lock, NULL);

   144

   145

    printk(KERN_INFO "Registering domain...\n");

   146

    if (!(domain1 = ecrt_master_create_domain(master))) {

   147

        printk(KERN_ERR "Domain creation failed!\n");

   148

        goto out_release_master;

   149

    }

   150

   151

    printk(KERN_INFO "Registering PDOs...\n");

   152

    if (ecrt_domain_register_pdo_list(domain1, domain1_pdos)) {

   153

        printk(KERN_ERR "PDO registration failed!\n");

   154

        goto out_release_master;

   155

    }

   156

   157

    printk(KERN_INFO "Activating master...\n");

   158

    if (ecrt_master_activate(master)) {

   159

        printk(KERN_ERR "Failed to activate master!\n");

   160

        goto out_release_master;

   161

    }

   162

   163

    ecrt_master_prepare(master);

   164

   165

    printk("Starting cyclic sample thread...\n");

   166

    requested_ticks = nano2count(TIMERTICKS);

   167

    tick_period = start_rt_timer(requested_ticks);

   168

    printk(KERN_INFO "RT timer started with %i/%i ticks.\n",

   169

           (int) tick_period, (int) requested_ticks);

   170

   171

    if (rt_task_init(&task, run, 0, 2000, 0, 1, NULL)) {

   172

        printk(KERN_ERR "Failed to init RTAI task!\n");

   173

        goto out_stop_timer;

   174

    }

   175

   176

    now = rt_get_time();

   177

    if (rt_task_make_periodic(&task, now + tick_period, tick_period)) {

   178

        printk(KERN_ERR "Failed to run RTAI task!\n");

   179

        goto out_stop_task;

   180

    }

   181

   182

    printk(KERN_INFO "=== EtherCAT RTAI sample module started. ===\n");

   183

    return 0;

   184

   185

 out_stop_task:

   186

    rt_task_delete(&task);

   187

 out_stop_timer:

   188

    stop_rt_timer();

   189

    ecrt_master_deactivate(master);

   190

 out_release_master:

   191

    ecrt_release_master(master);

   192

 out_return:

   193

    rt_sem_delete(&master_sem);

   194

    return -1;

   195

}

   196

   197

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

   198

   199

void __exit cleanup_mod(void)

   200

{

   201

    printk(KERN_INFO "=== Stopping EtherCAT RTAI sample module... ===\n");

   202

   203

    rt_task_delete(&task);

   204

    stop_rt_timer();

   205

    ecrt_master_deactivate(master);

   206

    ecrt_release_master(master);

   207

    rt_sem_delete(&master_sem);

   208

   209

    printk(KERN_INFO "=== EtherCAT RTAI sample module stopped. ===\n");

   210

}

   211

   212

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

   213

   214

module_init(init_mod);

   215

module_exit(cleanup_mod);

   216

   217

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

   218