Memory.h

Go to the documentation of this file.

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

#ifndef TEMU_MEMORY_IF_H
#define TEMU_MEMORY_IF_H

#include "temu-c/Support/Objsys.h"

#include <stdint.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef enum temu_MemoryKind {
  teMK_RAM,
  teMK_ROM,
  teMK_MMIO,
} temu_MemoryKind;

// Memory transaction flags
#define TEMU_MT_CACHEABLE         1
#define TEMU_MT_BYPASS_CACHE     (1 << 1)
#define TEMU_MT_FORCE_CACHE_MISS (1 << 2)
typedef struct temu_MemTransaction {
  uint64_t Va;      
  uint64_t Pa;      

  uint64_t Value;

  uint8_t Size;

  uint64_t Offset;
  void *Initiator;
  void *Page;
  uint64_t Cycles; 

  uint32_t Flags; 
} temu_MemTransaction;

typedef struct temu_MemAccessIface {
  void (*fetch)(void *Obj, temu_MemTransaction *Mt);

  void (*read)(void *Obj, temu_MemTransaction *Mt);

  void (*write)(void *Obj, temu_MemTransaction *Mt);
} temu_MemAccessIface;

TEMU_IFACE_REFERENCE_TYPE(temu_MemAccess);


typedef struct temu_MemoryIface {
  int (*readBytes)(void *Obj, void *Dest, uint64_t Offs, uint32_t Size, int Swap);
  int (*writeBytes)(void *Obj, uint64_t Offs, uint32_t Size, const void *Src, int Swap);
} temu_MemoryIface;

TEMU_IFACE_REFERENCE_TYPE(temu_Memory);



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 struct temu_MemoryMapIface {
  void (*map)(void *Obj, uint64_t Addr, uint64_t Len, temu_MemoryKind Type)
     __attribute__((deprecated));
  void (*mapDevice)(void *Obj, uint64_t Addr, uint64_t Len, void *Device)
    __attribute__((deprecated));
  void (*setAttribute)(void *Obj, uint64_t Addr, uint64_t Len, temu_MemoryAttr Attr)
    __attribute__((deprecated));
  void (*clearAttribute)(void *Obj, uint64_t Addr, uint64_t Len,
                         temu_MemoryAttr Attr)
    __attribute__((deprecated));
  void (*clearAttributes)(void *Obj, uint64_t Addr, uint64_t Len)
    __attribute__((deprecated));
} temu_MemoryMapIface;


TEMU_IFACE_REFERENCE_TYPE(temu_MemoryMap);

void
temu_mapMemorySpace(void *Obj, uint64_t Addr, uint64_t Len, void *MemObj);




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


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

#ifdef __cplusplus
}
#endif

#endif /* ! TEMU_MEMORY_IF_H */