src/include/machine.h

#ifndef MACHINE_H
#define MACHINE_H

/*
 *  Copyright (C) 2005-2006  Anders Gavare.  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *
 *  1. Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *  2. Redistributions in binary form must reproduce the above copyright  
 *     notice, this list of conditions and the following disclaimer in the 
 *     documentation and/or other materials provided with the distribution.
 *  3. The name of the author may not be used to endorse or promote products
 *     derived from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 *  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *  ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE   
 *  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 *  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 *  OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 *  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 *  OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 *  SUCH DAMAGE.
 *
 *
 *  $Id: machine.h,v 1.120 2006/06/24 19:52:28 debug Exp $
 */

#include <sys/types.h>
#include <sys/time.h>

#include "debugger_gdb.h"
#include "symbol.h"

#include "machine_arc.h"
#include "machine_pmax.h"
#include "machine_x86.h"


#define MAX_BREAKPOINTS         8
#define BREAKPOINT_FLAG_R       1

#define MAX_TICK_FUNCTIONS      16

struct cpu_family;
struct diskimage;
struct emul;
struct fb_window;
struct memory;
struct of_data;

/*  Ugly:  */
struct kn230_csr;
struct kn02_csr;
struct dec_ioasic_data;
struct ps2_data;
struct footbridge_data;
struct dec5800_data;
struct au1x00_ic_data;
struct malta_data;
struct vr41xx_data;
struct jazz_data;
struct crime_data;
struct mace_data;
struct sgi_ip20_data;
struct sgi_ip22_data;
struct sgi_ip30_data;
struct isa_pic_data {
        struct pic8259_data     *pic1;
        struct pic8259_data     *pic2;
        int                     last_int;
        int                     native_irq;
};


struct machine_bus {
        struct machine_bus *next;

        char            *name;

        void            (*debug_dump)(void *);
        void            *extra;
};


#define MACHINE_NAME_MAXBUF             150

struct machine {
        /*  Pointer back to the emul struct we are in:  */
        struct emul *emul;

        /*  Name as choosen by the user:  */
        char    *name;

        int     arch;                   /*  ARCH_MIPS, ARCH_PPC, ..  */
        int     machine_type;           /*  MACHINE_PMAX, ..  */
        int     machine_subtype;        /*  MACHINE_DEC_3MAX_5000, ..  */

        int     cycle_accurate;         /*  Set to non-zero for cycle
                                            accurate (slow) emulation.  */

        /*  Name set by code in src/machines/machine_*.c:  */
        char    *machine_name;

        int     stable;                 /*  startup warning for non-stable
                                            emulation modes.  */

        /*  The serial number is mostly used when emulating multiple machines
            in a network. nr_of_nics is the current nr of network cards, which
            is useful when emulating multiple cards in one machine:  */
        int     serial_nr;
        int     nr_of_nics;

        struct cpu_family *cpu_family;

        /*
         *  The "mainbus":
         *
         *      o)  memory
         *      o)  devices
         *      o)  CPUs
         */

        struct memory *memory;

        int     main_console_handle;

        /*  Hardware devices, run every x clock cycles.  */
        int     n_tick_entries;
        int     ticks_till_next[MAX_TICK_FUNCTIONS];
        int     ticks_reset_value[MAX_TICK_FUNCTIONS];
        void    (*tick_func[MAX_TICK_FUNCTIONS])(struct cpu *, void *);
        void    *tick_extra[MAX_TICK_FUNCTIONS];
        double  tick_hz[MAX_TICK_FUNCTIONS];

        void    (*md_interrupt)(struct machine *m, struct cpu *cpu,
                    int irq_nr, int assert);

        char    *cpu_name;  /*  TODO: remove this, there could be several
                                cpus with different names in a machine  */
        int     byte_order_override;
        int     bootstrap_cpu;
        int     use_random_bootstrap_cpu;
        int     start_paused;
        int     ncpus;
        struct cpu **cpus;

        /*  Registered busses:  */
        struct machine_bus *first_bus;
        int     n_busses;

        /*  These are used by stuff in cpu.c, mostly:  */
        int64_t ncycles;
        int64_t ncycles_show;
        int64_t ncycles_flush;
        int64_t ncycles_since_gettimeofday;
        struct timeval starttime;
        int     a_few_cycles;
        int     a_few_instrs;

        struct diskimage *first_diskimage;

        struct symbol_context symbol_context;

        int     random_mem_contents;
        int     physical_ram_in_mb;
        int     memory_offset_in_mb;
        int     prom_emulation;
        int     register_dump;
        int     arch_pagesize;

        int     bootdev_type;
        int     bootdev_id;
        char    *bootstr;
        char    *bootarg;

        struct debugger_gdb gdb;

        int     n_breakpoints;
        char    *breakpoint_string[MAX_BREAKPOINTS];
        uint64_t breakpoint_addr[MAX_BREAKPOINTS];
        int     breakpoint_flags[MAX_BREAKPOINTS];

        /*  Cache sizes: (1 << x) x=0 for default values  */
        /*  TODO: these are _PER CPU_!  */
        int     cache_picache;
        int     cache_pdcache;
        int     cache_secondary;
        int     cache_picache_linesize;
        int     cache_pdcache_linesize;
        int     cache_secondary_linesize;

        int     dbe_on_nonexistant_memaccess;
        int     dyntrans_alignment_check;
        int     instruction_trace;
        int     show_nr_of_instructions;
        int     show_symbolic_register_names;
        int     emulated_hz;
        int     speed_tricks;
        char    *userland_emul;         /*  NULL for no userland emulation  */
        int     force_netboot;
        int     slow_serial_interrupts_hack_for_linux;
        uint64_t file_loaded_end_addr;
        char    *boot_kernel_filename;
        char    *boot_string_argument;

