wdb.pcl

vxworks源码源码解读是学习vxworks的最佳途径

* EXPAND ../../../../../share/src/agents/wdb/wdb.h WDB_MEM_SCAN_DESC
*
* where WDB_MEM_REGION is:
*
* EXPAND ../../../../../share/src/agents/wdb/wdb.h WDB_MEM_REGION
*
* and WDB_MEM_XFER is:
*
* EXPAND ../../../../../share/src/agents/wdb/wdb.h WDB_MEM_XFER
*
* `memRegion' specifies the region of target memory
* to search and `memXfer' specifies the pattern to search for.
* If `numBytes' is greater than 0, search forwards. Otherwise
* a backwards search is performed.
* If `param' is equal to 0, the search tries to match the pattern specified
* by `source'. Otherwise the search continues until the pattern does not
* match.  
*
* The return value is the address at which the match was found.  TGT_ADDR_T
* is a type defined in host.h.
* 
* ERRORS:
* .iP WDB_ERR_MEM_ACCES 
* The target memory cannot be read.
* .iP WDB_ERR_NOT_FOUND 
* The pattern cannot be found.
* .iP "WDB and RPC errors"
* As described in the "REPLY ERRORS" section of the WDB
* man page.
*
*/

TGT_ADDR_T WDB_MEM_SCAN
    (
    WDB_MEM_SCAN_DESC *
    )

    {
    ...
    }

/*************************************************************************
*
* WDB_MEM_WRITE - write the contents of host memory to target memory
*
* This request writes from host memory to target memory.  The source
* is specified by WDB_MEM_XFER:
*
* EXPAND ../../../../../share/src/agents/wdb/wdb.h WDB_MEM_XFER
*
* `source' is set to the address of a memory block
* on the host. `numBytes' indicates the number of
* bytes to transfer.  `destination' points to a
* target address to which the memory contents should be transferred.
*
* ERRORS:
* .iP WDB_ERR_MEM_ACCES 
* The target memory cannot be written.
* .iP "WDB and RPC errors"
* As described in the "REPLY ERRORS" section of the WDB
* man page.
* 
*
*/

(none) WDB_MEM_WRITE
    (
    WDB_MEM_XFER parm
    )

    {
    ...
    }
  


/*************************************************************************
*
* WDB_MODE_GET - get the agent mode
*
* This request gets the agent mode.  The return value can be either:
*
* .iP WDB_MODE_TASK 25
* the agent runs as a task.
* .iP WDB_MODE_EXTERN
* the agent runs in external mode.
* .LP
*
* ERRORS:
* .iP "WDB and RPC errors"
* As described in the "REPLY ERRORS" section of the WDB
* man page.
*
*
*/

UINT32 * WDB_MODE_GET
    (
    (none) *
    )

    {
    ...
    }


/*************************************************************************
*
* WDB_MODE_SET - set the agent mode
*
* This request sets the agent mode.  The input parameter can be either:
*
* .iP WDB_MODE_TASK 25
* the agent runs as a task.
* .iP WDB_MODE_EXTERN
* the agent runs in external mode.
* .LP
*
* The agent can only perform external mode debugging
* if it is communicating using a driver that supports polled mode.
*
* ERRORS:
* .iP WDB_ERR_AGENT_MODE 
* The requested mode is not supported by the agent.
* .iP "WDB and RPC errors"
* As described in the "REPLY ERRORS" section of the WDB
* man page.
*
*
*/

(none) WDB_MODE_SET
    (
    UINT32 parm
    )

    {
    ...
    }

/*************************************************************************
*
* WDB_REGS_GET - get the registers of a context on the target
*
* This routine gets the registers of the context specified 
* by WDB_REG_READ_DESC:
*
* EXPAND ../../../../../share/src/agents/wdb/wdb.h WDB_REG_READ_DESC
*
* where WDB_CTX is:
*
* EXPAND ../../../../../share/src/agents/wdb/wdb.h WDB_CTX
*
* If `contextType' is WDB_CTX_SYSTEM the routine gets
* the VxWorks registers at the time the system-mode agent last stopped
* the system. (This only makes sense if you are doing external-mode
* debugging.)  Otherwise the routine gets
* the registers of task `contextId'.  `regSetType' determines the 
* type of registers to get as specified by:
*
* EXPAND ../../../../../share/src/agents/wdb/wdb.h WDB_REG_SET_TYPE
*
* Currently supported register sets include:
* .iP WDB_REG_SET_IU 25
* integer unit register
* .iP WDB_REG_SET_FPU 
* floating point unit register set
* .LP
*
* The return structure WDB_MEM_XFER is:
* 
* EXPAND ../../../../../share/src/agents/wdb/wdb.h WDB_MEM_XFER
*
* `source' must point to a buffer on the host into which the contents of the
* register set can be copied.  The register set is treated by the agent as
* an opaque block of memory; the bits are transferred with no swapping or
* other changes.  The actual structure of the block is determined by the
* VxWorks data structures REG_SET and FPREG_SET.  `memRegion' specifies the
* region within the block of memory to upload.
*
* ERRORS: 
* .iP WDB_ERR_INVALID_PARAMS 
* The register-set type is unsupported.
* .iP WDB_ERR_NO_RT_PROC 
* The agent does not support this service.
* .iP "WDB and RPC errors"
* As described in the "REPLY ERRORS" section of the WDB
* man page.
* 
*
*/

