UVSOCK.h File Reference

UVSOCK Interface. More...

Go to the source code of this file.

Data Structures

struct  CYCTS
 Cycles and Time data. More...
struct  SSTR
 String data. More...
struct  TVAL
 Virtual Register (VTR) value. More...
struct  VSET
 Virtual Register (VTR) data / Expression to calculate. More...
struct  AMEM
 Memory Read / Write data. More...
struct  SERIO
 Terminal I/O data. More...
struct  PRJDATA
 Multiple string data. More...
struct  BKPARM
 Breakpoint parameter data (new). More...
struct  BKRSP
 Breakpoint parameter data (existing). More...
struct  BKCHG
 Breakpoint change data. More...
struct  TRNOPT
 Project option data. More...
struct  UV_MRANGE
 Individual memory range data. More...
struct  UV_MEMINFO
 Memory ranges data. More...
struct  UVLICINFO
 Licensing data. More...
struct  DBGTGTOPT
 Target debugging data. More...
struct  PGRESS
 uVision Progress bar control data More...
struct  EXTVERS
 Extended version data. More...
struct  ENUMTPM
 Symbol enumeration data. More...
struct  ADRMTFL
 Map address to file / line request data. More...
struct  AFLMAP
 Map address to file / line return data. More...
struct  BPREASON
 Breakpoint reason data. More...
struct  iSTKENUM
 Stack enumeration request data. More...
struct  STACKENUM
 Stack enumeration return data. More...
struct  iVTRENUM
 Virtual register (VTR) enumeration request data. More...
struct  AVTR
 Virtual register (VTR) enumeration return data. More...
struct  iINTERVAL
 Wake interval data. More...
struct  iSHOWSYNC
 Show code in uVision request data. More...
struct  UVSOCK_ERROR_RESPONSE
 Error response data. More...
struct  UVSOCK_CMD_RESPONSE
 UVSOCK Command response / async message data format. More...
union  UVSOCK_CMD_DATA
 UVSOCK message data format. More...
struct  UVSOCK_CMD
 UVSOCK message format. More...

Defines

#define UV3_SOCKIF_VERS   207
 UVSOCK API version number.
#define SOCK_NDATA   32768
 Maximum transfer size of a single UVSOCK packet (bytes).
#define xFALSE   ((xBOOL)0)
 Boolean false.
#define xTRUE   (!xFALSE)
 Boolean true.

Enumerations

