UVSC_C.h

Go to the documentation of this file.

/******************************************************************************/
/* This file is part of the uVision/ARM development tools.                    */
/* Copyright (c) 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 __UVSC_C_H__
#define __UVSC_C_H__

#ifdef WIN32
#include <windows.h>
#endif

#include "UVSOCK.h"

#ifdef __cplusplus
  extern "C"  {
#endif

#ifdef WIN32
#ifdef _IN_DLL_
#define _UVSC_FUNC_  extern __declspec(dllexport)
#else
#define _UVSC_FUNC_  extern __declspec(dllimport)
#endif
#else /* #ifdef WIN32 */
#define _UVSC_FUNC_ 
#endif /* #ifdef WIN32 */

#define UVSC_MAX_CLIENTS          10

#define UVSC_MAX_API_STR_SIZE     1024

#define UVSC_PORT_AUTO            0

#define UVSC_MIN_AUTO_PORT        1

#define UVSC_MAX_AUTO_PORT        65535


typedef enum _tag_UVSC_STATUS {
  UVSC_STATUS_SUCCESS             = 0,  
  UVSC_STATUS_FAILED              = 1,  
  UVSC_STATUS_NOT_SUPPORTED       = 2,  
  UVSC_STATUS_NOT_INIT            = 3,  
  UVSC_STATUS_TIMEOUT             = 4,  
  UVSC_STATUS_INVALID_CONTEXT     = 5,  
  UVSC_STATUS_INVALID_PARAM       = 6,  
  UVSC_STATUS_BUFFER_TOO_SMALL    = 7,  
  UVSC_STATUS_CALLBACK_IN_USE     = 8,  
  UVSC_STATUS_COMMAND_ERROR       = 9,  
  UVSC_STATUS_END                       
} UVSC_STATUS;

typedef enum _tag_UVSC_RUNMODE {
  UVSC_RUNMODE_NORMAL             = 0,  
  UVSC_RUNMODE_LABVIEW            = 1,  
  UVSC_RUNMODE_END                = 2,  
} UVSC_RUNMODE;

typedef enum _tag_UVSC_PBAR {
  UVSC_PBAR_INIT                  = 0,  
  UVSC_PBAR_TEXT                  = 1,  
  UVSC_PBAR_POS                   = 2,  
  UVSC_PBAR_STOP                  = 3,  
} UVSC_PBAR;

typedef enum _tag_UVSC_CB_TYPE {
  UVSC_CB_ERROR                   = 0,  
  UVSC_CB_ASYNC_MSG               = 1,  
  UVSC_CB_DISCONNECTED            = 2,  
  UVSC_CB_BUILD_OUTPUT_MSG        = 3,  
  UVSC_CB_PROGRESS_BAR_MSG        = 4   
} UVSC_CB_TYPE;

typedef union _tag_UVSC_CB_DATA {
  UVSOCK_CMD msg;                       
  UVSC_STATUS err;                      
  int iConnHandle;                      
} UVSC_CB_DATA;

typedef void (*uvsc_cb)(void* cb_custom, UVSC_CB_TYPE type, UVSC_CB_DATA *data);

typedef void (*log_cb)(const char* msg, int msgLen);

// Control functions

_UVSC_FUNC_ void UVSC_Version(UINT *pUVSCVersion,
                              UINT *pUVSOCKVersion);

_UVSC_FUNC_ UVSC_STATUS UVSC_Init(int uvMinPort, 
                                      int uvMaxPort);

_UVSC_FUNC_ UVSC_STATUS UVSC_UnInit(void);

_UVSC_FUNC_ UVSC_STATUS UVSC_OpenConnection(char *name, 
                                                int *iConnHandle, 
                                                int *pPort,
                                                char *uvCmd,
                                                UVSC_RUNMODE uvRunmode,                                                
                                                uvsc_cb callback, 
                                                void* cb_custom, 
                                                char *logFileName,
                                                xBOOL logFileAppend, 
                                                log_cb logCallback);

_UVSC_FUNC_ UVSC_STATUS UVSC_CloseConnection(int iConnHandle, xBOOL terminate);

_UVSC_FUNC_ UVSC_STATUS UVSC_ConnHandleFromConnName(char *name, int *iConnHandle);

_UVSC_FUNC_ UVSC_STATUS UVSC_GetLastError(int iConnHandle, UV_OPERATION *msgType, UV_STATUS *status, char *str, int maxStrLen);

_UVSC_FUNC_ UVSC_STATUS UVSC_LogControl (int iConnHandle, xBOOL enableRaw, xBOOL enableTrace);



// Messaging functions

_UVSC_FUNC_ UVSC_STATUS UVSC_GEN_UVSOCK_VERSION(int iConnHandle, UINT *pMajor, UINT *pMinor);

