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 structure.

    33

*/

    34

    35

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

    36

    37

#ifndef __EC_SLAVE_H__

    38

#define __EC_SLAVE_H__

    39

    40

#include <linux/list.h>

    41

#include <linux/kobject.h>

    42

    43

#include "globals.h"

    44

#include "datagram.h"

    45

#include "pdo.h"

    46

#include "sync.h"

    47

#include "sdo.h"

    48

#include "fsm_slave.h"

    49

    50

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

    51

    52

/** Convenience macro for printing slave-specific information to syslog.

    53

 *

    54

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

    55

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

    56

 * POSITION is the slave's ring position.

    57

 *

    58

 * \param slave EtherCAT slave

    59

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

    60

 * \param args arguments (optional)

    61

 */

    62

#define EC_SLAVE_INFO(slave, fmt, args...) \

    63

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

    64

            slave->ring_position, ##args)

    65

    66

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

    67

 *

    68

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

    69

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

    70

 * POSITION is the slave's ring position.

    71

 *

    72

 * \param slave EtherCAT slave

    73

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

    74

 * \param args arguments (optional)

    75

 */

    76

#define EC_SLAVE_ERR(slave, fmt, args...) \

    77

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

    78

            slave->ring_position, ##args)

    79

    80

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

    81

 *

    82

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

    83

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

    84

 * POSITION is the slave's ring position.

    85

 *

    86

 * \param slave EtherCAT slave

    87

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

    88

 * \param args arguments (optional)

    89

 */

    90

#define EC_SLAVE_WARN(slave, fmt, args...) \

    91

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

    92

            slave->master->index, slave->ring_position, ##args)

    93

    94

/** Convenience macro for printing slave-specific debug messages to syslog.

    95

 *

    96

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

    97

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

    98

 * POSITION is the slave's ring position.

    99

 *

   100

 * \param slave EtherCAT slave

   101

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

   102

 * \param args arguments (optional)

   103

 */

   104

#define EC_SLAVE_DBG(slave, level, fmt, args...) \

   105

    do { \

   106

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

   107

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

   108

                    slave->master->index, slave->ring_position, ##args); \

   109

        } \

   110

    } while (0)

   111

   112

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

   113

   114

/** Slave port.

   115

 */

   116

typedef struct {

   117

    ec_slave_port_desc_t desc; /**< Port descriptors. */

   118

    ec_slave_port_link_t link; /**< Port link status. */

   119

    ec_slave_t *next_slave; /**< Connected slaves. */

   120

    uint32_t receive_time; /**< Port receive times for delay

   121

                                            measurement. */

   122

    uint32_t delay_to_next_dc; /**< Delay to next slave with DC support behind

   123

                                 this port [ns]. */

   124

} ec_slave_port_t;

   125

   126

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

   127

   128

/** Slave information interface data.

   129

 */

   130

typedef struct {

   131

    // Non-category data

   132

    uint16_t alias; /**< Configured station alias. */

   133

    uint32_t vendor_id; /**< Vendor ID. */

   134

    uint32_t product_code; /**< Vendor-specific product code. */

   135

    uint32_t revision_number; /**< Revision number. */

   136

    uint32_t serial_number; /**< Serial number. */

   137

    uint16_t boot_rx_mailbox_offset; /**< Bootstrap receive mailbox address. */

   138

    uint16_t boot_rx_mailbox_size; /**< Bootstrap receive mailbox size. */

   139

    uint16_t boot_tx_mailbox_offset; /**< Bootstrap transmit mailbox address. */

   140

    uint16_t boot_tx_mailbox_size; /**< Bootstrap transmit mailbox size. */

   141

    uint16_t std_rx_mailbox_offset; /**< Standard receive mailbox address. */

   142

    uint16_t std_rx_mailbox_size; /**< Standard receive mailbox size. */

   143

    uint16_t std_tx_mailbox_offset; /**< Standard transmit mailbox address. */

   144

    uint16_t std_tx_mailbox_size; /**< Standard transmit mailbox size. */

   145

    uint16_t mailbox_protocols; /**< Supported mailbox protocols. */

   146

   147

    // Strings

   148

    char **strings; /**< Strings in SII categories. */

   149

    unsigned int string_count; /**< Number of SII strings. */

   150

   151

    // General

   152

    unsigned int has_general; /**< General category present. */

   153

    char *group; /**< Group name. */

   154

    char *image; /**< Image name. */

   155

    char *order; /**< Order number. */

   156

    char *name; /**< Slave name. */

   157

    uint8_t physical_layer[EC_MAX_PORTS]; /**< Port media. */

   158

    ec_sii_coe_details_t coe_details; /**< CoE detail flags. */

   159

    ec_sii_general_flags_t general_flags; /**< General flags. */

   160

    int16_t current_on_ebus; /**< Power consumption in mA. */

   161

   162

    // SyncM

   163

    ec_sync_t *syncs; /**< SYNC MANAGER categories. */

   164

    unsigned int sync_count; /**< Number of sync managers. */

   165

   166

    // [RT]XPDO

   167

    struct list_head pdos; /**< SII [RT]XPDO categories. */

   168

} ec_sii_t;

   169

   170

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

   171

   172

/** EtherCAT slave.

   173

 */

   174

struct ec_slave

   175

