ethernet.h File Reference

Ethernet over EtherCAT (EoE). More...

Go to the source code of this file.

Data Structures
struct	ec_eoe_frame_t
	Queued frame structure. More...
struct	ec_eoe
	Ethernet over EtherCAT (EoE) handler. More...
Typedefs
typedef struct ec_eoe	ec_eoe_t
Functions
int	ec_eoe_init (ec_eoe_t *, ec_slave_t *)
	EoE constructor.
void	ec_eoe_clear (ec_eoe_t *)
	EoE destructor.
void	ec_eoe_run (ec_eoe_t *)
	Runs the EoE state machine.
void	ec_eoe_queue (ec_eoe_t *)
	Queues the datagram, if necessary.
int	ec_eoe_is_open (const ec_eoe_t *)
	Returns the state of the device.
int	ec_eoe_is_idle (const ec_eoe_t *)
	Returns the idle state.

---

Detailed Description

Ethernet over EtherCAT (EoE).

Definition in file ethernet.h.

---

Typedef Documentation

typedef struct ec_eoe ec_eoe_t

See also:

ec_eoe

Definition at line 68 of file ethernet.h.

---

Function Documentation

int ec_eoe_init	(	ec_eoe_t *	eoe,
		ec_slave_t *	slave
	)

EoE constructor.

Initializes the EoE handler, creates a net_device and registers it.

Returns:

Zero on success, otherwise a negative error code.

Parameters:

eoe	EoE handler
slave	EtherCAT slave

Definition at line 104 of file ethernet.c.

void ec_eoe_clear

(

ec_eoe_t *

eoe

)

EoE destructor.

Unregisteres the net_device and frees allocated memory.

Parameters:

eoe	EoE handler

Definition at line 214 of file ethernet.c.

int ec_eoe_is_open

(

const ec_eoe_t *

eoe

)

Returns the state of the device.

Returns:

1 if the device is "up", 0 if it is "down"

Parameters:

eoe	EoE handler

Definition at line 372 of file ethernet.c.

int ec_eoe_is_idle

(

const ec_eoe_t *

eoe

)

Returns the idle state.

Return values:

	1	The device is idle.
	0	The device is busy.

Parameters:

eoe	EoE handler

Definition at line 384 of file ethernet.c.