Isochronous Mode APIs

Introduction

Functions
void	PN_event1IsrHandler (void *arg)
	Event1 ISR handler. Used to call the application ISR Handler in case a Ti ISOM event/signal is triggered. More...
void	PN_event2IsrHandler (void *arg)
	Event2 ISR handler. Used to call the application ISR Handler in case a To ISOM event/signal is triggered. More...
int8_t	PN_ISO_initGPIOEvent (PN_Handle pnHandle, uint8_t isoMode, uint8_t isoEvent, uint32_t timeval, uint32_t duration)
	API to initialize the ISOM event/signal. Returns the ISOM handle. The Event/signal will be disabled by default. More...
void	PN_ISO_enableGPIOEvent (PN_Handle pnHandle)
	API to enable the ISOM event/signal generation. More...
void	PN_ISO_disableGPIOEvent (PN_Handle pnHandle)
	API to disable the ISOM event/signal generation. More...
void	PN_ISO_deInitGPIOEvent (PN_Handle pnHandle)
	API to De init the ISOM event/signal. More...

Macros
#define	PNISO_MODE_INTERRUPT   1
#define	PNISO_MODE_GPIO   2
#define	PNISO_MODE_DISABLE   0
#define	PNISO_MODE_ENABLE   1
#define	PNISO_TI_EVENT   1
#define	PNISO_TI_EVENT_REG_SHIFT   0
#define	PNISO_TO_EVENT   2
#define	PNISO_TO_EVENT_REG_SHIFT   1
#define	PNISO_ERR_SUCCESS   0
#define	PNISO_ERR_INVALID_EVENT   -1
#define	PNISO_ERR_EVENTS_EXHAUSTED   -2

Macro Definition Documentation

PNISO_MODE_INTERRUPT

#define PNISO_MODE_INTERRUPT   1

ISOM Interrupt Mode

PNISO_MODE_GPIO

#define PNISO_MODE_GPIO   2

ISOM GPIO Mode

PNISO_MODE_DISABLE

#define PNISO_MODE_DISABLE   0

Disable ISOM mode

PNISO_MODE_ENABLE

#define PNISO_MODE_ENABLE   1

Enable ISOM mode

PNISO_TI_EVENT

#define PNISO_TI_EVENT   1

Input ISOM event

PNISO_TI_EVENT_REG_SHIFT

#define PNISO_TI_EVENT_REG_SHIFT   0

Bit shift value for TI event

PNISO_TO_EVENT

#define PNISO_TO_EVENT   2

Output ISOM event

PNISO_TO_EVENT_REG_SHIFT

#define PNISO_TO_EVENT_REG_SHIFT   1

Bit shift value for TO event

PNISO_ERR_SUCCESS

#define PNISO_ERR_SUCCESS   0

PNISO_ERR_INVALID_EVENT

#define PNISO_ERR_INVALID_EVENT   -1

PNISO_ERR_EVENTS_EXHAUSTED

#define PNISO_ERR_EVENTS_EXHAUSTED   -2

Function Documentation

PN_event1IsrHandler()

void PN_event1IsrHandler

(

void *

arg

)

Event1 ISR handler. Used to call the application ISR Handler in case a Ti ISOM event/signal is triggered.

Parameters

[in]

arg

PN_event2IsrHandler()

void PN_event2IsrHandler

(

void *

arg

)

Event2 ISR handler. Used to call the application ISR Handler in case a To ISOM event/signal is triggered.

Parameters

[in]

arg

PN_ISO_initGPIOEvent()

int8_t PN_ISO_initGPIOEvent	(	PN_Handle	pnHandle,
		uint8_t	isoMode,
		uint8_t	isoEvent,
		uint32_t	timeval,
		uint32_t	duration
	)

API to initialize the ISOM event/signal. Returns the ISOM handle. The Event/signal will be disabled by default.

Parameters

	pnHandle	Profinet Handle
[in]	isoMode	ISOM Mode - PNISO_MODE_GPIO/PNISO_MODE_INTERRUPT
[in]	isoEvent	ISOM Event - PNISO_TI_EVENT/PNISO_TO_EVENT
[in]	timeval	time in nanosecond to trigger the event/signal (Reference is Start of Cycle)
[in]	duration	Duration of signal in nanoseconds

Return values

0	on success
-1	if max number of events reached
-2	if invalid event type passed

PN_ISO_enableGPIOEvent()

void PN_ISO_enableGPIOEvent

(

PN_Handle

pnHandle

)

API to enable the ISOM event/signal generation.

Parameters

pnHandle

Profinet Handle

PN_ISO_disableGPIOEvent()

void PN_ISO_disableGPIOEvent

(

PN_Handle

pnHandle

)

API to disable the ISOM event/signal generation.

Parameters

pnHandle

Profinet Handles

PN_ISO_deInitGPIOEvent()

void PN_ISO_deInitGPIOEvent

(

PN_Handle

pnHandle

)

API to De init the ISOM event/signal.

Parameters

pnHandle

Profinet Handle