Mercurial Mercurial > etherlabmaster / annotate
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
devices/ecdev.h
author Florian Pose <fp@igh-essen.com>
Mon, 24 Apr 2006 10:47:03 +0000
branchstable-1.0
changeset 1618 5cff10efb927
parent 195 674071846ee3
child 1619 0d4119024f55
permissions -rw-r--r--
MERGE trunk -r355:360 -> branches/stable-1.0 (Doxygen, INSTALL, and GPLv2)
104
052bc82d5442 MERGE branches/async -> trunk (alle Unterschiede ?bernommen)
Florian Pose <fp@igh-essen.com>
parents:
diff changeset 
     1
 
/******************************************************************************
052bc82d5442 MERGE branches/async -> trunk (alle Unterschiede ?bernommen)
Florian Pose <fp@igh-essen.com>
parents:
diff changeset 
     2
 
 *
195
674071846ee3 Translated all comments and documentation to english language.
Florian Pose <fp@igh-essen.com>
parents: 191
diff changeset 
     3
 
 *  $Id$
104
052bc82d5442 MERGE branches/async -> trunk (alle Unterschiede ?bernommen)
Florian Pose <fp@igh-essen.com>
parents:
diff changeset 
     4
 
 *
1618
5cff10efb927 MERGE trunk -r355:360 -> branches/stable-1.0 (Doxygen, INSTALL, and GPLv2)
Florian Pose <fp@igh-essen.com>
parents: 195
diff changeset 
     5
 
 *  Copyright (C) 2006  Florian Pose, Ingenieurgemeinschaft IgH
5cff10efb927 MERGE trunk -r355:360 -> branches/stable-1.0 (Doxygen, INSTALL, and GPLv2)
Florian Pose <fp@igh-essen.com>
parents: 195
diff changeset 
     6
 
 *
5cff10efb927 MERGE trunk -r355:360 -> branches/stable-1.0 (Doxygen, INSTALL, and GPLv2)
Florian Pose <fp@igh-essen.com>
parents: 195
diff changeset 
     7
 
 *  This file is part of the IgH EtherCAT Master.
5cff10efb927 MERGE trunk -r355:360 -> branches/stable-1.0 (Doxygen, INSTALL, and GPLv2)
Florian Pose <fp@igh-essen.com>
parents: 195
diff changeset 
     8
 
 *
5cff10efb927 MERGE trunk -r355:360 -> branches/stable-1.0 (Doxygen, INSTALL, and GPLv2)
Florian Pose <fp@igh-essen.com>
parents: 195
diff changeset 
     9
 
 *  The IgH EtherCAT Master is free software; you can redistribute it
5cff10efb927 MERGE trunk -r355:360 -> branches/stable-1.0 (Doxygen, INSTALL, and GPLv2)
Florian Pose <fp@igh-essen.com>
parents: 195
diff changeset 
    10
 
 *  and/or modify it under the terms of the GNU General Public License
5cff10efb927 MERGE trunk -r355:360 -> branches/stable-1.0 (Doxygen, INSTALL, and GPLv2)
Florian Pose <fp@igh-essen.com>
parents: 195
diff changeset 
    11
 
 *  as published by the Free Software Foundation; version 2 of the License.
5cff10efb927 MERGE trunk -r355:360 -> branches/stable-1.0 (Doxygen, INSTALL, and GPLv2)
Florian Pose <fp@igh-essen.com>
parents: 195
diff changeset 
    12
 
 *
5cff10efb927 MERGE trunk -r355:360 -> branches/stable-1.0 (Doxygen, INSTALL, and GPLv2)
Florian Pose <fp@igh-essen.com>
parents: 195
diff changeset 
    13
 
 *  The IgH EtherCAT Master is distributed in the hope that it will be
5cff10efb927 MERGE trunk -r355:360 -> branches/stable-1.0 (Doxygen, INSTALL, and GPLv2)
Florian Pose <fp@igh-essen.com>
parents: 195
diff changeset 
    14
 
 *  useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
5cff10efb927 MERGE trunk -r355:360 -> branches/stable-1.0 (Doxygen, INSTALL, and GPLv2)
Florian Pose <fp@igh-essen.com>
parents: 195
diff changeset 
    15
 
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
5cff10efb927 MERGE trunk -r355:360 -> branches/stable-1.0 (Doxygen, INSTALL, and GPLv2)
Florian Pose <fp@igh-essen.com>
parents: 195
diff changeset 
    16
 
 *  GNU General Public License for more details.
5cff10efb927 MERGE trunk -r355:360 -> branches/stable-1.0 (Doxygen, INSTALL, and GPLv2)
Florian Pose <fp@igh-essen.com>
parents: 195
diff changeset 
    17
 
 *
5cff10efb927 MERGE trunk -r355:360 -> branches/stable-1.0 (Doxygen, INSTALL, and GPLv2)
Florian Pose <fp@igh-essen.com>
parents: 195
diff changeset 
    18
 
 *  You should have received a copy of the GNU General Public License
5cff10efb927 MERGE trunk -r355:360 -> branches/stable-1.0 (Doxygen, INSTALL, and GPLv2)
Florian Pose <fp@igh-essen.com>
parents: 195
diff changeset 
    19
 
 *  along with the IgH EtherCAT Master; if not, write to the Free Software
5cff10efb927 MERGE trunk -r355:360 -> branches/stable-1.0 (Doxygen, INSTALL, and GPLv2)
Florian Pose <fp@igh-essen.com>
parents: 195
diff changeset 
    20
 
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
5cff10efb927 MERGE trunk -r355:360 -> branches/stable-1.0 (Doxygen, INSTALL, and GPLv2)
Florian Pose <fp@igh-essen.com>
parents: 195
diff changeset 
    21
 
 *
104
052bc82d5442 MERGE branches/async -> trunk (alle Unterschiede ?bernommen)
Florian Pose <fp@igh-essen.com>
parents:
diff changeset 
    22
 
 *****************************************************************************/
