QNX Software Development Platform Documentation Roadmap

For the most up-to-date version of the release notes for our products, go to our website, www.qnx.com.

On Windows and Linux hosts, the QNX SDP consists of the QNX Momentics Tool Suite, which you can use to develop applications that run on a target machine that's running the QNX Neutrino RTOS.

The self-hosted version of the QNX SDP consists of the QNX Neutrino RTOS and the QNX Momentics Tool Suite.

• Welcome to the QNX Software Development Platform
• Quickstart Guide: 10 Steps to Your First QNX Program
• Installation Guide
• Release Notes (this link goes to the most recent version in the Download area of our website)

• IDE User's Guide
• Phindows Connectivity

• System Architecture
• Neutrino User's Guide
• Getting Started with QNX Neutrino: A Guide for Realtime Programmers
• Neutrino Programmer's Guide
• Building Embedded Systems
• Utilities Reference
• Neutrino Library Reference
• Audio Developer's Guide
• Addon Interfaces Library Reference
• OS Technotes

• Photon Programmer's Guide
• Photon Library Reference
• Widget Reference
• Building Custom Widgets

• Adaptive Partitioning User's Guide
• Advanced Graphics Developer's Guide
• Board Support Packages (BSPs)
• Core Networking Stack User's Guide
• Driver Development Kit Guides
• High Availability Framework Developer's Guide
• Instant Device Activation User's Guide
• Multicore Processing User's Guide
• Photon Multilingual Input
• System Analysis Toolkit User's Guide

• Dinkum C++ Library
• Dinkum C99 Library
• Dinkum EC++ Library

Bookset overview

Welcome to the QNX Software Development Platform

Gives you a quick introduction to the QNX Software Development Platform and the QNX Momentics Tool Suite, and helps you find your way around the documentation.

Quickstart Guide: 10 Steps to Your First QNX Program

Helps you install and configure the QNX Software Development Platform and the QNX Neutrino operating system, and then leads you through a short tutorial that will have you soon developing applications and running them on QNX Neutrino.

IDE User's Guide

Describes the QNX Momentics Integrated Development Environment, how to set up and start using the tools to build QNX Neutrino-based target systems, etc.

System Architecture

Describes the philosophy and architecture of the QNX Neutrino microkernel, resource managers, processes, threads, message-passing services, and more.

Neutrino User's Guide

Describes how to use the QNX Neutrino runtime environment and perform various system-administration tasks.

Getting Started with QNX Neutrino: A Guide for Realtime Programmers

This book, by Rob Krten and updated by QNX staff, will help you design and develop robust realtime systems -- from tiny embedded control applications to large network-distributed systems -- using the QNX Neutrino RTOS.

Neutrino Programmer's Guide

Tells you how to get started writing programs, including interrupt handlers, resource managers, etc.

Building Embedded Systems

Tells you how to get the OS running on your target embedded system, write an IPL, customize a startup program, etc.

Utilities Reference

Describes the QNX Neutrino utilities and manager processes. You'll also find the complete manual for the qed editor.

Neutrino Library Reference

Describes the C library functions, including POSIX threads, kernel calls, resource manager functions, etc.

Audio Developer's Guide

Describes the audio drivers and API for developers who wish to write audio applications.

Addon Interfaces Library Reference

Describes the Addon Interfaces Library, and how to use it to add extendibility to applications using standard interfaces.

OS Technotes

Deals with a series of topics that aren't covered in the basic docset.

Photon Programmer's Guide

Gives you a hands-on tour of PhAB, the powerful application builder for Photon. You'll learn how to quickly assemble a GUI from predefined widgets, link the GUI to an application, and generate C source to bring the GUI to life.

Photon Library Reference

Provides concise descriptions of Photon's and PhAB's global data structures and functions.

Widget Reference

Contains guidelines for programming widgets, along with concise descriptions of all global data structures, resources, and convenience functions associated with widgets. It also gives you practical examples of how to use Photon widgets and widget functions.

Building Custom Widgets

Explains how to create a custom widget and how to bind it into PhAB. If you need a widget whose features extend the standard capabilities of the Photon widget library, this guide is for you.

Board Support Packages (BSPs)

You'll find two types of documentation for a BSP, depending on whether it's a newer or older BSP:

• as a single "readme" file
• as a conventional user's guide

To locate the docs for your installed BSPs, see the Start or Launch menu, or point your browser at:

$QNX_TARGET/usr/help/product/bsp_name_of_board

DDK Guides

DDK guides describe how to write drivers for the QNX OS. You'll find a separate DDK doc for audio, graphics, input, and Universal Serial Bus (USB) devices.

Note that the QNX Software Development Platform doesn't include the DDKs themselves, but it includes the documentation for them.

Adaptive Partitioning User's Guide

The Adaptive Partitioning User's Guide describes how to use adaptive partitioning to ensure that competing applications are given an engineered set of system resources (e.g. CPU time).

Advanced Graphics Developer's Guide

The Advanced Graphics Developer's Guide describes how to create graphical applications that use the QNX Graphics Framework API and the OpenGL ES APIs.

Core Networking User's Guide

The Core Networking User's Guide describes how to use io-pkt for networking on QNX Neutrino.

Multicore Processing User's Guide

The Multicore Processing User's Guide will help you get the most performance possible out of a multicore system.

System Analysis Toolkit User's Guide

The System Analysis Toolkit (SAT) guide describes how to use the SAT, which includes an instrumented microkernel, so you can see further into running systems than ever before. Now you can log every communication and state change within the microkernel, including interrupts, all parameters/return values from kernel calls, and scheduling decisions, resulting in a deeper and more detailed analysis of system elements. You can even perform kernel-level diagnostics remotely.

Photon Multilingual Input

Tells you how to input Chinese, Japanese, and Korean characters in Photon.

Phindows Connectivity

Tells you how to access the Photon microGUI from a Windows machine.

High Availability Framework Developer's Guide

The High Availability Framework guide describes how to build robust high-availability software running on the QNX Neutrino RTOS. This framework gives you the tools to isolate and even repair software faults before they occur throughout your entire system. It includes a highly resilient manager process that can perform multistage recovery, a client recovery library, and more.

Getting started with the docs

The following table may help you find your way around the docs for information on some common tasks:

Technical support options

To obtain technical support for any QNX product, visit the Support + Services area on our website (www.qnx.com). You'll find a wide range of support options, including community forums.

Please email your comments on the documentation to docs@qnx.com.

If a manual refers to third-party software, all appropriate copyright notices are published in an appendix called Third-Party Copyright Notices.