etherlabmaster: master/mailbox.c@ef907b0b5125 (annotated)

145 11a82e4fd31b Mailbox-Interface ausgelagert, erster EOE-Ansatz. Florian Pose <fp@igh-essen.com> parents: diff changeset	1	/******************************************************************************
11a82e4fd31b Mailbox-Interface ausgelagert, erster EOE-Ansatz. Florian Pose <fp@igh-essen.com> parents: diff changeset	2	*
11a82e4fd31b Mailbox-Interface ausgelagert, erster EOE-Ansatz. Florian Pose <fp@igh-essen.com> parents: diff changeset	3	* $Id$
11a82e4fd31b Mailbox-Interface ausgelagert, erster EOE-Ansatz. Florian Pose <fp@igh-essen.com> parents: diff changeset	4	*
1326 ef907b0b5125 merge -c1603 branches/stable-1.4: Changed licence headers to avoid conflicts with the GPL; restricted licence to GPLv2 only. Florian Pose <fp@igh-essen.com> parents: 1313 diff changeset	5	* Copyright (C) 2006-2008 Florian Pose, Ingenieurgemeinschaft IgH
197 b9a6e2c22745 GPLv2 License and enhanced Doxygen output. Florian Pose <fp@igh-essen.com> parents: 195 diff changeset	6	*
b9a6e2c22745 GPLv2 License and enhanced Doxygen output. Florian Pose <fp@igh-essen.com> parents: 195 diff changeset	7	* 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	8	*
1326 ef907b0b5125 merge -c1603 branches/stable-1.4: Changed licence headers to avoid conflicts with the GPL; restricted licence to GPLv2 only. Florian Pose <fp@igh-essen.com> parents: 1313 diff changeset	9	* The IgH EtherCAT Master is free software; you can redistribute it and/or
ef907b0b5125 merge -c1603 branches/stable-1.4: Changed licence headers to avoid conflicts with the GPL; restricted licence to GPLv2 only. Florian Pose <fp@igh-essen.com> parents: 1313 diff changeset	10	* modify it under the terms of the GNU General Public License version 2, as
ef907b0b5125 merge -c1603 branches/stable-1.4: Changed licence headers to avoid conflicts with the GPL; restricted licence to GPLv2 only. Florian Pose <fp@igh-essen.com> parents: 1313 diff changeset	11	* published by the Free Software Foundation.
ef907b0b5125 merge -c1603 branches/stable-1.4: Changed licence headers to avoid conflicts with the GPL; restricted licence to GPLv2 only. Florian Pose <fp@igh-essen.com> parents: 1313 diff changeset	12	*
ef907b0b5125 merge -c1603 branches/stable-1.4: Changed licence headers to avoid conflicts with the GPL; restricted licence to GPLv2 only. Florian Pose <fp@igh-essen.com> parents: 1313 diff changeset	13	* The IgH EtherCAT Master is distributed in the hope that it will be useful,
ef907b0b5125 merge -c1603 branches/stable-1.4: Changed licence headers to avoid conflicts with the GPL; restricted licence to GPLv2 only. Florian Pose <fp@igh-essen.com> parents: 1313 diff changeset	14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
ef907b0b5125 merge -c1603 branches/stable-1.4: Changed licence headers to avoid conflicts with the GPL; restricted licence to GPLv2 only. Florian Pose <fp@igh-essen.com> parents: 1313 diff changeset	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
ef907b0b5125 merge -c1603 branches/stable-1.4: Changed licence headers to avoid conflicts with the GPL; restricted licence to GPLv2 only. Florian Pose <fp@igh-essen.com> parents: 1313 diff changeset	16	* Public License for more details.
ef907b0b5125 merge -c1603 branches/stable-1.4: Changed licence headers to avoid conflicts with the GPL; restricted licence to GPLv2 only. Florian Pose <fp@igh-essen.com> parents: 1313 diff changeset	17	*
ef907b0b5125 merge -c1603 branches/stable-1.4: Changed licence headers to avoid conflicts with the GPL; restricted licence to GPLv2 only. Florian Pose <fp@igh-essen.com> parents: 1313 diff changeset	18	* You should have received a copy of the GNU General Public License along
ef907b0b5125 merge -c1603 branches/stable-1.4: Changed licence headers to avoid conflicts with the GPL; restricted licence to GPLv2 only. Florian Pose <fp@igh-essen.com> parents: 1313 diff changeset	19	* with the IgH EtherCAT Master; if not, write to the Free Software
197 b9a6e2c22745 GPLv2 License and enhanced Doxygen output. Florian Pose <fp@igh-essen.com> parents: 195 diff changeset	20	* 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	21	*
1326 ef907b0b5125 merge -c1603 branches/stable-1.4: Changed licence headers to avoid conflicts with the GPL; restricted licence to GPLv2 only. Florian Pose <fp@igh-essen.com> parents: 1313 diff changeset	22	* Using the EtherCAT technology and brand is permitted in compliance with
ef907b0b5125 merge -c1603 branches/stable-1.4: Changed licence headers to avoid conflicts with the GPL; restricted licence to GPLv2 only. Florian Pose <fp@igh-essen.com> parents: 1313 diff changeset	23	* the industrial property and similar rights of Beckhoff Automation GmbH.
246 0bf7c769de06 Changed license headers and added EtherCAT license notice. Florian Pose <fp@igh-essen.com> parents: 199 diff changeset	24	*
145 11a82e4fd31b Mailbox-Interface ausgelagert, erster EOE-Ansatz. Florian Pose <fp@igh-essen.com> parents: diff changeset	25	*****************************************************************************/
11a82e4fd31b Mailbox-Interface ausgelagert, erster EOE-Ansatz. Florian Pose <fp@igh-essen.com> parents: diff changeset	26
199 04ecf40fc2e9 Doxygen added interface modules and file documentation. Florian Pose <fp@igh-essen.com> parents: 197 diff changeset	27	/**
04ecf40fc2e9 Doxygen added interface modules and file documentation. Florian Pose <fp@igh-essen.com> parents: 197 diff changeset	28	\file
04ecf40fc2e9 Doxygen added interface modules and file documentation. Florian Pose <fp@igh-essen.com> parents: 197 diff changeset	29	Mailbox functionality.
04ecf40fc2e9 Doxygen added interface modules and file documentation. Florian Pose <fp@igh-essen.com> parents: 197 diff changeset	30	*/
04ecf40fc2e9 Doxygen added interface modules and file documentation. Florian Pose <fp@igh-essen.com> parents: 197 diff changeset	31
04ecf40fc2e9 Doxygen added interface modules and file documentation. Florian Pose <fp@igh-essen.com> parents: 197 diff changeset	32	/*****************************************************************************/
04ecf40fc2e9 Doxygen added interface modules and file documentation. Florian Pose <fp@igh-essen.com> parents: 197 diff changeset	33
145 11a82e4fd31b Mailbox-Interface ausgelagert, erster EOE-Ansatz. Florian Pose <fp@igh-essen.com> parents: diff changeset	34	#include <linux/slab.h>
11a82e4fd31b Mailbox-Interface ausgelagert, erster EOE-Ansatz. Florian Pose <fp@igh-essen.com> parents: diff changeset	35	#include <linux/delay.h>
11a82e4fd31b Mailbox-Interface ausgelagert, erster EOE-Ansatz. Florian Pose <fp@igh-essen.com> parents: diff changeset	36
11a82e4fd31b Mailbox-Interface ausgelagert, erster EOE-Ansatz. Florian Pose <fp@igh-essen.com> parents: diff changeset	37	#include "mailbox.h"
293 14aeb79aa992 Renamed command structure to datagram. Florian Pose <fp@igh-essen.com> parents: 279 diff changeset	38	#include "datagram.h"
145 11a82e4fd31b Mailbox-Interface ausgelagert, erster EOE-Ansatz. Florian Pose <fp@igh-essen.com> parents: diff changeset	39	#include "master.h"
11a82e4fd31b Mailbox-Interface ausgelagert, erster EOE-Ansatz. Florian Pose <fp@igh-essen.com> parents: diff changeset	40
11a82e4fd31b Mailbox-Interface ausgelagert, erster EOE-Ansatz. Florian Pose <fp@igh-essen.com> parents: diff changeset	41	/*****************************************************************************/
11a82e4fd31b Mailbox-Interface ausgelagert, erster EOE-Ansatz. Florian Pose <fp@igh-essen.com> parents: diff changeset	42
11a82e4fd31b Mailbox-Interface ausgelagert, erster EOE-Ansatz. Florian Pose <fp@igh-essen.com> parents: diff changeset	43	/**
293 14aeb79aa992 Renamed command structure to datagram. Florian Pose <fp@igh-essen.com> parents: 279 diff changeset	44	Prepares a mailbox-send datagram.
1313 ed15eef57d5c Improved error case return codes of many functions. Florian Pose <fp@igh-essen.com> parents: 1225 diff changeset	45	\return Pointer to mailbox datagram data, or ERR_PTR() code.
195 674071846ee3 Translated all comments and documentation to english language. Florian Pose <fp@igh-essen.com> parents: 154 diff changeset	46	*/
674071846ee3 Translated all comments and documentation to english language. Florian Pose <fp@igh-essen.com> parents: 154 diff changeset	47
279 12f48c1cb143 Removed mbox_command out of slave. Florian Pose <fp@igh-essen.com> parents: 276 diff changeset	48	uint8_t ec_slave_mbox_prepare_send(const ec_slave_t slave, /*< slave /
293 14aeb79aa992 Renamed command structure to datagram. Florian Pose <fp@igh-essen.com> parents: 279 diff changeset	49	ec_datagram_t datagram, /< datagram /
195 674071846ee3 Translated all comments and documentation to english language. Florian Pose <fp@igh-essen.com> parents: 154 diff changeset	50	uint8_t type, /*< mailbox protocol /
674071846ee3 Translated all comments and documentation to english language. Florian Pose <fp@igh-essen.com> parents: 154 diff changeset	51	size_t size /*< size of the data /
145 11a82e4fd31b Mailbox-Interface ausgelagert, erster EOE-Ansatz. Florian Pose <fp@igh-essen.com> parents: diff changeset	52	)
11a82e4fd31b Mailbox-Interface ausgelagert, erster EOE-Ansatz. Florian Pose <fp@igh-essen.com> parents: diff changeset	53	{
11a82e4fd31b Mailbox-Interface ausgelagert, erster EOE-Ansatz. Florian Pose <fp@igh-essen.com> parents: diff changeset	54	size_t total_size;
1313 ed15eef57d5c Improved error case return codes of many functions. Florian Pose <fp@igh-essen.com> parents: 1225 diff changeset	55	int ret;
145 11a82e4fd31b Mailbox-Interface ausgelagert, erster EOE-Ansatz. Florian Pose <fp@igh-essen.com> parents: diff changeset	56
834 0791aac03180 Separated SII data from slave. Florian Pose <fp@igh-essen.com> parents: 815 diff changeset	57	if (unlikely(!slave->sii.mailbox_protocols)) {
986 a486591ba86b Replaced misleading %i by %u. Florian Pose <fp@igh-essen.com> parents: 834 diff changeset	58	EC_ERR("Slave %u does not support mailbox communication!\n",
145 11a82e4fd31b Mailbox-Interface ausgelagert, erster EOE-Ansatz. Florian Pose <fp@igh-essen.com> parents: diff changeset	59	slave->ring_position);
1313 ed15eef57d5c Improved error case return codes of many functions. Florian Pose <fp@igh-essen.com> parents: 1225 diff changeset	60	return ERR_PTR(-EPROTONOSUPPORT);
145 11a82e4fd31b Mailbox-Interface ausgelagert, erster EOE-Ansatz. Florian Pose <fp@igh-essen.com> parents: diff changeset	61	}
11a82e4fd31b Mailbox-Interface ausgelagert, erster EOE-Ansatz. Florian Pose <fp@igh-essen.com> parents: diff changeset	62
1217 e8a9785e63c3 Introduced EC_MBOX_HEADER_SIZE. Florian Pose <fp@igh-essen.com> parents: 986 diff changeset	63	total_size = EC_MBOX_HEADER_SIZE + size;
834 0791aac03180 Separated SII data from slave. Florian Pose <fp@igh-essen.com> parents: 815 diff changeset	64	if (unlikely(total_size > slave->sii.rx_mailbox_size)) {
145 11a82e4fd31b Mailbox-Interface ausgelagert, erster EOE-Ansatz. Florian Pose <fp@igh-essen.com> parents: diff changeset	65	EC_ERR("Data size does not fit in mailbox!\n");
1313 ed15eef57d5c Improved error case return codes of many functions. Florian Pose <fp@igh-essen.com> parents: 1225 diff changeset	66	return ERR_PTR(-EOVERFLOW);
ed15eef57d5c Improved error case return codes of many functions. Florian Pose <fp@igh-essen.com> parents: 1225 diff changeset	67	}
ed15eef57d5c Improved error case return codes of many functions. Florian Pose <fp@igh-essen.com> parents: 1225 diff changeset	68
ed15eef57d5c Improved error case return codes of many functions. Florian Pose <fp@igh-essen.com> parents: 1225 diff changeset	69	ret = ec_datagram_fpwr(datagram, slave->station_address,
834 0791aac03180 Separated SII data from slave. Florian Pose <fp@igh-essen.com> parents: 815 diff changeset	70	slave->sii.rx_mailbox_offset,
1313 ed15eef57d5c Improved error case return codes of many functions. Florian Pose <fp@igh-essen.com> parents: 1225 diff changeset	71	slave->sii.rx_mailbox_size);
ed15eef57d5c Improved error case return codes of many functions. Florian Pose <fp@igh-essen.com> parents: 1225 diff changeset	72	if (ret)
ed15eef57d5c Improved error case return codes of many functions. Florian Pose <fp@igh-essen.com> parents: 1225 diff changeset	73	return ERR_PTR(ret);
293 14aeb79aa992 Renamed command structure to datagram. Florian Pose <fp@igh-essen.com> parents: 279 diff changeset	74
14aeb79aa992 Renamed command structure to datagram. Florian Pose <fp@igh-essen.com> parents: 279 diff changeset	75	EC_WRITE_U16(datagram->data, size); // mailbox service data length
14aeb79aa992 Renamed command structure to datagram. Florian Pose <fp@igh-essen.com> parents: 279 diff changeset	76	EC_WRITE_U16(datagram->data + 2, slave->station_address); // station addr.
14aeb79aa992 Renamed command structure to datagram. Florian Pose <fp@igh-essen.com> parents: 279 diff changeset	77	EC_WRITE_U8 (datagram->data + 4, 0x00); // channel & priority
14aeb79aa992 Renamed command structure to datagram. Florian Pose <fp@igh-essen.com> parents: 279 diff changeset	78	EC_WRITE_U8 (datagram->data + 5, type); // underlying protocol type
14aeb79aa992 Renamed command structure to datagram. Florian Pose <fp@igh-essen.com> parents: 279 diff changeset	79
1217 e8a9785e63c3 Introduced EC_MBOX_HEADER_SIZE. Florian Pose <fp@igh-essen.com> parents: 986 diff changeset	80	return datagram->data + EC_MBOX_HEADER_SIZE;
293 14aeb79aa992 Renamed command structure to datagram. Florian Pose <fp@igh-essen.com> parents: 279 diff changeset	81	}
14aeb79aa992 Renamed command structure to datagram. Florian Pose <fp@igh-essen.com> parents: 279 diff changeset	82
14aeb79aa992 Renamed command structure to datagram. Florian Pose <fp@igh-essen.com> parents: 279 diff changeset	83	/*****************************************************************************/
14aeb79aa992 Renamed command structure to datagram. Florian Pose <fp@igh-essen.com> parents: 279 diff changeset	84
14aeb79aa992 Renamed command structure to datagram. Florian Pose <fp@igh-essen.com> parents: 279 diff changeset	85	/**
14aeb79aa992 Renamed command structure to datagram. Florian Pose <fp@igh-essen.com> parents: 279 diff changeset	86	Prepares a datagram for checking the mailbox state.
786 ad618c76e9bd Updated doxygen docs. Florian Pose <fp@igh-essen.com> parents: 504 diff changeset	87	\todo Determine sync manager used for receive mailbox
195 674071846ee3 Translated all comments and documentation to english language. Florian Pose <fp@igh-essen.com> parents: 154 diff changeset	88	\return 0 in case of success, else < 0
674071846ee3 Translated all comments and documentation to english language. Florian Pose <fp@igh-essen.com> parents: 154 diff changeset	89	*/
674071846ee3 Translated all comments and documentation to english language. Florian Pose <fp@igh-essen.com> parents: 154 diff changeset	90
279 12f48c1cb143 Removed mbox_command out of slave. Florian Pose <fp@igh-essen.com> parents: 276 diff changeset	91	int ec_slave_mbox_prepare_check(const ec_slave_t slave, /< slave /
293 14aeb79aa992 Renamed command structure to datagram. Florian Pose <fp@igh-essen.com> parents: 279 diff changeset	92	ec_datagram_t datagram /< datagram /
279 12f48c1cb143 Removed mbox_command out of slave. Florian Pose <fp@igh-essen.com> parents: 276 diff changeset	93	)
12f48c1cb143 Removed mbox_command out of slave. Florian Pose <fp@igh-essen.com> parents: 276 diff changeset	94	{
1313 ed15eef57d5c Improved error case return codes of many functions. Florian Pose <fp@igh-essen.com> parents: 1225 diff changeset	95	int ret = ec_datagram_fprd(datagram, slave->station_address, 0x808, 8);
ed15eef57d5c Improved error case return codes of many functions. Florian Pose <fp@igh-essen.com> parents: 1225 diff changeset	96	if (ret)
ed15eef57d5c Improved error case return codes of many functions. Florian Pose <fp@igh-essen.com> parents: 1225 diff changeset	97	return ret;
145 11a82e4fd31b Mailbox-Interface ausgelagert, erster EOE-Ansatz. Florian Pose <fp@igh-essen.com> parents: diff changeset	98
1225 4d5b739edcb5 Introduced ec_datagram_zero(). Florian Pose <fp@igh-essen.com> parents: 1217 diff changeset	99	ec_datagram_zero(datagram);
145 11a82e4fd31b Mailbox-Interface ausgelagert, erster EOE-Ansatz. Florian Pose <fp@igh-essen.com> parents: diff changeset	100	return 0;
11a82e4fd31b Mailbox-Interface ausgelagert, erster EOE-Ansatz. Florian Pose <fp@igh-essen.com> parents: diff changeset	101	}
11a82e4fd31b Mailbox-Interface ausgelagert, erster EOE-Ansatz. Florian Pose <fp@igh-essen.com> parents: diff changeset	102
11a82e4fd31b Mailbox-Interface ausgelagert, erster EOE-Ansatz. Florian Pose <fp@igh-essen.com> parents: diff changeset	103	/*****************************************************************************/
11a82e4fd31b Mailbox-Interface ausgelagert, erster EOE-Ansatz. Florian Pose <fp@igh-essen.com> parents: diff changeset	104
11a82e4fd31b Mailbox-Interface ausgelagert, erster EOE-Ansatz. Florian Pose <fp@igh-essen.com> parents: diff changeset	105	/**
293 14aeb79aa992 Renamed command structure to datagram. Florian Pose <fp@igh-essen.com> parents: 279 diff changeset	106	Processes a mailbox state checking datagram.
195 674071846ee3 Translated all comments and documentation to english language. Florian Pose <fp@igh-essen.com> parents: 154 diff changeset	107	\return 0 in case of success, else < 0
674071846ee3 Translated all comments and documentation to english language. Florian Pose <fp@igh-essen.com> parents: 154 diff changeset	108	*/
674071846ee3 Translated all comments and documentation to english language. Florian Pose <fp@igh-essen.com> parents: 154 diff changeset	109
293 14aeb79aa992 Renamed command structure to datagram. Florian Pose <fp@igh-essen.com> parents: 279 diff changeset	110	int ec_slave_mbox_check(const ec_datagram_t datagram /< datagram /)
14aeb79aa992 Renamed command structure to datagram. Florian Pose <fp@igh-essen.com> parents: 279 diff changeset	111	{
14aeb79aa992 Renamed command structure to datagram. Florian Pose <fp@igh-essen.com> parents: 279 diff changeset	112	return EC_READ_U8(datagram->data + 5) & 8 ? 1 : 0;
14aeb79aa992 Renamed command structure to datagram. Florian Pose <fp@igh-essen.com> parents: 279 diff changeset	113	}
14aeb79aa992 Renamed command structure to datagram. Florian Pose <fp@igh-essen.com> parents: 279 diff changeset	114
14aeb79aa992 Renamed command structure to datagram. Florian Pose <fp@igh-essen.com> parents: 279 diff changeset	115	/*****************************************************************************/
14aeb79aa992 Renamed command structure to datagram. Florian Pose <fp@igh-essen.com> parents: 279 diff changeset	116
14aeb79aa992 Renamed command structure to datagram. Florian Pose <fp@igh-essen.com> parents: 279 diff changeset	117	/**
14aeb79aa992 Renamed command structure to datagram. Florian Pose <fp@igh-essen.com> parents: 279 diff changeset	118	Prepares a datagram to fetch mailbox data.
195 674071846ee3 Translated all comments and documentation to english language. Florian Pose <fp@igh-essen.com> parents: 154 diff changeset	119	\return 0 in case of success, else < 0
674071846ee3 Translated all comments and documentation to english language. Florian Pose <fp@igh-essen.com> parents: 154 diff changeset	120	*/
674071846ee3 Translated all comments and documentation to english language. Florian Pose <fp@igh-essen.com> parents: 154 diff changeset	121
279 12f48c1cb143 Removed mbox_command out of slave. Florian Pose <fp@igh-essen.com> parents: 276 diff changeset	122	int ec_slave_mbox_prepare_fetch(const ec_slave_t slave, /< slave /
293 14aeb79aa992 Renamed command structure to datagram. Florian Pose <fp@igh-essen.com> parents: 279 diff changeset	123	ec_datagram_t datagram /< datagram /
279 12f48c1cb143 Removed mbox_command out of slave. Florian Pose <fp@igh-essen.com> parents: 276 diff changeset	124	)
12f48c1cb143 Removed mbox_command out of slave. Florian Pose <fp@igh-essen.com> parents: 276 diff changeset	125	{
1313 ed15eef57d5c Improved error case return codes of many functions. Florian Pose <fp@igh-essen.com> parents: 1225 diff changeset	126	int ret = ec_datagram_fprd(datagram, slave->station_address,
834 0791aac03180 Separated SII data from slave. Florian Pose <fp@igh-essen.com> parents: 815 diff changeset	127	slave->sii.tx_mailbox_offset,
1313 ed15eef57d5c Improved error case return codes of many functions. Florian Pose <fp@igh-essen.com> parents: 1225 diff changeset	128	slave->sii.tx_mailbox_size);
ed15eef57d5c Improved error case return codes of many functions. Florian Pose <fp@igh-essen.com> parents: 1225 diff changeset	129	if (ret)
ed15eef57d5c Improved error case return codes of many functions. Florian Pose <fp@igh-essen.com> parents: 1225 diff changeset	130	return ret;
1225 4d5b739edcb5 Introduced ec_datagram_zero(). Florian Pose <fp@igh-essen.com> parents: 1217 diff changeset	131
4d5b739edcb5 Introduced ec_datagram_zero(). Florian Pose <fp@igh-essen.com> parents: 1217 diff changeset	132	ec_datagram_zero(datagram);
145 11a82e4fd31b Mailbox-Interface ausgelagert, erster EOE-Ansatz. Florian Pose <fp@igh-essen.com> parents: diff changeset	133	return 0;
11a82e4fd31b Mailbox-Interface ausgelagert, erster EOE-Ansatz. Florian Pose <fp@igh-essen.com> parents: diff changeset	134	}
11a82e4fd31b Mailbox-Interface ausgelagert, erster EOE-Ansatz. Florian Pose <fp@igh-essen.com> parents: diff changeset	135
11a82e4fd31b Mailbox-Interface ausgelagert, erster EOE-Ansatz. Florian Pose <fp@igh-essen.com> parents: diff changeset	136	/*****************************************************************************/
11a82e4fd31b Mailbox-Interface ausgelagert, erster EOE-Ansatz. Florian Pose <fp@igh-essen.com> parents: diff changeset	137
11a82e4fd31b Mailbox-Interface ausgelagert, erster EOE-Ansatz. Florian Pose <fp@igh-essen.com> parents: diff changeset	138	/**
390 685c267d80d8 Fixed mailbox bug, added mailbox error codes. Florian Pose <fp@igh-essen.com> parents: 325 diff changeset	139	Mailbox error codes.
685c267d80d8 Fixed mailbox bug, added mailbox error codes. Florian Pose <fp@igh-essen.com> parents: 325 diff changeset	140	*/
685c267d80d8 Fixed mailbox bug, added mailbox error codes. Florian Pose <fp@igh-essen.com> parents: 325 diff changeset	141
685c267d80d8 Fixed mailbox bug, added mailbox error codes. Florian Pose <fp@igh-essen.com> parents: 325 diff changeset	142	const ec_code_msg_t mbox_error_messages[] = {
685c267d80d8 Fixed mailbox bug, added mailbox error codes. Florian Pose <fp@igh-essen.com> parents: 325 diff changeset	143	{0x00000001, "MBXERR_SYNTAX"},
685c267d80d8 Fixed mailbox bug, added mailbox error codes. Florian Pose <fp@igh-essen.com> parents: 325 diff changeset	144	{0x00000002, "MBXERR_UNSUPPORTEDPROTOCOL"},
685c267d80d8 Fixed mailbox bug, added mailbox error codes. Florian Pose <fp@igh-essen.com> parents: 325 diff changeset	145	{0x00000003, "MBXERR_INVAILDCHANNEL"},
685c267d80d8 Fixed mailbox bug, added mailbox error codes. Florian Pose <fp@igh-essen.com> parents: 325 diff changeset	146	{0x00000004, "MBXERR_SERVICENOTSUPPORTED"},
685c267d80d8 Fixed mailbox bug, added mailbox error codes. Florian Pose <fp@igh-essen.com> parents: 325 diff changeset	147	{0x00000005, "MBXERR_INVALIDHEADER"},
685c267d80d8 Fixed mailbox bug, added mailbox error codes. Florian Pose <fp@igh-essen.com> parents: 325 diff changeset	148	{0x00000006, "MBXERR_SIZETOOSHORT"},
685c267d80d8 Fixed mailbox bug, added mailbox error codes. Florian Pose <fp@igh-essen.com> parents: 325 diff changeset	149	{0x00000007, "MBXERR_NOMOREMEMORY"},
685c267d80d8 Fixed mailbox bug, added mailbox error codes. Florian Pose <fp@igh-essen.com> parents: 325 diff changeset	150	{0x00000008, "MBXERR_INVALIDSIZE"},
685c267d80d8 Fixed mailbox bug, added mailbox error codes. Florian Pose <fp@igh-essen.com> parents: 325 diff changeset	151	{}
685c267d80d8 Fixed mailbox bug, added mailbox error codes. Florian Pose <fp@igh-essen.com> parents: 325 diff changeset	152	};
685c267d80d8 Fixed mailbox bug, added mailbox error codes. Florian Pose <fp@igh-essen.com> parents: 325 diff changeset	153
685c267d80d8 Fixed mailbox bug, added mailbox error codes. Florian Pose <fp@igh-essen.com> parents: 325 diff changeset	154	/*****************************************************************************/
685c267d80d8 Fixed mailbox bug, added mailbox error codes. Florian Pose <fp@igh-essen.com> parents: 325 diff changeset	155
1313 ed15eef57d5c Improved error case return codes of many functions. Florian Pose <fp@igh-essen.com> parents: 1225 diff changeset	156	/** Processes received mailbox data.
ed15eef57d5c Improved error case return codes of many functions. Florian Pose <fp@igh-essen.com> parents: 1225 diff changeset	157	*
ed15eef57d5c Improved error case return codes of many functions. Florian Pose <fp@igh-essen.com> parents: 1225 diff changeset	158	* \return Pointer to the received data, or ERR_PTR() code.
ed15eef57d5c Improved error case return codes of many functions. Florian Pose <fp@igh-essen.com> parents: 1225 diff changeset	159	*/
279 12f48c1cb143 Removed mbox_command out of slave. Florian Pose <fp@igh-essen.com> parents: 276 diff changeset	160	uint8_t ec_slave_mbox_fetch(const ec_slave_t slave, /*< slave /
293 14aeb79aa992 Renamed command structure to datagram. Florian Pose <fp@igh-essen.com> parents: 279 diff changeset	161	ec_datagram_t datagram, /< datagram /
390 685c267d80d8 Fixed mailbox bug, added mailbox error codes. Florian Pose <fp@igh-essen.com> parents: 325 diff changeset	162	uint8_t type, /< expected mailbox protocol /
195 674071846ee3 Translated all comments and documentation to english language. Florian Pose <fp@igh-essen.com> parents: 154 diff changeset	163	size_t size /< size of the received data /
145 11a82e4fd31b Mailbox-Interface ausgelagert, erster EOE-Ansatz. Florian Pose <fp@igh-essen.com> parents: diff changeset	164	)
11a82e4fd31b Mailbox-Interface ausgelagert, erster EOE-Ansatz. Florian Pose <fp@igh-essen.com> parents: diff changeset	165	{
11a82e4fd31b Mailbox-Interface ausgelagert, erster EOE-Ansatz. Florian Pose <fp@igh-essen.com> parents: diff changeset	166	size_t data_size;
11a82e4fd31b Mailbox-Interface ausgelagert, erster EOE-Ansatz. Florian Pose <fp@igh-essen.com> parents: diff changeset	167
431 47e7f99005c0 Improved output at mailbox error. Florian Pose <fp@igh-essen.com> parents: 424 diff changeset	168	data_size = EC_READ_U16(datagram->data);
47e7f99005c0 Improved output at mailbox error. Florian Pose <fp@igh-essen.com> parents: 424 diff changeset	169
1217 e8a9785e63c3 Introduced EC_MBOX_HEADER_SIZE. Florian Pose <fp@igh-essen.com> parents: 986 diff changeset	170	if (data_size + EC_MBOX_HEADER_SIZE > slave->sii.tx_mailbox_size) {
986 a486591ba86b Replaced misleading %i by %u. Florian Pose <fp@igh-essen.com> parents: 834 diff changeset	171	EC_ERR("Corrupt mailbox response received from slave %u!\n",
504 63d11bdfe3df Improved error messages in mailbox.c Florian Pose <fp@igh-essen.com> parents: 431 diff changeset	172	slave->ring_position);
834 0791aac03180 Separated SII data from slave. Florian Pose <fp@igh-essen.com> parents: 815 diff changeset	173	ec_print_data(datagram->data, slave->sii.tx_mailbox_size);
1313 ed15eef57d5c Improved error case return codes of many functions. Florian Pose <fp@igh-essen.com> parents: 1225 diff changeset	174	return ERR_PTR(-EPROTO);
293 14aeb79aa992 Renamed command structure to datagram. Florian Pose <fp@igh-essen.com> parents: 279 diff changeset	175	}
14aeb79aa992 Renamed command structure to datagram. Florian Pose <fp@igh-essen.com> parents: 279 diff changeset	176
390 685c267d80d8 Fixed mailbox bug, added mailbox error codes. Florian Pose <fp@igh-essen.com> parents: 325 diff changeset	177	*type = EC_READ_U8(datagram->data + 5) & 0x0F;
685c267d80d8 Fixed mailbox bug, added mailbox error codes. Florian Pose <fp@igh-essen.com> parents: 325 diff changeset	178	*size = data_size;
685c267d80d8 Fixed mailbox bug, added mailbox error codes. Florian Pose <fp@igh-essen.com> parents: 325 diff changeset	179
685c267d80d8 Fixed mailbox bug, added mailbox error codes. Florian Pose <fp@igh-essen.com> parents: 325 diff changeset	180	if (*type == 0x00) {
685c267d80d8 Fixed mailbox bug, added mailbox error codes. Florian Pose <fp@igh-essen.com> parents: 325 diff changeset	181	const ec_code_msg_t *mbox_msg;
1217 e8a9785e63c3 Introduced EC_MBOX_HEADER_SIZE. Florian Pose <fp@igh-essen.com> parents: 986 diff changeset	182	uint16_t code = EC_READ_U16(datagram->data + 8);
390 685c267d80d8 Fixed mailbox bug, added mailbox error codes. Florian Pose <fp@igh-essen.com> parents: 325 diff changeset	183
986 a486591ba86b Replaced misleading %i by %u. Florian Pose <fp@igh-essen.com> parents: 834 diff changeset	184	EC_ERR("Mailbox error response received from slave %u - ",
1217 e8a9785e63c3 Introduced EC_MBOX_HEADER_SIZE. Florian Pose <fp@igh-essen.com> parents: 986 diff changeset	185	slave->ring_position);
e8a9785e63c3 Introduced EC_MBOX_HEADER_SIZE. Florian Pose <fp@igh-essen.com> parents: 986 diff changeset	186
e8a9785e63c3 Introduced EC_MBOX_HEADER_SIZE. Florian Pose <fp@igh-essen.com> parents: 986 diff changeset	187	for (mbox_msg = mbox_error_messages; mbox_msg->code; mbox_msg++) {
390 685c267d80d8 Fixed mailbox bug, added mailbox error codes. Florian Pose <fp@igh-essen.com> parents: 325 diff changeset	188	if (mbox_msg->code != code) continue;
431 47e7f99005c0 Improved output at mailbox error. Florian Pose <fp@igh-essen.com> parents: 424 diff changeset	189	printk("Code 0x%04X: \"%s\".\n",
390 685c267d80d8 Fixed mailbox bug, added mailbox error codes. Florian Pose <fp@igh-essen.com> parents: 325 diff changeset	190	mbox_msg->code, mbox_msg->message);
685c267d80d8 Fixed mailbox bug, added mailbox error codes. Florian Pose <fp@igh-essen.com> parents: 325 diff changeset	191	break;
685c267d80d8 Fixed mailbox bug, added mailbox error codes. Florian Pose <fp@igh-essen.com> parents: 325 diff changeset	192	}
685c267d80d8 Fixed mailbox bug, added mailbox error codes. Florian Pose <fp@igh-essen.com> parents: 325 diff changeset	193
685c267d80d8 Fixed mailbox bug, added mailbox error codes. Florian Pose <fp@igh-essen.com> parents: 325 diff changeset	194	if (!mbox_msg->code)
431 47e7f99005c0 Improved output at mailbox error. Florian Pose <fp@igh-essen.com> parents: 424 diff changeset	195	printk("Unknown error reply code 0x%04X.\n", code);
47e7f99005c0 Improved output at mailbox error. Florian Pose <fp@igh-essen.com> parents: 424 diff changeset	196
47e7f99005c0 Improved output at mailbox error. Florian Pose <fp@igh-essen.com> parents: 424 diff changeset	197	if (slave->master->debug_level)
1217 e8a9785e63c3 Introduced EC_MBOX_HEADER_SIZE. Florian Pose <fp@igh-essen.com> parents: 986 diff changeset	198	ec_print_data(datagram->data + EC_MBOX_HEADER_SIZE, data_size);
e8a9785e63c3 Introduced EC_MBOX_HEADER_SIZE. Florian Pose <fp@igh-essen.com> parents: 986 diff changeset	199
1313 ed15eef57d5c Improved error case return codes of many functions. Florian Pose <fp@igh-essen.com> parents: 1225 diff changeset	200	return ERR_PTR(-EPROTO);
1217 e8a9785e63c3 Introduced EC_MBOX_HEADER_SIZE. Florian Pose <fp@igh-essen.com> parents: 986 diff changeset	201	}
e8a9785e63c3 Introduced EC_MBOX_HEADER_SIZE. Florian Pose <fp@igh-essen.com> parents: 986 diff changeset	202
e8a9785e63c3 Introduced EC_MBOX_HEADER_SIZE. Florian Pose <fp@igh-essen.com> parents: 986 diff changeset	203	return datagram->data + EC_MBOX_HEADER_SIZE;
e8a9785e63c3 Introduced EC_MBOX_HEADER_SIZE. Florian Pose <fp@igh-essen.com> parents: 986 diff changeset	204	}
e8a9785e63c3 Introduced EC_MBOX_HEADER_SIZE. Florian Pose <fp@igh-essen.com> parents: 986 diff changeset	205
e8a9785e63c3 Introduced EC_MBOX_HEADER_SIZE. Florian Pose <fp@igh-essen.com> parents: 986 diff changeset	206	/*****************************************************************************/

author	Florian Pose <fp@igh-essen.com>
	Mon, 26 Jan 2009 11:16:10 +0000
changeset 1326	ef907b0b5125
parent 1313	ed15eef57d5c
child 1337	0253c74d0940
permissions	-rw-r--r--