052bc82d5442 MERGE branches/async -> trunk (alle Unterschiede ?bernommen)
Florian Pose <fp@igh-essen.com>
parents:
diff changeset 
    23
 







1618






5cff10efb927
MERGE trunk -r355:360 -> branches/stable-1.0 (Doxygen, INSTALL, and GPLv2)



Florian Pose <fp@igh-essen.com>


parents: 
195

diff
changeset




    24


/**













5cff10efb927
MERGE trunk -r355:360 -> branches/stable-1.0 (Doxygen, INSTALL, and GPLv2)



Florian Pose <fp@igh-essen.com>


parents: 
195

diff
changeset




    25


   \file













5cff10efb927
MERGE trunk -r355:360 -> branches/stable-1.0 (Doxygen, INSTALL, and GPLv2)



Florian Pose <fp@igh-essen.com>


parents: 
195

diff
changeset




    26


   EtherCAT interface for EtherCAT device drivers.













5cff10efb927
MERGE trunk -r355:360 -> branches/stable-1.0 (Doxygen, INSTALL, and GPLv2)



Florian Pose <fp@igh-essen.com>


parents: 
195

diff
changeset




    27


*/













5cff10efb927
MERGE trunk -r355:360 -> branches/stable-1.0 (Doxygen, INSTALL, and GPLv2)



Florian Pose <fp@igh-essen.com>


parents: 
195

diff
changeset




    28














5cff10efb927
MERGE trunk -r355:360 -> branches/stable-1.0 (Doxygen, INSTALL, and GPLv2)



Florian Pose <fp@igh-essen.com>


parents: 
195

diff
changeset




    29


