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

/**

    35

   \file

    36

   EtherCAT sync manager methods.

    37

*/

    38

    39

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

    40

    41

#include "globals.h"

    42

#include "slave.h"

    43

#include "master.h"

    44

#include "pdo.h"

    45

#include "sync.h"

    46

    47

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

    48

    49

/**

    50

 * Constructor.

    51

 */

    52

    53

void ec_sync_init(

    54

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

    55

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

    56

        unsigned int index /**< sync manager index */

    57

        )

    58

{

    59

    sync->slave = slave;

    60

    sync->index = index;    

    61

    62

    sync->est_length = 0;

    63

    INIT_LIST_HEAD(&sync->pdos);

    64

    sync->alt_mapping = 0;

    65

}

    66

    67

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

    68

    69

/**

    70

 * Destructor.

    71

 */

    72

    73

void ec_sync_clear(

    74

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

    75

        )

    76

{

    77

    ec_sync_clear_pdos(sync);

    78

}

    79

    80

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

    81

    82

/**

    83

 * Calculates the size of a sync manager by evaluating PDO sizes.

    84

 * \return sync manager size

    85

 */

    86

    87

uint16_t ec_sync_size(

    88

        const ec_sync_t *sync /**< sync manager */

    89

        )

    90

{

    91

    const ec_pdo_t *pdo;

    92

    const ec_pdo_entry_t *pdo_entry;

    93

    unsigned int bit_size, byte_size;

    94

    95

    if (sync->length) return sync->length;

    96

    if (sync->est_length) return sync->est_length;

    97

    98

    bit_size = 0;

    99

    list_for_each_entry(pdo, &sync->pdos, list) {

   100

        list_for_each_entry(pdo_entry, &pdo->entries, list) {

   101

            bit_size += pdo_entry->bit_length;

   102

        }

   103

    }

   104

   105

    if (bit_size % 8) // round up to full bytes

   106

        byte_size = bit_size / 8 + 1;

   107

    else

   108

        byte_size = bit_size / 8;

   109

   110

    return byte_size;

   111

}

   112

   113

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

   114

   115

/**

   116

   Initializes a sync manager configuration page with EEPROM data.

   117

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

   118

*/

   119

   120

void ec_sync_config(

   121

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

   122

        uint8_t *data /**> configuration memory */

   123

        )

   124

{

   125

    size_t sync_size = ec_sync_size(sync);

   126

   127

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

   128

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

   129

               sync->index, sync->physical_start_address,

   130

               sync_size, sync->control_register, sync->enable);

   131

    }

   132

   133

    EC_WRITE_U16(data,     sync->physical_start_address);

   134

    EC_WRITE_U16(data + 2, sync_size);

   135

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

   136

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

   137

    EC_WRITE_U16(data + 6, sync->enable ? 0x0001 : 0x0000); // enable

   138

}

   139

   140

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

   141

   142

/**

   143

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

   144

 * \return 0 on success, else < 0

   145

 */

   146

   147

int ec_sync_add_pdo(

   148

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

   149

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

   150

        )

   151

{

   152

    ec_pdo_t *mapped_pdo;

   153

   154

    // PDO already mapped?

   155

    list_for_each_entry(mapped_pdo, &sync->pdos, list) {

   156

        if (mapped_pdo->index != pdo->index) continue;

   157

        EC_ERR("PDO 0x%04X is already mapped!\n", pdo->index);

   158

        return -1;

   159

    }

   160

   161

    if (!(mapped_pdo = kmalloc(sizeof(ec_pdo_t), GFP_KERNEL))) {

   162

        EC_ERR("Failed to allocate memory for PDO mapping.\n");

   163

        return -1;

   164

    }

   165

   166

    ec_pdo_init(mapped_pdo);

   167

    if (ec_pdo_copy(mapped_pdo, pdo)) {

   168

        ec_pdo_clear(mapped_pdo);

   169

        kfree(mapped_pdo);

   170

        return -1;

   171

    }

   172

   173

    // set appropriate sync manager index

   174

    mapped_pdo->sync_index = sync->index;

   175

   176

    list_add_tail(&mapped_pdo->list, &sync->pdos);

   177

    return 0;

   178

}

   179

   180

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

   181

   182

/**

   183

 * Clears the list of known mapped PDOs.

   184

 */

   185

   186

void ec_sync_clear_pdos(

   187

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

   188

        )

   189

{

   190

    ec_pdo_t *pdo, *next;

   191

   192

    // free all mapped PDOs

   193

    list_for_each_entry_safe(pdo, next, &sync->pdos, list) {

   194

        list_del(&pdo->list);

   195

        ec_pdo_clear(pdo);

   196

        kfree(pdo);

   197

    }

   198

}

   199

   200

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

   201

   202

/**

   203

 * \return Type of PDOs covered by the given sync manager.

   204

 */

   205

   206

ec_pdo_type_t ec_sync_get_pdo_type(

   207

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

   208

        )

   209

{

   210

    int index = sync->index;

   211

   212

    if (sync->slave && sync->slave->sii_mailbox_protocols) {

   213

        index -= 2;

   214

    }

   215

   216

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

   217

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

   218

        return EC_RX_PDO;

   219

    }

   220

   221

    return (ec_pdo_type_t) index;

   222

}

   223

   224

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