Windows Driver IPC API (RTKAPI) Overview

The Windows Driver Interprocess Communication API (RTKAPI) functions access wRTOS IPC mechanisms from Windows kernel device drivers. These RTKAPI calls are analogous to their RTAPI counterparts. For example, RtkOpenSemaphore is analogous to RtOpenSemaphore.

You use the RTKAPI functions the same way as the RTAPI functions, but from the Windows kernel environment. All RTKAPI interface names are prefixed with Rtk.

The RTKAPI includes a file (RtkApi.h) and a link library (RtkAPI.lib).

Note: RTK functions can be called only at the PASSIVE_LEVEL IRQL of a Windows Device Driver.

IMPORTANT: RTKAPI calls do not support subsystem dependencies that exist when using RTAPI calls. You must ensure the subsystem has been started before your driver starts.

Building RTK Drivers

To build wRTOS RTK drivers to run on Windows 10 and above, you must install a supported version of Visual Studio and Windows Driver Kit (WDK).

Please note the following installation requirements:

Note: Since the wRTOS Subsystem is built with Windows Driver Kit (WDK) 10, we recommend not using previous WDK versions to build RTK drivers.

Note: If you encounter errors related to headers and libraries while building RTK drivers, ensure that the installed versions of the WDK and Windows SDK match and that the Target Platform Version setting in Visual Studio (Configuration PropertiesGeneral > Target Platform Version) is set to the correct version number.