hw.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_HW_H
#define LIBETHERCAT_HW_H
 
#include <libosal/types.h>
#include <libosal/mutex.h>
 
#include <libethercat/pool.h>
#include <libethercat/datagram.h>
 
#if LIBETHERCAT_BUILD_DEVICE_PIKEOS == 1
#include <vm_file_types.h>
#include <drv/sbuf_hdr.h>
#endif
 
#define container_of(ptr, type, member) ({ \
        __typeof__( ((type *)0)->member ) *__mptr = (void *)(ptr); \
        (type *)( (char *)__mptr - offsetof(type,member) );})
 
#define ETH_P_ECAT      ((osal_uint16_t)0x88A4u)        
 
// forward decl
struct ec;
struct hw_common;
 
typedef enum pooltype {
    POOL_HIGH,
    POOL_LOW,
} pooltype_t; 
              //
 
typedef int (*hw_device_recv_t)(struct hw_common *phw);
 
 
typedef int (*hw_device_send_t)(struct hw_common *phw, ec_frame_t *pframe, pooltype_t pool_type);
 
 
typedef void (*hw_device_send_finished_t)(struct hw_common *phw);
 
 
typedef int (*hw_device_get_tx_buffer_t)(struct hw_common *phw, ec_frame_t **ppframe);
 
 
typedef int (*hw_device_close_t)(struct hw_common *phw);
 
#define ETH_FRAME_LEN   0x1518
 
typedef struct hw_common {
    struct ec *pec;                 
 
    osal_uint32_t mtu_size;         
    osal_mutex_t hw_lock;           
 
    pool_t tx_high;                 
    pool_t tx_low;                  
 
    pool_entry_t *tx_send[256];     
 
    osal_uint64_t frame_idx;        
    osal_size_t bytes_sent;         
    osal_size_t bytes_last_sent;    
    osal_timer_t next_cylce_start;  
 
    hw_device_recv_t recv;                      
    hw_device_send_t send;                      
    hw_device_send_finished_t send_finished;    
    hw_device_get_tx_buffer_t get_tx_buffer;    
    hw_device_close_t close;                    
                                                
    osal_uint64_t last_tx_duration_ns;
    osal_uint64_t last_rx_duration_ns;
} hw_common_t;                 
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
int hw_open(struct hw_common *phw, struct ec *pec);
 
 
int hw_close(struct hw_common *phw);
 
 
int hw_tx_high(struct hw_common *phw);
 
 
int hw_tx_low(struct hw_common *phw);
 
 
int hw_tx(struct hw_common *phw);
 
 
osal_bool_t hw_process_rx_frame(struct hw_common *phw, ec_frame_t *pframe);
 
 
void hw_enqueue(struct hw_common *phw, pool_entry_t *p_entry, pooltype_t pool_type);
 
#ifdef __cplusplus
}
#endif
 
#endif // LIBETHERCAT_HW_H