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

   EtherCAT datagram structure.

    33

*/

    34

    35

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

    36

    37

#ifndef __EC_DATAGRAM_H__

    38

#define __EC_DATAGRAM_H__

    39

    40

#include <linux/list.h>

    41

#include <linux/time.h>

    42

#include <linux/timex.h>

    43

    44

#include "globals.h"

    45

    46

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

    47

    48

/** EtherCAT datagram type.

    49

 */

    50

typedef enum {

    51

    EC_DATAGRAM_NONE = 0x00, /**< Dummy. */

    52

    EC_DATAGRAM_APRD = 0x01, /**< Auto Increment Physical Read. */

    53

    EC_DATAGRAM_APWR = 0x02, /**< Auto Increment Physical Write. */

    54

    EC_DATAGRAM_APRW = 0x03, /**< Auto Increment Physical ReadWrite. */

    55

    EC_DATAGRAM_FPRD = 0x04, /**< Configured Address Physical Read. */

    56

    EC_DATAGRAM_FPWR = 0x05, /**< Configured Address Physical Write. */

    57

    EC_DATAGRAM_FPRW = 0x06, /**< Configured Address Physical ReadWrite. */

    58

    EC_DATAGRAM_BRD  = 0x07, /**< Broadcast Read. */

    59

    EC_DATAGRAM_BWR  = 0x08, /**< Broadcast Write. */

    60

    EC_DATAGRAM_BRW  = 0x09, /**< Broadcast ReadWrite. */

    61

    EC_DATAGRAM_LRD  = 0x0A, /**< Logical Read. */

    62

    EC_DATAGRAM_LWR  = 0x0B, /**< Logical Write. */

    63

    EC_DATAGRAM_LRW  = 0x0C, /**< Logical ReadWrite. */

    64

    EC_DATAGRAM_ARMW = 0x0D, /**< Auto Increment Physical Read Multiple

    65

                               Write.  */

    66

    EC_DATAGRAM_FRMW = 0x0E, /**< Configured Address Physical Read Multiple

    67

                               Write. */

    68

} ec_datagram_type_t;

    69

    70

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

    71

    72

/** EtherCAT datagram state.

    73

 */

    74

typedef enum {

    75

    EC_DATAGRAM_INIT,      /**< Initial state of a new datagram. */

    76

    EC_DATAGRAM_QUEUED,    /**< Queued for sending. */

    77

    EC_DATAGRAM_SENT,      /**< Sent (still in the queue). */

    78

    EC_DATAGRAM_RECEIVED,  /**< Received (dequeued). */

    79

    EC_DATAGRAM_TIMED_OUT, /**< Timed out (dequeued). */

    80

    EC_DATAGRAM_ERROR      /**< Error while sending/receiving (dequeued). */

    81

} ec_datagram_state_t;

    82

    83

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

    84

    85

/** EtherCAT datagram.

    86

 */

    87

typedef struct {

    88

    struct list_head list; /**< Needed by domain datagram lists. */

    89

    struct list_head queue; /**< Master datagram queue item. */

    90

    struct list_head sent; /**< Master list item for sent datagrams. */

    91

    ec_datagram_type_t type; /**< Datagram type (APRD, BWR, etc.). */

    92

    uint8_t address[EC_ADDR_LEN]; /**< Recipient address. */

    93

    uint8_t *data; /**< Datagram payload. */

    94

    ec_origin_t data_origin; /**< Origin of the \a data memory. */

    95

    size_t mem_size; /**< Datagram \a data memory size. */

    96

    size_t data_size; /**< Size of the data in \a data. */

    97

    ec_domain_t *domain; /**< Owning domain (may be null for non-domain datagrams) */

    98

    uint8_t index; /**< Index (set by master). */

    99

    uint16_t working_counter; /**< Working counter. */

   100

    ec_datagram_state_t state; /**< State. */

   101

#ifdef EC_HAVE_CYCLES

   102

    cycles_t cycles_sent; /**< Time, when the datagram was sent. */

   103

#endif

   104

    unsigned long jiffies_sent; /**< Jiffies, when the datagram was sent. */

   105

#ifdef EC_HAVE_CYCLES

   106

    cycles_t cycles_received; /**< Time, when the datagram was received. */

   107

#endif

   108

    unsigned long jiffies_received; /**< Jiffies, when the datagram was

   109

                                      received. */

   110

    unsigned int skip_count; /**< Number of requeues when not yet received. */

   111

    unsigned long stats_output_jiffies; /**< Last statistics output. */

   112

    char name[EC_DATAGRAM_NAME_SIZE]; /**< Description of the datagram. */

   113

} ec_datagram_t;

   114

   115

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

   116

   117

void ec_datagram_init(ec_datagram_t *);

   118

void ec_datagram_clear(ec_datagram_t *);

   119

void ec_datagram_unqueue(ec_datagram_t *);

   120

int ec_datagram_prealloc(ec_datagram_t *, size_t);

   121

void ec_datagram_zero(ec_datagram_t *);

   122

   123

int ec_datagram_aprd(ec_datagram_t *, uint16_t, uint16_t, size_t);

   124

int ec_datagram_apwr(ec_datagram_t *, uint16_t, uint16_t, size_t);

   125

int ec_datagram_aprw(ec_datagram_t *, uint16_t, uint16_t, size_t);

   126

int ec_datagram_armw(ec_datagram_t *, uint16_t, uint16_t, size_t);

   127

int ec_datagram_fprd(ec_datagram_t *, uint16_t, uint16_t, size_t);

   128

int ec_datagram_fpwr(ec_datagram_t *, uint16_t, uint16_t, size_t);

   129

int ec_datagram_fprw(ec_datagram_t *, uint16_t, uint16_t, size_t);

   130

int ec_datagram_frmw(ec_datagram_t *, uint16_t, uint16_t, size_t);

   131

int ec_datagram_brd(ec_datagram_t *, uint16_t, size_t);

   132

int ec_datagram_bwr(ec_datagram_t *, uint16_t, size_t);

   133

int ec_datagram_brw(ec_datagram_t *, uint16_t, size_t);

   134

int ec_datagram_lrd(ec_datagram_t *, uint32_t, size_t, uint8_t *);

   135

int ec_datagram_lwr(ec_datagram_t *, uint32_t, size_t, uint8_t *);

   136

int ec_datagram_lrw(ec_datagram_t *, uint32_t, size_t, uint8_t *);

   137

   138

void ec_datagram_print_state(const ec_datagram_t *);

   139

void ec_datagram_print_wc_error(const ec_datagram_t *);

   140

void ec_datagram_output_stats(ec_datagram_t *);

   141

const char *ec_datagram_type_string(const ec_datagram_t *);

   142

   143

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

   144

   145

#endif