Subversion Repositories openrisc_2011-10-31

 The eCos Configuration Tool is used

          to tailor eCos at source level, prior to compilation or

          assembly, and provides a configuration file and a set of

          files used to build user applications. The sources and other

          files used for building a configuration are provided in a

          component repository, which is loaded

          when the eCos Configuration Tool

          is invoked. The component repository includes a set of files

          defining the structure of relationships between the

          Configuration Tool and other components, and is written in a

          Component Definition Language (CDL).

          For a description of the concepts underlying component

          configuration, see .

Add the eCos Configuration Tool install directory to your PATH, for example:

export PATH=/opt/ecos/ecos&Version;/bin:$PATH

You may run configtool with zero, one or two arguments. You can specify the eCos repository

 location, and/or an eCos save file (extension .ecc) on the command line. The ordering of these

two arguments is not significant. For example:

configtool /opt/ecos/ecos&Version;/packages myfile.ecc

The Configuration Tool will be displayed (see ).

There are two ways in which to invoke the eCos Configuration Tool:

              from the desktop explorer or program set up at installation

              time (by default

              Start

              ->

              Programs

              ->

              eCos

              ->

              Configuration Tool

              ).

type (at a command prompt or in the

            Start

            menu’s

            Run

            item): <foldername>\ConfigTool.exe where <foldername> is

            the full path of the directory in which you installed the eCos

            Configuration Tool.

The

            Configuration Tool

            will be displayed (see ).

You may run configtool with zero, one or two arguments. You can specify the eCos repository

location, and/or an eCos save file (extension .ecc) on the command line. The ordering of these

two arguments is not significant. For example:

configtool "c:\Program Files\eCos\packages" myfile.ecc

If you invoke the configuration tool from the command line with

--help, you will see this output:

Usage: eCos Configuration Tool [-h] [-e] [-v] [-c] [input file 1] [input file 2]

  -h  --help            displays help on the command line parameters

  -e  --edit-only       edit save file only

  -v  --version         print version

  -c  --compile-help    compile online help only

This summarizes valid parameters and switches. Switches are shown with

both short form and long form.

--help shows valid options and parameters, as above.

--edit-only runs the Configuration Tool in a mode that

suppresses creation of a build tree, in case you only want to create and edit save files.

--version shows version and build date information, and exits.

--compile-help compiles help contents files from the HTML documentation

files that the tool finds in the eCos repository, and exits.

When you invoke the eCos Configuration Tool, it accesses the Component

          Repository, a read-only location of configuration

          information. For an explanation of “Component

          Repository” see .

The eCos Configuration Tool will look

          for a component repository using (in descending order of preference):

A location specified on the command line

The component repository most recently used by the

current user

An eCos distribution under /opt/ecos (under

Linux) or a default location set by the installation procedure (under

Windows)

User input

The final case above will normally only occur if the previous

          repository has been moved or (under Windows) installation information stored in

          the Windows registry has been modified; it will result in a dialog box

being displayed that allows you to specify the repository location:

Note that in order to use the eCos Configuration Tool you are obliged to provide a

          valid repository location. 

In the rare event that you subsequently wish to change

          the component location, select

          Build->Repository

          and the above dialog box will then be displayed.

You can check the location of the current repository, the current save file

path, and the current hardware template and default package,

by selecting Help->Repository Information....

A summary will be displayed.

eCos configuration settings and other information

            (such as disabled conflicts) that are set using the

            eCos Configuration Tool are saved to

            a file between sessions. By default, when the

            eCos Configuration Tool is first

            invoked, it reads and displays information from the

            Component Registry and displays the information in an

            untitled blank document. You can perform the following

            operations on a document:

Use the “File->Save” menu

            item or click the Save Document icon on the

            toolbar; if the current document is unnamed, you will be prompted

            to supply a name for the configuration save file.

Select File->Open,

            or click the Open Document icon on the toolbar.

            You will be prompted to supply a name for the configuration save

            file. 

