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

 *  Using the EtherCAT technology and brand is permitted in compliance with

    23

 *  the industrial property and similar rights of Beckhoff Automation GmbH.

    24

 *

    25

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

    26

    27

/** \file

    28

 * EtherCAT sync manager methods.

    29

 */

    30

    31

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

    32

    33

#include "globals.h"

    34

#include "slave.h"

    35

#include "master.h"

    36

#include "pdo.h"

    37

#include "sync.h"

    38

    39

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

    40

    41

/** Constructor.

    42

 */

    43

void ec_sync_init(

    44

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

    45

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

    46

        )

    47

{

    48

    sync->slave = slave;

    49

    sync->physical_start_address = 0x0000;

    50

    sync->default_length = 0x0000;

    51

    sync->control_register = 0x00;

    52

    sync->enable = 0x00;

    53

    ec_pdo_list_init(&sync->pdos);

    54

}

    55

    56

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

    57

    58

/** Copy constructor.

    59

 */

    60

void ec_sync_init_copy(

    61

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

    62

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

    63

        )

    64

{

    65

   sync->slave = other->slave;

    66

   sync->physical_start_address = other->physical_start_address;

    67

   sync->default_length = other->default_length;

    68

   sync->control_register = other->control_register;

    69

   sync->enable = other->enable;

    70

   ec_pdo_list_init(&sync->pdos);

    71

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

    72

}

    73

    74

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

    75

    76

/** Destructor.

    77

 */

    78

void ec_sync_clear(

    79

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

    80

        )

    81

{

    82

    ec_pdo_list_clear(&sync->pdos);

    83

}

    84

    85

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

    86

    87

/** Initializes a sync manager configuration page.

    88

 *

    89

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

    90

 */

    91

void ec_sync_page(

    92

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

    93

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

    94

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

    95

        ec_direction_t dir, /**< Direction (overrides the control byte,

    96

                              if set to EC_DIR_INPUT or EC_DIR_OUTPUT). */

    97

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

    98

        )

    99

{

   100

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

   101

    uint16_t enable = sync->enable && data_size;

   102

    uint8_t control = sync->control_register;

   103

   104

    if (dir == EC_DIR_OUTPUT || dir == EC_DIR_INPUT) {

   105

        // override sync manager direction bits with dir parameter

   106

        EC_WRITE_BIT(&control, 2, dir == EC_DIR_OUTPUT ? 1 : 0);

   107

        EC_WRITE_BIT(&control, 3, 0);

   108

    }

   109

   110

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

   111

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

   112

               sync_index, sync->physical_start_address,

   113

               data_size, control, enable);

   114

   115

    EC_WRITE_U16(data,     sync->physical_start_address);

   116

    EC_WRITE_U16(data + 2, data_size);

   117

    EC_WRITE_U8 (data + 4, control);

   118

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

   119

    EC_WRITE_U16(data + 6, enable);

   120

}

   121

   122

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

   123

   124

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

   125

 *

   126

 * \return 0 on success, else < 0

   127

 */

   128

int ec_sync_add_pdo(

   129

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

   130

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

   131

        )

   132

{

   133

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

   134

}

   135

   136

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

   137

   138

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

   139

 */

   140

ec_direction_t ec_sync_default_direction(

   141

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

   142

        )

   143

{

   144

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

   145

        case 0x0: return EC_DIR_INPUT;

   146

        case 0x1: return EC_DIR_OUTPUT;

   147

        default: return EC_DIR_INVALID;

   148

    }

   149

}

   150

   151

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