IgH EtherCAT Master  1.5.3
pdo_entry.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_PDO_ENTRY_H__
38 #define __EC_PDO_ENTRY_H__
39 
40 #include <linux/list.h>
41 
42 #include "globals.h"
43 
44 /*****************************************************************************/
45 
48 typedef struct {
49  struct list_head list;
50  uint16_t index;
51  uint8_t subindex;
52  char *name;
53  uint8_t bit_length;
54 } ec_pdo_entry_t;
55 
56 /*****************************************************************************/
57 
58 void ec_pdo_entry_init(ec_pdo_entry_t *);
59 int ec_pdo_entry_init_copy(ec_pdo_entry_t *, const ec_pdo_entry_t *);
60 void ec_pdo_entry_clear(ec_pdo_entry_t *);
61 int ec_pdo_entry_set_name(ec_pdo_entry_t *, const char *);
62 int ec_pdo_entry_equal(const ec_pdo_entry_t *, const ec_pdo_entry_t *);
63 
64 /*****************************************************************************/
65 
66 #endif
ec_pdo_entry_init_copy
int ec_pdo_entry_init_copy(ec_pdo_entry_t *, const ec_pdo_entry_t *)
PDO entry copy constructor.
Definition: pdo_entry.c:59
ec_pdo_entry_clear
void ec_pdo_entry_clear(ec_pdo_entry_t *)
PDO entry destructor.
Definition: pdo_entry.c:76
globals.h
Global definitions and macros.
ec_pdo_entry_t
PDO entry description.
Definition: pdo_entry.h:48
ec_pdo_entry_t::index
uint16_t index
PDO entry index.
Definition: pdo_entry.h:50
ec_pdo_entry_t::bit_length
uint8_t bit_length
entry length in bit
Definition: pdo_entry.h:53
ec_pdo_entry_equal
int ec_pdo_entry_equal(const ec_pdo_entry_t *, const ec_pdo_entry_t *)
Compares two PDO entries.
Definition: pdo_entry.c:122
ec_pdo_entry_t::subindex
uint8_t subindex
PDO entry subindex.
Definition: pdo_entry.h:51
ec_pdo_entry_init
void ec_pdo_entry_init(ec_pdo_entry_t *)
PDO entry constructor.
Definition: pdo_entry.c:45
ec_pdo_entry_t::name
char * name
entry name
Definition: pdo_entry.h:52
ec_pdo_entry_set_name
int ec_pdo_entry_set_name(ec_pdo_entry_t *, const char *)
Set PDO entry name.
Definition: pdo_entry.c:89