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

/** \file

    35

 * EtherCAT sync manager.

    36

 */

    37

    38

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

    39

    40

#ifndef _EC_SYNC_H_

    41

#define _EC_SYNC_H_

    42

    43

#include <linux/list.h>

    44

    45

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

    46

    47

#include "globals.h"

    48

#include "pdo_mapping.h"

    49

    50

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

    51

    52

/** EtherCAT sync manager PDO mapping information source.

    53

 */

    54

typedef enum {

    55

    EC_SYNC_MAPPING_NONE, /**< No PDO mapping information. */

    56

    EC_SYNC_MAPPING_SII, /**< PDO mapping information from SII. */

    57

    EC_SYNC_MAPPING_COE, /**< PDO mapping information from CoE dictionary. */

    58

    EC_SYNC_MAPPING_CUSTOM, /**< PDO mapping configured externally. */

    59

} ec_sync_mapping_source_t;

    60

    61

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

    62

    63

/** Sync manager.

    64

 */

    65

typedef struct {

    66

    ec_slave_t *slave; /**< Slave, the sync manager belongs to. */

    67

    unsigned int index; /**< Sync manager index. */

    68

    uint16_t physical_start_address; /**< Physical start address. */

    69

    uint16_t length; /**< Data length in bytes. */

    70

    uint8_t control_register; /**< Control register value. */

    71

    uint8_t enable; /**< Enable bit. */

    72

    ec_pdo_mapping_t mapping; /**< Current Pdo mapping. */

    73

    ec_sync_mapping_source_t mapping_source; /**< Pdo mapping source. */

    74

} ec_sync_t;

    75

    76

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

    77

    78

void ec_sync_init(ec_sync_t *, ec_slave_t *, unsigned int);

    79

void ec_sync_clear(ec_sync_t *);

    80

    81

void ec_sync_config(const ec_sync_t *, uint16_t, uint8_t *);

    82

    83

int ec_sync_add_pdo(ec_sync_t *, const ec_pdo_t *);

    84

    85

ec_direction_t ec_sync_direction(const ec_sync_t *);

    86

    87

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

    88

    89

#endif