System Management

Overview

System Management API.

Functions
IOL_FUNC_DECL IOL_EErrorInfo	IOLM_API_SM_eSetPortConfig (INT8U u8Port_p, IOLM_SPortConfig *psuPortConfig_p)
	Port setup. More...
IOL_FUNC_DECL IOL_EErrorInfo	IOLM_API_SM_eGetPortConfig (INT8U u8Port_p, IOLM_SRealPortConfig *psuRealPortConfig_p)
	Get actual port configuration. More...
IOL_FUNC_DECL IOL_EErrorInfo	IOLM_API_SM_eOperate (void)
	Set all ready ports into OPERATE mode. More...
IOL_FUNC_DECL void	IOLM_Port_SM_vPortMode (INT8U u8Port_p, IOL_EPortMode ePortMode_p)
	Port mode indication. More...

Function Documentation

IOLM_API_SM_eGetPortConfig()

IOL_FUNC_DECL IOL_EErrorInfo IOLM_API_SM_eGetPortConfig	(	INT8U	u8Port_p,
		IOLM_SRealPortConfig *	psuRealPortConfig_p
	)

Get actual port configuration.

The get port configuration is used to get the actual port configuration. This function can be used to get the selected communication parameters.

Parameters

[in]	u8Port_p	The port number of the affected port.
[out]	psuRealPortConfig_p	Real port configuration.

Returns

IOL_EErrorInfo ErrorCode

Precondition

The port number must be smaller than IOLM_PORT_COUNT. psuRealPortConfig_p must point to a valid memory section.

Postcondition

psuRealPortConfig_p is valid.

IRQ-safe

No Function needs to be called in Mainloop context.

IOLM_API_SM_eOperate()

IOL_FUNC_DECL IOL_EErrorInfo IOLM_API_SM_eOperate

(

void

)

Set all ready ports into OPERATE mode.

Set operate function is used to set all ready Devices into OPERATE mode. The function checks the cycle time configuration and indicates and error if the requested cycle time can not be reached by one of the ready Devices.

Returns

IOL_EErrorInfo ErrorCode

Precondition

The port number must be smaller than IOLM_PORT_COUNT.

Postcondition

Port modes change to OPERATE.

IRQ-safe

No Function needs to be called in Mainloop context.

IOLM_API_SM_eSetPortConfig()

IOL_FUNC_DECL IOL_EErrorInfo IOLM_API_SM_eSetPortConfig	(	INT8U	u8Port_p,
		IOLM_SPortConfig *	psuPortConfig_p
	)

Port setup.

The set port configuration is used to setup the port mode. Depending on the target mode, not all values of IOLM_SPortConfig are needed. Unused values need to be set 0. If the desired target mode is already set, the function fails. The following target modes are possible:

• IOL_eTargetMode_INACTIVE :
  Is used to disable the port. Active communications are stopped. Needs no further parameter.
• IOL_eTargetMode_DI/IOL_eTargetMode_DO :
  Is used to set the port in digital IN/OUT mode (SIO mode). Active communications will be stopped. Needs no further parameter.
• IOL_eTargetMode_AUTOCOM :
  Start IO-Link communication with the connected Device. The Master accepts all Devices.
  Optional parameter: u8ConfiguredRevisionID, u8ConfiguredRevisionID
• IOL_eTargetMode_CFGCOM :
  Start IO-Link communication with the configured Device. The Master accepts only valid Devices.
  Required parameter: eInspectionLevel, au8ConfiguredVendorID, au8ConfiguredDevice ID
  Optional parameter: Parameters for IDENTICAL configuration (with serial number check)

Parameters

[in]	u8Port_p	The port number of the affected port.
[in]	psuPortConfig_p	Requested port configuration.

Returns

IOL_EErrorInfo ErrorCode

Precondition

The port number must be smaller than IOLM_PORT_COUNT.

Postcondition

On success, target mode changes.

IRQ-safe

No Function needs to be called in Mainloop context.

IOLM_Port_SM_vPortMode()

IOL_FUNC_DECL void IOLM_Port_SM_vPortMode	(	INT8U	u8Port_p,
		IOL_EPortMode	ePortMode_p
	)

Port mode indication.

This function is called if the State for this port has changed.

If a Port is in State IOL_ePortMode_READY_TO_OPERATE, the Device application can change the state of all ready ports to operate by call of IOLM_API_SM_eOperate().

Parameters

[in]	u8Port_p	The port number of the affected port.
[in]	ePortMode_p	New port State.

Returns

void

Precondition

The port number must be smaller than IOLM_PORT_COUNT.

Postcondition

None.

IRQ-safe

No Function will be called from Mainloop context.