Tornado User's Guide 2.2

1 Overview

1.1 Introduction

1.2 Cross-Development with Tornado

1.3 VxWorks Target Environment

1.4 Tornado Host Tools

WindView Software Logic Analyzer

VxSim Target Simulator

1.5 Host-Target Interface

Target Agent

Tornado Target Server

Tornado Registry

Virtual I/O

1.6 Customer Services

2 Setup and Startup

2.1 Introducing Tornado

2.2 Setting up the Tornado Registry

2.3 The Tornado Host Environment

2.3.1 Environment Variables for Tornado Components

2.3.2 Environment Variable For Solaris Hosts

2.3.3 Environment Variables for Convenience

2.3.4 X Resource Settings

2.4 Setting Up the Default Target Hardware

2.4.1 Default Target Configuration

2.4.2 Networking the Host and Target

Initializing the Host Network Software

Establishing the VxWorks System Name and Address

Giving VxWorks Access to the Host

2.4.3 Configuring the Target Hardware

Setting Up a Boot Mechanism

Setting Board Jumpers

Board Installation and Power

Connecting the Cables

2.5 Host-Target Communication Configuration

2.5.1 Network Connections

Configuring the Target Agent for Network Connection

2.5.2 END Connections

Configuring the Target Agent for END Connection

2.5.3 Serial-Line Connections

Configuring the Target Agent for Serial Connection

Configuring the Boot Program for Serial Connection

Testing the Connection

Starting the Target Server

2.5.4 The NetROM ROM-Emulator Connection

Configuring the Target Agent for NetROM

Configuring the NetROM

Starting the Target Server

Troubleshooting the NetROM ROM-Emulator Connection

2.5.5 The Transparent Mode Driver (TMD)

Configuring the Target Agent for TMD

Configuring visionICE II/visionPROBE II

Starting the Target Server

2.6 Booting VxWorks

2.6.1 Default Boot Process

2.6.2 Entering New Boot Parameters

2.6.3 Boot Program Commands

2.6.4 Description of Boot Parameters

2.6.5 Booting With New Parameters

2.6.6 Alternate Booting Procedures

2.6.7 Booting a Target Without a Network

2.6.8 Rebooting VxWorks

2.7 Connecting a Tornado Target Server

2.8 Launching Tornado

2.9 Tornado Interface Conventions

2.10 Troubleshooting

2.10.1 Things to Check

Hardware Configuration

Booting Problems

Target-Server Problems

2.10.2 Technical Support

3 Launcher

4 Projects

4.1 Introduction

4.2 Planning Your Projects

4.2.1 Getting a Functional BSP

Using a Wind River or Third-Party BSP

Using a Custom BSP For Custom Hardware

Using the Simulator BSP

4.2.2 Creating a Bootable Project Based On a BSP

Using the VxWorks Simulator

Using a Real Target

Image Size Considerations

4.2.3 Developing and Adding Your Application Source Code

Adding Existing Application Source Code

Creating New Application Source Code

Building With Custom Build Rules

Developing Architecture-Independent Applications

Using Configuration Management

Configuring VxWorks

Structuring Your Projects

4.3 Creating a Downloadable Application

4.3.1 Creating a Project for a Downloadable Application

4.3.2 Project Files for a Downloadable Application

4.3.3 Working With Application Files

Creating, Adding, and Removing Application Files

Displaying and Modifying File Properties

Opening, Saving, and Closing Files

4.3.4 Building a Downloadable Application

Calculating Makefile Dependencies

Build Specifications

Building an Application

4.3.5 Downloading an Application

4.3.6 Adding and Removing Projects

4.4 Creating a Custom VxWorks Image

4.4.1 Creating a Project for VxWorks

4.4.2 Project Files for VxWorks

4.4.3 Configuring VxWorks Components

Finding VxWorks Components and Configuration Macros

Displaying Descriptions and Online Help for Components

Including and Excluding Components

Component Conflicts

Changing Component Parameters

Estimating Total Component Size

4.4.4 Selecting the VxWorks Image Type

4.4.5 Building VxWorks

Using the Build Menu

Using the Command Line

4.4.6 Booting VxWorks

4.5 Creating a Bootable Application

4.5.1 Using Automated Scaling of VxWorks

4.5.2 Adding Application Initialization Routines

4.6 Working With Build Specifications

