Memory.h

Go to the documentation of this file.

//===-- temu-c/Memory.h - Memory Helpers ------------------------*- C++ -*-===//
//
// T-EMU: The Terma Emulator
// (c) Terma 2015-2016
// Authors: Mattias Holm <maho (at) terma.com>
//
//===----------------------------------------------------------------------===//


#ifndef TEMU_SUPPORT_MEMORY
#define TEMU_SUPPORT_MEMORY

#include <stdint.h>
#include "temu-c/Support/Attributes.h"
#include "temu-c/Support/Objsys.h"

#ifdef __cplusplus
extern "C" {
#endif


  typedef enum {
    teMA_Break      = 1,      
    teMA_WatchRead  = 1 << 1, 
    teMA_WatchWrite = 1 << 2, 
    teMA_Upset      = 1 << 3, 
    teMA_Faulty     = 1 << 4, 
    teMA_User1      = 1 << 5, 
    teMA_User2      = 1 << 6, 
    teMA_User3      = 1 << 7, 
  } temu_MemoryAttr;

typedef uint8_t temu_MemoryAttrs;


// Private interface, this is not stable yet
typedef struct temu_MemorySpaceIface {
  int (*mapDevice)(void *Obj, uint64_t Addr, uint64_t Len, void *Device,
                   uint32_t Flags);
  void (*setAttr)(void *Obj, uint64_t Addr, uint64_t Len, temu_MemoryAttr Attr);
  void (*clearAttr)(void *Obj, uint64_t Addr, uint64_t Len, temu_MemoryAttr Attr);
  temu_MemoryAttrs (*getAttrs)(void *Obj, uint64_t Addr);

  int (*mapDeviceWithNamedIface)(void *Obj, uint64_t Addr, uint64_t Len, void *Device, const char *IfaceName,
                                 uint32_t Flags);
  int (*unmapRange)(void *Obj, uint64_t Addr, uint64_t Len);
} temu_MemorySpaceIface;

TEMU_IFACE_REFERENCE_TYPE(temu_MemorySpace);
#define TEMU_MEMORY_SPACE_IFACE_TYPE "MemorySpaceIface"

// Private interface, do not use directly
typedef struct {
  void* (*getPDC)(void *Obj, uint64_t Addr);
  void (*allocPDC)(void *Obj, uint64_t Addr);
  void (*disposePDC)(void *Obj, uint64_t Addr);
  void (*writePDC)(void *Obj, uint64_t Addr, void *Inst);
  void (*clearPDC)(void *Obj, uint64_t Addr);
} temu_PDCIface;
TEMU_IFACE_REFERENCE_TYPE(temu_PDC);
#define TEMU_PDC_IFACE_TYPE "PDCIface"


TEMU_API int temu_memoryRead(void *mem, uint8_t *buff, uint64_t addr, uint32_t size,
                    int swap);

TEMU_API int temu_memoryWrite(void *mem, uint64_t addr, uint8_t *buff, uint32_t size,
                              int swap);

TEMU_API int temu_memoryMap(void *Obj, uint64_t Addr, uint64_t Len, void *MemObj,
                            uint32_t Flags);


TEMU_API int temu_memoryMapNamedIface(void *Obj, uint64_t Addr, uint64_t Len, void *MemObj, const char *IfaceName,
                                      uint32_t Flags);

TEMU_API void temu_memorySetAttr(void *Obj, uint64_t Addr, uint64_t Len, temu_MemoryAttr Attr);

TEMU_API void temu_memoryClearAttr(void *Obj, uint64_t Addr, uint64_t Len, temu_MemoryAttr Attr);

TEMU_API temu_MemoryAttrs temu_memoryGetAttrs(void *Obj, uint64_t Addr);

TEMU_API int temu_memoryReadPhys32(void *Obj, uint64_t Addr, uint32_t *Word);

TEMU_API int temu_memoryWritePhys32(void *Obj, uint64_t Addr, uint32_t Word);

TEMU_API uint32_t temu_normaliseWrite32(uint32_t OldVal, uint32_t NewVal,
                                        int Sz, int Off);

TEMU_API uint32_t temu_normaliseRead32(uint32_t Value, int Sz, int Off);


TEMU_API uint16_t temu_normaliseRead16(uint16_t Value, int Sz, int Off);


TEMU_API uint16_t temu_normaliseWrite16(uint16_t OldVal, uint16_t NewVal,
                                        int Sz, int Off);



#ifdef __cplusplus
}
#endif

#endif /* ! TEMU_SUPPORT_MEMORY */