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

    sync->mapping_source = EC_SYNC_MAPPING_NONE;

    66

}

    67

    68

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

    69

    70

/**

    71

 * Destructor.

    72

 */

    73

    74

void ec_sync_clear(

    75

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

    76

        )

    77

{

    78

    ec_sync_clear_pdos(sync);

    79

}

    80

    81

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

    82

    83

/**

    84

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

    85

 * \return sync manager size

    86

 */

    87

    88

uint16_t ec_sync_size(

    89

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

    90

        )

    91

{

    92

    const ec_pdo_t *pdo;

    93

    const ec_pdo_entry_t *pdo_entry;

    94

    unsigned int bit_size, byte_size;

    95

    96

    // if an estimated length is specified, return it

    97

    if (sync->est_length)

    98

        return sync->est_length;

    99

   100

    // calculate total Pdo size in bit

   101

    bit_size = 0;

   102

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

   103

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

   104

            bit_size += pdo_entry->bit_length;

   105

        }

   106

    }

   107

   108

    // bits to bytes

   109

    if (bit_size % 8) {

   110

        // round up to full bytes

   111

        byte_size = bit_size / 8 + 1;

   112

    } else {

   113

        byte_size = bit_size / 8;

   114

    }

   115

   116

    if (byte_size) {

   117

        // return total Pdo size, if there are Pdos assigned

   118

        return byte_size;

   119

    } else {

   120

        // return sync manager default size, if no Pdos are assigned

   121

        return sync->length;

   122

    }

   123

}

   124

   125

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

   126

   127

/**

   128

   Initializes a sync manager configuration page with EEPROM data.

   129

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

   130

*/

   131

   132

void ec_sync_config(

   133

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

   134

        uint8_t *data /**> configuration memory */

   135

        )

   136

{

   137

    size_t sync_size = ec_sync_size(sync);

   138

   139

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

   140

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

   141

               sync->index, sync->physical_start_address,

   142

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

   143

    }

   144

   145

    EC_WRITE_U16(data,     sync->physical_start_address);

   146

    EC_WRITE_U16(data + 2, sync_size);

   147

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

   148

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

   149

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

   150

}

   151

   152

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

   153

   154

/**

   155

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

   156

 * \return 0 on success, else < 0

   157

 */

   158

   159

int ec_sync_add_pdo(

   160

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

   161

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

   162

        )

   163

{

   164

    ec_pdo_t *mapped_pdo;

   165

   166

    // PDO already mapped?

   167

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

   168

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

   169

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

   170

        return -1;

   171

    }

   172

   173

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

   174

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

   175

        return -1;

   176

    }

   177

   178

    ec_pdo_init(mapped_pdo);

   179

    if (ec_pdo_copy(mapped_pdo, pdo)) {

   180

        ec_pdo_clear(mapped_pdo);

   181

        kfree(mapped_pdo);

   182

        return -1;

   183

    }

   184

   185

    // set appropriate sync manager index

   186

    mapped_pdo->sync_index = sync->index;

   187

   188

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

   189

    return 0;

   190

}

   191

   192

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

   193

   194

/**

   195

 * Clears the list of known mapped PDOs.

   196

 */

   197

   198

void ec_sync_clear_pdos(

   199

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

   200

        )

   201

{

   202

    ec_pdo_t *pdo, *next;

   203

   204

    // free all mapped PDOs

   205

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

   206

        list_del(&pdo->list);

   207

        ec_pdo_clear(pdo);

   208

        kfree(pdo);

   209

    }

   210

}

   211

   212

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

   213

   214

/**

   215

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

   216

 */

   217

   218

ec_pdo_type_t ec_sync_get_pdo_type(

   219

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

   220

        )

   221

{

   222

    int index = sync->index;

   223

   224

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

   225

        index -= 2;

   226

    }

   227

   228

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

   229

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

   230

        return EC_RX_PDO;

   231

    }

   232

   233

    return (ec_pdo_type_t) index;

   234

}

   235

   236

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