enum  UV_OPERATION {
  UV_NULL_CMD = 0x0000, UV_GEN_GET_VERSION = 0x0001, UV_GEN_UI_UNLOCK = 0x0002, UV_GEN_UI_LOCK = 0x0003,
  UV_GEN_HIDE = 0x0004, UV_GEN_SHOW = 0x0005, UV_GEN_RESTORE = 0x0006, UV_GEN_MINIMIZE = 0x0007,
  UV_GEN_MAXIMIZE = 0x0008, UV_GEN_EXIT = 0x0009, UV_GEN_GET_EXTVERSION = 0x000A, UV_GEN_CHECK_LICENSE = 0x000B,
  UV_GEN_CPLX_COMPLETE = 0x000C, UV_PRJ_LOAD = 0x1000, UV_PRJ_CLOSE = 0x1001, UV_PRJ_ADD_GROUP = 0x1002,
  UV_PRJ_DEL_GROUP = 0x1003, UV_PRJ_ADD_FILE = 0x1004, UV_PRJ_DEL_FILE = 0x1005, UV_PRJ_BUILD = 0x1006,
  UV_PRJ_REBUILD = 0x1007, UV_PRJ_CLEAN = 0x1008, UV_PRJ_BUILD_CANCEL = 0x1009, UV_PRJ_FLASH_DOWNLOAD = 0x100A,
  UV_PRJ_GET_DEBUG_TARGET = 0x100B, UV_PRJ_SET_DEBUG_TARGET = 0x100C, UV_PRJ_GET_OPTITEM = 0x100D, UV_PRJ_SET_OPTITEM = 0x100E,
  UV_PRJ_ENUM_GROUPS = 0x100F, UV_PRJ_ENUM_FILES = 0x1010, UV_PRJ_CMD_PROGRESS = 0x1011, UV_PRJ_ACTIVE_FILES = 0x1012,
  UV_PRJ_FLASH_ERASE = 0x1013, UV_DBG_ENTER = 0x2000, UV_DBG_EXIT = 0x2001, UV_DBG_START_EXECUTION = 0x2002,
  UV_DBG_STOP_EXECUTION = 0x2003, UV_DBG_STATUS = 0x2004, UV_DBG_RESET = 0x2005, UV_DBG_STEP_HLL = 0x2006,
  UV_DBG_STEP_INTO = 0x2007, UV_DBG_STEP_INSTRUCTION = 0x2008, UV_DBG_STEP_OUT = 0x2009, UV_DBG_CALC_EXPRESSION = 0x200A,
  UV_DBG_MEM_READ = 0x200B, UV_DBG_MEM_WRITE = 0x200C, UV_DBG_TIME_INFO = 0x200D, UV_DBG_SET_CALLBACK = 0x200E,
  UV_DBG_VTR_GET = 0x200F, UV_DBG_VTR_SET = 0x2010, UV_DBG_SERIAL_GET = 0x2011, UV_DBG_SERIAL_PUT = 0x2012,
  UV_DBG_VERIFY_CODE = 0x2013, UV_DBG_CREATE_BP = 0x2014, UV_DBG_ENUMERATE_BP = 0x2015, UV_DBG_CHANGE_BP = 0x2016,
  UV_DBG_ENUM_SYMTP = 0x2017, UV_DBG_ADR_TOFILELINE = 0x2018, UV_DBG_ENUM_STACK = 0x2019, UV_DBG_ENUM_VTR = 0x201A,
  UV_DBG_UNUSED = 0x201B, UV_DBG_ADR_SHOWCODE = 0x201C, UV_DBG_WAKE = 0x201D, UV_DBG_SLEEP = 0x201E,
  UV_MSGBOX_MSG = 0x201F, UV_CMD_RESPONSE = 0x3000, UV_ASYNC_MSG = 0x4000, UV_PRJ_BUILD_COMPLETE = 0x5000,
  UV_PRJ_BUILD_OUTPUT = 0x5001, UV_DBG_CALLBACK = 0x5002, UV_DBG_BP_ENUM_START = 0x5004, UV_DBG_BP_ENUMERATED = 0x5005,
  UV_DBG_BP_ENUM_END = 0x5006, UV_PRJ_ENUM_GROUPS_START = 0x5007, UV_PRJ_ENUM_GROUPS_ENU = 0x5008, UV_PRJ_ENUM_GROUPS_END = 0x5009,
  UV_PRJ_ENUM_FILES_START = 0x500A, UV_PRJ_ENUM_FILES_ENU = 0x500B, UV_PRJ_ENUM_FILES_END = 0x500C, UV_PRJ_PBAR_INIT = 0x500D,
  UV_PRJ_PBAR_STOP = 0x500E, UV_PRJ_PBAR_SET = 0x500F, UV_PRJ_PBAR_TEXT = 0x5010, UV_DBG_ENUM_SYMTP_START = 0x5011,
  UV_DBG_ENUM_SYMTP_ENU = 0x5012, UV_DBG_ENUM_SYMTP_END = 0x5013, UV_DBG_ENUM_STACK_START = 0x5014, UV_DBG_ENUM_STACK_ENU = 0x5015,
  UV_DBG_ENUM_STACK_END = 0x5016, UV_DBG_ENUM_VTR_START = 0x5017, UV_DBG_ENUM_VTR_ENU = 0x5018, UV_DBG_ENUM_VTR_END = 0x5019,
  UV_RTA_MESSAGE = 0x6000, UV_RTA_INCOMPATIBLE = 0x6001
}
 UVSOCK command codes. More...