/**













5cff10efb927
MERGE trunk -r355:360 -> branches/stable-1.0 (Doxygen, INSTALL, and GPLv2)



Florian Pose <fp@igh-essen.com>


parents: 
195

diff
changeset




    30


   \defgroup DeviceInterface EtherCAT device interface













5cff10efb927
MERGE trunk -r355:360 -> branches/stable-1.0 (Doxygen, INSTALL, and GPLv2)



Florian Pose <fp@igh-essen.com>


parents: 
195

diff
changeset




    31


   Master interface for EtherCAT-capable network device drivers.













5cff10efb927
MERGE trunk -r355:360 -> branches/stable-1.0 (Doxygen, INSTALL, and GPLv2)



Florian Pose <fp@igh-essen.com>


parents: 
195

diff
changeset




    32


   Through the EtherCAT device interface, EtherCAT-capable network device













5cff10efb927
MERGE trunk -r355:360 -> branches/stable-1.0 (Doxygen, INSTALL, and GPLv2)



Florian Pose <fp@igh-essen.com>


parents: 
195

diff
changeset




    33


   drivers are able to connect their device(s) to the master, pass received













5cff10efb927
MERGE trunk -r355:360 -> branches/stable-1.0 (Doxygen, INSTALL, and GPLv2)



Florian Pose <fp@igh-essen.com>


parents: 
195

diff
changeset




    34


   frames and notify the master about status changes. The master on his part,













5cff10efb927
MERGE trunk -r355:360 -> branches/stable-1.0 (Doxygen, INSTALL, and GPLv2)



Florian Pose <fp@igh-essen.com>


parents: 
195

diff
changeset




    35


   can send his frames through connected devices.













5cff10efb927
MERGE trunk -r355:360 -> branches/stable-1.0 (Doxygen, INSTALL, and GPLv2)



Florian Pose <fp@igh-essen.com>


parents: 
195

diff
changeset




    36


*/













5cff10efb927
MERGE trunk -r355:360 -> branches/stable-1.0 (Doxygen, INSTALL, and GPLv2)



Florian Pose <fp@igh-essen.com>


parents: 
195

diff
changeset




    37














5cff10efb927
MERGE trunk -r355:360 -> branches/stable-1.0 (Doxygen, INSTALL, and GPLv2)



Florian Pose <fp@igh-essen.com>


parents: 
195

diff
changeset




    38


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













5cff10efb927
MERGE trunk -r355:360 -> branches/stable-1.0 (Doxygen, INSTALL, and GPLv2)



Florian Pose <fp@igh-essen.com>


parents: 
195

diff
changeset




    39









104






052bc82d5442
MERGE branches/async -> trunk (alle Unterschiede ?bernommen)



Florian Pose <fp@igh-essen.com>


parents: 

diff
changeset




    40


#ifndef _ETHERCAT_DEVICE_H_













052bc82d5442
MERGE branches/async -> trunk (alle Unterschiede ?bernommen)



Florian Pose <fp@igh-essen.com>


parents: 

diff
changeset




    41


#define _ETHERCAT_DEVICE_H_













052bc82d5442
MERGE branches/async -> trunk (alle Unterschiede ?bernommen)



Florian Pose <fp@igh-essen.com>


parents: 

diff
changeset




    42














052bc82d5442
MERGE branches/async -> trunk (alle Unterschiede ?bernommen)



Florian Pose <fp@igh-essen.com>


parents: 

diff
changeset




    43


#include <linux/netdevice.h>













052bc82d5442
MERGE branches/async -> trunk (alle Unterschiede ?bernommen)



Florian Pose <fp@igh-essen.com>


parents: 

diff
changeset




    44














052bc82d5442
MERGE branches/async -> trunk (alle Unterschiede ?bernommen)



Florian Pose <fp@igh-essen.com>


parents: 

diff
changeset




    45


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













052bc82d5442
MERGE branches/async -> trunk (alle Unterschiede ?bernommen)



Florian Pose <fp@igh-essen.com>


parents: 

diff
changeset




    46














052bc82d5442
MERGE branches/async -> trunk (alle Unterschiede ?bernommen)



Florian Pose <fp@igh-essen.com>


parents: 

diff
changeset




    47


struct ec_device;













052bc82d5442
MERGE branches/async -> trunk (alle Unterschiede ?bernommen)



Florian Pose <fp@igh-essen.com>


parents: 

diff
changeset




    48


typedef struct ec_device ec_device_t;













052bc82d5442
MERGE branches/async -> trunk (alle Unterschiede ?bernommen)



Florian Pose <fp@igh-essen.com>


parents: 

diff
changeset




    49














052bc82d5442
MERGE branches/async -> trunk (alle Unterschiede ?bernommen)



Florian Pose <fp@igh-essen.com>


parents: 

diff
changeset




    50


typedef irqreturn_t (*ec_isr_t)(int, void *, struct pt_regs *);