        int     automatic_clock_adjustment;
        int     exit_without_entering_debugger;
        int     show_trace_tree;

        int     n_gfx_cards;

        /*  Machine-dependent: (PROM stuff, etc.)  */
        union {
                struct machine_arcbios  arc;
                struct machine_pmax     pmax;
                struct machine_pc       pc;
        } md;

        /*  OpenFirmware:  */
        struct of_data *of_data;

        /*  Bus-specific interrupt data:  */
        struct isa_pic_data isa_pic_data;

        /*  Machine-dependent interrupt specific structs:  */
        union {
                struct kn230_csr *kn230_csr;
                struct kn02_csr *kn02_csr;
                struct dec_ioasic_data *dec_ioasic_data;
                struct ps2_data *ps2_data;
                struct dec5800_data *dec5800_csr;
                struct au1x00_ic_data *au1x00_ic_data;
                struct vr41xx_data *vr41xx_data;       
                struct jazz_data *jazz_data;
                struct malta_data *malta_data;
                struct sgi_ip20_data *sgi_ip20_data;
                struct sgi_ip22_data *sgi_ip22_data;
                struct sgi_ip30_data *sgi_ip30_data;
                struct {
                        struct crime_data *crime_data;
                        struct mace_data *mace_data;
                } ip32;
                struct footbridge_data *footbridge_data;
                struct bebox_data *bebox_data;
                struct prep_data *prep_data;
                struct cpc700_data *cpc700_data;
                struct gc_data *gc_data;
                struct v3_data *v3_data;
        } md_int;

        /*  X11/framebuffer stuff:  */
        int     use_x11;
        int     x11_scaledown;
        int     x11_scaleup;
        int     x11_n_display_names;
        char    **x11_display_names;
        int     x11_current_display_name_nr;    /*  updated by x11.c  */

        int     n_fb_windows;
        struct fb_window **fb_windows;
};


/*
 *  Machine emulation types:
 */

#define ARCH_NOARCH             0
#define ARCH_MIPS               1
#define ARCH_PPC                2
#define ARCH_SPARC              3
#define ARCH_ALPHA              4
#define ARCH_X86                5
#define ARCH_ARM                6
#define ARCH_IA64               7
#define ARCH_M68K               8
#define ARCH_SH                 9
#define ARCH_HPPA               10
#define ARCH_I960               11
#define ARCH_AVR                12

/*  MIPS:  */
#define MACHINE_BAREMIPS        1000
#define MACHINE_TESTMIPS        1001
#define MACHINE_PMAX            1002
#define MACHINE_COBALT          1003
#define MACHINE_HPCMIPS         1004
#define MACHINE_PS2             1005
#define MACHINE_SGI             1006
#define MACHINE_ARC             1007
#define MACHINE_NETGEAR         1008
#define MACHINE_SONYNEWS        1009
#define MACHINE_EVBMIPS         1010
#define MACHINE_PSP             1011
#define MACHINE_ALGOR           1012

/*  PPC:  */
#define MACHINE_BAREPPC         2000
#define MACHINE_TESTPPC         2001
#define MACHINE_WALNUT          2002
#define MACHINE_PMPPC           2003
#define MACHINE_SANDPOINT       2004
#define MACHINE_BEBOX           2005
#define MACHINE_PREP            2006
#define MACHINE_MACPPC          2007
#define MACHINE_DB64360         2008
#define MACHINE_MVMEPPC         2009

/*  SPARC:  */
#define MACHINE_BARESPARC       3000
#define MACHINE_TESTSPARC       3001
#define MACHINE_SPARC           3002

/*  Alpha:  */
#define MACHINE_BAREALPHA       4000
#define MACHINE_TESTALPHA       4001
#define MACHINE_ALPHA           4002

/*  X86:  */
#define MACHINE_BAREX86         5000
#define MACHINE_X86             5001

/*  ARM:  */
#define MACHINE_BAREARM         6000
#define MACHINE_TESTARM         6001
#define MACHINE_CATS            6002
#define MACHINE_HPCARM          6003
#define MACHINE_ZAURUS          6004
#define MACHINE_NETWINDER       6005
#define MACHINE_SHARK           6006
#define MACHINE_IQ80321         6007
#define MACHINE_IYONIX          6008
#define MACHINE_TS7200          6009

/*  IA64:  */
#define MACHINE_BAREIA64        7000
#define MACHINE_TESTIA64        7001

/*  M68K:  */
#define MACHINE_BAREM68K        8000
#define MACHINE_TESTM68K        8001

/*  SH:  */
#define MACHINE_BARESH          9000
#define MACHINE_TESTSH          9001
#define MACHINE_HPCSH           9002

/*  HPPA:  */
#define MACHINE_BAREHPPA        10000
#define MACHINE_TESTHPPA        10001

/*  I960:  */
#define MACHINE_BAREI960        11000
#define MACHINE_TESTI960        11001

/*  AVR:  */
#define MACHINE_BAREAVR         12000
#define MACHINE_AVR_PAL         12001
#define MACHINE_AVR_MAHPONG     12002

/*  Other "pseudo"-machines:  */
#define MACHINE_NONE            0
#define MACHINE_USERLAND        100000

/*  DEC:  */
#define MACHINE_DEC_PMAX_3100           1
#define MACHINE_DEC_3MAX_5000           2
#define MACHINE_DEC_3MIN_5000           3
#define MACHINE_DEC_3MAXPLUS_5000       4
#define MACHINE_DEC_5800                5
#define MACHINE_DEC_5400                6
#define MACHINE_DEC_MAXINE_5000         7
#define MACHINE_DEC_5500                11
#define MACHINE_DEC_MIPSMATE_5100       12

