iLLD_TC27xC  1.0
Utility Functions
Collaboration diagram for Utility Functions:

Functions

IFX_INLINE IfxEth_RxDescrIfxEth_RxDescr_getNext (IfxEth_RxDescr *descr)
 Get pointer to next RX descriptor. More...
 
IFX_INLINE IfxEth_RxDescrIfxEth_getActualRxDescriptor (IfxEth *eth)
 Get pointer to actual RX descriptor. More...
 
IFX_INLINE void IfxEth_shuffleTxDescriptor (IfxEth *eth)
 Shuffle to next TX descriptor. More...
 
IFX_INLINE void IfxEth_shuffleRxDescriptor (IfxEth *eth)
 Shuffle to next RX descriptor. More...
 
IFX_INLINE boolean IfxEth_isTxInterrupt (IfxEth *eth)
 Checks whether transmit interrupt is requested. More...
 
IFX_INLINE boolean IfxEth_isRxInterrupt (IfxEth *eth)
 Checks whether receive interrupt is requested. More...
 
IFX_INLINE boolean IfxEth_isRxDataAvailable (IfxEth *eth)
 Checks whether one or more RX data is available. More...
 
IFX_INLINE boolean IfxEth_isRxChecksumError (IfxEth *eth)
 
IFX_INLINE boolean IfxEth_isLinkActive (IfxEth *eth)
 Checks whether physical connection is active. More...
 
IFX_INLINE uint16 IfxEth_getRxDataLength (IfxEth *eth)
 Returns length of the oldest available RX data. More...
 
IFX_INLINE void * IfxEth_getMacAddressPointer (IfxEth *eth)
 Returns pointer to the MAC address configured for this ETH. More...
 
IFX_INLINE boolean IfxEth_getLoopbackMode (IfxEth *eth)
 Get a free transmit buffer. More...
 
IFX_INLINE IfxEth_TxDescrIfxEth_getBaseTxDescriptor (IfxEth *eth)
 Get pointer to base TX descriptor. More...
 
IFX_INLINE IfxEth_RxDescrIfxEth_getBaseRxDescriptor (IfxEth *eth)
 Get pointer to base RX descriptor. More...
 
IFX_INLINE IfxEth_TxDescrIfxEth_getActualTxDescriptor (IfxEth *eth)
 Get pointer to actual TX descriptor. More...
 
IFX_INLINE uint32 IfxEth_getActualRxIndex (IfxEth *eth)
 
IFX_INLINE void IfxEth_TxDescr_release (IfxEth_TxDescr *descr)
 Release a TX descriptor for transmit queue. More...
 
IFX_INLINE void IfxEth_RxDescr_release (IfxEth_RxDescr *descr)
 release RX descriptor More...
 
IFX_EXTERN void IfxEth_wakeupTransmitter (IfxEth *eth)
 Wakeup the transmitter functions. More...
 
IFX_EXTERN void IfxEth_wakeupReceiver (IfxEth *eth)
 Wakeup the receiver functions. More...
 
IFX_EXTERN void IfxEth_stopTransmitter (IfxEth *eth)
 Stop the transmitter functions. More...
 
IFX_EXTERN void IfxEth_startTransmitter (IfxEth *eth)
 Start the transmitter functions. More...
 
IFX_EXTERN void IfxEth_setupChecksumEngine (IfxEth *eth, IfxEth_ChecksumMode mode)
 Set up checksum Engine. More...
 
IFX_EXTERN void IfxEth_setAndSendTransmitBuffer (IfxEth *eth, void *buffer, uint16 len)
 
IFX_EXTERN void IfxEth_readMacAddress (IfxEth *eth, uint8 *macAddress)
 Reads the MAC address from module register. More...
 
IFX_EXTERN void * IfxEth_getTransmitBuffer (IfxEth *eth)
 Get a free transmit buffer. 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_enableModule (void)
 Enable ETH Module. More...
 

Detailed Description

Function Documentation

IFX_EXTERN void IfxEth_enableModule ( void  )

Enable ETH Module.

Returns
None

Definition at line 548 of file IfxEth.c.

Referenced by IfxEth_init().

IFX_INLINE IfxEth_RxDescr * IfxEth_getActualRxDescriptor ( IfxEth eth)

Get pointer to actual RX descriptor.

Parameters
etheth ETH driver structure

Definition at line 801 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 902 of file IfxEth.h.

IFX_INLINE IfxEth_TxDescr * IfxEth_getActualTxDescriptor ( IfxEth eth)

Get pointer to actual TX descriptor.

Parameters
etheth ETH driver structure

Definition at line 896 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
etheth ETH driver structure

Definition at line 890 of file IfxEth.h.

Referenced by IfxEth_getActualRxIndex().

IFX_INLINE IfxEth_TxDescr * IfxEth_getBaseTxDescriptor ( IfxEth eth)

Get pointer to base TX descriptor.

Parameters
etheth ETH driver structure

Definition at line 884 of file IfxEth.h.

Referenced by IfxEth_setupChecksumEngine().

IFX_INLINE boolean IfxEth_getLoopbackMode ( IfxEth eth)

Get a free transmit buffer.

Parameters
ethETH driver structure
Returns
Loop back mode status (TRUE / FALSE)

