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

    37

*/

    38

    39

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

    40

    41

#ifndef _EC_SLAVE_H_

    42

#define _EC_SLAVE_H_

    43

    44

#include <linux/list.h>

    45

#include <linux/kobject.h>

    46

    47

#include "../include/ecrt.h"

    48

    49

#include "globals.h"

    50

#include "datagram.h"

    51

#include "pdo.h"

    52

#include "sync.h"

    53

#include "sdo.h"

    54

    55

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

    56

    57

/** Slave state mask.

    58

 *

    59

 * Apply this mask to a slave state byte to get the slave state without

    60

 * the error flag.

    61

 */

    62

#define EC_SLAVE_STATE_MASK 0x0F

    63

    64

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

    65

    66

/** State of an EtherCAT slave.

    67

 */

    68

typedef enum {

    69

    EC_SLAVE_STATE_UNKNOWN = 0x00,

    70

    /**< unknown state */

    71

    EC_SLAVE_STATE_INIT = 0x01,

    72

    /**< INIT state (no mailbox communication, no IO) */

    73

    EC_SLAVE_STATE_PREOP = 0x02,

    74

    /**< PREOP state (mailbox communication, no IO) */

    75

    EC_SLAVE_STATE_SAFEOP = 0x04,

    76

    /**< SAFEOP (mailbox communication and input update) */

    77

    EC_SLAVE_STATE_OP = 0x08,

    78

    /**< OP (mailbox communication and input/output update) */

    79

    EC_SLAVE_STATE_ACK_ERR = 0x10

    80

    /**< Acknowledge/Error bit (no actual state) */

    81

} ec_slave_state_t;

    82

    83

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

    84

    85

/** EtherCAT slave online state.

    86

 */

    87

typedef enum {

    88

    EC_SLAVE_OFFLINE,

    89

    EC_SLAVE_ONLINE

    90

} ec_slave_online_state_t;

    91

    92

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

    93

    94

/** Supported mailbox protocols.

    95

 */

    96

enum {

    97

    EC_MBOX_AOE = 0x01, /**< ADS-over-EtherCAT */

    98

    EC_MBOX_EOE = 0x02, /**< Ethernet-over-EtherCAT */

    99

    EC_MBOX_COE = 0x04, /**< CANopen-over-EtherCAT */

   100

    EC_MBOX_FOE = 0x08, /**< File-Access-over-EtherCAT */

   101

    EC_MBOX_SOE = 0x10, /**< Servo-Profile-over-EtherCAT */

   102

    EC_MBOX_VOE = 0x20  /**< Vendor specific */

   103

};

   104

   105

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

   106

   107

/** Slave information interface CANopen-over-EtherCAT details flags.

   108

 */

   109

typedef struct {

   110

    uint8_t enable_sdo : 1; /**< Enable Sdo access. */

   111

    uint8_t enable_sdo_info : 1; /**< SDO information service available. */

   112

    uint8_t enable_pdo_assign : 1; /**< Pdo mapping configurable. */

   113

    uint8_t enable_pdo_configuration : 1; /**< Pdo configuration possible. */

   114

    uint8_t enable_upload_at_startup : 1; /**< ?. */

   115

    uint8_t enable_sdo_complete_access : 1; /**< Complete access possible. */

   116

} ec_sii_coe_details_t;

   117

   118

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

   119

   120

/** Slave information interface general flags.

   121

 */

   122

typedef struct {

   123

    uint8_t enable_safeop : 1; /**< ?. */

   124

    uint8_t enable_not_lrw : 1; /**< Slave does not support LRW. */

   125

} ec_sii_general_flags_t;

   126

   127

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

   128

   129

/** Slave information interface data.

   130

 */

   131

typedef struct {

   132

    // Non-category data 

   133

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

   134

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

   135

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

   136

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

   137

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

   138

    uint16_t rx_mailbox_offset; /**< Mailbox address (master to slave). */

   139

    uint16_t rx_mailbox_size; /**< Mailbox size (master to slave). */

   140

    uint16_t tx_mailbox_offset; /**< Mailbox address (slave to master). */

   141

    uint16_t tx_mailbox_size; /**< Mailbox size (slave to master). */

   142

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

   143

   144

    // Strings

   145

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

   146

    unsigned int string_count; /**< number of EEPROM strings */

   147

   148

    // General

   149

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

   150

    char *group; /**< slave group acc. to EEPROM */

   151

    char *image; /**< slave image name acc. to EEPROM */

   152

    char *order; /**< slave order number acc. to EEPROM */

   153

    char *name; /**< slave name acc. to EEPROM */

   154

    uint8_t physical_layer[4]; /**< port media */

   155

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

   156

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

   157

    int16_t current_on_ebus; /**< power consumption */

   158

   159

    // SyncM

   160

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

   161

    unsigned int sync_count; /**< number of sync managers in EEPROM */

   162

   163

    // [RT]XPDO

   164

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

   165

} ec_sii_t;

   166

   167

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

   168

   169

/** EtherCAT slave.

   170

 */

   171

struct ec_slave

   172

{

   173

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

   174

    struct kobject kobj; /**< kobject */

   175

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

   176

   177

    // addresses

   178

    uint16_t ring_position; /**< ring position */

   179

    uint16_t station_address; /**< configured station address */

   180

   181

    // configuration

   182

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

   183

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

   184

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

   185

    ec_slave_online_state_t online_state; /**< online state */

   186

    unsigned int self_configured; /**< Slave was configured by this master. */

   187

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

   188

   189

    // base data

   190

    uint8_t base_type; /**< slave type */

   191

    uint8_t base_revision; /**< revision */

   192

    uint16_t base_build; /**< build number */

   193

    uint16_t base_fmmu_count; /**< number of supported FMMUs */

   194

   195

    // data link status

   196

    uint8_t dl_link[4]; /**< link detected */

   197

    uint8_t dl_loop[4]; /**< loop closed */

   198

    uint8_t dl_signal[4]; /**< detected signal on RX port */

   199

   200

    // EEPROM

   201

    uint8_t *eeprom_data; /**< Complete EEPROM image */

   202

    size_t eeprom_size; /**< size of the EEPROM contents in bytes */

   203

   204

    // slave information interface

   205

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

   206

   207

    struct kobject sdo_kobj; /**< kobject for Sdos */

   208

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

   209

    uint8_t sdo_dictionary_fetched; /**< dictionary has been fetched */

   210

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

   211

};

   212

   213

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

   214

   215

// slave construction/destruction

   216

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

   217

void ec_slave_destroy(ec_slave_t *);

   218

   219

void ec_slave_request_state(ec_slave_t *, ec_slave_state_t);

   220

void ec_slave_set_state(ec_slave_t *, ec_slave_state_t);

   221

void ec_slave_set_online_state(ec_slave_t *, ec_slave_online_state_t);

   222

   223

// SII categories

   224

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

   225

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

   226

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

   227

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

   228

        ec_direction_t);

   229

   230

// misc.

   231

ec_sync_t *ec_slave_get_pdo_sync(ec_slave_t *, ec_direction_t); 

   232

int ec_slave_validate(const ec_slave_t *, uint32_t, uint32_t);

   233

void ec_slave_sdo_dict_info(const ec_slave_t *,

   234

        unsigned int *, unsigned int *);

   235

ec_sdo_t *ec_slave_get_sdo(ec_slave_t *, uint16_t);

   236

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

   237

   238

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

   239

   240

#endif