voe_handler.h

Go to the documentation of this file.

/*****************************************************************************
 *
 *  Copyright (C) 2006-2008  Florian Pose, Ingenieurgemeinschaft IgH
 *
 *  This file is part of the IgH EtherCAT Master.
 *
 *  The IgH EtherCAT Master is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU General Public License version 2, as
 *  published by the Free Software Foundation.
 *
 *  The IgH EtherCAT Master is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
 *  Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with the IgH EtherCAT Master; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 ****************************************************************************/

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

#ifndef __EC_VOE_HANDLER_H__
#define __EC_VOE_HANDLER_H__

#include <linux/list.h>

#include "globals.h"
#include "datagram.h"
#include "fsm_mbox.h"

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

struct ec_voe_handler {
    struct list_head list; 
    ec_slave_config_t *config; 
    ec_datagram_t datagram; 
    uint32_t vendor_id; 
    uint16_t vendor_type; 
    size_t data_size; 
    ec_direction_t dir; 
    void (*state)(ec_voe_handler_t *); 
    ec_internal_request_state_t request_state; 
    unsigned int retries; 
    unsigned long jiffies_start; 
    ec_fsm_mbox_t fsm_mbox; 
};

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

int ec_voe_handler_init(ec_voe_handler_t *, ec_slave_config_t *, size_t);
void ec_voe_handler_clear(ec_voe_handler_t *);
void ec_voe_handler_release_mbox_lock(ec_voe_handler_t *);
size_t ec_voe_handler_mem_size(const ec_voe_handler_t *);

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

#endif