enum  UV_STATUS {
  UV_STATUS_SUCCESS = 0, UV_STATUS_FAILED = 1, UV_STATUS_NO_PROJECT = 2, UV_STATUS_WRITE_PROTECTED = 3,
  UV_STATUS_NO_TARGET = 4, UV_STATUS_NO_TOOLSET = 5, UV_STATUS_NOT_DEBUGGING = 6, UV_STATUS_ALREADY_PRESENT = 7,
  UV_STATUS_INVALID_NAME = 8, UV_STATUS_NOT_FOUND = 9, UV_STATUS_DEBUGGING = 10, UV_STATUS_TARGET_EXECUTING = 11,
  UV_STATUS_TARGET_STOPPED = 12, UV_STATUS_PARSE_ERROR = 13, UV_STATUS_OUT_OF_RANGE = 14, UV_STATUS_BP_CANCELLED = 15,
  UV_STATUS_BP_BADADDRESS = 16, UV_STATUS_BP_NOTSUPPORTED = 17, UV_STATUS_BP_FAILED = 18, UV_STATUS_BP_REDEFINED = 19,
  UV_STATUS_BP_DISABLED = 20, UV_STATUS_BP_ENABLED = 21, UV_STATUS_BP_CREATED = 22, UV_STATUS_BP_DELETED = 23,
  UV_STATUS_BP_NOTFOUND = 24, UV_STATUS_BUILD_OK_WARNINGS = 25, UV_STATUS_BUILD_FAILED = 26, UV_STATUS_BUILD_CANCELLED = 27,
  UV_STATUS_NOT_SUPPORTED = 28, UV_STATUS_TIMEOUT = 29, UV_STATUS_UNEXPECTED_MSG = 30, UV_STATUS_VERIFY_FAILED = 31,
  UV_STATUS_NO_ADRMAP = 32, UV_STATUS_INFO = 33, UV_STATUS_NO_MEM_ACCESS = 34, UV_STATUS_FLASH_DOWNLOAD = 35,
  UV_STATUS_BUILDING = 36, UV_STATUS_HARDWARE = 37, UV_STATUS_SIMULATOR = 38, UV_STATUS_BUFFER_TOO_SMALL = 39,
  UV_STATUS_END
}
 UVSOCK status codes. More...
enum  VTT_TYPE {
  VTT_void = 0, VTT_bit = 1, VTT_char = 2, VTT_uchar = 3,
  VTT_int = 4, VTT_uint = 5, VTT_short = 6, VTT_ushort = 7,
  VTT_long = 8, VTT_ulong = 9, VTT_float = 10, VTT_double = 11,
  VTT_ptr = 12, VTT_union = 13, VTT_struct = 14, VTT_func = 15,
  VTT_string = 16, VTT_enum = 17, VTT_field = 18, VTT_int64 = 19,
  VTT_uint64 = 20, VTT_end
}
 Variant-Types used in TVAL. More...
enum  UVBUILDCODES {
  UVBUILD_OK = 1, UVBUILD_OK_WARNINGS = 2, UVBUILD_ERRORS = 3, UVBUILD_CANCELLED = 4,
  UVBUILD_CLEANED = 5, UVBUILD_CODES_END
}
 Build Completion Codes. More...
enum  BKTYPE {
  BRKTYPE_EXEC = 1, BRKTYPE_READ = 2, BRKTYPE_WRITE = 3, BRKTYPE_READWRITE = 4,
  BRKTYPE_COMPLEX = 5, BRKTYPE_END
}
 Breakpoint type definition. More...
enum  CHG_TYPE { CHG_KILLBP = 1, CHG_ENABLEBP = 2, CHG_DISABLEBP = 3, CHG_END }
 Breakpoint change operation definition. More...
enum  OPTSEL {
  OPT_LMISC = 1, OPT_CMISC = 2, OPT_AMISC = 3, OPT_CINCL = 4,
  OPT_AINCL = 5, OPT_CDEF = 6, OPT_ADEF = 7, OPT_CUNDEF = 8,
  OPT_AUNDEF = 9, OPT_COPTIMIZE = 10, OPT_CODEGEN = 11, OPT_MEMRANGES = 12,
  OPT_ASNMEMRANGES = 13, OPT_END
}
 Project option type definition. More...
enum  UV_MR { UV_MR_NONE = 0, UV_MR_ROM = 1, UV_MR_RAM = 2, UV_MR_END }
 Memory range type definition. More...
enum  UV_TARGET { UV_TARGET_HW = 0, UV_TARGET_SIM = 1, UV_TARGET_END }
 Debug target type definition. More...
enum  PGCMD {
  UV_PROGRESS_INIT = 1, UV_PROGRESS_SETPOS = 2, UV_PROGRESS_CLOSE = 3, UV_PROGRESS_INITTXT = 4,
  UV_PROGRESS_SETTEXT = 5, UV_PROGRESS_END
}
 uVision Progress bar control type definition More...
