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

    58

                                  the mailbox. */

    59

#endif

    60

};

    61

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

    62

    63

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

    64

    65

void ec_mbox_init(ec_mailbox_t *, ec_datagram_t *);

    66

void ec_mbox_clear(ec_mailbox_t *);

    67

    68

/**

    69

   Checks the datagrams states.

    70

*/

    71

static inline int ec_mbox_is_datagram_state(

    72

        ec_mailbox_t *mbox,

    73

        ec_datagram_state_t state

    74

        )

    75

{

    76

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

    77

#ifdef EC_REDUCE_MBOXFRAMESIZE

    78

         && (mbox->end_datagram.type == EC_DATAGRAM_NONE

    79

                 || mbox->end_datagram.state == state)

    80

#endif

    81

         ;

    82

}

    83

    84

/**

    85

   Checks the datagrams working counter.

    86

*/

    87

static inline int ec_mbox_is_datagram_wc(

    88

        ec_mailbox_t *mbox,

    89

        size_t wc

    90

        )

    91

{

    92

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

    93

#ifdef EC_REDUCE_MBOXFRAMESIZE

    94

         && (mbox->end_datagram.type == EC_DATAGRAM_NONE

    95

                 || mbox->end_datagram.working_counter == wc)

    96

#endif

    97

         ;

    98

}

    99

   100

void ec_slave_mbox_queue_datagrams(const ec_slave_t *, ec_mailbox_t *);

   101

void ec_master_mbox_queue_datagrams(ec_master_t *, ec_mailbox_t *);

   102

uint8_t *ec_slave_mbox_prepare_send(const ec_slave_t *, ec_mailbox_t *,

   103

                                    uint8_t, size_t);

   104

int ec_slave_mbox_prepare_check(const ec_slave_t *, ec_mailbox_t *);

   105

int ec_slave_mbox_check(ec_mailbox_t *);

   106

int ec_slave_mbox_prepare_fetch(const ec_slave_t *, ec_mailbox_t *);

   107

uint8_t *ec_slave_mbox_fetch(const ec_slave_t *, ec_mailbox_t *,

   108

                             uint8_t *, size_t *);

   109

   110

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

   111

   112

#endif