1

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

     2

 *

     3

 *  $Id$

     4

 *

     5

 *  Copyright (C) 2006  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

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

    37

*/

    38

    39

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

    40

    41

#ifndef __EC_FSM_COE_MAP_H__

    42

#define __EC_FSM_COE_MAP_H__

    43

    44

#include "globals.h"

    45

#include "datagram.h"

    46

#include "slave.h"

    47

#include "fsm_coe.h"

    48

    49

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

    50

    51

typedef struct ec_fsm_coe_map ec_fsm_coe_map_t; /**< \see ec_fsm_coe_map */

    52

    53

/**

    54

 * \todo doc

    55

 */

    56

struct ec_fsm_coe_map

    57

{

    58

    void (*state)(ec_fsm_coe_map_t *); /**< CoE mapping state function */

    59

    ec_fsm_coe_t *fsm_coe; /**< CoE state machine to use */

    60

    61

    ec_slave_t *slave; /**< EtherCAT slave */

    62

    ec_sdo_request_t request; /**< Sdo request */

    63

    64

    ec_direction_t dir; /**< index of the current sync manager */

    65

    ec_sync_t *sync; /**< Pdo sync manager. */

    66

    uint16_t sync_sdo_index; /**< Index of the mapping Sdo. */

    67

    uint8_t sync_subindices; /**< number of mapped Pdos */

    68

    uint16_t sync_subindex; /**< current subindex in mapping Sdo */

    69

    70

    ec_pdo_list_t pdos; /**< List of read in Pdos. */

    71

    ec_pdo_t *pdo; /**< Current Pdo. */

    72

    ec_sdo_t *pdo_sdo; /**< Current Pdo Sdo. */

    73

    uint8_t pdo_subindices; /**< Number of Pdo entries. */

    74

    uint16_t pdo_subindex; /**< Current subindex in Pdo Sdo. */

    75

};

    76

    77

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

    78

    79

void ec_fsm_coe_map_init(ec_fsm_coe_map_t *, ec_fsm_coe_t *);

    80

void ec_fsm_coe_map_clear(ec_fsm_coe_map_t *);

    81

    82

void ec_fsm_coe_map_start(ec_fsm_coe_map_t *, ec_slave_t *);

    83

    84

int ec_fsm_coe_map_exec(ec_fsm_coe_map_t *);

    85

int ec_fsm_coe_map_success(ec_fsm_coe_map_t *);

    86

    87

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

    88

    89

#endif