aboutsummaryrefslogtreecommitdiff
path: root/sim/ppc/corefile.h
blob: 912623cc1ec9d88bc5455645b99abbb4c9960bce (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
/*  This file is part of the program psim.

    Copyright (C) 1994-1995, Andrew Cagney <cagney@highland.com.au>

    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 Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 
    */


#ifndef _CORE_H_
#define _CORE_H_

/* basic types */

typedef struct _core core;
typedef struct _core_map core_map;

/* constructor */

core INLINE_CORE *core_create
(void);

device INLINE_CORE *core_device_create
(core *);



/* the core has three sub mappings that the more efficient
   read/write fixed quantity functions use */

core_map INLINE_CORE *core_readable
(core *memory);

core_map INLINE_CORE *core_writeable
(core *memory);

core_map INLINE_CORE *core_executable
(core *memory);



/* operators to add/remove a mapping in the core

   callback-memory:

   All access are passed onto the specified devices callback routines
   after being `translated'.  DEFAULT indicates that the specified
   memory should be called if all other mappings fail.
   
   For callback-memory, the device must be specified.

   raw-memory:

   While RAM could be implemented using the callback interface
   core instead treats it as the common case including the code
   directly in the read/write operators.

   For raw-memory, the device is ignored and the core alloc's a
   block to act as the memory.

   default-memory:

   Should, for the core, there be no defined mapping for a given
   address then the default map (if present) is called.

   For default-memory, the device must be specified. */

void INLINE_CORE core_attach
(core *map,
 attach_type attach,
 int address_space,
 access_type access,
 unsigned_word addr,
 unsigned nr_bytes, /* host limited */
 device *device); /*callback/default*/

void INLINE_CORE core_detach
(core *map,
 attach_type attach,
 int address_space,
 unsigned_word addr,
 unsigned nr_bytes, /* host limited */
 access_type access,
 device *device); /*callback/default*/


/* Variable sized read/write:

   Transfer (zero) a variable size block of data between the host and
   target (possibly byte swapping it).  Should any problems occure,
   the number of bytes actually transfered is returned. */

unsigned INLINE_CORE core_map_read_buffer
(core_map *map,
 void *buffer,
 unsigned_word addr,
 unsigned nr_bytes);

unsigned INLINE_CORE core_map_write_buffer
(core_map *map,
 const void *buffer,
 unsigned_word addr,
 unsigned nr_bytes);


/* Fixed sized read/write:

   Transfer a fixed amout of memory between the host and target.  The
   memory always being translated and the operation always aborting
   should a problem occure */

#define DECLARE_CORE_WRITE_N(N) \
void INLINE_CORE core_map_write_##N \
(core_map *map, \
 unsigned_word addr, \
 unsigned_##N val, \
 cpu *processor, \
 unsigned_word cia);

DECLARE_CORE_WRITE_N(1)
DECLARE_CORE_WRITE_N(2)
DECLARE_CORE_WRITE_N(4)
DECLARE_CORE_WRITE_N(8)
DECLARE_CORE_WRITE_N(word)

#define DECLARE_CORE_READ_N(N) \
unsigned_##N INLINE_CORE core_map_read_##N \
(core_map *map, \
 unsigned_word addr, \
 cpu *processor, \
 unsigned_word cia);

DECLARE_CORE_READ_N(1)
DECLARE_CORE_READ_N(2)
DECLARE_CORE_READ_N(4)
DECLARE_CORE_READ_N(8)
DECLARE_CORE_READ_N(word)

#endif