enum  ENTPJOB { UV_TPENUM_MEMBERS = 1, UV_TPENUM_END }
 Symbol enumeration type definition. More...
enum  STOPREASON {
  STOPREASON_UNDEFINED = 0x0000, STOPREASON_EXEC = 0x0001, STOPREASON_READ = 0x0002, STOPREASON_HIT_WRITE = 0x0004,
  STOPREASON_HIT_COND = 0x0008, STOPREASON_HIT_ESC = 0x0010, STOPREASON_HIT_VIOLA = 0x0020, STOPREASON_TIME_OVER = 0x0040,
  STOPREASON_UNDEFINS = 0x0080, STOPREASON_PABT = 0x0100, STOPREASON_DABT = 0x0200, STOPREASON_NONALIGN = 0x0400,
  STOPREASON_END
}
 Stop reason definition. More...

Detailed Description

UVSOCK Interface.

Version:
V2.07
API for uVision 3 UVSOCK socket interface.

General API Rules

Version History

Author, Date, Version

Change Log

Version 2.00:

Version 2.01: Version 2.02: Version 2.03: Version 2.04: Version 2.05: Version 2.06: Version 2.07:

Definition in file UVSOCK.h.

Define Documentation

#define SOCK_NDATA   32768

Maximum transfer size of a single UVSOCK packet (bytes).

No UVSOCK packet may be larger than SOCK_NDATA bytes. This includes both the packet header and packet data.

Definition at line 85 of file UVSOCK.h.

#define UV3_SOCKIF_VERS   207

UVSOCK API version number.

This number is converted to an X.YY version number by the following formula: 

 X.YY = UV3_SOCKIF_VERS / 100

For example: 

 UV3_SOCKIF_VERS = 201 ==> V2.01

Definition at line 79 of file UVSOCK.h.

#define xFALSE   ((xBOOL)0)

Boolean false.

Value of false for the xBOOL data type

Definition at line 91 of file UVSOCK.h.

#define xTRUE   (!xFALSE)

Boolean true.

Value of true for the xBOOL data type

Definition at line 97 of file UVSOCK.h.

Enumeration Type Documentation

enum BKTYPE

Breakpoint type definition.

Defines the possible types of breakpoints in uVision.

Enumerator:
BRKTYPE_EXEC  Execution Breakpoint.
BRKTYPE_READ  Read Access Breakpoint.
BRKTYPE_WRITE  Write Access Breakpoint.
BRKTYPE_READWRITE  ReadWrite Access Breakpoint.
BRKTYPE_COMPLEX  Complex Breakpoint (Expression Breakpoint).
BRKTYPE_END  Always at end.

Definition at line 723 of file UVSOCK.h.

enum CHG_TYPE

Breakpoint change operation definition.

Indicates the type of change to make to a breakpoint in the BKCHG structure

Enumerator:
CHG_KILLBP  Delete breakpoint.
CHG_ENABLEBP  Enable breakpoint.
CHG_DISABLEBP  Disable breakpoint.
CHG_END  Always at end.

Definition at line 776 of file UVSOCK.h.

enum ENTPJOB

Symbol enumeration type definition.

Identifies the type of symbol enumeration to perform.

Enumerator:
UV_TPENUM_MEMBERS  Enumerate symbols' structure members: name, offset, size.
UV_TPENUM_END  Always at end.

Definition at line 1002 of file UVSOCK.h.

enum OPTSEL

Project option type definition.

Identifies the type of uVision project option to get or set in the UV_PRJ_GET_OPTITEM and UV_PRJ_SET_OPTITEM commands

Enumerator:
OPT_LMISC  Link-Misc string (valid for Target only).
OPT_CMISC  C-Misc string.
OPT_AMISC  Asm-Misc string.
OPT_CINCL  C-Include-path string.
OPT_AINCL  Asm-Include-path string.
OPT_CDEF  C-Defines string.
OPT_ADEF  Asm-Defines string.
OPT_CUNDEF  C-Undefines (valid for Group- and File-level only).
OPT_AUNDEF  Unused: Asm-Undefines, non-existant in uVision.
OPT_COPTIMIZE  C optimization options [Level, Time].
OPT_CODEGEN  ARM/Thumb mode for ARM7TDMI targets.
OPT_MEMRANGES  Memory ranges available to be assigned.
OPT_ASNMEMRANGES  Assigned memory ranges at specified level.
OPT_END  Always at end.

