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

/** Slave port.

    53

 */

    54

typedef struct {

    55

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

    56

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

    57

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

    58

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

    59

                                            measurement. */

    60

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

    61

                                 this port [ns]. */

    62

} ec_slave_port_t;

    63

    64

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

    65

    66

/** Slave information interface data.

    67

 */

    68

typedef struct {

    69

    // Non-category data 

    70

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

    71

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

    72

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

    73

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

    74

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

    75

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

    76

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

    77

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

    78

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

    79

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

    80

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

    81

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

    82

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

    83

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

    84

    85

    // Strings

    86

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

    87

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

    88

    89

    // General

    90

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

    91

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

    92

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

    93

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

    94

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

    95

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

    96

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

    97

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

    98

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

    99

   100

    // SyncM

   101

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

   102

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

   103

   104

    // [RT]XPDO

   105

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

   106

} ec_sii_t;

   107

   108

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

   109

   110

/** EtherCAT slave.

   111

 */

   112

struct ec_slave

   113

{

   114

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

   115

   116

    // addresses

   117

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

   118

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

   119

   120

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

   121

   122

    // configuration

   123

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

   124

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

   125

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

   126

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

   127

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

   128

    uint16_t configured_rx_mailbox_offset; /**< Configured receive mailbox

   129

                                             offset. */

   130

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

   131

                                          */

   132

    uint16_t configured_tx_mailbox_offset; /**< Configured send mailbox

   133

                                             offset. */

   134

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

   135

   136

    // base data

   137

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

   138

    uint8_t base_revision; /**< Revision. */

   139

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

   140

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

   141

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

   142

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

   143

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

   144

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

   145

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

   146

                                  register. Otherwise it can only be used for

   147

                                  delay measurement. */

   148

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

   149

                                   (offset from reference clock). */

   150

   151

    // SII

   152

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

   153

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

   154

   155

    // Slave information interface

   156

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

   157

   158

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

   159

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

   160

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

   161

   162

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

   163

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

   164

                                   from user space. */

   165

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

   166

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

   167

                                   space. */

   168

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

   169

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

   170

                                   space. */

   171

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

   172

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

   173

};

   174

   175

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

   176

   177

// slave construction/destruction

   178

void ec_slave_init(ec_slave_t *, ec_master_t *, uint16_t, uint16_t);

   179

void ec_slave_clear(ec_slave_t *);

   180

   181

void ec_slave_clear_sync_managers(ec_slave_t *);

   182

   183

void ec_slave_request_state(ec_slave_t *, ec_slave_state_t);

   184

void ec_slave_set_state(ec_slave_t *, ec_slave_state_t);

   185

   186

// SII categories

   187

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

   188

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

   189

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

   190

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

   191

        ec_direction_t);

   192

   193

// misc.

   194

ec_sync_t *ec_slave_get_sync(ec_slave_t *, uint8_t); 

   195

   196

void ec_slave_sdo_dict_info(const ec_slave_t *,

   197

        unsigned int *, unsigned int *);

   198

ec_sdo_t *ec_slave_get_sdo(ec_slave_t *, uint16_t);

   199

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

   200

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

   201

uint16_t ec_slave_sdo_count(const ec_slave_t *);

   202

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

   203

void ec_slave_attach_pdo_names(ec_slave_t *);

   204

   205

void ec_slave_calc_port_delays(ec_slave_t *);

   206

void ec_slave_calc_transmission_delays_rec(ec_slave_t *, uint32_t *);

   207

   208

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

   209

   210

#endif