idx.h File Reference

ethercat index More...

#include <libosal/queue.h>
#include <libosal/types.h>
#include <libosal/binary_semaphore.h>
#include <libosal/mutex.h>
#include "libethercat/common.h"

Go to the source code of this file.

Data Structures
struct	idx_entry
	index entry More...
struct	idx_queue
	index queue More...

Macros
#define	LEC_MAX_INDEX   256

Typedefs
typedef struct idx_entry	idx_entry_t
	index entry
typedef struct idx_queue	idx_queue_t
	index queue

Functions
	TAILQ_HEAD (idx_entry_queue, idx_entry)
int	ec_index_init (idx_queue_t *idx_q)
	Initialize index queue structure.
void	ec_index_deinit (idx_queue_t *idx_q)
	Deinitialize index queue structure.
int	ec_index_get (idx_queue_t *idx_q, struct idx_entry **entry)
	Get next free index entry.
void	ec_index_put (idx_queue_t *idx_q, struct idx_entry *entry)
	Returns index entry.

Detailed Description

ethercat index

Author

Robert Burger rober.nosp@m.t.bu.nosp@m.rger@.nosp@m.dlr..nosp@m.de

Date

11 Nov 2016

Function Documentation

ec_index_deinit()

void ec_index_deinit

(

idx_queue_t *

idx_q

)

Deinitialize index queue structure.

Deinitialize index queue structure and clear all indicex for ethercat frames.

Parameters

[in]

idx_q

Pointer to index queue structure.

ec_index_get()

int ec_index_get	(	idx_queue_t *	idx_q,
		struct idx_entry **	entry
	)

Get next free index entry.

Parameters

[in]	idx_q	Pointer to index queue.
[out]	entry	Return entry of next free index.

Returns

EC_OK on succes, otherwise error code

ec_index_init()

int ec_index_init

(

idx_queue_t *

idx_q

)

Initialize index queue structure.

Initialize index queue structure and fill in 256 indicex for ethercat frames.

Parameters

[in]

idx_q

Pointer to index queue structure.

Returns

EC_OK 0 on success, oherwise error code

ec_index_put()

void ec_index_put	(	idx_queue_t *	idx_q,
		struct idx_entry *	entry
	)

Returns index entry.

Parameters

[in]	idx_q	Pointer to index queue.
[in]	entry	Return index entry.