Collaboration diagram for Utility Functions:

Functions
IFX_INLINE IfxEth_RxDescr *	IfxEth_RxDescr_getNext (IfxEth_RxDescr *descr)
	Get pointer to next RX descriptor. More...

IFX_INLINE void	IfxEth_RxDescr_release (IfxEth_RxDescr *descr)
	release RX descriptor More...

IFX_INLINE void	IfxEth_TxDescr_release (IfxEth_TxDescr *descr)
	Release a TX descriptor for transmit queue. More...

IFX_INLINE IfxEth_RxDescr *	IfxEth_getActualRxDescriptor (IfxEth *eth)
	Get pointer to actual RX descriptor. More...

IFX_INLINE uint32	IfxEth_getActualRxIndex (IfxEth *eth)

IFX_INLINE IfxEth_TxDescr *	IfxEth_getActualTxDescriptor (IfxEth *eth)
	Get pointer to actual TX descriptor. More...

IFX_INLINE IfxEth_RxDescr *	IfxEth_getBaseRxDescriptor (IfxEth *eth)
	Get pointer to base RX descriptor. More...

IFX_INLINE IfxEth_TxDescr *	IfxEth_getBaseTxDescriptor (IfxEth *eth)
	Get pointer to base TX descriptor. More...

IFX_INLINE boolean	IfxEth_getLoopbackMode (IfxEth *eth)
	returns the status of th eloopback mode More...

IFX_INLINE void *	IfxEth_getMacAddressPointer (IfxEth *eth)
	Returns pointer to the MAC address configured for this ETH. More...

IFX_INLINE IfxEth_ReceiveProcessState	IfxEth_getReceiveProcessState (IfxEth *eth)
	returns the Receive Process State More...

IFX_INLINE uint16	IfxEth_getRxDataLength (IfxEth *eth)
	Returns length of the oldest available RX data. More...

IFX_INLINE IfxEth_TransmitProcessState	IfxEth_getTransmitProcessState (IfxEth *eth)
	returns the Transmit Process State More...

IFX_INLINE boolean	IfxEth_isLinkActive (IfxEth *eth)
	Checks whether physical connection is active. More...

IFX_INLINE boolean	IfxEth_isRxChecksumError (IfxEth *eth)

IFX_INLINE boolean	IfxEth_isRxDataAvailable (IfxEth *eth)
	Checks whether one or more RX data is available. More...

IFX_INLINE boolean	IfxEth_isRxInterrupt (IfxEth *eth)
	Checks whether receive interrupt is requested. More...

IFX_INLINE boolean	IfxEth_isTxInterrupt (IfxEth *eth)
	Checks whether transmit interrupt is requested. More...

IFX_INLINE void	IfxEth_readAllFlags (IfxEth *eth)
	reads the status of all flags More...

IFX_INLINE void	IfxEth_shuffleRxDescriptor (IfxEth *eth)
	Shuffle to next RX descriptor. More...

IFX_INLINE void	IfxEth_shuffleTxDescriptor (IfxEth *eth)
	Shuffle to next TX descriptor. More...

IFX_EXTERN void	IfxEth_enableModule (void)
	Enable ETH Module. More...

IFX_EXTERN void *	IfxEth_getReceiveBuffer (IfxEth *eth)
	Gets receive buffer note: IfxEth_freeReceiveBuffer() shall be called after the data from the RX buffer has been processed. More...

IFX_EXTERN void *	IfxEth_getTransmitBuffer (IfxEth *eth)
	Get a free transmit buffer. More...

IFX_EXTERN void	IfxEth_readMacAddress (IfxEth eth, uint8 macAddress)
	Reads the MAC address from module register. More...

IFX_EXTERN void	IfxEth_resetModule (void)
	resets Ethernet kernel More...

IFX_EXTERN void	IfxEth_setAndSendTransmitBuffer (IfxEth eth, void buffer, uint16 len)

IFX_EXTERN void	IfxEth_setupChecksumEngine (IfxEth *eth, IfxEth_ChecksumMode mode)
	Set up checksum Engine. More...

IFX_EXTERN void	IfxEth_startTransmitter (IfxEth *eth)
	Start the transmitter functions. More...

IFX_EXTERN void	IfxEth_stopTransmitter (IfxEth *eth)
	Stop the transmitter functions. More...

IFX_EXTERN void	IfxEth_wakeupReceiver (IfxEth *eth)
	Wakeup the receiver functions. More...

IFX_EXTERN void	IfxEth_wakeupTransmitter (IfxEth *eth)
	Wakeup the transmitter functions. More...

Detailed Description

Function Documentation

IFX_EXTERN void IfxEth_enableModule ( void )

