wtx.html

vxworks相关论文

 <i>ppClientData</i> is NULL.
<p>
</dl>

</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><i><a href="./wtx.html#wtxClientDataSet">wtxClientDataSet</a></i>(&nbsp;)</b>

<hr>
<a name="wtxClientDataSet"></a>
<p align=right>
<a href="rtnIndex.html"><i>WTX C Library :  Routines</i></a></p>

</blockquote><h1><i>wtxClientDataSet</i>(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong><i>wtxClientDataSet</i>(&nbsp;)</strong> - set the client data associated with the WTX handle</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS wtxClientDataSet
    (
    HWTX   hWtx,       /* WTX API handle */
    void * pClientData /* value to associate with handle */
    )</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine causes the value <i>pClientData</i> to be associated with the
WTX API handle <i>hWtx</i>. The client data can be used by the
caller in any way and, except when in the set and get routines,
is not used or altered in any way by the WTX API. The initial value
of the client data before it is set is always NULL.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
<b>WTX_OK</b> or <b>WTX_ERROR</b>.
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><i><a href="./wtx.html#wtxClientDataGet">wtxClientDataGet</a></i>(&nbsp;)</b>.

<hr>
<a name="wtxAgentModeGet"></a>
<p align=right>
<a href="rtnIndex.html"><i>WTX C Library :  Routines</i></a></p>

</blockquote><h1><i>wtxAgentModeGet</i>(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong><i>wtxAgentModeGet</i>(&nbsp;)</strong> - get the mode of the target agent</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>WTX_AGENT_MODE_TYPE wtxAgentModeGet
    (
    HWTX hWtx /* WTX API handle */
    )</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine returns the running mode of the target agent that the 
current target server is attached to.  
<p>
<pre>
typedef enum wtx_agent_mode_type	/* debug agent running mode */
    {
    WTX_AGENT_MODE_TASK 	= 1,	/* run in task mode */
    WTX_AGENT_MODE_EXTERN	= 2,	/* run in system mode */
    WTX_AGENT_MODE_BI		= 3	/* bimodal agent */
    } WTX_AGENT_MODE_TYPE;</pre>

<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
The current agent running mode or <b>WTX_ERROR</b>.
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="../wtxpcl/wtx.html#WTX_AGENT_MODE_GET" >WTX_AGENT_MODE_GET</a></b>, <b><i><a href="./wtx.html#wtxTsInfoGet">wtxTsInfoGet</a></i>(&nbsp;)</b>, <b><i><a href="./wtx.html#wtxAgentModeSet">wtxAgentModeSet</a></i>(&nbsp;)</b>

<hr>
<a name="wtxAgentModeSet"></a>
<p align=right>
<a href="rtnIndex.html"><i>WTX C Library :  Routines</i></a></p>

</blockquote><h1><i>wtxAgentModeSet</i>(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong><i>wtxAgentModeSet</i>(&nbsp;)</strong> - set the mode of the target agent</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS wtxAgentModeSet
    (
    HWTX                hWtx,     /* WTX API handle */
    WTX_AGENT_MODE_TYPE agentMode /* debug agent mode */
    )</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine sets the mode of the target agent that the current target
server is attached to.  A given agent may not support all the possible 
modes.
<p>
<pre>
typedef enum wtx_agent_mode_type	/* debug agent running mode */
    {
    WTX_AGENT_MODE_TASK 	= 1,	/* run in task mode */
    WTX_AGENT_MODE_EXTERN	= 2,	/* run in system mode */
    WTX_AGENT_MODE_BI		= 3	/* bimodal agent */
    } WTX_AGENT_MODE_TYPE;</pre>

<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
<b>WTX_OK</b> or <b>WTX_ERROR</b>.
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="../wtxpcl/wtx.html#WTX_AGENT_MODE_SET" >WTX_AGENT_MODE_SET</a></b>, <b><i><a href="./wtx.html#wtxTsInfoGet">wtxTsInfoGet</a></i>(&nbsp;)</b>, <b><i><a href="./wtx.html#wtxAgentModeGet">wtxAgentModeGet</a></i>(&nbsp;)</b>

<hr>
<a name="wtxAsyncNotifyEnable"></a>
<p align=right>
<a href="rtnIndex.html"><i>WTX C Library :  Routines</i></a></p>

</blockquote><h1><i>wtxAsyncNotifyEnable</i>(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong><i>wtxAsyncNotifyEnable</i>(&nbsp;)</strong> - start the asynchronous event notification</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS wtxAsyncNotifyEnable
    (
    HWTX    hWtx, /* WTX API handle */
    FUNCPTR pFunc /* User defined function */
    )</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This function creates a socket-based link between the target server and 
the client where events will be sent. If a user defined function 
is given (pFunc != NULL) then this function is called each time an 
event is received by the target server, this function must take 
a <b>WTX_EVENT_DESC</b> as input parameter. If no user defined function is 
given then received events are just stored in the asynchronous event 
list, those events can be get using <b><i><a href="./wtx.html#wtxAsyncEventGet">wtxAsyncEventGet</a></i>(&nbsp;)</b>.
<p>
In conjunction with <b><i><a href="./wtx.html#wtxAsyncNotifyEnable">wtxAsyncNotifyEnable</a></i>(&nbsp;)</b>, <b><i><a href="./wtx.html#wtxRegisterForEvent">wtxRegisterForEvent</a></i>(&nbsp;)</b> (or
<b><i><a href="./wtx.html#wtxUnregisterForEvent">wtxUnregisterForEvent</a></i>(&nbsp;)</b>) must be used to specify which type of events must
be sent to the requester.
<p>
Upon calling this function, the <b><i><a href="./wtx.html#wtxEventGet">wtxEventGet</a></i>(&nbsp;)</b> and <b><i><a href="./wtx.html#wtxEventListGet">wtxEventListGet</a></i>(&nbsp;)</b> 
routines will always return nothing.
<p>
When an event is coming to the client, the event is put in an 
<b>WTX_EVENT_DESC</b> structure and passed to the user provided function 
pointed to by <i>pFunc</i>.
<p>
All strings contained in the <b>WTX_EVENT_DESC</b> structure must be copied 
before to be used because their life duration is depending on the events
stream.
<p>
The user defined function must take a <b>WTX_EVENT_DESC</b> * as input 
parameter. It is called each time an event is received by the target
server.
<p>
</blockquote><h4>NOTE</h4><blockquote><p>
<p>
This service uses <b><a href="../wtxpcl/wtx.html#WTX_COMMAND_SEND" >WTX_COMMAND_SEND</a></b> request of the WTX protocol. 
<p>
</blockquote><h4>EXAMPLE</h4><blockquote><p>
<p>

Declaration of a simple event handler.
<p>
<pre>  LOCAL void eventHookRtn     /* Hook routine used by the notification */
      (
      WTX_EVENT_DESC * event  /* Event received from the target server */
      )
      {
      /* Just print the event string and exit */

      if (event-&gt;event != NULL)
          printf ("Received event: %s\n", event-&gt;event);
      }
</pre>

Start of the asynchronous notification from the C API.
<p>
<pre>      /* Initialization */
              .
              .

      /* Start the notification */

      if (wtxAsyncNotifyEnable (wtxh, (FUNCPTR) eventHookRtn) 
          != (UINT32) WTX_OK)
          return (WTX_ERROR);

      /* core of the WTX application */
              .
              .
</pre>

</blockquote><h4>RETURN</h4><blockquote><p>
<b>WTX_OK</b> or <b>WTX_ERROR</b> if the request failed.
<p>
</blockquote><h4>ERRORS</h4><blockquote><p>
<p>
<dl>
<dt>
<b>WTX_ERR_API_SERVICE_ALREADY_STARTED</b>
<dd>

An wtxAsyncNotifyDisable must be called before.
<p>
<dt>
<b>WTX_ERR_API_CANT_OPEN_SOCKET</b>
<dd>

Socket creation, bind or listen failed.
<p>
<dt>
<b>WTX_ERR_API_CANT_GET_HOSTNAME</b>
<dd>
 Cannot get name of current host.
<p>
</dl>

</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="../wtxpcl/wtx.html#WTX_COMMAND_SEND" >WTX_COMMAND_SEND</a></b>, <b><i><a href="./wtx.html#wtxAsyncNotifyEnable">wtxAsyncNotifyEnable</a></i>(&nbsp;)</b>, <b><i><a href="./wtx.html#wtxAsyncEventGet">wtxAsyncEventGet</a></i>(&nbsp;)</b>

<hr>
<a name="wtxAsyncNotifyDisable"></a>
<p align=right>
<a href="rtnIndex.html"><i>WTX C Library :  Routines</i></a></p>

</blockquote><h1><i>wtxAsyncNotifyDisable</i>(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong><i>wtxAsyncNotifyDisable</i>(&nbsp;)</strong> - stop the asynchronous event notification</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS wtxAsyncNotifyDisable
    (
    HWTX hWtx /* WTX API handle */
    )</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This function sends to the target server an order to stop the asynchronous
notification of events.
<p>
</blockquote><h4>NOTE</h4><blockquote><p>
<p>
This service uses <b><a href="../wtxpcl/wtx.html#WTX_COMMAND_SEND" >WTX_COMMAND_SEND</a></b> request of the WTX protocol.
<p>
</blockquote><h4>RETURN</h4><blockquote><p>
<b>WTX_OK</b> or <b>WTX_ERROR</b> if exchange failed.
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="../wtxpcl/wtx.html#WTX_COMMAND_SEND" >WTX_COMMAND_SEND</a></b>, <b><i><a href="./wtx.html#wtxAsyncNotifyEnable">wtxAsyncNotifyEnable</a></i>(&nbsp;)</b>, <b><i><a href="./wtx.html#wtxAsyncEventGet">wtxAsyncEventGet</a></i>(&nbsp;)</b>

<hr>
<a name="wtxBreakpointAdd"></a>
<p align=right>
<a href="rtnIndex.html"><i>WTX C Library :  Routines</i></a></p>

</blockquote><h1><i>wtxBreakpointAdd</i>(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong><i>wtxBreakpointAdd</i>(&nbsp;)</strong> - create a new WTX eventpoint of type breakpoint</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>UINT32 wtxBreakpointAdd
    (
    HWTX             hWtx,        /* WTX API handle */
    WTX_CONTEXT_TYPE contextType, /* type of context to put bp in */
    WTX_CONTEXT_ID_T contextId,   /* associated context */
    TGT_ADDR_T       tgtAddr      /* breakpoint address */
    )</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine creates a new eventpoint on the target to represent a
breakpoint at the address <i>tgtAddr</i> for the target context <i>contextId</i>.
The target server maintains a list of eventpoints created on the target
and this can be queried using <b><i><a href="./wtx.html#wtxEventpointList">wtxEventpointList</a></i>(&nbsp;)</b>.  When a context is
destroyed on the target or the target is reset, eventpoints are deleted
automatically without intervention from the creator.
<p>
The context types are given by:
<p>
<pre>
typedef enum wtx_context_type		/* types of context */
    {
    WTX_CONTEXT_SYSTEM		= 0,	/* system mode */
    WTX_CONTEXT_GROUP		= 1,	/* process group (not implemented) */
    WTX_CONTEXT_ANY		= 2,	/* any context (not implemented) */
    WTX_CONTEXT_TASK		= 3,	/* specific task or processes */
    WTX_CONTEXT_ANY_TASK	= 4,	/* any task */
    WTX_CONTEXT_ISR		= 5,	/* specific ISR (not implemented) */
    WTX_CONTEXT_ISR_ANY		= 6	/* any ISR (not implemented) */
    } WTX_CONTEXT_TYPE;</pre>

<p>
When <i>contextType</i> is set to <b>WTX_CONTEXT_SYSTEM</b>, then only breakpoints
in system mode can be added. When <i>contextType</i> is set to <b>WTX_CONTEXT_TASK</b>,