Definition at line 803 of file UVSOCK.h.

enum PGCMD

uVision Progress bar control type definition

Indicates the type of uVision progress bar operation to perform.

Enumerator:
UV_PROGRESS_INIT  Initialize progress bar with optional label (in -mode).
UV_PROGRESS_SETPOS  Set progress bar percentage (0...100).
UV_PROGRESS_CLOSE  Close the progress bar.
UV_PROGRESS_INITTXT  Initialize progress bar (in text mode).
UV_PROGRESS_SETTEXT  Set inside bar text in text mode.
UV_PROGRESS_END  Always at end.

Definition at line 955 of file UVSOCK.h.

enum STOPREASON

Stop reason definition.

Indicates the reason that target / simulation execution has stopped.

Enumerator:
STOPREASON_UNDEFINED  Unknown / undefined stop reason.
STOPREASON_EXEC  Hit execution breakpoint.
STOPREASON_READ  Hit read access breakpoint.
STOPREASON_HIT_WRITE  Hit write access breakpoint.
STOPREASON_HIT_COND  Hit conditional breakpoint.
STOPREASON_HIT_ESC  ESCape key has been pressed.
STOPREASON_HIT_VIOLA  Memory access violation occurred (simulator only).
STOPREASON_TIME_OVER  Interval time set by UV_DBG_SET_CALLBACK or UV_DBG_WAKE elapsed.
STOPREASON_UNDEFINS  Undefined instruction occurred.
STOPREASON_PABT  (Instruction) prefetch abort occurred
STOPREASON_DABT  Data abort occurred.
STOPREASON_NONALIGN  Non-aligned access occurred (simulator only).
STOPREASON_END  Always at end.

Definition at line 1068 of file UVSOCK.h.

enum UV_MR

Memory range type definition.

Indicates the type of memory range defined in a UV_MRANGE structure.

Enumerator:
UV_MR_NONE  Memory range is not set within uVision.
UV_MR_ROM  Memory range is ROM.
UV_MR_RAM  Memory range is RAM.
UV_MR_END  Always at end.

Definition at line 864 of file UVSOCK.h.

enum UV_OPERATION

UVSOCK command codes.

Each request, response and asynchronous message has a unique command code. The response to a message will contain the same command code as the request in its UVSOCK_CMD_RESPONSE structure.

Enumerator:
UV_NULL_CMD  Not a command. A message containing this code should be ignored.
UV_GEN_GET_VERSION  Get the UVSOCK interface version number.

UV_GEN_UI_UNLOCK  Enable message boxes and user input in uVision.

UV_GEN_UI_LOCK  Disable message boxes and user input in uVision.

UV_GEN_HIDE  Completely hide the uVision window.

UV_GEN_SHOW  Show the uVision window (bringing it to the front if it is behind other windows).

UV_GEN_RESTORE  Restore the uVision window.

UV_GEN_MINIMIZE  Minimise the uVision window.

UV_GEN_MAXIMIZE  Maximise the uVision window.

UV_GEN_EXIT  Exit uVision.

UV_GEN_GET_EXTVERSION  Get extended version number information for uVision (in ASCII format).

UV_GEN_CHECK_LICENSE  Check toolchain licensing.

UV_GEN_CPLX_COMPLETE  Complex command has completed.

UV_PRJ_LOAD  Load a uVision project.

UV_PRJ_CLOSE  Close the currently loaded uVision project.

UV_PRJ_ADD_GROUP  Add one or more groups to the current project.

UV_PRJ_DEL_GROUP  Remove one or more groups from the current project.

UV_PRJ_ADD_FILE  Add one or more files to a group in the current project.

UV_PRJ_DEL_FILE  Remove one or more files from a group in the current project.

UV_PRJ_BUILD  Build the current project.

UV_PRJ_REBUILD  Rebuild the current project.

UV_PRJ_CLEAN  Clean current project.

UV_PRJ_BUILD_CANCEL  Stop a currently progressing build / rebuild.

