API without SMI

This section provides an overview of all interface functions that can be used with the SMI disabled. The great advantage of SMI is that most of the API functionality is handled by the SMI and doesn't have to be set manually. To deactivate the SMI, the IOLM_SMI_ENABLED definition must be set to 0. For more details, see the corresponding function descriptions and the following sections.

General API

The stack needs to be initalized once during startup with the following function:

• IOLM_API_eInit()

To proceed the internal state machines and send notifications to the application layer, the main run function must be called periodically. This must be done at least once during an IO-Link cycle.

• IOLM_API_vRun()

Timing API

The following functions are used for timing:

• IOLM_API_vTimerExpired()
• IOLM_Port_vStartTimer()
• IOLM_Port_s32SysTickVal()

For details see Timer System.

Physical Layer API

The following functions are used to access the physical layer:

• IOLM_API_PL_vTransferInd()
• IOLM_Port_PL_vSetMode()
• IOLM_Port_PL_eWakeUp()
• IOLM_API_PL_u8WakeAck()
• IOLM_Port_PL_vTransferPrepare()
• IOLM_Port_PL_vTransferTrig()
• IOLM_Port_PL_boGetDI()
• IOLM_Port_PL_vSetDO()

For details see Physical Layer.

Port Configuration

The configuration of device specific stack values (like IOLM_PORT_COUNT for the number of available ports on the Master, IOLM_SMI_ENABLED, etc.) needs to be set in IO-Link Port Definitions and in IO-Link Master Port Definitions.

System Management API

The System Management is used to configure the port modes and indicate their current state.

• IOLM_API_SM_eSetPortConfig()
• IOLM_API_SM_eGetPortConfig()
• IOLM_API_SM_eOperate()
• IOLM_Port_SM_vPortMode()

Process Data API

The following functions are used to access the process image:

• IOLM_API_AL_eGetInput()
• IOLM_API_AL_eSetOutput()

If the Port is in a SIO Mode, the process image length is 1 byte and used as boolean for the state of the pin.

The following function indicates that there is new input process image available:

• IOLM_Port_AL_vNewInput()

The following function indicate the end of a Process Data cycle:

• IOLM_Port_AL_vPDCycle()

The following functions are used to set/indicate the status of the Process Data:

• IOLM_API_AL_eControlReq()
• IOLM_Port_AL_vControlInd()

ISDU/Parameter API

The ISDU/Parameter API is used to access parameters of a Device. Requests are sent with the Req functions. If the request is finished (which takes multiple IO-Link cycles), the corresponding Cnf function is called with the result. If a Device needs too much time to respond, the request can be aborted. There is also a auto timeout of IOL_ISDU_TIMEOUT_MS milliseconds.

• IOLM_API_AL_eReadReq()
• IOLM_API_AL_eWriteReq()
• IOLM_API_AL_vAbort()
• IOLM_Port_AL_vReadCnf()
• IOLM_Port_AL_vWriteCnf()

Event API

Events are indicated by the following function:

• IOLM_Port_AL_vEventInd()

Events must always be acknowledged. The application will receive no further Device Event until the last one is acknowledged by the following function.

• IOLM_API_AL_vEventRsp()

Data Storage API

The following functions are used to access the Data Storage:

• IOLM_API_DS_eSet()
• IOLM_API_DS_eDelete()
• IOLM_Port_DS_vStoreData()
• IOLM_API_DS_vStoreComplete()
• IOLM_Port_DS_u16LoadData()

For a detailed description see Data Storage.