052bc82d5442
MERGE branches/async -> trunk (alle Unterschiede ?bernommen)



Florian Pose <fp@igh-essen.com>


parents: 

diff
changeset




    51














052bc82d5442
MERGE branches/async -> trunk (alle Unterschiede ?bernommen)



Florian Pose <fp@igh-essen.com>


parents: 

diff
changeset




    52


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













052bc82d5442
MERGE branches/async -> trunk (alle Unterschiede ?bernommen)



Florian Pose <fp@igh-essen.com>


parents: 

diff
changeset




    53


// Registration functions













052bc82d5442
MERGE branches/async -> trunk (alle Unterschiede ?bernommen)



Florian Pose <fp@igh-essen.com>


parents: 

diff
changeset




    54














052bc82d5442
MERGE branches/async -> trunk (alle Unterschiede ?bernommen)



Florian Pose <fp@igh-essen.com>


parents: 

diff
changeset




    55


ec_device_t *ecdev_register(unsigned int master_index,













052bc82d5442
MERGE branches/async -> trunk (alle Unterschiede ?bernommen)



Florian Pose <fp@igh-essen.com>


parents: 

diff
changeset




    56


                            struct net_device *net_dev, ec_isr_t isr,













052bc82d5442
MERGE branches/async -> trunk (alle Unterschiede ?bernommen)



Florian Pose <fp@igh-essen.com>


parents: 

diff
changeset




    57


                            struct module *module);













052bc82d5442
MERGE branches/async -> trunk (alle Unterschiede ?bernommen)



Florian Pose <fp@igh-essen.com>


parents: 

diff
changeset




    58


void ecdev_unregister(unsigned int master_index, ec_device_t *device);













052bc82d5442
MERGE branches/async -> trunk (alle Unterschiede ?bernommen)



Florian Pose <fp@igh-essen.com>


parents: 

diff
changeset




    59









191






ca805255a935
Prepared Free-Run mode



Florian Pose <fp@igh-essen.com>


parents: 
104

diff
changeset




    60


int ecdev_start(unsigned int master_index);













ca805255a935
Prepared Free-Run mode



Florian Pose <fp@igh-essen.com>


parents: 
104

diff
changeset




    61


void ecdev_stop(unsigned int master_index);













ca805255a935
Prepared Free-Run mode



Florian Pose <fp@igh-essen.com>


parents: 
104

diff
changeset




    62









104






052bc82d5442
MERGE branches/async -> trunk (alle Unterschiede ?bernommen)



Florian Pose <fp@igh-essen.com>


parents: 

diff
changeset




    63


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













052bc82d5442
MERGE branches/async -> trunk (alle Unterschiede ?bernommen)



Florian Pose <fp@igh-essen.com>


parents: 

diff
changeset




    64


// Device methods













052bc82d5442
MERGE branches/async -> trunk (alle Unterschiede ?bernommen)



Florian Pose <fp@igh-essen.com>


parents: 

diff
changeset




    65














052bc82d5442
MERGE branches/async -> trunk (alle Unterschiede ?bernommen)



Florian Pose <fp@igh-essen.com>


parents: 

diff
changeset




    66


void ecdev_receive(ec_device_t *device, const void *data, size_t size);













052bc82d5442
MERGE branches/async -> trunk (alle Unterschiede ?bernommen)



Florian Pose <fp@igh-essen.com>


parents: 

diff
changeset




    67


void ecdev_link_state(ec_device_t *device, uint8_t newstate);













052bc82d5442
MERGE branches/async -> trunk (alle Unterschiede ?bernommen)



Florian Pose <fp@igh-essen.com>


parents: 

diff
changeset




    68














052bc82d5442
MERGE branches/async -> trunk (alle Unterschiede ?bernommen)



Florian Pose <fp@igh-essen.com>


parents: 

diff
changeset




    69


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













052bc82d5442
MERGE branches/async -> trunk (alle Unterschiede ?bernommen)



Florian Pose <fp@igh-essen.com>


parents: 

diff
changeset




    70














052bc82d5442
MERGE branches/async -> trunk (alle Unterschiede ?bernommen)



Florian Pose <fp@igh-essen.com>


parents: 

diff
changeset




    71


#endif













etherlabmaster