Click its name at the bottom of the

            File menu. 

Documents may also be opened by:

double-clicking a Configuration Save File in the desktop

explorer (Windows only);

invoking the eCos

Configuration Tool

with the name of a Configuration File as command-line argument,

or by creating a shortcut to the eCos Configuration Tool with such an argument

(under Windows or a suitable Linux desktop environment).

Select File->New,

or click the New Document icon on the toolbar.

Select File->Save

                As. You will be prompted to supply a new

              name for the configuration save file.

The location of the build and install trees are

            derived from the eCos save file name as illustrated in the

            following example:

Save file name = “c:\My

            eCos\config1.ecc”

Install tree folder = “c:\My

            eCos\config1_install”

Build tree folder = “c:\My

            eCos\config1_build”

These names are automatically generated from the name

            of the save file.

See also .

The eCos Configuration Tool contains

several methods for accessing online help.

Most dialogs displayed by the eCos Configuration Tool are supplied

with context-sensitive help. You can then get help relating

to any control within the current dialog box by

Right-clicking the control (or pressing

              F1

              )

A “What’s This?” popup menu will

          be displayed. Click the menu to display a brief description of the

          function of the selected control.

Clicking the question mark icon in the dialog

            caption bar (Windows) or the question mark button on the dialog (Linux).

A question mark cursor will be displayed. Click on

              any control to display a brief description of its

              function.

Some dialogs may have a Help

          button. You can press this to display a more general

          description of the function of the dialog box as a whole.

          This help will be in HTML form; for more information, see

          below.

In the Help menu, click

          Help On...

and then click on a window (or click on the arrow/question mark button

on the toolbar, then click on a window). A small popup window page describing the

window will be displayed. The same thing can be achieved by right-clicking

on a window and clicking on What's This?.

In the configuration window, right-click on a configuration

item (or use Shift+F10). A context

menu will be displayed; select Visit Documentation

to display the page in the eCos documentation that most closely

corresponds to the selected item.

Using the internal help system. This will show an internal viewer similar to Microsoft HTML Help, with a contents

hierarchy on the left and HTML pages on the right; see . The index is regenerated for each repository. If the documentation in

the repository has changed but the contents does not reflect this, please use the Tools Regenerate Help Index menu

item.

Using the default HTML browser. On Unix, you will need a .mailcap entry similar to this:

text/html; netscape -no-about-splash %s

Using the specified browser.

If you wish, you may choose to have HTML Help displayed

in a browser of your choice. To do this, select View->Settings and

use the controls in the View Documentation group to select the replacement browser.

Note that the Navigation facilities of the built-in HTML

Help system will be unavailable if you choose this method

of displaying help.

The following visual aspects of the eCos Configuration Tool can be changed to suit

        individual preferences. These aspects are saved on a per-user

        basis, so that when the eCos Configuration Tool is next invoked by the same

        user, the appearance will be as set in the previous

        session.

The relative sizes of all windows in the eCos Configuration Tool may be adjusted by dragging

          the splitter bars that separate the windows. The chosen

          sizes will be used the next time the eCos Configuration Tool is invoked by the current

          user. 

All windows except the Configuration

            Window may be shown or hidden by using the

          commands under the View menu (for

          example, View->Output) or the

          corresponding keyboard accelerators

          (Alt+1 to

          Alt+4).

Your chosen set of windows (and their relative sizes) will

be preserved between invocations of the eCos Configuration

Tool.

To change other visual aspects, select

          View->Settings

          and then select the Display and

          View tabs depending on the settings

          you wish to alter..

          The options are as follows:

In the configuration window, you can choose to have

            either descriptive names (the

            default) or macro names displayed as

            tree item labels. Descriptive names are generally more

            comprehensible, but macro names are used in some contexts

            such as conflict resolution and may be directly related to

            the source code of the configuration. Note that it is

            possible to search for an item in the configuration view

            by selecting

            Find->Edit

            (see ). Both

            descriptive names and macro names can be searched.

