etherlabmaster: master/pdo.h@b13ef712a2d7 (annotated)

627 4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	1	/******************************************************************************
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	2	*
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	3	* $Id$
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	4	*
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	5	* Copyright (C) 2006 Florian Pose, Ingenieurgemeinschaft IgH
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	6	*
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	7	* This file is part of the IgH EtherCAT Master.
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	8	*
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	9	* The IgH EtherCAT Master is free software; you can redistribute it
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	10	* and/or modify it under the terms of the GNU General Public License
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	11	* as published by the Free Software Foundation; either version 2 of the
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	12	* License, or (at your option) any later version.
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	13	*
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	14	* The IgH EtherCAT Master is distributed in the hope that it will be
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	15	* useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	16	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	17	* GNU General Public License for more details.
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	18	*
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	19	* You should have received a copy of the GNU General Public License
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	20	* along with the IgH EtherCAT Master; if not, write to the Free Software
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	21	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	22	*
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	23	* The right to use EtherCAT Technology is granted and comes free of
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	24	* charge under condition of compatibility of product made by
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	25	* Licensee. People intending to distribute/sell products based on the
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	26	* code, have to sign an agreement to guarantee that products using
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	27	* software based on IgH EtherCAT master stay compatible with the actual
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	28	* EtherCAT specification (which are released themselves as an open
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	29	* standard) as the (only) precondition to have the right to use EtherCAT
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	30	* Technology, IP and trade marks.
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	31	*
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	32	*****************************************************************************/
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	33
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	34	/**
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	35	\file
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	36	EtherCAT Process data object structure.
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	37	*/
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	38
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	39	/*****************************************************************************/
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	40
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	41	#ifndef _EC_PDO_H_
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	42	#define _EC_PDO_H_
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	43
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	44	#include <linux/list.h>
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	45
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	46	#include "globals.h"
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	47
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	48	/*****************************************************************************/
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	49
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	50	/**
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	51	* PDO type.
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	52	*/
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	53
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	54	typedef enum
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	55	{
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	56	EC_RX_PDO, /*< Reveive PDO /
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	57	EC_TX_PDO /*< Transmit PDO /
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	58	}
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	59	ec_pdo_type_t;
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	60
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	61	/*****************************************************************************/
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	62
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	63	/**
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	64	* PDO description.
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	65	*/
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	66
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	67	typedef struct
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	68	{
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	69	struct list_head list; /*< list item /
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	70	ec_pdo_type_t type; /*< PDO type /
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	71	uint16_t index; /*< PDO index /
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	72	int8_t sync_index; /*< assigned sync manager /
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	73	char name; /< PDO name /
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	74	struct list_head entries; /*< entry list /
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	75	}
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	76	ec_pdo_t;
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	77
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	78	/*****************************************************************************/
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	79
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	80	/**
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	81	* PDO entry description.
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	82	*/
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	83
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	84	typedef struct
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	85	{
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	86	struct list_head list; /*< list item /
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	87	uint16_t index; /*< PDO entry index /
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	88	uint8_t subindex; /*< PDO entry subindex /
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	89	char name; /< entry name /
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	90	uint8_t bit_length; /*< entry length in bit /
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	91	}
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	92	ec_pdo_entry_t;
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	93
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	94	/*****************************************************************************/
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	95
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	96	void ec_pdo_init(ec_pdo_t *);
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	97	void ec_pdo_clear(ec_pdo_t *);
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	98	int ec_pdo_copy(ec_pdo_t , const ec_pdo_t );
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	99
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	100	/*****************************************************************************/
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	101
4793ca94f082 Layed out PDO structures to own files. Florian Pose <fp@igh-essen.com> parents: diff changeset	102	#endif

author	Florian Pose <fp@igh-essen.com>
	Tue, 18 Sep 2007 14:19:21 +0000
changeset 731	b13ef712a2d7
parent 627	4793ca94f082
child 792	3778920f61e4
permissions	-rw-r--r--