pdo_list.h File Reference

EtherCAT PDO list structure. More...

Go to the source code of this file.

Data Structures
struct	ec_pdo_list_t
	EtherCAT PDO list. More...
Functions
void	ec_pdo_list_init (ec_pdo_list_t *)
	PDO list constructor.
void	ec_pdo_list_clear (ec_pdo_list_t *)
	PDO list destructor.
void	ec_pdo_list_clear_pdos (ec_pdo_list_t *)
	Clears the list of mapped PDOs.
ec_pdo_t *	ec_pdo_list_add_pdo (ec_pdo_list_t *, uint16_t)
	Add a new PDO to the list.
int	ec_pdo_list_add_pdo_copy (ec_pdo_list_t *, const ec_pdo_t *)
	Add the copy of an existing PDO to the list.
int	ec_pdo_list_copy (ec_pdo_list_t *, const ec_pdo_list_t *)
	Makes a deep copy of another PDO list.
uint16_t	ec_pdo_list_total_size (const ec_pdo_list_t *)
	Calculates the total size of the mapped PDO entries.
int	ec_pdo_list_equal (const ec_pdo_list_t *, const ec_pdo_list_t *)
	Compares two PDO lists.
ec_pdo_t *	ec_pdo_list_find_pdo (const ec_pdo_list_t *, uint16_t)
	Finds a PDO with the given index.
const ec_pdo_t *	ec_pdo_list_find_pdo_const (const ec_pdo_list_t *, uint16_t)
	Finds a PDO with the given index and returns a const pointer.
const ec_pdo_t *	ec_pdo_list_find_pdo_by_pos_const (const ec_pdo_list_t *, unsigned int)
	Finds a PDO via its position in the list.
unsigned int	ec_pdo_list_count (const ec_pdo_list_t *)
	Get the number of PDOs in the list.
void	ec_pdo_list_print (const ec_pdo_list_t *)
	Outputs the PDOs in the list.

---

Detailed Description

EtherCAT PDO list structure.

Definition in file pdo_list.h.

---

Function Documentation

ec_pdo_t* ec_pdo_list_add_pdo	(	ec_pdo_list_t *	pl,
		uint16_t	index
	)

Add a new PDO to the list.

Returns:

Pointer to new PDO, otherwise an ERR_PTR() code.

Parameters:

pl	PDO list.
index	PDO index.

Definition at line 117 of file pdo_list.c.

int ec_pdo_list_add_pdo_copy	(	ec_pdo_list_t *	pl,
		const ec_pdo_t *	pdo
	)

Add the copy of an existing PDO to the list.

Returns:

0 on success, else < 0

Parameters:

pl	PDO list.
pdo	PDO to add.

Definition at line 141 of file pdo_list.c.

int ec_pdo_list_copy	(	ec_pdo_list_t *	pl,
		const ec_pdo_list_t *	other
	)

Makes a deep copy of another PDO list.

Returns:

0 on success, else < 0

Parameters:

pl	PDO list.
other	PDO list to copy from.

Definition at line 177 of file pdo_list.c.

uint16_t ec_pdo_list_total_size

(

const ec_pdo_list_t *

pl

)

Calculates the total size of the mapped PDO entries.

Return values:

Data

size in byte.

Parameters:

pl

PDO list.

Definition at line 87 of file pdo_list.c.

int ec_pdo_list_equal	(	const ec_pdo_list_t *	pl1,
		const ec_pdo_list_t *	pl2
	)

Compares two PDO lists.

Only the list is compared, not the PDO entries (i. e. the PDO mapping).

Return values:

	1	The given PDO lists are equal.
	0	The given PDO lists differ.

Parameters:

pl1	First list.
pl2	Second list.

Definition at line 207 of file pdo_list.c.

ec_pdo_t* ec_pdo_list_find_pdo	(	const ec_pdo_list_t *	pl,
		uint16_t	index
	)

Finds a PDO with the given index.

Returns:

Search result, or NULL.

Parameters:

pl	PDO list.
index	PDO index.

Definition at line 243 of file pdo_list.c.

const ec_pdo_t* ec_pdo_list_find_pdo_const	(	const ec_pdo_list_t *	pl,
		uint16_t	index
	)

Finds a PDO with the given index and returns a const pointer.

Returns:

Search result, or NULL.

Parameters:

pl	PDO list.
index	PDO index.

Definition at line 265 of file pdo_list.c.

const ec_pdo_t* ec_pdo_list_find_pdo_by_pos_const	(	const ec_pdo_list_t *	pl,
		unsigned int	pos
	)

Finds a PDO via its position in the list.

Const version.

Returns:

Zero on success, otherwise a negative error code.

Parameters:

pl	PDO list.
pos	Position in the list.

Definition at line 289 of file pdo_list.c.

unsigned int ec_pdo_list_count

(

const ec_pdo_list_t *

pl

)

Get the number of PDOs in the list.

Returns:

Number of PDOs.

Parameters:

pl

PDO list.

Definition at line 311 of file pdo_list.c.