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 stave 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"

    53

    54

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

    55

    56

/**

    57

   State of an EtherCAT slave.

    58

*/

    59

    60

typedef enum

    61

{

    62

    EC_SLAVE_STATE_UNKNOWN = 0x00,

    63

    /**< unknown state */

    64

    EC_SLAVE_STATE_INIT = 0x01,

    65

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

    66

    EC_SLAVE_STATE_PREOP = 0x02,

    67

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

    68

    EC_SLAVE_STATE_SAVEOP = 0x04,

    69

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

    70

    EC_SLAVE_STATE_OP = 0x08,

    71

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

    72

    EC_SLAVE_STATE_ACK_ERR = 0x10

    73

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

    74

}

    75

ec_slave_state_t;

    76

    77

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

    78

    79

/**

    80

 */

    81

    82

typedef enum {

    83

    EC_SLAVE_OFFLINE,

    84

    EC_SLAVE_ONLINE

    85

}

    86

ec_slave_online_state_t;

    87

    88

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

    89

    90

/**

    91

   Supported mailbox protocols.

    92

*/

    93

    94

enum

    95

{

    96

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

    97

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

    98

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

    99

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

   100

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

   101

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

   102

};

   103

   104

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

   105

   106

/**

   107

   FMMU configuration.

   108

*/

   109

   110

typedef struct

   111

{

   112

    unsigned int index; /**< FMMU index */

   113

    const ec_domain_t *domain; /**< domain */

   114

    const ec_sync_t *sync; /**< sync manager */

   115

    uint32_t logical_start_address; /**< logical start address */

   116

}

   117

ec_fmmu_t;

   118

   119

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

   120

   121

/**

   122

   EtherCAT slave.

   123

*/

   124

   125

struct ec_slave

   126

{

   127

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

   128

    struct kobject kobj; /**< kobject */

   129

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

   130

   131

    ec_slave_state_t requested_state; /**< requested application state */

   132

    ec_slave_state_t current_state; /**< current application state */

   133

    ec_slave_online_state_t online_state; /**< online state */

   134

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

   135

    unsigned int error_flag; /**< stop processing after an error */

   136

    unsigned int pdos_registered; /**< non-zero, if PDOs were registered */

   137

   138

    // addresses

   139

    uint16_t ring_position; /**< ring position */

   140

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

   141

    uint16_t coupler_index; /**< index of the last bus coupler */

   142

    uint16_t coupler_subindex; /**< index of this slave after last coupler */

   143

   144

    // base data

   145

    uint8_t base_type; /**< slave type */

   146

    uint8_t base_revision; /**< revision */

   147

    uint16_t base_build; /**< build number */

   148

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

   149

   150

    // data link status

   151

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

   152

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

   153

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

   154

   155

    // EEPROM

   156

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

   157

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

   158

   159

    // slave information interface

   160

    uint16_t sii_alias; /**< configured station alias */

   161

    uint32_t sii_vendor_id; /**< vendor id */

   162

    uint32_t sii_product_code; /**< vendor's product code */

   163

    uint32_t sii_revision_number; /**< revision number */

   164

    uint32_t sii_serial_number; /**< serial number */

   165

    uint16_t sii_rx_mailbox_offset; /**< mailbox address (master to slave) */

   166

    uint16_t sii_rx_mailbox_size; /**< mailbox size (master to slave) */

   167

    uint16_t sii_tx_mailbox_offset; /**< mailbox address (slave to master) */

   168

    uint16_t sii_tx_mailbox_size; /**< mailbox size (slave to master) */

   169

    uint16_t sii_mailbox_protocols; /**< supported mailbox protocols */

   170

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

   171

    char **sii_strings; /**< strings in EEPROM categories */

   172

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

   173

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

   174

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

   175

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

   176

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

   177

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

   178

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

   179

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

   180

    int16_t sii_current_on_ebus; /**< power consumption */

   181

   182

    ec_fmmu_t fmmus[EC_MAX_FMMUS]; /**< FMMU configurations */

   183

    uint8_t fmmu_count; /**< number of FMMUs used */

   184

   185

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

   186

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

   187

    struct list_head sdo_confs; /**< list of SDO configurations */

   188

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

   189

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

   190

};

   191

   192

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

   193

   194

// slave construction/destruction

   195

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

   196

void ec_slave_destroy(ec_slave_t *);

   197

   198

void ec_slave_reset(ec_slave_t *);

   199

   200

int ec_slave_prepare_fmmu(ec_slave_t *, const ec_domain_t *,

   201

        const ec_sync_t *);

   202

   203

void ec_slave_request_state(ec_slave_t *, ec_slave_state_t);

   204

void ec_slave_set_state(ec_slave_t *, ec_slave_state_t);

   205

void ec_slave_set_online_state(ec_slave_t *, ec_slave_online_state_t);

   206

   207

// SII categories

   208

int ec_slave_fetch_sii_strings(ec_slave_t *, const uint8_t *);

   209

void ec_slave_fetch_sii_general(ec_slave_t *, const uint8_t *);

   210

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

   211

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

   212

        ec_pdo_type_t);

   213

   214

// misc.

   215

ec_sync_t *ec_slave_get_pdo_sync(ec_slave_t *, ec_direction_t); 

   216

void ec_slave_fmmu_config(const ec_slave_t *, const ec_fmmu_t *, uint8_t *);

   217

uint16_t ec_slave_calc_sync_size(const ec_slave_t *, const ec_sync_t *);

   218

   219

int ec_slave_is_coupler(const ec_slave_t *);

   220

   221

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

   222

   223

void ec_slave_sdo_dict_info(const ec_slave_t *,

   224

                            unsigned int *, unsigned int *);

   225

   226

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

   227

   228

#endif