UVSOCK.h

Go to the documentation of this file.

/******************************************************************************/
/* This file is part of the uVision/ARM development tools.                    */
/* Copyright (c) 2004-2008 KEIL - An ARM Company. All rights reserved.        */
/* This software may only be used under the terms of a valid, current,        */
/* end user licence from KEIL for a compatible version of KEIL software       */
/* development tools. Nothing else gives you the right to use this software.  */
/******************************************************************************/

#ifndef _UVSOCK_H_
#define _UVSOCK_H_

#define UV3_SOCKIF_VERS   207           

#define SOCK_NDATA  32768              

#define xFALSE      ((xBOOL)0)

#define xTRUE       (!xFALSE)


#ifdef WIN32

typedef unsigned char         xBOOL;   

typedef unsigned char          xUC8;   

typedef unsigned short int  xWORD16;

typedef   signed short int   xINT16;

typedef unsigned __int64       xU64;

typedef   signed __int64       xI64;

#else
 // Other platform type definitions
#endif /* #ifdef WIN32 */

/****************************************************************************/
// Socket-Commmands
/****************************************************************************/

typedef enum {

//---Command codes:
  //--- General functions:
  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,   



  //--- Project functions:
  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,   



  
  //--- Debug functions:
  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,     


//---Answers/Error from uVision to Client:
  UV_CMD_RESPONSE         = 0x3000,   


//---Asynchronous messages:
  UV_ASYNC_MSG            = 0x4000,   


//--- Special Asynchronous messages:
  //--- Project functions:
  UV_PRJ_BUILD_COMPLETE   = 0x5000,   

  UV_PRJ_BUILD_OUTPUT     = 0x5001,   


  //--- Debug functions:
  UV_DBG_CALLBACK         = 0x5002,   

 
  //--- Response to UV_DBG_ENUMERATE_BP:  
  UV_DBG_BP_ENUM_START    = 0x5004,   

  UV_DBG_BP_ENUMERATED    = 0x5005,   

  UV_DBG_BP_ENUM_END      = 0x5006,   


  //--- Response to UV_PRJ_ENUM_GROUPS:
  UV_PRJ_ENUM_GROUPS_START= 0x5007,   

  UV_PRJ_ENUM_GROUPS_ENU  = 0x5008,   

  UV_PRJ_ENUM_GROUPS_END  = 0x5009,   


  //--- Response to UV_PRJ_ENUM_FILES:
  UV_PRJ_ENUM_FILES_START = 0x500A,   

  UV_PRJ_ENUM_FILES_ENU   = 0x500B,   

  UV_PRJ_ENUM_FILES_END   = 0x500C,   


  //--- Progress bar functions
  UV_PRJ_PBAR_INIT        = 0x500D,   

  UV_PRJ_PBAR_STOP        = 0x500E,   

  UV_PRJ_PBAR_SET         = 0x500F,   

  UV_PRJ_PBAR_TEXT        = 0x5010,   


  //--- Response to UV_DBG_ENUM_SYMTP:
  UV_DBG_ENUM_SYMTP_START = 0x5011,   

  UV_DBG_ENUM_SYMTP_ENU   = 0x5012,   

  UV_DBG_ENUM_SYMTP_END   = 0x5013,   


  //--- Response to UV_DBG_ENUM_STACK:
  UV_DBG_ENUM_STACK_START = 0x5014,   

  UV_DBG_ENUM_STACK_ENU   = 0x5015,   

  UV_DBG_ENUM_STACK_END   = 0x5016,   


  //--- Response to UV_DBG_ENUM_VTR:
  UV_DBG_ENUM_VTR_START   = 0x5017,   

  UV_DBG_ENUM_VTR_ENU     = 0x5018,   

  UV_DBG_ENUM_VTR_END     = 0x5019,   


  //--- Real-Time Agent:
  UV_RTA_MESSAGE          = 0x6000,   

  UV_RTA_INCOMPATIBLE     = 0x6001,   

  
//--- Test definititions (for testing only):
  UV_TST_1                = 0xFF00,
  UV_TST_2                = 0xFF01,
  UV_TST_3                = 0xFF02,
  UV_TST_4                = 0xFF03,
  UV_TST_5                = 0xFF04,
  UV_TST_6                = 0xFF05,
  UV_TST_7                = 0xFF06,
  UV_TST_8                = 0xFF07,
  UV_TST_9                = 0xFF08,
  UV_TST_10               = 0xFF09
} UV_OPERATION;

typedef enum _tag_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                       
} UV_STATUS;


typedef 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                   
} VTT_TYPE;


#pragma pack(1)

typedef struct cycts  {
  xU64            cycles;   
  double          tStamp;   
} CYCTS;

typedef struct sstr  {    
  int               nLen;   
  char        szStr[256];   
} SSTR;

