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 TIMERTICKS (1000000000 / FREQUENCY)

    58

    59

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

    60

    61

// RTAI

    62

RT_TASK task;

    63

SEM master_sem;

    64

cycles_t t_last_start = 0, t_critical;

    65

    66

// EtherCAT

    67

ec_master_t *master = NULL;

    68

ec_domain_t *domain1 = NULL;

    69

    70

// data fields

    71

void *r_ana_out;

    72

    73

// channels

    74

uint32_t k_pos;

    75

    76

ec_pdo_reg_t domain1_pdos[] = {

    77

    {"2", Beckhoff_EL4132_Output1, &r_ana_out},

    78

    {}

    79

};

    80

    81

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

    82

    83

void run(long data)

    84

{

    85

    while (1)

    86

    {

    87

        t_last_start = get_cycles();

    88

        rt_sem_wait(&master_sem);

    89

    90

        ecrt_master_receive(master);

    91

        ecrt_domain_process(domain1);

    92

    93

        // process data

    94

        //k_pos = EC_READ_U32(r_ssi_input);

    95

    96

        ecrt_master_run(master);

    97

        ecrt_master_send(master);

    98

    99

        rt_sem_signal(&master_sem);

   100

        rt_task_wait_period();

   101

    }

   102

}

   103

   104

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

   105

   106

int request_lock(void *data)

   107

{

   108

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

   109

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

   110

   111

    // allow access

   112

    rt_sem_wait(&master_sem);

   113

    return 0;

   114

}

   115

   116

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

   117

   118

void release_lock(void *data)

   119

{

   120

    rt_sem_signal(&master_sem);

   121

}

   122

   123

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

   124

   125

int __init init_mod(void)

   126

{

   127

    RTIME tick_period, requested_ticks, now;

   128

   129

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

   130

   131

    rt_sem_init(&master_sem, 1);

   132

   133

    t_critical = cpu_khz * 800 / FREQUENCY; // ticks for 80%

   134

   135

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

   136

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

   137

        goto out_return;

   138

    }

   139

   140

    ecrt_master_callbacks(master, request_lock, release_lock, NULL);

   141

   142

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

   143

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

   144

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

   145

        goto out_release_master;

   146

    }

   147

   148

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

   149

    if (ecrt_domain_register_pdo_list(domain1, domain1_pdos)) {

   150

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

   151

        goto out_release_master;

   152

    }

   153

   154

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

   155

    if (ecrt_master_activate(master)) {

   156

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

   157

        goto out_release_master;

   158

    }

   159

   160

    ecrt_master_prepare(master);

   161

   162

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

   163

    requested_ticks = nano2count(TIMERTICKS);

   164

    tick_period = start_rt_timer(requested_ticks);

   165

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

   166

           (int) tick_period, (int) requested_ticks);

   167

   168

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

   169

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

   170

        goto out_stop_timer;

   171

    }

   172

   173

    now = rt_get_time();

   174

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

   175

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

   176

        goto out_stop_task;

   177

    }

   178

   179

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

   180

    return 0;

   181

   182

 out_stop_task:

   183

    rt_task_delete(&task);

   184

 out_stop_timer:

   185

    stop_rt_timer();

   186

    ecrt_master_deactivate(master);

   187

 out_release_master:

   188

    ecrt_release_master(master);

   189

 out_return:

   190

    rt_sem_delete(&master_sem);

   191

    return -1;

   192

}

   193

   194

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

   195

   196

void __exit cleanup_mod(void)

   197

{

   198

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

   199

   200

    rt_task_delete(&task);

   201

    stop_rt_timer();

   202

    ecrt_master_deactivate(master);

   203

    ecrt_release_master(master);

   204

    rt_sem_delete(&master_sem);

   205

   206

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

   207

}

   208

   209

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

   210

   211

module_init(init_mod);

   212

module_exit(cleanup_mod);

   213

   214

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

   215