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

 *  ---

    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

/**

    31

   \file

    32

   EtherCAT slave configuration structure.

    33

*/

    34

    35

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

    36

    37

#ifndef __EC_SLAVE_CONFIG_H__

    38

#define __EC_SLAVE_CONFIG_H__

    39

    40

#include <linux/list.h>

    41

    42

#include "globals.h"

    43

#include "slave.h"

    44

#include "sync_config.h"

    45

#include "fmmu_config.h"

    46

    47

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

    48

    49

/** Convenience macro for printing configuration-specific information to

    50

 * syslog.

    51

 *

    52

 * This will print the message in \a fmt with a prefixed

    53

 * "EtherCAT <INDEX> <ALIAS>:<POSITION>: ", where INDEX is the master index

    54

 * and ALIAS and POSITION identify the configuration.

    55

 *

    56

 * \param sc EtherCAT slave configuration

    57

 * \param fmt format string (like in printf())

    58

 * \param args arguments (optional)

    59

 */

    60

#define EC_CONFIG_INFO(sc, fmt, args...) \

    61

    printk(KERN_INFO "EtherCAT %u %u:%u: " fmt, sc->master->index, \

    62

            sc->alias, sc->position, ##args)

    63

    64

/** Convenience macro for printing configuration-specific errors to syslog.

    65

 *

    66

 * This will print the message in \a fmt with a prefixed

    67

 * "EtherCAT <INDEX> <ALIAS>:<POSITION>: ", where INDEX is the master index

    68

 * and ALIAS and POSITION identify the configuration.

    69

 *

    70

 * \param sc EtherCAT slave configuration

    71

 * \param fmt format string (like in printf())

    72

 * \param args arguments (optional)

    73

 */

    74

#define EC_CONFIG_ERR(sc, fmt, args...) \

    75

    printk(KERN_ERR "EtherCAT ERROR %u %u:%u: " fmt, sc->master->index, \

    76

            sc->alias, sc->position, ##args)

    77

    78

/** Convenience macro for printing configuration-specific warnings to syslog.

    79

 *

    80

 * This will print the message in \a fmt with a prefixed

    81

 * "EtherCAT <INDEX> <ALIAS>:<POSITION>: ", where INDEX is the master index

    82

 * and ALIAS and POSITION identify the configuration.

    83

 *

    84

 * \param sc EtherCAT slave configuration

    85

 * \param fmt format string (like in printf())

    86

 * \param args arguments (optional)

    87

 */

    88

#define EC_CONFIG_WARN(sc, fmt, args...) \

    89

    printk(KERN_WARNING "EtherCAT WARNING %u %u:%u: " fmt, \

    90

            sc->master->index, sc->alias, sc->position, ##args)

    91

    92

/** Convenience macro for printing configuration-specific debug messages to

    93

 * syslog.

    94

 *

    95

 * This will print the message in \a fmt with a prefixed

    96

 * "EtherCAT <INDEX> <ALIAS>:<POSITION>: ", where INDEX is the master index

    97

 * and ALIAS and POSITION identify the configuration.

    98

 *

    99

 * \param sc EtherCAT slave configuration

   100

 * \param fmt format string (like in printf())

   101

 * \param args arguments (optional)

   102

 */

   103

#define EC_CONFIG_DBG(sc, level, fmt, args...) \

   104

    do { \

   105

        if (sc->master->debug_level >= level) { \

   106

            printk(KERN_DEBUG "EtherCAT DEBUG %u %u:%u: " fmt, \

   107

                    sc->master->index, sc->alias, sc->position, ##args); \

   108

        } \

   109

    } while (0)

   110

   111

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

   112

   113

/** EtherCAT slave configuration.

   114

 */

   115

struct ec_slave_config {

   116

    struct list_head list; /**< List item. */

   117

    ec_master_t *master; /**< Master owning the slave configuration. */

   118

   119

    uint16_t alias; /**< Slave alias. */

   120

    uint16_t position; /**< Index after alias. If alias is zero, this is the

   121

                         ring position. */

   122

    uint32_t vendor_id; /**< Slave vendor ID. */

   123

    uint32_t product_code; /**< Slave product code. */

   124

   125

    uint16_t watchdog_divider; /**< Watchdog divider as a number of 40ns

   126

                                 intervals (see spec. reg. 0x0400). */

   127

    uint16_t watchdog_intervals; /**< Process data watchdog intervals (see

   128

                                   spec. reg. 0x0420). */

   129

    uint8_t allow_overlapping_pdos;	/**< Allow input PDOs use the same frame space

   130

                                      as output PDOs. */

   131

    ec_slave_t *slave; /**< Slave pointer. This is \a NULL, if the slave is

   132

                         offline. */

   133

   134

    ec_sync_config_t sync_configs[EC_MAX_SYNC_MANAGERS]; /**< Sync manager

   135

                                                   configurations. */

   136

    ec_fmmu_config_t fmmu_configs[EC_MAX_FMMUS]; /**< FMMU configurations. */

   137

    uint8_t used_fmmus; /**< Number of FMMUs used. */

   138

    uint16_t dc_assign_activate; /**< Vendor-specific AssignActivate word. */

   139

    ec_sync_signal_t dc_sync[EC_SYNC_SIGNAL_COUNT]; /**< DC sync signals. */

   140

   141

    struct list_head sdo_configs; /**< List of SDO configurations. */

   142

    struct list_head sdo_requests; /**< List of SDO requests. */

   143

    struct list_head voe_handlers; /**< List of VoE handlers. */

   144

    struct list_head soe_configs; /**< List of SoE configurations. */

   145

};

   146

   147

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

   148

   149

void ec_slave_config_init(ec_slave_config_t *, ec_master_t *, uint16_t,

   150

        uint16_t, uint32_t, uint32_t);

   151

void ec_slave_config_clear(ec_slave_config_t *);

   152

   153

int ec_slave_config_attach(ec_slave_config_t *);

   154

void ec_slave_config_detach(ec_slave_config_t *);

   155

   156

void ec_slave_config_load_default_sync_config(ec_slave_config_t *);

   157

   158

unsigned int ec_slave_config_sdo_count(const ec_slave_config_t *);

   159

const ec_sdo_request_t *ec_slave_config_get_sdo_by_pos_const(

   160

        const ec_slave_config_t *, unsigned int);

   161

unsigned int ec_slave_config_idn_count(const ec_slave_config_t *);

   162

const ec_soe_request_t *ec_slave_config_get_idn_by_pos_const(

   163

        const ec_slave_config_t *, unsigned int);

   164

ec_sdo_request_t *ec_slave_config_find_sdo_request(ec_slave_config_t *,

   165

        unsigned int);

   166

ec_voe_handler_t *ec_slave_config_find_voe_handler(ec_slave_config_t *,

   167

        unsigned int);

   168

   169

ec_sdo_request_t *ecrt_slave_config_create_sdo_request_err(

   170

        ec_slave_config_t *, uint16_t, uint8_t, size_t);

   171

ec_voe_handler_t *ecrt_slave_config_create_voe_handler_err(

   172

        ec_slave_config_t *, size_t);

   173

   174

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

   175

   176

#endif