EtherNet/IP FWHAL APIs

Introduction

Functions
void	EIP_drvInit (EIP_Handle icssEipHandle)
	Initialization routine for Ethernet/IP driver functions. More...
void	EIP_drvStop (EIP_Handle icssEipHandle)
	EIP driver stop API. More...
void	EIP_drvStart (EIP_Handle icssEipHandle)
	EIP driver start API. More...
void	EIP_processProtocolFrames (uint32_t *queue_number, void *userArg)
	API to process the real time Packets. More...
int8_t	EIP_initializeCIPSync (EIP_Handle icssEipHandle)
	API to initialize the CIP Sync objects in the EIP handle Initialize CIP Sync member variables based on PTP implementation. More...
int32_t	EIP_configureLLDPForwarding (EIP_Handle icssEipHandle, uint8_t enableFeature)
	API to configure the LLDP forwarding to the other port. More...
int32_t	EIP_configureLLDPFwdHelper (uint32_t pruBaseAddress, uint8_t val)
	API to configure the value stored at the required offset in ICSS SMEM. More...

Function Documentation

EIP_drvInit()

void EIP_drvInit

(

EIP_Handle

icssEipHandle

)

Initialization routine for Ethernet/IP driver functions.

    This API does the following functionalities:
        Loads the firmware on PRU0 and PRU1 cores
        Call DLR init API
        Call TimeSync(PTP) init API

Parameters

icssEipHandle

[in] EIP handle

EIP_drvStop()

void EIP_drvStop

(

EIP_Handle

icssEipHandle

)

EIP driver stop API.

    This API stops DLR and disables PTP

Parameters

icssEipHandle

[in] EIP handle

EIP_drvStart()

void EIP_drvStart

(

EIP_Handle

icssEipHandle

)

EIP driver start API.

    This API starts DLR and enables PTP

Parameters

icssEipHandle

[in] EIP handle

EIP_processProtocolFrames()

void EIP_processProtocolFrames	(	uint32_t *	queue_number,
		void *	userArg
	)

API to process the real time Packets.

    This API will be registered as Real Tme Rx Call back. Incase of EIP, the driver
    receives DLR and PTP packets. This API receives the packet, checks the packet
    type and passes the packet to DLR driver or PTP driver

Parameters

queue_number	[in] Queue where the packet is present
userArg	[in] userArgumment. EIP handle

EIP_initializeCIPSync()

int8_t EIP_initializeCIPSync

(

EIP_Handle

icssEipHandle

)

API to initialize the CIP Sync objects in the EIP handle Initialize CIP Sync member variables based on PTP implementation.

Parameters

icssEipHandle

[in] EIP handle

Return values

0	- On success <0 - On failure

EIP_configureLLDPForwarding()

int32_t EIP_configureLLDPForwarding	(	EIP_Handle	icssEipHandle,
		uint8_t	enableFeature
	)

API to configure the LLDP forwarding to the other port.

Parameters

icssEipHandle	[in] EIP handle
enableFeature	[in] Option to enable or disable the LLDP forwarding 1 - Feature is enabled 0 - Feature is disabled

Return values

0	- On success <0 - On failure

EIP_configureLLDPFwdHelper()

int32_t EIP_configureLLDPFwdHelper	(	uint32_t	pruBaseAddress,
		uint8_t	val
	)

API to configure the value stored at the required offset in ICSS SMEM.

Parameters

pruBaseAddress	[in] PRU Base Address
val	[in] Value to program at the SMEM address

Return values

0	- On success <0 - On failure