WDB_MEM_XFER WDB_REGS_GET
    (
    WDB_REG_READ_DESC *
    )

    {
    ...
    }

/*************************************************************************
*
* WDB_REGS_SET - set the registers of a context on the target
*
* This routine sets the registers of the context specified
* by WDB_REG_READ_DESC:
*
* EXPAND ../../../../../share/src/agents/wdb/wdb.h WDB_REG_READ_DESC
*
* where WDB_CTX is:
*
* EXPAND ../../../../../share/src/agents/wdb/wdb.h WDB_CTX
*
* If `contextType' is WDB_CTX_SYSTEM the routine sets
* the VxWorks registers at the time the system-mode agent last stopped
* the system. (This only makes sense if you are doing external mode
* debugging.)  Otherwise the routine sets
* the registers of task `contextId'.  `regSetType' determines the
* type of registers to set as specified by:
*
* EXPAND ../../../../../share/src/agents/wdb/wdb.h WDB_REG_SET_TYPE
*
* Currently supported register sets include:
* .iP WDB_REG_SET_IU 25
* integer unit register
* .iP WDB_REG_SET_FPU 
* floating point unit register set
* .LP
*
* The return structure WDB_MEM_XFER is:
*
* EXPAND ../../../../../share/src/agents/wdb/wdb.h WDB_MEM_XFER
*
* The actual structure of the block is determined by the VxWorks data
* structures REG_SET and FPREG_SET.  The `memXfer' field of WDB_REG_WRITE_DESC
* specifies where in the block to copy the data.  The register set is
* treated by the agent as an opaque block of memory.  `source' specifies a
* host buffer, which is copied exactly with no swapping or other changes.
* `numBytes' specifies the number of bytes of data to transfer.
* `destination' specifies the byte offset within the register block to copy
* to. This mechanism allows one to set all the registers at once or just a
* few registers at a time.
*
* ERRORS:
* .iP WDB_ERR_INVALID_PARAMS 
* The register-set type is unsupported.
* .iP WDB_ERR_NO_RT_PROC 
* The agent does not support this service.
* .iP "WDB and RPC errors"
* As described in the "REPLY ERRORS" section of the WDB
* man page.
* 
*
*/

(none) WDB_REGS_SET
    (
    WDB_REG_WRITE_DESC *
    )

    {
    ...
    }

/*************************************************************************
*
* WDB_TARGET_CONNECT - connect the target server to the target agent
*
* This routine connects the target server to the target agent.  Any
* server can connect to the agent, but the agent only accepts requests
* from the last-connected host.  For more details on connecting to the agent,
* see the section "REQUESTS SENT TO THE AGENT".
* 
* ERRORS:
* .iP "WDB and RPC errors"
* As described in the "REPLY ERRORS" section of the WDB
* man page.
*
*
*/

WDB_TGT_INFO * WDB_TARGET_CONNECT 
    (
    (none) *
    )

    {
    ...
    }

/**************************************************************************
* 
* WDB_TARGET_DISCONNECT - disconnect the target server from the target agent
* 
* This request disconnects the target server from the target agent.
*
* ERRORS:
* .iP "WDB and RPC errors"
* As described in the "REPLY ERRORS" section of the WDB
* man page.
*
*/

(none) * WDB_TARGET_DISCONNECT
    (
    (none) *
    )

    {
    ...
    }


/*************************************************************************
*
* WDB_TARGET_PING - probe the target
*
* This request tests the connection to the target.
* 
* ERRORS:
* .iP "WDB and RPC errors"
* As described in the "REPLY ERRORS" section of the WDB
* man page.
*
*
*/

(none) * WDB_TARGET_PING 
    (
    (none) *
    )
   
    {
    ...
    }

/*************************************************************************
*
* WDB_VIO_WRITE - write data to a virtual I/O channel
*
* This routine writes data from the host to a virtual I/O channel on the
* target.  The input parameters are supplied in WDB_MEM_XFER:
*
* EXPAND ../../../../../share/src/agents/wdb/wdb.h WDB_MEM_XFER
*
* `source' and `numBytes' specify the block
* of memory to write to the target.
* `destination' is a virtual I/O channel number.
* The routine returns the number of bytes actually transferred (which
* could be less than `numBytes' if the VIO input buffer on the target is full).
* See the man page for wdbVioDrv
* for details on how to open a VIO channel on the target.
*
* NOTE: There is no WDB_VIO_READ routine. VIO data transferred 
* from the target to the host is uploaded as an asynchronous event 
* (with WDB_EVENT_GET).
*
* ERRORS: 
* .iP WDB_ERR_INVALID_VIO_CHANNEL 
* There is no such virtual I/O channel open on the target. 
* .iP "WDB and RPC errors"
* As described in the "REPLY ERRORS" section of the WDB
* man page.
* 
*
*/

UINT32 WDB_VIO_WRITE
    (
    WDB_MEM_XFER *
    )

    {
    ...
    }