Enable ETH Module.

Returns: None

Definition at line 47 of file IfxEth.c.

Referenced by IfxEth_init().

IFX_INLINE IfxEth_RxDescr * IfxEth_getActualRxDescriptor ( IfxEth * eth)

Get pointer to actual RX descriptor.

Parameters

eth	eth ETH driver structure

Definition at line 1008 of file IfxEth.h.

Referenced by IfxEth_freeReceiveBuffer(), IfxEth_getReceiveBuffer(), IfxEth_getRxDataLength(), IfxEth_isRxChecksumError(), and IfxEth_isRxDataAvailable().

IFX_INLINE uint32 IfxEth_getActualRxIndex ( IfxEth * eth)

Definition at line 1014 of file IfxEth.h.

IFX_INLINE IfxEth_TxDescr * IfxEth_getActualTxDescriptor ( IfxEth * eth)

Get pointer to actual TX descriptor.

Parameters

eth	eth ETH driver structure

Definition at line 1021 of file IfxEth.h.

Referenced by IfxEth_getTransmitBuffer(), IfxEth_sendTransmitBuffer(), and IfxEth_setAndSendTransmitBuffer().

IFX_INLINE IfxEth_RxDescr * IfxEth_getBaseRxDescriptor ( IfxEth * eth)

Get pointer to base RX descriptor.

Parameters

eth	eth ETH driver structure

Definition at line 1027 of file IfxEth.h.

Referenced by IfxEth_getActualRxIndex(), and IfxEth_initReceiveDescriptors().

IFX_INLINE IfxEth_TxDescr * IfxEth_getBaseTxDescriptor ( IfxEth * eth)

Get pointer to base TX descriptor.

Parameters

eth	eth ETH driver structure

Definition at line 1033 of file IfxEth.h.

Referenced by IfxEth_initTransmitDescriptors(), and IfxEth_setupChecksumEngine().

IFX_INLINE boolean IfxEth_getLoopbackMode ( IfxEth * eth)

returns the status of th eloopback mode

Parameters

eth	ETH driver structure

Returns: Loop back mode status (TRUE / FALSE)

Definition at line 1039 of file IfxEth.h.

IFX_INLINE void * IfxEth_getMacAddressPointer ( IfxEth * eth)

Returns pointer to the MAC address configured for this ETH.

Parameters

eth	ETH driver structure

Definition at line 1046 of file IfxEth.h.

IFX_EXTERN void* IfxEth_getReceiveBuffer ( IfxEth * eth)

Gets receive buffer
note: IfxEth_freeReceiveBuffer() shall be called after the data from the RX buffer has been processed.

Parameters

eth	ETH driver structure

Returns: retval NULL_PTR no received frame retval !NULL_PTR a frame has been received

Definition at line 66 of file IfxEth.c.

IFX_INLINE IfxEth_ReceiveProcessState IfxEth_getReceiveProcessState ( IfxEth * eth)

returns the Receive Process State

Parameters

eth	ETH driver structure

Returns: Receive Process State

Definition at line 1052 of file IfxEth.h.

IFX_INLINE uint16 IfxEth_getRxDataLength ( IfxEth * eth)

Returns length of the oldest available RX data.

Parameters

eth	ETH driver structure

Returns: Data length

Definition at line 1059 of file IfxEth.h.

IFX_EXTERN void* IfxEth_getTransmitBuffer ( IfxEth * eth)

Get a free transmit buffer.

Parameters

eth	ETH driver structure

Returns: retval NULL_PTR no free transmit buffer is available retval !NULL_PTR a free transmit buffer is available

Definition at line 84 of file IfxEth.c.

Referenced by IfxEth_waitTransmitBuffer().

IFX_INLINE IfxEth_TransmitProcessState IfxEth_getTransmitProcessState ( IfxEth * eth)

returns the Transmit Process State

Parameters

eth	ETH driver structure

Returns: Transmit Process State

Definition at line 1072 of file IfxEth.h.

IFX_INLINE boolean IfxEth_isLinkActive ( IfxEth * eth)

Checks whether physical connection is active.

Parameters

eth	ETH driver structure

Returns: retval zero Connection is inactive retval non zero Connection is active

Definition at line 1079 of file IfxEth.h.

IFX_INLINE boolean IfxEth_isRxChecksumError ( IfxEth * eth)

Parameters

eth	pointer to ETH driver structure

Definition at line 1085 of file IfxEth.h.

IFX_INLINE boolean IfxEth_isRxDataAvailable ( IfxEth * eth)

Checks whether one or more RX data is available.

Parameters

eth	ETH driver structure

Returns: retval TRUE one or more RX data is available retval FALSE no RX data is available

