pool.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 POOL_H
#define POOL_H
 
#include <libosal/queue.h>
 
#include <libosal/types.h>
#include <libosal/mutex.h>
#include <libosal/semaphore.h>
 
#include "libethercat/common.h"
#include "libethercat/idx.h"
 
#define LEC_MAX_POOL_DATA_SIZE      (1600)      
 
// forward declaration
struct ec; 
struct ec_datagram;
 
typedef struct pool_entry {
    void (*user_cb)(struct ec *pec, struct pool_entry *p_entry, struct ec_datagram *p_dg);  
    int user_arg;                                           
    idx_entry_t *p_idx;                                     
 
    TAILQ_ENTRY(pool_entry) qh;                             
    
    osal_uint8_t data[LEC_MAX_POOL_DATA_SIZE];              
} pool_entry_t;                                             
 
TAILQ_HEAD(pool_queue, pool_entry);
 
typedef struct pool {    
    struct pool_queue avail;                                
    osal_semaphore_t avail_cnt;                             
    osal_mutex_t _pool_lock;                                
} pool_t;                                                   
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
int pool_open(pool_t *pp, osal_size_t cnt, pool_entry_t *entries);
 
 
int pool_close(pool_t *pp);
 
 
int pool_get(pool_t *pp, pool_entry_t **entry, osal_timer_t *timeout);
 
 
void pool_remove(pool_t *pp, pool_entry_t *entry);
 
 
int pool_peek(pool_t *pp, pool_entry_t **entry);
    
 
void pool_put(pool_t *pp, pool_entry_t *entry);
 
 
void pool_put_head(pool_t *pp, pool_entry_t *entry);
 
#ifdef __cplusplus
}
#endif
 
#endif // POOL_H