A

Directories and Files

A.1 Introduction

Wind River products are installed in a single directory tree. The directory root is shown as c:\tornado in our documentation, but you may choose whatever root is most appropriate for your site. The overall layout of the tree segregates files meant for the development host (such as the compilers and debugging tools), files for the target system (such as VxWorks, BSPs, and configuration files), and files that perform other functions (Table A-1).

Table A-1: installDir

Directory/File

Description

.wind

Directory for customization files and files that capture the Tornado application state. Described in A.4 Initialization and State-Information Files.

docs

Directory of online documentation in HTML format.

host

Directory of host-resident tools and associated files. Described in more detail in A.2 Host Directories and Files.

Setup

Directory of the SETUP program, including the WIND subdirectory where PDF versions of documentation are located.

share

Directory of protocol definitions shared by both host and target software, including agents\wtx, tgtsvr, and wtx directories.

target

Directory of VxWorks target-resident software and associated files. Described in more detail in A.3 Target Directories and Files.

License.txt

Text of Wind River License agreement. This is a plain-text file that you can examine with any editor.

Readme.txt

Last-minute information about the current Tornado release. This is a plain-text file that you can examine with any editor.

setup.log

Log file for SETUP program. This is a plain-text file that you can examine with any editor.

A.2 Host Directories and Files

Table A-2 is a summary and description of the Tornado directories and files below the top-level host directory.

Table A-2: installDir\host

Directory/File

Description

include

Directory containing header files for the Tornado tools.

host-os
(x86-win32 for
Windows hosts)

Host-specific directory to permit Tornado installations for multiple hosts to be installed in a single tree, and share files in other directories.

host-os\bin

Directory containing Tornado tool executables (including GNU ToolKit binaries) on a particular host. This directory must be on your execution path to use Tornado conveniently.

host-os/include

Directory containing OS-specific header files.

host-os/jre118

Directory containing Java Runtime Environment-related files.

host-os\lib

