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... | |
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.
[in] | u8Port_p | The port number of the affected port. |
[out] | psuRealPortConfig_p | Real port configuration. |
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.
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:
[in] | u8Port_p | The port number of the affected port. |
[in] | psuPortConfig_p | Requested port configuration. |
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().
[in] | u8Port_p | The port number of the affected port. |
[in] | ePortMode_p | New port State. |