You can choose to have integer items in the

            Configuration Window displayed in decimal or hexadecimal

            format.

Change the font for a particular window by selecting the window name using the drop-down list,

then clicking on Change Font to select a font for that

window. The changes will be applied when the press OK to dismiss the Settings dialog.

If you never make font changes, then the windows will take

the default setting determined by your current Windows or Unix environment.

If the Splash Screen checkbox is checked, a splash

window will appear as the application is loading. Uncheck this to eliminate the splash screen.

You can change the viewer used to display header files.

You can change the viewer used to display HTML files.

See .

The following windows are available within the

      eCos  Configuration

        Tool:

                Configuration Window

                Properties Window

                Short Description

                Conflicts

                Output

The layout of the windows may be adjusted to suit your

        preferences: see .

This is the principal window used to configure eCos. It

          takes the form of a tree-based representation of the

          configuration items within the currently loaded eCos

          packages.

In the case of items whose values may be changed,

          controls are available to set the item values. These either

          take the form of check boxes or radio buttons within the

          tree itself or cells to the right of the thin vertical

          splitter bar. Controls in the tree may be used in the usual

          way; cells, however, must first be activated.

To activate a cell, simply click on it: it will assume a sunken

appearance and data can then be edited in the cell. To terminate

in-cell editing, click elsewhere in the configuration window or

press ENTER. To discard the partial results

of in-cell editing and revert to the previous value, press ESCAPE.

Cells come in three varieties, according to the type of

          data they accept:

      
      

         
620
         

         

         

      
      

         
621
         

         

         

      
      

         
622
         

         

         

      
      

         
623
         

         

         

      
      

         
624
         

         

         
Cell Type
      
      

         
625
         

         

         
Data Accepted
      
      

         
626
         

         

         

      
      

         
627
         

         

         

      
      

         
628
         

         

         

      
      

         
629
         

         

         

      
      

         
630
         

         

         
Integer
      
      

         
631
         

         

         
Decimal or hexadecimal values
      
      

         
632
         

         

         

      
      

         
633
         

         

         

      
      

         
634
         

         

         
Floating Point
      
      

         
635
         

         

         
Floating point values
      
      

         
636
         

         

         

      
      

         
637
         

         

         

      
      

         
638
         

         

         
String
      
      

         
639
         

         

         
Any
      
      

         
640
         

         

         

      
      

         
641
         

         

         

      
      

         
642
         

         

         

      
      

         
643
         

         

         

In the case of string cells, you can double-click the cell

to display a dialog box containing a larger region in which to edit

the string value. This is useful in the case of long strings, or

those spanning multiple lines.

Some items will appear disabled. In this case the item

            label and any associated controls and cells will be

            grayed. It is not be possible to change the values of

            disabled items.

You can right-click on an item in the configuration

              window item to display a pop-up menu which (depending on

              the type of the item selected) allows you to:

 Properties –

                  information relating to the currently selected item

                  is displayed. The information is equivalent to that

                  displayed in the Properties

                  Window.

 Restore Defaults -

                  the default value of the currently selected item is

                  restored.

Visit Documentation

                  - causes the HTML page most closely relating to the

                  currently selected item to be displayed. This has

                  the same effect as double-clicking the URL property

                  in the Properties Window.

 View Header File

                  – this causes the file containing the items to

                  be displayed. This is equivalent to double-clicking

                  on the File property in the Properties Window. The

                  viewer used for this purpose may be changed using

                  the View->Settings menu item

                  (see ).

                  Note that this operation is only possible when the

                  current configuration is saved, in order to avoid

                  the possibility of changing the source

                  repository.

Unload Package -

                  this is equivalent to using the

                  Build->Packages menu item to

                  select and unload the package in

                  question.

This window exists to display any configuration item

            conflicts. Conflicts are the result of failures to meet

            the requirements between configuration items expressed in

            the CDL. See  .

The window comprises three columns:

                Item

This is the macro name of the first item involved

                in the conflict.

                Conflict

