rdi_hif.h

realview22.rar

/*
 * ARM RDI : rdi_hif.h
 * Copyright (C) 1998 Advanced RISC Machines Ltd. All rights reserved.
 * Description of the RDI_HostosInterface structure.
 */

/*
 * RCS $Revision: 1.10.4.1.20.1 $
 * Checkin $Date: 2002/05/09 15:53:02 $
 * Revising $Author: gevans $
 */

#ifndef rdi_hif_h
#define rdi_hif_h

#include "host.h"

#if defined(__STDC__) || defined(ANSI) || defined (__cplusplus) \
 || defined(_WIN32)
#  include <stdarg.h>
#else
#  include <varargs.h>
#endif


#if defined(__cplusplus) && !defined(CLX_CPP_LINKAGE)
extern "C" {
#endif

/*
 * Definition: RDI_HIF_BLOCKSIZE
 *    Purpose: The maximum number of bytes that should be passed in a call
 *             to RDI_Hif_Write.
 */
#define RDI_HIF_BLOCKSIZE 4096


typedef struct RDI_Hif_DbgArgStr RDI_Hif_DbgArg;
typedef void RDI_Hif_DbgPrint(
    RDI_Hif_DbgArg *arg, const char *format, va_list ap);
typedef void RDI_Hif_DbgPause(RDI_Hif_DbgArg *arg);

typedef struct RDI_Hif_HostosArgStr RDI_Hif_HostosArg;
typedef void RDI_Hif_WriteC(RDI_Hif_HostosArg *arg, int c);
typedef int RDI_Hif_ReadC(RDI_Hif_HostosArg *arg);
typedef int RDI_Hif_Write(RDI_Hif_HostosArg *arg, char const *buffer, int len);
  /* RDI_Hif_Write: BEWARE that in RDI spec, len should be the length
     *including* nul-termination and that buffer should always be
     nul-terminated.  Both these things are wrong.  It need not be
     nul-terminated and len is the number of characters to write. */

typedef char *RDI_Hif_GetS(RDI_Hif_HostosArg *arg, char *buffer, int len);
typedef struct RDI_Hif_ResetArgStr RDI_Hif_ResetArg;
typedef void RDI_Hif_ResetProc(RDI_Hif_ResetArg *arg);

/*
 * Added for RDI 1.51
 */
#if RDI_VERSION == 151

#define RDI_MB_OK               0
#define RDI_MB_OKCANCEL         1
#define RDI_MB_YESNO            2
#define RDI_MB_YESNOCANCEL      3
#define RDI_MB_RETRYCANCEL      4
#define RDI_MB_ABORTRETRYIGNORE 5
#define RDI_MB_STATUS           6 /* No response required; agent scope only.
                                   * Maximum string length 32 chars - see spec
                                   */

#define RDI_MBICON_EXCLAMATION  0x100
#define RDI_MBICON_INFORMATION  0x200
#define RDI_MBICON_QUESTION     0x300
#define RDI_MBICON_STOP         0x400

typedef enum
{
    RDI_MBANSWER_OK,
    RDI_MBANSWER_CANCEL,
    RDI_MBANSWER_YES,
    RDI_MBANSWER_NO,
    RDI_MBANSWER_ABORT,
    RDI_MBANSWER_RETRY,
    RDI_MBANSWER_IGNORE
} RDI_Hif_UserMessageReturn;

typedef struct RDI_Hif_UserMessageArg RDI_Hif_UserMessageArg;
typedef RDI_Hif_UserMessageReturn RDI_Hif_UserMessageProc(
    RDI_Hif_UserMessageArg *arg, char const *msg, uint32 type);
#endif

struct RDI_HostosInterface {
    RDI_Hif_DbgPrint *dbgprint;
    RDI_Hif_DbgPause *dbgpause;
    RDI_Hif_DbgArg *dbgarg;

    RDI_Hif_WriteC *writec;
    RDI_Hif_ReadC *readc;
    RDI_Hif_Write *write;
    RDI_Hif_GetS *gets;
    RDI_Hif_HostosArg *hostosarg;

    RDI_Hif_ResetProc *reset;
    RDI_Hif_ResetArg *resetarg;

#if RDI_VERSION == 151    
    RDI_Hif_UserMessageProc *message;
    RDI_Hif_UserMessageArg  *messagearg;
#endif
};

#if defined(__cplusplus) && !defined(CLX_CPP_LINKAGE)
}
#endif


#endif