OpenCores
URL https://opencores.org/ocsvn/openrisc/openrisc/trunk

Subversion Repositories openrisc

[/] [openrisc/] [trunk/] [or1ksim/] [sim-config.h] - Diff between revs 224 and 235

Go to most recent revision | Only display areas with differences | Details | Blame | View Log

Rev 224 Rev 235
/* sim-config.h -- Simulator configuration header file
/* sim-config.h -- Simulator configuration header file
 
 
   Copyright (C) 1999 Damjan Lampret, lampret@opencores.org
   Copyright (C) 1999 Damjan Lampret, lampret@opencores.org
   Copyright (C) 2008 Embecosm Limited
   Copyright (C) 2008 Embecosm Limited
 
 
   Contributor Jeremy Bennett <jeremy.bennett@embecosm.com>
   Contributor Jeremy Bennett <jeremy.bennett@embecosm.com>
 
 
   This file is part of OpenRISC 1000 Architectural Simulator.
   This file is part of OpenRISC 1000 Architectural Simulator.
 
 
   This program is free software; you can redistribute it and/or modify it
   This program is free software; you can redistribute it and/or modify it
   under the terms of the GNU General Public License as published by the Free
   under the terms of the GNU General Public License as published by the Free
   Software Foundation; either version 3 of the License, or (at your option)
   Software Foundation; either version 3 of the License, or (at your option)
   any later version.
   any later version.
 
 
   This program is distributed in the hope that it will be useful, but WITHOUT
   This program is distributed in the hope that it will be useful, but WITHOUT
   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
   more details.
   more details.
 
 
   You should have received a copy of the GNU General Public License along
   You should have received a copy of the GNU General Public License along
   with this program.  If not, see <http://www.gnu.org/licenses/>. */
   with this program.  If not, see <http://www.gnu.org/licenses/>. */
 
 
/* This program is commented throughout in a fashion suitable for processing
/* This program is commented throughout in a fashion suitable for processing
   with Doxygen. */
   with Doxygen. */
 
 
 
 
