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

    33

*/

    34

    35

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

    36

    37

#ifndef __EC_FSM_SLAVE_SCAN_H__

    38

#define __EC_FSM_SLAVE_SCAN_H__

    39

    40

#include "globals.h"

    41

#include "datagram.h"

    42

#include "slave.h"

    43

#include "fsm_sii.h"

    44

#include "fsm_change.h"

    45

#include "fsm_coe.h"

    46

#include "fsm_pdo.h"

    47

    48

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

    49

    50

/** \see ec_fsm_slave_scan */

    51

typedef struct ec_fsm_slave_scan ec_fsm_slave_scan_t;

    52

    53

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

    54

 */

    55

struct ec_fsm_slave_scan

    56

{

    57

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

    58

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

    59

    ec_fsm_slave_config_t *fsm_slave_config; /**< Slave configuration state

    60

                                               machine to use. */

    61

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

    62

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

    63

    64

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

    65

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

    66

    67

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

    68

};

    69

    70

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

    71

    72

void ec_fsm_slave_scan_init(ec_fsm_slave_scan_t *, ec_datagram_t *,

    73

        ec_fsm_slave_config_t *, ec_fsm_pdo_t *);

    74

void ec_fsm_slave_scan_clear(ec_fsm_slave_scan_t *);

    75

    76

void ec_fsm_slave_scan_start(ec_fsm_slave_scan_t *, ec_slave_t *);

    77

    78

int ec_fsm_slave_scan_exec(ec_fsm_slave_scan_t *);

    79

int ec_fsm_slave_scan_success(const ec_fsm_slave_scan_t *);

    80

    81

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

    82

    83

#endif