wtx.html

vxworks相关论文

the request such as the maximum number of elements in an array.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
This paragraph describes the return value of the request. For 
example, a typical return value is:
<p>
The <b>errCode</b> field in <b>WTX_CORE</b> contains OK, or ERROR if communication
with the target fails.  If <b>errCode</b> is OK, the
<b>val</b> field in <b>WTX_MSG_RESULT</b> contains .......
<p>
</blockquote><h4>ACTION LOCATION</h4><blockquote><p>
<p>
This paragraph gives the scope of the request: applicable to
the target, to the target server, to both, or to the WTX registry.
<p>
</blockquote><h4>EXAMPLE</h4><blockquote><p>
<p>
This paragraph gives an example of input parameters for this request.
<p>
</blockquote><h4>ERRORS</h4><blockquote><p>
<p>
This paragraph lists the possible error codes returned by this request.
<dl>
<dt>
<b>A_WTX_ERROR_CODE</b>
<dd>
 Each error code is described here along with a description of possible 
causes of failure. 
</dl>

</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./wtx.html#top">WTX</a></b>

<hr>
<a name="WTX_AGENT_MODE_GET"></a>
<p align=right>
<a href="rtnIndex.html"><i>WTX Protocol :  Requests</i></a></p>

</blockquote><h1>WTX_AGENT_MODE_GET</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>WTX_AGENT_MODE_GET</strong> - WTX get debug agent mode</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>INPUT: WTX_MSG_TOOL_ID
OUTPUT: WTX_MSG_RESULT
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This request returns the running mode of the debug agent. The mode can be 
either:
<p>
<dl>
<dt>
<b>WTX_AGENT_MODE_TASK</b>
<dd>

The agent runs as a task.     
<p>
<dt>
<b>WTX_AGENT_MODE_EXTERN</b>
<dd>
 The agent runs in external mode. 
</dl>

<p>

The tool making the request sends its identifier in the following format:
<p>
<pre>
typedef struct wtx_msg_tool_id		/* Tool identifier message */
    {
    WTX_CORE		wtxCore;	/* WTX message core        */
    } WTX_MSG_TOOL_ID;</pre>

<p>
The agent mode is returned in a <b>WTX_MSG_RESULT</b> message:
<p>
<pre>
typedef struct wtx_msg_result		/* Simple request result */
    {
    WTX_CORE		wtxCore;	/* WTX message core      */

    WTX_VALUE		val;		/* Result value of call  */
    } WTX_MSG_RESULT;</pre>

<p>
</blockquote><h4>IMPORTANT</h4><blockquote><p>
<p>
The agent mode is the mode at the time the request was made to the
target; it might be obsolete by the time it is received by the tool
making the request.
<p>
</blockquote><h4>ASSOCIATED EVENTS</h4><blockquote><p>
<p>
This request has no associated events.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
<p>
The <b>errCode</b> field in <b>WTX_CORE</b> contains OK, or ERROR if communication
with the target fails.  If <b>errCode</b> is OK, the
<b>val</b> field in <b>WTX_MSG_RESULT</b> contains the current agent running mode.
<p>
</blockquote><h4>ACTION LOCATION</h4><blockquote><p>
<p>
Target only
<p>
</blockquote><h4>ERRORS</h4><blockquote><p>
<p>
<dl>
<dt>
<b>WTX_ERR_AGENT_COMMUNICATION_ERROR</b>
<dd>

Failure while communicating with the target.
<p>
<dt>
TIMEOUT
<dd>
 WTX RPC timeout. 
</dl>

<p>

</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./wtx.html#WTX_AGENT_MODE_SET">WTX_AGENT_MODE_SET</a></b>

<hr>
<a name="WTX_AGENT_MODE_SET"></a>
<p align=right>
<a href="rtnIndex.html"><i>WTX Protocol :  Requests</i></a></p>

</blockquote><h1>WTX_AGENT_MODE_SET</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>WTX_AGENT_MODE_SET</strong> - WTX set debug agent mode</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>INPUT: WTX_MSG_PARAM
OUTPUT: WTX_MSG_RESULT
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This request sets the running mode of the debug agent.  The debug agent mode
to set, the <b>value</b> field in <b>WTX_MSG_PARAM</b>, can be:
<p>
<dl>
<dt>
<b>MODE_TASK</b>
<dd>

The agent runs in task mode allowing only task debugging.
<p>
<dt>
<b>MODE_EXTERN</b>
<dd>

The agent runs in external mode allowing only system and interrupt code 
debugging.
<p>
<dt>
<b>MODE_BI</b>
<dd>
 The agent runs in both external and task modes, switching from one mode to
the other when hitting breakpoints. 
</dl>

<p>