#define DEC_PROM_CALLBACK_STRUCT        0xffffffffbfc04000ULL
#define DEC_PROM_EMULATION              0xffffffffbfc08000ULL
#define DEC_PROM_INITIAL_ARGV           (INITIAL_STACK_POINTER + 0x80)
#define DEC_PROM_STRINGS                0xffffffffbfc20000ULL
#define DEC_PROM_TCINFO                 0xffffffffbfc2c000ULL
#define DEC_MEMMAP_ADDR                 0xffffffffbfc30000ULL

/*  HPCmips:  */
#define MACHINE_HPCMIPS_CASIO_BE300             1
#define MACHINE_HPCMIPS_CASIO_E105              2
#define MACHINE_HPCMIPS_NEC_MOBILEPRO_770       3
#define MACHINE_HPCMIPS_NEC_MOBILEPRO_780       4
#define MACHINE_HPCMIPS_NEC_MOBILEPRO_800       5
#define MACHINE_HPCMIPS_NEC_MOBILEPRO_880       6
#define MACHINE_HPCMIPS_AGENDA_VR3              7
#define MACHINE_HPCMIPS_IBM_WORKPAD_Z50         8

/*  HPCarm:  */
#define MACHINE_HPCARM_IPAQ                     1
#define MACHINE_HPCARM_JORNADA720               2

/*  HPCsh:  */
#define MACHINE_HPCSH_JORNADA680                1
#define MACHINE_HPCSH_JORNADA690                2

/*  Playstation 2:  */
#define PLAYSTATION2_BDA        0xffffffffa0001000ULL
#define PLAYSTATION2_OPTARGS    0xffffffff81fff100ULL
#define PLAYSTATION2_SIFBIOS    0xffffffffbfc10000ULL

/*  SGI and ARC:  */
#define MACHINE_ARC_NEC_RD94            1
#define MACHINE_ARC_JAZZ_PICA           2
#define MACHINE_ARC_NEC_R94             3
#define MACHINE_ARC_DESKTECH_TYNE       4
#define MACHINE_ARC_JAZZ_MAGNUM         5
#define MACHINE_ARC_NEC_R98             6
#define MACHINE_ARC_JAZZ_M700           7
#define MACHINE_ARC_NEC_R96             8

/*  Algor:  */
#define MACHINE_ALGOR_P4032             4
#define MACHINE_ALGOR_P5064             5

/*  EVBMIPS:  */
#define MACHINE_EVBMIPS_MALTA           1
#define MACHINE_EVBMIPS_MALTA_BE        2
#define MACHINE_EVBMIPS_MESHCUBE        3
#define MACHINE_EVBMIPS_PB1000          4

/*  PReP:  */
#define MACHINE_PREP_IBM6050            1
#define MACHINE_PREP_MVME2400           2

/*  Sun SPARC:  */
#define MACHINE_SPARC_SS5               1
#define MACHINE_SPARC_SS20              2
#define MACHINE_SPARC_ULTRA1            3
#define MACHINE_SPARC_ULTRA60           4

/*  MacPPC:  TODO: Real model names  */
#define MACHINE_MACPPC_G3               1
#define MACHINE_MACPPC_G4               2
#define MACHINE_MACPPC_G5               3

/*  MVMEPPC  */
#define MACHINE_MVMEPPC_1600            1
#define MACHINE_MVMEPPC_2100            2
#define MACHINE_MVMEPPC_5500            3

/*  X86:  */
#define MACHINE_X86_GENERIC             1
#define MACHINE_X86_XT                  2


/*
 *  Problem: kernels seem to be loaded at low addresses in RAM, so
 *  storing environment strings and memory descriptors there is a bad
 *  idea. They are stored at 0xbfc..... instead.  The ARC SPB must
 *  be at physical address 0x1000 though.
 */
#define SGI_SPB_ADDR            0xffffffff80001000ULL
/*  0xbfc10000 is firmware callback vector stuff  */
#define ARC_FIRMWARE_VECTORS    0xffffffffbfc80000ULL
#define ARC_FIRMWARE_ENTRIES    0xffffffffbfc88000ULL
#define ARC_ARGV_START          0xffffffffbfc90000ULL
#define ARC_ENV_STRINGS         0xffffffffbfc98000ULL
#define ARC_ENV_POINTERS        0xffffffffbfc9d000ULL
#define SGI_SYSID_ADDR          0xffffffffbfca1800ULL
#define ARC_DSPSTAT_ADDR        0xffffffffbfca1c00ULL
#define ARC_MEMDESC_ADDR        0xffffffffbfca1c80ULL
#define ARC_CONFIG_DATA_ADDR    0xffffffffbfca2000ULL
#define FIRST_ARC_COMPONENT     0xffffffffbfca8000ULL
#define ARC_PRIVATE_VECTORS     0xffffffffbfcb0000ULL
#define ARC_PRIVATE_ENTRIES     0xffffffffbfcb8000ULL


/*  For the automachine system:  */
struct machine_entry_subtype {
        int                     machine_subtype;/*  Old-style subtype  */
        const char              *name;          /*  Official name  */
        int                     n_aliases;
        char                    **aliases;      /*  Aliases  */
};

struct machine_entry {
        struct machine_entry    *next;

        /*  Machine type:  */
        int                     arch;
        int                     machine_type;   /*  Old-style type  */
        const char              *name;          /*  Official name  */
        int                     n_aliases;
        char                    **aliases;      /*  Aliases  */

        void                    (*setup)(struct machine *, struct cpu *);
        void                    (*set_default_cpu)(struct machine *);
        void                    (*set_default_ram)(struct machine *);