UV_PRJ_FLASH_DOWNLOAD  Download the built binary to flash.

UV_PRJ_GET_DEBUG_TARGET  Get the currently configured debug target.

UV_PRJ_SET_DEBUG_TARGET  Set the currently configured debug target.

UV_PRJ_GET_OPTITEM  Get an option item for the current project.

UV_PRJ_SET_OPTITEM  Set an option item for the current project.

UV_PRJ_ENUM_GROUPS  Enumerate the groups of the current project.

UV_PRJ_ENUM_FILES  Enumerate the files of a given group in the current project.

UV_PRJ_CMD_PROGRESS  Control the uVision UI progress bar.

UV_PRJ_ACTIVE_FILES  Get number of active files for the current project (i.e.

how many files would be built on a rebuild)

UV_PRJ_FLASH_ERASE  Erase flash device.

UV_DBG_ENTER  Start the debugger.

UV_DBG_EXIT  Stop the debugger.

UV_DBG_START_EXECUTION  Start target execution.

UV_DBG_STOP_EXECUTION  Stop target execution.

UV_DBG_STATUS  Check if the target / simulation is running.

UV_DBG_RESET  Reset the target / simulation.

UV_DBG_STEP_HLL  Step one line of HLL code(High Level Language code, eg C).

UV_DBG_STEP_INTO  Step into HLL code(High Level Language code, eg C) or step one ASM instruction.

UV_DBG_STEP_INSTRUCTION  Step one ASM Instruction.

UV_DBG_STEP_OUT  Step out of the current function.

UV_DBG_CALC_EXPRESSION  Calculate the value of an expression.

UV_DBG_MEM_READ  Read memory.

UV_DBG_MEM_WRITE  Write memory.

UV_DBG_TIME_INFO  Get the current simulation cycles and time-stamp (NOTE: This information is also available in every UVSOCK message) [SIMULATOR ONLY].

UV_DBG_SET_CALLBACK  Set a time-interval for callback [SIMULATOR ONLY].

UV_DBG_VTR_GET  Read a Virtual Register (VTR) value.

UV_DBG_VTR_SET  Write a Virtual Register (VTR) value.

UV_DBG_SERIAL_GET  Read serial output from a uVision serial window.

UV_DBG_SERIAL_PUT  Write serial output to a uVision serial window.

UV_DBG_VERIFY_CODE  Verify the code in flash against built binary.

UV_DBG_CREATE_BP  Create a new breakpoint.

UV_DBG_ENUMERATE_BP  Enumerate all currently defined breakpoints.

UV_DBG_CHANGE_BP  Enable, disable or delete an existing breakpoint.

UV_DBG_ENUM_SYMTP  Enumerate the struct members of a variable, i.e.

the member size and packing

UV_DBG_ADR_TOFILELINE  Map an address to code file & linenumber.

UV_DBG_ENUM_STACK  Enumerate the call stack.

UV_DBG_ENUM_VTR  Enumerate all virtual registers (VTRs).

UV_DBG_UNUSED  Unused.
UV_DBG_ADR_SHOWCODE  Show disassembly and/or HLL (High Level Language) file for an address.

UV_DBG_WAKE  Set sleep callback and/or wake up simulation [SIMULATOR ONLY].

UV_DBG_SLEEP  Sleep the simulation [SIMULATOR ONLY].

UV_MSGBOX_MSG  Notification of a UV message box.

UV_CMD_RESPONSE  Response to a command from the client (the UVSOCK_CMD_RESPONSE structure will contain the command code to which this is a response).

UV_ASYNC_MSG  Asynchronous message from uVision (the UVSOCK_CMD_RESPONSE structure will contain the relevant command code).

UV_PRJ_BUILD_COMPLETE  Notification of build completion.

UV_PRJ_BUILD_OUTPUT  Notification of a line of build output.

UV_DBG_CALLBACK  Notification of expiration of the callback timeout set by UV_DBG_SET_CALLBACK.

UV_DBG_BP_ENUM_START  Start of breakpoint enumeration (no breakpoint info).

  • Async format : no data
UV_DBG_BP_ENUMERATED  Breakpoint enumeration; zero, one or more Response(s) with breakpoint info.

UV_DBG_BP_ENUM_END  End of breakpoint enumeration (no breakpoint info).

  • Async format : no data