typedef struct tval  {
  VTT_TYPE         vType;   
  union  {                 
    unsigned long     ul;   
    signed char       sc;   
    unsigned char     uc;   
    signed short     i16;   
    unsigned short   u16;   
    signed long        l;   
    int                i;   
    xI64             i64;   
    xU64             u64;   
    float              f;   
    double             d;   
  } v;                      
} TVAL;

typedef struct vset_t  {
  TVAL               val;   
  SSTR               str;   
} VSET;

typedef struct amem  {
  xU64             nAddr;   
  UINT            nBytes;   
  xU64           ErrAddr;   
  UINT              nErr;   
  xUC8         aBytes[1];   
} AMEM;

typedef struct serio  {
  xWORD16       nChannel;   
  xWORD16       itemMode;   
  DWORD            nMany;   
  union  {
    xUC8       aBytes[1];   
    xWORD16    aWords[1];   
  } s;                      
} SERIO;
 
typedef struct prjdat  { 
  UINT              nLen;   
  UINT             nCode;   
  char        szNames[1];   
} PRJDATA;

typedef enum uvbuildcodes  {
  UVBUILD_OK          = 1,  
  UVBUILD_OK_WARNINGS = 2,  
  UVBUILD_ERRORS      = 3,  
  UVBUILD_CANCELLED   = 4,  
  UVBUILD_CLEANED     = 5,  
  UVBUILD_CODES_END         
} UVBUILDCODES;

typedef enum bktype  {
  BRKTYPE_EXEC      = 1,    
  BRKTYPE_READ      = 2,    
  BRKTYPE_WRITE     = 3,    
  BRKTYPE_READWRITE = 4,    
  BRKTYPE_COMPLEX   = 5,    
  BRKTYPE_END               
} BKTYPE;

typedef struct bkparm  {
  BKTYPE            type;   
  UINT             count;   
  UINT           accSize;   
  UINT           nExpLen;   
  UINT           nCmdLen;   
  char    szBuffer[1024];   
} BKPARM;

typedef struct bkrsp  {
  BKTYPE           type;    
  UINT            count;    
  UINT          enabled;    
  UINT        nTickMark;    
  xU64         nAddress;    
  UINT          nExpLen;    
  char    szBuffer[512];    
} BKRSP; 

typedef enum chg_type  {
  CHG_KILLBP        = 1,    
  CHG_ENABLEBP      = 2,    
  CHG_DISABLEBP     = 3,    
  CHG_END                   
} CHG_TYPE;

typedef struct bkchg  {
  CHG_TYPE         type;    
  UINT        nTickMark;    
  UINT          nRes[8];    
} BKCHG;

typedef 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                   
} OPTSEL;

typedef struct trnopt  {
  OPTSEL             job;   
  UINT             iTarg;   
  UINT            iGroup;   
  UINT             iFile;   
  UINT             iItem;   
  char       szBuffer[3];   
} TRNOPT;

typedef enum uv_mr  {
  UV_MR_NONE     = 0,       
  UV_MR_ROM      = 1,       
  UV_MR_RAM      = 2,       
  UV_MR_END                 
} UV_MR;

typedef struct uv_mrange  {
  DWORD        mType : 8;   
  DWORD      dfltRam : 1;   
  DWORD      dfltRom : 1;   
  DWORD      isZiRam : 1;   
  DWORD              :21;   
  DWORD          nRes[3];   

  xU64            nStart;   
  xU64             nSize;   
} UV_MRANGE;

typedef struct uv_minfo  {
  UINT           nRanges;   
  UINT           nRes[8];   
  UV_MRANGE           mr;   
} UV_MEMINFO;

typedef struct uvlicinfo  {
  DWORD       rvmdk :  1;   
  DWORD             : 31;   
  DWORD         nRes[10];   
} UVLICINFO;

typedef enum uv_target  {
  UV_TARGET_HW   = 0,       
  UV_TARGET_SIM  = 1,       
  UV_TARGET_END             
} UV_TARGET;

typedef struct dbgtgtopt {
  DWORD      target :  1;   
  DWORD             : 31;   
  DWORD         nRes[10];   
} DBGTGTOPT;

typedef 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           
} PGCMD;

typedef struct pgress  {
  PGCMD              job;   
  UINT              perc;   
  UINT           nRes[8];   
  char        szLabel[1];   
} PGRESS;

typedef struct extvers  {
  UINT            iV_Uv3;   
  UINT           iV_Sock;   
  UINT          nRes[30];   
  char       szBuffer[3];   
} EXTVERS;

typedef enum enTpJob  {
  UV_TPENUM_MEMBERS  =  1,  
  UV_TPENUM_END             
} ENTPJOB;