        /*  Machine subtypes:  */
        int                     n_subtypes;
        struct machine_entry_subtype **subtype;
};

#define MACHINE_SETUP_TYPE(n)   void (*n)(struct machine *, struct cpu *)
#define MACHINE_SETUP(x)        void machine_setup_ ## x(struct machine *machine, \
                                    struct cpu *cpu)
#define MACHINE_DEFAULT_CPU(x)  void machine_default_cpu_ ## x(struct machine *machine)
#define MACHINE_DEFAULT_RAM(x)  void machine_default_ram_ ## x(struct machine *machine)
#define MACHINE_REGISTER(x)     void machine_register_ ## x(void)
#define MR_DEFAULT(x,name,arch,type) struct machine_entry               \
            *me = machine_entry_new(name,arch,type);                    \
        me->setup = machine_setup_ ## x;                                \
        me->set_default_cpu = machine_default_cpu_ ## x;                \
        machine_entry_register(me, arch);
void automachine_init(void);


/*  machine.c:  */
struct machine *machine_new(char *name, struct emul *emul);
int machine_name_to_type(char *stype, char *ssubtype,
        int *type, int *subtype, int *arch);
void machine_add_tickfunction(struct machine *machine,
        void (*func)(struct cpu *, void *), void *extra,
        int clockshift, double hz);
void machine_register(char *name, MACHINE_SETUP_TYPE(setup));
void dump_mem_string(struct cpu *cpu, uint64_t addr);
void store_string(struct cpu *cpu, uint64_t addr, char *s);
int store_64bit_word(struct cpu *cpu, uint64_t addr, uint64_t data64);
int store_32bit_word(struct cpu *cpu, uint64_t addr, uint64_t data32);
int store_16bit_word(struct cpu *cpu, uint64_t addr, uint64_t data16);
void store_byte(struct cpu *cpu, uint64_t addr, uint8_t data);
void store_64bit_word_in_host(struct cpu *cpu, unsigned char *data,
        uint64_t data32);
void store_32bit_word_in_host(struct cpu *cpu, unsigned char *data,
        uint64_t data32);
void store_16bit_word_in_host(struct cpu *cpu, unsigned char *data,
        uint16_t data16);
uint32_t load_32bit_word(struct cpu *cpu, uint64_t addr);
uint16_t load_16bit_word(struct cpu *cpu, uint64_t addr);
void store_buf(struct cpu *cpu, uint64_t addr, char *s, size_t len);
void add_environment_string(struct cpu *cpu, char *s, uint64_t *addr);
void add_environment_string_dual(struct cpu *cpu,
        uint64_t *ptrp, uint64_t *addrp, char *s1, char *s2);
void store_pointer_and_advance(struct cpu *cpu, uint64_t *addrp,
        uint64_t data, int flag64);
void machine_setup(struct machine *);
void machine_memsize_fix(struct machine *);
void machine_default_cputype(struct machine *);
void machine_dumpinfo(struct machine *);
void machine_bus_register(struct machine *, char *busname,
        void (*debug_dump)(void *), void *extra);
int machine_run(struct machine *machine);
void machine_list_available_types_and_cpus(void);
struct machine_entry *machine_entry_new(const char *name, 
        int arch, int oldstyle_type);
void machine_entry_add_alias(struct machine_entry *me, const char *name);
void machine_entry_add_subtype(struct machine_entry *me, const char *name,
        int oldstyle_subtype, ...);
void machine_entry_register(struct machine_entry *me, int arch);
void machine_init(void);


