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

 *  Using the EtherCAT technology and brand is permitted in compliance with

    23

 *  the industrial property and similar rights of Beckhoff Automation GmbH.

    24

 *

    25

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

    26

    27

/**

    28

   \file

    29

   EtherCAT slave structure.

    30

*/

    31

    32

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

    33

    34

#ifndef __EC_SLAVE_H__

    35

#define __EC_SLAVE_H__

    36

    37

#include <linux/list.h>

    38

#include <linux/kobject.h>

    39

    40

#include "globals.h"

    41

#include "datagram.h"

    42

#include "pdo.h"

    43

#include "sync.h"

    44

#include "sdo.h"

    45

    46

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

    47

    48

/** Slave information interface data.

    49

 */

    50

typedef struct {

    51

    // Non-category data 

    52

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

    53

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

    54

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

    55

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

    56

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

    57

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

    58

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

    59

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

    60

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

    61

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

    62

    63

    // Strings

    64

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

    65

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

    66

    67

    // General

    68

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

    69

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

    70

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

    71

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

    72

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

    73

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

    74

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

    75

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

    76

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

    77

    78

    // SyncM

    79

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

    80

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

    81

    82

    // [RT]XPDO

    83

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

    84

} ec_sii_t;

    85

    86

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

    87

    88

/** EtherCAT slave port information.

    89

 */

    90

typedef struct {

    91

    uint8_t dl_link; /**< Link detected. */

    92

    uint8_t dl_loop; /**< Loop closed. */

    93

    uint8_t dl_signal; /**< Detected signal on RX port. */

    94

} ec_slave_port_t;

    95

    96

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

    97

    98

/** EtherCAT slave.

    99

 */

   100

struct ec_slave

   101

{

   102

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

   103

   104

    // addresses

   105

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

   106

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

   107

   108

    // configuration

   109

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

   110

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

   111

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

   112

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

   113

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

   114

   115

    // base data

   116

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

   117

    uint8_t base_revision; /**< Revision. */

   118

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

   119

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

   120

   121

    // data link status

   122

    ec_slave_port_t ports[EC_MAX_PORTS]; /**< Port link status. */

   123

   124

    // SII

   125

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

   126

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

   127

   128

    // Slave information interface

   129

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

   130

   132

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

   133

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

   134

};

   135

   136

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

   137

   138

// slave construction/destruction

   139

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

   140

void ec_slave_clear(ec_slave_t *);

   141

   142

void ec_slave_clear_sync_managers(ec_slave_t *);

   143

   144

void ec_slave_request_state(ec_slave_t *, ec_slave_state_t);

   145

void ec_slave_set_state(ec_slave_t *, ec_slave_state_t);

   146

   147

// SII categories

   148

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

   149

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

   150

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

   151

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

   152

        ec_direction_t);

   153

   154

// misc.

   155

ec_sync_t *ec_slave_get_sync(ec_slave_t *, uint8_t); 

   156

   157

void ec_slave_sdo_dict_info(const ec_slave_t *,

   158

        unsigned int *, unsigned int *);

   159

ec_sdo_t *ec_slave_get_sdo(ec_slave_t *, uint16_t);

   160

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

   161

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

   162

uint16_t ec_slave_sdo_count(const ec_slave_t *);

   163

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

   164

void ec_slave_attach_pdo_names(ec_slave_t *);

   165

   166

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

   167

   168

#endif