ChorusOS man pages section 1CC: Host and Target Utilities

chconsole(1CC)

NAME

chconsole- ChorusOS Debug Console

SYNOPSIS

chconsole

-h

-target-host

name

target

DESCRIPTION

chconsole is a host utility.

chconsole is the ChorusOS Debug Console. It prints the messages produced on the target with the sysWrite(2K) system call and it provides keyboard input for the sysPoll(2K) and sysRead(2K) system calls. The chconsole tool uses the Debug API and it connects to the chserver daemon on the host. It is intended to be used when the DEBUG_SYSTEM feature is enabled and the DebugServer is connected. The chconsole tool can also be used for the console management of a boot or prom monitor.

The chserver server can control one or several targets. Each of these targets have a separate debug console. The chconsole tool tries to find a default active target. If you have registered several targets and that several are active at the same time, you must specify the name of the target for which you want to get the Debug Console. Your target must be registered to the Debug Server. You can obtain the list of registered targets using the chls tool with the -t option and you can register a new target with the chadmin tool.

If there is only one target controlled by the Debug Server, then chconsole will select it automatically. Otherwise, it is necessary to specify the target name explicitly on the command line.

When the chconsole tool is connected to a target, it displays the message produced by the target (with the sysWrite(2K) system call for example). The input that you type is sent to the target and feeds the sysPoll(2K), sysRead(2K) system calls or the prom monitor. While the console is running, it also monitors the state of the target and is able to report events such as Stop, Resume, Reboot, Breakpoint, Single step and more. The event monitoring is controlled by the event_report variable.

To exit the chconsole tool, type ^C or use the ~q command.

OPTIONS

The following options are supported:

-target-host name: Indicates the host name where the chserver server is running. You may also use the CHSERVER_HOST environment variable to avoid to pass this option. Refer to chserver manual page for the setting of this environment variable.
-h: Prints the help description and exit..
target: This optional parameter indicates the target name for which the debug console must be displayed. By default, the chconsole tool tries to find the default active target and reports its debug console. If several targets are registered and active, the chconsole tool is not able to choose the target and you must specify the target name.

EXTENDED DESCRIPTION

Command

A tilde ( ~) appearing as the first character of a line is an escape signal which directs chconsole to perform some special action. chconsole recognizes the following escape sequences:

~
~.
~q: Exit the chconsole
~c [name]: Change directory to name (no argument implies change to your home directory)
~!: Escape to an interactive shell on the local machine (exiting the shell returns you to chconsole)
~h
~?: Get a summary of the tilde escapes
~speed [speed]: Set the speed of the serial line connected to the DebugServer and the target
~parity [parity]: Set the parity of the serial line
~set var value: Set a variable (see discussion below)
~reboot [hard]: Reboots the target. The reboot command has two mode: a soft and a hard mode. The soft reboot mode assumes that the Debug Agent is running on the target (DEBUG_SYSTEM feature eanbled). In this mode, the reboot is executed by the target itself. In the hard reboot mode, an external tool is used to reset the target. Such external tool can operate directly on the reset line for example.
~list: Lists the variables with their value
~info: Prints some information about the target

Internal Variables

chconsole maintains a set of variables which are used in normal operation. Variables may be displayed with the ~list command and they may be set with the ~s escape.

escape: The escape character that activates the chconsole action. The default is ~ (tilde).
event-report: This varialbe controls the report of events on the console. When it is set to 0, no monitoring is made. When it is set to 1, the >chconsole tool informs when the target is stopped, resumed, rebooted, hit a breakpoint or did a single step. The default is 1
reconnect-delay: This integer variable controls the reconnection delay to the DebugServer. When the DebugServer is stopped, the >chconsole tool tries to reconnect to it. This variable indicates the maximum time in seconds to wait for a reconnection.

ENVIRONMENT VARIABLES

The following environment variables are read by chconsole:

CHSERVER_HOST: The host name where the DebugServer is running.

ATTRIBUTES

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

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Interface Stability	Evolving