UV_PRJ_ENUM_GROUPS_START  Start of group enumeration.

  • Async format : no data
UV_PRJ_ENUM_GROUPS_ENU  Group enumeration; zero, one or more Responses with group name.

UV_PRJ_ENUM_GROUPS_END  End of group enumeration.

  • Async format : no data
UV_PRJ_ENUM_FILES_START  Start of files enumeration.

  • Async format : no data
UV_PRJ_ENUM_FILES_ENU  File enumeration; zero, one or more Response(s) with file name.

UV_PRJ_ENUM_FILES_END  End of files enumeration.

  • Async format : no data
UV_PRJ_PBAR_INIT  Notification of progress bar initialisation.

UV_PRJ_PBAR_STOP  Notification of progress bar stopping.

UV_PRJ_PBAR_SET  Notification of progress bar position change.

UV_PRJ_PBAR_TEXT  Notification of progress bar text change.

UV_DBG_ENUM_SYMTP_START  Start of structure member enumeration.

  • Async format : no data
UV_DBG_ENUM_SYMTP_ENU  Structure member enumeration; zero, one or more Responses with member information.

UV_DBG_ENUM_SYMTP_END  End of structure member enumeration.

  • Async format : no data
UV_DBG_ENUM_STACK_START  Start of stack enumeration.

  • Async format : no data
UV_DBG_ENUM_STACK_ENU  Stack enumeration; one or more Response(s) with stack frame information.

UV_DBG_ENUM_STACK_END  End of stack enumeration.

  • Async format : no data
UV_DBG_ENUM_VTR_START  Start of vtr enumeration.

  • Async format : no data
UV_DBG_ENUM_VTR_ENU  Vtr enumeration; one or more Response(s) of structure.

UV_DBG_ENUM_VTR_END  End of vtr enumeration.

  • Async format : no data
UV_RTA_MESSAGE  Notification of a Real-Time Agent message from the target.

UV_RTA_INCOMPATIBLE  Notification of an incompatible Real-Time Agent in the current target.

Definition at line 152 of file UVSOCK.h.

enum UV_STATUS

UVSOCK status codes.

UVSOCK status codes are returned in UV_CMD_RESPONSE and UV_ASYNC_MSG messages from uVision to the client. They represent the result of the operation relating to the UVSOCK command code in the same message. If the code is not UV_STATUS_SUCCESS, it will be accompanied by an error string.