4.6.1 Changing a Build Specification

Custom Makefile Rules

4.6.2 Creating New Build Specifications

4.6.3 Selecting a Specification for the Current Build

4.7 Configuring the Target-Host Communication Interface

Configuration for an END Driver Connection

Configuration for Integrated Target Simulators

Configuration for NetROM Connection

Configuration for Network Connection

Configuration for Serial Connection

Configuration for tyCoDrv Connection

Scaling the Target Agent

Configuring the Target Agent for Exception Hooks

Starting the Agent Before the Kernel

4.8 Configuring and Building a VxWorks Boot Program

4.9 Building a Custom Boot ROM

5 Command Line Configuration and Build

5.1 Introduction

5.2 Building, Loading, and Unloading Application Modules

5.3 Configuring VxWorks

5.3.1 The Board Support Package (BSP)

The System Library

Virtual Memory Mapping

Configuration Files

BSP Initialization Modules

BSP Documentation

5.3.2 The Environment Variables

5.3.3 The Configuration Header Files

The Global Configuration Header File: configAll.h

The BSP-specific Configuration Header File: config.h

Selection of Optional Features

5.3.4 The Configuration Module: usrConfig.c

5.3.5 Alternative VxWorks Configurations

Scaling Down VxWorks

Executing VxWorks from ROM

5.4 Building a VxWorks System Image

5.4.1 Available VxWorks Images

5.4.2 Rebuilding VxWorks with make

5.4.3 Including Customized VxWorks Code

5.4.4 Linking the System Modules

5.4.5 Creating the System Symbol Table Module

5.5 Makefiles for BSPs and Applications

5.5.1 Make Variables

Variables for Compilation Options

Variables for BSP Parameters

Variables for Customizing the Run-Time

5.5.2 Using Makefile Include Files for Application Modules

5.6 Creating Bootable Applications

5.6.1 Linking Bootable Applications

5.6.2 Creating a Standalone VxWorks System with a Built-in Symbol Table

5.6.3 Creating a VxWorks System in ROM

5.7 Building Projects From a BSP

6 VxSim

7 Shell

7.1 Introduction

7.2 Using the Shell

7.2.1 Starting and Stopping the Tornado Shell

7.2.2 Downloading From the Shell

7.2.3 Shell Features

7.2.4 Invoking Built-In Shell Routines

Task Management

Task Information

System Information

System Modification and Debugging

C++ Development

Object Display

Network Status Display

Resolving Name Conflicts between Host and Target

7.2.5 Running Target Routines from the Shell

7.2.6 Rebooting from the Shell

7.2.7 Using the Shell for System Mode Debugging

7.2.8 Interrupting a Shell Command

7.3 The Shell C-Expression Interpreter

7.4 C++ Interpretation

7.4.1 Overloaded Function Names

7.4.2 Automatic Name Demangling

7.5 Shell Line Editing

7.6 Object Module Load Path

7.7 Tcl: Shell Interpretation

7.7.1 Tcl: Controlling the Target

Tcl: Calling Target Routines

Tcl: Passing Values to Target Routines

7.7.2 Tcl: Calling Under C Control

7.7.3 Tcl: Tornado Shell lnitialization

7.8 The Shell Architecture

7.8.1 Controlling the Target from the Host

7.8.2 Shell Components

7.8.3 Layers of Interpretation

8 Browser

9 Debugger

9.1 Introduction

9.2 Starting CrossWind

9.3 A Sketch of CrossWind

9.4 CrossWind in Detail

9.4.1 Graphical Controls

Display Manipulation

CrossWind Menus

CrossWind Buttons

9.4.2 Debugger Command Panel: GDB

GDB Initialization Files

What Modules to Debug

What Code to Display

Executing Your Program

Application I/O

Graphically Enhanced Commands

Managing Targets

Command-Interaction Facilities

Extended Debugger Commands

Extended Debugger Variables

9.5 System-Mode Debugging

9.5.1 Entering System Mode

9.5.2 Thread Facilities in System Mode

Displaying Summary Thread Information

Switching Threads Explicitly

Thread-Specific Breakpoints

Switching Threads Implicitly

9.5.3 Configuring VxWorks for System Mode Debugging

9.5.4 Tcl: Debugger Automation

9.5.5 Tcl: A Simple Debugger Example

9.5.6 Tcl: Specialized GDB Commands

