APIs for Profinet Device FWHAL

Introduction

Profinet Device FWHAL(Firmware and Hardware Abstraction Layer) APIs implement the key interface between Profinet firmware and slave stack.

Sub Modules
	CPM/PPM Management APIs
	DCP Filter APIs
	Isochronous Mode APIs
	Legacy Startup APIs
	MRP APIs
	Multicast Filter Table APIs
	PTCP APIs
	Phase Management APIs
	Triple buffer management APIs
	Watchdog timer APIs

Data Structures
struct	t_listIndex
struct	t_rtcMemBuff

Functions
void	PN_registerPpmCall (PN_Handle pnHandle, pnCallBack_t callBack)
	Registers callback function required for PPM processing. More...
void	PN_registerCpmCall (PN_Handle pnHandle, pnCallBack_t callBack)
	Registers callback function required for CPM processing. More...
void	PN_registerStatCall (PN_Handle pnHandle, pnCallBack_t callBack)
	Registers callback function required for Stat processing. More...
void	PN_clearPruIRQ (PRUICSS_HwAttrs const *pruicssHwAttrs, uint8_t irq_num)
int32_t	PN_setBaseClock (PN_Handle pnHandle, uint16_t factor)
	Sets Profinet base clock in multiples of 31.25us. More...

Macros
#define	SHADOW_LIST   0
#define	ACTIVE_LIST   1
#define	HALFSIZE   4

Macro Definition Documentation

SHADOW_LIST

#define SHADOW_LIST   0

ACTIVE_LIST

#define ACTIVE_LIST   1

HALFSIZE

#define HALFSIZE   4

Function Documentation

PN_registerPpmCall()

void PN_registerPpmCall	(	PN_Handle	pnHandle,
		pnCallBack_t	callBack
	)

Registers callback function required for PPM processing.

Parameters

	pnHandle	Profinet Handle
[in]	callBack	Callback function pointer

PN_registerCpmCall()

void PN_registerCpmCall	(	PN_Handle	pnHandle,
		pnCallBack_t	callBack
	)

Registers callback function required for CPM processing.

Parameters

	pnHandle	Profinet Handle
[in]	callBack	Callback function pointer

PN_registerStatCall()

void PN_registerStatCall	(	PN_Handle	pnHandle,
		pnCallBack_t	callBack
	)

Registers callback function required for Stat processing.

Parameters

	pnHandle	Profinet Handle
[in]	callBack	Callback function pointer

PN_clearPruIRQ()

void PN_clearPruIRQ	(	PRUICSS_HwAttrs const *	pruicssHwAttrs,
		uint8_t	irq_num
	)

PN_setBaseClock()

int32_t PN_setBaseClock	(	PN_Handle	pnHandle,
		uint16_t	factor
	)

Sets Profinet base clock in multiples of 31.25us.

Parameters

[in]	pnHandle	Profinet Handle
	factor	Clock send factor: min value 8, max value 128

Return values

Slot	number (>=0)
<0	if failure

Variable Documentation

pRtcConfig

uint32_t pRtcConfig

Stores PRUSS DataRAM0

ocmcBaseAddress

uint32_t ocmcBaseAddress

Stores the OCMC Baseaddress