{

   176

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

   177

    ec_device_index_t device_index; /**< Index of device the slave responds

   178

                                      on. */

   179

   180

    // addresses

   181

    uint16_t ring_position; /**< Ring position. */

   182

    uint16_t station_address; /**< Configured station address. */

   183

    uint16_t effective_alias; /**< Effective alias address. */

   184

   185

    ec_slave_port_t ports[EC_MAX_PORTS]; /**< Ports. */

   186

   187

    // configuration

   188

    ec_slave_config_t *config; /**< Current configuration. */

   189

    ec_slave_state_t requested_state; /**< Requested application state. */

   190

    ec_slave_state_t current_state; /**< Current application state. */

   191

    unsigned int error_flag; /**< Stop processing after an error. */

   192

    unsigned int force_config; /**< Force (re-)configuration. */

   193

    uint16_t configured_rx_mailbox_offset; /**< Configured receive mailbox

   194

                                             offset. */

   195

    uint16_t configured_rx_mailbox_size; /**< Configured receive mailbox size.

   196

                                          */

   197

    uint16_t configured_tx_mailbox_offset; /**< Configured send mailbox

   198

                                             offset. */

   199

    uint16_t configured_tx_mailbox_size; /**< Configured send mailbox size. */

   200

   201

    // base data

   202

    uint8_t base_type; /**< Slave type. */

   203

    uint8_t base_revision; /**< Revision. */

   204

    uint16_t base_build; /**< Build number. */

   205

    uint8_t base_fmmu_count; /**< Number of supported FMMUs. */

   206

    uint8_t base_sync_count; /**< Number of supported sync managers. */

   207

    uint8_t base_fmmu_bit_operation; /**< FMMU bit operation is supported. */

   208

    uint8_t base_dc_supported; /**< Distributed clocks are supported. */

   209

    ec_slave_dc_range_t base_dc_range; /**< DC range. */

   210

    uint8_t has_dc_system_time; /**< The slave supports the DC system time

   211

                                  register. Otherwise it can only be used for

   212

                                  delay measurement. */

   213

    uint32_t transmission_delay; /**< DC system time transmission delay

   214

                                   (offset from reference clock). */

   215

   216

    // SII

   217

    uint16_t *sii_words; /**< Complete SII image. */

   218

    size_t sii_nwords; /**< Size of the SII contents in words. */

   219

   220

    // Slave information interface

   221

    ec_sii_t sii; /**< Extracted SII data. */

   222

   223

    struct list_head sdo_dictionary; /**< SDO dictionary list */

   224

    uint8_t sdo_dictionary_fetched; /**< Dictionary has been fetched. */

   225

    unsigned long jiffies_preop; /**< Time, the slave went to PREOP. */

   226

   227

    struct list_head slave_sdo_requests; /**< SDO access requests. */

   228

    wait_queue_head_t sdo_queue; /**< Wait queue for SDO access requests

   229

                                   from user space. */

   230

    struct list_head foe_requests; /**< FoE write requests. */

   231

    wait_queue_head_t foe_queue; /**< Wait queue for FoE requests from user

   232

                                   space. */

   233

    struct list_head soe_requests; /**< FoE write requests. */

   234

    wait_queue_head_t soe_queue; /**< Wait queue for SoE requests from user

   235

                                   space. */

   236

    ec_fsm_slave_t fsm; /**< Slave state machine. */

   237

    ec_datagram_t fsm_datagram; /**< Datagram used for state machines. */

   238

};

   239

   240

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

   241

   242

// slave construction/destruction

   243

void ec_slave_init(ec_slave_t *, ec_master_t *, ec_device_index_t,

   244

        uint16_t, uint16_t);

   245

void ec_slave_clear(ec_slave_t *);

   246

   247

void ec_slave_clear_sync_managers(ec_slave_t *);

   248

   249

void ec_slave_request_state(ec_slave_t *, ec_slave_state_t);

   250

void ec_slave_set_state(ec_slave_t *, ec_slave_state_t);

   251

   252

// SII categories

   253

int ec_slave_fetch_sii_strings(ec_slave_t *, const uint8_t *, size_t);

   254

int ec_slave_fetch_sii_general(ec_slave_t *, const uint8_t *, size_t);

   255

int ec_slave_fetch_sii_syncs(ec_slave_t *, const uint8_t *, size_t);

   256

int ec_slave_fetch_sii_pdos(ec_slave_t *, const uint8_t *, size_t,

   257

        ec_direction_t);

   258

   259

// misc.

   260

ec_sync_t *ec_slave_get_sync(ec_slave_t *, uint8_t);

   261

   262

void ec_slave_sdo_dict_info(const ec_slave_t *,

   263

        unsigned int *, unsigned int *);

   264

ec_sdo_t *ec_slave_get_sdo(ec_slave_t *, uint16_t);

   265

const ec_sdo_t *ec_slave_get_sdo_const(const ec_slave_t *, uint16_t);

   266

const ec_sdo_t *ec_slave_get_sdo_by_pos_const(const ec_slave_t *, uint16_t);

   267

uint16_t ec_slave_sdo_count(const ec_slave_t *);

   268

const ec_pdo_t *ec_slave_find_pdo(const ec_slave_t *, uint16_t);

   269

void ec_slave_attach_pdo_names(ec_slave_t *);

   270

   271

void ec_slave_calc_port_delays(ec_slave_t *);

   272

void ec_slave_calc_transmission_delays_rec(ec_slave_t *, uint32_t *);

   273

   274

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

   275

   276

#endif