1

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

     2

 *

     3

 *  $Id:$

     4

 *

     5

 *  Copyright (C) 2008  Olav Zarges, imc Meßsysteme GmbH

     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 FoE state machines.

    37

*/

    38

    39

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

    40

    41

#ifndef __EC_FSM_FOE_H__

    42

#define __EC_FSM_FOE_H__

    43

    44

#include "globals.h"

    45

#include "../include/ecrt.h"

    46

#include "datagram.h"

    47

#include "slave.h"

    48

#include "foe_request.h"

    49

    50

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

    51

    52

typedef struct ec_fsm_foe ec_fsm_foe_t; /**< \see ec_fsm_foe */

    53

    54

/** Finite state machines for the CANopen-over-EtherCAT protocol.

    55

 */

    56

struct ec_fsm_foe {

    57

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

    58

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

    59

    unsigned int retries; /**< retries upon datagram timeout */

    60

    61

    void (*state)(ec_fsm_foe_t *); /**< FoE state function */

    62

    unsigned long jiffies_start; /**< FoE timestamp. */

    63

    uint8_t subindex; /**< current subindex */

    64

    ec_foe_request_t *request; /**< FoE request */

    65

    uint8_t toggle; /**< toggle bit for segment commands */

    66

    67

    uint32_t tx_errors;

    68

    uint8_t *tx_buffer;

    69

    uint32_t tx_buffer_size;

    70

    uint32_t tx_buffer_offset;

    71

    uint32_t tx_last_packet;

    72

    uint32_t tx_packet_no;

    73

    uint32_t tx_current_size;

    74

    uint8_t *tx_filename;

    75

    uint32_t tx_filename_len;

    76

    77

    78

    uint32_t rx_errors;

    79

    uint8_t *rx_buffer;

    80

    uint32_t rx_buffer_size;

    81

    uint32_t rx_buffer_offset;

    82

    uint32_t rx_current_size;

    83

    uint32_t rx_packet_no;

    84

    uint32_t rx_expected_packet_no;

    85

    uint32_t rx_last_packet;

    86

    uint8_t *rx_filename;

    87

    uint32_t rx_filename_len;

    88

};

    89

    90

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

    91

    92

void ec_fsm_foe_init(ec_fsm_foe_t *, ec_datagram_t *);

    93

void ec_fsm_foe_clear(ec_fsm_foe_t *);

    94

    95

int ec_fsm_foe_exec(ec_fsm_foe_t *);

    96

int ec_fsm_foe_success(ec_fsm_foe_t *);

    97

    98

void ec_fsm_foe_transfer(ec_fsm_foe_t *, ec_slave_t *, ec_foe_request_t *);

    99

   100

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

   101

   102

#endif