Definition at line 877 of file IfxEth.h.

IFX_INLINE void * IfxEth_getMacAddressPointer ( IfxEth eth)

Returns pointer to the MAC address configured for this ETH.

Parameters
ethETH driver structure

Definition at line 871 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
ethETH driver structure
Returns
retval NULL_PTR no received frame retval !NULL_PTR a frame has been received

Definition at line 522 of file IfxEth.c.

IFX_INLINE uint16 IfxEth_getRxDataLength ( IfxEth eth)

Returns length of the oldest available RX data.

Parameters
ethETH driver structure
Returns
Data length

Definition at line 858 of file IfxEth.h.

IFX_EXTERN void* IfxEth_getTransmitBuffer ( IfxEth eth)

Get a free transmit buffer.

Parameters
ethETH driver structure
Returns
retval NULL_PTR no free transmit buffer is available retval !NULL_PTR a free transmit buffer is available

Definition at line 507 of file IfxEth.c.

Referenced by IfxEth_waitTransmitBuffer().

IFX_INLINE boolean IfxEth_isLinkActive ( IfxEth eth)

Checks whether physical connection is active.

Parameters
ethETH driver structure
Returns
retval zero Connection is inactive retval non zero Connection is active

Definition at line 852 of file IfxEth.h.

IFX_INLINE boolean IfxEth_isRxChecksumError ( IfxEth eth)
Parameters
ethpointer to ETH driver structure

Definition at line 842 of file IfxEth.h.

IFX_INLINE boolean IfxEth_isRxDataAvailable ( IfxEth eth)

Checks whether one or more RX data is available.

Parameters
ethETH driver structure
Returns
retval TRUE one or more RX data is available retval FALSE no RX data is available

Definition at line 835 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
ethETH driver structure
Returns
TRUE/FALSE

Definition at line 827 of file IfxEth.h.

IFX_INLINE boolean IfxEth_isTxInterrupt ( IfxEth eth)

Checks whether transmit interrupt is requested.

Parameters
ethETH driver structure
Returns
TRUE/FALSE

Definition at line 819 of file IfxEth.h.

IFX_EXTERN void IfxEth_readMacAddress ( IfxEth eth,
uint8 macAddress 
)

Reads the MAC address from module register.

Parameters
ethETH driver structure
macAddressMAC address
Returns
None

Definition at line 301 of file IfxEth.c.

IFX_INLINE IfxEth_RxDescr * IfxEth_RxDescr_getNext ( IfxEth_RxDescr descr)

Get pointer to next RX descriptor.

Parameters
descrdescr Pointer to an RX descriptor

Definition at line 795 of file IfxEth.h.

Referenced by IfxEth_shuffleRxDescriptor().

IFX_INLINE void IfxEth_RxDescr_release ( IfxEth_RxDescr descr)

release RX descriptor

Returns
None

Definition at line 915 of file IfxEth.h.

Referenced by IfxEth_freeReceiveBuffer().

IFX_EXTERN void IfxEth_setAndSendTransmitBuffer ( IfxEth eth,
void *  buffer,
uint16  len 
)
Parameters
ethpointer to ETH driver structure
lenlength of buffer
Returns
None

Definition at line 280 of file IfxEth.c.

IFX_EXTERN void IfxEth_setupChecksumEngine ( IfxEth eth,
IfxEth_ChecksumMode  mode 
)

Set up checksum Engine.

Parameters
etheth ETH driver structure
Returns
None

Definition at line 230 of file IfxEth.c.

IFX_INLINE void IfxEth_shuffleRxDescriptor ( IfxEth eth)

Shuffle to next RX descriptor.

Parameters
etheth ETH driver structure
Returns
None

Definition at line 813 of file IfxEth.h.

Referenced by IfxEth_freeReceiveBuffer().

IFX_INLINE void IfxEth_shuffleTxDescriptor ( IfxEth eth)

Shuffle to next TX descriptor.

Parameters
etheth ETH driver structure
Returns
None

Definition at line 807 of file IfxEth.h.

Referenced by IfxEth_sendTransmitBuffer().

IFX_EXTERN void IfxEth_startTransmitter ( IfxEth eth)

Start the transmitter functions.

Parameters
etheth ETH driver structure
Returns
None

Definition at line 143 of file IfxEth.c.

Referenced by IfxEth_wakeupTransmitter().

IFX_EXTERN void IfxEth_stopTransmitter ( IfxEth eth)

Stop the transmitter functions.

Parameters
etheth ETH driver structure
Returns
None

Definition at line 133 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
descrEnter_String_herdescr Pointer to a TX descriptore
Returns
None

Definition at line 909 of file IfxEth.h.

IFX_EXTERN void IfxEth_wakeupReceiver ( IfxEth eth)

Wakeup the receiver functions.

Parameters
etheth ETH driver structure
Returns
None

Definition at line 116 of file IfxEth.c.

Referenced by IfxEth_getReceiveBuffer().

IFX_EXTERN void IfxEth_wakeupTransmitter ( IfxEth eth)

Wakeup the transmitter functions.

Parameters
etheth ETH driver structure
Returns
None

Definition at line 97 of file IfxEth.c.

Referenced by IfxEth_sendTransmitBuffer().