IgH EtherCAT Master  1.5.2
mailbox.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_MAILBOX_H__
38 #define __EC_MAILBOX_H__
39 
40 #include "slave.h"
41 
42 /*****************************************************************************/
43 
46 #define EC_MBOX_HEADER_SIZE 6
47 
48 /*****************************************************************************/
49 
50 uint8_t *ec_slave_mbox_prepare_send(const ec_slave_t *, ec_datagram_t *,
51  uint8_t, size_t);
52 int ec_slave_mbox_prepare_check(const ec_slave_t *, ec_datagram_t *);
53 int ec_slave_mbox_check(const ec_datagram_t *);
54 int ec_slave_mbox_prepare_fetch(const ec_slave_t *, ec_datagram_t *);
55 uint8_t *ec_slave_mbox_fetch(const ec_slave_t *, const ec_datagram_t *,
56  uint8_t *, size_t *);
57 
58 /*****************************************************************************/
59 
60 #endif
slave.h
EtherCAT slave structure.
ec_datagram_t
EtherCAT datagram.
Definition: datagram.h:87
ec_slave
EtherCAT slave.
Definition: slave.h:176
ec_slave_mbox_prepare_fetch
int ec_slave_mbox_prepare_fetch(const ec_slave_t *, ec_datagram_t *)
Prepares a datagram to fetch mailbox data.
Definition: mailbox.c:127
ec_slave_mbox_prepare_check
int ec_slave_mbox_prepare_check(const ec_slave_t *, ec_datagram_t *)
Prepares a datagram for checking the mailbox state.
Definition: mailbox.c:96
ec_slave_mbox_prepare_send
uint8_t * ec_slave_mbox_prepare_send(const ec_slave_t *, ec_datagram_t *, uint8_t, size_t)
Prepares a mailbox-send datagram.
Definition: mailbox.c:51
ec_slave_mbox_check
int ec_slave_mbox_check(const ec_datagram_t *)
Processes a mailbox state checking datagram.
Definition: mailbox.c:115
ec_slave_mbox_fetch
uint8_t * ec_slave_mbox_fetch(const ec_slave_t *, const ec_datagram_t *, uint8_t *, size_t *)
Processes received mailbox data.
Definition: mailbox.c:165