This is a description of the conflict type. The currently

                supported types are “unresolved”, “illegal

                value”, “evaluation exception”, “goal

                unsatisfied” and “bad data”.

                Property

This contains a description of the configuration

                item’s property that caused the conflict.

Within the conflicts window you can right-click on

                any item to display a context menu which allows you to

                choose from one of the following options:

To locate the item involved in the

conflict, double-click in the first or third column, or

right-click over the item and choose Locate

from the popup menu.

You can use the Tools->Resolve Conflicts menu

item, or right-click over the item and select Resolve from the popup menu,

to resolve conflicts — .

This window displays any output generated by

              execution of external tools and any error messages that

              are not suitable for display in other forms (for

              example, as message boxes).

Within the output window you can right-click to display a

context menu which allows you to:

Save the contents of the window to a

                  file

Clear the contents of the

                  window

This window displays the CDL properties of the item

              currently selected in the configuration window. The same

              information may be displayed by right-clicking the item

              and selecting “properties”.

Two properties may be double-clicked as

            follows:

URL –

                  double-clicking on a URL property causes the

                  referenced HTML page to be displayed. This has the

                  same effect as right-clicking on the item and

                  choosing “Visit

                  Documentation”.

File –

                  double-clicking on a File property in a saved

                  configuration causes the File to be displayed. The

                  viewer used for this purpose may be changed using

                  the View->Settings menu

                  item. Note that this operation is only possible when

                  the current configuration is saved, in order to

                  avoid the possibility of changing the source

                  repository.

This window displays a short description of the item

              currently selected in the configuration window. More

              extensive documentation may be available by

              right-clicking on the item and choosing “Visit

              Documentation”.

To add or remove packages from the configuration, select

          Build->Packages.

            The following dialog box will be displayed:

The left-hand list shows those packages that are available to

          be loaded. The right-hand list shows those that are

          currently loaded. In order to transfer packages from one

          list to another (that is, to load or unload packages)

          double-click the selection or click the

          Add or Remove

          buttons.

The version drop-down list displays the versions of the

          selected packages. When loading packages, this control may

          be used to load versions other than the most recent

          (current). Note that if more than one package is selected,

          the version drop-down list will display only the versions

          common to all the selected packages.

The window under the version displays a brief

          description of the selected package. If more than one

          package is selected, this window will be blank.

        Under the description window there is a Keywords

control into which you can type a string to be matched against

package names, macro names and descriptions. The lists are updated

a second or so after typing has stopped.

If you type several separate words,

all of these words must be associated with a given package

for that package to be displayed. If you select

the Match exactly checkbox, then the string

is taken to be a complete fragment and matched against the beginning

of a name, macro name or descriptions. All matches are done

case-insensitively.

If you check Omit hardware packages, only

non-hardware packages will be shown.

To add, modify or remove entries in the list of

          platforms used for running tests, select

          Tools->Platforms. The following

          dialog will be displayed:

You may add, modify or remove platform entries as you

          wish, but in order to run tests, a platform must be defined

          to correspond to the currently loaded hardware template. The

          information associated with each platform name is used to

          run tests.

To modify a platform, click the

          Modify button with the appropriate

          platform selected, or double-click on an entry in the list.

          A dialog will be displayed that allows you to change the

          command prefix, platform type and arguments for

          GDB. 

To add a new platform, click the

          Add button. A similar dialog will be

          displayed that allows you to define a new platform. To

          remove a platform, click the Delete

          button or press the DEL key with the

          appropriate platform selected.

The command prefix is used when running tests in order

          to determine the names of the executables (such as gdb) to

          be used. For example, if the gdb executable name is

          “arm-elf-gdb.exe” the prefix should be set to

          “arm-elf”.

The platform type indicates the capabilities of the platform

- whether it is hardware or a simulator, and whether breakpoints

are supported.

The arguments for the GDB field allow

additional arguments to be passed to gdb when it is used to run

a test.  This is typically used in the case of simulators linked

to gdb in order to define memory layout.