_UVSC_FUNC_ UVSC_STATUS UVSC_GEN_EXT_VERSION(int iConnHandle, EXTVERS *pVersions, UINT *pVersionsLen);

_UVSC_FUNC_ UVSC_STATUS UVSC_GEN_HIDE(int iConnHandle);

_UVSC_FUNC_ UVSC_STATUS UVSC_GEN_SHOW(int iConnHandle);

_UVSC_FUNC_ UVSC_STATUS UVSC_GEN_MAXIMIZE(int iConnHandle);

_UVSC_FUNC_ UVSC_STATUS UVSC_GEN_MINIMIZE(int iConnHandle);

_UVSC_FUNC_ UVSC_STATUS UVSC_GEN_RESTORE(int iConnHandle);

_UVSC_FUNC_ UVSC_STATUS UVSC_GEN_UI_LOCK(int iConnHandle);

_UVSC_FUNC_ UVSC_STATUS UVSC_GEN_UI_UNLOCK(int iConnHandle);

_UVSC_FUNC_ UVSC_STATUS UVSC_GEN_CHECK_LICENSE(int iConnHandle, UVLICINFO *pLicInfo);

_UVSC_FUNC_ UVSC_STATUS UVSC_PRJ_LOAD(int iConnHandle, PRJDATA *pProjectFile, int projectFileLen);

_UVSC_FUNC_ UVSC_STATUS UVSC_PRJ_CLOSE(int iConnHandle);

_UVSC_FUNC_ UVSC_STATUS UVSC_PRJ_ADD_FILE(int iConnHandle, PRJDATA *pGroupFiles, int groupFilesLen);

_UVSC_FUNC_ UVSC_STATUS UVSC_PRJ_DEL_FILE(int iConnHandle, PRJDATA *pGroupFiles, int groupFilesLen);

_UVSC_FUNC_ UVSC_STATUS UVSC_PRJ_ENUM_FILES(int iConnHandle, SSTR *pGroup, int groupLen, SSTR *pFiles, int *pFileIndexes, int *pFileCount);

_UVSC_FUNC_ UVSC_STATUS UVSC_PRJ_ADD_GROUP(int iConnHandle, PRJDATA *pGroups, int groupsLen);

_UVSC_FUNC_ UVSC_STATUS UVSC_PRJ_DEL_GROUP(int iConnHandle, PRJDATA *pGroups, int groupsLen);

_UVSC_FUNC_ UVSC_STATUS UVSC_PRJ_ENUM_GROUPS(int iConnHandle, SSTR *pGroups, int *pGroupIndexes, int *pGroupCount);

_UVSC_FUNC_ UVSC_STATUS UVSC_PRJ_ACTIVE_FILES(int iConnHandle, UINT *pActiveFileCount);

_UVSC_FUNC_ UVSC_STATUS UVSC_PRJ_BUILD(int iConnHandle, xBOOL rebuild);

_UVSC_FUNC_ UVSC_STATUS UVSC_PRJ_BUILD_CANCEL(int iConnHandle);

_UVSC_FUNC_ UVSC_STATUS UVSC_PRJ_CLEAN(int iConnHandle);

_UVSC_FUNC_ UVSC_STATUS UVSC_PRJ_FLASH_DOWNLOAD(int iConnHandle);

_UVSC_FUNC_ UVSC_STATUS UVSC_PRJ_GET_OPTITEM(int iConnHandle, TRNOPT *pTrnOpt, int trnOptLen);

_UVSC_FUNC_ UVSC_STATUS UVSC_PRJ_SET_OPTITEM(int iConnHandle, TRNOPT *pTrnOpt, int trnOptLen);

_UVSC_FUNC_ UVSC_STATUS UVSC_PRJ_GET_DEBUG_TARGET(int iConnHandle, DBGTGTOPT *pDbgTgtOpt);

_UVSC_FUNC_ UVSC_STATUS UVSC_PRJ_SET_DEBUG_TARGET(int iConnHandle, DBGTGTOPT *pDbgTgtOpt);

_UVSC_FUNC_ UVSC_STATUS UVSC_PRJ_CMD_PROGRESS(int iConnHandle, PGRESS *pPgress, int pgressLen);


_UVSC_FUNC_ UVSC_STATUS UVSC_DBG_ENTER(int iConnHandle);

_UVSC_FUNC_ UVSC_STATUS UVSC_DBG_EXIT(int iConnHandle);

_UVSC_FUNC_ UVSC_STATUS UVSC_DBG_START_EXECUTION(int iConnHandle);

_UVSC_FUNC_ UVSC_STATUS UVSC_DBG_STOP_EXECUTION(int iConnHandle);

_UVSC_FUNC_ UVSC_STATUS UVSC_DBG_STATUS(int iConnHandle, int *pStatus);

_UVSC_FUNC_ UVSC_STATUS UVSC_DBG_STEP_HLL(int iConnHandle);