#ifndef SIM_CONFIG_H
#ifndef SIM_CONFIG_H
#define SIM_CONFIG_H
#define SIM_CONFIG_H
 
 
/* System includes */
/* System includes */
#include <stdio.h>
#include <stdio.h>
 
 
/* Package includes */
/* Package includes */
#include "arch.h"
#include "arch.h"
 
 
/* Simulator configuration macros. Eventually this one will be a lot bigger. */
/* Simulator configuration macros. Eventually this one will be a lot bigger. */
 
 
#define MAX_SBUF_LEN     256    /* Max. length of store buffer */
#define MAX_SBUF_LEN     256    /* Max. length of store buffer */
 
 
#define EXE_LOG_HARDWARE   0    /* Print out RTL states */
#define EXE_LOG_HARDWARE   0    /* Print out RTL states */
#define EXE_LOG_SIMPLE     1    /* Executed log prints out dissasembly */
#define EXE_LOG_SIMPLE     1    /* Executed log prints out dissasembly */
#define EXE_LOG_SOFTWARE   2    /* Simple with some register output */
#define EXE_LOG_SOFTWARE   2    /* Simple with some register output */
 
 
#define STR_SIZE         256
#define STR_SIZE         256
 
 
/* Number of cycles between checks to runtime.sim.iprompt */
/* Number of cycles between checks to runtime.sim.iprompt */
#define CHECK_INT_TIME 100000
#define CHECK_INT_TIME 100000
 
 
/* Print to the defined output stream */
/* Print to the defined output stream */
#define PRINTF(x...) fprintf (runtime.sim.fout, x)
#define PRINTF(x...) fprintf (runtime.sim.fout, x)
 
 
/* Print only if we are not running silently */
/* Print only if we are not running silently */
#define PRINTFQ(x...) if (!config.sim.quiet) { fprintf (runtime.sim.fout, x); }
#define PRINTFQ(x...) if (!config.sim.quiet) { fprintf (runtime.sim.fout, x); }
 
 
/*! Data structure for configuration data */
/*! Data structure for configuration data */
struct config
struct config
{
{
  struct
  struct
  {                             /* External linkage for SystemC */
  {                             /* External linkage for SystemC */
    void  *class_ptr;
    void  *class_ptr;
    int  (*read_up) (void              *class_ptr,
    int  (*read_up) (void              *class_ptr,
                     unsigned long int  addr,
                     unsigned long int  addr,
                     unsigned char      mask[],
                     unsigned char      mask[],
                     unsigned char      rdata[],
                     unsigned char      rdata[],
                     int                data_len);
                     int                data_len);
    int  (*write_up) (void              *class_ptr,
    int  (*write_up) (void              *class_ptr,
                      unsigned long int  addr,
                      unsigned long int  addr,
                      unsigned char      mask[],
                      unsigned char      mask[],
                      unsigned char      wdata[],
                      unsigned char      wdata[],
                      int                data_len);
                      int                data_len);
  } ext;
  } ext;
 
 
  struct
  struct
  {
  {
    int is_library;             /* Library operation */
    int is_library;             /* Library operation */
    int debug;                  /* Simulator debugging */
    int debug;                  /* Simulator debugging */
    int verbose;                /* Force verbose output */
    int verbose;                /* Force verbose output */
 
 
    int profile;                /* Is profiler running */
    int profile;                /* Is profiler running */
    char *prof_fn;              /* Profiler filename */
    char *prof_fn;              /* Profiler filename */
 
 
    int mprofile;               /* Is memory profiler running */
    int mprofile;               /* Is memory profiler running */
    char *mprof_fn;             /* Memory profiler filename */
    char *mprof_fn;             /* Memory profiler filename */
 
 
    int history;                /* instruction stream history analysis */
    int history;                /* instruction stream history analysis */
    int exe_log;                /* Print out RTL states? */
    int exe_log;                /* Print out RTL states? */
    int exe_log_type;           /* Type of log */
    int exe_log_type;           /* Type of log */
    long long int exe_log_start;        /* First instruction to log */
    long long int exe_log_start;        /* First instruction to log */
    long long int exe_log_end;  /* Last instr to log, -1 if continuous */
    long long int exe_log_end;  /* Last instr to log, -1 if continuous */
    int exe_log_marker;         /* If nonzero, place markers before */
    int exe_log_marker;         /* If nonzero, place markers before */
    /* each exe_log_marker instructions */
    /* each exe_log_marker instructions */
    char *exe_log_fn;           /* RTL state comparison filename */
    char *exe_log_fn;           /* RTL state comparison filename */
    int exe_bin_insn_log;       /* Binary dump log of exec. instructions */
    int exe_bin_insn_log;       /* Binary dump log of exec. instructions */
    char* exe_bin_insn_log_fn;  /* Binary dump log of exec. instructions name */
    char* exe_bin_insn_log_fn;  /* Binary dump log of exec. instructions name */
    long clkcycle_ps;           /* Clock duration in ps */
    long clkcycle_ps;           /* Clock duration in ps */
    int strict_npc;             /* JPB. NPC flushes pipeline when changed */
    int strict_npc;             /* JPB. NPC flushes pipeline when changed */
    int  quiet;                 /* Minimize message output */
    int  quiet;                 /* Minimize message output */
    int  report_mem_errs;       /* Report out of memory accesses */
    int  report_mem_errs;       /* Report out of memory accesses */
  } sim;
  } sim;
 
 
  struct
  struct
  {                             /* Verification API */
  {                             /* Verification API */
    int enabled;                /* Whether is VAPI module enabled */
    int enabled;                /* Whether is VAPI module enabled */
    int server_port;            /* user specified port for services */
    int server_port;            /* user specified port for services */
    int log_enabled;            /* Whether to log the vapi requests */
    int log_enabled;            /* Whether to log the vapi requests */
    int hide_device_id;         /* Whether to log dev ID each request */
    int hide_device_id;         /* Whether to log dev ID each request */
    char *vapi_fn;              /* vapi log filename */
    char *vapi_fn;              /* vapi log filename */
  } vapi;
  } vapi;
 
 
  struct
  struct
  {
  {
    char *timings_fn;           /* Filename of the timing table */
    char *timings_fn;           /* Filename of the timing table */
    int memory_order;           /* Memory access stricness */
    int memory_order;           /* Memory access stricness */
    int calling_convention;     /* Do funcs follow std calling conv? */
    int calling_convention;     /* Do funcs follow std calling conv? */
    int enable_bursts;          /* Whether burst are enabled */
    int enable_bursts;          /* Whether burst are enabled */
    int no_multicycle;          /* Generate no multicycle paths */
    int no_multicycle;          /* Generate no multicycle paths */
  } cuc;
  } cuc;
 
 
  struct
  struct
  {
  {
    int superscalar;            /* superscalara analysis */
    int superscalar;            /* superscalara analysis */
    int hazards;                /* dependency hazards analysis */
    int hazards;                /* dependency hazards analysis */
    int dependstats;            /* dependency statistics */
    int dependstats;            /* dependency statistics */
    int sbuf_len;               /* length of store buffer, 0=disabled */
    int sbuf_len;               /* length of store buffer, 0=disabled */
    int hardfloat;      /* whether hardfloat is enabled */
    int hardfloat;      /* whether hardfloat is enabled */
  } cpu;
  } cpu;
 
 
  struct
  struct
  {
  {
    int enabled;                /* Whether data cache is enabled */
    int enabled;                /* Whether data cache is enabled */
    int nways;                  /* Number of DC ways */
    int nways;                  /* Number of DC ways */
    int nsets;                  /* Number of DC sets */
    int nsets;                  /* Number of DC sets */
    int blocksize;              /* DC entry size */
    int blocksize;              /* DC entry size */
    int ustates;                /* number of DC usage states */
    int ustates;                /* number of DC usage states */
    int store_missdelay;        /* cycles a store miss costs */
    int store_missdelay;        /* cycles a store miss costs */
    int store_hitdelay;         /* cycles a store hit costs */
    int store_hitdelay;         /* cycles a store hit costs */
    int load_missdelay;         /* cycles a load miss costs */
    int load_missdelay;         /* cycles a load miss costs */
    int load_hitdelay;          /* cycles a load hit costs */
    int load_hitdelay;          /* cycles a load hit costs */
  } dc;
  } dc;
 
 
  struct pic
  struct pic
  {
  {
    int enabled;                /* Is interrupt controller enabled? */
    int enabled;                /* Is interrupt controller enabled? */
    int edge_trigger;           /* Are interrupts edge triggered? */
    int edge_trigger;           /* Are interrupts edge triggered? */
  } pic;
  } pic;
 
 
  struct
  struct
  {
  {
    int enabled;                /* Is power management operational? */
    int enabled;                /* Is power management operational? */
  } pm;
  } pm;
 
 
  struct
  struct
  {
  {
    int enabled;                /* branch prediction buffer analysis */
    int enabled;                /* branch prediction buffer analysis */
    int sbp_bnf_fwd;            /* Static BP for l.bnf uses fwd predn */
    int sbp_bnf_fwd;            /* Static BP for l.bnf uses fwd predn */
    int sbp_bf_fwd;             /* Static BP for l.bf uses fwd predn */
    int sbp_bf_fwd;             /* Static BP for l.bf uses fwd predn */
    int btic;                   /* BP target insn cache analysis */
    int btic;                   /* BP target insn cache analysis */
    int missdelay;              /* How much cycles does the miss cost */
    int missdelay;              /* How much cycles does the miss cost */
    int hitdelay;               /* How much cycles does the hit cost */
    int hitdelay;               /* How much cycles does the hit cost */
  } bpb;
  } bpb;
 
 
  struct
  struct
  {
  {
    int enabled;                /* Is debug module enabled */
    int enabled;                /* Is debug module enabled */
    int gdb_enabled;            /* Is legacy debugging with GDB possible */
 
    int rsp_enabled;            /* Is RSP debugging with GDB possible */
    int rsp_enabled;            /* Is RSP debugging with GDB possible */
    int server_port;            /* Port for legacy GDB connection */
 
    int rsp_port;               /* Port for RSP GDB connection */
    int rsp_port;               /* Port for RSP GDB connection */
    unsigned long vapi_id;      /* "Fake" vapi dev id for JTAG proxy */
    unsigned long vapi_id;      /* "Fake" vapi dev id for JTAG proxy */
    long int  jtagcycle_ps;     /* JTAG clock duration in ps */
    long int  jtagcycle_ps;     /* JTAG clock duration in ps */
  } debug;
  } debug;
};
};
 
 
/*! Data structure for run time data */
/*! Data structure for run time data */
struct runtime
struct runtime
{
{
  struct
  struct
  {
  {
    FILE *fprof;                /* Profiler file */
    FILE *fprof;                /* Profiler file */
    FILE *fmprof;               /* Memory profiler file */
    FILE *fmprof;               /* Memory profiler file */
    FILE *fexe_log;             /* RTL state comparison file */
    FILE *fexe_log;             /* RTL state comparison file */
    FILE *fexe_bin_insn_log;    /* Binary instruction dump/log file */
    FILE *fexe_bin_insn_log;    /* Binary instruction dump/log file */
    FILE *fout;                 /* file for standard output */
    FILE *fout;                 /* file for standard output */
    char *filename;             /* Original Command Simulator file (CZ) */
    char *filename;             /* Original Command Simulator file (CZ) */
    int iprompt;                /* Interactive prompt */
    int iprompt;                /* Interactive prompt */
    int iprompt_run;            /* Interactive prompt is running */
    int iprompt_run;            /* Interactive prompt is running */
    long long cycles;           /* Cycles counts fetch stages */
    long long cycles;           /* Cycles counts fetch stages */
    long long int end_cycles;   /* JPB. Cycles to end of quantum */
    long long int end_cycles;   /* JPB. Cycles to end of quantum */
    double time_point;          /* JPB. Time point in the simulation */
    double time_point;          /* JPB. Time point in the simulation */
    unsigned long int ext_int_set;      /* JPB. External interrupts to set */
    unsigned long int ext_int_set;      /* JPB. External interrupts to set */
    unsigned long int ext_int_clr;      /* DXL. External interrupts ti clear */
    unsigned long int ext_int_clr;      /* DXL. External interrupts ti clear */
 
 
    int mem_cycles;             /* Each cycle has counter of mem_cycles;
    int mem_cycles;             /* Each cycle has counter of mem_cycles;
                                   this value is joined with cycles
                                   this value is joined with cycles
                                   at the end of the cycle; no sim
                                   at the end of the cycle; no sim
                                   originated memory accesses should be
                                   originated memory accesses should be
                                   performed inbetween. */
                                   performed inbetween. */
    int loadcycles;             /* Load and store stalls */
    int loadcycles;             /* Load and store stalls */
    int storecycles;
    int storecycles;
 
 
    long long reset_cycles;
    long long reset_cycles;
 
 
    int  hush;                  /* Is simulator to do reg dumps */
    int  hush;                  /* Is simulator to do reg dumps */
  } sim;
  } sim;
 
 
  struct
  struct
  {
  {
    unsigned int  instr;        /* Current JTAG instruction */
    unsigned int  instr;        /* Current JTAG instruction */
    unsigned long int  mod_id;  /* Currently selected module */
    unsigned long int  mod_id;  /* Currently selected module */
    int  write_defined_p;       /* WRITE_COMMAND has set details for GO */
    int  write_defined_p;       /* WRITE_COMMAND has set details for GO */
    unsigned char  acc_type;    /* Access type for GO */
    unsigned char  acc_type;    /* Access type for GO */
    unsigned long int  addr;    /* Address to read/write for GO */
    unsigned long int  addr;    /* Address to read/write for GO */
    unsigned long int  size;    /* Num bytes to read/write (up to 2^16) */
    unsigned long int  size;    /* Num bytes to read/write (up to 2^16) */
  } debug;
  } debug;
 
 
  struct
  struct
  {
  {
    long long instructions;     /* Instructions executed */
    long long instructions;     /* Instructions executed */
    long long reset_instructions;
    long long reset_instructions;
 
 
    int stalled;
    int stalled;
    int halted;                 /* When library hits exit. */
    int halted;                 /* When library hits exit. */
    int hazardwait;             /* how many cycles were wasted because of hazards */
    int hazardwait;             /* how many cycles were wasted because of hazards */
    int supercycles;            /* Superscalar cycles */
    int supercycles;            /* Superscalar cycles */
  } cpu;
  } cpu;
 
 
  struct
  struct
  {                             /* Verification API, part of Advanced Core Verification */
  {                             /* Verification API, part of Adv Core Verif */
    int enabled;                /* Whether is VAPI module enabled */
    int enabled;                /* Whether is VAPI module enabled */
    FILE *vapi_file;            /* vapi file */
    FILE *vapi_file;            /* vapi file */
    int server_port;            /* A user specified port number for services */
    int server_port;            /* A user specified port number for services */
  } vapi;
  } vapi;
 
 
/* CUC configuration parameters */
/* CUC configuration parameters */
  struct
  struct
  {
  {
    int mdelay[4];              /* average memory delays in cycles
    int mdelay[4];              /* average memory delays in cycles
                                   {read single, read burst, write single, write burst} */
                                   {read single, read burst, write single, write burst} */
    double cycle_duration;      /* in ns */
    double cycle_duration;      /* in ns */
  } cuc;
  } cuc;
};
};
 
 
/*! Union of all possible paramter values */
/*! Union of all possible paramter values */
union param_val
union param_val
{
{
  char          *str_val;
  char          *str_val;
  int            int_val;
  int            int_val;
  long long int  longlong_val;
  long long int  longlong_val;
  oraddr_t       addr_val;
  oraddr_t       addr_val;
};
};
 
 
/*! Enum of all possible paramter types */
/*! Enum of all possible paramter types */
enum param_t
enum param_t
{
{
  PARAMT_NONE = 0,               /* No parameter */
  PARAMT_NONE = 0,               /* No parameter */
  PARAMT_STR,                   /* String parm enclosed in double quotes (") */
  PARAMT_STR,                   /* String parm enclosed in double quotes (") */
  PARAMT_WORD,                  /* String parm NOT enclosed in double quotes */
  PARAMT_WORD,                  /* String parm NOT enclosed in double quotes */
  PARAMT_INT,                   /* Integer parameter */
  PARAMT_INT,                   /* Integer parameter */
  PARAMT_LONGLONG,              /* Long long int parameter */
  PARAMT_LONGLONG,              /* Long long int parameter */
  PARAMT_ADDR                   /* Address parameter */
  PARAMT_ADDR                   /* Address parameter */
};
};
 
 
/* Generic structure for a configuration section */
/* Generic structure for a configuration section */
struct config_section
struct config_section
{
{
  char *name;
  char *name;
  void *(*sec_start) (void);
  void *(*sec_start) (void);
  void (*sec_end) (void *);
  void (*sec_end) (void *);
  void *dat;
  void *dat;
  struct config_param *params;
  struct config_param *params;
  struct config_section *next;
  struct config_section *next;
};
};
 
 
/* Externally visible data structures*/
/* Externally visible data structures*/
extern struct config          config;
extern struct config          config;
extern struct runtime         runtime;
extern struct runtime         runtime;
extern struct config_section *cur_section;
extern struct config_section *cur_section;
extern int                    do_stats;
extern int                    do_stats;
 
 
/* Prototypes for external use */
/* Prototypes for external use */
extern void  set_config_command (int argc, char **argv);
extern void  set_config_command (int argc, char **argv);
extern void  init_defconfig (void);
extern void  init_defconfig (void);
extern int   parse_args (int argc, char *argv[]);
extern int   parse_args (int argc, char *argv[]);
extern void  print_config (void);
extern void  print_config (void);
extern void  reg_config_param (struct config_section *sec,
extern void  reg_config_param (struct config_section *sec,
                               const char            *param,
                               const char            *param,
                               enum param_t           type,
                               enum param_t           type,
                               void (*param_cb)  (union param_val,
                               void (*param_cb)  (union param_val,
                                                  void *));
                                                  void *));
extern struct config_section *reg_config_sec (const char *section,
extern struct config_section *reg_config_sec (const char *section,
                                              void *(*sec_start) (void),
                                              void *(*sec_start) (void),
                                              void  (*sec_end) (void *));
                                              void  (*sec_end) (void *));
 
 
extern void  reg_config_secs ();
extern void  reg_config_secs ();
 
 
#endif /* SIM_CONFIG_H */
#endif /* SIM_CONFIG_H */
 
 

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.