1

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

     2

 *

     3

 *  $Id$

     4

 *

     5

 *  Copyright (C) 2006-2012  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

#include "coe_emerg_ring.h"

    47

    48

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

    49

    50

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

    51

 * syslog.

    52

 *

    53

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

    54

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

    55

 * and ALIAS and POSITION identify the configuration.

    56

 *

    57

 * \param sc EtherCAT slave configuration

    58

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

    59

 * \param args arguments (optional)

    60

 */

    61

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

    62

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

    63

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

    64

    65

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

    66

 *

    67

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

    68

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

    69

 * and ALIAS and POSITION identify the configuration.

    70

 *

    71

 * \param sc EtherCAT slave configuration

    72

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

    73

 * \param args arguments (optional)

    74

 */

    75

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

    76

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

    77

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

    78

    79

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

    80

 *

    81

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

    82

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

    83

 * and ALIAS and POSITION identify the configuration.

    84

 *

    85

 * \param sc EtherCAT slave configuration

    86

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

    87

 * \param args arguments (optional)

    88

 */

    89

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

    90

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

    91

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

    92

    93

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

    94

 * syslog.

    95

 *

    96

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

    97

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

    98

 * and ALIAS and POSITION identify the configuration.

    99

 *

   100

 * \param sc EtherCAT slave configuration

   101

 * \param level Debug level. Master's debug level must be >= \a level for

   102

 * output.

   103

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

   104

 * \param args arguments (optional)

   105

 */

   106

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

   107

    do { \

   108

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

   109

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

   110

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

   111

        } \

   112

    } while (0)

   113

   114

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

   115

   116

/** EtherCAT slave configuration.

   117

 */

   118

struct ec_slave_config {

   119

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

   120

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

   121

   122

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

   123

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

   124

                         ring position. */

   125

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

   126

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

   127

   128

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

   129

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

   130

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

   131

                                   spec. reg. 0x0420). */

   132

   133

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

   134

                                      as output PDOs. */

   135

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

   136

                         offline. */

   137

   138

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

   139

                                                   configurations. */

   140

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

   141

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

   142

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

   143

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

   144

   145

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

   146

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

   147

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

   148

    struct list_head reg_requests; /**< List of register requests. */

   149

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

   150

   151

    ec_coe_emerg_ring_t emerg_ring; /**< CoE emergency ring buffer. */

   152

};

   153

   154

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

   155

   156

void ec_slave_config_init(ec_slave_config_t *, ec_master_t *, uint16_t,

   157

        uint16_t, uint32_t, uint32_t);

   158

void ec_slave_config_clear(ec_slave_config_t *);

   159

   160

int ec_slave_config_attach(ec_slave_config_t *);

   161

void ec_slave_config_detach(ec_slave_config_t *);

   162

   163

void ec_slave_config_load_default_sync_config(ec_slave_config_t *);

   164

   165

unsigned int ec_slave_config_sdo_count(const ec_slave_config_t *);

   166

const ec_sdo_request_t *ec_slave_config_get_sdo_by_pos_const(

   167

        const ec_slave_config_t *, unsigned int);

   168

unsigned int ec_slave_config_idn_count(const ec_slave_config_t *);

   169

const ec_soe_request_t *ec_slave_config_get_idn_by_pos_const(

   170

        const ec_slave_config_t *, unsigned int);

   171

ec_sdo_request_t *ec_slave_config_find_sdo_request(ec_slave_config_t *,

   172

        unsigned int);

   173

ec_reg_request_t *ec_slave_config_find_reg_request(ec_slave_config_t *,

   174

        unsigned int);

   175

ec_voe_handler_t *ec_slave_config_find_voe_handler(ec_slave_config_t *,

   176

        unsigned int);

   177

void ec_slave_config_expire_disconnected_requests(ec_slave_config_t *);

   178

   179

ec_sdo_request_t *ecrt_slave_config_create_sdo_request_err(

   180

        ec_slave_config_t *, uint16_t, uint8_t, size_t);

   181

ec_voe_handler_t *ecrt_slave_config_create_voe_handler_err(

   182

        ec_slave_config_t *, size_t);

   183

ec_reg_request_t *ecrt_slave_config_create_reg_request_err(

   184

        ec_slave_config_t *, size_t);

   185

   186

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

   187

   188

#endif