1

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

     2

 *

     3

 *  $Id$

     4

 *

     5

 *  Copyright (C) 2006  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

    10

 *  and/or modify it under the terms of the GNU General Public License

    11

 *  as published by the Free Software Foundation; either version 2 of the

    12

 *  License, or (at your option) any later version.

    13

 *

    14

 *  The IgH EtherCAT Master is distributed in the hope that it will be

    15

 *  useful, but WITHOUT ANY WARRANTY; without even the implied warranty of

    16

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    17

 *  GNU General Public License for more details.

    18

 *

    19

 *  You should have received a copy of the GNU General Public License

    20

 *  along with the IgH EtherCAT Master; if not, write to the Free Software

    21

 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

    22

 *

    23

 *  The right to use EtherCAT Technology is granted and comes free of

    24

 *  charge under condition of compatibility of product made by

    25

 *  Licensee. People intending to distribute/sell products based on the

    26

 *  code, have to sign an agreement to guarantee that products using

    27

 *  software based on IgH EtherCAT master stay compatible with the actual

    28

 *  EtherCAT specification (which are released themselves as an open

    29

 *  standard) as the (only) precondition to have the right to use EtherCAT

    30

 *  Technology, IP and trade marks.

    31

 *

    32

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

    33

    34

/**

    35

   \file

    36

   EtherCAT Process data object structure.

    37

*/

    38

    39

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

    40

    41

#ifndef _EC_PDO_H_

    42

#define _EC_PDO_H_

    43

    44

#include <linux/list.h>

    45

    46

#include "../include/ecrt.h"

    47

    48

#include "globals.h"

    49

    50

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

    51

    52

/** Pdo description.

    53

 */

    54

typedef struct {

    55

    struct list_head list; /**< List item. */

    56

    ec_direction_t dir; /**< Pdo direction. */

    57

    uint16_t index; /**< Pdo index. */

    58

    int8_t sync_index; /**< Assigned sync manager. */

    59

    char *name; /**< Pdo name. */

    60

    struct list_head entries; /**< List of Pdo entries. */

    61

    unsigned int default_config; /**< The entries contain the default Pdo

    62

                                   configuration. */

    63

} ec_pdo_t;

    64

    65

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

    66

    67

/** Pdo entry description.

    68

 */

    69

typedef struct {

    70

    struct list_head list; /**< list item */

    71

    uint16_t index; /**< Pdo entry index */

    72

    uint8_t subindex; /**< Pdo entry subindex */

    73

    char *name; /**< entry name */

    74

    uint8_t bit_length; /**< entry length in bit */

    75

} ec_pdo_entry_t;

    76

    77

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

    78

    79

void ec_pdo_init(ec_pdo_t *);

    80

int ec_pdo_init_copy(ec_pdo_t *, const ec_pdo_t *);

    81

void ec_pdo_clear(ec_pdo_t *);

    82

void ec_pdo_clear_entries(ec_pdo_t *);

    83

int ec_pdo_set_name(ec_pdo_t *, const char *);

    84

ec_pdo_entry_t *ec_pdo_add_entry(ec_pdo_t *, uint16_t, uint8_t, uint8_t);

    85

int ec_pdo_copy_entries(ec_pdo_t *, const ec_pdo_t *);

    86

int ec_pdo_equal_entries(const ec_pdo_t *, const ec_pdo_t *);

    87

    88

void ec_pdo_entry_init(ec_pdo_entry_t *);

    89

int ec_pdo_entry_init_copy(ec_pdo_entry_t *, const ec_pdo_entry_t *);

    90

void ec_pdo_entry_clear(ec_pdo_entry_t *);

    91

int ec_pdo_entry_set_name(ec_pdo_entry_t *, const char *);

    92

int ec_pdo_entry_equal(const ec_pdo_entry_t *, const ec_pdo_entry_t *);

    93

    94

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

    95

    96

#endif