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 scanning state machine.

    30

*/

    31

    32

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

    33

    34

#ifndef __EC_FSM_SLAVE_SCAN_H__

    35

#define __EC_FSM_SLAVE_SCAN_H__

    36

    37

#include "globals.h"

    38

#include "datagram.h"

    39

#include "slave.h"

    40

#include "fsm_sii.h"

    41

#include "fsm_change.h"

    42

#include "fsm_coe.h"

    43

#include "fsm_pdo.h"

    44

    45

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

    46

    47

/** \see ec_fsm_slave_scan */

    48

typedef struct ec_fsm_slave_scan ec_fsm_slave_scan_t;

    49

    50

/** Finite state machine for scanning an EtherCAT slave.

    51

 */

    52

struct ec_fsm_slave_scan

    53

{

    54

    ec_slave_t *slave; /**< Slave the FSM runs on. */

    55

    ec_datagram_t *datagram; /**< Datagram used in the state machine. */

    56

    ec_fsm_slave_config_t *fsm_slave_config; /**< Slave configuration state

    57

                                               machine to use. */

    58

    ec_fsm_pdo_t *fsm_pdo; /**< PDO configuration state machine to use. */

    59

    unsigned int retries; /**< Retries on datagram timeout. */

    60

    61

    void (*state)(ec_fsm_slave_scan_t *); /**< State function. */

    62

    uint16_t sii_offset; /**< SII offset in words. */

    63

    64

    ec_fsm_sii_t fsm_sii; /**< SII state machine. */

    65

};

    66

    67

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

    68

    69

void ec_fsm_slave_scan_init(ec_fsm_slave_scan_t *, ec_datagram_t *,

    70

        ec_fsm_slave_config_t *, ec_fsm_pdo_t *);

    71

void ec_fsm_slave_scan_clear(ec_fsm_slave_scan_t *);

    72

    73

void ec_fsm_slave_scan_start(ec_fsm_slave_scan_t *, ec_slave_t *);

    74

    75

int ec_fsm_slave_scan_exec(ec_fsm_slave_scan_t *);

    76

int ec_fsm_slave_scan_success(const ec_fsm_slave_scan_t *);

    77

    78

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

    79

    80

#endif