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

// RTAI task frequency in Hz

    51

#define INHIBIT_TIME 20

    52

    53

#define TIMERTICKS (1000000000 / FREQUENCY)

    54

    57

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

    58

    59

// RTAI

    63

    64

// EtherCAT

    68

    69

// data fields

    80

    {}

    81

};

    82

    83

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

    84

    85

void run(long data)

    86

{

    87

    static unsigned int blink = 0;

    88

    static unsigned int counter = 0;

    89

    90

    while (1) {

    91

        t_last_cycle = get_cycles();

    92

    93

        rt_sem_wait(&master_sem);

    94

        ecrt_master_receive(master);

    95

        ecrt_domain_process(domain1);

    96

        rt_sem_signal(&master_sem);

    97

    98

        // process data

    99

        EC_WRITE_U8(r_dig_out, blink ? 0x0F : 0x00);

   100

   101

        rt_sem_wait(&master_sem);

   102

        ecrt_domain_queue(domain1);

   103

        ecrt_master_send(master);

   104

        rt_sem_signal(&master_sem);

   105

   106

        if (counter) {

   107

            counter--;

   108

        }

   109

        else {

   110

            counter = FREQUENCY;

   111

            blink = !blink;

   132

        }

   133

   134

        rt_task_wait_period();

   135

    }

   136

}

   137

   138

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

   139

   140

int request_lock(void *data)

   141

{

   142

    // too close to the next real time cycle: deny access...

   143

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

   144

   145

    // allow access

   146

    rt_sem_wait(&master_sem);

   147

    return 0;

   148

}

   149

   150

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

   151

   152

void release_lock(void *data)

   153

{

   154

    rt_sem_signal(&master_sem);

   155

}

   156

   157

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

   158

   159

int __init init_mod(void)

   160

{

   161

    RTIME tick_period, requested_ticks, now;

   162

   164

   165

    rt_sem_init(&master_sem, 1);

   166

   167

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

   168

   169

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

   171

        goto out_return;

   172

    }

   173

   174

    ecrt_master_callbacks(master, request_lock, release_lock, NULL);

   175

   177

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

   179

        goto out_release_master;

   180

    }

   181

   185

        goto out_release_master;

   186

    }

   187

   189

    if (ecrt_master_activate(master)) {

   191

        goto out_release_master;

   192

    }

   193

   195

    requested_ticks = nano2count(TIMERTICKS);

   196

    tick_period = start_rt_timer(requested_ticks);

   198

           (int) tick_period, (int) requested_ticks);

   199

   200

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

   202

        goto out_stop_timer;

   203

    }

   204

   205

    now = rt_get_time();

   206

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

   208

        goto out_stop_task;

   209

    }

   210

   212

    return 0;

   213

   214

 out_stop_task:

   215

    rt_task_delete(&task);

   216

 out_stop_timer:

   217

    stop_rt_timer();

   218

 out_release_master:

   219

    ecrt_release_master(master);

   220

 out_return:

   221

    rt_sem_delete(&master_sem);

   222

    return -1;

   223

}

   224

   225

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

   226

   227

void __exit cleanup_mod(void)

   228

{

   230

   231

    rt_task_delete(&task);

   232

    stop_rt_timer();

   233

    ecrt_release_master(master);

   234

    rt_sem_delete(&master_sem);

   235

   237

}

   238

   239

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

   240

   241

MODULE_LICENSE("GPL");

   242

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

   243

MODULE_DESCRIPTION("EtherCAT RTAI sample module");

   244

   245

module_init(init_mod);

   246

module_exit(cleanup_mod);

   247

   248

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