<pre>
typedef struct wtx_msg_param		/* Simple request parameter */
    {
    WTX_CORE		wtxCore;	/* WTX message core         */

    WTX_VALUE		param;		/* Param value of call      */
    } WTX_MSG_PARAM;</pre>

<p>
The result of this request is returned in a <b>WTX_MSG_RESULT</b> message
but the <b>val</b> field is not used and is always NULL.
<p>
<pre>
typedef struct wtx_msg_result		/* Simple request result */
    {
    WTX_CORE		wtxCore;	/* WTX message core      */

    WTX_VALUE		val;		/* Result value of call  */
    } WTX_MSG_RESULT;</pre>

<p>
</blockquote><h4>IMPORTANT</h4><blockquote><p>
<p>
Not all agents support all debugging modes. When an agent does not support a
given mode, it returns a <b>WTX_ERR_AGENT_UNSUPPORTED_REQUEST</b> error and remains
in the previous mode.
<p>
</blockquote><h4>ASSOCIATED EVENTS</h4><blockquote><p>
<p>
This request has no associated events.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
The <b>errCode</b> field in <b>WTX_CORE</b> contains OK, or an ERROR code if 
the given agent mode is invalid.
<p>
</blockquote><h4>ACTION LOCATION</h4><blockquote><p>
<p>
Target only
<p>
</blockquote><h4>ERRORS</h4><blockquote><p>
<p>
<dl>
<dt>
<b>WTX_ERR_AGENT_INVALID_PARAMS</b>
<dd>

The requested running mode is not supported by the agent.
<p>
<dt>
<b>WTX_ERR_AGENT_UNSUPPORTED_REQUEST</b>
<dd>

The agent mode set is not supported by the agent.
<p>
<dt>
<b>WTX_ERR_AGENT_COMMUNICATION_ERROR</b>
<dd>

Failure while communicating with the target.
<p>
<dt>
TIMEOUT
<dd>
 WTX RPC timeout. 
</dl>

<p>

</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./wtx.html#WTX_AGENT_MODE_GET">WTX_AGENT_MODE_GET</a></b>

<hr>
<a name="WTX_CLOSE"></a>
<p align=right>
<a href="rtnIndex.html"><i>WTX Protocol :  Requests</i></a></p>

</blockquote><h1>WTX_CLOSE</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>WTX_CLOSE</strong> - WTX close a file or pipe </p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>INPUT: WTX_MSG_PARAM
OUTPUT: WTX_MSG_RESULT
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This request closes the file specified by the file descriptor in the
<b>param</b> field of <b>WTX_MSG_PARAM</b>.  If <b>param</b> is a pipe,
this request uses the <b><i>pclose</i>(&nbsp;)</b> system call to close the pipe; otherwise 
it calls <b><i><a href="../../vxworks/ref/ioLib.html#close" >close</a></i>(&nbsp;)</b>.
<p>
<pre>
typedef struct wtx_msg_param		/* Simple request parameter */
    {
    WTX_CORE		wtxCore;	/* WTX message core         */

    WTX_VALUE		param;		/* Param value of call      */
    } WTX_MSG_PARAM;</pre>

<p>
After a call to <b><a href="./wtx.html#WTX_CLOSE">WTX_CLOSE</a></b>, any data written to the file from a virtual I/O
channel is lost. The result of this request is returned in a 
<b>WTX_MSG_RESULT</b> message but the <b>val</b> field is not used and is 
always NULL.
<p>
<pre>
typedef struct wtx_msg_result		/* Simple request result */
    {
    WTX_CORE		wtxCore;	/* WTX message core      */

    WTX_VALUE		val;		/* Result value of call  */
    } WTX_MSG_RESULT;</pre>

<p>
</blockquote><h4>ASSOCIATED EVENTS</h4><blockquote><p>
<p>
This request has no associated events.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
The <b>errCode</b> field in <b>WTX_CORE</b> contains OK, or an ERROR code if 
unable to close the specified file or pipe.
<p>
</blockquote><h4>ACTION LOCATION</h4><blockquote><p>
<p>
Target server only
<p>
</blockquote><h4>ERRORS</h4><blockquote><p>
<p>
<dl>
<dt>
<b>WTX_ERR_SVR_INVALID_FILE_DESCRIPTOR</b>
<dd>

The file descriptor is invalid.
<p>
<dt>
EBADF
<dd>

The given file descriptor is not an active descriptor; the file may
already be closed.
<p>
<dt>
TIMEOUT
<dd>
 WTX RPC timeout. 
</dl>

<p>

</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./wtx.html#WTX_OPEN">WTX_OPEN</a></b>, <b><a href="./wtx.html#WTX_VIO_FILE_LIST">WTX_VIO_FILE_LIST</a></b>

<hr>
<a name="WTX_CONSOLE_CREATE"></a>
<p align=right>
<a href="rtnIndex.html"><i>WTX Protocol :  Requests</i></a></p>