Add Documentation about INTEGRITY RTOS

Merge-request: 1101
Reviewed-by: Harald Fernengel <harald.fernengel@nokia.com>

1 files changed, 109 insertions, 0 deletions

diff --git a/doc/src/platforms/platform-notes-rtos.qdoc b/doc/src/platforms/platform-notes-rtos.qdoc
index 776f510..be63063 100644
--- a/doc/src/platforms/platform-notes-rtos.qdoc
+++ b/doc/src/platforms/platform-notes-rtos.qdoc
@@ -245,3 +245,112 @@
     some regressions were spotted in QDateTime computation around year 0 and year 1970,
     which have been tracked back to faulty time zone data on some QNX versions.
 */
+
+/*!
+    \page platform-notes-integrity.html
+    \title Platform Notes - INTEGRITY
+    \contentspage Platform Notes
+    \target INTEGRITY
+
+    \note INTEGRITY is a community supported platform. See the
+    \l{Supported Platforms} page for more information.
+
+    This page contains information about the Qt for INTEGRITY port. More
+    information about the combinations of platforms and compilers supported
+    by Qt can be found on the \l{Supported Platforms} page.
+
+    Note that Qt for INTEGRITY is currently based on \l{Qt for Embedded Linux},
+    which contains its own windowing system.
+
+    Qt for INTEGRITY contains experimental screen and input drivers based on the
+    gh_FB Framebuffer API for graphics, a Connection-based mouse and keyboard
+    support. For information about these drivers, please refer to Green Hills
+    Software standard support.
+
+    \tableofcontents
+
+    \section1 Supported Versions
+
+    Qt has been tested on INTEGRITY 10 on various PowerPC, ARM and x86 targets.
+    On some platforms a native graphics FrameBuffer driver is available and has
+    then been used for testing. On all other platforms, the default FrameBuffer
+    VNC driver is used.
+
+    \section1 Limitations
+
+    Some of Qt's functionality is currently not available on INTEGRITY:
+
+    \table
+    \header \o Function \o Notes
+    \row \o QProcess
+         \o Not implemented. Volunteers welcome.
+    \row \o QSharedMemory
+         \o Not available - INTEGRITY doesn't support SYSV style shared memory.
+    \row \o QSystemSemaphore
+         \o Not available - INTEGRITY doesn't support SYSV style system semaphores.
+    \row \o QWS Multi Process
+         \o QT_NO_QWS_MULTIPROCESS is always on due to missing shared memory support.
+    \row \o Phonon
+         \o There is no standard audio backend.
+    \row \o Qt3Support
+         \o The Qt3Support library is not available on INTEGRITY.
+    \row \o QtScript
+         \o Not available - INTEGRITY's mmap() doesn't support allocating memory.
+    \endtable
+
+    \section1 Build Instructions
+
+    Qt for INTEGRITY can be built on either a Linux or Windows (with cygwin) host.
+    In both cases, a standard installation of INTEGRITY is required, with the
+    addition of the FrameBuffer API.
+
+    Example configure line for cross-compiling Qt for INTEGRITY for an
+    ARM INTEGRITY target:
+
+    \code
+    ./configure --hostprefix=$PWD -embedded integrity -xplatform unsupported/qws/integrity-arm-cxarm -static -qt-kbd-integrity -qt-mouse-integrity -no-mouse-linuxtp -no-mouse-pc -no-kbd-tty -qt-gfx-integrityfb -no-qt3support -no-gfx-linuxfb -no-glib -no-openssl -no-largefile -little-endian -arch integrity -prefix / -opensource -no-feature-QWS_MULTIPROCESS -no-feature-SHAREDMEMORY -no-feature-PROCESS -no-feature-SYSTEMSEMAPHORE -no-feature-PRINTER -no-feature-QWS_QPF2 -no-scripttools
+    \endcode
+
+    \list
+    \o \c{--hostprefix=$PWD} - specifies the current directory as the base source for Qt
+    \o \c{-arch integrity} - sets the architecture to INTEGRITY (for atomic operations)
+    \o \c{-embedded integrity} - builds the embedded version of Qt and sets the architecture to INTEGRITY
+    \o \c{-xplatform unsupported/qws/integrity-arm-cxarm} - selects the arm-cxarm mkspec for INTEGRITY
+    \o \c{-static} - specifies a static build of Qt
+    \o \c{-no-gfx-linuxfb},  \c{-no-mouse-linuxtp}, \c{-no-mouse-pc} and \c{-no-kbd-tty} are Linux specific and won't work on INTEGRITY
+    \o \c{-no-qt3support} - required since the Qt3 support classes are not supported on INTEGRITY
+    \o \c{-no-exceptions} - reduces the size of the library by disabling exception support
+    \o \c{-no-openssl} - disable support for OpenSSL
+    \o \c{-no-glib} - disable support for unavailable Glib
+    \o \c{-no-largefile} - disable support for large (> 2TB) files
+    \o \c{-no-scripttools} - disable support for QtScript tools
+    \o \c{-qt-gfx-integrity} - enables the experimental gh_FB based display driver
+    \o \c{-qt-mouse-integrity} - enables the experimental Connection-based mouse driver
+    \o \c{-qt-kbd-integrity} - enables the experimental Connection-based keyboard driver
+    \endlist
+
+    The above script will generate MULTI .gpj Project files, not Makefiles. The
+    main benefit of using these project files is automatic dependency checking,
+    but this also provides an organization known to INTEGRITY customers.
+    For Qt libraries, the top-level file is projects.gpj.
+
+    \section1 General Notes
+
+    \list
+    \o Before you run the above configure line, you may want to modify the values
+       of INTEGRITY_DIR and INTEGRITY_BSP in unsupported/qws/integrity-arm-cxarm/qmake.conf.
+       If you do not do this, you will have to modify the resulting generated projects.gpj
+
+    \o GIF support is currently not enabled.
+
+    \o Default .int files are generated. You may want to modify the amount of heap assigned
+       to each example by modifying the HeapSize declaration in the specific example .int file.
+
+    \o Some of the tools, examples and demos do not compile due to dependencies on QProcess
+       or other classes that are not available on INTEGRITY.
+
+    \endlist
+
+    \section1 Platform Regressions
+
+*/