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

    30

/**

    31

   \file

    32

   Mailbox functionality.

    33

*/

    34

    35

/*****************************************************************************/

    36

    37

#ifndef __EC_MAILBOX_H__

    38

#define __EC_MAILBOX_H__

    39

    40

#include "globals.h"

    41

#include "datagram.h"

    42

    43

/*****************************************************************************/

    44

    45

/** Size of the mailbox header.

    46

 */

    47

#define EC_MBOX_HEADER_SIZE 6

    48

    49

/*****************************************************************************/

    50

    51

/** EtherCAT slave mailbox.

    52

 */

    53

struct ec_mailbox

    54

{

    55

    ec_datagram_t* datagram;    /**< Datagram used for the mailbox content. */

    56

#ifdef EC_REDUCE_MBOXFRAMESIZE

    57

    ec_datagram_t end_datagram; /**< Datagram used for writing the end byte to the mailbox. */

    58

#endif

    59

};

    60

typedef struct ec_mailbox ec_mailbox_t; /**< \see ec_mailbox. */

    61

    62

/*****************************************************************************/

    63

    64

void     ec_mbox_init(ec_mailbox_t *, ec_datagram_t*);

    65

void     ec_mbox_clear(ec_mailbox_t*);

    66

/**

    67

   Checks the datagrams states.

    68

*/

    69

static inline int ec_mbox_is_datagram_state(ec_mailbox_t*mbox,

    70

                                            ec_datagram_state_t state) {

    71

    return (mbox->datagram->state == state)

    72

#ifdef EC_REDUCE_MBOXFRAMESIZE

    73

         && (mbox->end_datagram.type == EC_DATAGRAM_NONE || mbox->end_datagram.state == state)

    74

#endif

    75

    ;

    76

}

    77

    78

/**

    79

   Checks the datagrams working counter.

    80

*/

    81

static inline int ec_mbox_is_datagram_wc(ec_mailbox_t*mbox,

    82

                                         size_t wc) {

    83

    return (mbox->datagram->working_counter == wc)

    84

#ifdef EC_REDUCE_MBOXFRAMESIZE

    85

         && (mbox->end_datagram.type == EC_DATAGRAM_NONE || mbox->end_datagram.working_counter == wc)

    86

#endif

    87

         ;

    88

}

    89

    90

void     ec_slave_mbox_queue_datagrams(const ec_slave_t*,ec_mailbox_t*);

    91

void     ec_master_mbox_queue_datagrams(ec_master_t*, ec_mailbox_t*);

    92

uint8_t *ec_slave_mbox_prepare_send(const ec_slave_t*,ec_mailbox_t *,

    93

                                    uint8_t, size_t);

    94

int      ec_slave_mbox_prepare_check(const ec_slave_t*,ec_mailbox_t *);

    95

int      ec_slave_mbox_check(ec_mailbox_t *);

    96

int      ec_slave_mbox_prepare_fetch(const ec_slave_t*,ec_mailbox_t *);

    97

uint8_t *ec_slave_mbox_fetch(const ec_slave_t*,ec_mailbox_t *,

    98

                             uint8_t *, size_t *);

    99

   100

/*****************************************************************************/

   101

   102

#endif