1

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

     2

 *

     3

 *  $Id$

     4

 *

     5

 *  Copyright (C) 2006-2008  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 and/or

    10

 *  modify it under the terms of the GNU General Public License version 2, as

    11

 *  published by the Free Software Foundation.

    12

 *

    13

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

    14

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

    15

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General

    16

 *  Public License for more details.

    17

 *

    18

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

    19

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

    20

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

    21

 *

    22

 *  Using the EtherCAT technology and brand is permitted in compliance with

    23

 *  the industrial property and similar rights of Beckhoff Automation GmbH.

    24

 *

    25

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

    26

    27

/** \file

    28

 *

    29

 * EtherCAT interface for EtherCAT device drivers.

    30

 *

    31

 * \defgroup DeviceInterface EtherCAT Device Interface

    32

 *

    33

 * Master interface for EtherCAT-capable network device drivers. Through the

    34

 * EtherCAT device interface, EtherCAT-capable network device drivers are able

    35

 * to connect their device(s) to the master, pass received frames and notify

    36

 * the master about status changes. The master on his part, can send his

    37

 * frames through connected devices.

    38

 */

    39

    40

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

    41

    42

#ifndef __ECDEV_H__

    43

#define __ECDEV_H__

    44

    45

#include <linux/netdevice.h>

    46

    47

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

    48

    49

struct ec_device;

    50

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

    51

    52

/** Device poll function type.

    53

 */

    54

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

    55

    56

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

    57

 * Offering/withdrawal functions

    58

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

    59

    60

ec_device_t *ecdev_offer(struct net_device *net_dev, ec_pollfunc_t poll,

    61

        struct module *module);

    62

void ecdev_withdraw(ec_device_t *device);

    63

    64

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

    65

 * Device methods

    66

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

    67

    68

int ecdev_open(ec_device_t *device);

    69

void ecdev_close(ec_device_t *device);

    70

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

    71

void ecdev_set_link(ec_device_t *device, uint8_t state);

    72

uint8_t ecdev_get_link(const ec_device_t *device);

    73

    74

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

    75

    76

#endif