SMI On Request Data

Overview

SMI On Request Data.

Typedefs
typedef void(*	IOLM_SMI_CBDeviceWriteCnf) (INT8U u8ClientID_p, INT8U u8Port_p, INT16U u16Error_p)
	Set Device On-request Data confirmation callback. More...
typedef void(*	IOLM_SMI_CBDeviceReadCnf) (INT8U u8ClientID_p, INT8U u8Port_p, INT16U u16Error_p, INT16U u16ArgBlockLength_p, INT8U *pu8ArgBlock_p)
	Get Device On-request Data confirmation callback. More...

Functions
IOL_FUNC_DECL void	IOLM_SMI_vDeviceWriteReq (INT8U u8ClientID_p, INT8U u8Port_p, INT16U u16ArgBlockLength_p, INT8U *pu8ArgBlock_p)
	Set Device On-request Data. More...
IOL_FUNC_DECL void	IOLM_SMI_vDeviceReadReq (INT8U u8ClientID_p, INT8U u8Port_p, INT16U u16ArgBlockLength_p, INT8U *pu8ArgBlock_p)
	Get Device On-request Data. More...

Typedef Documentation

IOLM_SMI_CBDeviceReadCnf

IOLM_SMI_CBDeviceReadCnf

Get Device On-request Data confirmation callback.

This service allows for reading On-request Data (OD) from the Device via the Master. Confirmation to the IOLM_SMI_vDeviceReadReq request.

Parameters

[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 Device On-request Data (IOLM_SMI_SOnRequestData).

Example

void IOLM_SMI_vDeviceReadCnf(INT8U u8ClientID_p, INT8U u8Port_p, INT16U u16Error_p,
                            INT16U u16ArgBlockLength_p, INT8U *pu8ArgBlock_p)
{
    if (u16Error_p != IOL_eErrorType_NONE)
    {
        UART_printf("IO-Link port %u: Read failed with error 0x%04x\n", u8Port_p, u16Error_p);
    }
    else
    {
        // ToDo: Insert application specific code here
    }
}

See also

IOLM_SMI_SCallbacks, IOLM_SMI_vInit, IOLM_SMI_EArgBlockID

IOLM_SMI_CBDeviceWriteCnf

IOLM_SMI_CBDeviceWriteCnf

Set Device On-request Data confirmation callback.

This callback indicates an answer to an On-request Data (OD) write request from a Device. Confirmation to the IOLM_SMI_vDeviceWriteReq request.

Parameters

[in]	u8ClientID_p	Client ID.
[in]	u8Port_p	Port ID.
[in]	u16Error_p	Error message as IOL_EErrorType.

Example

void IOLM_SMI_vDeviceWriteCnf(INT8U u8ClientID_p, INT8U u8Port_p, INT16U u16Error_p)
{
    if (u16Error_p != IOL_eErrorType_NONE)
    {
        UART_printf("IO-Link port %u: Write failed with error 0x%04x\n", u8Port_p, u16Error_p);
    }
    else
    {
        // ToDo: Insert application specific code here
    }
}

See also

IOLM_SMI_SCallbacks, IOLM_SMI_vInit, IOLM_SMI_EArgBlockID

Function Documentation

IOLM_SMI_vDeviceReadReq()

IOL_FUNC_DECL void IOLM_SMI_vDeviceReadReq	(	INT8U	u8ClientID_p,
		INT8U	u8Port_p,
		INT16U	u16ArgBlockLength_p,
		INT8U *	pu8ArgBlock_p
	)

Get Device On-request Data.

This service allows for reading On-request Data (OD) from the Device via the Master. The answer to the request is the function IOLM_SMI_CBDeviceReadCnf.

Parameters

[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 Device On-request Data (IOLM_SMI_SOnRequestData).

Example

INT8U au8Mem[IOLM_SMI_ARGBLOCK_ONREQ_LEN(0)]; // Allocate ArgBlock memory
IOLM_SMI_SOnRequestData *psuReq = (IOLM_SMI_SOnRequestData *)au8Mem;
 
// Fill request
psuReq->u16ArgBlockID = IOLM_SMI_ENDIAN_16(IOLM_SMI_eArgBlockID_OnRequestDataRead);
psuReq->u16Index = IOLM_SMI_ENDIAN_16(16); // Index 16 = VendorName
psuReq->u8Subindex = 0;
 
// Send request
IOLM_SMI_vDeviceReadReq(
    0,                              // Client ID
    0,                              // Port
    IOLM_SMI_ARGBLOCK_ONREQ_LEN(0), // Length
    au8Mem
);
 
// Wait for IOLM_SMI_CBDeviceReadCnf

IOLM_SMI_vDeviceWriteReq()

IOL_FUNC_DECL void IOLM_SMI_vDeviceWriteReq	(	INT8U	u8ClientID_p,
		INT8U	u8Port_p,
		INT16U	u16ArgBlockLength_p,
		INT8U *	pu8ArgBlock_p
	)

Set Device On-request Data.

This service allows for writing On-request Data (OD) for propagation to the Device. The answer to the request is the function IOLM_SMI_CBDeviceWriteCnf.

Parameters

[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 Device's On-request Data (IOLM_SMI_SOnRequestData).

Example

INT8U au8Mem[IOLM_SMI_ARGBLOCK_ONREQ_LEN(2)]; // Allocate ArgBlock memory
IOLM_SMI_SOnRequestData *psuReq = (IOLM_SMI_SOnRequestData *)au8Mem;
 
// Fill request
psuReq->u16ArgBlockID = IOLM_SMI_ENDIAN_16(IOLM_SMI_eArgBlockID_OnRequestDataWrite);
psuReq->u16Index = IOLM_SMI_ENDIAN_16(123); // Index
psuReq->u8Subindex = 0;                     // SubIndex
psuReq->au8Data[0] = 0x12;                  // Data
psuReq->au8Data[1] = 0x34;                  // Data
 
// Send request
IOLM_SMI_vDeviceWriteReq(
    0,                              // Client ID
    0,                              // Port
    IOLM_SMI_ARGBLOCK_ONREQ_LEN(2), // Length
    au8Mem
);
 
// Wait for IOLM_SMI_CBDeviceWriteCnf