etherlabmaster: master/domain.h@b9a6e2c22745 (annotated)

42 a22a202d0f42 Domains, Warten beim Senden, 10kHz. Florian Pose <fp@igh-essen.com> parents: diff changeset	1	/******************************************************************************
a22a202d0f42 Domains, Warten beim Senden, 10kHz. Florian Pose <fp@igh-essen.com> parents: diff changeset	2	*
54 7506e67dd122 Vereinheitlichte Schnittstellen, Include-Verzeichnis und Module getrennt. Florian Pose <fp@igh-essen.com> parents: 52 diff changeset	3	* d o m a i n . h
42 a22a202d0f42 Domains, Warten beim Senden, 10kHz. Florian Pose <fp@igh-essen.com> parents: diff changeset	4	*
195 674071846ee3 Translated all comments and documentation to english language. Florian Pose <fp@igh-essen.com> parents: 179 diff changeset	5	* EtherCAT domain structure.
42 a22a202d0f42 Domains, Warten beim Senden, 10kHz. Florian Pose <fp@igh-essen.com> parents: diff changeset	6	*
a22a202d0f42 Domains, Warten beim Senden, 10kHz. Florian Pose <fp@igh-essen.com> parents: diff changeset	7	* $Id$
a22a202d0f42 Domains, Warten beim Senden, 10kHz. Florian Pose <fp@igh-essen.com> parents: diff changeset	8	*
197 b9a6e2c22745 GPLv2 License and enhanced Doxygen output. Florian Pose <fp@igh-essen.com> parents: 195 diff changeset	9	* Copyright (C) 2006 Florian Pose, Ingenieurgemeinschaft IgH
b9a6e2c22745 GPLv2 License and enhanced Doxygen output. Florian Pose <fp@igh-essen.com> parents: 195 diff changeset	10	*
b9a6e2c22745 GPLv2 License and enhanced Doxygen output. Florian Pose <fp@igh-essen.com> parents: 195 diff changeset	11	* This file is part of the IgH EtherCAT Master.
b9a6e2c22745 GPLv2 License and enhanced Doxygen output. Florian Pose <fp@igh-essen.com> parents: 195 diff changeset	12	*
b9a6e2c22745 GPLv2 License and enhanced Doxygen output. Florian Pose <fp@igh-essen.com> parents: 195 diff changeset	13	* The IgH EtherCAT Master is free software; you can redistribute it
b9a6e2c22745 GPLv2 License and enhanced Doxygen output. Florian Pose <fp@igh-essen.com> parents: 195 diff changeset	14	* and/or modify it under the terms of the GNU General Public License
b9a6e2c22745 GPLv2 License and enhanced Doxygen output. Florian Pose <fp@igh-essen.com> parents: 195 diff changeset	15	* as published by the Free Software Foundation; version 2 of the License.
b9a6e2c22745 GPLv2 License and enhanced Doxygen output. Florian Pose <fp@igh-essen.com> parents: 195 diff changeset	16	*
b9a6e2c22745 GPLv2 License and enhanced Doxygen output. Florian Pose <fp@igh-essen.com> parents: 195 diff changeset	17	* The IgH EtherCAT Master is distributed in the hope that it will be
b9a6e2c22745 GPLv2 License and enhanced Doxygen output. Florian Pose <fp@igh-essen.com> parents: 195 diff changeset	18	* useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
b9a6e2c22745 GPLv2 License and enhanced Doxygen output. Florian Pose <fp@igh-essen.com> parents: 195 diff changeset	19	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
b9a6e2c22745 GPLv2 License and enhanced Doxygen output. Florian Pose <fp@igh-essen.com> parents: 195 diff changeset	20	* GNU General Public License for more details.
b9a6e2c22745 GPLv2 License and enhanced Doxygen output. Florian Pose <fp@igh-essen.com> parents: 195 diff changeset	21	*
b9a6e2c22745 GPLv2 License and enhanced Doxygen output. Florian Pose <fp@igh-essen.com> parents: 195 diff changeset	22	* You should have received a copy of the GNU General Public License
b9a6e2c22745 GPLv2 License and enhanced Doxygen output. Florian Pose <fp@igh-essen.com> parents: 195 diff changeset	23	* along with the IgH EtherCAT Master; if not, write to the Free Software
b9a6e2c22745 GPLv2 License and enhanced Doxygen output. Florian Pose <fp@igh-essen.com> parents: 195 diff changeset	24	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
b9a6e2c22745 GPLv2 License and enhanced Doxygen output. Florian Pose <fp@igh-essen.com> parents: 195 diff changeset	25	*
42 a22a202d0f42 Domains, Warten beim Senden, 10kHz. Florian Pose <fp@igh-essen.com> parents: diff changeset	26	*****************************************************************************/
a22a202d0f42 Domains, Warten beim Senden, 10kHz. Florian Pose <fp@igh-essen.com> parents: diff changeset	27
a22a202d0f42 Domains, Warten beim Senden, 10kHz. Florian Pose <fp@igh-essen.com> parents: diff changeset	28	#ifndef _EC_DOMAIN_H_
a22a202d0f42 Domains, Warten beim Senden, 10kHz. Florian Pose <fp@igh-essen.com> parents: diff changeset	29	#define _EC_DOMAIN_H_
a22a202d0f42 Domains, Warten beim Senden, 10kHz. Florian Pose <fp@igh-essen.com> parents: diff changeset	30
73 9f4ea66d89a3 Dynamische FMMU-Konfiguration, zwei Kopieroperationen eingespart, Einr?ckungen angepasst. Florian Pose <fp@igh-essen.com> parents: 56 diff changeset	31	#include <linux/list.h>
178 b84f69db8566 MERGE branches/sysfs -> trunk (whole SysFS implementation) Florian Pose <fp@igh-essen.com> parents: 144 diff changeset	32	#include <linux/kobject.h>
73 9f4ea66d89a3 Dynamische FMMU-Konfiguration, zwei Kopieroperationen eingespart, Einr?ckungen angepasst. Florian Pose <fp@igh-essen.com> parents: 56 diff changeset	33
54 7506e67dd122 Vereinheitlichte Schnittstellen, Include-Verzeichnis und Module getrennt. Florian Pose <fp@igh-essen.com> parents: 52 diff changeset	34	#include "globals.h"
7506e67dd122 Vereinheitlichte Schnittstellen, Include-Verzeichnis und Module getrennt. Florian Pose <fp@igh-essen.com> parents: 52 diff changeset	35	#include "slave.h"
98 f564d0929292 MERGE branches/async 222:233 -> trunk (Kommando-Warteschlangen). Florian Pose <fp@igh-essen.com> parents: 95 diff changeset	36	#include "command.h"
73 9f4ea66d89a3 Dynamische FMMU-Konfiguration, zwei Kopieroperationen eingespart, Einr?ckungen angepasst. Florian Pose <fp@igh-essen.com> parents: 56 diff changeset	37
9f4ea66d89a3 Dynamische FMMU-Konfiguration, zwei Kopieroperationen eingespart, Einr?ckungen angepasst. Florian Pose <fp@igh-essen.com> parents: 56 diff changeset	38	/*****************************************************************************/
9f4ea66d89a3 Dynamische FMMU-Konfiguration, zwei Kopieroperationen eingespart, Einr?ckungen angepasst. Florian Pose <fp@igh-essen.com> parents: 56 diff changeset	39
9f4ea66d89a3 Dynamische FMMU-Konfiguration, zwei Kopieroperationen eingespart, Einr?ckungen angepasst. Florian Pose <fp@igh-essen.com> parents: 56 diff changeset	40	/**
197 b9a6e2c22745 GPLv2 License and enhanced Doxygen output. Florian Pose <fp@igh-essen.com> parents: 195 diff changeset	41	\defgroup Domain EtherCAT domain
b9a6e2c22745 GPLv2 License and enhanced Doxygen output. Florian Pose <fp@igh-essen.com> parents: 195 diff changeset	42	Data types and methods for EtherCAT domains.
b9a6e2c22745 GPLv2 License and enhanced Doxygen output. Florian Pose <fp@igh-essen.com> parents: 195 diff changeset	43	A domain handles process data IO with a group of slaves.
b9a6e2c22745 GPLv2 License and enhanced Doxygen output. Florian Pose <fp@igh-essen.com> parents: 195 diff changeset	44	\{
b9a6e2c22745 GPLv2 License and enhanced Doxygen output. Florian Pose <fp@igh-essen.com> parents: 195 diff changeset	45	*/
b9a6e2c22745 GPLv2 License and enhanced Doxygen output. Florian Pose <fp@igh-essen.com> parents: 195 diff changeset	46
b9a6e2c22745 GPLv2 License and enhanced Doxygen output. Florian Pose <fp@igh-essen.com> parents: 195 diff changeset	47	/*****************************************************************************/
b9a6e2c22745 GPLv2 License and enhanced Doxygen output. Florian Pose <fp@igh-essen.com> parents: 195 diff changeset	48
b9a6e2c22745 GPLv2 License and enhanced Doxygen output. Florian Pose <fp@igh-essen.com> parents: 195 diff changeset	49	/**
195 674071846ee3 Translated all comments and documentation to english language. Florian Pose <fp@igh-essen.com> parents: 179 diff changeset	50	Data field registration type.
73 9f4ea66d89a3 Dynamische FMMU-Konfiguration, zwei Kopieroperationen eingespart, Einr?ckungen angepasst. Florian Pose <fp@igh-essen.com> parents: 56 diff changeset	51	*/
9f4ea66d89a3 Dynamische FMMU-Konfiguration, zwei Kopieroperationen eingespart, Einr?ckungen angepasst. Florian Pose <fp@igh-essen.com> parents: 56 diff changeset	52
9f4ea66d89a3 Dynamische FMMU-Konfiguration, zwei Kopieroperationen eingespart, Einr?ckungen angepasst. Florian Pose <fp@igh-essen.com> parents: 56 diff changeset	53	typedef struct
9f4ea66d89a3 Dynamische FMMU-Konfiguration, zwei Kopieroperationen eingespart, Einr?ckungen angepasst. Florian Pose <fp@igh-essen.com> parents: 56 diff changeset	54	{
195 674071846ee3 Translated all comments and documentation to english language. Florian Pose <fp@igh-essen.com> parents: 179 diff changeset	55	struct list_head list; /*< list item /
674071846ee3 Translated all comments and documentation to english language. Florian Pose <fp@igh-essen.com> parents: 179 diff changeset	56	ec_slave_t slave; /< slave /
674071846ee3 Translated all comments and documentation to english language. Florian Pose <fp@igh-essen.com> parents: 179 diff changeset	57	const ec_sync_t sync; /< sync manager /
674071846ee3 Translated all comments and documentation to english language. Florian Pose <fp@igh-essen.com> parents: 179 diff changeset	58	uint32_t field_offset; /*< data field offset /
674071846ee3 Translated all comments and documentation to english language. Florian Pose <fp@igh-essen.com> parents: 179 diff changeset	59	void data_ptr; /< pointer to process data pointer(s) */
73 9f4ea66d89a3 Dynamische FMMU-Konfiguration, zwei Kopieroperationen eingespart, Einr?ckungen angepasst. Florian Pose <fp@igh-essen.com> parents: 56 diff changeset	60	}
9f4ea66d89a3 Dynamische FMMU-Konfiguration, zwei Kopieroperationen eingespart, Einr?ckungen angepasst. Florian Pose <fp@igh-essen.com> parents: 56 diff changeset	61	ec_field_reg_t;
42 a22a202d0f42 Domains, Warten beim Senden, 10kHz. Florian Pose <fp@igh-essen.com> parents: diff changeset	62
a22a202d0f42 Domains, Warten beim Senden, 10kHz. Florian Pose <fp@igh-essen.com> parents: diff changeset	63	/*****************************************************************************/
a22a202d0f42 Domains, Warten beim Senden, 10kHz. Florian Pose <fp@igh-essen.com> parents: diff changeset	64
a22a202d0f42 Domains, Warten beim Senden, 10kHz. Florian Pose <fp@igh-essen.com> parents: diff changeset	65	/**
195 674071846ee3 Translated all comments and documentation to english language. Florian Pose <fp@igh-essen.com> parents: 179 diff changeset	66	EtherCAT domain.
674071846ee3 Translated all comments and documentation to english language. Florian Pose <fp@igh-essen.com> parents: 179 diff changeset	67	Handles the process data and the therefore needed commands of a certain
674071846ee3 Translated all comments and documentation to english language. Florian Pose <fp@igh-essen.com> parents: 179 diff changeset	68	group of slaves.
42 a22a202d0f42 Domains, Warten beim Senden, 10kHz. Florian Pose <fp@igh-essen.com> parents: diff changeset	69	*/
a22a202d0f42 Domains, Warten beim Senden, 10kHz. Florian Pose <fp@igh-essen.com> parents: diff changeset	70
73 9f4ea66d89a3 Dynamische FMMU-Konfiguration, zwei Kopieroperationen eingespart, Einr?ckungen angepasst. Florian Pose <fp@igh-essen.com> parents: 56 diff changeset	71	struct ec_domain
42 a22a202d0f42 Domains, Warten beim Senden, 10kHz. Florian Pose <fp@igh-essen.com> parents: diff changeset	72	{
195 674071846ee3 Translated all comments and documentation to english language. Florian Pose <fp@igh-essen.com> parents: 179 diff changeset	73	struct kobject kobj; /*< kobject /
674071846ee3 Translated all comments and documentation to english language. Florian Pose <fp@igh-essen.com> parents: 179 diff changeset	74	struct list_head list; /*< list item /
674071846ee3 Translated all comments and documentation to english language. Florian Pose <fp@igh-essen.com> parents: 179 diff changeset	75	unsigned int index; /*< domain index (just a number) /
674071846ee3 Translated all comments and documentation to english language. Florian Pose <fp@igh-essen.com> parents: 179 diff changeset	76	ec_master_t master; /< EtherCAT master owning the domain /
674071846ee3 Translated all comments and documentation to english language. Florian Pose <fp@igh-essen.com> parents: 179 diff changeset	77	size_t data_size; /*< size of the process data /
674071846ee3 Translated all comments and documentation to english language. Florian Pose <fp@igh-essen.com> parents: 179 diff changeset	78	struct list_head commands; /*< process data commands /
674071846ee3 Translated all comments and documentation to english language. Florian Pose <fp@igh-essen.com> parents: 179 diff changeset	79	uint32_t base_address; /*< logical offset address of the process data /
674071846ee3 Translated all comments and documentation to english language. Florian Pose <fp@igh-essen.com> parents: 179 diff changeset	80	unsigned int response_count; /*< number of responding slaves /
674071846ee3 Translated all comments and documentation to english language. Florian Pose <fp@igh-essen.com> parents: 179 diff changeset	81	struct list_head field_regs; /*< data field registrations /
73 9f4ea66d89a3 Dynamische FMMU-Konfiguration, zwei Kopieroperationen eingespart, Einr?ckungen angepasst. Florian Pose <fp@igh-essen.com> parents: 56 diff changeset	82	};
42 a22a202d0f42 Domains, Warten beim Senden, 10kHz. Florian Pose <fp@igh-essen.com> parents: diff changeset	83
197 b9a6e2c22745 GPLv2 License and enhanced Doxygen output. Florian Pose <fp@igh-essen.com> parents: 195 diff changeset	84	/** \} */
b9a6e2c22745 GPLv2 License and enhanced Doxygen output. Florian Pose <fp@igh-essen.com> parents: 195 diff changeset	85
42 a22a202d0f42 Domains, Warten beim Senden, 10kHz. Florian Pose <fp@igh-essen.com> parents: diff changeset	86	/*****************************************************************************/
a22a202d0f42 Domains, Warten beim Senden, 10kHz. Florian Pose <fp@igh-essen.com> parents: diff changeset	87
178 b84f69db8566 MERGE branches/sysfs -> trunk (whole SysFS implementation) Florian Pose <fp@igh-essen.com> parents: 144 diff changeset	88	int ec_domain_init(ec_domain_t , ec_master_t , unsigned int);
b84f69db8566 MERGE branches/sysfs -> trunk (whole SysFS implementation) Florian Pose <fp@igh-essen.com> parents: 144 diff changeset	89	void ec_domain_clear(struct kobject *);
73 9f4ea66d89a3 Dynamische FMMU-Konfiguration, zwei Kopieroperationen eingespart, Einr?ckungen angepasst. Florian Pose <fp@igh-essen.com> parents: 56 diff changeset	90	int ec_domain_alloc(ec_domain_t *, uint32_t);
42 a22a202d0f42 Domains, Warten beim Senden, 10kHz. Florian Pose <fp@igh-essen.com> parents: diff changeset	91
a22a202d0f42 Domains, Warten beim Senden, 10kHz. Florian Pose <fp@igh-essen.com> parents: diff changeset	92	/*****************************************************************************/
a22a202d0f42 Domains, Warten beim Senden, 10kHz. Florian Pose <fp@igh-essen.com> parents: diff changeset	93
a22a202d0f42 Domains, Warten beim Senden, 10kHz. Florian Pose <fp@igh-essen.com> parents: diff changeset	94	#endif

author	Florian Pose <fp@igh-essen.com>
	Fri, 21 Apr 2006 12:35:17 +0000
changeset 197	b9a6e2c22745
parent 195	674071846ee3
child 199	04ecf40fc2e9
permissions	-rw-r--r--