SMI Configuration.
Typedefs | |
typedef void(* | IOLM_SMI_CBMasterIdentificationCnf) (INT8U u8ClientID_p, INT16U u16Error_p, INT16U u16ArgBlockLength_p, INT8U *pu8ArgBlock_p) |
Get Master identification confirmation callback. More... | |
typedef void(* | IOLM_SMI_CBMasterConfigurationCnf) (INT8U u8ClientID_p, INT16U u16Error_p) |
Get Master configuration confirmation callback. More... | |
typedef void(* | IOLM_SMI_CBPortConfigurationCnf) (INT8U u8ClientID_p, INT8U u8Port_p, INT16U u16Error_p) |
Set port configuration confirmation callback. More... | |
typedef void(* | IOLM_SMI_CBReadbackPortConfigurationCnf) (INT8U u8ClientID_p, INT8U u8Port_p, INT16U u16Error_p, INT16U u16ArgBlockLength_p, INT8U *pu8ArgBlock_p) |
Read back port configuration confirmation callback. More... | |
typedef void(* | IOLM_SMI_CBPortStatusCnf) (INT8U u8ClientID_p, INT8U u8Port_p, INT16U u16Error_p, INT16U u16ArgBlockLength_p, INT8U *pu8ArgBlock_p) |
Get port status confirmation callback. More... | |
typedef void(* | IOLM_SMI_CBDSBackupToParServCnf) (INT8U u8ClientID_p, INT8U u8Port_p, INT16U u16Error_p, INT16U u16ArgBlockLength_p, INT8U *pu8ArgBlock_p) |
Backup to parameter server confirmation callback. More... | |
typedef void(* | IOLM_SMI_CBDSBackupFromParServCnf) (INT8U u8ClientID_p, INT8U u8Port_p, INT16U u16Error_p) |
Backup from parameter server confirmation callback. More... | |
Functions | |
IOL_FUNC_DECL void | IOLM_SMI_vMasterIdentificationReq (INT8U u8ClientID_p) |
Get Master identification. More... | |
IOL_FUNC_DECL void | IOLM_SMI_vMasterConfigurationReq (INT8U u8ClientID_p, INT16U u16ArgBlockLength_p, INT8U *pu8ArgBlock_p) |
Set Master configuration. More... | |
IOL_FUNC_DECL void | IOLM_SMI_vPortConfigurationReq (INT8U u8ClientID_p, INT8U u8Port_p, INT16U u16ArgBlockLength_p, INT8U *pu8ArgBlock_p) |
Set port configuration. More... | |
IOL_FUNC_DECL void | IOLM_SMI_vReadbackPortConfigurationReq (INT8U u8ClientID_p, INT8U u8Port_p) |
Read back port configuration. More... | |
IOL_FUNC_DECL void | IOLM_SMI_vPortStatusReq (INT8U u8ClientID_p, INT8U u8Port_p) |
Get port status. More... | |
IOL_FUNC_DECL INT16U | IOLM_SMI_u16PortStatusReqCnf (INT8U u8Port_p, INT16U *pu16ArgBlockLength_p, INT8U *pu8ArgBlock_p) |
Get port status request and confirmation. More... | |
IOL_FUNC_DECL void | IOLM_SMI_vDSBackupToParServReq (INT8U u8ClientID_p, INT8U u8Port_p) |
Backup to parameter server. More... | |
IOL_FUNC_DECL void | IOLM_SMI_vDSBackupFromParServReq (INT8U u8ClientID_p, INT8U u8Port_p, INT16U u16ArgBlockLength_p, INT8U *pu8ArgBlock_p) |
Backup from parameter server. More... | |
IOL_FUNC_DECL INT16U | IOLM_SMI_u16PortPowerOffOnReqCnf (INT8U u8Port_p, INT16U u16ArgBlockLength_p, INT8U *pu8ArgBlock_p) |
Port power off on request and confirmation. More... | |
IOLM_SMI_CBDSBackupFromParServCnf |
Backup from parameter server confirmation callback.
With the help of this service, an SMI client such as a gateway application is able to restore the technology parameter set of a Device within Data Storage from an upper level parameter server. Confirmation to the IOLM_SMI_vDSBackupFromParServReq request.
[in] | u8ClientID_p | Client ID. |
[in] | u8Port_p | Port ID. |
[in] | u16Error_p | Error message as IOL_EErrorType. |
IOLM_SMI_CBDSBackupToParServCnf |
Backup to parameter server confirmation callback.
With the help of this service, an SMI client such as a gateway application is able to retrieve the technology parameter set of a Device from Data Storage and back it up within an upper level parameter server. Confirmation to the IOLM_SMI_vDSBackupToParServReq request.
[in] | u8ClientID_p | Client ID. |
[in] | u8Port_p | Port ID. |
[in] | u16Error_p | Error message as IOL_EErrorType. |
[in] | u16ArgBlockLength_p | Length of ArgBlock. |
[in] | pu8ArgBlock_p | Data pointer which points to the backup to parameter server. |
IOLM_SMI_CBMasterConfigurationCnf |
Get Master configuration confirmation callback.
This callback service is called by the stack and is used to get the general configuration of the Master. Confirmation to the IOLM_SMI_vMasterConfigurationReq request.
[in] | u8ClientID_p | Client ID. |
[in] | u16Error_p | Error message as IOL_EErrorType. |
IOLM_SMI_CBMasterIdentificationCnf |
Get Master identification confirmation callback.
Confirmation callback to a request of the Master identification from the stack to the IOLM_SMI_vMasterIdentificationReq request. Since this is hardware specific, it has to be implemented in the application code.
[in] | u8ClientID_p | Client ID. |
[in] | u16Error_p | Error message as IOL_EErrorType. |
[in] | u16ArgBlockLength_p | Length of the ArgBlock. |
[in] | pu8ArgBlock_p | Data pointer which points to the master identification (IOLM_SMI_SMasterident). |
IOLM_SMI_CBPortConfigurationCnf |
Set port configuration confirmation callback.
With the help of this service, an SMI client such as a gateway application launches the indicated Master port and the connected Device using the elements in parameter PortConfigList. The service shall be accepted immediately and performed without delay. Content of Data Storage for that port will be deleted at each new port configuration via "DS_Delete". Confirmation to the IOLM_SMI_vPortConfigurationReq request.
[in] | u8ClientID_p | Client ID. |
[in] | u8Port_p | Port ID. |
[in] | u16Error_p | Error message as IOL_EErrorType. |
IOLM_SMI_CBPortStatusCnf |
Get port status confirmation callback.
This service allows for retrieval of the effective status of the indicated Master port. Confirmation to the IOLM_SMI_vPortStatusReq request. See also IOLM_SMI_u16PortStatusReqCnf for a combined request/confirmation service.
[in] | u8ClientID_p | Client ID. |
[in] | u8Port_p | Port ID. |
[in] | u16Error_p | Error message as IOL_EErrorType. |
[in] | u16ArgBlockLength_p | Length of ArgBlock. |
[in] | pu8ArgBlock_p | Data pointer which points to the port status (IOLM_SMI_SPortStatusList). |
IOLM_SMI_CBReadbackPortConfigurationCnf |
Read back port configuration confirmation callback.
This service allows for retrieval of the effective configuration of the indicated Master port. Confirmation to the IOLM_SMI_vReadbackPortConfigurationReq request.
[in] | u8ClientID_p | Client ID. |
[in] | u8Port_p | Port ID. |
[in] | u16Error_p | Error message as IOL_EErrorType. |
[in] | u16ArgBlockLength_p | Length of ArgBlock. |
[in] | pu8ArgBlock_p | Data pointer which points to the port configuration (IOLM_SMI_SPortConfigList). |
IOL_FUNC_DECL INT16U IOLM_SMI_u16PortPowerOffOnReqCnf | ( | INT8U | u8Port_p, |
INT16U | u16ArgBlockLength_p, | ||
INT8U * | pu8ArgBlock_p | ||
) |
Port power off on request and confirmation.
This service allows for switching power of a particular port off and on.
[in] | u8Port_p | Port ID. |
[in,out] | u16ArgBlockLength_p | Pointer which points to the length of ArgBlock. |
[in,out] | pu8ArgBlock_p | Data pointer which points to the PortPowerOffOn data (IOLM_SMI_SPortPowerOffOn). |
IOL_FUNC_DECL INT16U IOLM_SMI_u16PortStatusReqCnf | ( | INT8U | u8Port_p, |
INT16U * | pu16ArgBlockLength_p, | ||
INT8U * | pu8ArgBlock_p | ||
) |
Get port status request and confirmation.
This service allows for retrieval of the effective status of the indicated Master port. It combines the request (IOLM_SMI_vPortStatusReq) and confirmation (IOLM_SMI_CBPortStatusCnf) service.
[in] | u8Port_p | Port ID. |
[in,out] | pu16ArgBlockLength_p | Pointer to length of ArgBlock. |
[in,out] | pu8ArgBlock_p | Data pointer which points to the port status (IOLM_SMI_SPortStatusList). |
IOL_FUNC_DECL void IOLM_SMI_vDSBackupFromParServReq | ( | INT8U | u8ClientID_p, |
INT8U | u8Port_p, | ||
INT16U | u16ArgBlockLength_p, | ||
INT8U * | pu8ArgBlock_p | ||
) |
Backup from parameter server.
With the help of this service, an SMI client such as a gateway application is able to restore the technology parameter set of a Device within Data Storage from an upper level parameter server. The answer to the request is the function IOLM_SMI_CBDSBackupFromParServCnf.
[in] | u8ClientID_p | Client ID. |
[in] | u8Port_p | Port ID. |
[in] | u16ArgBlockLength_p | Length of ArgBlock. |
[in] | pu8ArgBlock_p | Data pointer which points to the backup to parameter server. |
Backup to parameter server.
With the help of this service, an SMI client such as a gateway application is able to retrieve the technology parameter set of a Device from Data Storage and back it up within an upper level parameter server. The answer to the request is the function IOLM_SMI_CBDSBackupToParServCnf.
[in] | u8ClientID_p | Client ID. |
[in] | u8Port_p | Port ID. |
IOL_FUNC_DECL void IOLM_SMI_vMasterConfigurationReq | ( | INT8U | u8ClientID_p, |
INT16U | u16ArgBlockLength_p, | ||
INT8U * | pu8ArgBlock_p | ||
) |
Set Master configuration.
This service allows to set the general configuration of the Master. The answer to the request is the function IOLM_SMI_CBMasterConfigurationCnf.
[in] | u8ClientID_p | Client ID. |
[in] | u16ArgBlockLength_p | Length of the ArgBlock. |
[in] | pu8ArgBlock_p | Data pointer which points to the Master configuration (IOLM_SMI_SVoidArgBlock). |
IOL_FUNC_DECL void IOLM_SMI_vMasterIdentificationReq | ( | INT8U | u8ClientID_p | ) |
Get Master identification.
Request of the Master identification. The answer to the request is the function IOLM_SMI_CBMasterIdentificationCnf.
[in] | u8ClientID_p | Client ID. |
IOL_FUNC_DECL void IOLM_SMI_vPortConfigurationReq | ( | INT8U | u8ClientID_p, |
INT8U | u8Port_p, | ||
INT16U | u16ArgBlockLength_p, | ||
INT8U * | pu8ArgBlock_p | ||
) |
Set port configuration.
With the help of this service, an SMI client such as a gateway application launches the indicated Master port and the connected Device using the elements in parameter PortConfigList. The service shall be accepted immediately and performed without delay. Content of Data Storage for that port will be deleted at each new port configuration via "DS_Delete". The answer to the request is the function IOLM_SMI_CBPortConfigurationCnf.
[in] | u8ClientID_p | Client ID. |
[in] | u8Port_p | Port ID. |
[in] | u16ArgBlockLength_p | Length of the ArgBlock. |
[in] | pu8ArgBlock_p | Data pointer which points to the port configuration (IOLM_SMI_SPortConfigList). |
Get port status.
This service allows for retrieval of the effective status of the indicated Master port. The answer to the request is the function IOLM_SMI_CBPortStatusCnf. See also IOLM_SMI_u16PortStatusReqCnf for a combined request/confirmation service.
[in] | u8ClientID_p | Client ID. |
[in] | u8Port_p | Port ID. |
Read back port configuration.
This service allows for retrieval of the effective configuration of the indicated Master port. The answer to the request is the function IOLM_SMI_CBReadbackPortConfigurationCnf.
[in] | u8ClientID_p | Client ID. |
[in] | u8Port_p | Port ID. |