Legacy Startup APIs

Introduction

Functions
tLegStates	PN_getLegState (void)
	Returns the IRT Legacy mode state. More...
void	PN_setLegState (void *arg, void *arg2)
	Sets the state of legacy state machine This API is registered as a callback in PN_registerSetState. More...
void	PN_setLegPkt (void *arg, void *arg2)
	Sets the Ethernet packet to output during legacy startup Usually a copy of RTC3 PPM. This API is registered as a callback in PN_registerSetPkt. More...
void	PN_registerSetState (PN_Handle pnHandle, pnLegCallBack_t callBack)
	Registers callback function for legacy state This callback is used to change the Legacy state machine. More...
void	PN_registerSetPkt (PN_Handle pnHandle, pnLegCallBack_t callBack)
	Registers callback function for packet pointer This callback is used to configure the packet send by the IRT state machine. More...

Typedefs
typedef void(*	pnLegCallBack_t) (void *arg, void *arg2)
	Callback function for processing Profinet IRQs. More...
typedef void(*	pnDrvThreadSafe_t) (void)

Enumerations
enum	tLegStates { NOINIT, READY, SENDPPM, ABORT }
	possible states for legacy suppport state machine More...

Typedef Documentation

pnLegCallBack_t

typedef void(* pnLegCallBack_t) (void *arg, void *arg2)

Callback function for processing Profinet IRQs.

Parameters

arg
arg2

Precondition

IRT_LEGACY_STARTUP_SUPPORT defined

pnDrvThreadSafe_t

typedef void(* pnDrvThreadSafe_t) (void)

Enumeration Type Documentation

tLegStates

enum tLegStates

possible states for legacy suppport state machine

Precondition

IRT_LEGACY_STARTUP_SUPPORT defined

Enumerator
NOINIT	not initialized yet
READY	initialized
SENDPPM	sending RTC3 packet in green at RR=128
ABORT	error case

Function Documentation

PN_getLegState()

tLegStates PN_getLegState

(

void

)

Returns the IRT Legacy mode state.

Returns

Current state of the Legacy mode state machine

PN_setLegState()

void PN_setLegState	(	void *	arg,
		void *	arg2
	)

Sets the state of legacy state machine This API is registered as a callback in PN_registerSetState.

Parameters

arg	new state tLegStates
arg2	not used

PN_setLegPkt()

void PN_setLegPkt	(	void *	arg,
		void *	arg2
	)

Sets the Ethernet packet to output during legacy startup Usually a copy of RTC3 PPM. This API is registered as a callback in PN_registerSetPkt.

Parameters

arg	Pointer to valid packet buffer, no checks. t_rtcPacket
arg2	not used

PN_registerSetState()

void PN_registerSetState	(	PN_Handle	pnHandle,
		pnLegCallBack_t	callBack
	)

Registers callback function for legacy state This callback is used to change the Legacy state machine.

Parameters

	pnHandle	Profinet Handle
[in]	callBack	Callback function pointer

Precondition

IRT_LEGACY_STARTUP_SUPPORT defined

PN_registerSetPkt()

void PN_registerSetPkt	(	PN_Handle	pnHandle,
		pnLegCallBack_t	callBack
	)

Registers callback function for packet pointer This callback is used to configure the packet send by the IRT state machine.

Parameters

	pnHandle	Profinet Handle
[in]	callBack	Callback function pointer

Precondition

IRT_LEGACY_STARTUP_SUPPORT defined