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; version 2 of the License.

    14

 *

    15

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

    16

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

    17

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    18

 *  GNU General Public License for more details.

    19

 *

    20

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

    21

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

    22

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

    23

 *

    24

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

    25

    26

// Linux

    27

#include <linux/module.h>

    28

    29

// RTAI

    30

#include "rtai_sched.h"

    31

#include "rtai_sem.h"

    32

    33

// EtherCAT

    34

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

    35

    36

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

    37

    38

// comment this for synchronous IO

    39

#define ASYNC

    40

    41

// RTAI task frequency in Hz

    42

#define FREQUENCY 10000

    43

    44

#define TIMERTICKS (1000000000 / FREQUENCY)

    45

    46

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

    47

    48

// RTAI

    49

RT_TASK task;

    50

SEM master_sem;

    51

cycles_t t_last_start = 0;

    52

cycles_t t_critical;

    53

    54

// EtherCAT

    55

ec_master_t *master = NULL;

    56

ec_domain_t *domain1 = NULL;

    57

    58

// data fields

    59

void *r_ssi_input;

    60

    61

// channels

    62

uint32_t k_pos;

    63

    64

ec_field_init_t domain1_fields[] = {

    65

    {&r_ssi_input, "3", "Beckhoff", "EL5001", "InputValue",   0},

    66

    {NULL,         "2", "Beckhoff", "EL4132", "OutputValue",  0},

    67

    {}

    68

};

    69

    70

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

    71

    72

void run(long data)

    73

{

    74

    while (1)

    75

    {

    76

        t_last_start = get_cycles();

    77

        rt_sem_wait(&master_sem);

    78

    79

#ifdef ASYNC

    80

        // receive

    81

        ecrt_master_async_receive(master);

    82

        ecrt_domain_process(domain1);

    83

#else

    84

        // send and receive

    85

        ecrt_domain_queue(domain1);

    86

        ecrt_master_run(master);

    87

        ecrt_master_sync_io(master);

    88

        ecrt_domain_process(domain1);

    89

#endif

    90

    91

        // process data

    92

        k_pos = EC_READ_U32(r_ssi_input);

    93

    94

#ifdef ASYNC

    95

        // send

    96

        ecrt_domain_queue(domain1);

    97

        ecrt_master_run(master);

    98

        ecrt_master_async_send(master);

    99

#endif

   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_start > 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 * 800 / FREQUENCY; // ticks for 80%

   136

   137

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

   138

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

   139

        goto out_return;

   140

    }

   141

   142

    ecrt_master_callbacks(master, request_lock, release_lock, NULL);

   143

   144

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

   145

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

   146

    {

   147

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

   148

        goto out_release_master;

   149

    }

   150

   151

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

   152

    if (ecrt_domain_register_field_list(domain1, domain1_fields)) {

   153

        printk(KERN_ERR "Field 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

#if 0

   164

    if (ecrt_master_fetch_sdo_lists(master)) {

   165

        printk(KERN_ERR "Failed to fetch SDO lists!\n");

   166

        goto out_deactivate;

   167

    }

   168

    ecrt_master_print(master, 2);

   169

#else

   170

    ecrt_master_print(master, 0);

   171

#endif

   172

   173

#if 0

   174

    if (!(slave = ecrt_master_get_slave(master, "5"))) {

   175

        printk(KERN_ERR "Failed to get slave 5!\n");

   176

        goto out_deactivate;

   177

    }

   178

   179

    if (ecrt_slave_sdo_write_exp8(slave, 0x4061, 1,  0) ||

   180

        ecrt_slave_sdo_write_exp8(slave, 0x4061, 2,  1) ||

   181

        ecrt_slave_sdo_write_exp8(slave, 0x4061, 3,  1) ||

   182

        ecrt_slave_sdo_write_exp8(slave, 0x4066, 0,  0) ||

   183

        ecrt_slave_sdo_write_exp8(slave, 0x4067, 0,  4) ||

   184

        ecrt_slave_sdo_write_exp8(slave, 0x4068, 0,  0) ||

   185

        ecrt_slave_sdo_write_exp8(slave, 0x4069, 0, 25) ||

   186

        ecrt_slave_sdo_write_exp8(slave, 0x406A, 0, 25) ||

   187

        ecrt_slave_sdo_write_exp8(slave, 0x406B, 0, 50)) {

   188

        printk(KERN_ERR "Failed to configure SSI slave!\n");

   189

        goto out_deactivate;

   190

    }

   191

#endif

   192

   193

#if 0

   194

    printk(KERN_INFO "Writing alias...\n");

   195

    if (ecrt_slave_sdo_write_exp16(slave, 0xBEEF)) {

   196

        printk(KERN_ERR "Failed to write alias!\n");

   197

        goto out_deactivate;

   198

    }

   199

#endif

   200

   201

#ifdef ASYNC

   202

    // send once and wait...

   203

    ecrt_master_prepare_async_io(master);

   204

#endif

   205

   206

    if (ecrt_master_start_eoe(master)) {

   207

        printk(KERN_ERR "Failed to start EoE processing!\n");

   208

        goto out_deactivate;

   209

    }

   210

   211

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

   212

    requested_ticks = nano2count(TIMERTICKS);

   213

    tick_period = start_rt_timer(requested_ticks);

   214

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

   215

           (int) tick_period, (int) requested_ticks);

   216

   217

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

   218

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

   219

        goto out_stop_timer;

   220

    }

   221

   222

    now = rt_get_time();

   223

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

   224

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

   225

        goto out_stop_task;

   226

    }

   227

   228

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

   229

    return 0;

   230

   231

 out_stop_task:

   232

    rt_task_delete(&task);

   233

 out_stop_timer:

   234

    stop_rt_timer();

   235

 out_deactivate:

   236

    ecrt_master_deactivate(master);

   237

 out_release_master:

   238

    ecrt_release_master(master);

   239

 out_return:

   240

    rt_sem_delete(&master_sem);

   241

    return -1;

   242

}

   243

   244

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

   245

   246

void __exit cleanup_mod(void)

   247

{

   248

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

   249

   250

    rt_task_delete(&task);

   251

    stop_rt_timer();

   252

    ecrt_master_deactivate(master);

   253

    ecrt_release_master(master);

   254

    rt_sem_delete(&master_sem);

   255

   256

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

   257

}

   258

   259

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

   260

   261

MODULE_LICENSE("GPL");

   262

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

   263

MODULE_DESCRIPTION ("EtherCAT RTAI sample module");

   264

   265

module_init(init_mod);

   266

module_exit(cleanup_mod);

   267

   268

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

   269