1

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

     2

 *

     3

 *  $Id$

     4

 *

     5

 *  Copyright (C) 2006  Florian Pose, Ingenieurgemeinschaft IgH

     6

 *

     7

 *  This file is part of the IgH EtherCAT Master.

     8

 *

     9

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

    10

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

    11

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

    12

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

    13

 *

    14

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

    15

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

    16

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    17

 *  GNU General Public License for more details.

    18

 *

    19

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

    20

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

    21

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

    22

 *

    23

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

    24

 *  charge under condition of compatibility of product made by

    25

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

    26

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

    27

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

    28

 *  EtherCAT specification (which are released themselves as an open

    29

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

    30

 *  Technology, IP and trade marks.

    31

 *

    32

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

    33

    34

/**

    35

   \file

    36

   EtherCAT interface for EtherCAT device drivers.

    37

*/

    38

    39

/**

    40

   \defgroup DeviceInterface EtherCAT device interface

    41

   Master interface for EtherCAT-capable network device drivers.

    42

   Through the EtherCAT device interface, EtherCAT-capable network device

    43

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

    44

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

    45

   can send his frames through connected devices.

    46

*/

    47

    48

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

    49

    50

#ifndef _ETHERCAT_DEVICE_H_

    51

#define _ETHERCAT_DEVICE_H_

    52

    53

#include <linux/netdevice.h>

    54

    55

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

    56

    57

struct ec_device;

    58

typedef struct ec_device ec_device_t; /**< \see ec_device */

    59

    60

/**

    61

   Device poll function type.

    62

*/

    63

    64

typedef void (*ec_pollfunc_t)(struct net_device *);

    65

    66

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

    67

// Offering/withdrawal functions

    68

    69

int ecdev_offer(struct net_device *net_dev, ec_pollfunc_t poll,

    70

        struct module *module, ec_device_t **);

    71

void ecdev_withdraw(ec_device_t *device);

    72

    73

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

    74

// Device methods

    75

    76

int ecdev_open(ec_device_t *device);

    77

void ecdev_close(ec_device_t *device);

    78

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

    79

void ecdev_link_state(ec_device_t *device, uint8_t newstate);

    80

    81

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

    82

    83

#endif