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

        )

    54

{

    55

    sync->slave = slave;

    56

    sync->physical_start_address = 0x0000;

    57

    sync->default_length = 0x0000;

    58

    sync->control_register = 0x00;

    59

    sync->enable = 0x00;

    60

    ec_pdo_list_init(&sync->pdos);

    61

    sync->assign_source = EC_ASSIGN_NONE;

    62

}

    63

    64

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

    65

    66

/** Copy constructor.

    67

 */

    68

void ec_sync_init_copy(

    69

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

    70

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

    71

        )

    72

{

    73

   sync->slave = other->slave;

    74

   sync->physical_start_address = other->physical_start_address;

    75

   sync->default_length = other->default_length;

    76

   sync->control_register = other->control_register;

    77

   sync->enable = other->enable;

    78

   ec_pdo_list_init(&sync->pdos);

    79

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

    80

   sync->assign_source = other->assign_source;

    81

}

    82

    83

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

    84

    85

/** Destructor.

    86

 */

    87

void ec_sync_clear(

    88

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

    89

        )

    90

{

    91

    ec_pdo_list_clear(&sync->pdos);

    92

}

    93

    94

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

    95

    96

/** Initializes a sync manager configuration page.

    97

 *

    98

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

    99

 */

   100

void ec_sync_page(

   101

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

   102

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

   103

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

   104

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

   105

                              if set to EC_DIR_INPUT or EC_DIR_OUTPUT). */

   106

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

   107

        )

   108

{

   109

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

   110

    uint16_t enable = sync->enable && data_size;

   111

    uint8_t control = sync->control_register;

   112

   113

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

   114

        // override sync manager direction bits with dir parameter

   115

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

   116

        EC_WRITE_BIT(&control, 3, 0);

   117

    }

   118

   119

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

   120

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

   121

               sync_index, sync->physical_start_address,

   122

               data_size, control, enable);

   123

   124

    EC_WRITE_U16(data,     sync->physical_start_address);

   125

    EC_WRITE_U16(data + 2, data_size);

   126

    EC_WRITE_U8 (data + 4, control);

   127

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

   128

    EC_WRITE_U16(data + 6, enable);

   129

}

   130

   131

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

   132

   133

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

   134

 *

   135

 * \return 0 on success, else < 0

   136

 */

   137

int ec_sync_add_pdo(

   138

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

   139

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

   140

        )

   141

{

   142

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

   143

}

   144

   145

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

   146

   147

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

   148

 */

   149

ec_direction_t ec_sync_default_direction(

   150

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

   151

        )

   152

{

   153

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

   154

        case 0x0: return EC_DIR_INPUT;

   155

        case 0x1: return EC_DIR_OUTPUT;

   156

        default: return EC_DIR_INVALID;

   157

    }

   158

}

   159

   160

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