Enumerator:
UV_STATUS_SUCCESS  Operation successful: No error.
UV_STATUS_FAILED  Operation failed: Generic / unknown error.
UV_STATUS_NO_PROJECT  Operation failed: No project is currently open.
UV_STATUS_WRITE_PROTECTED  Operation failed: The current project is write protected.
UV_STATUS_NO_TARGET  Operation failed: No target is selected for the current project.
UV_STATUS_NO_TOOLSET  Operation failed: No toolset is selected for the current target.
UV_STATUS_NOT_DEBUGGING  Operation failed: The debugger is not running, this operation is only possible in debug mode.
UV_STATUS_ALREADY_PRESENT  Operation failed: The group / file is already present in the current project.
UV_STATUS_INVALID_NAME  Operation failed: One of the specified group / file / project name(s) is invalid.
UV_STATUS_NOT_FOUND  Operation failed: File / group not found in the current project.
UV_STATUS_DEBUGGING  Operation failed: The debugger is running, this operation is only possible when not in debug mode.
UV_STATUS_TARGET_EXECUTING  Operation failed: The target is executing, this operation is not possible when target is executing.
UV_STATUS_TARGET_STOPPED  Operation failed: The target is stopped, this operation is not possible when target is stopped.
UV_STATUS_PARSE_ERROR  Operation failed: Error parsing data in request.
UV_STATUS_OUT_OF_RANGE  Operation failed: Data in request is out of range.
UV_STATUS_BP_CANCELLED  Operation failed: Create new breakpoint has been cancelled.
UV_STATUS_BP_BADADDRESS  Operation failed: Invalid address in create breakpoint.
UV_STATUS_BP_NOTSUPPORTED  Operation failed: Type of breakpoint is not supported (by target).
UV_STATUS_BP_FAILED  Operation failed: Breakpoint creation failed (syntax error, nested command etc.).
UV_STATUS_BP_REDEFINED  Breakpoint Info: A breakpoint has been redefined.
UV_STATUS_BP_DISABLED  Breakpoint Info: A breakpoint has been disabled.
UV_STATUS_BP_ENABLED  Breakpoint Info: A breakpoint has been enabled.
UV_STATUS_BP_CREATED  Breakpoint Info: A breakpoint has been created.
UV_STATUS_BP_DELETED  Breakpoint Info: A breakpoint has been deleted.
UV_STATUS_BP_NOTFOUND  Operation failed: Breakpoint with nTickMark cookie not found.
UV_STATUS_BUILD_OK_WARNINGS  Build Info: A build was successful, but with warnings.
UV_STATUS_BUILD_FAILED  Build Info: A build failed with errors.
UV_STATUS_BUILD_CANCELLED  Build Info: A build was cancelled.
UV_STATUS_NOT_SUPPORTED  Operation failed: Requested operation is not supported.
UV_STATUS_TIMEOUT  Operation failed: No response to the request occurred within the timeout period (UVSOCK Client DLL only).
UV_STATUS_UNEXPECTED_MSG  Operation failed: An unexpected message type was returned (UVSOCK Client DLL only).
UV_STATUS_VERIFY_FAILED  Operation failed: The code downloaded in the target differs from the current binary.
UV_STATUS_NO_ADRMAP  Operation failed: The specified code address does not map to a file / line.
UV_STATUS_INFO  General Info: This is an information only message. It may contain warning information pertinent to a later error condition.
UV_STATUS_NO_MEM_ACCESS  Operation failed: Memory access is blocked (most likely target does not support memory access while running).
UV_STATUS_FLASH_DOWNLOAD  Operation failed: The target is downloading FLASH, this operation is not possible when FLASH is downloading.
UV_STATUS_BUILDING  Operation failed: A build is in progress, this operation is not possible when build is in progress.
UV_STATUS_HARDWARE  Operation failed: The debugger is debugging hardware, this operation is not possible when debugging a hardware target.
UV_STATUS_SIMULATOR  Operation failed: The debugger is debugging a simulation, this operation not possible when debugging a simulated target.
UV_STATUS_BUFFER_TOO_SMALL  Operation failed: Return buffer was too small (UVSOCK Client DLL only).
UV_STATUS_END  Always at end.

Definition at line 467 of file UVSOCK.h.

enum UV_TARGET

Debug target type definition.

Indicates how uVision will debug the target when debug mode is entered.

Enumerator:
UV_TARGET_HW  Target will be debugged using the specified hardware debugger.
UV_TARGET_SIM  Target will be debugged using the uVision simulator.
UV_TARGET_END  Always at end.

Definition at line 926 of file UVSOCK.h.

enum UVBUILDCODES

Build Completion Codes.

The build completetion codes indicate the completion status of a uVision build.

Enumerator:
UVBUILD_OK  Build was Ok - no errors and warnings.
UVBUILD_OK_WARNINGS  Build was Ok - with warnings.
UVBUILD_ERRORS  Build failed - with error(s).
UVBUILD_CANCELLED  Build was stopped/cancelled.
UVBUILD_CLEANED  Project clean was completed.
UVBUILD_CODES_END  Always at end.

Definition at line 710 of file UVSOCK.h.

enum VTT_TYPE

Variant-Types used in TVAL.

Gives the type of the corresponding data in a TVAL structure.

Enumerator:
VTT_void  Unused.
VTT_bit  val.ul & 1
VTT_char  val.sc
VTT_uchar  val.uc
VTT_int  val.i
VTT_uint  val.ul
VTT_short  val.i16
VTT_ushort  val.u16
VTT_long  val.l
VTT_ulong  val.ul
VTT_float  val.f
VTT_double  val.d
VTT_ptr  val.ul
VTT_union  Unused.
VTT_struct  Unused.
VTT_func  Unused.
VTT_string  Unused.
VTT_enum  Unused.
VTT_field  Unused.
VTT_int64  val.i64
VTT_uint64  val.u64
VTT_end  Always at end.

Definition at line 524 of file UVSOCK.h.

Copyright (c) KEIL - An ARM Company.
All rights reserved.
Visit our web site at www.keil.com.

Generated with doxygen.