chadmin(1CC)

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | EXTENDED DESCRIPTION | EXAMPLES | ENVIRONMENT VARIABLES | ATTRIBUTES | SEE ALSO

NAME

chadmin- ChorusOS DebugServer administration tool

SYNOPSIS

chadmin [-activate name] [-add-core-target name] [-add-serial-target name] [-baud value] [-deactivate name] [-device dev-file] [-h] [-layout-file file] [-parity value] [-pathmap original_dir new_dir] [-reboot-server name] [-remove-target name] [-save filename] [-set name] [-shutdown] [-stat] [-target name] [-target-type type]

DESCRIPTION

chadmin is a host utility.

chadmin is the ChorusOS DebugServer administration tool. It allows the DebugServer to be stopped, to obtain statistical information about it, and to register new targets dynamically.

OPTIONS

The following options are supported:

-activate name

Activates the target name. When the target is activated, the DebugServer polls the serial line and provides debugging control of the target through the DebugAgent.

-add-core-target name

Registers a new target represented by a core file.

-add-serial-target name

Registers a new target with a serial line backend. name indicates the name of the target, as it will appear in the object tree of the DebugServer.

-baud value

Specifies the baud rate of the serial line. Use this option to change the baud rate of the serial line between the DebugServer and the DebugAgent.

-deactivate name

Deactivates the target name. When the target is deactivated, the DebugServer does not poll the serial line. Debugging and console control for the target are no longer managed by the DebugServer.

-device dev-file

Indicates the path to the serial device that the DebugServer must use. This option is relevant only when a new target is being registered.

-h

Prints the usage description.

-layout-file dev-file

Indicates the path of the ChorusOS XML layout file. The path should point to the layout.xml file generated during the creation of the target image. The XML layout file is required for the DebugServer to obtain information about the image.

-parity value

Specifies the parity of the serial line. Use this option to change the parity of the data on the serial line between the DebugServer and the DebugAgent.

-pathmap original_dir new_dir

Sets or removes a translation pathmap. The first argument is the original directory, that cannot be accessed by the DebugServer. The second argument is the new directory that the DebugServer should use, instead of the original one.

-reboot-server name

Sets the name of the external reboot server for the target. If an external reboot server exists for your target, you can activate or deactivate the use of the external reboot server, using this option.

-remove-target name

Removes the target name.

-save filename

Saves the DebugServer configuration into the file filename. The file must be writable by the DebugServer process.

-set name value

Sets the value of an attribute. The arguments that follow consist of name-value pairs. The name should be an absolute path. The value is converted into an integer, depending on the attribute type.

-shutdown

Stops the DebugServer.

-stat

Prints statistics collected by the ChorusOS DebugServer.

-target name

Indicates the name of the target. Use this option when an operation must be applied on a given target and several targets are active in the DebugServer.

-target-type type

Indicates the target type in terms of the architecture/processor. The type specified must be registered in the DebugServer XML configuration files. This type can usually be determined by looking at the archive file.

EXTENDED DESCRIPTION

The chadmin tool is used in the following situations:

To register a new target:

The DebugServer must have some information about the target so that it can control it. In general, you will register your target only once. The information that you must pass includes the target name, the serial device name and the path of the XML image layout file generated by mkimage.

To update the information about a target:

Sometimes the information that you have specified during the registration changes. This is often the case for the serial line speed and the path of the XML image layout file. Use the chadmin tool in to update this information.

To activate or deactivate a target:

Activation and deactivation of a target is useful when some targets are momentarily unavailable to the DebugServer, or when you want the DebugServer to release control of the serial line without having to go to the remove and/or register process of the target.

EXAMPLES

The following example illustrates how you can register a new target:

chadmin -add-serial-target quintet -device /dev/ttyb -layout-file image/LILO/kts/layout.xml

If you discover that the serial line was not set correctly, or if you change the dbg.driver.baud tunable to increase the speed of the serial line, for example, you can update your target configuration by typing the following commands:

chadmin -set targets/quintet/backends/log:bkpts: cache:serial/device /dev/ttya chadmin -set targets/quintet/backends/log:bkpts:\ cache:serial/baud 38400

where quintet is the name of your target, ttya is the new device and 38400 is the baud rate that you have setup in the debug agent tunable.

Sometimes, the path of the XML layout file is not correct, or is changed, if you are booting another system image, for example. In this case, you can update the target configuration by typing the following command:

chadmin -set targets/quintet/layout_file image/LILO/chorus/layout.xml

where image/LILO/chorus/layout.xml is the new path.

ENVIRONMENT VARIABLES

The following environment variable is read by chadmin:

CHSERVER_HOST

The host name on which the DebugServer is running.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Interface Stability	Evolving

SEE ALSO

chserver(1CC)

ChorusOS 5.0  Last Revised December 2001

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | EXTENDED DESCRIPTION | EXAMPLES | ENVIRONMENT VARIABLES | ATTRIBUTES | SEE ALSO