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

 *  ---

    23

 *

    24

 *  The license mentioned above concerns the source code only. Using the

    25

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

    26

 *  industrial property and similar rights of Beckhoff Automation GmbH.

    27

 *

    28

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

    29

    30

/**

    31

   \file

    32

   Vendor specific over EtherCAT protocol handler.

    33

*/

    34

    35

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

    36

    37

#ifndef __EC_VOE_HANDLER_H__

    38

#define __EC_VOE_HANDLER_H__

    39

    40

#include <linux/list.h>

    41

    42

#include "globals.h"

    43

#include "datagram.h"

    44

    45

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

    46

    47

/** Vendor specific over EtherCAT handler.

    48

 */

    49

struct ec_voe_handler {

    50

    struct list_head list; /**< List item. */

    51

    ec_slave_config_t *config; /**< Parent slave configuration. */

    52

    ec_datagram_t datagram; /**< State machine datagram. */

    53

    ec_mailbox_t mbox; /**< State machine mailbox. */

    54

    uint32_t vendor_id; /**< Vendor ID for the header. */

    55

    uint16_t vendor_type; /**< Vendor type for the header. */

    56

    size_t data_size; /**< Size of VoE data. */

    57

    ec_direction_t dir; /**< Direction. EC_DIR_OUTPUT means writing to

    58

                          the slave, EC_DIR_INPUT means reading from the

    59

                          slave. */

    60

    void (*state)(ec_voe_handler_t *); /**< State function */

    61

    ec_internal_request_state_t request_state; /**< Handler state. */

    62

    unsigned int retries; /**< retries upon datagram timeout */

    63

    unsigned long jiffies_start; /**< Timestamp for timeout calculation. */

    64

};

    65

    66

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

    67

    68

int ec_voe_handler_init(ec_voe_handler_t *, ec_slave_config_t *, size_t);

    69

void ec_voe_handler_clear(ec_voe_handler_t *);

    70

size_t ec_voe_handler_mem_size(const ec_voe_handler_t *);

    71

    72

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

    73

    74

#endif