IgH EtherCAT Master: soe_request.h Source File

00001 /******************************************************************************
00002  *
00003  *  $Id$
00004  *
00005  *  Copyright (C) 2006-2008  Florian Pose, Ingenieurgemeinschaft IgH
00006  *
00007  *  This file is part of the IgH EtherCAT Master.
00008  *
00009  *  The IgH EtherCAT Master is free software; you can redistribute it and/or
00010  *  modify it under the terms of the GNU General Public License version 2, as
00011  *  published by the Free Software Foundation.
00012  *
00013  *  The IgH EtherCAT Master is distributed in the hope that it will be useful,
00014  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
00015  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
00016  *  Public License for more details.
00017  *
00018  *  You should have received a copy of the GNU General Public License along
00019  *  with the IgH EtherCAT Master; if not, write to the Free Software
00020  *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00021  *
00022  *  ---
00023  *
00024  *  The license mentioned above concerns the source code only. Using the
00025  *  EtherCAT technology and brand is only permitted in compliance with the
00026  *  industrial property and similar rights of Beckhoff Automation GmbH.
00027  *
00028  *****************************************************************************/
00029 
00035 /*****************************************************************************/
00036 
00037 #ifndef __EC_SOE_REQUEST_H__
00038 #define __EC_SOE_REQUEST_H__
00039 
00040 #include <linux/list.h>
00041 
00042 #include "globals.h"
00043 
00044 /*****************************************************************************/
00045 
00048 typedef struct {
00049     struct list_head list; 
00050     uint8_t drive_no; 
00051     uint16_t idn; 
00052     ec_al_state_t al_state; 
00053     uint8_t *data; 
00054     size_t mem_size; 
00055     size_t data_size; 
00056     ec_direction_t dir; 
00058     ec_internal_request_state_t state; 
00059     unsigned long jiffies_sent; 
00061     uint16_t error_code; 
00062 } ec_soe_request_t;
00063 
00064 /*****************************************************************************/
00065 
00066 void ec_soe_request_init(ec_soe_request_t *);
00067 void ec_soe_request_clear(ec_soe_request_t *);
00068 
00069 int ec_soe_request_copy(ec_soe_request_t *, const ec_soe_request_t *);
00070 void ec_soe_request_set_drive_no(ec_soe_request_t *, uint8_t);
00071 void ec_soe_request_set_idn(ec_soe_request_t *, uint16_t);
00072 int ec_soe_request_alloc(ec_soe_request_t *, size_t);
00073 int ec_soe_request_copy_data(ec_soe_request_t *, const uint8_t *, size_t);
00074 int ec_soe_request_append_data(ec_soe_request_t *, const uint8_t *, size_t);
00075 void ec_soe_request_read(ec_soe_request_t *);
00076 void ec_soe_request_write(ec_soe_request_t *);
00077 
00078 /*****************************************************************************/
00079 
00080 #endif