#endif  /*  MACHINE_H  */
1	dpavlin	4	#ifndef MACHINE_H
2			#define MACHINE_H
3
4			/*
5	dpavlin	22	* Copyright (C) 2005-2006 Anders Gavare. All rights reserved.
6	dpavlin	4	*
7			* Redistribution and use in source and binary forms, with or without
8			* modification, are permitted provided that the following conditions are met:
9			*
10			* 1. Redistributions of source code must retain the above copyright
11			* notice, this list of conditions and the following disclaimer.
12			* 2. Redistributions in binary form must reproduce the above copyright
13			* notice, this list of conditions and the following disclaimer in the
14			* documentation and/or other materials provided with the distribution.
15			* 3. The name of the author may not be used to endorse or promote products
16			* derived from this software without specific prior written permission.
17			*
18			* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19			* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20			* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21			* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22			* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23			* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24			* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25			* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26			* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27			* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28			* SUCH DAMAGE.
29			*
30			*
31	dpavlin	26	* $Id: machine.h,v 1.120 2006/06/24 19:52:28 debug Exp $
32	dpavlin	4	*/
33
34			#include <sys/types.h>
35			#include <sys/time.h>
36
37	dpavlin	24	#include "debugger_gdb.h"
38	dpavlin	4	#include "symbol.h"
39
40	dpavlin	14	#include "machine_arc.h"
41	dpavlin	24	#include "machine_pmax.h"
42	dpavlin	6	#include "machine_x86.h"
43	dpavlin	4
44	dpavlin	14
45	dpavlin	4	#define MAX_BREAKPOINTS 8
46			#define BREAKPOINT_FLAG_R 1
47
48	dpavlin	24	#define MAX_TICK_FUNCTIONS 16
49	dpavlin	4
50			struct cpu_family;
51			struct diskimage;
52			struct emul;
53			struct fb_window;
54			struct memory;
55	dpavlin	22	struct of_data;
56	dpavlin	4
57			/* Ugly: */
58			struct kn230_csr;
59			struct kn02_csr;
60			struct dec_ioasic_data;
61			struct ps2_data;
62	dpavlin	14	struct footbridge_data;
63	dpavlin	4	struct dec5800_data;
64			struct au1x00_ic_data;
65	dpavlin	10	struct malta_data;
66	dpavlin	4	struct vr41xx_data;
67			struct jazz_data;
68			struct crime_data;
69			struct mace_data;
70			struct sgi_ip20_data;
71			struct sgi_ip22_data;
72			struct sgi_ip30_data;
73	dpavlin	12	struct isa_pic_data {
74	dpavlin	20	struct pic8259_data *pic1;
75			struct pic8259_data *pic2;
76			int last_int;
77			int native_irq;
78	dpavlin	12	};
79	dpavlin	4
80	dpavlin	12
81	dpavlin	22	struct machine_bus {
82			struct machine_bus *next;
83
84			char *name;
85
86			void (debug_dump)(void );
87			void *extra;
88			};
89
90
91	dpavlin	20	#define MACHINE_NAME_MAXBUF 150
92	dpavlin	10
93	dpavlin	4	struct machine {
94			/* Pointer back to the emul struct we are in: */
95			struct emul *emul;
96
97			/* Name as choosen by the user: */
98			char *name;
99
100			int arch; /* ARCH_MIPS, ARCH_PPC, .. */
101	dpavlin	22	int machine_type; /* MACHINE_PMAX, .. */
102	dpavlin	4	int machine_subtype; /* MACHINE_DEC_3MAX_5000, .. */
103
104	dpavlin	24	int cycle_accurate; /* Set to non-zero for cycle
105			accurate (slow) emulation. */
106
107	dpavlin	22	/* Name set by code in src/machines/machine_.c: /
108	dpavlin	4	char *machine_name;
109
110	dpavlin	22	int stable; /* startup warning for non-stable
111			emulation modes. */
112
113	dpavlin	4	/* The serial number is mostly used when emulating multiple machines
114			in a network. nr_of_nics is the current nr of network cards, which
115			is useful when emulating multiple cards in one machine: */
116			int serial_nr;
117			int nr_of_nics;
118
119			struct cpu_family *cpu_family;
120
121			/*
122			* The "mainbus":
123			*
124			* o) memory
125			* o) devices
126			* o) CPUs
127			*/
128
129			struct memory *memory;
130
131			int main_console_handle;
132
133			/* Hardware devices, run every x clock cycles. */
134			int n_tick_entries;
135			int ticks_till_next[MAX_TICK_FUNCTIONS];
136			int ticks_reset_value[MAX_TICK_FUNCTIONS];
137			void (tick_func[MAX_TICK_FUNCTIONS])(struct cpu , void *);
138			void *tick_extra[MAX_TICK_FUNCTIONS];
139	dpavlin	24	double tick_hz[MAX_TICK_FUNCTIONS];
140	dpavlin	4
141			void (md_interrupt)(struct machine m, struct cpu *cpu,
142			int irq_nr, int assert);
143
144			char cpu_name; / TODO: remove this, there could be several
145			cpus with different names in a machine */
146			int byte_order_override;
147			int bootstrap_cpu;
148			int use_random_bootstrap_cpu;
149			int start_paused;
150			int ncpus;
151			struct cpu **cpus;
152
153	dpavlin	22	/* Registered busses: */
154			struct machine_bus *first_bus;
155			int n_busses;
156
157	dpavlin	4	/* These are used by stuff in cpu.c, mostly: */
158			int64_t ncycles;
159			int64_t ncycles_show;
160			int64_t ncycles_flush;
161	dpavlin	10	int64_t ncycles_since_gettimeofday;
162			struct timeval starttime;
163	dpavlin	4	int a_few_cycles;
164			int a_few_instrs;
165
166			struct diskimage *first_diskimage;
167
168			struct symbol_context symbol_context;
169
170			int random_mem_contents;
171			int physical_ram_in_mb;
172			int memory_offset_in_mb;
173			int prom_emulation;
174			int register_dump;
175	dpavlin	12	int arch_pagesize;
176	dpavlin	4
177	dpavlin	22	int bootdev_type;
178			int bootdev_id;
179			char *bootstr;
180			char *bootarg;
181
182	dpavlin	24	struct debugger_gdb gdb;
183
184	dpavlin	4	int n_breakpoints;
185			char *breakpoint_string[MAX_BREAKPOINTS];
186			uint64_t breakpoint_addr[MAX_BREAKPOINTS];
187			int breakpoint_flags[MAX_BREAKPOINTS];
188
189			/* Cache sizes: (1 << x) x=0 for default values */
190			/* TODO: these are _PER CPU_! */
191			int cache_picache;
192			int cache_pdcache;
193			int cache_secondary;
194			int cache_picache_linesize;
195			int cache_pdcache_linesize;
196			int cache_secondary_linesize;
197
198			int dbe_on_nonexistant_memaccess;
199	dpavlin	12	int dyntrans_alignment_check;
200	dpavlin	4	int instruction_trace;
201			int show_nr_of_instructions;
202			int show_symbolic_register_names;
203			int emulated_hz;
204			int speed_tricks;
205			char userland_emul; / NULL for no userland emulation */
206			int force_netboot;
207			int slow_serial_interrupts_hack_for_linux;
208			uint64_t file_loaded_end_addr;
209			char *boot_kernel_filename;
210			char *boot_string_argument;
211
212			int automatic_clock_adjustment;
213			int exit_without_entering_debugger;
214			int show_trace_tree;
215
216			int n_gfx_cards;
217
218	dpavlin	6	/* Machine-dependent: (PROM stuff, etc.) */
219			union {
220			struct machine_arcbios arc;
221	dpavlin	24	struct machine_pmax pmax;
222	dpavlin	6	struct machine_pc pc;
223			} md;
224	dpavlin	4
225	dpavlin	22	/* OpenFirmware: */
226			struct of_data *of_data;
227
228	dpavlin	14	/* Bus-specific interrupt data: */
229			struct isa_pic_data isa_pic_data;
230
231	dpavlin	6	/* Machine-dependent interrupt specific structs: */
232			union {
233			struct kn230_csr *kn230_csr;
234			struct kn02_csr *kn02_csr;
235			struct dec_ioasic_data *dec_ioasic_data;
236			struct ps2_data *ps2_data;
237			struct dec5800_data *dec5800_csr;
238			struct au1x00_ic_data *au1x00_ic_data;
239			struct vr41xx_data *vr41xx_data;
240			struct jazz_data *jazz_data;
241	dpavlin	10	struct malta_data *malta_data;
242	dpavlin	6	struct sgi_ip20_data *sgi_ip20_data;
243			struct sgi_ip22_data *sgi_ip22_data;
244			struct sgi_ip30_data *sgi_ip30_data;
245			struct {
246			struct crime_data *crime_data;
247			struct mace_data *mace_data;
248			} ip32;
249	dpavlin	14	struct footbridge_data *footbridge_data;
250	dpavlin	20	struct bebox_data *bebox_data;
251			struct prep_data *prep_data;
252			struct cpc700_data *cpc700_data;
253	dpavlin	22	struct gc_data *gc_data;
254			struct v3_data *v3_data;
255	dpavlin	6	} md_int;
256
257	dpavlin	4	/* X11/framebuffer stuff: */
258			int use_x11;
259			int x11_scaledown;
260	dpavlin	20	int x11_scaleup;
261	dpavlin	4	int x11_n_display_names;
262			char **x11_display_names;
263			int x11_current_display_name_nr; /* updated by x11.c */
264
265			int n_fb_windows;
266			struct fb_window **fb_windows;
267			};
268
269
270			/*
271			* Machine emulation types:
272			*/
273
274			#define ARCH_NOARCH 0
275			#define ARCH_MIPS 1
276			#define ARCH_PPC 2
277			#define ARCH_SPARC 3
278	dpavlin	12	#define ARCH_ALPHA 4
279			#define ARCH_X86 5
280			#define ARCH_ARM 6
281			#define ARCH_IA64 7
282			#define ARCH_M68K 8
283	dpavlin	14	#define ARCH_SH 9
284			#define ARCH_HPPA 10
285			#define ARCH_I960 11
286			#define ARCH_AVR 12
287	dpavlin	4
288			/* MIPS: */
289			#define MACHINE_BAREMIPS 1000
290			#define MACHINE_TESTMIPS 1001
291	dpavlin	22	#define MACHINE_PMAX 1002
292	dpavlin	4	#define MACHINE_COBALT 1003
293			#define MACHINE_HPCMIPS 1004
294			#define MACHINE_PS2 1005
295			#define MACHINE_SGI 1006
296			#define MACHINE_ARC 1007
297	dpavlin	24	#define MACHINE_NETGEAR 1008
298			#define MACHINE_SONYNEWS 1009
299			#define MACHINE_EVBMIPS 1010
300			#define MACHINE_PSP 1011
301			#define MACHINE_ALGOR 1012
302	dpavlin	4
303			/* PPC: */
304			#define MACHINE_BAREPPC 2000
305			#define MACHINE_TESTPPC 2001
306			#define MACHINE_WALNUT 2002
307			#define MACHINE_PMPPC 2003
308			#define MACHINE_SANDPOINT 2004
309			#define MACHINE_BEBOX 2005
310			#define MACHINE_PREP 2006
311			#define MACHINE_MACPPC 2007
312			#define MACHINE_DB64360 2008
313	dpavlin	22	#define MACHINE_MVMEPPC 2009
314	dpavlin	4
315			/* SPARC: */
316			#define MACHINE_BARESPARC 3000
317	dpavlin	12	#define MACHINE_TESTSPARC 3001
318	dpavlin	24	#define MACHINE_SPARC 3002
319	dpavlin	4
320			/* Alpha: */
321	dpavlin	12	#define MACHINE_BAREALPHA 4000
322			#define MACHINE_TESTALPHA 4001
323			#define MACHINE_ALPHA 4002
324	dpavlin	4
325			/* X86: */
326	dpavlin	12	#define MACHINE_BAREX86 5000
327			#define MACHINE_X86 5001
328	dpavlin	4
329	dpavlin	6	/* ARM: */
330	dpavlin	12	#define MACHINE_BAREARM 6000
331			#define MACHINE_TESTARM 6001
332	dpavlin	14	#define MACHINE_CATS 6002
333			#define MACHINE_HPCARM 6003
334			#define MACHINE_ZAURUS 6004
335			#define MACHINE_NETWINDER 6005
336			#define MACHINE_SHARK 6006
337			#define MACHINE_IQ80321 6007
338			#define MACHINE_IYONIX 6008
339	dpavlin	22	#define MACHINE_TS7200 6009
340	dpavlin	6
341	dpavlin	12	/* IA64: */
342			#define MACHINE_BAREIA64 7000
343			#define MACHINE_TESTIA64 7001
344
345			/* M68K: */
346			#define MACHINE_BAREM68K 8000
347			#define MACHINE_TESTM68K 8001
348
349	dpavlin	14	/* SH: */
350			#define MACHINE_BARESH 9000
351			#define MACHINE_TESTSH 9001
352			#define MACHINE_HPCSH 9002
353
354			/* HPPA: */
355			#define MACHINE_BAREHPPA 10000
356			#define MACHINE_TESTHPPA 10001
357
358			/* I960: */
359			#define MACHINE_BAREI960 11000
360			#define MACHINE_TESTI960 11001
361
362			/* AVR: */
363			#define MACHINE_BAREAVR 12000
364	dpavlin	24	#define MACHINE_AVR_PAL 12001
365			#define MACHINE_AVR_MAHPONG 12002
366	dpavlin	14
367	dpavlin	4	/* Other "pseudo"-machines: */
368			#define MACHINE_NONE 0
369			#define MACHINE_USERLAND 100000
370
371			/* DEC: */
372			#define MACHINE_DEC_PMAX_3100 1
373			#define MACHINE_DEC_3MAX_5000 2
374			#define MACHINE_DEC_3MIN_5000 3
375			#define MACHINE_DEC_3MAXPLUS_5000 4
376			#define MACHINE_DEC_5800 5
377			#define MACHINE_DEC_5400 6
378			#define MACHINE_DEC_MAXINE_5000 7
379			#define MACHINE_DEC_5500 11
380			#define MACHINE_DEC_MIPSMATE_5100 12
381
382			#define DEC_PROM_CALLBACK_STRUCT 0xffffffffbfc04000ULL
383			#define DEC_PROM_EMULATION 0xffffffffbfc08000ULL
384			#define DEC_PROM_INITIAL_ARGV (INITIAL_STACK_POINTER + 0x80)
385			#define DEC_PROM_STRINGS 0xffffffffbfc20000ULL
386			#define DEC_PROM_TCINFO 0xffffffffbfc2c000ULL
387			#define DEC_MEMMAP_ADDR 0xffffffffbfc30000ULL
388
389			/* HPCmips: */
390			#define MACHINE_HPCMIPS_CASIO_BE300 1
391			#define MACHINE_HPCMIPS_CASIO_E105 2
392			#define MACHINE_HPCMIPS_NEC_MOBILEPRO_770 3
393			#define MACHINE_HPCMIPS_NEC_MOBILEPRO_780 4
394			#define MACHINE_HPCMIPS_NEC_MOBILEPRO_800 5
395			#define MACHINE_HPCMIPS_NEC_MOBILEPRO_880 6
396			#define MACHINE_HPCMIPS_AGENDA_VR3 7
397			#define MACHINE_HPCMIPS_IBM_WORKPAD_Z50 8
398
399	dpavlin	14	/* HPCarm: */
400			#define MACHINE_HPCARM_IPAQ 1
401			#define MACHINE_HPCARM_JORNADA720 2
402
403			/* HPCsh: */
404			#define MACHINE_HPCSH_JORNADA680 1
405			#define MACHINE_HPCSH_JORNADA690 2
406
407	dpavlin	4	/* Playstation 2: */
408			#define PLAYSTATION2_BDA 0xffffffffa0001000ULL
409			#define PLAYSTATION2_OPTARGS 0xffffffff81fff100ULL
410			#define PLAYSTATION2_SIFBIOS 0xffffffffbfc10000ULL
411
412			/* SGI and ARC: */
413			#define MACHINE_ARC_NEC_RD94 1
414			#define MACHINE_ARC_JAZZ_PICA 2
415			#define MACHINE_ARC_NEC_R94 3
416			#define MACHINE_ARC_DESKTECH_TYNE 4
417			#define MACHINE_ARC_JAZZ_MAGNUM 5
418			#define MACHINE_ARC_NEC_R98 6
419			#define MACHINE_ARC_JAZZ_M700 7
420			#define MACHINE_ARC_NEC_R96 8
421
422	dpavlin	20	/* Algor: */
423			#define MACHINE_ALGOR_P4032 4
424			#define MACHINE_ALGOR_P5064 5
425
426	dpavlin	8	/* EVBMIPS: */
427			#define MACHINE_EVBMIPS_MALTA 1
428	dpavlin	12	#define MACHINE_EVBMIPS_MALTA_BE 2
429	dpavlin	24	#define MACHINE_EVBMIPS_MESHCUBE 3
430			#define MACHINE_EVBMIPS_PB1000 4
431	dpavlin	8
432	dpavlin	22	/* PReP: */
433			#define MACHINE_PREP_IBM6050 1
434			#define MACHINE_PREP_MVME2400 2
435
436	dpavlin	24	/* Sun SPARC: */
437			#define MACHINE_SPARC_SS5 1
438			#define MACHINE_SPARC_SS20 2
439			#define MACHINE_SPARC_ULTRA1 3
440			#define MACHINE_SPARC_ULTRA60 4
441
442	dpavlin	4	/* MacPPC: TODO: Real model names */
443	dpavlin	24	#define MACHINE_MACPPC_G3 1
444			#define MACHINE_MACPPC_G4 2
445			#define MACHINE_MACPPC_G5 3
446	dpavlin	4
447	dpavlin	22	/* MVMEPPC */
448			#define MACHINE_MVMEPPC_1600 1
449			#define MACHINE_MVMEPPC_2100 2
450			#define MACHINE_MVMEPPC_5500 3
451
452	dpavlin	6	/* X86: */
453			#define MACHINE_X86_GENERIC 1
454			#define MACHINE_X86_XT 2
455	dpavlin	4
456	dpavlin	6
457	dpavlin	4	/*
458			* Problem: kernels seem to be loaded at low addresses in RAM, so
459			* storing environment strings and memory descriptors there is a bad
460			* idea. They are stored at 0xbfc..... instead. The ARC SPB must
461			* be at physical address 0x1000 though.
462			*/
463			#define SGI_SPB_ADDR 0xffffffff80001000ULL
464			/* 0xbfc10000 is firmware callback vector stuff */
465			#define ARC_FIRMWARE_VECTORS 0xffffffffbfc80000ULL
466			#define ARC_FIRMWARE_ENTRIES 0xffffffffbfc88000ULL
467			#define ARC_ARGV_START 0xffffffffbfc90000ULL
468			#define ARC_ENV_STRINGS 0xffffffffbfc98000ULL
469			#define ARC_ENV_POINTERS 0xffffffffbfc9d000ULL
470			#define SGI_SYSID_ADDR 0xffffffffbfca1800ULL
471			#define ARC_DSPSTAT_ADDR 0xffffffffbfca1c00ULL
472			#define ARC_MEMDESC_ADDR 0xffffffffbfca1c80ULL
473			#define ARC_CONFIG_DATA_ADDR 0xffffffffbfca2000ULL
474			#define FIRST_ARC_COMPONENT 0xffffffffbfca8000ULL
475			#define ARC_PRIVATE_VECTORS 0xffffffffbfcb0000ULL
476			#define ARC_PRIVATE_ENTRIES 0xffffffffbfcb8000ULL
477
478
479	dpavlin	22	/* For the automachine system: */
480			struct machine_entry_subtype {
481			int machine_subtype;/* Old-style subtype */
482			const char name; / Official name */
483			int n_aliases;
484			char *aliases; / Aliases */
485			};
486
487			struct machine_entry {
488			struct machine_entry *next;
489
490			/* Machine type: */
491			int arch;
492			int machine_type; /* Old-style type */
493			const char name; / Official name */
494			int n_aliases;
495			char *aliases; / Aliases */
496
497			void (setup)(struct machine , struct cpu *);
498			void (set_default_cpu)(struct machine );
499			void (set_default_ram)(struct machine );
500
501			/* Machine subtypes: */
502			int n_subtypes;
503			struct machine_entry_subtype **subtype;
504			};
505
506			#define MACHINE_SETUP_TYPE(n) void (n)(struct machine , struct cpu *)
507			#define MACHINE_SETUP(x) void machine_setup_ ## x(struct machine *machine, \
508			struct cpu *cpu)
509			#define MACHINE_DEFAULT_CPU(x) void machine_default_cpu_ ## x(struct machine *machine)
510			#define MACHINE_DEFAULT_RAM(x) void machine_default_ram_ ## x(struct machine *machine)
511			#define MACHINE_REGISTER(x) void machine_register_ ## x(void)
512	dpavlin	26	#define MR_DEFAULT(x,name,arch,type) struct machine_entry \
513			*me = machine_entry_new(name,arch,type); \
514			me->setup = machine_setup_ ## x; \
515			me->set_default_cpu = machine_default_cpu_ ## x; \
516			machine_entry_register(me, arch);
517	dpavlin	22	void automachine_init(void);
518
519
520	dpavlin	4	/* machine.c: */
521			struct machine machine_new(char name, struct emul *emul);
522			int machine_name_to_type(char stype, char ssubtype,
523			int type, int subtype, int *arch);
524			void machine_add_tickfunction(struct machine *machine,
525	dpavlin	24	void (func)(struct cpu , void ), void extra,
526			int clockshift, double hz);
527	dpavlin	22	void machine_register(char *name, MACHINE_SETUP_TYPE(setup));
528	dpavlin	4	void dump_mem_string(struct cpu *cpu, uint64_t addr);
529			void store_string(struct cpu cpu, uint64_t addr, char s);
530			int store_64bit_word(struct cpu *cpu, uint64_t addr, uint64_t data64);
531			int store_32bit_word(struct cpu *cpu, uint64_t addr, uint64_t data32);
532			int store_16bit_word(struct cpu *cpu, uint64_t addr, uint64_t data16);
533	dpavlin	6	void store_byte(struct cpu *cpu, uint64_t addr, uint8_t data);
534	dpavlin	4	void store_64bit_word_in_host(struct cpu cpu, unsigned char data,
535			uint64_t data32);
536			void store_32bit_word_in_host(struct cpu cpu, unsigned char data,
537			uint64_t data32);
538			void store_16bit_word_in_host(struct cpu cpu, unsigned char data,
539			uint16_t data16);
540			uint32_t load_32bit_word(struct cpu *cpu, uint64_t addr);
541			uint16_t load_16bit_word(struct cpu *cpu, uint64_t addr);
542			void store_buf(struct cpu cpu, uint64_t addr, char s, size_t len);
543	dpavlin	22	void add_environment_string(struct cpu cpu, char s, uint64_t *addr);
544			void add_environment_string_dual(struct cpu *cpu,
545			uint64_t ptrp, uint64_t addrp, char s1, char s2);
546			void store_pointer_and_advance(struct cpu cpu, uint64_t addrp,
547			uint64_t data, int flag64);
548	dpavlin	4	void machine_setup(struct machine *);
549			void machine_memsize_fix(struct machine *);
550			void machine_default_cputype(struct machine *);
551			void machine_dumpinfo(struct machine *);
552	dpavlin	22	void machine_bus_register(struct machine , char busname,
553			void (debug_dump)(void ), void *extra);
554	dpavlin	26	int machine_run(struct machine *machine);
555	dpavlin	4	void machine_list_available_types_and_cpus(void);
556	dpavlin	22	struct machine_entry machine_entry_new(const char name,
557	dpavlin	26	int arch, int oldstyle_type);
558			void machine_entry_add_alias(struct machine_entry me, const char name);
559			void machine_entry_add_subtype(struct machine_entry me, const char name,
560			int oldstyle_subtype, ...);
561			void machine_entry_register(struct machine_entry *me, int arch);
562	dpavlin	4	void machine_init(void);
563
564
565			#endif /* MACHINE_H */