About this Reference

The Virtual Device Developer's API Reference presents the QNX Hypervisor public API. It is intended for use by developers writing virtual devices (vdevs) in a QNX Hypervisor or QNX Hypervisor for Safety system.

This reference should be used in conjunction with the following documents:

Note: For information about which QNX SDP version is compatible with your QNX hypervisor release, meaning you can use that QNX SDP version as a development platform, see your hypervisor Release Notes.

As a convenience, the qvm public header files include the vdev.h header file, which includes all of the header files for the QNX vdev API.

Where relevant (e.g., vio.h), the API follows the VIRTIO specifications. These are available from OASIS at oasis-open.org.

DANGER

The QNX virtual device toolkit does not automatically produce safety-certified vdevs. It is your responsibility to develop your vdevs in an appropriate environment and to see them through safety certification.

If you require assistance, please contact your QNX technical support representative.

What's in this guide

To find out about: See:
Safe use of the functions in this API Function Safety
The Application Binary Interface (ABI) version of the vdev API abi.h
Support routines for virtual character devices cdev.h
Firmware-related definitions firmware.h
Functions related to the guest's address space gasp.h
Manipulating a guest's address space guest.h
Hypervisor host PCI interface for vdevs hpci.h
Definitions for outpipe outpipe.h
The vdev API base types types.h
Miscellaneous utility functions in the vdev API utils.h
General support for virtual devices vdev-core.h
Support for VIRTIO devices vio.h
Support for virtual PCI devices vpci.h
Support virtual watchdog devices wdog.h
Definitions for the virtual APIC bus x86_64/apic.h