fp@433: /******************************************************************************
fp@433:  *
fp@433:  *  $Id$
fp@433:  *
fp@433:  *  Copyright (C) 2006  Florian Pose, Ingenieurgemeinschaft IgH
fp@433:  *
fp@433:  *  This file is part of the IgH EtherCAT Master.
fp@433:  *
fp@433:  *  The IgH EtherCAT Master is free software; you can redistribute it
fp@433:  *  and/or modify it under the terms of the GNU General Public License
fp@433:  *  as published by the Free Software Foundation; either version 2 of the
fp@433:  *  License, or (at your option) any later version.
fp@433:  *
fp@433:  *  The IgH EtherCAT Master is distributed in the hope that it will be
fp@433:  *  useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
fp@433:  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
fp@433:  *  GNU General Public License for more details.
fp@433:  *
fp@433:  *  You should have received a copy of the GNU General Public License
fp@433:  *  along with the IgH EtherCAT Master; if not, write to the Free Software
fp@433:  *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
fp@433:  *
fp@433:  *  The right to use EtherCAT Technology is granted and comes free of
fp@433:  *  charge under condition of compatibility of product made by
fp@433:  *  Licensee. People intending to distribute/sell products based on the
fp@433:  *  code, have to sign an agreement to guarantee that products using
fp@433:  *  software based on IgH EtherCAT master stay compatible with the actual
fp@433:  *  EtherCAT specification (which are released themselves as an open
fp@433:  *  standard) as the (only) precondition to have the right to use EtherCAT
fp@433:  *  Technology, IP and trade marks.
fp@433:  *
fp@433:  *****************************************************************************/
fp@433: 
fp@433: /**
fp@433:    \file
fp@433:    EtherCAT slave information interface FSM structure.
fp@433: */
fp@433: 
fp@433: /*****************************************************************************/
fp@433: 
fp@883: #ifndef __EC_FSM_SII_H__
fp@883: #define __EC_FSM_SII_H__
fp@433: 
fp@433: #include "globals.h"
fp@433: #include "../include/ecrt.h"
fp@433: #include "datagram.h"
fp@433: #include "slave.h"
fp@433: 
fp@433: /*****************************************************************************/
fp@433: 
fp@815: /** SII access addressing mode.
fp@758:  */
fp@815: typedef enum {
fp@815:     EC_FSM_SII_USE_INCREMENT_ADDRESS, /**< Use auto-increment addressing. */
fp@815:     EC_FSM_SII_USE_CONFIGURED_ADDRESS /**< Use configured addresses. */
fp@815: } ec_fsm_sii_addressing_t;
fp@433: 
fp@433: /*****************************************************************************/
fp@433: 
fp@433: typedef struct ec_fsm_sii ec_fsm_sii_t; /**< \see ec_fsm_sii */
fp@433: 
fp@433: /**
fp@433:    Slave information interface FSM.
fp@433: */
fp@433: 
fp@433: struct ec_fsm_sii
fp@433: {
fp@433:     ec_slave_t *slave; /**< slave the FSM runs on */
fp@433:     ec_datagram_t *datagram; /**< datagram used in the state machine */
fp@505:     unsigned int retries; /**< retries upon datagram timeout */
fp@433: 
fp@433:     void (*state)(ec_fsm_sii_t *); /**< SII state function */
fp@755:     uint16_t word_offset; /**< input: word offset in SII */
fp@433:     ec_fsm_sii_addressing_t mode; /**< reading via APRD or NPRD */
fp@433:     uint8_t value[4]; /**< raw SII value (32bit) */
fp@433:     cycles_t cycles_start; /**< start timestamp */
fp@433:     uint8_t check_once_more; /**< one more try after timeout */
fp@433: };
fp@433: 
fp@433: /*****************************************************************************/
fp@433: 
fp@433: void ec_fsm_sii_init(ec_fsm_sii_t *, ec_datagram_t *);
fp@433: void ec_fsm_sii_clear(ec_fsm_sii_t *);
fp@433: 
fp@433: void ec_fsm_sii_read(ec_fsm_sii_t *, ec_slave_t *,
fp@433:                      uint16_t, ec_fsm_sii_addressing_t);
fp@600: void ec_fsm_sii_write(ec_fsm_sii_t *, ec_slave_t *, uint16_t,
fp@979:         const uint16_t *, ec_fsm_sii_addressing_t);
fp@433: 
fp@435: int ec_fsm_sii_exec(ec_fsm_sii_t *);
fp@433: int ec_fsm_sii_success(ec_fsm_sii_t *);
fp@433: 
fp@433: /*****************************************************************************/
fp@433: 
fp@433: #endif