EtherCAT_DataLinkLayer Class Reference

Abstract representation of the EtherCAT DLL. More...

#include <ethercat_dll.h>

List of all members.

Public Member Functions
void	attach (struct netif *netif)
	Attach the DLL to a networking interface.
bool	rx (EtherCAT_Frame *a_frame, int a_handle)
	receive an EtherCAT frame previously sent by tx() (blocking call!)
int	tx (EtherCAT_Frame *a_frame)
	transmit an EtherCAT frame (non-blocking call)
bool	txandrx (EtherCAT_Frame *a_frame)
	transmit and receive EtherCAT frame (blocking call!)
Static Public Member Functions
static EtherCAT_DataLinkLayer *	instance (void)
	This class is a singleton.
Protected Member Functions
	EtherCAT_DataLinkLayer ()
Private Attributes
struct netif *	m_if
Static Private Attributes
static EtherCAT_DataLinkLayer *	m_instance

---

Detailed Description

Abstract representation of the EtherCAT DLL.

Definition at line 42 of file ethercat_dll.h.

---

Constructor & Destructor Documentation

EtherCAT_DataLinkLayer::EtherCAT_DataLinkLayer

(

)

[protected]

---

Member Function Documentation

void EtherCAT_DataLinkLayer::attach

(

struct netif *

netif

)

Attach the DLL to a networking interface.

Parameters:

netif

pointer to the NIC

static EtherCAT_DataLinkLayer* EtherCAT_DataLinkLayer::instance

(

void

)

[static]

This class is a singleton.

Todo:

Pass destination MAC address instead of defaulting to broadcast?

bool EtherCAT_DataLinkLayer::rx	(	EtherCAT_Frame *	a_frame,
		int	a_handle
	)

receive an EtherCAT frame previously sent by tx() (blocking call!)

Parameters:

a_frame	ethercat frame to be sent
a_handle	handle previously returned by tx()

Returns:

false for error/dropped packet

int EtherCAT_DataLinkLayer::tx

(

EtherCAT_Frame *

a_frame

)

transmit an EtherCAT frame (non-blocking call)

Parameters:

a_frame

ethercat frame to be sent

Returns:

positive or zero handle on success, negative value for error Successfull tx MUST be followed by rx call.

bool EtherCAT_DataLinkLayer::txandrx

(

EtherCAT_Frame *

a_frame

)

transmit and receive EtherCAT frame (blocking call!)

Parameters:

a_frame

ethercat frame to be sent NOTE that txandrx will retry sending lost frames.

---

Member Data Documentation

struct netif* EtherCAT_DataLinkLayer::m_if [private]

Definition at line 81 of file ethercat_dll.h.

EtherCAT_DataLinkLayer* EtherCAT_DataLinkLayer::m_instance [static, private]

Definition at line 80 of file ethercat_dll.h.

---

The documentation for this class was generated from the following file:

• ethercat_dll.h