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

    33

*/

    34

    35

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

    36

    37

#ifndef __EC_FSM_COE_H__

    38

#define __EC_FSM_COE_H__

    39

    40

#include "globals.h"

    41

#include "datagram.h"

    42

#include "mailbox.h"

    43

#include "slave.h"

    44

#include "sdo.h"

    45

#include "sdo_request.h"

    46

    47

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

    48

    49

typedef struct ec_fsm_coe ec_fsm_coe_t; /**< \see ec_fsm_coe */

    50

    51

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

    52

 */

    53

struct ec_fsm_coe {

    54

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

    55

    ec_mailbox_t *mbox; /**< mailbox used in the state machine */

    56

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

    57

    58

    void (*state)(ec_fsm_coe_t *); /**< CoE state function */

    59

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

    60

    ec_sdo_t *sdo; /**< current SDO */

    61

    uint8_t subindex; /**< current subindex */

    62

    ec_sdo_request_t *request; /**< SDO request */

    63

    uint32_t complete_size; /**< Used when segmenting. */

    64

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

    65

    uint32_t offset; /**< Data offset during segmented download. */

    66

    uint32_t remaining; /**< Remaining bytes during segmented download. */

    67

};

    68

    69

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

    70

    71

void ec_fsm_coe_init(ec_fsm_coe_t *, ec_mailbox_t *);

    72

void ec_fsm_coe_clear(ec_fsm_coe_t *);

    73

    74

void ec_fsm_coe_dictionary(ec_fsm_coe_t *, ec_slave_t *);

    75

void ec_fsm_coe_transfer(ec_fsm_coe_t *, ec_slave_t *, ec_sdo_request_t *);

    76

    77

int ec_fsm_coe_exec(ec_fsm_coe_t *);

    78

int ec_fsm_coe_success(ec_fsm_coe_t *);

    79

    80

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

    81

    82

#endif