Directory containing subroutine libraries for the Tornado tools. Subdirectories include backend (implementing the communications back ends available to the target server) and gcc-lib (containing the separate programs called by the GNU compiler driver.

host-os\host-type

Routines and scripts required by the host machine.

host-os\x-wrs-vxworks

Directory containing component programs and libraries for the GNU ToolKit configured for architecture x.

java

Directory containing various .jar files.

resource

Directory containing host-independent supporting files for the Tornado interactive tools.

resource\app-defaults

Directory containing default settings for the Tornado tools.

resource\bitmaps

Directory containing icons and button definitions for the Tornado tools.

resource\doctools

Directory containing tools for creating reference entries from source code.

resource\help

Directory containing online help.

resource\loader

Directory of object-module format information for the dynamic linker.

resource\synopsis

Directory containing entries that support WindSh command completion and look-up.

resource\target

Directory containing the target information database.

resource\tcl

Directory containing Tcl source code for the Tornado tools, including sub-directories with dialog descriptions and other definitions for each tool.

resource\test

Directory containing tests for the WTX protocol.

resource\vxdcom

Directory containing VxDCOM images and template.

resource\wdb

Mappings for WDB protocol extensions.

resource\userlock

Global authorization file for Tornado users.

src

Directory containing source for host utilities and examples, including demo (VxWorks sample programs) and windview (WindView and triggering sample programs).

tcl

Directory containing the standard Tcl and Tk distribution.

A.3 Target Directories and Files

Table A-3 is a summary and description of the Tornado directories and files below the top-level target directory.

Table A-3: installDir\target

Directories

Files

Description

config

Directory containing files used to configure and build particular VxWorks systems. It includes system-dependent modules and some user-alterable modules. These files are organized into several subdirectories: the subdirectory all, which contains modules common to all implementations of VxWorks (system-independent modules), and a subdirectory for each port of VxWorks to specific target hardware (system-dependent modules).

config\all

Subdirectory containing system configuration modules. Note that this method of configuration has been replaced by the project facility (see 4. Projects).

bootInit.c

System-independent boot ROM facilities.

configAll.h

Generic header file used to define configuration parameters common to all targets.

usrConfig.c,
bootConfig.c

Source of the configuration module for a VxWorks development system (usrConfig.c), and a configuration module for the VxWorks boot ROM (bootConfig.c).

config\bspname

Directory containing system-dependent modules for each port of VxWorks to a particular target CPU. Each of these directories includes the files listed below. In addition, drivers specific to each BSP are located here. See 4.4.4 Selecting the VxWorks Image Type.

00bsp.cdf

Project facility configuration file that overrides the generic BSP components in comps/vxWorks/00bsp.cdf with BSP-specific versions of components and parameters.

00html.cdf

Project facility configuration file for HTML.

bootrom,
bootrom.hex

VxWorks boot ROM code, as object module (bootrom) and as an ASCII file (bootrom.hex) in Motorola S-record format or Intel hex format (i960 targets), suitable for downloading over a serial connection to a PROM programmer. For more information see 4.8 Configuring and Building a VxWorks Boot Program.

config.h

Header file of hardware configuration parameters.

bspname.h

Header file for the target board.

Makefile

Makefile for creating boot ROMs and the VxWorks system image for a particular target.

romInit.s

Assembly language source for initialization code that is the entry point for the VxWorks boot ROMs and ROM-based versions of VxWorks.

sysLib.c,
sysALib.s

Two source modules of system-dependent routines.

sysSerial.c

Driver for on-board serial ports.

vxWorks,
vxWorks.sym

Complete, linked VxWorks system binary (vxWorks), and its symbol table (vxWorks.sym) created with the supplied configuration files.

config\comps

Directory containing source and configuration files.

config\simulator

Directory containing configuration files and executables for the host simulator.

Directory containing all the header (include) files supplied by VxWorks. Your application modules must include several of them in order to access VxWorks facilities. The h directory also contains the following subdirectories:

h\arch

Directory containing architecture-dependent header files.

h\arpa

Directory containing a header file for use with inetLib.

h\dhcp

Directory containing header files for use with dhcp.

h\drv

Directory containing hardware-specific header files (primarily for drivers). Not all of the subdirectories shown are present for all BSPs.

h\make

Directory containing files that describe the rules for the makefiles for each CPU and toolset.

h\net

Directory containing all the internal header (include) files used by the VxWorks network. Network drivers must include several of these header files, but no application modules should need them.

h\netinet

Directory containing Internet-specific header files.

h\private

Directory containing header files for code private to VxWorks.

h\resolv

Directory containing header files for use with name service.

h\rip

Directory containing header files for use with rip.

h\rpc

Directory containing header files that must be included by applications using the Remote Procedure Call library (RPC).

h\sys

Directory containing header files specified by POSIX.

h\tffs

Directory containing header files for use with TrueFFS.

h\tool

Directory containing header files for Diab and GNU.

h\types

Directory containing header files used for defining types.

h\wdb

Directory containing header files for use with WDB.

lib

Directory containing the machine-independent object libraries and modules provided by VxWorks.

lib\objcputooltest

Directory containing vxColor.o, a test program, for the specified target.

lib\archfamily

Directory containing VxWorks object modules as individual files (suitable for loading dynamically to the target).

lib/libcputoolvx.a

An archive (ar) format library containing the object modules that make up VxWorks.

proj

Directory containing the default VxWorks images and the default location for projects to be created.

src

Directory containing all source files for VxWorks.

src\arch

Directory containing makefiles to build source.

src\config

Directory containing files used to force inclusion of specific VxWorks modules.

ansi_5_0.c

Used to include all 5.0 ANSI C library routines.

assertInit.c

Used to include the assert ANSI C library routine.

cplusdiabComplex.c,
cplusdiabComplexIo.c,
cplusdiabIos.c,
cplusdiabIosLang.c,
cplusdiabStl.c,
cplusdiabString.c,
cplusdiabStringIo.c,
cplusgnuComplex.c,
cplusgnuComplexIo.c,
cplusgnuIos.c,
cplusgnuIosLang.c,
cplusgnuStl.c,
cplusgnuString.c,
cplusgnuStringIo.c

Used to include the various groups of C++ routines.

ctypeInit.c

Used to include the ctype ANSI C library routines.

localeInit.c

Used to include the locale ANSI C library routines.

mathInit.c

Used to include the math ANSI C library routines.

stdioInit.c

Used to include the stdio ANSI C library routines.

stdlibInit.c

Used to include the stdlib ANSI C library routines.

stringInit.c

Used to include the string ANSI C library routines.

timeInit.c

Used to include the time ANSI C library routines.

usrAta.c

Used to include the ATA initialization routines.

usrBreakpoint.c

Used to include the breakpoint management routines.

usrCplusTools.c,
usrCplusVxw.c

Placeholder files.

usrDepend.c

Used to check module dependences for constants defined in configAll.h and config.h.

usrDsp.c

Used to activate dsp support.

usrExtra.c

Used to include extra modules that are needed by VxWorks but not referenced in the VxWorks code.

usrFd.c

Used to mount a dosFs file system on a boot diskette (i386/i486 targets only).

usrIde.c

Used to mount a dosFs file system on a boot IDE hard disk drive (i386/i486 targets only).

usrKernel.c

Used to configure and initialize the wind kernel.

usrLoadSym.c

Used to load the VxWorks symbol table.

usrMmuInit.c

Used to initialize the memory management unit.

usrNetwork.c

Used to configure and initialize networking support.

usrPcmcia.c

Used to configure and initialize PCMCIA support.

usrScript.c

Used to execute a startup script when VxWorks first boots.

usrScsi.c

Used to configure and initialize SCSI support.

usrSmObj.c

Used to configure and initialize shared memory object support.

usrTffs.c

Used to configure and initialize TrueFFS support.

usrWdb.c

Used to configure and initialize the Tornado target agent.

usrWindview.c

Used to configure and initialize WindView.

src\demo

Directory containing sample application modules for demonstration purposes, including both the source and the compiled object modules ready to be loaded into VxWorks.

src\demo\1

Directory containing a simple introductory demo program as well as a server/client socket demonstration.

src\demo\color

Directory containing the VxColor example application.

src\demo\cplusplus

Directory containing the factory example application.

src\demo\dg

Directory containing a simple datagram facility, useful for demonstrating and testing datagrams on VxWorks and/or other TCP/IP systems.

src\demo\start

Directory containing the program used with the Tornado Getting Started Guide tutorial.

src\demo\wind

Directory containing the windDemo example application.

src\drv

Directory containing source code for supported board device drivers.

src\usr

Directory containing user-modifiable code. Not every file in the directory is listed here.

devSplit.c

Provides a routine to split the device name from a full path name.

Makefile

Contains the makefile rules for building the vx library.

memDrv.c

Pseudo-device driver that allows memory to be accessed as a VxWorks character (non-block) device.

ramDiskCbio.c

RAM-disk driver with a CBIO interface which can be utilized directly by dosFsLib without using dcacheCbio.

ramDrv.c

Block device driver that allows memory to be used as a device with VxWorks local file systems.

usrLib.c

Library of routines designed for interactive invocation, which can be modified or extended if desired.

src\wdb

Directory containing target agent communication support.

wdbUdpLib.c

Implements communication methods for the target agent using a lightweight UDP/IP stack.

wdbUdpSockLib.c

Initializes UDP socket routines for the target agent.

The following directories are included only with a VxWorks source license:

src\arch

Directory containing VxWorks source code for architecture-specific modules.

src\cplus

Directory containing source code for the Wind Foundation Classes.

src\libc

Directory containing the source files for the ANSI C library.

src\math

Directory containing the source files for various math routines (non-ANSI).

src\netwrs

Directory containing the source files for the VxWorks network subsystem modules.

src\netinet

Directory containing the source files for Internet network protocols.

src\os

Directory containing the source code for VxWorks kernel extensions (for example: I\O, file systems).

src\ostool

Directory containing the source code for VxWorks tools.

src\rpc

Directory containing the source code for RPC that has been modified to run under VxWorks.

src\util

Directory containing source code for the VxWorks utilities.

src\wind

Directory containing source code for the VxWorks kernel.

unsupported

Directory containing miscellaneous unsupported code such as public-domain software, examples, host tools, obsolete BSPs, and the BOOTP server.

A.4 Initialization and State-Information Files

You can define initialization files to customize each of the Tornado tools. These files are not distributed as a part of Tornado; it is up to you to define them if you wish. If they are present, the initialization files are collected in a directory called .wind. Tornado looks for this directory in two places: first under c:\tornado (that is, your base installation directory), and then under the directory specified by the HOME environment variable (if defined). In each of these directories, if an initialization file is found, its contents are sourced as Tcl code.

Some Tornado tools also use the c:\tornado\.wind directory to store state information (and some optional products store both initialization and state information there).

Table A-4 and Table A-5 are a description of the kinds of files that can be stored in the c:\tornado\.wind directory.

Table A-4: .wind Initialization Files

Directory/File

Description

browser.tcl

Optional Tcl initialization code for the browser. See CTcl.

crosswind.tcl

Optional Tcl initialization code for the debugger front end. See 10.8 Tcl: Debugger Customization.

gdb.tcl

Optional Tcl initialization code for the debugging engine itself. See 10.8 Tcl: Debugger Customization.

Tornado.tcl

Optional Tcl initialization code for the Tools menu and toolbar, and for overall Tornado initialization.

windsh.tcl

Optional Tcl initialization code for the shell. See 7.7.3 Tcl: Tornado Shell lnitialization.

wtxtcl.tcl

Optional Tcl initialization code for wtxtcl, the Tcl interpreter with WTX-protocol extensions. See the Tornado API Programmer's Guide: Extending Tornado Tools.

Table A-5: .wind State-Information Files

Directory/File

Description

profile

A file of identification information used for your Tornado support requests. This information is collected and updated through the Support command in the Tools menu; see 1.6 Customer Services.

.wind/tsr

A directory recording the history of your Tornado support requests. This information is managed through the Support command in the Tools menu; see 1.6 Customer Services.