IgH EtherCAT Master  1.5.3
voe_handler.h
Go to the documentation of this file.
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 
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 
50  struct list_head list;
53  uint32_t vendor_id;
54  uint16_t vendor_type;
55  size_t data_size;
59  void (*state)(ec_voe_handler_t *);
61  unsigned int retries;
62  unsigned long jiffies_start;
63 };
64 
65 /*****************************************************************************/
66 
70 
71 /*****************************************************************************/
72 
73 #endif
int ec_voe_handler_init(ec_voe_handler_t *, ec_slave_config_t *, size_t)
VoE handler constructor.
Definition: voe_handler.c:72
ec_datagram_t datagram
State machine datagram.
Definition: voe_handler.h:52
EtherCAT datagram.
Definition: datagram.h:87
uint16_t vendor_type
Vendor type for the header.
Definition: voe_handler.h:54
struct list_head list
List item.
Definition: voe_handler.h:50
Global definitions and macros.
uint32_t vendor_id
Vendor ID for the header.
Definition: voe_handler.h:53
ec_internal_request_state_t
Generic request state.
Definition: globals.h:278
void(* state)(ec_voe_handler_t *)
State function.
Definition: voe_handler.h:59
ec_internal_request_state_t request_state
Handler state.
Definition: voe_handler.h:60
size_t data_size
Size of VoE data.
Definition: voe_handler.h:55
ec_direction_t
Direction type for PDO assignment functions.
Definition: ecrt.h:446
unsigned long jiffies_start
Timestamp for timeout calculation.
Definition: voe_handler.h:62
Vendor specific over EtherCAT handler.
Definition: voe_handler.h:49
size_t ec_voe_handler_mem_size(const ec_voe_handler_t *)
Get usable memory size.
Definition: voe_handler.c:108
EtherCAT datagram structure.
unsigned int retries
retries upon datagram timeout
Definition: voe_handler.h:61
ec_direction_t dir
Direction.
Definition: voe_handler.h:56
void ec_voe_handler_clear(ec_voe_handler_t *)
VoE handler destructor.
Definition: voe_handler.c:95
EtherCAT slave configuration.
Definition: slave_config.h:117
ec_slave_config_t * config
Parent slave configuration.
Definition: voe_handler.h:51