IgH EtherCAT Master: pdo.h Source File

00001 /******************************************************************************
00002  *
00003  *  $Id$
00004  *
00005  *  Copyright (C) 2006-2008  Florian Pose, Ingenieurgemeinschaft IgH
00006  *
00007  *  This file is part of the IgH EtherCAT Master.
00008  *
00009  *  The IgH EtherCAT Master is free software; you can redistribute it and/or
00010  *  modify it under the terms of the GNU General Public License version 2, as
00011  *  published by the Free Software Foundation.
00012  *
00013  *  The IgH EtherCAT Master is distributed in the hope that it will be useful,
00014  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
00015  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
00016  *  Public License for more details.
00017  *
00018  *  You should have received a copy of the GNU General Public License along
00019  *  with the IgH EtherCAT Master; if not, write to the Free Software
00020  *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00021  *
00022  *  ---
00023  *
00024  *  The license mentioned above concerns the source code only. Using the
00025  *  EtherCAT technology and brand is only permitted in compliance with the
00026  *  industrial property and similar rights of Beckhoff Automation GmbH.
00027  *
00028  *****************************************************************************/
00029 
00035 /*****************************************************************************/
00036 
00037 #ifndef __EC_PDO_H__
00038 #define __EC_PDO_H__
00039 
00040 #include <linux/list.h>
00041 
00042 #include "globals.h"
00043 #include "pdo_entry.h"
00044 
00045 /*****************************************************************************/
00046 
00049 typedef struct {
00050     struct list_head list; 
00051     uint16_t index; 
00052     int8_t sync_index; 
00053     char *name; 
00054     struct list_head entries; 
00055 } ec_pdo_t;
00056 
00057 /*****************************************************************************/
00058 
00059 void ec_pdo_init(ec_pdo_t *);
00060 int ec_pdo_init_copy(ec_pdo_t *, const ec_pdo_t *);
00061 void ec_pdo_clear(ec_pdo_t *);
00062 void ec_pdo_clear_entries(ec_pdo_t *);
00063 int ec_pdo_set_name(ec_pdo_t *, const char *);
00064 ec_pdo_entry_t *ec_pdo_add_entry(ec_pdo_t *, uint16_t, uint8_t, uint8_t);
00065 int ec_pdo_copy_entries(ec_pdo_t *, const ec_pdo_t *);
00066 int ec_pdo_equal_entries(const ec_pdo_t *, const ec_pdo_t *);
00067 unsigned int ec_pdo_entry_count(const ec_pdo_t *);
00068 const ec_pdo_entry_t *ec_pdo_find_entry_by_pos_const(
00069         const ec_pdo_t *, unsigned int);
00070 
00071 void ec_pdo_print_entries(const ec_pdo_t *);
00072 
00073 /*****************************************************************************/
00074 
00075 #endif