eoe.h

Go to the documentation of this file.

 
/*
 * This file is part of libethercat.
 *
 * libethercat is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 * 
 * libethercat 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
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public 
 * License along with libethercat (LICENSE.LGPL-V3); if not, write 
 * to the Free Software Foundation, Inc., 51 Franklin Street, Fifth 
 * Floor, Boston, MA  02110-1301, USA.
 * 
 * Please note that the use of the EtherCAT technology, the EtherCAT 
 * brand name and the EtherCAT logo is only permitted if the property 
 * rights of Beckhoff Automation GmbH are observed. For further 
 * information please contact Beckhoff Automation GmbH & Co. KG, 
 * Hülshorstweg 20, D-33415 Verl, Germany (www.beckhoff.com) or the 
 * EtherCAT Technology Group, Ostendstraße 196, D-90482 Nuremberg, 
 * Germany (ETG, www.ethercat.org).
 *
 */
 
#ifndef LIBETHERCAT_EOE_H
#define LIBETHERCAT_EOE_H
 
#include <libosal/types.h>
#include <libosal/mutex.h>
#include <libosal/semaphore.h>
 
#include "libethercat/common.h"
 
#define LEC_EOE_MAC_LEN         (6u)
#define LEC_EOE_IP_ADDRESS_LEN  (4u)
#define LEC_EOE_SUBNET_LEN      (4u)
#define LEC_EOE_GATEWAY_LEN     (4u)
#define LEC_EOE_DNS_LEN         (4u)
#define LEC_EOE_DNS_NAME_LEN    (128u)
 
typedef struct ec_eoe_slave_config {
    int use_eoe;                                    
 
    osal_uint8_t mac[LEC_EOE_MAC_LEN];              
    osal_uint8_t ip_address[LEC_EOE_IP_ADDRESS_LEN];
    osal_uint8_t subnet[LEC_EOE_SUBNET_LEN];        
    osal_uint8_t gateway[LEC_EOE_GATEWAY_LEN];      
    osal_uint8_t dns[LEC_EOE_DNS_LEN];              
    osal_char_t dns_name[LEC_EOE_DNS_NAME_LEN];     
} ec_eoe_slave_config_t;
 
typedef struct ec_eoe {
    pool_t recv_pool;                               
    pool_t response_pool;
 
    pool_entry_t free_frames[128];                  
    pool_t eth_frames_free_pool;                    
    pool_t eth_frames_recv_pool;                    
 
    osal_mutex_t lock;
    osal_semaphore_t send_sync;
} ec_eoe_t;
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
void ec_eoe_init(ec_t *pec, osal_uint16_t slave);
 
 
void ec_eoe_deinit(ec_t *pec, osal_uint16_t slave);
 
 
void ec_eoe_enqueue(ec_t *pec, osal_uint16_t slave, pool_entry_t *p_entry);
 
 
int ec_eoe_set_ip_parameter(ec_t *pec, osal_uint16_t slave, osal_uint8_t *mac,
        osal_uint8_t *ip_address, osal_uint8_t *subnet, osal_uint8_t *gateway, 
        osal_uint8_t *dns, osal_char_t *dns_name);
 
// send ethernet frame, fragmented if needed
int ec_eoe_send_frame(ec_t *pec, osal_uint16_t slave, osal_uint8_t *frame, 
        osal_size_t frame_len);
 
// setup tun interface
int ec_eoe_setup_tun(ec_t *pec);
 
// Destroy tun interface
void ec_eoe_destroy_tun(ec_t *pec);
 
#ifdef __cplusplus
}
#endif
 
#endif // LIBETHERCAT_EOE_H