1

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

     2

 *

     3

 *  $Id: sync.c,v d9cf40facbc4 2010/05/03 16:07:57 fp $

     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

/** \file

    31

 * EtherCAT sync manager methods.

    32

 */

    33

    34

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

    35

    36

#include "globals.h"

    37

#include "slave.h"

    38

#include "master.h"

    39

#include "pdo.h"

    40

#include "sync.h"

    41

    42

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

    43

    44

/** Constructor.

    45

 */

    46

void ec_sync_init(

    47

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

    48

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

    49

        )

    50

{

    51

    sync->slave = slave;

    52

    sync->physical_start_address = 0x0000;

    53

    sync->default_length = 0x0000;

    54

    sync->control_register = 0x00;

    55

    sync->enable = 0x00;

    56

    ec_pdo_list_init(&sync->pdos);

    57

}

    58

    59

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

    60

    61

/** Copy constructor.

    62

 */

    63

void ec_sync_init_copy(

    64

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

    65

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

    66

        )

    67

{

    68

   sync->slave = other->slave;

    69

   sync->physical_start_address = other->physical_start_address;

    70

   sync->default_length = other->default_length;

    71

   sync->control_register = other->control_register;

    72

   sync->enable = other->enable;

    73

   ec_pdo_list_init(&sync->pdos);

    74

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

    75

}

    76

    77

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

    78

    79

/** Destructor.

    80

 */

    81

void ec_sync_clear(

    82

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

    83

        )

    84

{

    85

    ec_pdo_list_clear(&sync->pdos);

    86

}

    87

    88

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

    89

    90

/** Initializes a sync manager configuration page.

    91

 *

    92

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

    93

 */

    94

void ec_sync_page(

    95

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

    96

        uint8_t sync_index, /**< Index of the sync manager. */

    97

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

    98

        const ec_sync_config_t *sync_config, /**< Configuration. */

    99

        uint8_t pdo_xfer, /**< Non-zero, if PDOs will be transferred via this

   100

                            sync manager. */

   101

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

   102

        )

   103

{

   104

    // enable only if (SII enable is set or PDO xfer)

   105

    // and size is > 0 and SM is not virtual

   106

    uint16_t enable = ((sync->enable & 0x01) || pdo_xfer)

   107

                        && data_size

   108

                        && ((sync->enable & 0x04) == 0);

   109

    uint8_t control = sync->control_register;

   110

   111

    if (sync_config) {

   112

   113

        switch (sync_config->dir) {

   114

            case EC_DIR_OUTPUT:

   115

            case EC_DIR_INPUT:

   116

                EC_WRITE_BIT(&control, 2,

   117

                        sync_config->dir == EC_DIR_OUTPUT ? 1 : 0);

   118

                EC_WRITE_BIT(&control, 3, 0);

   119

                break;

   120

            default:

   121

                break;

   122

        }

   123

   124

        switch (sync_config->watchdog_mode) {

   125

            case EC_WD_ENABLE:

   126

            case EC_WD_DISABLE:

   127

                EC_WRITE_BIT(&control, 6,

   128

                        sync_config->watchdog_mode == EC_WD_ENABLE);

   129

                break;

   130

            default:

   131

                break;

   132

        }

   133

    }

   134

   135

    EC_SLAVE_DBG(sync->slave, 1, "SM%u: Addr 0x%04X, Size %3u,"

   136

            " Ctrl 0x%02X, En %u\n",

   137

            sync_index, sync->physical_start_address,

   138

            data_size, control, enable);

   139

   140

    EC_WRITE_U16(data,     sync->physical_start_address);

   141

    EC_WRITE_U16(data + 2, data_size);

   142

    EC_WRITE_U8 (data + 4, control);

   143

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

   144

    EC_WRITE_U16(data + 6, enable);

   145

}

   146

   147

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

   148

   149

/** Adds a PDO to the list of known mapped PDOs.

   150

 *

   151

 * \return 0 on success, else < 0

   152

 */

   153

int ec_sync_add_pdo(

   154

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

   155

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

   156

        )

   157

{

   158

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

   159

}

   160

   161

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

   162

   163

/** Determines the default direction from the control register.

   164

 */

   165

ec_direction_t ec_sync_default_direction(

   166

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

   167

        )

   168

{

   169

    switch ((sync->control_register & 0x0C) >> 2) {

   170

        case 0x0: return EC_DIR_INPUT;

   171

        case 0x1: return EC_DIR_OUTPUT;

   172

        default: return EC_DIR_INVALID;

   173

    }

   174

}

   175

   176

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