The Tornado Release Notes contain the latest list of supported hosts and targets, as well as information on compatibility with older releases, an outline of new features, and any caveats concerning the current release.

The Tornado Migration Guide contains information designed to help VxWorks developers in moving from Tornado 2.2.x and VxWorks 5.4.x to Tornado 2.2 and VxWorks 5.5.

The GNU Toolchain Release Notes contain information about changes made to the GNU toolchain since the Tornado 2.0 release.

The Diab C/C++ Release Notes contain information about changes made to the Diab compiler suite since the Diab 4.4 release.

A Tornado 2.2/VxWorks 5.5 product information Web page is available at: http://www.windriver.com/corporate/support/prodbullet/T2.2/

The Tornado Getting Started Guide (this manual) provides instructions on installing Tornado and other Tornado products, as well as tutorial introductions to both the Tornado tools and VxWorks.

The Tornado User's Guide is the central document for the Tornado IDE. It includes:

• A global overview of Tornado and its capabilities.

• Instructions on how to configure your environment and set up communications with a target system.

• The Tornado development environment and its major interactive features--simulator, editor, project facility, target server management, shell, browser, and debugger.

• Command-line tools for project creation and debugging.

• COM and DCOM.

• Customizing Tornado.

• Tornado directories and files, the use of Tcl (Tool Command Language) in Tornado, and reference information for host tools.

• Wind River coding conventions.

The Tornado API Programmer's Guide is for developers who wish to extend the Tornado development environment. It contains descriptive information about:

• The run-time agent.

• Its host-system counterpart, the target server.

• The WDB protocol that supports the target agent and target server.

• The WTX C and Tcl protocols used by the Tornado tools to communicate with the target server.

• Client Component Architecture (CCA), which is the new architecture of the Tornado IDE.

The Tornado API Reference is the reference companion to the Tornado API Programmer's Guide.

The Tornado Reference describes the host tools and utilities.

The Tornado SETUP Developer's Guide provides instructions for creating an installation image that can install products on top of Tornado.

The WindView User's Guide describes the features and use of the WindView software logic analyzer, which is integrated with the Tornado IDE. The companion WindView User's Reference, describes WindView and networking events.

The VxWorks Programmer's Guide describes the VxWorks operating system and associated run-time facilities. This guide is the best starting point for learning about VxWorks from a problem-solving perspective because it is organized by the function of VxWorks components. It includes the following topics:

• The fundamentals of the VxWorks kernel and run-time environment.

• The I/O system and the device drivers that underlie it.

• Local file systems, including the DOS-compatible file system and the CD-ROM file system.

• POSIX standard interfaces, which are real-time extensions to the VxWorks kernel facilities.

• Target tools, which include the target-resident shell, loader, and symbol tables; as well as VxWorks show routines.

• C++ development, with guidelines for creating VxWorks applications in C++ and configuring VxWorks to support them.

• TrueFFs, a flash memory interface, which provides a block device interface to a wide variety of flash-memory devices.

• Configuring and writing COM and DCOM applications for VxWorks.

• VxMP, which provides shared-memory objects dedicated to high-speed synchronization and communication between tasks running on separate CPUs.

• VxFusion, a lightweight, media-independent mechanism, based on VxWorks message queues, for developing distributed applications.

• VxVMI, a virtual memory interface, which provides write protection and an architecture-dependent interface to the CPU's MMU.

The VxWorks architecture supplements provide additional information specific to target architectures.¹

The Network Programmer's Guide describes the networking facilities available with VxWorks. It includes the following topics:

• Configuring the network stack.

• Network configuration protocols.

• Dynamic routing protocols.

• Networking APIs.

• Booting over the network.

• Creating a new data link layer driver or network service.

The VxWorks OS Libraries API Reference and the VxWorks Drivers API Reference include reference descriptions of all VxWorks libraries that apply to all targets. Each entry lists the routines found in a given library, including a one-line synopsis of each, along with a general description of their use.

The VxWorks BSP Reference consists of reference descriptions for BSP-specific libraries and routines for all installed BSPs. This section also contains entries for the serial, Ethernet, and SCSI drivers available with VxWorks Board Support Packages (BSPs).

The VxWorks Errno Code List provides a description of VxWorks errno codes, by number, by routine name, and alphabetically.

The VxWorks BSP Developer's Guide provides instructions on creating, documenting, and testing new BSPs, components, and projects.

	NOTE: The FSF develops software under UNIX, and examples in their manuals reflect this. Nevertheless, the GNU tools operate reliably under Windows.

Tornado includes a collection of all Tornado and VxWorks manuals in HTML format. You can open the online manuals from the Help>Manuals Contents menu in the Tornado IDE or at installDir\docs\books.html. An index and full-text search are available.

Help buttons in every Tornado dialog box and the Help menu on the menu bar provide information on the Tornado component you are currently executing. In addition, from the shell, you can hot-key to the reference entry for the VxWorks routine you have entered.

PDF versions of most books in the standard Tornado documentation set, as well as the Diab compiler guides, are provided in installDir\SETUP\DOCS. They are also available in the DOCS directory at the base of the Tornado core product CD.

In the Tornado guides, cross-references to a reference entry for a specified tool or module refer to an entry in the online VxWorks API Reference (for target libraries or subroutines) or to the Tornado API Reference(for host tools).

Cross-references between books take the form Book Title: Chapter Name, and are not linked in the HTML version.

In general, all manuals refer to Tornado directories and files with pathnames starting at the installation directory installDir. Use the pathname chosen on your system for Tornado installation. Your working directory is referred to as projDir.

The screen displays in this book are for illustrative purposes. They may not correspond exactly to the Tornado environment you see on your computer, because both Tornado and the Windows environment in which it runs can be customized. Tornado is also designed to permit easy integration with added tools.

Tornado allows you to execute most functions either from within the IDE or from the command line. The command syntax is usually the same for Windows and UNIX command lines. For this reason these documents use the following default format for command lines:

% prjCreate

When a particular command syntax applies to UNIX only, this is stated. When a command syntax applies to Windows only, or when the Windows version differs from the UNIX version, the Windows format is:

c:\> winFooRun param

Tornado manuals use the font conventions in the following table for special elements. C subroutine names always include parentheses, as in printf( ). Combinations of keys that must be pressed simultaneously are shown with a + linking the keys. For example, CTRL+F3 means to simultaneously press the key labeled CTRL and the key labeled F3.

Table 0-1:   Typographical Conventions