master/fsm_pdo_config.h
author Florian Pose <fp@igh-essen.com>
Fri, 29 Feb 2008 08:27:17 +0000
changeset 846 19248bbf9308
parent 814 a51f857b1b2d
child 854 f4f53be425ac
permissions -rw-r--r--
Cross blinking.
799
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     1
/******************************************************************************
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     2
 *
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     3
 *  $Id$
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     4
 *
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     5
 *  Copyright (C) 2006  Florian Pose, Ingenieurgemeinschaft IgH
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     6
 *
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     7
 *  This file is part of the IgH EtherCAT Master.
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     8
 *
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
     9
 *  The IgH EtherCAT Master is free software; you can redistribute it
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    10
 *  and/or modify it under the terms of the GNU General Public License
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    11
 *  as published by the Free Software Foundation; either version 2 of the
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    12
 *  License, or (at your option) any later version.
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    13
 *
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    14
 *  The IgH EtherCAT Master is distributed in the hope that it will be
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    15
 *  useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    16
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    17
 *  GNU General Public License for more details.
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    18
 *
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    19
 *  You should have received a copy of the GNU General Public License
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    20
 *  along with the IgH EtherCAT Master; if not, write to the Free Software
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    21
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    22
 *
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    23
 *  The right to use EtherCAT Technology is granted and comes free of
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    24
 *  charge under condition of compatibility of product made by
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    25
 *  Licensee. People intending to distribute/sell products based on the
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    26
 *  code, have to sign an agreement to guarantee that products using
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    27
 *  software based on IgH EtherCAT master stay compatible with the actual
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    28
 *  EtherCAT specification (which are released themselves as an open
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    29
 *  standard) as the (only) precondition to have the right to use EtherCAT
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    30
 *  Technology, IP and trade marks.
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    31
 *
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    32
 *****************************************************************************/
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    33
801
6b1e2b0ed8bc Cleaned up Pdo mapping and configuration state machines.
Florian Pose <fp@igh-essen.com>
parents: 800
diff changeset
    34
/** \file
814
a51f857b1b2d Renamed [PS]DO to [PS]do.
Florian Pose <fp@igh-essen.com>
parents: 801
diff changeset
    35
 * EtherCAT Pdo configuration state machine structures.
801
6b1e2b0ed8bc Cleaned up Pdo mapping and configuration state machines.
Florian Pose <fp@igh-essen.com>
parents: 800
diff changeset
    36
 */
799
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    37
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    38
/*****************************************************************************/
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    39
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    40
#ifndef __EC_FSM_PDO_CONFIG__
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    41
#define __EC_FSM_PDO_CONFIG__
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    42
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    43
#include "globals.h"
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    44
#include "../include/ecrt.h"
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    45
#include "datagram.h"
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    46
#include "fsm_coe.h"
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    47
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    48
/*****************************************************************************/
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    49
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    50
/**
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    51
 * \see ec_fsm_pdo_config
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    52
 */
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    53
typedef struct ec_fsm_pdo_config ec_fsm_pdo_config_t;
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    54
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    55
/** Pdo configuration state machine.
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    56
 */
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    57
struct ec_fsm_pdo_config
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    58
{
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    59
    void (*state)(ec_fsm_pdo_config_t *); /**< state function */
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    60
    ec_fsm_coe_t *fsm_coe; /**< CoE state machine to use */
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    61
    ec_slave_t *slave; /**< Slave the FSM runs on. */
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    62
814
a51f857b1b2d Renamed [PS]DO to [PS]do.
Florian Pose <fp@igh-essen.com>
parents: 801
diff changeset
    63
    const ec_pdo_t *pdo; /**< Current Pdo to configure. */
800
e0b8cbc8a88d Minor changes.
Florian Pose <fp@igh-essen.com>
parents: 799
diff changeset
    64
    const ec_pdo_entry_t *entry; /**< Current entry. */
799
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    65
814
a51f857b1b2d Renamed [PS]DO to [PS]do.
Florian Pose <fp@igh-essen.com>
parents: 801
diff changeset
    66
    ec_sdo_data_t sdodata; /**< Sdo configuration data. */
a51f857b1b2d Renamed [PS]DO to [PS]do.
Florian Pose <fp@igh-essen.com>
parents: 801
diff changeset
    67
    uint16_t sdo_value; /**< Sdo value. */
799
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    68
    unsigned int entry_count; /**< Number of configured entries. */
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    69
};
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    70
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    71
/*****************************************************************************/
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    72
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    73
void ec_fsm_pdo_config_init(ec_fsm_pdo_config_t *, ec_fsm_coe_t *);
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    74
void ec_fsm_pdo_config_clear(ec_fsm_pdo_config_t *);
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    75
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    76
void ec_fsm_pdo_config_start(ec_fsm_pdo_config_t *, ec_slave_t *);
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    77
int ec_fsm_pdo_config_exec(ec_fsm_pdo_config_t *);
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    78
int ec_fsm_pdo_config_success(const ec_fsm_pdo_config_t *);
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    79
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    80
/*****************************************************************************/
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    81
068a58b96965 Pdo configuration.
Florian Pose <fp@igh-essen.com>
parents:
diff changeset
    82
#endif