_UVSC_FUNC_ UVSC_STATUS UVSC_DBG_STEP_INSTRUCTION(int iConnHandle);

_UVSC_FUNC_ UVSC_STATUS UVSC_DBG_STEP_INTO(int iConnHandle);

_UVSC_FUNC_ UVSC_STATUS UVSC_DBG_STEP_OUT(int iConnHandle);

_UVSC_FUNC_ UVSC_STATUS UVSC_DBG_RESET(int iConnHandle);

_UVSC_FUNC_ UVSC_STATUS UVSC_DBG_MEM_READ(int iConnHandle, AMEM *pMem, int memLen);

_UVSC_FUNC_ UVSC_STATUS UVSC_DBG_MEM_WRITE(int iConnHandle, AMEM *pMem, int memLen);

_UVSC_FUNC_ UVSC_STATUS UVSC_DBG_CREATE_BP(int iConnHandle, BKPARM *pBkptSet, int bkptSetLen, BKRSP *pBkptRsp, int *pBkptRspLen);

_UVSC_FUNC_ UVSC_STATUS UVSC_DBG_CHANGE_BP(int iConnHandle, BKCHG *pBkptChg, int bkptChgLen, BKRSP *pBkptRsp, int *pBkptRspLen);

_UVSC_FUNC_ UVSC_STATUS UVSC_DBG_ENUMERATE_BP(int iConnHandle, BKRSP *pBkptRsp, int *pBkptIndexes, int *pBkptCount);

_UVSC_FUNC_ UVSC_STATUS UVSC_DBG_SERIAL_GET(int iConnHandle, SERIO *pSerIO, int serIOLen);

_UVSC_FUNC_ UVSC_STATUS UVSC_DBG_SERIAL_PUT(int iConnHandle, SERIO *pSerIO, int serIOLen);

_UVSC_FUNC_ UVSC_STATUS UVSC_DBG_CALC_EXPRESSION(int iConnHandle, VSET *pVSet, int vSetLen);

_UVSC_FUNC_ UVSC_STATUS UVSC_DBG_ENUM_VTR(int iConnHandle, iVTRENUM *piVtrEnum, AVTR *paVTR, int *pVtrIndexes, int *pVtrCount);

_UVSC_FUNC_ UVSC_STATUS UVSC_DBG_VTR_GET(int iConnHandle, VSET *pVSet, int vSetLen);

_UVSC_FUNC_ UVSC_STATUS UVSC_DBG_VTR_SET(int iConnHandle, VSET *pVSet, int vSetLen);

_UVSC_FUNC_ UVSC_STATUS UVSC_DBG_ENUM_STACK(int iConnHandle, iSTKENUM *piStkEnum, STACKENUM *pStackEnum, int *pStackCount);

_UVSC_FUNC_ UVSC_STATUS UVSC_DBG_ADR_TOFILELINE(int iConnHandle, ADRMTFL *pAdrMtfl, AFLMAP *pAflMap, int *pAflMapLen);

_UVSC_FUNC_ UVSC_STATUS UVSC_DBG_ADR_SHOWCODE(int iConnHandle, iSHOWSYNC *piShowSync);

_UVSC_FUNC_ UVSC_STATUS UVSC_DBG_WAKE(int iConnHandle, iINTERVAL *piInterval);

_UVSC_FUNC_ UVSC_STATUS UVSC_DBG_SLEEP(int iConnHandle);


// Build Output Functions

_UVSC_FUNC_ UVSC_STATUS UVSC_GetBuildOutputSize(int iConnHandle, int *pBuildOutputSize);

_UVSC_FUNC_ UVSC_STATUS UVSC_GetBuildOutput(int iConnHandle, char *pBuildOutput, int buildOutputLen);


// Queue functions

_UVSC_FUNC_ UVSC_STATUS UVSC_ReadBuildQ(int iConnHandle, char *pOutputLine, int timeout);

_UVSC_FUNC_ UVSC_STATUS UVSC_ReadPBarQ(int iConnHandle, UVSC_PBAR *pBar, char *pStr, int timeout);

_UVSC_FUNC_ UVSC_STATUS UVSC_ReadAsyncQ(int iConnHandle, int iQueueNo, UVSOCK_CMD *buf, int timeout);

_UVSC_FUNC_ UVSC_STATUS UVSC_FlushAsyncQ(int iConnHandle, int iQueueNo);


// Advanced functions

_UVSC_FUNC_ UVSC_STATUS UVSC_TxRxRaw(int iConnHandle, UVSOCK_CMD *buf);

_UVSC_FUNC_ UVSOCK_CMD *UVSC_CreateMsg (UVSOCK_CMD *buf, UV_OPERATION eCmd, int nLen, const void *pData);




#ifdef __cplusplus
  }
#endif

#endif /* #define __UVSC_C_H__ */

---

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

Generated with doxygen.