Definition at line 1095 of file IfxEth.h.

Referenced by IfxEth_getReceiveBuffer(), and IfxEth_getRxDataLength().

IFX_INLINE boolean IfxEth_isRxInterrupt ( IfxEth * eth)

Checks whether receive interrupt is requested.

Parameters

eth	ETH driver structure

Returns: TRUE/FALSE

Definition at line 1102 of file IfxEth.h.

IFX_INLINE boolean IfxEth_isTxInterrupt ( IfxEth * eth)

Checks whether transmit interrupt is requested.

Parameters

eth	ETH driver structure

Returns: TRUE/FALSE

Definition at line 1117 of file IfxEth.h.

IFX_INLINE void IfxEth_readAllFlags ( IfxEth * eth)

reads the status of all flags

Parameters

eth	ETH driver structure

Returns: None

Definition at line 1125 of file IfxEth.h.

IFX_EXTERN void IfxEth_readMacAddress	(	IfxEth *	eth,
		uint8 *	macAddress
	)

Reads the MAC address from module register.

Parameters

eth	ETH driver structure
macAddress	MAC address

Returns: None

Definition at line 330 of file IfxEth.c.

IFX_EXTERN void IfxEth_resetModule ( void )

resets Ethernet kernel

Returns: None

Definition at line 338 of file IfxEth.c.

Referenced by IfxEth_init().

IFX_INLINE IfxEth_RxDescr * IfxEth_RxDescr_getNext ( IfxEth_RxDescr * descr)

Get pointer to next RX descriptor.

Parameters

descr descr Pointer to an RX descriptor

Returns: next RX descriptor

Definition at line 933 of file IfxEth.h.

Referenced by IfxEth_shuffleRxDescriptor().

IFX_INLINE void IfxEth_RxDescr_release ( IfxEth_RxDescr * descr)

release RX descriptor

Parameters

descr pointer to Rx descriptor

Returns: None

Definition at line 939 of file IfxEth.h.

Referenced by IfxEth_freeReceiveBuffer().

IFX_EXTERN void IfxEth_setAndSendTransmitBuffer	(	IfxEth *	eth,
		void *	buffer,
		uint16	len
	)

Parameters

eth	pointer to ETH driver structure
len	length of buffer

Returns: None

Definition at line 371 of file IfxEth.c.

IFX_EXTERN void IfxEth_setupChecksumEngine	(	IfxEth *	eth,
		IfxEth_ChecksumMode	mode
	)

Set up checksum Engine.

Parameters

eth	eth ETH driver structure
mode	specifies checksum mode

Returns: None

Definition at line 395 of file IfxEth.c.

IFX_INLINE void IfxEth_shuffleRxDescriptor ( IfxEth * eth)

Shuffle to next RX descriptor.

Parameters

eth	eth ETH driver structure

Returns: None

Definition at line 1157 of file IfxEth.h.

Referenced by IfxEth_freeReceiveBuffer().

IFX_INLINE void IfxEth_shuffleTxDescriptor ( IfxEth * eth)

Shuffle to next TX descriptor.

Parameters

eth	eth ETH driver structure

Returns: None

Definition at line 1163 of file IfxEth.h.

Referenced by IfxEth_sendTransmitBuffer().

IFX_EXTERN void IfxEth_startTransmitter ( IfxEth * eth)

Start the transmitter functions.

Parameters

eth	eth ETH driver structure

Returns: None

Definition at line 578 of file IfxEth.c.

Referenced by IfxEth_wakeupTransmitter().

IFX_EXTERN void IfxEth_stopTransmitter ( IfxEth * eth)

Stop the transmitter functions.

Parameters

eth	eth ETH driver structure

Returns: None

Definition at line 588 of file IfxEth.c.

Referenced by IfxEth_init().

IFX_INLINE void IfxEth_TxDescr_release ( IfxEth_TxDescr * descr)

Release a TX descriptor for transmit queue.

Parameters

descr Enter_String_herdescr Pointer to a TX descriptore

Returns: None

Definition at line 963 of file IfxEth.h.

IFX_EXTERN void IfxEth_wakeupReceiver ( IfxEth * eth)

Wakeup the receiver functions.

Parameters

eth	eth ETH driver structure

Returns: None

Definition at line 598 of file IfxEth.c.

Referenced by IfxEth_getReceiveBuffer().

IFX_EXTERN void IfxEth_wakeupTransmitter ( IfxEth * eth)

Wakeup the transmitter functions.

Parameters

eth	eth ETH driver structure

Returns: None

Definition at line 615 of file IfxEth.c.

Referenced by IfxEth_sendTransmitBuffer().