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 methods.

    36

 */

    37

    38

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

    39

    40

#include "globals.h"

    41

#include "slave.h"

    42

#include "master.h"

    43

#include "pdo.h"

    44

#include "sync.h"

    45

    46

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

    47

    48

/** Constructor.

    49

 */

    50

void ec_sync_init(

    51

        ec_sync_t *sync, /**< EtherCAT sync manager. */

    52

        ec_slave_t *slave, /**< EtherCAT slave. */

    53

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

    54

        )

    55

{

    56

    sync->slave = slave;

    57

    sync->index = index;    

    58

    59

    ec_pdo_list_init(&sync->pdos);

    60

    sync->assign_source = EC_ASSIGN_NONE;

    61

}

    62

    63

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

    64

    65

/** Copy constructor.

    66

 */

    67

void ec_sync_init_copy(

    68

        ec_sync_t *sync, /**< EtherCAT sync manager. */

    69

        const ec_sync_t *other /**< Sync manager to copy from. */

    70

        )

    71

{

    72

   sync->slave = other->slave;

    73

   sync->index = other->index;

    74

   sync->physical_start_address = other->physical_start_address;

    75

   sync->length = other->length;

    76

   sync->control_register = other->control_register;

    77

   sync->enable = other->enable;

    78

    79

   ec_pdo_list_init(&sync->pdos);

    80

   ec_pdo_list_copy(&sync->pdos, &other->pdos);

    81

    82

   sync->assign_source = other->assign_source;

    83

}

    84

    85

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

    86

    87

/** Destructor.

    88

 */

    89

void ec_sync_clear(

    90

        ec_sync_t *sync /**< EtherCAT sync manager. */

    91

        )

    92

{

    93

    ec_pdo_list_clear(&sync->pdos);

    94

}

    95

    96

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

    97

    98

/** Initializes a sync manager configuration page with SII data.

    99

 *

   100

 * The referenced memory (\a data) must be at least \a EC_SYNC_SIZE bytes.

   101

 */

   102

void ec_sync_config(

   103

        const ec_sync_t *sync, /**< Sync manager. */

   104

        uint16_t data_size, /**< Data size. */

   105

        uint8_t *data /**> Configuration memory. */

   106

        )

   107

{

   108

    // enable only if SII enable is set and size is > 0.

   109

    uint16_t enable = sync->enable && data_size;

   110

   111

    if (sync->slave->master->debug_level) {

   112

        EC_DBG("SM%u: Addr 0x%04X, Size %3u, Ctrl 0x%02X, En %u\n",

   113

               sync->index, sync->physical_start_address,

   114

               data_size, sync->control_register, enable);

   115

    }

   116

   117

    EC_WRITE_U16(data,     sync->physical_start_address);

   118

    EC_WRITE_U16(data + 2, data_size);

   119

    EC_WRITE_U8 (data + 4, sync->control_register);

   120

    EC_WRITE_U8 (data + 5, 0x00); // status byte (read only)

   121

    EC_WRITE_U16(data + 6, enable);

   122

}

   123

   124

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

   125

   126

/** Adds a Pdo to the list of known mapped Pdos.

   127

 *

   128

 * \return 0 on success, else < 0

   129

 */

   130

int ec_sync_add_pdo(

   131

        ec_sync_t *sync, /**< EtherCAT sync manager. */

   132

        const ec_pdo_t *pdo /**< Pdo to map. */

   133

        )

   134

{

   135

    return ec_pdo_list_add_pdo_copy(&sync->pdos, pdo);

   136

}

   137

   138

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

   139

   140

/** Get direction covered by sync manager.

   141

 *

   142

 * \return Direction covered by the given sync manager.

   143

 */

   144

ec_direction_t ec_sync_direction(

   145

        const ec_sync_t *sync /**< EtherCAT sync manager. */

   146

        )

   147

{

   148

    int index = sync->index;

   149

   150

    if (sync->slave->sii.sync_count != 1) {

   151

        if (sync->slave && sync->slave->sii.mailbox_protocols) {

   152

            index -= 2;

   153

        }

   154

   155

        if (index < 0 || index > 1) {

   156

            EC_WARN("ec_sync_get_direction(): invalid sync manager index.\n");

   157

            return EC_DIR_OUTPUT;

   158

        }

   159

    } else { // sync_count == 1

   160

        if (!list_empty(&sync->pdos.list)) {

   161

            const ec_pdo_t *pdo =

   162

                list_entry(sync->pdos.list.next, ec_pdo_t, list);

   163

            return pdo->dir;

   164

        }

   165

   166

    }

   167

   168

    return (ec_direction_t) index;

   169

}

   170

   171

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