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

    33

*/

    34

    35

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

    36

    37

#ifndef __EC_SLAVE_CONFIG_H__

    38

#define __EC_SLAVE_CONFIG_H__

    39

    40

#include <linux/list.h>

    41

    42

#include "globals.h"

    43

#include "slave.h"

    44

#include "sync_config.h"

    45

#include "fmmu_config.h"

    46

    47

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

    48

    49

/** EtherCAT slave configuration.

    50

 */

    51

struct ec_slave_config {

    52

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

    53

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

    54

    55

    uint16_t alias; /**< Slave alias. */

    56

    uint16_t position; /**< Index after alias. If alias is zero, this is the

    57

                         ring position. */

    58

    uint32_t vendor_id; /**< Slave vendor ID. */

    59

    uint32_t product_code; /**< Slave product code. */

    60

    61

    uint16_t watchdog_divider; /**< Watchdog divider as a number of 40ns

    62

                                 intervals (see spec. reg. 0x0400). */

    63

    uint16_t watchdog_intervals; /**< Process data watchdog intervals (see

    64

                                   spec. reg. 0x0420). */

    65

    uint8_t allow_overlapping_pdos;	/**< Allow input PDOs use the same frame space

    66

                                      as output PDOs. */

    67

    ec_slave_t *slave; /**< Slave pointer. This is \a NULL, if the slave is

    68

                         offline. */

    69

    70

    ec_sync_config_t sync_configs[EC_MAX_SYNC_MANAGERS]; /**< Sync manager

    71

                                                   configurations. */

    72

    ec_fmmu_config_t fmmu_configs[EC_MAX_FMMUS]; /**< FMMU configurations. */

    73

    uint8_t used_fmmus; /**< Number of FMMUs used. */

    74

    unsigned int used_for_fmmu_datagram[EC_DIR_COUNT]; /**< Number of FMMUs

    75

                                                         used for process data

    76

                                                         exchange datagrams. */

    77

    uint16_t dc_assign_activate; /**< Vendor-specific AssignActivate word. */

    78

    ec_sync_signal_t dc_sync[EC_SYNC_SIGNAL_COUNT]; /**< DC sync signals. */

    79

    80

    struct list_head sdo_configs; /**< List of SDO configurations. */

    81

    struct list_head sdo_requests; /**< List of SDO requests. */

    82

    struct list_head voe_handlers; /**< List of VoE handlers. */

    83

    struct list_head soe_configs; /**< List of SoE configurations. */

    84

};

    85

    86

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

    87

    88

void ec_slave_config_init(ec_slave_config_t *, ec_master_t *, uint16_t,

    89

        uint16_t, uint32_t, uint32_t);

    90

void ec_slave_config_clear(ec_slave_config_t *);

    91

    92

int ec_slave_config_attach(ec_slave_config_t *);

    93

void ec_slave_config_detach(ec_slave_config_t *);

    94

    95

void ec_slave_config_load_default_sync_config(ec_slave_config_t *);

    96

    97

unsigned int ec_slave_config_sdo_count(const ec_slave_config_t *);

    98

const ec_sdo_request_t *ec_slave_config_get_sdo_by_pos_const(

    99

        const ec_slave_config_t *, unsigned int);

   100

ec_sdo_request_t *ec_slave_config_find_sdo_request(ec_slave_config_t *,

   101

        unsigned int);

   102

ec_voe_handler_t *ec_slave_config_find_voe_handler(ec_slave_config_t *,

   103

        unsigned int);

   104

   105

ec_sdo_request_t *ecrt_slave_config_create_sdo_request_err(

   106

        ec_slave_config_t *, uint16_t, uint8_t, size_t);

   107

ec_voe_handler_t *ecrt_slave_config_create_voe_handler_err(

   108

        ec_slave_config_t *, size_t);

   109

   110

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

   111

   112

#endif