9.5.7 Tcl: Invoking GDB Facilities

9.5.8 Tcl: A Linked-List Traversal Macro

9.6 Tcl: CrossWind Customization

9.6.1 Tcl: Debugger Initialization Files

9.6.2 Tcl: Passing Control between the Two CrossWind Interpreters

9.6.3 Tcl: Experimenting with CrossWind Extensions

Tcl: "This" Buttons for C++

Tcl: A List Command for the File Menu

Tcl: An Add-Symbols Command for the File Menu

10 Building VxDCOM Applications

10.1 Introduction

10.2 The VxDCOM Development Process

10.3 Configuring a VxDCOM Bootable Image

10.3.1 Adding VxDCOM Component Support

10.3.2 Configuring the DCOM Parameters

10.4 Using the VxDCOM Wizard

10.4.1 Choosing the Project Type

10.4.2 Creating a COM/DCOM Skeleton Project

Defining the CoClass

Choosing CoClass Options

Generating the Skeleton Files

10.4.3 Importing Existing Files into a New Project

Porting Existing Applications

Editing IDL Files

Adding Non-Automation Types

10.5 The Generated Output

10.6 Implementing the Server and Client

10.7 Building and Linking the Application

10.8 Registering, Deploying, and Running Your Application

10.8.1 Registering Proxy DLLs on Windows

10.8.2 Register the Type Library

10.8.3 Registering the Server

10.8.4 Authenticating the Server

10.8.5 Activating the Server

11 Customization

11.1 Introduction

11.2 Setting Download Options

11.3 Setting Project Options

11.4 Setting Version Control Options

11.5 Installation and Licenses

11.6 Customizing the Tools Menu

11.6.1 The Customize Tools Dialog Box

Macros for Customized Menu Commands

11.6.2 Examples of Tools Menu Customization

11.7 Alternate Default Editor

11.8 Tcl Customization Files

Tornado Initialization

HTML Help Initialization

Appendices

A Directories and Files

A.1 Introduction

A.2 Host Directories and Files

A.3 Target Directories and Files

A.4 Initialization and State-Information Files

B Makefile Details

B.1 Introduction

B.2 Customizing the VxWorks Makefile

B.3 Commonly Used Makefile Macros

C Tcl

C.1 Why Tcl?

C.2 Introduction to Tcl

C.2.1 Tcl Variables

C.2.2 Lists in Tcl

C.2.3 Associative Arrays

C.2.4 Command Substitution

C.2.5 Arithmetic

C.2.6 I/O, Files, and Formatting

C.2.7 Procedures

C.2.8 Control Structures

C.2.9 Tcl Error Handling

C.2.10 Integrating Tcl and C Applications

D Coding Conventions

D.1 Introduction

D.2 File Heading

D.3 C Coding Conventions

D.3.1 C Module Layout

D.3.2 C Subroutine Layout

D.3.3 C Declaration Formats

D.3.4 C Code Layout

D.3.5 C Naming Conventions

D.3.6 C Style

D.3.7 C Header File Layout

D.3.8 Documentation Format Conventions for C

D.4 Tcl Coding Conventions

D.4.1 Tcl Module Layout

D.4.2 Tcl Procedure Layout

D.4.3 Tcl Code Outside Procedures

D.4.4 Declaration Formats

D.4.5 Code Layout

D.4.6 Naming Conventions

D.4.7 Tcl Style

E X Resources

E.1 Predefined X Resource Collections

E.2 Resource Definition Files

F VxWorks Initialization Timeline

F.1 Introduction

F.2 The VxWorks Entry Point: sysInit( )

F.3 The Initial Routine: usrInit( )

F.4 Initializing the Kernel

F.5 Initializing the Memory Pool

F.6 The Initial Task: usrRoot( )

F.7 The System Clock Routine: usrClock( )

F.8 Initialization Summary

F.9 Initialization Sequence for ROM-Based VxWorks

Tornado

User's Guide

2.2

Contents

1 Overview

2 Setup and Startup

3 Launcher

4 Projects

5 Command Line Configuration and Build

6 VxSim

7 Shell

8 Browser

9 Debugger

10 Building VxDCOM Applications

11 Customization

Appendices

A Directories and Files

B Makefile Details

C Tcl

D Coding Conventions

E X Resources

F VxWorks Initialization Timeline

Index