typedef struct enumtpm  {
  ENTPJOB            Job;   
  UINT             nOffs;   
  UINT             nSize;   
  UINT           nRes[8];   
  char         szID[512];   
} ENUMTPM;

typedef struct adrmtfl  {
  UINT        bFull :  1;   
  UINT              : 31;   
  xU64              nAdr;   
  UINT           nRes[7];   
} ADRMTFL;

typedef struct aflmap  {
  UINT             nLine;   
  xU64              nAdr;   
  UINT             iFile;   
  UINT             iFunc;   
  int            nRes[5];   
  char         szFile[1];   
} AFLMAP;

typedef 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                    
} STOPREASON;

typedef struct bpreason  {
  UINT             nRes1;   
  UINT             nRes2;   
  UINT            StrLen;   
  STOPREASON     eReason;   
  xU64               nPC;   
  xU64              nAdr;   
  int             nBpNum;   
  UINT         nTickMark;   
  UINT           nRes[4];   
} BPREASON;

typedef struct istkenum  {
  UINT        bFull : 1;    
  UINT              :31;    
  UINT          nRes[7];    
} iSTKENUM;

typedef struct stackenum  {
  UINT             nItem;   
  xU64              nAdr;   
  xU64           nRetAdr;   
  UINT           nRes[7];   
} STACKENUM;

typedef struct ivtrenum  {
  UINT        bValue : 1;   
  UINT               :31;   
  UINT           nRes[7];   
} iVTRENUM;

typedef struct avtr  {
  UINT        bValue : 1;   
  UINT       vtrType : 8;   
  UINT        vtrFrq : 1;   
  UINT      vtrClock : 1;   
  UINT         vtrNo :16;   
  UINT               : 5;   

  UINT           nRes[7];   
  TVAL             value;   
  char         szName[1];   
} AVTR;

typedef struct iInterval  {  
  UINT    bAutoStart : 1;   
  UINT       bCycles : 1;   
  UINT  bSetInterval : 1;   
  UINT               :29;   
  float         fSeconds;   
  xI64           iCycles;   
  UINT           nRes[7];   
} iINTERVAL;

typedef struct iShowSync  {
  xU64              nAdr;   
  UINT          bAsm : 1;   
  UINT          bHll : 1;   
  UINT       bAsmRes : 1;   
  UINT       bHllRes : 1;   
  UINT               :28;   
  UINT           nRes[7];   
} iSHOWSYNC;

#pragma pack(1)  // ()

typedef struct _tag_UVSOCK_ERROR_RESPONSE  {
  UINT                   nRes1;    
  UINT                   nRes2;    
  UINT                  StrLen;    
  BYTE     str [SOCK_NDATA-20];    
} UVSOCK_ERROR_RESPONSE;


typedef struct _tag_UVSOCK_CMD_RESPONSE  {
  UV_OPERATION             cmd;    
  UV_STATUS             status;    
  union {
    UVSOCK_ERROR_RESPONSE  err;    
    UINT                  nVal;    
    CYCTS                 time;    
    AMEM                  amem;    
    SERIO               serdat;    
    VSET                  vset;    
    BKRSP                  brk;    
    TRNOPT              trnopt;    
    SSTR                   str;    
    EXTVERS              evers;    
    ENUMTPM                tpm;    
    AFLMAP                aflm;    
    BPREASON             StopR;    
    STACKENUM            stack;    
    AVTR                   vtr;    
    UVLICINFO          licinfo;    
    DBGTGTOPT        dbgtgtopt;    
  };    
} UVSOCK_CMD_RESPONSE;


typedef union _tag_UVSOCK_CMD_DATA {
  BYTE        raw [SOCK_NDATA];    

  // Request message, and / or legacy format asynchronous data  
  PRJDATA              prjdata;    
  AMEM                    amem;    
  SERIO                 serdat;    
  VSET                    vset;    
  TRNOPT                trnopt;    
  SSTR                    sstr;    
  BKPARM                bkparm;    
  BKCHG                  bkchg;    
  DBGTGTOPT          dbgtgtopt;    
  ADRMTFL              adrmtfl;    
  iSHOWSYNC          ishowsync;    
  iVTRENUM            ivtrenum;    

  // Command response, or new format asynchronous message data
  UVSOCK_CMD_RESPONSE   cmdRsp;    

} UVSOCK_CMD_DATA;

typedef struct _tag_UVSOCK_CMD  {
  UINT             m_nTotalLen;    
  UV_OPERATION          m_eCmd;    
  UINT               m_nBufLen;    
  xU64                  cycles;    
  double                tStamp;    
  UINT                    m_Id;    
  UVSOCK_CMD_DATA         data;    
} UVSOCK_CMD;

#pragma pack()


#endif /* #ifndef _UVSOCK_H_ */

---

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

Generated with doxygen.